openai 4.0.0-beta.0 → 4.0.0-beta.10

package/README.md

@@ -2,12 +2,9 @@
 
 [![NPM version](https://img.shields.io/npm/v/openai.svg)](https://npmjs.org/package/openai)
 
-The OpenAI Node library provides convenient access to the OpenAI REST API from applications written in server-side JavaScript.
-It includes TypeScript definitions for all request params and response fields.
+This library provides convenient access to the OpenAI REST API from TypeScript or JavaScript.
 
-> ⚠️ **Important note: this library is meant for server-side usage only, as using it in client-side browser code will expose your secret API key. [See here](https://platform.openai.com/docs/api-reference/authentication) for more details.**
-
-## Documentation
+It is generated from our [OpenAPI specification](https://github.com/openai/openai-openapi) with [Stainless](https://stainlessapi.com/).
 
 To learn how to use the OpenAI API, check out our [API Reference](https://platform.openai.com/docs/api-reference) and [Documentation](https://platform.openai.com/docs).
 
@@ -21,24 +18,26 @@ yarn add openai
 
 ## Usage
 
+> [!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).
+
 ```js
 import OpenAI from 'openai';
 
-const openAI = new OpenAI({
+const openai = new OpenAI({
   apiKey: 'my api key', // defaults to process.env["OPENAI_API_KEY"]
 });
 
 async function main() {
-  const completion = await openAI.completions.create({
-    model: 'text-davinci-002',
-    prompt: 'Say this is a test',
-    max_tokens: 6,
-    temperature: 0,
+  const completion = await openai.chat.completions.create({
+    messages: [{ role: 'user', content: 'Say this is a test' }],
+    model: 'gpt-3.5-turbo',
   });
 
   console.log(completion.choices);
 }
-main().catch(console.error);
+
+main();
 ```
 
 ## Streaming Responses
@@ -48,60 +47,83 @@ We provide support for streaming responses using Server Side Events (SSE).
 ```ts
 import OpenAI from 'openai';
 
-const client = new OpenAI();
+const openai = new OpenAI();
 
-const stream = await client.completions.create({
-  prompt: 'Say this is a test',
-  model: 'text-davinci-003',
-  stream: true,
-});
-for await (const part of stream) {
-  process.stdout.write(part.choices[0]?.text || '');
+async function main() {
+  const stream = await openai.chat.completions.create({
+    model: 'gpt-4',
+    messages: [{ role: 'user', content: 'Say this is a test' }],
+    stream: true,
+  });
+  for await (const part of stream) {
+    process.stdout.write(part.choices[0]?.delta?.content || '');
+  }
 }
+
+main();
 ```
 
 If you need to cancel a stream, you can `break` from the loop
 or call `stream.controller.abort()`.
 
-### Usage with TypeScript
+### Request & Response types
 
-Importing, instantiating, and interacting with the library are the same as above.
-If you like, you may reference our types directly:
+This library includes TypeScript definitions for all request params and response fields. You may import and use them like so:
 
 ```ts
 import OpenAI from 'openai';
 
-const openAI = new OpenAI({
+const openai = new OpenAI({
   apiKey: 'my api key', // defaults to process.env["OPENAI_API_KEY"]
 });
 
 async function main() {
-  const params: OpenAI.CompletionCreateParams = {
-    model: 'text-davinci-002',
-    prompt: 'Say this is a test',
-    max_tokens: 6,
-    temperature: 0,
+  const params: OpenAI.Chat.CompletionCreateParams = {
+    messages: [{ role: 'user', content: 'Say this is a test' }],
+    model: 'gpt-3.5-turbo',
   };
-  const completion: OpenAI.Completion = await openAI.completions.create(params);
+  const completion: OpenAI.Chat.ChatCompletion = await openai.chat.completions.create(params);
 }
-main().catch(console.error);
+
+main();
 ```
 
 Documentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.
 
 ## File Uploads
 
-Request parameters that correspond to file uploads can be passed as either a `FormData.Blob` or a `FormData.File` instance.
+Request parameters that correspond to file uploads can be passed in many different forms:
 
-We provide a `fileFromPath` helper function to easily create `FormData.File` instances from a given class.
+- `File` (or an object with the same structure)
+- a `fetch` `Response` (or an object with the same structure)
+- an `fs.ReadStream`
+- the return value of our `toFile` helper
 
 ```ts
-import OpenAI, { fileFromPath } from 'openai';
+import fs from 'fs';
+import fetch from 'node-fetch';
+import OpenAI, { toFile } from 'openai';
+
+const openai = new OpenAI();
 
-const openAI = new OpenAI();
+// If you have access to Node `fs` we recommend using `fs.createReadStream()`:
+await openai.files.create({ file: fs.createReadStream('input.jsonl'), purpose: 'fine-tune' });
 
-const file = await fileFromPath('input.jsonl');
-await openAI.files.create({ file: file, purpose: 'fine-tune' });
+// Or if you have the web `File` API you can pass a `File` instance:
+await openai.files.create({ file: new File(['my bytes'], 'input.jsonl'), purpose: 'fine-tune' });
+
+// You can also pass a `fetch` `Response`:
+await openai.files.create({ file: await fetch('https://somesite/input.jsonl'), purpose: 'fine-tune' });
+
+// Finally, if none of the above are convenient, you can use our `toFile` helper:
+await openai.files.create({
+  file: await toFile(Buffer.from('my bytes'), 'input.jsonl'),
+  purpose: 'fine-tune',
+});
+await openai.files.create({
+  file: await toFile(new Uint8Array([0, 1, 2]), 'input.jsonl'),
+  purpose: 'fine-tune',
+});
 ```
 
 ## Handling errors
@@ -112,7 +134,7 @@ a subclass of `APIError` will be thrown:
 
 ```ts
 async function main() {
-  const fineTune = await openAI.fineTunes
+  const fineTune = await openai.fineTunes
     .create({ training_file: 'file-XGinujblHPwGLSztz8cPS8XY' })
     .catch((err) => {
       if (err instanceof OpenAI.APIError) {
@@ -120,10 +142,13 @@ async function main() {
         console.log(err.name); // BadRequestError
 
         console.log(err.headers); // {server: 'nginx', ...}
+      } else {
+        throw err;
       }
     });
 }
-main().catch(console.error);
+
+main();
 ```
 
 Error codes are as followed:
@@ -150,12 +175,12 @@ You can use the `maxRetries` option to configure or disable this:
 <!-- prettier-ignore -->
 ```js
 // Configure the default for all requests:
-const openAI = new OpenAI({
+const openai = new OpenAI({
   maxRetries: 0, // default is 2
 });
 
 // Or, configure per-request:
-openAI.embeddings.create({ model: 'text-similarity-babbage-001',input: 'The food was delicious and the waiter...' }, {
+await openai.chat.completions.create({ messages: [{ role: 'user', content: 'How can I get the name of the current day in Node.js?' }], model: 'gpt-3.5-turbo' }, {
   maxRetries: 5,
 });
 ```
@@ -167,12 +192,12 @@ Requests time out after 60 seconds by default. You can configure this with a `ti
 <!-- prettier-ignore -->
 ```ts
 // Configure the default for all requests:
-const openAI = new OpenAI({
+const openai = new OpenAI({
   timeout: 20 * 1000, // 20 seconds (default is 60s)
 });
 
 // Override per-request:
-openAI.edits.create({ model: 'text-davinci-edit-001',input: 'What day of the wek is it?',instruction: 'Fix the spelling mistakes' }, {
+await openai.chat.completions.create({ messages: [{ role: 'user', content: 'How can I list all files in a directory using Python?' }], model: 'gpt-3.5-turbo' }, {
   timeout: 5 * 1000,
 });
 ```
@@ -181,6 +206,30 @@ On timeout, an `APIConnectionTimeoutError` is thrown.
 
 Note that requests which time out will be [retried twice by default](#retries).
 
+## Advanced Usage
+
+### Accessing raw Response data (e.g., headers)
+
+The "raw" `Response` returned by `fetch()` can be accessed through the `.asResponse()` method on the `APIPromise` type that all methods return.
+
+You can also use the `.withResponse()` method to get the raw `Response` along with the parsed data.
+
+```ts
+const openai = new OpenAI();
+
+const response = await openai.chat.completions
+  .create({ messages: [{ role: 'user', content: 'Say this is a test' }], model: 'gpt-3.5-turbo' })
+  .asResponse();
+console.log(response.headers.get('X-My-Header'));
+console.log(response.statusText); // access the underlying Response object
+
+const { data: completions, response: raw } = await openai.chat.completions
+  .create({ messages: [{ role: 'user', content: 'Say this is a test' }], model: 'gpt-3.5-turbo' })
+  .withResponse();
+console.log(raw.headers.get('X-My-Header'));
+console.log(completions.choices);
+```
+
 ## Configuring an HTTP(S) Agent (e.g., for proxies)
 
 By default, this library uses a stable agent for all http/https requests to reuse TCP connections, eliminating many TCP & TLS handshakes and shaving around 100ms off most requests.
@@ -193,22 +242,26 @@ import http from 'http';
 import HttpsProxyAgent from 'https-proxy-agent';
 
 // Configure the default for all requests:
-const openAI = new OpenAI({
+const openai = new OpenAI({
   httpAgent: new HttpsProxyAgent(process.env.PROXY_URL),
 });
 
 // Override per-request:
-openAI.models.list({
+await openai.models.list({
   baseURL: 'http://localhost:8080/test-api',
   httpAgent: new http.Agent({ keepAlive: false }),
 })
 ```
 
-## Status
+## Semantic Versioning
+
+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.
 
-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.
+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.
 
@@ -216,8 +269,10 @@ We are keen for your feedback; please open an [issue](https://www.github.com/ope
 
 The following runtimes are supported:
 
-- Node.js version 12 or higher.
-- Deno v1.28.0 or higher (experimental).
-  Use `import OpenAI from "npm:openai"`.
+- Node.js 16 LTS or later ([non-EOL](https://endoflife.date/nodejs)) versions.
+- Deno v1.28.0 or higher, using `import OpenAI from "npm:openai"`.
+  Deno Deploy is not yet supported.
+- Cloudflare Workers.
+- Vercel Edge Runtime.
 
 If you are interested in other runtime environments, please open or upvote an issue on GitHub.

package/_shims/ReadableStream.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+
+/**
+ * >>> Confused? <<<
+ *
+ * If you're getting errors from these types, try adding "lib": ["DOM"]
+ * to your tsconfig.json, or otherwise configure the appropriate builtin
+ * `ReadableStream` type for your environment.
+ */
+
+// @ts-ignore
+type _ReadableStream<R = any> = unknown extends ReadableStream ? never : ReadableStream<R>;
+declare const _ReadableStream: {
+  prototype: _ReadableStream;
+  new (
+    underlyingSource: _UnderlyingByteSource,
+    strategy?: { highWaterMark?: number },
+  ): _ReadableStream<Uint8Array>;
+  new <R = any>(
+    underlyingSource: _UnderlyingDefaultSource<R>,
+    strategy?: _QueuingStrategy<R>,
+  ): _ReadableStream<R>;
+  new <R = any>(underlyingSource?: _UnderlyingSource<R>, strategy?: _QueuingStrategy<R>): _ReadableStream<R>;
+};
+
+// @ts-ignore
+type _UnderlyingSource<R = any> = unknown extends UnderlyingSource ? never : UnderlyingSource<R>;
+// @ts-ignore
+type _UnderlyingByteSource = unknown extends UnderlyingByteSource ? never : UnderlyingByteSource;
+type _UnderlyingDefaultSource<R = any> =
+  // @ts-ignore
+  unknown extends UnderlyingDefaultSource ? never : UnderlyingDefaultSource<R>;
+// @ts-ignore
+type _QueuingStrategy<R = any> = unknown extends QueuingStrategy ? never : QueuingStrategy<R>;
+
+export { _ReadableStream as ReadableStream };

package/_shims/ReadableStream.js

@@ -0,0 +1,5 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+
+exports.ReadableStream = ReadableStream;

package/_shims/ReadableStream.mjs

@@ -0,0 +1,7 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+
+const _ReadableStream = ReadableStream;
+
+export { _ReadableStream as ReadableStream };

package/_shims/ReadableStream.node.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+import { ReadableStream } from 'web-streams-polyfill';
+export { ReadableStream };
+//# sourceMappingURL=ReadableStream.node.d.ts.map

package/_shims/ReadableStream.node.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReadableStream.node.d.ts","sourceRoot":"","sources":["../src/_shims/ReadableStream.node.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAEtD,OAAO,EAAE,cAAc,EAAE,CAAC"}

package/_shims/ReadableStream.node.js

@@ -0,0 +1,14 @@
+'use strict';
+Object.defineProperty(exports, '__esModule', { value: true });
+exports.ReadableStream = void 0;
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+const web_streams_polyfill_1 = require('web-streams-polyfill');
+Object.defineProperty(exports, 'ReadableStream', {
+  enumerable: true,
+  get: function () {
+    return web_streams_polyfill_1.ReadableStream;
+  },
+});
+//# sourceMappingURL=ReadableStream.node.js.map

package/_shims/ReadableStream.node.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReadableStream.node.js","sourceRoot":"","sources":["../src/_shims/ReadableStream.node.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,+DAAsD;AAE7C,+FAFA,qCAAc,OAEA"}

package/_shims/ReadableStream.node.mjs

@@ -0,0 +1,3 @@
+import { ReadableStream } from 'web-streams-polyfill';
+export { ReadableStream };
+//# sourceMappingURL=ReadableStream.node.mjs.map

package/_shims/ReadableStream.node.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReadableStream.node.mjs","sourceRoot":"","sources":["../src/_shims/ReadableStream.node.ts"],"names":[],"mappings":"OAGO,EAAE,cAAc,EAAE,MAAM,sBAAsB;AAErD,OAAO,EAAE,cAAc,EAAE,CAAC"}

package/_shims/agent.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ *
+ * This is a stub for non-node environments.
+ * In node environments, it gets replaced agent.node.ts by the package export map
+ */
+export type Agent = any;
+export declare const getDefaultAgent: (url: string) => any;
+//# sourceMappingURL=agent.d.ts.map

package/_shims/agent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"agent.d.ts","sourceRoot":"","sources":["../src/_shims/agent.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,MAAM,KAAK,GAAG,GAAG,CAAC;AAExB,eAAO,MAAM,eAAe,QAAS,MAAM,KAAG,GAE7C,CAAC"}

package/_shims/agent.js

@@ -0,0 +1,14 @@
+'use strict';
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ *
+ * This is a stub for non-node environments.
+ * In node environments, it gets replaced agent.node.ts by the package export map
+ */
+Object.defineProperty(exports, '__esModule', { value: true });
+exports.getDefaultAgent = void 0;
+const getDefaultAgent = (url) => {
+  return undefined;
+};
+exports.getDefaultAgent = getDefaultAgent;
+//# sourceMappingURL=agent.js.map

package/_shims/agent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"agent.js","sourceRoot":"","sources":["../src/_shims/agent.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAII,MAAM,eAAe,GAAG,CAAC,GAAW,EAAO,EAAE;IAClD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAFW,QAAA,eAAe,mBAE1B"}

package/_shims/agent.mjs

@@ -0,0 +1,10 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ *
+ * This is a stub for non-node environments.
+ * In node environments, it gets replaced agent.node.ts by the package export map
+ */
+export const getDefaultAgent = (url) => {
+  return undefined;
+};
+//# sourceMappingURL=agent.mjs.map

package/_shims/agent.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"agent.mjs","sourceRoot":"","sources":["../src/_shims/agent.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAIH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,GAAW,EAAO,EAAE;IAClD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC"}

package/_shims/agent.node.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+import type { Agent } from 'node:http';
+export type { Agent };
+export declare const getDefaultAgent: (url: string) => Agent | undefined;
+//# sourceMappingURL=agent.node.d.ts.map

package/_shims/agent.node.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"agent.node.d.ts","sourceRoot":"","sources":["../src/_shims/agent.node.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAGvC,YAAY,EAAE,KAAK,EAAE,CAAC;AAUtB,eAAO,MAAM,eAAe,QAAS,MAAM,KAAG,KAAK,GAAG,SAGrD,CAAC"}

package/_shims/agent.node.js

@@ -0,0 +1,28 @@
+'use strict';
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+var __importDefault =
+  (this && this.__importDefault) ||
+  function (mod) {
+    return mod && mod.__esModule ? mod : { default: mod };
+  };
+Object.defineProperty(exports, '__esModule', { value: true });
+exports.getDefaultAgent = void 0;
+const agentkeepalive_1 = __importDefault(require('agentkeepalive'));
+const abort_controller_1 = require('abort-controller');
+const defaultHttpAgent = new agentkeepalive_1.default({ keepAlive: true, timeout: 5 * 60 * 1000 });
+const defaultHttpsAgent = new agentkeepalive_1.default.HttpsAgent({
+  keepAlive: true,
+  timeout: 5 * 60 * 1000,
+});
+// Polyfill global object if needed.
+if (typeof AbortController === 'undefined') {
+  AbortController = abort_controller_1.AbortController;
+}
+const getDefaultAgent = (url) => {
+  if (defaultHttpsAgent && url.startsWith('https')) return defaultHttpsAgent;
+  return defaultHttpAgent;
+};
+exports.getDefaultAgent = getDefaultAgent;
+//# sourceMappingURL=agent.node.js.map

package/_shims/agent.node.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"agent.node.js","sourceRoot":"","sources":["../src/_shims/agent.node.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;AAEH,oEAA4C;AAE5C,uDAA8E;AAI9E,MAAM,gBAAgB,GAAU,IAAI,wBAAc,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,GAAG,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;AAChG,MAAM,iBAAiB,GAAU,IAAI,wBAAc,CAAC,UAAU,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,GAAG,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;AAE5G,oCAAoC;AACpC,IAAI,OAAO,eAAe,KAAK,WAAW,EAAE;IAC1C,eAAe,GAAG,kCAAwD,CAAC;CAC5E;AAEM,MAAM,eAAe,GAAG,CAAC,GAAW,EAAqB,EAAE;IAChE,IAAI,iBAAiB,IAAI,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC;QAAE,OAAO,iBAAiB,CAAC;IAC3E,OAAO,gBAAgB,CAAC;AAC1B,CAAC,CAAC;AAHW,QAAA,eAAe,mBAG1B"}

package/_shims/agent.node.mjs

@@ -0,0 +1,16 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+import KeepAliveAgent from 'agentkeepalive';
+import { AbortController as AbortControllerPolyfill } from 'abort-controller';
+const defaultHttpAgent = new KeepAliveAgent({ keepAlive: true, timeout: 5 * 60 * 1000 });
+const defaultHttpsAgent = new KeepAliveAgent.HttpsAgent({ keepAlive: true, timeout: 5 * 60 * 1000 });
+// Polyfill global object if needed.
+if (typeof AbortController === 'undefined') {
+  AbortController = AbortControllerPolyfill;
+}
+export const getDefaultAgent = (url) => {
+  if (defaultHttpsAgent && url.startsWith('https')) return defaultHttpsAgent;
+  return defaultHttpAgent;
+};
+//# sourceMappingURL=agent.node.mjs.map

package/_shims/agent.node.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"agent.node.mjs","sourceRoot":"","sources":["../src/_shims/agent.node.ts"],"names":[],"mappings":"AAAA;;GAEG;OAEI,cAAc,MAAM,gBAAgB;OAEpC,EAAE,eAAe,IAAI,uBAAuB,EAAE,MAAM,kBAAkB;AAI7E,MAAM,gBAAgB,GAAU,IAAI,cAAc,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,GAAG,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;AAChG,MAAM,iBAAiB,GAAU,IAAI,cAAc,CAAC,UAAU,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,GAAG,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;AAE5G,oCAAoC;AACpC,IAAI,OAAO,eAAe,KAAK,WAAW,EAAE;IAC1C,eAAe,GAAG,uBAAwD,CAAC;CAC5E;AAED,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,GAAW,EAAqB,EAAE;IAChE,IAAI,iBAAiB,IAAI,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC;QAAE,OAAO,iBAAiB,CAAC;IAC3E,OAAO,gBAAgB,CAAC;AAC1B,CAAC,CAAC"}

package/_shims/fetch.d.ts

@@ -0,0 +1,59 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+
+// Use builtin web types if present; else never (user should
+// add appropriate lib or types to tsconfig)
+
+/**
+ * >>> Confused? <<<
+ *
+ * If you're getting errors from these types, try adding "lib": ["DOM"]
+ * to your tsconfig.json, or otherwise configure the appropriate builtin
+ * `fetch` types for your environment.
+ */
+
+// @ts-ignore
+type _fetch = unknown extends typeof fetch ? never : typeof fetch;
+// @ts-ignore
+type _Request = unknown extends Request ? never : Request;
+// @ts-ignore
+type _RequestInfo = unknown extends RequestInfo ? never : RequestInfo;
+// @ts-ignore
+type _RequestInit = unknown extends RequestInit ? never : RequestInit;
+// @ts-ignore
+type _Response = unknown extends Response ? never : Response;
+// @ts-ignore
+type _ResponseInit = unknown extends ResponseInit ? never : ResponseInit;
+// @ts-ignore
+type _ResponseType = unknown extends ResponseType ? never : ResponseType;
+// @ts-ignore
+type _BodyInit = unknown extends BodyInit ? never : BodyInit;
+// @ts-ignore
+type _Headers = unknown extends Headers ? never : Headers;
+// @ts-ignore
+type _HeadersInit = unknown extends HeadersInit ? never : HeadersInit;
+
+declare const _fetch: _fetch;
+declare const _Request: {
+  prototype: _Request;
+  new (input: _RequestInfo | URL, init?: _RequestInit): _Request;
+};
+declare const _Response: {
+  prototype: _Response;
+  new (body?: _BodyInit | null, init?: _ResponseInit): _Response;
+};
+declare const _Headers: {
+  prototype: _Headers;
+  new (init?: _HeadersInit): _Headers;
+};
+
+export const isPolyfilled = false;
+
+export { _fetch as fetch, _Request as Request, _Response as Response, _Headers as Headers };
+export type {
+  _RequestInit as RequestInit,
+  _RequestInfo as RequestInfo,
+  _ResponseType as ResponseType,
+  _BodyInit as BodyInit,
+};

package/_shims/fetch.js

@@ -0,0 +1,13 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+
+// If we accidentally call fetch with the wrong this binding,
+// in the browser it would throw:
+//   TypeError: Failed to execute 'fetch' on 'Window': Illegal invocation
+exports.fetch = fetch.bind(undefined);
+exports.Request = Request;
+exports.Response = Response;
+exports.Headers = Headers;
+
+exports.isPolyfilled = false;

package/_shims/fetch.mjs

@@ -0,0 +1,15 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+
+// If we accidentally call fetch with the wrong this binding,
+// in the browser it would throw:
+//   TypeError: Failed to execute 'fetch' on 'Window': Illegal invocation
+const _fetch = fetch.bind(undefined);
+const _Request = Request;
+const _Response = Response;
+const _Headers = Headers;
+
+export const isPolyfilled = false;
+
+export { _fetch as fetch, _Request as Request, _Response as Response, _Headers as Headers };

package/_shims/fetch.node.d.ts

@@ -0,0 +1,63 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+
+import * as nf from 'node-fetch';
+
+// Use builtin web types if present; else node-fetch types
+
+/**
+ * >>> Confused? <<<
+ *
+ * If you're getting errors from these types, try adding "lib": ["DOM"]
+ * to your tsconfig.json, or otherwise configure the appropriate builtin
+ * `fetch` types for your environment.
+ */
+
+// @ts-ignore
+type _fetch = unknown extends typeof fetch ? typeof nf.default : typeof fetch;
+// @ts-ignore
+type _Request = unknown extends Request ? nf.Request : Request;
+// @ts-ignore
+type _RequestInfo = unknown extends RequestInfo ? nf.RequestInfo : RequestInfo;
+// @ts-ignore
+type _RequestInit = unknown extends RequestInit ? nf.RequestInit : RequestInit;
+// @ts-ignore
+type _Response = unknown extends Response ? nf.Response : Response;
+// @ts-ignore
+type _ResponseInit = unknown extends ResponseInit ? nf.ResponseInit : ResponseInit;
+type _ResponseType =
+  // @ts-ignore
+  unknown extends ResponseType ? 'basic' | 'cors' | 'default' | 'error' | 'opaque' | 'opaqueredirect'
+  : // @ts-ignore
+    ResponseType;
+// @ts-ignore
+type _BodyInit = unknown extends BodyInit ? nf.BodyInit : BodyInit;
+// @ts-ignore
+type _Headers = unknown extends Headers ? nf.Headers : Headers;
+// @ts-ignore
+type _HeadersInit = unknown extends HeadersInit ? nf.HeadersInit : HeadersInit;
+
+declare const _fetch: _fetch;
+declare const _Request: {
+  prototype: _Request;
+  new (input: _RequestInfo | URL, init?: _RequestInit): _Request;
+};
+declare const _Response: {
+  prototype: _Response;
+  new (body?: _BodyInit | null, init?: _ResponseInit): _Response;
+};
+declare const _Headers: {
+  prototype: _Headers;
+  new (init?: _HeadersInit): _Headers;
+};
+
+export const isPolyfilled = false;
+
+export { _fetch as fetch, _Request as Request, _Response as Response, _Headers as Headers };
+export type {
+  _RequestInit as RequestInit,
+  _RequestInfo as RequestInfo,
+  _ResponseType as ResponseType,
+  _BodyInit as BodyInit,
+};