@quantum-hub/qhub-api 1.0.4

package/dist/api/service/index.js

@@ -0,0 +1,48 @@
+"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.HubServiceTimeoutError = exports.HubServiceError = exports.HubServiceEnvironment = exports.HubServiceClient = exports.HubService = void 0;
+exports.HubService = __importStar(require("./api/index.js"));
+var Client_js_1 = require("./Client.js");
+Object.defineProperty(exports, "HubServiceClient", { enumerable: true, get: function () { return Client_js_1.HubServiceClient; } });
+var environments_js_1 = require("./environments.js");
+Object.defineProperty(exports, "HubServiceEnvironment", { enumerable: true, get: function () { return environments_js_1.HubServiceEnvironment; } });
+var index_js_1 = require("./errors/index.js");
+Object.defineProperty(exports, "HubServiceError", { enumerable: true, get: function () { return index_js_1.HubServiceError; } });
+Object.defineProperty(exports, "HubServiceTimeoutError", { enumerable: true, get: function () { return index_js_1.HubServiceTimeoutError; } });
+__exportStar(require("./exports.js"), exports);

package/eslint.config.mjs

@@ -0,0 +1,11 @@
+import eslint from "@eslint/js";
+import tseslint from 'typescript-eslint';
+
+export default tseslint.config(
+  eslint.configs.recommended,
+  tseslint.configs.recommended,
+  tseslint.configs.stylistic,
+  {
+    ignores: ["dist", "src"]
+  },
+);

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@quantum-hub/qhub-api",
+  "version": "1.0.4",
+  "description": "SDK to interact with the official Kipu Quantum Hub APIs.",
+  "author": "Kipu Quantum GmbH",
+  "contributors": [
+    "Harzenetter, Lukas <lukas.harzenetter@kipu-quantum.com>",
+    "Wurster, Michael <michael.wurster@kipu-quantum.com>"
+  ],
+  "license": "Apache-2.0",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "shx rm -rf dist && tsc -b",
+    "lint": "eslint",
+    "test": "vitest"
+  },
+  "dependencies": {
+    "form-data": "^4",
+    "form-data-encoder": "^4",
+    "formdata-node": "^6",
+    "js-base64": "^3",
+    "node-fetch": "^3",
+    "qs": "^6",
+    "readable-stream": "^4",
+    "url-join": "^5"
+  },
+  "devDependencies": {
+    "@types/node": "^22",
+    "@types/node-fetch": "^2",
+    "@types/qs": "^6",
+    "@types/url-join": "^5",
+    "dotenv": "^17",
+    "eslint": "^9",
+    "shx": "^0.4.0",
+    "typescript": "^5",
+    "typescript-eslint": "^8",
+    "vitest": "^3"
+  },
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/api/platform/BaseClient.ts

@@ -0,0 +1,87 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import { HeaderAuthProvider } from "./auth/HeaderAuthProvider.js";
+import { mergeHeaders } from "./core/headers.js";
+import * as core from "./core/index.js";
+import type * as environments from "./environments.js";
+
+export type BaseClientOptions = {
+    environment?: core.Supplier<environments.HubPlatformEnvironment | string>;
+    /** Specify a custom URL to connect the client to. */
+    baseUrl?: core.Supplier<string>;
+    /** Override the X-OrganizationId header */
+    organizationId?: core.Supplier<string | undefined>;
+    /** Additional headers to include in requests. */
+    headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+    /** The default maximum time to wait for a response in seconds. */
+    timeoutInSeconds?: number;
+    /** The default number of times to retry the request. Defaults to 2. */
+    maxRetries?: number;
+    /** Provide a custom fetch implementation. Useful for platforms that don't have a built-in fetch or need a custom implementation. */
+    fetch?: typeof fetch;
+    /** Configure logging for the client. */
+    logging?: core.logging.LogConfig | core.logging.Logger;
+} & HeaderAuthProvider.AuthOptions;
+
+export interface BaseRequestOptions {
+    /** The maximum time to wait for a response in seconds. */
+    timeoutInSeconds?: number;
+    /** The number of times to retry the request. Defaults to 2. */
+    maxRetries?: number;
+    /** A hook to abort the request. */
+    abortSignal?: AbortSignal;
+    /** Override the X-OrganizationId header */
+    organizationId?: string | undefined;
+    /** Additional query string parameters to include in the request. */
+    queryParams?: Record<string, unknown>;
+    /** Additional headers to include in the request. */
+    headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+}
+
+export type NormalizedClientOptions<T extends BaseClientOptions = BaseClientOptions> = T & {
+    logging: core.logging.Logger;
+    authProvider?: core.AuthProvider;
+};
+
+export type NormalizedClientOptionsWithAuth<T extends BaseClientOptions = BaseClientOptions> =
+    NormalizedClientOptions<T> & {
+        authProvider: core.AuthProvider;
+    };
+
+export function normalizeClientOptions<T extends BaseClientOptions = BaseClientOptions>(
+    options: T,
+): NormalizedClientOptions<T> {
+    const headers = mergeHeaders(
+        {
+            "X-Fern-Language": "JavaScript",
+            "X-Fern-Runtime": core.RUNTIME.type,
+            "X-Fern-Runtime-Version": core.RUNTIME.version,
+            "X-OrganizationId": options?.organizationId,
+        },
+        options?.headers,
+    );
+
+    return {
+        ...options,
+        logging: core.logging.createLogger(options?.logging),
+        headers,
+    } as NormalizedClientOptions<T>;
+}
+
+export function normalizeClientOptionsWithAuth<T extends BaseClientOptions = BaseClientOptions>(
+    options: T,
+): NormalizedClientOptionsWithAuth<T> {
+    const normalized = normalizeClientOptions(options) as NormalizedClientOptionsWithAuth<T>;
+    const normalizedWithNoOpAuthProvider = withNoOpAuthProvider(normalized);
+    normalized.authProvider ??= new HeaderAuthProvider(normalizedWithNoOpAuthProvider);
+    return normalized;
+}
+
+function withNoOpAuthProvider<T extends BaseClientOptions = BaseClientOptions>(
+    options: NormalizedClientOptions<T>,
+): NormalizedClientOptionsWithAuth<T> {
+    return {
+        ...options,
+        authProvider: new core.NoOpAuthProvider(),
+    };
+}

package/src/api/platform/Client.ts

@@ -0,0 +1,78 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import { ApplicationsClient } from "./api/resources/applications/client/Client.js";
+import { DataPoolSharesClient } from "./api/resources/dataPoolShares/client/Client.js";
+import { DataPoolsClient } from "./api/resources/dataPools/client/Client.js";
+import { OrganizationsClient } from "./api/resources/organizations/client/Client.js";
+import { QuantumJobsClient } from "./api/resources/quantumJobs/client/Client.js";
+import { QuantumWorkloadsClient } from "./api/resources/quantumWorkloads/client/Client.js";
+import { ServiceExecutionsClient } from "./api/resources/serviceExecutions/client/Client.js";
+import { ServiceJobsClient } from "./api/resources/serviceJobs/client/Client.js";
+import { ServiceSharesClient } from "./api/resources/serviceShares/client/Client.js";
+import { SubscriptionsClient } from "./api/resources/subscriptions/client/Client.js";
+import type { BaseClientOptions, BaseRequestOptions } from "./BaseClient.js";
+import { type NormalizedClientOptionsWithAuth, normalizeClientOptionsWithAuth } from "./BaseClient.js";
+
+export declare namespace HubPlatformClient {
+    export type Options = BaseClientOptions;
+
+    export interface RequestOptions extends BaseRequestOptions {}
+}
+
+export class HubPlatformClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<HubPlatformClient.Options>;
+    protected _serviceShares: ServiceSharesClient | undefined;
+    protected _serviceExecutions: ServiceExecutionsClient | undefined;
+    protected _dataPools: DataPoolsClient | undefined;
+    protected _dataPoolShares: DataPoolSharesClient | undefined;
+    protected _subscriptions: SubscriptionsClient | undefined;
+    protected _serviceJobs: ServiceJobsClient | undefined;
+    protected _applications: ApplicationsClient | undefined;
+    protected _quantumWorkloads: QuantumWorkloadsClient | undefined;
+    protected _quantumJobs: QuantumJobsClient | undefined;
+    protected _organizations: OrganizationsClient | undefined;
+
+    constructor(options: HubPlatformClient.Options) {
+        this._options = normalizeClientOptionsWithAuth(options);
+    }
+
+    public get serviceShares(): ServiceSharesClient {
+        return (this._serviceShares ??= new ServiceSharesClient(this._options));
+    }
+
+    public get serviceExecutions(): ServiceExecutionsClient {
+        return (this._serviceExecutions ??= new ServiceExecutionsClient(this._options));
+    }
+
+    public get dataPools(): DataPoolsClient {
+        return (this._dataPools ??= new DataPoolsClient(this._options));
+    }
+
+    public get dataPoolShares(): DataPoolSharesClient {
+        return (this._dataPoolShares ??= new DataPoolSharesClient(this._options));
+    }
+
+    public get subscriptions(): SubscriptionsClient {
+        return (this._subscriptions ??= new SubscriptionsClient(this._options));
+    }
+
+    public get serviceJobs(): ServiceJobsClient {
+        return (this._serviceJobs ??= new ServiceJobsClient(this._options));
+    }
+
+    public get applications(): ApplicationsClient {
+        return (this._applications ??= new ApplicationsClient(this._options));
+    }
+
+    public get quantumWorkloads(): QuantumWorkloadsClient {
+        return (this._quantumWorkloads ??= new QuantumWorkloadsClient(this._options));
+    }
+
+    public get quantumJobs(): QuantumJobsClient {
+        return (this._quantumJobs ??= new QuantumJobsClient(this._options));
+    }
+
+    public get organizations(): OrganizationsClient {
+        return (this._organizations ??= new OrganizationsClient(this._options));
+    }
+}

package/src/api/platform/api/errors/BadRequestError.ts

@@ -0,0 +1,21 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as core from "../../core/index.js";
+import * as errors from "../../errors/index.js";
+
+export class BadRequestError extends errors.HubPlatformError {
+    constructor(body?: any, rawResponse?: core.RawResponse) {
+        super({
+            message: "BadRequestError",
+            statusCode: 400,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+
+        this.name = this.constructor.name;
+    }
+}

package/src/api/platform/api/errors/ForbiddenError.ts

@@ -0,0 +1,21 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as core from "../../core/index.js";
+import * as errors from "../../errors/index.js";
+
+export class ForbiddenError extends errors.HubPlatformError {
+    constructor(body?: any, rawResponse?: core.RawResponse) {
+        super({
+            message: "ForbiddenError",
+            statusCode: 403,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+
+        this.name = this.constructor.name;
+    }
+}

package/src/api/platform/api/errors/InternalServerError.ts

@@ -0,0 +1,21 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as core from "../../core/index.js";
+import * as errors from "../../errors/index.js";
+
+export class InternalServerError extends errors.HubPlatformError {
+    constructor(body?: any, rawResponse?: core.RawResponse) {
+        super({
+            message: "InternalServerError",
+            statusCode: 500,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+
+        this.name = this.constructor.name;
+    }
+}

package/src/api/platform/api/errors/NotFoundError.ts

@@ -0,0 +1,21 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as core from "../../core/index.js";
+import * as errors from "../../errors/index.js";
+
+export class NotFoundError extends errors.HubPlatformError {
+    constructor(body?: any, rawResponse?: core.RawResponse) {
+        super({
+            message: "NotFoundError",
+            statusCode: 404,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+
+        this.name = this.constructor.name;
+    }
+}

package/src/api/platform/api/errors/UnauthorizedError.ts

@@ -0,0 +1,21 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as core from "../../core/index.js";
+import * as errors from "../../errors/index.js";
+
+export class UnauthorizedError extends errors.HubPlatformError {
+    constructor(body?: any, rawResponse?: core.RawResponse) {
+        super({
+            message: "UnauthorizedError",
+            statusCode: 401,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+
+        this.name = this.constructor.name;
+    }
+}

package/src/api/platform/api/errors/index.ts

@@ -0,0 +1,5 @@
+export * from "./BadRequestError.js";
+export * from "./ForbiddenError.js";
+export * from "./InternalServerError.js";
+export * from "./NotFoundError.js";
+export * from "./UnauthorizedError.js";

package/src/api/platform/api/index.ts

@@ -0,0 +1,3 @@
+export * from "./errors/index.js";
+export * from "./resources/index.js";
+export * from "./types/index.js";