@planqk/planqk-api-sdk 1.0.0

package/dist/core/fetcher/HttpResponsePromise.js

@@ -0,0 +1,94 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpResponsePromise = void 0;
+/**
+ * A promise that returns the parsed response and lets you retrieve the raw response too.
+ */
+class HttpResponsePromise extends Promise {
+    innerPromise;
+    unwrappedPromise;
+    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.
+     */
+    async withRawResponse() {
+        return await this.innerPromise;
+    }
+}
+exports.HttpResponsePromise = HttpResponsePromise;

package/dist/core/fetcher/RawResponse.d.ts

@@ -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/core/fetcher/RawResponse.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.unknownRawResponse = exports.abortRawResponse = void 0;
+exports.toRawResponse = toRawResponse;
+const Headers_js_1 = require("./Headers.js");
+/**
+ * A raw response indicating that the request was aborted.
+ */
+exports.abortRawResponse = {
+    headers: new Headers_js_1.Headers(),
+    redirected: false,
+    status: 499,
+    statusText: "Client Closed Request",
+    type: "error",
+    url: "",
+};
+/**
+ * A raw response indicating an unknown error.
+ */
+exports.unknownRawResponse = {
+    headers: new Headers_js_1.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.
+ */
+function toRawResponse(response) {
+    return {
+        headers: response.headers,
+        redirected: response.redirected,
+        status: response.status,
+        statusText: response.statusText,
+        type: response.type,
+        url: response.url,
+    };
+}

package/dist/core/fetcher/ResponseWithBody.d.ts

@@ -0,0 +1,4 @@
+export type ResponseWithBody = Response & {
+    body: ReadableStream<Uint8Array>;
+};
+export declare function isResponseWithBody(response: Response): response is ResponseWithBody;

package/dist/core/fetcher/ResponseWithBody.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isResponseWithBody = isResponseWithBody;
+function isResponseWithBody(response) {
+    return response.body != null;
+}

package/dist/core/fetcher/Supplier.d.ts

@@ -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/core/fetcher/Supplier.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Supplier = void 0;
+exports.Supplier = {
+    get: async (supplier) => {
+        if (typeof supplier === "function") {
+            return supplier();
+        }
+        else {
+            return supplier;
+        }
+    },
+};

package/dist/core/fetcher/createRequestUrl.d.ts

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

package/dist/core/fetcher/createRequestUrl.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createRequestUrl = createRequestUrl;
+const qs_js_1 = require("../url/qs.js");
+function createRequestUrl(baseUrl, queryParameters) {
+    const queryString = (0, qs_js_1.toQueryString)(queryParameters, { arrayFormat: "repeat" });
+    return queryString ? `${baseUrl}?${queryString}` : baseUrl;
+}

package/dist/core/fetcher/getErrorResponseBody.d.ts

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

package/dist/core/fetcher/getErrorResponseBody.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getErrorResponseBody = getErrorResponseBody;
+const json_js_1 = require("../json.js");
+const getResponseBody_js_1 = require("./getResponseBody.js");
+async function getErrorResponseBody(response) {
+    let contentType = response.headers.get("Content-Type")?.toLowerCase();
+    if (contentType == null || contentType.length === 0) {
+        return (0, getResponseBody_js_1.getResponseBody)(response);
+    }
+    if (contentType.indexOf(";") !== -1) {
+        contentType = contentType.split(";")[0]?.trim() ?? "";
+    }
+    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 = await response.text();
+            return text.length > 0 ? (0, json_js_1.fromJson)(text) : undefined;
+        default:
+            if (contentType.startsWith("application/vnd.") && contentType.endsWith("+json")) {
+                const text = await response.text();
+                return text.length > 0 ? (0, json_js_1.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 await response.text();
+    }
+}

package/dist/core/fetcher/getFetchFn.d.ts

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

package/dist/core/fetcher/getFetchFn.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFetchFn = getFetchFn;
+async function getFetchFn() {
+    return fetch;
+}

package/dist/core/fetcher/getHeader.d.ts

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

package/dist/core/fetcher/getHeader.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getHeader = getHeader;
+function getHeader(headers, header) {
+    for (const [headerKey, headerValue] of Object.entries(headers)) {
+        if (headerKey.toLowerCase() === header.toLowerCase()) {
+            return headerValue;
+        }
+    }
+    return undefined;
+}

package/dist/core/fetcher/getRequestBody.d.ts

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

package/dist/core/fetcher/getRequestBody.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRequestBody = getRequestBody;
+const json_js_1 = require("../json.js");
+async function getRequestBody({ body, type }) {
+    if (type.includes("json")) {
+        return (0, json_js_1.toJson)(body);
+    }
+    else {
+        return body;
+    }
+}

package/dist/core/fetcher/getResponseBody.d.ts

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

package/dist/core/fetcher/getResponseBody.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getResponseBody = getResponseBody;
+const BinaryResponse_js_1 = require("./BinaryResponse.js");
+const ResponseWithBody_js_1 = require("./ResponseWithBody.js");
+const json_js_1 = require("../json.js");
+async function getResponseBody(response, responseType) {
+    if (!(0, ResponseWithBody_js_1.isResponseWithBody)(response)) {
+        return undefined;
+    }
+    switch (responseType) {
+        case "binary-response":
+            return (0, BinaryResponse_js_1.getBinaryResponse)(response);
+        case "blob":
+            return await response.blob();
+        case "arrayBuffer":
+            return await response.arrayBuffer();
+        case "sse":
+            return response.body;
+        case "streaming":
+            return response.body;
+        case "text":
+            return await response.text();
+    }
+    // if responseType is "json" or not specified, try to parse as JSON
+    const text = await response.text();
+    if (text.length > 0) {
+        try {
+            let responseBody = (0, json_js_1.fromJson)(text);
+            return responseBody;
+        }
+        catch (err) {
+            return {
+                ok: false,
+                error: {
+                    reason: "non-json",
+                    statusCode: response.status,
+                    rawBody: text,
+                },
+            };
+        }
+    }
+    return undefined;
+}

package/dist/core/fetcher/index.d.ts

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

package/dist/core/fetcher/index.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpResponsePromise = exports.unknownRawResponse = exports.toRawResponse = exports.abortRawResponse = exports.Supplier = exports.getHeader = exports.fetcher = void 0;
+var Fetcher_js_1 = require("./Fetcher.js");
+Object.defineProperty(exports, "fetcher", { enumerable: true, get: function () { return Fetcher_js_1.fetcher; } });
+var getHeader_js_1 = require("./getHeader.js");
+Object.defineProperty(exports, "getHeader", { enumerable: true, get: function () { return getHeader_js_1.getHeader; } });
+var Supplier_js_1 = require("./Supplier.js");
+Object.defineProperty(exports, "Supplier", { enumerable: true, get: function () { return Supplier_js_1.Supplier; } });
+var RawResponse_js_1 = require("./RawResponse.js");
+Object.defineProperty(exports, "abortRawResponse", { enumerable: true, get: function () { return RawResponse_js_1.abortRawResponse; } });
+Object.defineProperty(exports, "toRawResponse", { enumerable: true, get: function () { return RawResponse_js_1.toRawResponse; } });
+Object.defineProperty(exports, "unknownRawResponse", { enumerable: true, get: function () { return RawResponse_js_1.unknownRawResponse; } });
+var HttpResponsePromise_js_1 = require("./HttpResponsePromise.js");
+Object.defineProperty(exports, "HttpResponsePromise", { enumerable: true, get: function () { return HttpResponsePromise_js_1.HttpResponsePromise; } });

package/dist/core/fetcher/makeRequest.d.ts

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

package/dist/core/fetcher/makeRequest.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeRequest = void 0;
+const signals_js_1 = require("./signals.js");
+const makeRequest = async (fetchFn, url, method, headers, requestBody, timeoutMs, abortSignal, withCredentials, duplex) => {
+    const signals = [];
+    // Add timeout signal
+    let timeoutAbortId = undefined;
+    if (timeoutMs != null) {
+        const { signal, abortId } = (0, signals_js_1.getTimeoutSignal)(timeoutMs);
+        timeoutAbortId = abortId;
+        signals.push(signal);
+    }
+    // Add arbitrary signal
+    if (abortSignal != null) {
+        signals.push(abortSignal);
+    }
+    let newSignals = (0, signals_js_1.anySignal)(signals);
+    const response = await fetchFn(url, {
+        method: method,
+        headers,
+        body: requestBody,
+        signal: newSignals,
+        credentials: withCredentials ? "include" : undefined,
+        // @ts-ignore
+        duplex,
+    });
+    if (timeoutAbortId != null) {
+        clearTimeout(timeoutAbortId);
+    }
+    return response;
+};
+exports.makeRequest = makeRequest;

package/dist/core/fetcher/requestWithRetries.d.ts

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

package/dist/core/fetcher/requestWithRetries.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.requestWithRetries = requestWithRetries;
+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 addJitter(delay) {
+    // Generate a random value between -JITTER_FACTOR and +JITTER_FACTOR
+    const jitterMultiplier = 1 + (Math.random() * 2 - 1) * JITTER_FACTOR;
+    return delay * jitterMultiplier;
+}
+async function requestWithRetries(requestFn, maxRetries = DEFAULT_MAX_RETRIES) {
+    let response = await requestFn();
+    for (let i = 0; i < maxRetries; ++i) {
+        if ([408, 429].includes(response.status) || response.status >= 500) {
+            // Calculate base delay using exponential backoff (in milliseconds)
+            const baseDelay = Math.min(INITIAL_RETRY_DELAY * Math.pow(2, i), MAX_RETRY_DELAY);
+            // Add jitter to the delay
+            const delayWithJitter = addJitter(baseDelay);
+            await new Promise((resolve) => setTimeout(resolve, delayWithJitter));
+            response = await requestFn();
+        }
+        else {
+            break;
+        }
+    }
+    return response;
+}

package/dist/core/fetcher/signals.d.ts

@@ -0,0 +1,11 @@
+export declare function getTimeoutSignal(timeoutMs: number): {
+    signal: AbortSignal;
+    abortId: NodeJS.Timeout;
+};
+/**
+ * Returns an abort signal that is getting aborted when
+ * at least one of the specified abort signals is aborted.
+ *
+ * Requires at least node.js 18.
+ */
+export declare function anySignal(...args: AbortSignal[] | [AbortSignal[]]): AbortSignal;

package/dist/core/fetcher/signals.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getTimeoutSignal = getTimeoutSignal;
+exports.anySignal = anySignal;
+const TIMEOUT = "timeout";
+function getTimeoutSignal(timeoutMs) {
+    const controller = new AbortController();
+    const abortId = setTimeout(() => controller.abort(TIMEOUT), timeoutMs);
+    return { signal: controller.signal, abortId };
+}
+/**
+ * Returns an abort signal that is getting aborted when
+ * at least one of the specified abort signals is aborted.
+ *
+ * Requires at least node.js 18.
+ */
+function anySignal(...args) {
+    // Allowing signals to be passed either as array
+    // of signals or as multiple arguments.
+    const signals = (args.length === 1 && Array.isArray(args[0]) ? args[0] : args);
+    const controller = new AbortController();
+    for (const signal of signals) {
+        if (signal.aborted) {
+            // Exiting early if one of the signals
+            // is already aborted.
+            controller.abort(signal?.reason);
+            break;
+        }
+        // Listening for signals and removing the listeners
+        // when at least one symbol is aborted.
+        signal.addEventListener("abort", () => controller.abort(signal?.reason), {
+            signal: controller.signal,
+        });
+    }
+    return controller.signal;
+}

package/dist/core/file.d.ts

@@ -0,0 +1 @@
+export type FileLike = ArrayBuffer | Uint8Array | import("buffer").Buffer | import("buffer").Blob | import("buffer").File | import("stream").Readable | import("stream/web").ReadableStream | globalThis.Blob | globalThis.File | ReadableStream;

package/dist/core/file.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/core/form-data-utils/FormDataWrapper.d.ts

@@ -0,0 +1,16 @@
+interface FormDataRequest<Body> {
+    body: Body;
+    headers: Record<string, string>;
+    duplex?: "half";
+}
+export declare function newFormData(): Promise<FormDataWrapper>;
+export declare class FormDataWrapper {
+    private fd;
+    setup(): Promise<void>;
+    append(key: string, value: unknown): void;
+    private getFileName;
+    private convertToBlob;
+    appendFile(key: string, value: unknown, fileName?: string): Promise<void>;
+    getRequest(): FormDataRequest<FormData>;
+}
+export {};