feat: initial alpha changes

Author: RobertCraigie

.eslintrc.js

@@ -5,6 +5,25 @@ module.exports = {
     'no-unused-vars': 'off',
     'prettier/prettier': 'error',
     'unused-imports/no-unused-imports': 'error',
+    'no-restricted-imports': [
+      'error',
+      {
+        patterns: [
+          {
+            group: ['openai', 'openai/*'],
+            message: 'Use a relative import, not a package import.',
+          },
+        ],
+      },
+    ],
   },
+  overrides: [
+    {
+      files: ['tests/**', 'examples/**'],
+      rules: {
+        'no-restricted-imports': 'off',
+      },
+    },
+  ],
   root: true,
 };

README.md

@@ -303,7 +303,6 @@ Request parameters that correspond to file uploads can be passed in many differe
 
 ```ts
 import fs from 'fs';
-import fetch from 'node-fetch';
 import OpenAI, { toFile } from 'openai';
 
 const client = new OpenAI();
@@ -560,21 +559,23 @@ validate or strip extra properties from the response from the API.
 
 ### Customizing the fetch client
 
-By default, this library uses `node-fetch` in Node, and expects a global `fetch` function in other environments.
+By default, this library expects a global `fetch` function is defined.
 
-If you would prefer to use a global, web-standards-compliant `fetch` function even in a Node environment,
-(for example, if you are running Node with `--experimental-fetch` or using NextJS which polyfills with `undici`),
-add the following import before your first import `from "OpenAI"`:
+If you want to use a different `fetch` function, you can either polyfill the global:
 
 ```ts
-// Tell TypeScript and the package to use the global web fetch instead of node-fetch.
-// Note, despite the name, this does not add any polyfills, but expects them to be provided if needed.
-import 'openai/shims/web';
-import OpenAI from 'openai';
+import fetch from 'my-fetch';
+
+globalThis.fetch = fetch;
 ```
 
-To do the inverse, add `import "openai/shims/node"` (which does import polyfills).
-This can also be useful if you are getting the wrong TypeScript types for `Response` ([more details](https://github.com/openai/openai-node/tree/master/src/_shims#readme)).
+Or pass it to the client:
+
+```ts
+import fetch from 'my-fetch';
+
+const client = new OpenAI({ fetch });
+```
 
 ### Logging and middleware
 
@@ -620,6 +621,8 @@ await client.models.list({
 });
 ```
 
+## Frequently Asked Questions
+
 ## Semantic versioning
 
 This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:
@@ -634,7 +637,7 @@ We are keen for your feedback; please open an [issue](https://www.github.com/ope
 
 ## Requirements
 
-TypeScript >= 4.5 is supported.
+TypeScript >= 4.9 is supported.
 
 The following runtimes are supported:
 

api.md

@@ -8,9 +8,9 @@ const config: JestConfigWithTsJest = {
   },
   moduleNameMapper: {
     '^openai$': '<rootDir>/src/index.ts',
-    '^openai/_shims/auto/(.*)$': '<rootDir>/src/_shims/auto/$1-node',
     '^openai/(.*)$': '<rootDir>/src/$1',
   },
+  setupFilesAfterEnv: ['<rootDir>/jest.setup.ts'],
   modulePathIgnorePatterns: [
     '<rootDir>/ecosystem-tests/',
     '<rootDir>/dist/',

jest.config.ts

@@ -23,105 +23,48 @@
     "lint": "./scripts/lint",
     "fix": "./scripts/format"
   },
-  "dependencies": {
-    "@types/node": "^18.11.18",
-    "@types/node-fetch": "^2.6.4",
-    "abort-controller": "^3.0.0",
-    "agentkeepalive": "^4.2.1",
-    "form-data-encoder": "1.7.2",
-    "formdata-node": "^4.3.2",
-    "node-fetch": "^2.6.7"
-  },
+  "dependencies": {},
   "devDependencies": {
+    "@arethetypeswrong/cli": "^0.17.0",
     "@swc/core": "^1.3.102",
     "@swc/jest": "^0.2.29",
     "@types/jest": "^29.4.0",
+    "@types/node": "^20.17.6",
     "@typescript-eslint/eslint-plugin": "^6.7.0",
-    "@typescript-eslint/parser": "^6.7.0",
+    "@typescript-eslint/parser": "^6.0.0",
     "eslint": "^8.49.0",
     "eslint-plugin-prettier": "^5.0.1",
     "eslint-plugin-unused-imports": "^3.0.0",
     "fast-check": "^3.22.0",
     "iconv-lite": "^0.6.3",
     "jest": "^29.4.0",
     "prettier": "^3.0.0",
-    "prettier-2": "npm:prettier@^2",
-    "segfault-handler": "^1.3.0",
+    "publint": "^0.2.12",
     "ts-jest": "^29.1.0",
     "ts-node": "^10.5.0",
-    "tsc-multi": "^1.1.0",
+    "tsc-multi": "https://github.com/stainless-api/tsc-multi/releases/download/v1.1.3/tsc-multi.tgz",
     "tsconfig-paths": "^4.0.0",
     "typescript": "^4.8.2",
     "zod": "^3.23.8"
   },
-  "sideEffects": [
-    "./_shims/index.js",
-    "./_shims/index.mjs",
-    "./shims/node.js",
-    "./shims/node.mjs",
-    "./shims/web.js",
-    "./shims/web.mjs"
-  ],
   "imports": {
     "openai": ".",
     "openai/*": "./src/*"
   },
   "exports": {
-    "./_shims/auto/*": {
-      "deno": {
-        "types": "./dist/_shims/auto/*.d.ts",
-        "require": "./dist/_shims/auto/*.js",
-        "default": "./dist/_shims/auto/*.mjs"
-      },
-      "bun": {
-        "types": "./dist/_shims/auto/*.d.ts",
-        "require": "./dist/_shims/auto/*-bun.js",
-        "default": "./dist/_shims/auto/*-bun.mjs"
-      },
-      "browser": {
-        "types": "./dist/_shims/auto/*.d.ts",
-        "require": "./dist/_shims/auto/*.js",
-        "default": "./dist/_shims/auto/*.mjs"
-      },
-      "worker": {
-        "types": "./dist/_shims/auto/*.d.ts",
-        "require": "./dist/_shims/auto/*.js",
-        "default": "./dist/_shims/auto/*.mjs"
-      },
-      "workerd": {
-        "types": "./dist/_shims/auto/*.d.ts",
-        "require": "./dist/_shims/auto/*.js",
-        "default": "./dist/_shims/auto/*.mjs"
-      },
-      "node": {
-        "types": "./dist/_shims/auto/*-node.d.ts",
-        "require": "./dist/_shims/auto/*-node.js",
-        "default": "./dist/_shims/auto/*-node.mjs"
-      },
-      "types": "./dist/_shims/auto/*.d.ts",
-      "require": "./dist/_shims/auto/*.js",
-      "default": "./dist/_shims/auto/*.mjs"
-    },
     ".": {
-      "require": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.js"
-      },
-      "types": "./dist/index.d.mts",
-      "default": "./dist/index.mjs"
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
     },
     "./*.mjs": {
-      "types": "./dist/*.d.ts",
       "default": "./dist/*.mjs"
     },
     "./*.js": {
-      "types": "./dist/*.d.ts",
       "default": "./dist/*.js"
     },
     "./*": {
-      "types": "./dist/*.d.ts",
-      "require": "./dist/*.js",
-      "default": "./dist/*.mjs"
+      "import": "./dist/*.mjs",
+      "require": "./dist/*.js"
     }
   },
   "bin": "./bin/cli",

package.json

@@ -15,7 +15,6 @@ rm -rf dist; mkdir dist
 # Copy src to dist/src and build from dist/src into dist, so that
 # the source map for index.js.map will refer to ./src/index.ts etc
 cp -rp src README.md dist
-rm dist/src/_shims/*-deno.ts dist/src/_shims/auto/*-deno.ts
 for file in LICENSE CHANGELOG.md; do
   if [ -e "${file}" ]; then cp "${file}" dist; fi
 done
@@ -29,9 +28,6 @@ node scripts/utils/make-dist-package-json.cjs > dist/package.json
 
 # build to .js/.mjs/.d.ts files
 npm exec tsc-multi
-# copy over handwritten .js/.mjs/.d.ts files
-cp src/_shims/*.{d.ts,js,mjs,md} dist/_shims
-cp src/_shims/auto/*.{d.ts,js,mjs} dist/_shims/auto
 # we need to add exports = module.exports = OpenAI to index.js;
 # No way to get that from index.ts because it would cause compile errors
 # when building .mjs
@@ -42,6 +38,10 @@ node scripts/utils/fix-index-exports.cjs
 # the same export default statement)
 cp dist/index.d.ts dist/index.d.mts
 cp tsconfig.dist-src.json dist/src/tsconfig.json
+cp src/internal/shim-types.d.ts dist/internal/shim-types.d.ts
+cp src/internal/shim-types.d.ts dist/internal/shim-types.d.mts
+mkdir -p dist/internal/polyfill
+cp src/internal/polyfill/*.{mjs,js,d.ts} dist/internal/polyfill
 
 node scripts/utils/postprocess-files.cjs
 

scripts/build

@@ -7,21 +7,6 @@ cd "$(dirname "$0")/.."
 rm -rf dist-deno; mkdir dist-deno
 cp -rp src/* jsr.json dist-deno
 
-rm -rf dist-deno/shims
-
-rm dist-deno/_shims/node*.{js,mjs,ts}
-rm dist-deno/_shims/manual*.{js,mjs,ts}
-rm dist-deno/_shims/index.{d.ts,js,mjs}
-for file in dist-deno/_shims/*-deno.ts; do
-	mv -- "$file" "${file%-deno.ts}.ts"
-done
-
-rm dist-deno/_shims/auto/*-node.ts
-rm dist-deno/_shims/auto/*.{d.ts,js,mjs}
-for file in dist-deno/_shims/auto/*-deno.ts; do
-	mv -- "$file" "${file%-deno.ts}.ts"
-done
-
 for file in README.md LICENSE CHANGELOG.md; do
   if [ -e "${file}" ]; then cp "${file}" dist-deno; fi
 done

scripts/build-deno

@@ -7,5 +7,12 @@ cd "$(dirname "$0")/.."
 echo "==> Running eslint"
 ESLINT_USE_FLAT_CONFIG="false" ./node_modules/.bin/eslint --ext ts,js .
 
-echo "==> Running tsc"
-./node_modules/.bin/tsc --noEmit
+echo "==> Building"
+./scripts/build # also checks types
+
+echo "==> Running Are The Types Wrong?"
+./node_modules/.bin/attw --pack dist -f json >.attw.json || true
+node scripts/utils/attw-report.cjs
+
+echo "==> Running publint"
+./node_modules/.bin/publint dist

scripts/lint

@@ -0,0 +1,21 @@
+const fs = require('fs');
+const problems = Object.values(JSON.parse(fs.readFileSync('.attw.json', 'utf-8')).problems)
+  .flat()
+  .filter(
+    (problem) =>
+      !(
+        // This is intentional, if the user specifies .mjs they get ESM.
+        (
+          (problem.kind === 'CJSResolvesToESM' && problem.entrypoint.endsWith('.mjs')) ||
+          // This is intentional for backwards compat reasons.
+          (problem.kind === 'MissingExportEquals' && problem.implementationFileName.endsWith('/index.js'))
+        )
+      ),
+  );
+fs.unlinkSync('.attw.json');
+if (problems.length) {
+  process.stdout.write('The types are wrong!\n' + JSON.stringify(problems, null, 2) + '\n');
+  process.exitCode = 1;
+} else {
+  process.stdout.write('Types ok!\n');
+}

scripts/utils/attw-report.cjs

@@ -8,7 +8,10 @@ const indexJs =
 
 let before = fs.readFileSync(indexJs, 'utf8');
 let after = before.replace(
-  /^\s*exports\.default\s*=\s*(\w+)/m,
-  'exports = module.exports = $1;\nmodule.exports.AzureOpenAI = AzureOpenAI;\nexports.default = $1',
+  /^(\s*Object\.defineProperty\s*\(exports,\s*["']__esModule["'].+)$/m,
+  `exports = module.exports = function (...args) {
+    return new exports.default(...args)
+  }
+  $1`.replace(/^  /gm, ''),
 );
 fs.writeFileSync(indexJs, after, 'utf8');