@deepgram/sdk 4.11.3 → 5.0.0-alpha.2

package/dist/esm/core/fetcher/HttpResponsePromise.mjs

@@ -0,0 +1,99 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+/**
+ * A promise that returns the parsed response and lets you retrieve the raw response too.
+ */
+export class HttpResponsePromise extends Promise {
+    constructor(promise) {
+        // Initialize with a no-op to avoid premature parsing
+        super((resolve) => {
+            resolve(undefined);
+        });
+        this.innerPromise = promise;
+    }
+    /**
+     * Creates an `HttpResponsePromise` from a function that returns a promise.
+     *
+     * @param fn - A function that returns a promise resolving to a `WithRawResponse` object.
+     * @param args - Arguments to pass to the function.
+     * @returns An `HttpResponsePromise` instance.
+     */
+    static fromFunction(fn, ...args) {
+        return new HttpResponsePromise(fn(...args));
+    }
+    /**
+     * Creates a function that returns an `HttpResponsePromise` from a function that returns a promise.
+     *
+     * @param fn - A function that returns a promise resolving to a `WithRawResponse` object.
+     * @returns A function that returns an `HttpResponsePromise` instance.
+     */
+    static interceptFunction(fn) {
+        return (...args) => {
+            return HttpResponsePromise.fromPromise(fn(...args));
+        };
+    }
+    /**
+     * Creates an `HttpResponsePromise` from an existing promise.
+     *
+     * @param promise - A promise resolving to a `WithRawResponse` object.
+     * @returns An `HttpResponsePromise` instance.
+     */
+    static fromPromise(promise) {
+        return new HttpResponsePromise(promise);
+    }
+    /**
+     * Creates an `HttpResponsePromise` from an executor function.
+     *
+     * @param executor - A function that takes resolve and reject callbacks to create a promise.
+     * @returns An `HttpResponsePromise` instance.
+     */
+    static fromExecutor(executor) {
+        const promise = new Promise(executor);
+        return new HttpResponsePromise(promise);
+    }
+    /**
+     * Creates an `HttpResponsePromise` from a resolved result.
+     *
+     * @param result - A `WithRawResponse` object to resolve immediately.
+     * @returns An `HttpResponsePromise` instance.
+     */
+    static fromResult(result) {
+        const promise = Promise.resolve(result);
+        return new HttpResponsePromise(promise);
+    }
+    unwrap() {
+        if (!this.unwrappedPromise) {
+            this.unwrappedPromise = this.innerPromise.then(({ data }) => data);
+        }
+        return this.unwrappedPromise;
+    }
+    /** @inheritdoc */
+    then(onfulfilled, onrejected) {
+        return this.unwrap().then(onfulfilled, onrejected);
+    }
+    /** @inheritdoc */
+    catch(onrejected) {
+        return this.unwrap().catch(onrejected);
+    }
+    /** @inheritdoc */
+    finally(onfinally) {
+        return this.unwrap().finally(onfinally);
+    }
+    /**
+     * Retrieves the data and raw response.
+     *
+     * @returns A promise resolving to a `WithRawResponse` object.
+     */
+    withRawResponse() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.innerPromise;
+        });
+    }
+}

package/dist/esm/core/fetcher/RawResponse.d.mts

@@ -0,0 +1,29 @@
+/**
+ * The raw response from the fetch call excluding the body.
+ */
+export type RawResponse = Omit<{
+    [K in keyof Response as Response[K] extends Function ? never : K]: Response[K];
+}, "ok" | "body" | "bodyUsed">;
+/**
+ * A raw response indicating that the request was aborted.
+ */
+export declare const abortRawResponse: RawResponse;
+/**
+ * A raw response indicating an unknown error.
+ */
+export declare const unknownRawResponse: RawResponse;
+/**
+ * Converts a `RawResponse` object into a `RawResponse` by extracting its properties,
+ * excluding the `body` and `bodyUsed` fields.
+ *
+ * @param response - The `RawResponse` object to convert.
+ * @returns A `RawResponse` object containing the extracted properties of the input response.
+ */
+export declare function toRawResponse(response: Response): RawResponse;
+/**
+ * Creates a `RawResponse` from a standard `Response` object.
+ */
+export interface WithRawResponse<T> {
+    readonly data: T;
+    readonly rawResponse: RawResponse;
+}

package/dist/esm/core/fetcher/RawResponse.mjs

@@ -0,0 +1,40 @@
+import { Headers } from "./Headers.mjs";
+/**
+ * A raw response indicating that the request was aborted.
+ */
+export const abortRawResponse = {
+    headers: new Headers(),
+    redirected: false,
+    status: 499,
+    statusText: "Client Closed Request",
+    type: "error",
+    url: "",
+};
+/**
+ * A raw response indicating an unknown error.
+ */
+export const unknownRawResponse = {
+    headers: new Headers(),
+    redirected: false,
+    status: 0,
+    statusText: "Unknown Error",
+    type: "error",
+    url: "",
+};
+/**
+ * Converts a `RawResponse` object into a `RawResponse` by extracting its properties,
+ * excluding the `body` and `bodyUsed` fields.
+ *
+ * @param response - The `RawResponse` object to convert.
+ * @returns A `RawResponse` object containing the extracted properties of the input response.
+ */
+export function toRawResponse(response) {
+    return {
+        headers: response.headers,
+        redirected: response.redirected,
+        status: response.status,
+        statusText: response.statusText,
+        type: response.type,
+        url: response.url,
+    };
+}

package/dist/esm/core/fetcher/Supplier.d.mts

@@ -0,0 +1,4 @@
+export type Supplier<T> = T | Promise<T> | (() => T | Promise<T>);
+export declare const Supplier: {
+    get: <T>(supplier: Supplier<T>) => Promise<T>;
+};

package/dist/esm/core/fetcher/Supplier.mjs

@@ -0,0 +1,19 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+export const Supplier = {
+    get: (supplier) => __awaiter(void 0, void 0, void 0, function* () {
+        if (typeof supplier === "function") {
+            return supplier();
+        }
+        else {
+            return supplier;
+        }
+    }),
+};

package/dist/esm/core/fetcher/createRequestUrl.d.mts

@@ -0,0 +1 @@
+export declare function createRequestUrl(baseUrl: string, queryParameters?: Record<string, unknown>): string;

package/dist/esm/core/fetcher/createRequestUrl.mjs

@@ -0,0 +1,5 @@
+import { toQueryString } from "../url/qs.mjs";
+export function createRequestUrl(baseUrl, queryParameters) {
+    const queryString = toQueryString(queryParameters, { arrayFormat: "repeat" });
+    return queryString ? `${baseUrl}?${queryString}` : baseUrl;
+}

package/dist/esm/core/fetcher/getErrorResponseBody.d.mts

@@ -0,0 +1 @@
+export declare function getErrorResponseBody(response: Response): Promise<unknown>;

package/dist/esm/core/fetcher/getErrorResponseBody.mjs

@@ -0,0 +1,42 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { fromJson } from "../json.mjs";
+import { getResponseBody } from "./getResponseBody.mjs";
+export function getErrorResponseBody(response) {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a, _b, _c;
+        let contentType = (_a = response.headers.get("Content-Type")) === null || _a === void 0 ? void 0 : _a.toLowerCase();
+        if (contentType == null || contentType.length === 0) {
+            return getResponseBody(response);
+        }
+        if (contentType.indexOf(";") !== -1) {
+            contentType = (_c = (_b = contentType.split(";")[0]) === null || _b === void 0 ? void 0 : _b.trim()) !== null && _c !== void 0 ? _c : "";
+        }
+        switch (contentType) {
+            case "application/hal+json":
+            case "application/json":
+            case "application/ld+json":
+            case "application/problem+json":
+            case "application/vnd.api+json":
+            case "text/json": {
+                const text = yield response.text();
+                return text.length > 0 ? fromJson(text) : undefined;
+            }
+            default:
+                if (contentType.startsWith("application/vnd.") && contentType.endsWith("+json")) {
+                    const text = yield response.text();
+                    return text.length > 0 ? fromJson(text) : undefined;
+                }
+                // Fallback to plain text if content type is not recognized
+                // Even if no body is present, the response will be an empty string
+                return yield response.text();
+        }
+    });
+}

package/dist/esm/core/fetcher/getFetchFn.d.mts

@@ -0,0 +1 @@
+export declare function getFetchFn(): Promise<typeof fetch>;

package/dist/esm/core/fetcher/getFetchFn.mjs

@@ -0,0 +1,14 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+export function getFetchFn() {
+    return __awaiter(this, void 0, void 0, function* () {
+        return fetch;
+    });
+}

package/dist/esm/core/fetcher/getHeader.d.mts

@@ -0,0 +1 @@
+export declare function getHeader(headers: Record<string, any>, header: string): string | undefined;

package/dist/esm/core/fetcher/getHeader.mjs

@@ -0,0 +1,8 @@
+export function getHeader(headers, header) {
+    for (const [headerKey, headerValue] of Object.entries(headers)) {
+        if (headerKey.toLowerCase() === header.toLowerCase()) {
+            return headerValue;
+        }
+    }
+    return undefined;
+}

package/dist/esm/core/fetcher/getRequestBody.d.mts

@@ -0,0 +1,7 @@
+export declare namespace GetRequestBody {
+    interface Args {
+        body: unknown;
+        type: "json" | "file" | "bytes" | "form" | "other";
+    }
+}
+export declare function getRequestBody({ body, type }: GetRequestBody.Args): Promise<BodyInit | undefined>;

package/dist/esm/core/fetcher/getRequestBody.mjs

@@ -0,0 +1,24 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { toJson } from "../json.mjs";
+import { toQueryString } from "../url/qs.mjs";
+export function getRequestBody(_a) {
+    return __awaiter(this, arguments, void 0, function* ({ body, type }) {
+        if (type === "form") {
+            return toQueryString(body, { arrayFormat: "repeat", encode: true });
+        }
+        if (type.includes("json")) {
+            return toJson(body);
+        }
+        else {
+            return body;
+        }
+    });
+}

package/dist/esm/core/fetcher/getResponseBody.d.mts

@@ -0,0 +1 @@
+export declare function getResponseBody(response: Response, responseType?: string): Promise<unknown>;

package/dist/esm/core/fetcher/getResponseBody.mjs

@@ -0,0 +1,66 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { fromJson } from "../json.mjs";
+import { getBinaryResponse } from "./BinaryResponse.mjs";
+export function getResponseBody(response, responseType) {
+    return __awaiter(this, void 0, void 0, function* () {
+        switch (responseType) {
+            case "binary-response":
+                return getBinaryResponse(response);
+            case "blob":
+                return yield response.blob();
+            case "arrayBuffer":
+                return yield response.arrayBuffer();
+            case "sse":
+                if (response.body == null) {
+                    return {
+                        ok: false,
+                        error: {
+                            reason: "body-is-null",
+                            statusCode: response.status,
+                        },
+                    };
+                }
+                return response.body;
+            case "streaming":
+                if (response.body == null) {
+                    return {
+                        ok: false,
+                        error: {
+                            reason: "body-is-null",
+                            statusCode: response.status,
+                        },
+                    };
+                }
+                return response.body;
+            case "text":
+                return yield response.text();
+        }
+        // if responseType is "json" or not specified, try to parse as JSON
+        const text = yield response.text();
+        if (text.length > 0) {
+            try {
+                const responseBody = fromJson(text);
+                return responseBody;
+            }
+            catch (_err) {
+                return {
+                    ok: false,
+                    error: {
+                        reason: "non-json",
+                        statusCode: response.status,
+                        rawBody: text,
+                    },
+                };
+            }
+        }
+        return undefined;
+    });
+}

package/dist/esm/core/fetcher/index.d.mts

@@ -0,0 +1,11 @@
+export type { APIResponse } from "./APIResponse.mjs";
+export type { BinaryResponse } from "./BinaryResponse.mjs";
+export type { EndpointMetadata } from "./EndpointMetadata.mjs";
+export { EndpointSupplier } from "./EndpointSupplier.mjs";
+export type { Fetcher, FetchFunction } from "./Fetcher.mjs";
+export { fetcher } from "./Fetcher.mjs";
+export { getHeader } from "./getHeader.mjs";
+export { HttpResponsePromise } from "./HttpResponsePromise.mjs";
+export type { RawResponse, WithRawResponse } from "./RawResponse.mjs";
+export { abortRawResponse, toRawResponse, unknownRawResponse } from "./RawResponse.mjs";
+export { Supplier } from "./Supplier.mjs";

package/dist/esm/core/fetcher/index.mjs

@@ -0,0 +1,6 @@
+export { EndpointSupplier } from "./EndpointSupplier.mjs";
+export { fetcher } from "./Fetcher.mjs";
+export { getHeader } from "./getHeader.mjs";
+export { HttpResponsePromise } from "./HttpResponsePromise.mjs";
+export { abortRawResponse, toRawResponse, unknownRawResponse } from "./RawResponse.mjs";
+export { Supplier } from "./Supplier.mjs";

package/dist/esm/core/fetcher/makeRequest.d.mts

@@ -0,0 +1 @@
+export declare const makeRequest: (fetchFn: (url: string, init: RequestInit) => Promise<Response>, url: string, method: string, headers: Headers | Record<string, string>, requestBody: BodyInit | undefined, timeoutMs?: number, abortSignal?: AbortSignal, withCredentials?: boolean, duplex?: "half") => Promise<Response>;

package/dist/esm/core/fetcher/makeRequest.mjs

@@ -0,0 +1,36 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { anySignal, getTimeoutSignal } from "./signals.mjs";
+export const makeRequest = (fetchFn, url, method, headers, requestBody, timeoutMs, abortSignal, withCredentials, duplex) => __awaiter(void 0, void 0, void 0, function* () {
+    const signals = [];
+    let timeoutAbortId;
+    if (timeoutMs != null) {
+        const { signal, abortId } = getTimeoutSignal(timeoutMs);
+        timeoutAbortId = abortId;
+        signals.push(signal);
+    }
+    if (abortSignal != null) {
+        signals.push(abortSignal);
+    }
+    const newSignals = anySignal(signals);
+    const response = yield fetchFn(url, {
+        method: method,
+        headers,
+        body: requestBody,
+        signal: newSignals,
+        credentials: withCredentials ? "include" : undefined,
+        // @ts-ignore
+        duplex,
+    });
+    if (timeoutAbortId != null) {
+        clearTimeout(timeoutAbortId);
+    }
+    return response;
+});

package/dist/esm/core/fetcher/requestWithRetries.d.mts

@@ -0,0 +1 @@
+export declare function requestWithRetries(requestFn: () => Promise<Response>, maxRetries?: number): Promise<Response>;

package/dist/esm/core/fetcher/requestWithRetries.mjs

@@ -0,0 +1,64 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+const INITIAL_RETRY_DELAY = 1000; // in milliseconds
+const MAX_RETRY_DELAY = 60000; // in milliseconds
+const DEFAULT_MAX_RETRIES = 2;
+const JITTER_FACTOR = 0.2; // 20% random jitter
+function addPositiveJitter(delay) {
+    const jitterMultiplier = 1 + Math.random() * JITTER_FACTOR;
+    return delay * jitterMultiplier;
+}
+function addSymmetricJitter(delay) {
+    const jitterMultiplier = 1 + (Math.random() - 0.5) * JITTER_FACTOR;
+    return delay * jitterMultiplier;
+}
+function getRetryDelayFromHeaders(response, retryAttempt) {
+    const retryAfter = response.headers.get("Retry-After");
+    if (retryAfter) {
+        const retryAfterSeconds = parseInt(retryAfter, 10);
+        if (!Number.isNaN(retryAfterSeconds) && retryAfterSeconds > 0) {
+            return Math.min(retryAfterSeconds * 1000, MAX_RETRY_DELAY);
+        }
+        const retryAfterDate = new Date(retryAfter);
+        if (!Number.isNaN(retryAfterDate.getTime())) {
+            const delay = retryAfterDate.getTime() - Date.now();
+            if (delay > 0) {
+                return Math.min(Math.max(delay, 0), MAX_RETRY_DELAY);
+            }
+        }
+    }
+    const rateLimitReset = response.headers.get("X-RateLimit-Reset");
+    if (rateLimitReset) {
+        const resetTime = parseInt(rateLimitReset, 10);
+        if (!Number.isNaN(resetTime)) {
+            const delay = resetTime * 1000 - Date.now();
+            if (delay > 0) {
+                return addPositiveJitter(Math.min(delay, MAX_RETRY_DELAY));
+            }
+        }
+    }
+    return addSymmetricJitter(Math.min(INITIAL_RETRY_DELAY * Math.pow(2, retryAttempt), MAX_RETRY_DELAY));
+}
+export function requestWithRetries(requestFn_1) {
+    return __awaiter(this, arguments, void 0, function* (requestFn, maxRetries = DEFAULT_MAX_RETRIES) {
+        let response = yield requestFn();
+        for (let i = 0; i < maxRetries; ++i) {
+            if ([408, 429].includes(response.status) || response.status >= 500) {
+                const delay = getRetryDelayFromHeaders(response, i);
+                yield new Promise((resolve) => setTimeout(resolve, delay));
+                response = yield requestFn();
+            }
+            else {
+                break;
+            }
+        }
+        return response;
+    });
+}

package/dist/esm/core/fetcher/signals.d.mts

@@ -0,0 +1,5 @@
+export declare function getTimeoutSignal(timeoutMs: number): {
+    signal: AbortSignal;
+    abortId: ReturnType<typeof setTimeout>;
+};
+export declare function anySignal(...args: AbortSignal[] | [AbortSignal[]]): AbortSignal;

package/dist/esm/core/fetcher/signals.mjs

@@ -0,0 +1,20 @@
+const TIMEOUT = "timeout";
+export function getTimeoutSignal(timeoutMs) {
+    const controller = new AbortController();
+    const abortId = setTimeout(() => controller.abort(TIMEOUT), timeoutMs);
+    return { signal: controller.signal, abortId };
+}
+export function anySignal(...args) {
+    const signals = (args.length === 1 && Array.isArray(args[0]) ? args[0] : args);
+    const controller = new AbortController();
+    for (const signal of signals) {
+        if (signal.aborted) {
+            controller.abort(signal === null || signal === void 0 ? void 0 : signal.reason);
+            break;
+        }
+        signal.addEventListener("abort", () => controller.abort(signal === null || signal === void 0 ? void 0 : signal.reason), {
+            signal: controller.signal,
+        });
+    }
+    return controller.signal;
+}

package/dist/esm/core/file/exports.d.mts

@@ -0,0 +1 @@
+export type { Uploadable } from "./types.mjs";

package/dist/esm/core/file/exports.mjs

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

package/dist/esm/core/file/file.d.mts

@@ -0,0 +1,10 @@
+import type { Uploadable } from "./types.mjs";
+export declare function toBinaryUploadRequest(file: Uploadable): Promise<{
+    body: Uploadable.FileLike;
+    headers?: Record<string, string>;
+}>;
+export declare function toMultipartDataPart(file: Uploadable): Promise<{
+    data: Uploadable.FileLike;
+    filename?: string;
+    contentType?: string;
+}>;