Merge pull request #2 from stainless-sdks/next

Next

Author: RolandoAndrade

.github/workflows/ci.yml

@@ -7,6 +7,10 @@ on:
       - 'integrated/**'
       - 'stl-preview-head/**'
       - 'stl-preview-base/**'
+  pull_request:
+    branches-ignore:
+      - 'stl-preview-head/**'
+      - 'stl-preview-base/**'
 
 jobs:
   lint:

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 17
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/scan-documents%2Fscan-documents-41af66c2f2ba90b745f6c36d89d31281f16d916521b98a8f510ec3a8f90a1efb.yml
-openapi_spec_hash: 0c629cd46c640a055b0cfa5d88aad337
-config_hash: ee078a284af580362c78b746a0c811c2
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/scan-documents%2Fscan-documents-42f9aa9c3b2769584f60fa3742f3a004bdf2e3b5ba30a44535b0191654b1a51e.yml
+openapi_spec_hash: a0bab3e1411b24d8a662df98d227049a
+config_hash: 4f1180f734cbc7323ff2ed85a9cd510d

README.md

@@ -1,6 +1,6 @@
 # Scan Documents TypeScript API Library
 
-[![NPM version](https://img.shields.io/npm/v/scan-documents.svg)](https://npmjs.org/package/scan-documents) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/scan-documents)
+[![NPM version](<https://img.shields.io/npm/v/scan-documents.svg?label=npm%20(stable)>)](https://npmjs.org/package/scan-documents) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/scan-documents)
 
 This library provides convenient access to the Scan Documents REST API from server-side TypeScript or JavaScript.
 
@@ -26,11 +26,7 @@ const client = new ScanDocuments({
   apiKey: process.env['SCAN_DOCUMENTS_API_KEY'], // This is the default and can be omitted
 });
 
-async function main() {
-  const file = await client.files.upload({ file: fs.createReadStream('path/to/file'), name: 'REPLACE_ME' });
-}
-
-main();
+const file = await client.files.upload({ file: fs.createReadStream('path/to/file'), name: 'REPLACE_ME' });
 ```
 
 ### Request & Response types
@@ -45,15 +41,11 @@ const client = new ScanDocuments({
   apiKey: process.env['SCAN_DOCUMENTS_API_KEY'], // This is the default and can be omitted
 });
 
-async function main() {
-  const params: ScanDocuments.FileUploadParams = {
-    file: fs.createReadStream('path/to/file'),
-    name: 'REPLACE_ME',
-  };
-  const file: ScanDocuments.File = await client.files.upload(params);
-}
-
-main();
+const params: ScanDocuments.FileUploadParams = {
+  file: fs.createReadStream('path/to/file'),
+  name: 'REPLACE_ME',
+};
+const file: ScanDocuments.File = await client.files.upload(params);
 ```
 
 Documentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.
@@ -115,21 +107,17 @@ a subclass of `APIError` will be thrown:
 
 <!-- prettier-ignore -->
 ```ts
-async function main() {
-  const file = await client.files
-    .upload({ file: fs.createReadStream('path/to/file'), name: 'REPLACE_ME' })
-    .catch(async (err) => {
-      if (err instanceof ScanDocuments.APIError) {
-        console.log(err.status); // 400
-        console.log(err.name); // BadRequestError
-        console.log(err.headers); // {server: 'nginx', ...}
-      } else {
-        throw err;
-      }
-    });
-}
-
-main();
+const file = await client.files
+  .upload({ file: fs.createReadStream('path/to/file'), name: 'REPLACE_ME' })
+  .catch(async (err) => {
+    if (err instanceof ScanDocuments.APIError) {
+      console.log(err.status); // 400
+      console.log(err.name); // BadRequestError
+      console.log(err.headers); // {server: 'nginx', ...}
+    } else {
+      throw err;
+    }
+  });
 ```
 
 Error codes are as follows:
@@ -291,9 +279,8 @@ parameter. This library doesn't validate at runtime that the request matches the
 send will be sent as-is.
 
 ```ts
-client.foo.create({
-  foo: 'my_param',
-  bar: 12,
+client.files.upload({
+  // ...
   // @ts-expect-error baz is not yet public
   baz: 'undocumented option',
 });

SECURITY.md

@@ -16,11 +16,11 @@ before making any information public.
 ## Reporting Non-SDK Related Security Issues
 
 If you encounter security issues that are not directly related to SDKs but pertain to the services
-or products provided by Scan Documents please follow the respective company's security reporting guidelines.
+or products provided by Scan Documents, please follow the respective company's security reporting guidelines.
 
 ### Scan Documents Terms and Policies
 
-Please contact support@scan-documents.com for any questions or concerns regarding security of our services.
+Please contact support@scan-documents.com for any questions or concerns regarding the security of our services.
 
 ---
 

api.md

@@ -1,3 +1,9 @@
+# Shared
+
+Types:
+
+- <code><a href="./src/resources/shared.ts">JsonSchemaSpec</a></code>
+
 # Files
 
 Types:
@@ -48,7 +54,6 @@ Types:
 - <code><a href="./src/resources/image-operations.ts">ExtractTextRequest</a></code>
 - <code><a href="./src/resources/image-operations.ts">ExtractTextResponse</a></code>
 - <code><a href="./src/resources/image-operations.ts">ImageFromTaskResponse</a></code>
-- <code><a href="./src/resources/image-operations.ts">JsonSchemaSpec</a></code>
 - <code><a href="./src/resources/image-operations.ts">WarpRequest</a></code>
 - <code><a href="./src/resources/image-operations.ts">WarpResponse</a></code>
 

bin/publish-npm

@@ -4,19 +4,55 @@ set -eux
 
 npm config set '//registry.npmjs.org/:_authToken' "$NPM_TOKEN"
 
-# Build the project
 yarn build
-
-# Navigate to the dist directory
 cd dist
 
-# Get the version from package.json
-VERSION="$(node -p "require('./package.json').version")"
+# Get package name and version from package.json
+PACKAGE_NAME="$(jq -r -e '.name' ./package.json)"
+VERSION="$(jq -r -e '.version' ./package.json)"
+
+# Get latest version from npm
+#
+# If the package doesn't exist, npm will return:
+# {
+#   "error": {
+#     "code": "E404",
+#     "summary": "Unpublished on 2025-06-05T09:54:53.528Z",
+#     "detail": "'the_package' is not in this registry..."
+#   }
+# }
+NPM_INFO="$(npm view "$PACKAGE_NAME" version --json 2>/dev/null || true)"
+
+# Check if we got an E404 error
+if echo "$NPM_INFO" | jq -e '.error.code == "E404"' > /dev/null 2>&1; then
+  # Package doesn't exist yet, no last version
+  LAST_VERSION=""
+elif echo "$NPM_INFO" | jq -e '.error' > /dev/null 2>&1; then
+  # Report other errors
+  echo "ERROR: npm returned unexpected data:"
+  echo "$NPM_INFO"
+  exit 1
+else
+  # Success - get the version
+  LAST_VERSION=$(echo "$NPM_INFO" | jq -r '.') # strip quotes
+fi
 
-# Extract the pre-release tag if it exists
+# Check if current version is pre-release (e.g. alpha / beta / rc)
+CURRENT_IS_PRERELEASE=false
 if [[ "$VERSION" =~ -([a-zA-Z]+) ]]; then
-  # Extract the part before any dot in the pre-release identifier
-  TAG="${BASH_REMATCH[1]}"
+  CURRENT_IS_PRERELEASE=true
+  CURRENT_TAG="${BASH_REMATCH[1]}"
+fi
+
+# Check if last version is a stable release
+LAST_IS_STABLE_RELEASE=true
+if [[ -z "$LAST_VERSION" || "$LAST_VERSION" =~ -([a-zA-Z]+) ]]; then
+  LAST_IS_STABLE_RELEASE=false
+fi
+
+# Use a corresponding alpha/beta tag if there already is a stable release and we're publishing a prerelease.
+if $CURRENT_IS_PRERELEASE && $LAST_IS_STABLE_RELEASE; then
+  TAG="$CURRENT_TAG"
 else
   TAG="latest"
 fi

eslint.config.mjs

@@ -10,7 +10,7 @@ export default tseslint.config(
       parserOptions: { sourceType: 'module' },
     },
     files: ['**/*.ts', '**/*.mts', '**/*.cts', '**/*.js', '**/*.mjs', '**/*.cjs'],
-    ignores: ['dist/**'],
+    ignores: ['dist/'],
     plugins: {
       '@typescript-eslint': tseslint.plugin,
       'unused-imports': unusedImports,

jest.config.ts

@@ -15,6 +15,7 @@ const config: JestConfigWithTsJest = {
     '<rootDir>/dist/',
     '<rootDir>/deno/',
     '<rootDir>/deno_tests/',
+    '<rootDir>/packages/',
   ],
   testPathIgnorePatterns: ['scripts'],
 };

package.json

@@ -34,21 +34,18 @@
     "@typescript-eslint/eslint-plugin": "8.31.1",
     "@typescript-eslint/parser": "8.31.1",
     "eslint": "^9.20.1",
-    "eslint-plugin-prettier": "^5.2.3",
+    "eslint-plugin-prettier": "^5.4.1",
     "eslint-plugin-unused-imports": "^4.1.4",
     "iconv-lite": "^0.6.3",
     "jest": "^29.4.0",
     "prettier": "^3.0.0",
     "publint": "^0.2.12",
     "ts-jest": "^29.1.0",
     "ts-node": "^10.5.0",
-    "tsc-multi": "https://github.com/stainless-api/tsc-multi/releases/download/v1.1.4/tsc-multi-1.1.4.tgz",
+    "tsc-multi": "https://github.com/stainless-api/tsc-multi/releases/download/v1.1.8/tsc-multi.tgz",
     "tsconfig-paths": "^4.0.0",
     "typescript": "5.8.3"
   },
-  "resolutions": {
-    "synckit": "0.8.8"
-  },
   "imports": {
     "scan-documents": ".",
     "scan-documents/*": "./src/*"

packages/mcp-server/build

@@ -23,14 +23,10 @@ PKG_JSON_PATH=../../packages/mcp-server/package.json node ../../scripts/utils/ma
 node scripts/postprocess-dist-package-json.cjs
 
 # build to .js/.mjs/.d.ts files
-npm exec tsc-multi
+./node_modules/.bin/tsc-multi
 
 cp tsconfig.dist-src.json dist/src/tsconfig.json
 
-# Add proper Node.js shebang to the top of the file
-sed -i.bak '1s;^;#!/usr/bin/env node\n;' dist/index.js
-rm dist/index.js.bak
-
 chmod +x dist/index.js
 
 DIST_PATH=./dist PKG_IMPORT_PATH=scan-documents-mcp/ node ../../scripts/utils/postprocess-files.cjs