v4.0.0-beta.8

Author: schnerd

.gitignore

@@ -2,4 +2,5 @@ node_modules
 yarn-error.log
 codegen.log
 dist
+/deno
 /*.tgz

.prettierignore

@@ -1,3 +1,4 @@
 CHANGELOG.md
 /ecosystem-tests
 /node_modules
+/deno

README.md

@@ -230,11 +230,15 @@ await openai.models.list({
 })
 ```
 
-## Status
+## Semantic Versioning
 
-This package is in beta. Its internals and interfaces are not stable
-and subject to change without a major semver bump;
-please reach out if you rely on any undocumented behavior.
+This package generally attempts to follow [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:
+
+1. Changes that only affect static types, without breaking runtime behavior.
+2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals)_.
+3. Changes that we do not expect to impact the vast majority of users in practice.
+
+We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.
 
 We are keen for your feedback; please open an [issue](https://www.github.com/openai/openai-node/issues) with questions, bugs, or suggestions.
 

build

@@ -3,15 +3,12 @@ set -exuo pipefail
 
 node scripts/check-version.cjs
 
-yarn tsc
-
 # Build into dist and will publish the package from there,
 # so that src/resources/foo.ts becomes <package root>/resources/foo.js
 # This way importing from `"openai/resources/foo"` works
 # even with `"moduleResolution": "node"`
 
-rm -rf dist
-mkdir dist
+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
@@ -23,10 +20,10 @@ done
 node scripts/make-dist-package-json.cjs > dist/package.json
 
 # build to .js/.mjs/.d.ts files
-tsc-multi
+npm exec tsc-multi
 # copy over handwritten .js/.mjs/.d.ts files
 cp src/_shims/*.{d.ts,js,mjs} dist/_shims
-tsc-alias -p tsconfig.build.json
+npm exec tsc-alias -- -p tsconfig.build.json
 # we need to add exports = module.exports = OpenAI Node to index.js;
 # No way to get that from index.ts because it would cause compile errors
 # when building .mjs
@@ -37,19 +34,22 @@ node scripts/fix-index-exports.cjs
 # the same export default statement)
 cp dist/index.d.ts dist/index.d.mts
 
+SED=(sed -i)
+if [[ "$OSTYPE" == "darwin"* ]]; then SED=(sed -i ''); fi
+
 # strip out lib="dom" and types="node" references; these are needed at build time,
 # but would pollute the user's TS environment
 REFERENCE_SUBS='s/^ *\/\/\/ *<reference *lib="dom".*//g;s/^ *\/\/\/ *<reference *types="node".*//g'
-if [[ "$OSTYPE" == "darwin"* ]]; then
-  find dist -type f -exec sed -i '' "${REFERENCE_SUBS}" {} +
-else
-  find dist -type f -exec sed -i "${REFERENCE_SUBS}" {} +
-fi
+find dist -type f -exec "${SED[@]}" "${REFERENCE_SUBS}" {} +
 
-yarn prettier --loglevel=warn --write .
+npm exec prettier -- --loglevel=warn --write .
 
 # make sure that nothing crashes when we require the output CJS or
 # import the output ESM
-cd dist
-node -e 'require("openai")'
-node -e 'import("openai")' --input-type=module
+(cd dist && node -e 'require("openai")')
+(cd dist && node -e 'import("openai")' --input-type=module)
+
+if command -v deno &> /dev/null && [ -e ./build-deno ]
+then
+  ./build-deno
+fi

ecosystem-tests/ts-browser-webpack/src/index.ts

@@ -93,7 +93,7 @@ const model = 'whisper-1';
 
 const params = new URLSearchParams(location.search);
 
-const client = new OpenAI({ apiKey: params.get('apiKey') ?? undefined });
+const client = new OpenAI({ apiKey: params.get('apiKey') ?? undefined, dangerouslyAllowBrowser: true });
 
 async function typeTests() {
   // @ts-expect-error this should error if the `Uploadable` type was resolved correctly

examples/azure.ts

@@ -1,4 +1,4 @@
-#!/usr/bin/env yarn tsn -T
+#!/usr/bin/env -S npm run tsn -T
 
 import OpenAI from 'openai';
 

examples/demo.ts

@@ -1,4 +1,4 @@
-#!/usr/bin/env yarn tsn -T
+#!/usr/bin/env -S npm run tsn -T
 
 import OpenAI from 'openai';
 

examples/errors.ts

@@ -1,4 +1,4 @@
-#!/usr/bin/env yarn tsn -T
+#!/usr/bin/env -S npm run tsn -T
 
 import OpenAI, { NotFoundError } from 'openai';
 

examples/fine-tunes.ts

@@ -1,4 +1,4 @@
-#!/usr/bin/env yarn tsn -T
+#!/usr/bin/env -S npm run tsn -T
 
 /**
  * Fine-tuning allows you to train models on your own data.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "openai",
-  "version": "4.0.0-beta.7",
+  "version": "4.0.0-beta.8",
   "description": "Client library for the OpenAI API",
   "author": "OpenAI <[email protected]>",
   "types": "dist/index.d.ts",
@@ -91,6 +91,7 @@
     "jest": "^29.4.0",
     "prettier": "rattrayalex/prettier#postfix-ternaries",
     "ts-jest": "^29.1.0",
+    "ts-morph": "^19.0.0",
     "ts-node": "^10.5.0",
     "tsc-alias": "^1.8.6",
     "tsc-multi": "^1.1.0",