@chatbotkit/fetch 0.2.0 → 1.0.0

package/.eslintrc

@@ -0,0 +1 @@
+{}

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @chatbotkit/fetch
 
+## 1.0.0
+
+### Major Changes
+
+- Better and more consistent API types, list filtering and more.
+
+## 0.3.0
+
+### Minor Changes
+
+- - Refactored project scripts.
+  - Introduced a new usage method.
+
 ## 0.2.0
 
 ### Minor Changes

package/dist/cjs/index.cjs

@@ -1,15 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FormData = exports.Blob = exports.fetch = void 0;
+exports.jsonl = exports.withRetry = exports.withTimeout = exports.FetchError = exports.anySignal = exports.TIMEOUT_ERROR_NAME = exports.ABORT_ERROR_NAME = exports.FormData = exports.Blob = exports.fetch = void 0;
 const node_fetch_native_1 = require("node-fetch-native");
 Object.defineProperty(exports, "fetch", { enumerable: true, get: function () { return node_fetch_native_1.fetch; } });
 Object.defineProperty(exports, "Blob", { enumerable: true, get: function () { return node_fetch_native_1.Blob; } });
 Object.defineProperty(exports, "FormData", { enumerable: true, get: function () { return node_fetch_native_1.FormData; } });
-if (typeof globalThis.ReadableStream === 'function' &&
-    // @ts-ignore
+if (
+// eslint-disable-next-line no-undef
+typeof globalThis.ReadableStream === 'function' &&
+    // @ts-expect-error polyfill
+    // eslint-disable-next-line no-undef
     typeof globalThis.ReadableStream.prototype[Symbol.asyncIterator] !==
         'function') {
-    // @ts-ignore
+    // @ts-expect-error polyfill
+    // eslint-disable-next-line no-undef
     globalThis.ReadableStream.prototype[Symbol.asyncIterator] = function () {
         const reader = this.getReader();
         return {
@@ -20,3 +24,189 @@ if (typeof globalThis.ReadableStream === 'function' &&
         };
     };
 }
+exports.ABORT_ERROR_NAME = 'AbortError';
+exports.TIMEOUT_ERROR_NAME = 'TimeoutError';
+/**
+ * @param {AbortSignal[]} signals
+ * @returns {AbortSignal}
+ */
+function anySignal(signals) {
+    const controller = new AbortController();
+    for (const signal of signals) {
+        if (signal.aborted) {
+            controller.abort(signal.reason);
+            return signal;
+        }
+        signal.addEventListener('abort', () => controller.abort(signal.reason), {
+            signal: controller.signal,
+        });
+    }
+    return controller.signal;
+}
+exports.anySignal = anySignal;
+/**
+ * @todo add definition
+ * @todo move to @chatbotkit/fetch sdk
+ */
+class FetchError extends Error {
+    /**
+     * @param {string} message
+     * @param {number|string} code
+     * @param {string} url
+     * @param {RequestInit & withTimeoutOptions & withRetryOptions} request
+     * @param {Response} response
+     */
+    constructor(message, code, url, request, response) {
+        super(message);
+        this.code = code || response.status;
+        this.url = url;
+        this.request = request;
+        this.response = response;
+    }
+}
+exports.FetchError = FetchError;
+/**
+ * @typedef {(url: string, options?: RequestInit) => Promise<Response>} FetchFn
+ */
+/**
+ * @typedef {{
+ *   timeout?: number
+ * }} withTimeoutOptions
+ *
+ * @param {FetchFn} fetch
+ * @param {withTimeoutOptions} [defaultOptions]
+ * @returns {FetchFn}
+ */
+function withTimeout(fetch, defaultOptions) {
+    /**
+     * @param {string} url
+     * @param {RequestInit & withTimeoutOptions} [options]
+     * @returns {Promise<Response>}
+     */
+    return async function fetchWithTimeout(url, options) {
+        const timeout = options?.timeout ?? defaultOptions?.timeout ?? 30000;
+        let signal;
+        let handler;
+        if (timeout > 0 && timeout !== Infinity) {
+            const abortController = new AbortController();
+            // @todo use AbortSignal.timeout(n) when widely supported
+            handler = setTimeout(() => {
+                abortController.abort(exports.TIMEOUT_ERROR_NAME);
+            }, timeout);
+            signal = options?.signal
+                ? anySignal([abortController.signal, options.signal])
+                : abortController.signal;
+        }
+        else {
+            signal = options?.signal;
+        }
+        let response;
+        try {
+            response = await fetch(url, {
+                ...options,
+                signal,
+            });
+        }
+        finally {
+            clearTimeout(handler);
+        }
+        return response;
+    };
+}
+exports.withTimeout = withTimeout;
+/**
+ * @typedef {{
+ *   retries?: number,
+ *   retryDelay?: number,
+ *   retryAbort?: boolean,
+ *   retryTimeout?: boolean,
+ *   retryStatuses?: number[]
+ * }} withRetryOptions
+ *
+ * @todo move to @chatbotkit/fetch sdk
+ * @param {FetchFn} fetch
+ * @param {withRetryOptions} [defaultOptions]
+ * @returns {FetchFn}
+ */
+function withRetry(fetch, defaultOptions) {
+    /**
+     * @param {string} url
+     * @param {RequestInit & withRetryOptions} [options]
+     * @returns {Promise<Response>}
+     */
+    return async function fetchWithRetry(url, options) {
+        const retries = options?.retries ?? defaultOptions?.retries ?? 5;
+        const retryDelay = options?.retryDelay ?? defaultOptions?.retryDelay ?? 250;
+        const retryAbort = options?.retryAbort ?? defaultOptions?.retryAbort ?? false;
+        const retryTimeout = options?.retryTimeout ?? defaultOptions?.retryTimeout ?? false;
+        const retryStatuses = options?.retryStatuses ??
+            defaultOptions?.retryStatuses ?? [429, 500, 502, 503, 504];
+        let response;
+        try {
+            response = await fetch(url, { ...options });
+            if (!response.ok) {
+                if (retryStatuses.includes(response.status)) {
+                    throw new FetchError(`Request failed`, response.status, url, options || {}, response);
+                }
+                else {
+                    return response;
+                }
+            }
+            return response;
+        }
+        catch (error) {
+            switch (true) {
+                case error instanceof Error &&
+                    error.name === exports.ABORT_ERROR_NAME &&
+                    !retryAbort:
+                    {
+                        throw error;
+                    }
+                case error instanceof Error &&
+                    error.name === exports.TIMEOUT_ERROR_NAME &&
+                    !retryTimeout:
+                    {
+                        throw error;
+                    }
+                case retries === 0: {
+                    if (response) {
+                        return response;
+                    }
+                    else {
+                        throw error;
+                    }
+                }
+            }
+            await new Promise((resolve) => setTimeout(resolve, retryDelay));
+            return await fetchWithRetry(url, {
+                ...options,
+                retries: retries - 1,
+                retryDelay: retryDelay * 2,
+            });
+        }
+    };
+}
+exports.withRetry = withRetry;
+/**
+ * @param {ReadableStream<Uint8Array> & {[Symbol.asyncIterator](): AsyncIterator<Uint8Array>}} body
+ * @returns {AsyncGenerator<Record<string,any>>}
+ */
+async function* jsonl(body) {
+    const decoder = new TextDecoder();
+    let previous = '';
+    for await (const chunk of body) {
+        previous += decoder.decode(chunk);
+        let eolIndex;
+        while ((eolIndex = previous.indexOf('\n')) >= 0) {
+            const line = previous.slice(0, eolIndex + 1);
+            if (line) {
+                yield JSON.parse(line);
+            }
+            previous = previous.slice(eolIndex + 1);
+        }
+    }
+    if (previous.trim().length > 0) {
+        yield JSON.parse(previous);
+    }
+}
+exports.jsonl = jsonl;

package/dist/cjs/index.d.ts

@@ -1,3 +1,74 @@
+/**
+ * @param {AbortSignal[]} signals
+ * @returns {AbortSignal}
+ */
+export function anySignal(signals: AbortSignal[]): AbortSignal;
+/**
+ * @typedef {(url: string, options?: RequestInit) => Promise<Response>} FetchFn
+ */
+/**
+ * @typedef {{
+ *   timeout?: number
+ * }} withTimeoutOptions
+ *
+ * @param {FetchFn} fetch
+ * @param {withTimeoutOptions} [defaultOptions]
+ * @returns {FetchFn}
+ */
+export function withTimeout(fetch: FetchFn, defaultOptions?: withTimeoutOptions | undefined): FetchFn;
+/**
+ * @typedef {{
+ *   retries?: number,
+ *   retryDelay?: number,
+ *   retryAbort?: boolean,
+ *   retryTimeout?: boolean,
+ *   retryStatuses?: number[]
+ * }} withRetryOptions
+ *
+ * @todo move to @chatbotkit/fetch sdk
+ * @param {FetchFn} fetch
+ * @param {withRetryOptions} [defaultOptions]
+ * @returns {FetchFn}
+ */
+export function withRetry(fetch: FetchFn, defaultOptions?: withRetryOptions | undefined): FetchFn;
+/**
+ * @param {ReadableStream<Uint8Array> & {[Symbol.asyncIterator](): AsyncIterator<Uint8Array>}} body
+ * @returns {AsyncGenerator<Record<string,any>>}
+ */
+export function jsonl(body: ReadableStream<Uint8Array> & {
+    [Symbol.asyncIterator](): AsyncIterator<Uint8Array>;
+}): AsyncGenerator<Record<string, any>>;
+export const ABORT_ERROR_NAME: "AbortError";
+export const TIMEOUT_ERROR_NAME: "TimeoutError";
+/**
+ * @todo add definition
+ * @todo move to @chatbotkit/fetch sdk
+ */
+export class FetchError extends Error {
+    /**
+     * @param {string} message
+     * @param {number|string} code
+     * @param {string} url
+     * @param {RequestInit & withTimeoutOptions & withRetryOptions} request
+     * @param {Response} response
+     */
+    constructor(message: string, code: number | string, url: string, request: RequestInit & withTimeoutOptions & withRetryOptions, response: Response);
+    code: string | number;
+    url: string;
+    request: RequestInit & withTimeoutOptions & withRetryOptions;
+    response: Response;
+}
+export type FetchFn = (url: string, options?: RequestInit) => Promise<Response>;
+export type withTimeoutOptions = {
+    timeout?: number;
+};
+export type withRetryOptions = {
+    retries?: number;
+    retryDelay?: number;
+    retryAbort?: boolean;
+    retryTimeout?: boolean;
+    retryStatuses?: number[];
+};
 import { fetch } from 'node-fetch-native';
 import { Blob } from 'node-fetch-native';
 import { FormData } from 'node-fetch-native';

package/dist/esm/index.d.ts

@@ -1,3 +1,74 @@
+/**
+ * @param {AbortSignal[]} signals
+ * @returns {AbortSignal}
+ */
+export function anySignal(signals: AbortSignal[]): AbortSignal;
+/**
+ * @typedef {(url: string, options?: RequestInit) => Promise<Response>} FetchFn
+ */
+/**
+ * @typedef {{
+ *   timeout?: number
+ * }} withTimeoutOptions
+ *
+ * @param {FetchFn} fetch
+ * @param {withTimeoutOptions} [defaultOptions]
+ * @returns {FetchFn}
+ */
+export function withTimeout(fetch: FetchFn, defaultOptions?: withTimeoutOptions | undefined): FetchFn;
+/**
+ * @typedef {{
+ *   retries?: number,
+ *   retryDelay?: number,
+ *   retryAbort?: boolean,
+ *   retryTimeout?: boolean,
+ *   retryStatuses?: number[]
+ * }} withRetryOptions
+ *
+ * @todo move to @chatbotkit/fetch sdk
+ * @param {FetchFn} fetch
+ * @param {withRetryOptions} [defaultOptions]
+ * @returns {FetchFn}
+ */
+export function withRetry(fetch: FetchFn, defaultOptions?: withRetryOptions | undefined): FetchFn;
+/**
+ * @param {ReadableStream<Uint8Array> & {[Symbol.asyncIterator](): AsyncIterator<Uint8Array>}} body
+ * @returns {AsyncGenerator<Record<string,any>>}
+ */
+export function jsonl(body: ReadableStream<Uint8Array> & {
+    [Symbol.asyncIterator](): AsyncIterator<Uint8Array>;
+}): AsyncGenerator<Record<string, any>>;
+export const ABORT_ERROR_NAME: "AbortError";
+export const TIMEOUT_ERROR_NAME: "TimeoutError";
+/**
+ * @todo add definition
+ * @todo move to @chatbotkit/fetch sdk
+ */
+export class FetchError extends Error {
+    /**
+     * @param {string} message
+     * @param {number|string} code
+     * @param {string} url
+     * @param {RequestInit & withTimeoutOptions & withRetryOptions} request
+     * @param {Response} response
+     */
+    constructor(message: string, code: number | string, url: string, request: RequestInit & withTimeoutOptions & withRetryOptions, response: Response);
+    code: string | number;
+    url: string;
+    request: RequestInit & withTimeoutOptions & withRetryOptions;
+    response: Response;
+}
+export type FetchFn = (url: string, options?: RequestInit) => Promise<Response>;
+export type withTimeoutOptions = {
+    timeout?: number;
+};
+export type withRetryOptions = {
+    retries?: number;
+    retryDelay?: number;
+    retryAbort?: boolean;
+    retryTimeout?: boolean;
+    retryStatuses?: number[];
+};
 import { fetch } from 'node-fetch-native';
 import { Blob } from 'node-fetch-native';
 import { FormData } from 'node-fetch-native';

package/dist/esm/index.js

@@ -1,9 +1,14 @@
 import { fetch, Blob, FormData } from 'node-fetch-native';
-if (typeof globalThis.ReadableStream === 'function' &&
-    // @ts-ignore
+export { fetch, Blob, FormData };
+if (
+// eslint-disable-next-line no-undef
+typeof globalThis.ReadableStream === 'function' &&
+    // @ts-expect-error polyfill
+    // eslint-disable-next-line no-undef
     typeof globalThis.ReadableStream.prototype[Symbol.asyncIterator] !==
         'function') {
-    // @ts-ignore
+    // @ts-expect-error polyfill
+    // eslint-disable-next-line no-undef
     globalThis.ReadableStream.prototype[Symbol.asyncIterator] = function () {
         const reader = this.getReader();
         return {
@@ -14,4 +19,184 @@ if (typeof globalThis.ReadableStream === 'function' &&
         };
     };
 }
-export { fetch, Blob, FormData };
+export const ABORT_ERROR_NAME = 'AbortError';
+export const TIMEOUT_ERROR_NAME = 'TimeoutError';
+/**
+ * @param {AbortSignal[]} signals
+ * @returns {AbortSignal}
+ */
+export function anySignal(signals) {
+    const controller = new AbortController();
+    for (const signal of signals) {
+        if (signal.aborted) {
+            controller.abort(signal.reason);
+            return signal;
+        }
+        signal.addEventListener('abort', () => controller.abort(signal.reason), {
+            signal: controller.signal,
+        });
+    }
+    return controller.signal;
+}
+/**
+ * @todo add definition
+ * @todo move to @chatbotkit/fetch sdk
+ */
+export class FetchError extends Error {
+    /**
+     * @param {string} message
+     * @param {number|string} code
+     * @param {string} url
+     * @param {RequestInit & withTimeoutOptions & withRetryOptions} request
+     * @param {Response} response
+     */
+    constructor(message, code, url, request, response) {
+        super(message);
+        this.code = code || response.status;
+        this.url = url;
+        this.request = request;
+        this.response = response;
+    }
+}
+/**
+ * @typedef {(url: string, options?: RequestInit) => Promise<Response>} FetchFn
+ */
+/**
+ * @typedef {{
+ *   timeout?: number
+ * }} withTimeoutOptions
+ *
+ * @param {FetchFn} fetch
+ * @param {withTimeoutOptions} [defaultOptions]
+ * @returns {FetchFn}
+ */
+export function withTimeout(fetch, defaultOptions) {
+    /**
+     * @param {string} url
+     * @param {RequestInit & withTimeoutOptions} [options]
+     * @returns {Promise<Response>}
+     */
+    return async function fetchWithTimeout(url, options) {
+        const timeout = options?.timeout ?? defaultOptions?.timeout ?? 30000;
+        let signal;
+        let handler;
+        if (timeout > 0 && timeout !== Infinity) {
+            const abortController = new AbortController();
+            // @todo use AbortSignal.timeout(n) when widely supported
+            handler = setTimeout(() => {
+                abortController.abort(TIMEOUT_ERROR_NAME);
+            }, timeout);
+            signal = options?.signal
+                ? anySignal([abortController.signal, options.signal])
+                : abortController.signal;
+        }
+        else {
+            signal = options?.signal;
+        }
+        let response;
+        try {
+            response = await fetch(url, {
+                ...options,
+                signal,
+            });
+        }
+        finally {
+            clearTimeout(handler);
+        }
+        return response;
+    };
+}
+/**
+ * @typedef {{
+ *   retries?: number,
+ *   retryDelay?: number,
+ *   retryAbort?: boolean,
+ *   retryTimeout?: boolean,
+ *   retryStatuses?: number[]
+ * }} withRetryOptions
+ *
+ * @todo move to @chatbotkit/fetch sdk
+ * @param {FetchFn} fetch
+ * @param {withRetryOptions} [defaultOptions]
+ * @returns {FetchFn}
+ */
+export function withRetry(fetch, defaultOptions) {
+    /**
+     * @param {string} url
+     * @param {RequestInit & withRetryOptions} [options]
+     * @returns {Promise<Response>}
+     */
+    return async function fetchWithRetry(url, options) {
+        const retries = options?.retries ?? defaultOptions?.retries ?? 5;
+        const retryDelay = options?.retryDelay ?? defaultOptions?.retryDelay ?? 250;
+        const retryAbort = options?.retryAbort ?? defaultOptions?.retryAbort ?? false;
+        const retryTimeout = options?.retryTimeout ?? defaultOptions?.retryTimeout ?? false;
+        const retryStatuses = options?.retryStatuses ??
+            defaultOptions?.retryStatuses ?? [429, 500, 502, 503, 504];
+        let response;
+        try {
+            response = await fetch(url, { ...options });
+            if (!response.ok) {
+                if (retryStatuses.includes(response.status)) {
+                    throw new FetchError(`Request failed`, response.status, url, options || {}, response);
+                }
+                else {
+                    return response;
+                }
+            }
+            return response;
+        }
+        catch (error) {
+            switch (true) {
+                case error instanceof Error &&
+                    error.name === ABORT_ERROR_NAME &&
+                    !retryAbort:
+                    {
+                        throw error;
+                    }
+                case error instanceof Error &&
+                    error.name === TIMEOUT_ERROR_NAME &&
+                    !retryTimeout:
+                    {
+                        throw error;
+                    }
+                case retries === 0: {
+                    if (response) {
+                        return response;
+                    }
+                    else {
+                        throw error;
+                    }
+                }
+            }
+            await new Promise((resolve) => setTimeout(resolve, retryDelay));
+            return await fetchWithRetry(url, {
+                ...options,
+                retries: retries - 1,
+                retryDelay: retryDelay * 2,
+            });
+        }
+    };
+}
+/**
+ * @param {ReadableStream<Uint8Array> & {[Symbol.asyncIterator](): AsyncIterator<Uint8Array>}} body
+ * @returns {AsyncGenerator<Record<string,any>>}
+ */
+export async function* jsonl(body) {
+    const decoder = new TextDecoder();
+    let previous = '';
+    for await (const chunk of body) {
+        previous += decoder.decode(chunk);
+        let eolIndex;
+        while ((eolIndex = previous.indexOf('\n')) >= 0) {
+            const line = previous.slice(0, eolIndex + 1);
+            if (line) {
+                yield JSON.parse(line);
+            }
+            previous = previous.slice(eolIndex + 1);
+        }
+    }
+    if (previous.trim().length > 0) {
+        yield JSON.parse(previous);
+    }
+}

package/package.json

@@ -1,8 +1,11 @@
 {
   "name": "@chatbotkit/fetch",
-  "version": "0.2.0",
+  "version": "1.0.0",
   "description": "Isomorphic implenetation for fetch specifically designed for @chatbotkit/sdk.",
   "license": "ISC",
+  "engines": {
+    "node": ">=18.16.0"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/chatbotkit/node-sdk.git"
@@ -30,6 +33,16 @@
         "default": "./dist/esm/index.js"
       }
     },
+    "./index": {
+      "require": {
+        "types": "./dist/cjs/index.d.ts",
+        "default": "./dist/cjs/index.cjs"
+      },
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      }
+    },
     "./index.js": {
       "require": {
         "types": "./dist/cjs/index.d.ts",
@@ -44,11 +57,12 @@
   "scripts": {
     "build": "run-s build:*",
     "build:cjs": "tsc -p tsconfig.cjs.json",
-    "build:cjs_rename": "find ./dist/cjs -name '*.js' -exec rename .js .cjs {} +",
-    "build:cjs_rewrite_cjs": "find ./dist/cjs -name '*.cjs' -exec sed -i 's/require(\"\\(.*\\)\\.js\")/require(\"\\1.cjs\")/g' {} +",
-    "build:cjs_rewrite_ts": "find ./dist/cjs -name '*.ts' -exec sed -i 's/from \"\\(.*\\)\\.js\"/from \"\\1.cjs\"/g' {} +",
+    "build:cjs_rename": "node ../../scripts/rename-cjs.js",
+    "build:cjs_rewrite_cjs": "node ../../scripts/rewrite-cjs.js",
+    "build:cjs_rewrite_ts": "node ../../scripts/rewrite-ts.js",
     "build:esm": "tsc -p tsconfig.esm.json",
-    "build:exports": "node scripts/build-exports.js",
+    "build:exports": "node ../../scripts/build-exports.js",
+    "check": "tsc --noEmit",
     "test": "true"
   },
   "types": "./dist/esm/index.d.ts",