@tryfinch/finch-api 5.1.0 → 5.3.0

package/resources/webhooks.mjs

@@ -3,112 +3,108 @@ import { APIResource } from '@tryfinch/finch-api/resource';
 import { createHmac } from 'crypto';
 import { getHeader } from '@tryfinch/finch-api/core';
 export class Webhooks extends APIResource {
-  /**
-   * Validates that the given payload was sent by Finch and parses the payload.
-   */
-  unwrap(payload, headers, secret = this.client.webhookSecret) {
-    this.verifySignature(payload, headers, secret);
-    return JSON.parse(payload);
-  }
-  parseSecret(secret) {
-    if (!secret) {
-      throw new Error(
-        "The webhook secret must either be set using the env var, FINCH_WEBHOOK_SECRET, on the client class, Finch({ webhook_secret: '123' }), or passed to this function",
-      );
+    /**
+     * Validates that the given payload was sent by Finch and parses the payload.
+     */
+    unwrap(payload, headers, secret = this.client.webhookSecret) {
+        this.verifySignature(payload, headers, secret);
+        return JSON.parse(payload);
     }
-    const buf = Buffer.from(secret, 'base64');
-    if (buf.toString('base64') !== secret) {
-      throw new Error(`Given secret is not valid`);
+    parseSecret(secret) {
+        if (!secret) {
+            throw new Error("The webhook secret must either be set using the env var, FINCH_WEBHOOK_SECRET, on the client class, Finch({ webhook_secret: '123' }), or passed to this function");
+        }
+        const buf = Buffer.from(secret, 'base64');
+        if (buf.toString('base64') !== secret) {
+            throw new Error(`Given secret is not valid`);
+        }
+        return new Uint8Array(buf);
     }
-    return new Uint8Array(buf);
-  }
-  signPayload(payload, { eventId, timestamp, secret }) {
-    const encoder = new TextEncoder();
-    const toSign = encoder.encode(`${eventId}.${timestamp.getTime() / 1000}.${payload}`);
-    const hmac = createHmac('sha256', secret);
-    hmac.update(toSign);
-    return `v1,${hmac.digest('base64')}`;
-  }
-  /** Make an assertion, if not `true`, then throw. */
-  assert(expr, msg = '') {
-    if (!expr) {
-      throw new Error(msg);
+    signPayload(payload, { eventId, timestamp, secret }) {
+        const encoder = new TextEncoder();
+        const toSign = encoder.encode(`${eventId}.${timestamp.getTime() / 1000}.${payload}`);
+        const hmac = createHmac('sha256', secret);
+        hmac.update(toSign);
+        return `v1,${hmac.digest('base64')}`;
     }
-  }
-  /** Compare to array buffers or data views in a way that timing based attacks
-   * cannot gain information about the platform. */
-  timingSafeEqual(a, b) {
-    if (a.byteLength !== b.byteLength) {
-      return false;
+    /** Make an assertion, if not `true`, then throw. */
+    assert(expr, msg = '') {
+        if (!expr) {
+            throw new Error(msg);
+        }
     }
-    if (!(a instanceof DataView)) {
-      a = new DataView(ArrayBuffer.isView(a) ? a.buffer : a);
+    /** Compare to array buffers or data views in a way that timing based attacks
+     * cannot gain information about the platform. */
+    timingSafeEqual(a, b) {
+        if (a.byteLength !== b.byteLength) {
+            return false;
+        }
+        if (!(a instanceof DataView)) {
+            a = new DataView(ArrayBuffer.isView(a) ? a.buffer : a);
+        }
+        if (!(b instanceof DataView)) {
+            b = new DataView(ArrayBuffer.isView(b) ? b.buffer : b);
+        }
+        this.assert(a instanceof DataView);
+        this.assert(b instanceof DataView);
+        const length = a.byteLength;
+        let out = 0;
+        let i = -1;
+        while (++i < length) {
+            out |= a.getUint8(i) ^ b.getUint8(i);
+        }
+        return out === 0;
     }
-    if (!(b instanceof DataView)) {
-      b = new DataView(ArrayBuffer.isView(b) ? b.buffer : b);
+    /**
+     * Validates whether or not the webhook payload was sent by Finch.
+     *
+     * An error will be raised if the webhook payload was not sent by Finch.
+     */
+    verifySignature(body, headers, secret = this.client.webhookSecret) {
+        const parsedSecret = this.parseSecret(secret);
+        const eventId = getHeader(headers, 'finch-event-id');
+        if (!eventId) {
+            throw new Error('Could not find finch-event-id header');
+        }
+        const msgTimestamp = getHeader(headers, 'finch-timestamp');
+        if (!msgTimestamp) {
+            throw new Error('Could not find finch-timestamp header');
+        }
+        const msgSignature = getHeader(headers, 'finch-signature');
+        if (!msgSignature) {
+            throw new Error('Could not find finch-signature header');
+        }
+        const now = Math.floor(Date.now() / 1000);
+        const timestampSeconds = parseInt(msgTimestamp, 10);
+        if (isNaN(timestampSeconds)) {
+            throw new Error(`Invalid timestamp header: ${msgTimestamp}`);
+        }
+        if (typeof body !== 'string') {
+            throw new Error('Webhook body must be passed as the raw JSON string sent from the server (do not parse it first).');
+        }
+        const webhook_tolerance_in_seconds = 5 * 60; // 5 minutes
+        if (now - timestampSeconds > webhook_tolerance_in_seconds) {
+            throw new Error('Webhook timestamp is too old');
+        }
+        if (timestampSeconds > now + webhook_tolerance_in_seconds) {
+            throw new Error('Webhook timestamp is too new');
+        }
+        const timestamp = new Date(timestampSeconds * 1000);
+        const computedSignature = this.signPayload(body, { eventId, timestamp, secret: parsedSecret });
+        const expectedSignature = computedSignature.split(',')[1];
+        const passedSignatures = msgSignature.split(' ');
+        const encoder = new globalThis.TextEncoder();
+        for (const versionedSignature of passedSignatures) {
+            const [version, signature] = versionedSignature.split(',');
+            if (version !== 'v1') {
+                continue;
+            }
+            if (this.timingSafeEqual(encoder.encode(signature), encoder.encode(expectedSignature))) {
+                // valid!
+                return;
+            }
+        }
+        throw new Error('None of the given webhook signatures match the expected signature');
     }
-    this.assert(a instanceof DataView);
-    this.assert(b instanceof DataView);
-    const length = a.byteLength;
-    let out = 0;
-    let i = -1;
-    while (++i < length) {
-      out |= a.getUint8(i) ^ b.getUint8(i);
-    }
-    return out === 0;
-  }
-  /**
-   * Validates whether or not the webhook payload was sent by Finch.
-   *
-   * An error will be raised if the webhook payload was not sent by Finch.
-   */
-  verifySignature(body, headers, secret = this.client.webhookSecret) {
-    const parsedSecret = this.parseSecret(secret);
-    const eventId = getHeader(headers, 'finch-event-id');
-    if (!eventId) {
-      throw new Error('Could not find finch-event-id header');
-    }
-    const msgTimestamp = getHeader(headers, 'finch-timestamp');
-    if (!msgTimestamp) {
-      throw new Error('Could not find finch-timestamp header');
-    }
-    const msgSignature = getHeader(headers, 'finch-signature');
-    if (!msgSignature) {
-      throw new Error('Could not find finch-signature header');
-    }
-    const now = Math.floor(Date.now() / 1000);
-    const timestampSeconds = parseInt(msgTimestamp, 10);
-    if (isNaN(timestampSeconds)) {
-      throw new Error(`Invalid timestamp header: ${msgTimestamp}`);
-    }
-    if (typeof body !== 'string') {
-      throw new Error(
-        'Webhook body must be passed as the raw JSON string sent from the server (do not parse it first).',
-      );
-    }
-    const webhook_tolerance_in_seconds = 5 * 60; // 5 minutes
-    if (now - timestampSeconds > webhook_tolerance_in_seconds) {
-      throw new Error('Webhook timestamp is too old');
-    }
-    if (timestampSeconds > now + webhook_tolerance_in_seconds) {
-      throw new Error('Webhook timestamp is too new');
-    }
-    const timestamp = new Date(timestampSeconds * 1000);
-    const computedSignature = this.signPayload(body, { eventId, timestamp, secret: parsedSecret });
-    const expectedSignature = computedSignature.split(',')[1];
-    const passedSignatures = msgSignature.split(' ');
-    const encoder = new globalThis.TextEncoder();
-    for (const versionedSignature of passedSignatures) {
-      const [version, signature] = versionedSignature.split(',');
-      if (version !== 'v1') {
-        continue;
-      }
-      if (this.timingSafeEqual(encoder.encode(signature), encoder.encode(expectedSignature))) {
-        // valid!
-        return;
-      }
-    }
-    throw new Error('None of the given webhook signatures match the expected signature');
-  }
 }
-//# sourceMappingURL=webhooks.mjs.map
+//# sourceMappingURL=webhooks.mjs.map

package/shims/node.d.ts

@@ -0,0 +1,29 @@
+                              
+                              
+                              
+import * as types from "../_shims/node-types.js";
+declare module '../_shims/manual-types' {
+    namespace manual {
+        type Agent = types.Agent;
+        export import fetch = types.fetch;
+        type Request = types.Request;
+        type RequestInfo = types.RequestInfo;
+        type RequestInit = types.RequestInit;
+        type Response = types.Response;
+        type ResponseInit = types.ResponseInit;
+        type ResponseType = types.ResponseType;
+        type BodyInit = types.BodyInit;
+        type Headers = types.Headers;
+        type HeadersInit = types.HeadersInit;
+        type BlobPropertyBag = types.BlobPropertyBag;
+        type FilePropertyBag = types.FilePropertyBag;
+        type FileFromPathOptions = types.FileFromPathOptions;
+        export import FormData = types.FormData;
+        export import File = types.File;
+        export import Blob = types.Blob;
+        type Readable = types.Readable;
+        type FsReadStream = types.FsReadStream;
+        type ReadableStream = types.ReadableStream;
+    }
+}
+//# sourceMappingURL=node.d.ts.map

package/shims/node.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../src/shims/node.ts"],"names":[],"mappings":";;;AACA,OAAO,KAAK,KAAK,MAAM,sBAAsB,CAAC;AAK9C,OAAO,QAAQ,wBAAwB,CAAC;IACtC,UAAiB,MAAM,CAAC;QAEtB,KAAY,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;QAEhC,MAAM,QAAQ,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;QAElC,KAAY,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;QAEpC,KAAY,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QAE5C,KAAY,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QAE5C,KAAY,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;QAEtC,KAAY,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC;QAE9C,KAAY,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC;QAE9C,KAAY,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;QAEtC,KAAY,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;QAEpC,KAAY,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QAE5C,KAAY,eAAe,GAAG,KAAK,CAAC,eAAe,CAAC;QAEpD,KAAY,eAAe,GAAG,KAAK,CAAC,eAAe,CAAC;QAEpD,KAAY,mBAAmB,GAAG,KAAK,CAAC,mBAAmB,CAAC;QAE5D,MAAM,QAAQ,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;QAExC,MAAM,QAAQ,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QAEhC,MAAM,QAAQ,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QAEhC,KAAY,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;QAEtC,KAAY,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC;QAE9C,KAAY,cAAc,GAAG,KAAK,CAAC,cAAc,CAAC;KACnD;CACF"}

package/shims/node.js

@@ -0,0 +1,31 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// @ts-ignore
+const types = __importStar(require("../_shims/node-types.js"));
+const registry_1 = require("../_shims/registry.js");
+const node_runtime_1 = require("../_shims/node-runtime.js");
+(0, registry_1.setShims)((0, node_runtime_1.getRuntime)());
+//# sourceMappingURL=node.js.map

package/shims/node.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"node.js","sourceRoot":"","sources":["../src/shims/node.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAAA,aAAa;AACb,+DAA8C;AAC9C,oDAA8C;AAC9C,4DAAoD;AACpD,IAAA,mBAAQ,EAAC,IAAA,yBAAU,GAAE,CAAC,CAAC"}

package/shims/node.mjs

@@ -0,0 +1,5 @@
+import * as types from "../_shims/node-types.mjs";
+import { setShims } from "../_shims/registry.mjs";
+import { getRuntime } from "../_shims/node-runtime.mjs";
+setShims(getRuntime());
+//# sourceMappingURL=node.mjs.map

package/shims/node.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"node.mjs","sourceRoot":"","sources":["../src/shims/node.ts"],"names":[],"mappings":"OACO,KAAK,KAAK;OACV,EAAE,QAAQ,EAAE;OACZ,EAAE,UAAU,EAAE;AACrB,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC"}

package/shims/web.d.ts

@@ -0,0 +1,26 @@
+import * as types from "../_shims/web-types.js";
+declare module '../_shims/manual-types' {
+    namespace manual {
+        type Agent = types.Agent;
+        export import fetch = types.fetch;
+        type Request = types.Request;
+        type RequestInfo = types.RequestInfo;
+        type RequestInit = types.RequestInit;
+        type Response = types.Response;
+        type ResponseInit = types.ResponseInit;
+        type ResponseType = types.ResponseType;
+        type BodyInit = types.BodyInit;
+        type Headers = types.Headers;
+        type HeadersInit = types.HeadersInit;
+        type BlobPropertyBag = types.BlobPropertyBag;
+        type FilePropertyBag = types.FilePropertyBag;
+        type FileFromPathOptions = types.FileFromPathOptions;
+        export import FormData = types.FormData;
+        export import File = types.File;
+        export import Blob = types.Blob;
+        type Readable = types.Readable;
+        type FsReadStream = types.FsReadStream;
+        type ReadableStream = types.ReadableStream;
+    }
+}
+//# sourceMappingURL=web.d.ts.map

package/shims/web.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"web.d.ts","sourceRoot":"","sources":["../src/shims/web.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,KAAK,MAAM,qBAAqB,CAAC;AAK7C,OAAO,QAAQ,wBAAwB,CAAC;IACtC,UAAiB,MAAM,CAAC;QAEtB,KAAY,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;QAEhC,MAAM,QAAQ,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;QAElC,KAAY,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;QAEpC,KAAY,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QAE5C,KAAY,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QAE5C,KAAY,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;QAEtC,KAAY,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC;QAE9C,KAAY,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC;QAE9C,KAAY,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;QAEtC,KAAY,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;QAEpC,KAAY,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QAE5C,KAAY,eAAe,GAAG,KAAK,CAAC,eAAe,CAAC;QAEpD,KAAY,eAAe,GAAG,KAAK,CAAC,eAAe,CAAC;QAEpD,KAAY,mBAAmB,GAAG,KAAK,CAAC,mBAAmB,CAAC;QAE5D,MAAM,QAAQ,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;QAExC,MAAM,QAAQ,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QAEhC,MAAM,QAAQ,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QAEhC,KAAY,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;QAEtC,KAAY,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC;QAE9C,KAAY,cAAc,GAAG,KAAK,CAAC,cAAc,CAAC;KACnD;CACF"}

package/shims/web.js

@@ -0,0 +1,31 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// @ts-ignore
+const types = __importStar(require("../_shims/web-types.js"));
+const registry_1 = require("../_shims/registry.js");
+const web_runtime_1 = require("../_shims/web-runtime.js");
+(0, registry_1.setShims)((0, web_runtime_1.getRuntime)({ manuallyImported: true }));
+//# sourceMappingURL=web.js.map

package/shims/web.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"web.js","sourceRoot":"","sources":["../src/shims/web.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAAA,aAAa;AACb,8DAA6C;AAC7C,oDAA8C;AAC9C,0DAAmD;AACnD,IAAA,mBAAQ,EAAC,IAAA,wBAAU,EAAC,EAAE,gBAAgB,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC"}

package/shims/web.mjs

@@ -0,0 +1,5 @@
+import * as types from "../_shims/web-types.mjs";
+import { setShims } from "../_shims/registry.mjs";
+import { getRuntime } from "../_shims/web-runtime.mjs";
+setShims(getRuntime({ manuallyImported: true }));
+//# sourceMappingURL=web.mjs.map

package/shims/web.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"web.mjs","sourceRoot":"","sources":["../src/shims/web.ts"],"names":[],"mappings":"OACO,KAAK,KAAK;OACV,EAAE,QAAQ,EAAE;OACZ,EAAE,UAAU,EAAE;AACrB,QAAQ,CAAC,UAAU,CAAC,EAAE,gBAAgB,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC"}

package/src/_shims/MultipartBody.ts

@@ -0,0 +1,9 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+export class MultipartBody {
+  constructor(public body: any) {}
+  get [Symbol.toStringTag](): string {
+    return 'MultipartBody';
+  }
+}

package/src/_shims/README.md

@@ -0,0 +1,46 @@
+# 👋 Wondering what everything in here does?
+
+`@tryfinch/finch-api` supports a wide variety of runtime environments like Node.js, Deno, Bun, browsers, and various
+edge runtimes, as well as both CommonJS (CJS) and EcmaScript Modules (ESM).
+
+To do this, `@tryfinch/finch-api` provides shims for either using `node-fetch` when in Node (because `fetch` is still experimental there) or the global `fetch` API built into the environment when not in Node.
+
+It uses [conditional exports](https://nodejs.org/api/packages.html#conditional-exports) to
+automatically select the correct shims for each environment. However, conditional exports are a fairly new
+feature and not supported everywhere. For instance, the TypeScript `"moduleResolution": "node"`
+
+setting doesn't consult the `exports` map, compared to `"moduleResolution": "nodeNext"`, which does.
+Unfortunately that's still the default setting, and it can result in errors like
+getting the wrong raw `Response` type from `.asResponse()`, for example.
+
+The user can work around these issues by manually importing one of:
+
+- `import '@tryfinch/finch-api/shims/node'`
+- `import '@tryfinch/finch-api/shims/web'`
+
+All of the code here in `_shims` handles selecting the automatic default shims or manual overrides.
+
+### How it works - Runtime
+
+Runtime shims get installed by calling `setShims` exported by `@tryfinch/finch-api/_shims/registry`.
+
+Manually importing `@tryfinch/finch-api/shims/node` or `@tryfinch/finch-api/shims/web`, calls `setShims` with the respective runtime shims.
+
+All client code imports shims from `@tryfinch/finch-api/_shims/index`, which:
+
+- checks if shims have been set manually
+- if not, calls `setShims` with the shims from `@tryfinch/finch-api/_shims/auto/runtime`
+- re-exports the installed shims from `@tryfinch/finch-api/_shims/registry`.
+
+`@tryfinch/finch-api/_shims/auto/runtime` exports web runtime shims.
+If the `node` export condition is set, the export map replaces it with `@tryfinch/finch-api/_shims/auto/runtime-node`.
+
+### How it works - Type time
+
+All client code imports shim types from `@tryfinch/finch-api/_shims/index`, which selects the manual types from `@tryfinch/finch-api/_shims/manual-types` if they have been declared, otherwise it exports the auto types from `@tryfinch/finch-api/_shims/auto/types`.
+
+`@tryfinch/finch-api/_shims/manual-types` exports an empty namespace.
+Manually importing `@tryfinch/finch-api/shims/node` or `@tryfinch/finch-api/shims/web` merges declarations into this empty namespace, so they get picked up by `@tryfinch/finch-api/_shims/index`.
+
+`@tryfinch/finch-api/_shims/auto/types` exports web type definitions.
+If the `node` export condition is set, the export map replaces it with `@tryfinch/finch-api/_shims/auto/types-node`, though TS only picks this up if `"moduleResolution": "nodenext"` or `"moduleResolution": "bundler"`.

package/src/_shims/auto/runtime-bun.ts

@@ -0,0 +1,4 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+export * from '../bun-runtime';

package/src/_shims/auto/runtime-node.ts

@@ -0,0 +1,4 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+export * from '../node-runtime';

package/src/_shims/auto/runtime.ts

@@ -0,0 +1,4 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+export * from '../web-runtime';

package/src/_shims/auto/types-node.ts

@@ -0,0 +1,4 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+export * from '../node-types';

package/src/_shims/auto/types.d.ts

@@ -0,0 +1,99 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+export type Agent = any;
+
+// @ts-ignore
+declare const _fetch:                                        typeof fetch;
+export { _fetch as fetch };
+
+// @ts-ignore
+type _Request =                                   Request;
+export { _Request as Request };
+
+// @ts-ignore
+type _RequestInfo =                                       RequestInfo;
+export { type _RequestInfo as RequestInfo };
+
+// @ts-ignore
+type _RequestInit =                                       RequestInit;
+export { type _RequestInit as RequestInit };
+
+// @ts-ignore
+type _Response =                                    Response;
+export { _Response as Response };
+
+// @ts-ignore
+type _ResponseInit =                                        ResponseInit;
+export { type _ResponseInit as ResponseInit };
+
+// @ts-ignore
+type _ResponseType =                                        ResponseType;
+export { type _ResponseType as ResponseType };
+
+// @ts-ignore
+type _BodyInit =                                    BodyInit;
+export { type _BodyInit as BodyInit };
+
+// @ts-ignore
+type _Headers =                                   Headers;
+export { _Headers as Headers };
+
+// @ts-ignore
+type _HeadersInit =                                       HeadersInit;
+export { type _HeadersInit as HeadersInit };
+
+type EndingType = 'native' | 'transparent';
+
+export interface BlobPropertyBag {
+  endings?: EndingType;
+  type?: string;
+}
+
+export interface FilePropertyBag extends BlobPropertyBag {
+  lastModified?: number;
+}
+
+export type FileFromPathOptions = Omit<FilePropertyBag, 'lastModified'>;
+
+// @ts-ignore
+type _FormData =                                    FormData;
+// @ts-ignore
+declare const _FormData:                                           typeof FormData;
+export { _FormData as FormData };
+
+// @ts-ignore
+type _File =                                File;
+// @ts-ignore
+declare const _File:                                       typeof File;
+export { _File as File };
+
+// @ts-ignore
+type _Blob =                                Blob;
+// @ts-ignore
+declare const _Blob:                                       typeof Blob;
+export { _Blob as Blob };
+
+export declare class Readable {
+  readable: boolean;
+  readonly readableEnded: boolean;
+  readonly readableFlowing: boolean | null;
+  readonly readableHighWaterMark: number;
+  readonly readableLength: number;
+  readonly readableObjectMode: boolean;
+  destroyed: boolean;
+  read(size?: number): any;
+  pause(): this;
+  resume(): this;
+  isPaused(): boolean;
+  destroy(error?: Error): this;
+  [Symbol.asyncIterator](): AsyncIterableIterator<any>;
+}
+
+export declare class FsReadStream extends Readable {
+  path: {}; // node type is string | Buffer
+}
+
+// @ts-ignore
+type _ReadableStream<R = any> =                                             ReadableStream<R>;
+export { type _ReadableStream as ReadableStream };

package/src/_shims/auto/types.js

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

package/src/_shims/auto/types.mjs

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

package/src/_shims/bun-runtime.ts

@@ -0,0 +1,14 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+import { type Shims } from './registry';
+import { getRuntime as getWebRuntime } from './web-runtime';
+import { ReadStream as FsReadStream } from 'node:fs';
+
+export function getRuntime(): Shims {
+  const runtime = getWebRuntime();
+  function isFsReadStream(value: any): value is FsReadStream {
+    return value instanceof FsReadStream;
+  }
+  return { ...runtime, isFsReadStream };
+}

package/src/_shims/index.d.ts

@@ -0,0 +1,79 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+import { manual } from './manual-types';
+import * as auto from "../ch/finch-api/_shims/auto/types";
+import { type RequestOptions } from '../core';
+
+type SelectType<Manual, Auto> = unknown extends Manual ? Auto : Manual;
+
+export const kind: string;
+
+// @ts-ignore
+export type Agent = SelectType<manual.Agent, auto.Agent>;
+
+// @ts-ignore
+export const fetch: SelectType<typeof manual.fetch, typeof auto.fetch>;
+
+// @ts-ignore
+export type Request = SelectType<manual.Request, auto.Request>;
+// @ts-ignore
+export type RequestInfo = SelectType<manual.RequestInfo, auto.RequestInfo>;
+// @ts-ignore
+export type RequestInit = SelectType<manual.RequestInit, auto.RequestInit>;
+
+// @ts-ignore
+export type Response = SelectType<manual.Response, auto.Response>;
+// @ts-ignore
+export type ResponseInit = SelectType<manual.ResponseInit, auto.ResponseInit>;
+// @ts-ignore
+export type ResponseType = SelectType<manual.ResponseType, auto.ResponseType>;
+// @ts-ignore
+export type BodyInit = SelectType<manual.BodyInit, auto.BodyInit>;
+// @ts-ignore
+export type Headers = SelectType<manual.Headers, auto.Headers>;
+// @ts-ignore
+export const Headers: SelectType<typeof manual.Headers, typeof auto.Headers>;
+// @ts-ignore
+export type HeadersInit = SelectType<manual.HeadersInit, auto.HeadersInit>;
+
+// @ts-ignore
+export type BlobPropertyBag = SelectType<manual.BlobPropertyBag, auto.BlobPropertyBag>;
+// @ts-ignore
+export type FilePropertyBag = SelectType<manual.FilePropertyBag, auto.FilePropertyBag>;
+// @ts-ignore
+export type FileFromPathOptions = SelectType<manual.FileFromPathOptions, auto.FileFromPathOptions>;
+// @ts-ignore
+export type FormData = SelectType<manual.FormData, auto.FormData>;
+// @ts-ignore
+export const FormData: SelectType<typeof manual.FormData, typeof auto.FormData>;
+// @ts-ignore
+export type File = SelectType<manual.File, auto.File>;
+// @ts-ignore
+export const File: SelectType<typeof manual.File, typeof auto.File>;
+// @ts-ignore
+export type Blob = SelectType<manual.Blob, auto.Blob>;
+// @ts-ignore
+export const Blob: SelectType<typeof manual.Blob, typeof auto.Blob>;
+
+// @ts-ignore
+export type Readable = SelectType<manual.Readable, auto.Readable>;
+// @ts-ignore
+export type FsReadStream = SelectType<manual.FsReadStream, auto.FsReadStream>;
+// @ts-ignore
+export type ReadableStream = SelectType<manual.ReadableStream, auto.ReadableStream>;
+
+export function getMultipartRequestOptions<T extends {} = Record<string, unknown>>(
+  form: FormData,
+  opts: RequestOptions<T>,
+): Promise<RequestOptions<T>>;
+
+export function getDefaultAgent(url: string): any;
+
+// @ts-ignore
+export type FileFromPathOptions = SelectType<manual.FileFromPathOptions, auto.FileFromPathOptions>;
+
+export function fileFromPath(path: string, options?: FileFromPathOptions): Promise<File>;
+export function fileFromPath(path: string, filename?: string, options?: FileFromPathOptions): Promise<File>;
+
+export function isFsReadStream(value: any): value is FsReadStream;