Merge pull request #277 from openai/release-please--branches--master--changes--next--components--openai

chore(next => master): release 4.5.0

Author: schnerd

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "4.4.0"
+  ".": "4.5.0"
 }

CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## 4.5.0 (2023-09-06)
+
+Full Changelog: [v4.4.0...v4.5.0](https://github.com/openai/openai-node/compare/v4.4.0...v4.5.0)
+
+### Features
+
+* **client:** add files.waitForProcessing() method ([#292](https://github.com/openai/openai-node/issues/292)) ([ef59010](https://github.com/openai/openai-node/commit/ef59010cab0c666fa8a437ec6e27800789aa8705))
+* fixes tests where an array has to have unique enum values ([#290](https://github.com/openai/openai-node/issues/290)) ([a10b895](https://github.com/openai/openai-node/commit/a10b8956b3eaae7cdcb90329a8386a41219ca021))
+* make docs more readable by eliminating unnecessary escape sequences ([#287](https://github.com/openai/openai-node/issues/287)) ([a068043](https://github.com/openai/openai-node/commit/a06804314d4815d420c97f6f965c926ea70d56df))
+
+
+### Bug Fixes
+
+* **client:** fix TS errors that appear when users Go to Source in VSCode ([#281](https://github.com/openai/openai-node/issues/281)) ([8dc59bc](https://github.com/openai/openai-node/commit/8dc59bcf924cc991747ca475c714d915e04c6012)), closes [#249](https://github.com/openai/openai-node/issues/249)
+* **client:** handle case where the client is instantiated with a undefined baseURL ([#285](https://github.com/openai/openai-node/issues/285)) ([5095cf3](https://github.com/openai/openai-node/commit/5095cf340743e4627b4f0ad2f055ebe332824d23))
+* **client:** use explicit file extensions in _shims imports ([#276](https://github.com/openai/openai-node/issues/276)) ([16fe929](https://github.com/openai/openai-node/commit/16fe929688d35c2ebe52c8cf1c1570bafda5f97e))
+
+
+### Documentation
+
+* **api:** update docstrings ([#286](https://github.com/openai/openai-node/issues/286)) ([664e953](https://github.com/openai/openai-node/commit/664e9532c8acfbf981e9a788ab40c111ebe2fda0))
+* **readme:** add link to api.md ([#291](https://github.com/openai/openai-node/issues/291)) ([0d1cce2](https://github.com/openai/openai-node/commit/0d1cce26cdc6567c10c8d72bbc72a788ffb8f2be))
+
 ## 4.4.0 (2023-09-01)
 
 Full Changelog: [v4.3.1...v4.4.0](https://github.com/openai/openai-node/compare/v4.3.1...v4.4.0)

README.md

@@ -18,7 +18,7 @@ yarn add openai
 
 ## Usage
 
-The full API of this library can be found in [API.md file](https://github.com/openai/openai-node/blob/master/api.md). The code below shows how to get started using the chat completions API.
+The full API of this library can be found in [api.md file](https://github.com/openai/openai-node/blob/master/api.md). The code below shows how to get started using the chat completions API.
 
 ```js
 import OpenAI from 'openai';
@@ -39,9 +39,6 @@ async function main() {
 main();
 ```
 
-> [!IMPORTANT]
-> Previous versions of this SDK used a `Configuration` class. See the [v3 to v4 migration guide](https://github.com/openai/openai-node/discussions/217).
-
 ## Streaming Responses
 
 We provide support for streaming responses using Server Sent Events (SSE).
@@ -92,6 +89,9 @@ main();
 
 Documentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.
 
+> [!IMPORTANT]
+> Previous versions of this SDK used a `Configuration` class. See the [v3 to v4 migration guide](https://github.com/openai/openai-node/discussions/217).
+
 ## File Uploads
 
 Request parameters that correspond to file uploads can be passed in many different forms:
@@ -309,6 +309,8 @@ We are keen for your feedback; please open an [issue](https://www.github.com/ope
 
 ## Requirements
 
+TypeScript >= 4.5 is supported.
+
 The following runtimes are supported:
 
 - Node.js 16 LTS or later ([non-EOL](https://endoflife.date/nodejs)) versions.

api.md

@@ -62,6 +62,7 @@ Methods:
 - <code title="get /files">client.files.<a href="./src/resources/files.ts">list</a>() -> FileObjectsPage</code>
 - <code title="delete /files/{file_id}">client.files.<a href="./src/resources/files.ts">del</a>(fileId) -> FileDeleted</code>
 - <code title="get /files/{file_id}/content">client.files.<a href="./src/resources/files.ts">retrieveContent</a>(fileId) -> string</code>
+- <code>client.files.<a href="./src/resources/files.ts">waitForProcessing</a>(id, { pollInterval = 5000, maxWait = 30 _ 60 _ 1000 }) -> Promise&lt;FileObject&gt;</code>
 
 # Images
 

build

@@ -12,6 +12,7 @@ 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.*
 for file in LICENSE CHANGELOG.md; do
   if [ -e "${file}" ]; then cp "${file}" dist; fi
 done
@@ -37,14 +38,14 @@ node scripts/fix-index-exports.cjs
 # index.d.mts the default import will work (even though both files have
 # 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
+cp tsconfig.dist-src.json dist/src/tsconfig.json
 
 # 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'
-find dist -type f -exec "${SED[@]}" "${REFERENCE_SUBS}" {} +
+find dist -type f -exec node scripts/remove-triple-slash-references.js {} +
+# strip out `unknown extends RequestInit ? never :` from dist/src/_shims;
+# these cause problems when viewing the .ts source files in go to definition
+find dist/src/_shims -type f -exec node scripts/replace-shim-guards.js {} +
 
 npm exec prettier -- --loglevel=warn --write .
 

ecosystem-tests/bun/bun.lockb

@@ -8,6 +8,6 @@
   "devDependencies": {
     "fastest-levenshtein": "^1.0.16",
     "bun-types": "latest",
-    "typescript": "^5.1.0"
+    "typescript": "5.0.4"
   }
 }

ecosystem-tests/bun/package.json

@@ -48,6 +48,10 @@ const projects = {
       await run('npm', ['test']);
     }
   },
+  'node-ts-cjs-ts4.5': async () => {
+    await installPackage();
+    await run('npm', ['run', 'tsc']);
+  },
   'node-ts-cjs-dom': async () => {
     await installPackage();
     await run('npm', ['run', 'tsc']);
@@ -296,8 +300,7 @@ async function withRetry(fn: () => Promise<void>, identifier: string, retryAmoun
     try {
       return await fn();
     } catch (err) {
-      retryAmount--;
-      if (retryAmount === 0) throw err;
+      if (--retryAmount <= 0) throw err;
       console.error(`${identifier} failed due to ${err}; retries left ${retryAmount}`);
     }
   } while (retryAmount > 0);