@planqk/planqk-api-sdk 1.0.0

package/dist/api/resources/dataPools/client/index.js

@@ -0,0 +1,17 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./requests/index.js"), exports);

package/dist/api/resources/dataPools/client/requests/AddDataPoolFileRequest.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as core from "../../../../../core/index.js";
+/**
+ * @example
+ *     {
+ *         file: fs.createReadStream("/path/to/your/file")
+ *     }
+ */
+export interface AddDataPoolFileRequest {
+    filename?: string;
+    file: core.FileLike;
+}

package/dist/api/resources/dataPools/client/requests/AddDataPoolFileRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/dataPools/client/requests/CreateDataPoolRequest.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {}
+ */
+export interface CreateDataPoolRequest {
+    name?: string;
+}

package/dist/api/resources/dataPools/client/requests/CreateDataPoolRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/dataPools/client/requests/UpdateDataPoolRequest.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {}
+ */
+export interface UpdateDataPoolRequest {
+    name?: string;
+    shortDescription?: string;
+    description?: string;
+}

package/dist/api/resources/dataPools/client/requests/UpdateDataPoolRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/dataPools/client/requests/index.d.ts

@@ -0,0 +1,3 @@
+export { type UpdateDataPoolRequest } from "./UpdateDataPoolRequest.js";
+export { type CreateDataPoolRequest } from "./CreateDataPoolRequest.js";
+export { type AddDataPoolFileRequest } from "./AddDataPoolFileRequest.js";

package/dist/api/resources/dataPools/client/requests/index.js

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

package/dist/api/resources/dataPools/index.d.ts

@@ -0,0 +1 @@
+export * from "./client/index.js";

package/dist/api/resources/dataPools/index.js

@@ -0,0 +1,17 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./client/index.js"), exports);

package/dist/api/resources/index.d.ts

@@ -0,0 +1,2 @@
+export * as dataPools from "./dataPools/index.js";
+export * from "./dataPools/client/requests/index.js";

package/dist/api/resources/index.js

@@ -0,0 +1,41 @@
+"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 () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dataPools = void 0;
+exports.dataPools = __importStar(require("./dataPools/index.js"));
+__exportStar(require("./dataPools/client/requests/index.js"), exports);

package/dist/api/types/DataPoolDto.d.ts

@@ -0,0 +1,23 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface DataPoolDto {
+    /** The access permission role for this entity of the current user */
+    currentUserPermission?: DataPoolDto.CurrentUserPermission;
+    id?: string;
+    name?: string;
+    shortDescription?: string;
+    description?: string;
+    createdAt?: string;
+}
+export declare namespace DataPoolDto {
+    /**
+     * The access permission role for this entity of the current user
+     */
+    type CurrentUserPermission = "VIEWER" | "MAINTAINER" | "OWNER";
+    const CurrentUserPermission: {
+        readonly Viewer: "VIEWER";
+        readonly Maintainer: "MAINTAINER";
+        readonly Owner: "OWNER";
+    };
+}

package/dist/api/types/DataPoolDto.js

@@ -0,0 +1,14 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DataPoolDto = void 0;
+var DataPoolDto;
+(function (DataPoolDto) {
+    DataPoolDto.CurrentUserPermission = {
+        Viewer: "VIEWER",
+        Maintainer: "MAINTAINER",
+        Owner: "OWNER",
+    };
+})(DataPoolDto || (exports.DataPoolDto = DataPoolDto = {}));

package/dist/api/types/DataPoolFileDto.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface DataPoolFileDto {
+    id?: string;
+    dataPoolId?: string;
+    name?: string;
+    fullPath?: string;
+    contentType?: string;
+    contentLength?: number;
+    createdAt?: string;
+}

package/dist/api/types/DataPoolFileDto.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/OauthScope.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type OauthScope = 
+/** */
+"profile";
+export declare const OauthScope: {
+    readonly Profile: "profile";
+};

package/dist/api/types/OauthScope.js

@@ -0,0 +1,9 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OauthScope = void 0;
+exports.OauthScope = {
+    Profile: "profile",
+};

package/dist/api/types/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./OauthScope.js";
+export * from "./DataPoolDto.js";
+export * from "./DataPoolFileDto.js";

package/dist/api/types/index.js

@@ -0,0 +1,19 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./OauthScope.js"), exports);
+__exportStar(require("./DataPoolDto.js"), exports);
+__exportStar(require("./DataPoolFileDto.js"), exports);

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

@@ -0,0 +1,20 @@
+import { RawResponse } from "./RawResponse.js";
+/**
+ * The response of an API call.
+ * It is a successful response or a failed response.
+ */
+export type APIResponse<Success, Failure> = SuccessfulResponse<Success> | FailedResponse<Failure>;
+export interface SuccessfulResponse<T> {
+    ok: true;
+    body: T;
+    /**
+     * @deprecated Use `rawResponse` instead
+     */
+    headers?: Record<string, any>;
+    rawResponse: RawResponse;
+}
+export interface FailedResponse<T> {
+    ok: false;
+    error: T;
+    rawResponse: RawResponse;
+}

package/dist/core/fetcher/APIResponse.js

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

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

@@ -0,0 +1,20 @@
+import { ResponseWithBody } from "./ResponseWithBody.js";
+export type BinaryResponse = {
+    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/bodyUsed) */
+    bodyUsed: boolean;
+    /**
+     * Returns a ReadableStream of the response body.
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/body)
+     */
+    stream: () => ReadableStream<Uint8Array>;
+    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/arrayBuffer) */
+    arrayBuffer: () => Promise<ArrayBuffer>;
+    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/blob) */
+    blob: () => Promise<Blob>;
+    /**
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/bytes)
+     * Some versions of the Fetch API may not support this method.
+     */
+    bytes?(): Promise<Uint8Array>;
+};
+export declare function getBinaryResponse(response: ResponseWithBody): BinaryResponse;

package/dist/core/fetcher/BinaryResponse.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBinaryResponse = getBinaryResponse;
+function getBinaryResponse(response) {
+    const binaryResponse = {
+        get bodyUsed() {
+            return response.bodyUsed;
+        },
+        stream: () => response.body,
+        arrayBuffer: response.arrayBuffer.bind(response),
+        blob: response.blob.bind(response),
+    };
+    if ("bytes" in response && typeof response.bytes === "function") {
+        binaryResponse.bytes = response.bytes.bind(response);
+    }
+    return binaryResponse;
+}

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

@@ -0,0 +1,40 @@
+import { APIResponse } from "./APIResponse.js";
+import { Supplier } from "./Supplier.js";
+export type FetchFunction = <R = unknown>(args: Fetcher.Args) => Promise<APIResponse<R, Fetcher.Error>>;
+export declare namespace Fetcher {
+    interface Args {
+        url: string;
+        method: string;
+        contentType?: string;
+        headers?: Record<string, string | Supplier<string | undefined> | undefined>;
+        queryParameters?: Record<string, string | string[] | object | object[] | null>;
+        body?: unknown;
+        timeoutMs?: number;
+        maxRetries?: number;
+        withCredentials?: boolean;
+        abortSignal?: AbortSignal;
+        requestType?: "json" | "file" | "bytes";
+        responseType?: "json" | "blob" | "sse" | "streaming" | "text" | "arrayBuffer" | "binary-response";
+        duplex?: "half";
+    }
+    type Error = FailedStatusCodeError | NonJsonError | TimeoutError | UnknownError;
+    interface FailedStatusCodeError {
+        reason: "status-code";
+        statusCode: number;
+        body: unknown;
+    }
+    interface NonJsonError {
+        reason: "non-json";
+        statusCode: number;
+        rawBody: string;
+    }
+    interface TimeoutError {
+        reason: "timeout";
+    }
+    interface UnknownError {
+        reason: "unknown";
+        errorMessage: string;
+    }
+}
+export declare function fetcherImpl<R = unknown>(args: Fetcher.Args): Promise<APIResponse<R, Fetcher.Error>>;
+export declare const fetcher: FetchFunction;

package/dist/core/fetcher/Fetcher.js

@@ -0,0 +1,105 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetcher = void 0;
+exports.fetcherImpl = fetcherImpl;
+const json_js_1 = require("../json.js");
+const RawResponse_js_1 = require("./RawResponse.js");
+const Supplier_js_1 = require("./Supplier.js");
+const createRequestUrl_js_1 = require("./createRequestUrl.js");
+const getErrorResponseBody_js_1 = require("./getErrorResponseBody.js");
+const getFetchFn_js_1 = require("./getFetchFn.js");
+const getRequestBody_js_1 = require("./getRequestBody.js");
+const getResponseBody_js_1 = require("./getResponseBody.js");
+const makeRequest_js_1 = require("./makeRequest.js");
+const requestWithRetries_js_1 = require("./requestWithRetries.js");
+async function getHeaders(args) {
+    const newHeaders = {};
+    if (args.body !== undefined && args.contentType != null) {
+        newHeaders["Content-Type"] = args.contentType;
+    }
+    if (args.headers == null) {
+        return newHeaders;
+    }
+    for (const [key, value] of Object.entries(args.headers)) {
+        const result = await Supplier_js_1.Supplier.get(value);
+        if (typeof result === "string") {
+            newHeaders[key] = result;
+            continue;
+        }
+        if (result == null) {
+            continue;
+        }
+        newHeaders[key] = `${result}`;
+    }
+    return newHeaders;
+}
+async function fetcherImpl(args) {
+    const url = (0, createRequestUrl_js_1.createRequestUrl)(args.url, args.queryParameters);
+    const requestBody = await (0, getRequestBody_js_1.getRequestBody)({
+        body: args.body,
+        type: args.requestType === "json" ? "json" : "other",
+    });
+    const fetchFn = await (0, getFetchFn_js_1.getFetchFn)();
+    try {
+        const response = await (0, requestWithRetries_js_1.requestWithRetries)(async () => (0, makeRequest_js_1.makeRequest)(fetchFn, url, args.method, await getHeaders(args), requestBody, args.timeoutMs, args.abortSignal, args.withCredentials, args.duplex), args.maxRetries);
+        if (response.status >= 200 && response.status < 400) {
+            return {
+                ok: true,
+                body: (await (0, getResponseBody_js_1.getResponseBody)(response, args.responseType)),
+                headers: response.headers,
+                rawResponse: (0, RawResponse_js_1.toRawResponse)(response),
+            };
+        }
+        else {
+            return {
+                ok: false,
+                error: {
+                    reason: "status-code",
+                    statusCode: response.status,
+                    body: await (0, getErrorResponseBody_js_1.getErrorResponseBody)(response),
+                },
+                rawResponse: (0, RawResponse_js_1.toRawResponse)(response),
+            };
+        }
+    }
+    catch (error) {
+        if (args.abortSignal != null && args.abortSignal.aborted) {
+            return {
+                ok: false,
+                error: {
+                    reason: "unknown",
+                    errorMessage: "The user aborted a request",
+                },
+                rawResponse: RawResponse_js_1.abortRawResponse,
+            };
+        }
+        else if (error instanceof Error && error.name === "AbortError") {
+            return {
+                ok: false,
+                error: {
+                    reason: "timeout",
+                },
+                rawResponse: RawResponse_js_1.abortRawResponse,
+            };
+        }
+        else if (error instanceof Error) {
+            return {
+                ok: false,
+                error: {
+                    reason: "unknown",
+                    errorMessage: error.message,
+                },
+                rawResponse: RawResponse_js_1.unknownRawResponse,
+            };
+        }
+        return {
+            ok: false,
+            error: {
+                reason: "unknown",
+                errorMessage: (0, json_js_1.toJson)(error),
+            },
+            rawResponse: RawResponse_js_1.unknownRawResponse,
+        };
+    }
+}
+exports.fetcher = fetcherImpl;

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

@@ -0,0 +1,2 @@
+declare let Headers: typeof globalThis.Headers;
+export { Headers };

package/dist/core/fetcher/Headers.js

@@ -0,0 +1,85 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Headers = void 0;
+let Headers;
+if (typeof globalThis.Headers !== "undefined") {
+    exports.Headers = Headers = globalThis.Headers;
+}
+else {
+    exports.Headers = Headers = class Headers {
+        headers;
+        constructor(init) {
+            this.headers = new Map();
+            if (init) {
+                if (init instanceof Headers) {
+                    init.forEach((value, key) => this.append(key, value));
+                }
+                else if (Array.isArray(init)) {
+                    for (const [key, value] of init) {
+                        if (typeof key === "string" && typeof value === "string") {
+                            this.append(key, value);
+                        }
+                        else {
+                            throw new TypeError("Each header entry must be a [string, string] tuple");
+                        }
+                    }
+                }
+                else {
+                    for (const [key, value] of Object.entries(init)) {
+                        if (typeof value === "string") {
+                            this.append(key, value);
+                        }
+                        else {
+                            throw new TypeError("Header values must be strings");
+                        }
+                    }
+                }
+            }
+        }
+        append(name, value) {
+            const key = name.toLowerCase();
+            const existing = this.headers.get(key) || [];
+            this.headers.set(key, [...existing, value]);
+        }
+        delete(name) {
+            const key = name.toLowerCase();
+            this.headers.delete(key);
+        }
+        get(name) {
+            const key = name.toLowerCase();
+            const values = this.headers.get(key);
+            return values ? values.join(", ") : null;
+        }
+        has(name) {
+            const key = name.toLowerCase();
+            return this.headers.has(key);
+        }
+        set(name, value) {
+            const key = name.toLowerCase();
+            this.headers.set(key, [value]);
+        }
+        forEach(callbackfn, thisArg) {
+            const boundCallback = thisArg ? callbackfn.bind(thisArg) : callbackfn;
+            this.headers.forEach((values, key) => boundCallback(values.join(", "), key, this));
+        }
+        getSetCookie() {
+            return this.headers.get("set-cookie") || [];
+        }
+        *entries() {
+            for (const [key, values] of this.headers.entries()) {
+                yield [key, values.join(", ")];
+            }
+        }
+        *keys() {
+            yield* this.headers.keys();
+        }
+        *values() {
+            for (const values of this.headers.values()) {
+                yield values.join(", ");
+            }
+        }
+        [Symbol.iterator]() {
+            return this.entries();
+        }
+    };
+}

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

@@ -0,0 +1,58 @@
+import { WithRawResponse } from "./RawResponse.js";
+/**
+ * A promise that returns the parsed response and lets you retrieve the raw response too.
+ */
+export declare class HttpResponsePromise<T> extends Promise<T> {
+    private innerPromise;
+    private unwrappedPromise;
+    private constructor();
+    /**
+     * 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<F extends (...args: never[]) => Promise<WithRawResponse<T>>, T>(fn: F, ...args: Parameters<F>): HttpResponsePromise<T>;
+    /**
+     * 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<F extends (...args: never[]) => Promise<WithRawResponse<T>>, T = Awaited<ReturnType<F>>["data"]>(fn: F): (...args: Parameters<F>) => HttpResponsePromise<T>;
+    /**
+     * Creates an `HttpResponsePromise` from an existing promise.
+     *
+     * @param promise - A promise resolving to a `WithRawResponse` object.
+     * @returns An `HttpResponsePromise` instance.
+     */
+    static fromPromise<T>(promise: Promise<WithRawResponse<T>>): HttpResponsePromise<T>;
+    /**
+     * 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<T>(executor: (resolve: (value: WithRawResponse<T>) => void, reject: (reason?: unknown) => void) => void): HttpResponsePromise<T>;
+    /**
+     * Creates an `HttpResponsePromise` from a resolved result.
+     *
+     * @param result - A `WithRawResponse` object to resolve immediately.
+     * @returns An `HttpResponsePromise` instance.
+     */
+    static fromResult<T>(result: WithRawResponse<T>): HttpResponsePromise<T>;
+    private unwrap;
+    /** @inheritdoc */
+    then<TResult1 = T, TResult2 = never>(onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | null, onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null): Promise<TResult1 | TResult2>;
+    /** @inheritdoc */
+    catch<TResult = never>(onrejected?: ((reason: unknown) => TResult | PromiseLike<TResult>) | null): Promise<T | TResult>;
+    /** @inheritdoc */
+    finally(onfinally?: (() => void) | null): Promise<T>;
+    /**
+     * Retrieves the data and raw response.
+     *
+     * @returns A promise resolving to a `WithRawResponse` object.
+     */
+    withRawResponse(): Promise<WithRawResponse<T>>;
+}