@quantum-hub/qhub-api 1.0.4

package/dist/api/service/core/logging/logger.js

@@ -0,0 +1,146 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Logger = exports.ConsoleLogger = exports.LogLevel = void 0;
+exports.createLogger = createLogger;
+exports.LogLevel = {
+    Debug: "debug",
+    Info: "info",
+    Warn: "warn",
+    Error: "error",
+};
+const logLevelMap = {
+    [exports.LogLevel.Debug]: 1,
+    [exports.LogLevel.Info]: 2,
+    [exports.LogLevel.Warn]: 3,
+    [exports.LogLevel.Error]: 4,
+};
+/**
+ * Default console-based logger implementation.
+ */
+class ConsoleLogger {
+    debug(message, ...args) {
+        console.debug(message, ...args);
+    }
+    info(message, ...args) {
+        console.info(message, ...args);
+    }
+    warn(message, ...args) {
+        console.warn(message, ...args);
+    }
+    error(message, ...args) {
+        console.error(message, ...args);
+    }
+}
+exports.ConsoleLogger = ConsoleLogger;
+/**
+ * Logger class that provides level-based logging functionality.
+ */
+class Logger {
+    level;
+    logger;
+    silent;
+    /**
+     * Creates a new logger instance.
+     * @param config - Logger configuration
+     */
+    constructor(config) {
+        this.level = logLevelMap[config.level];
+        this.logger = config.logger;
+        this.silent = config.silent;
+    }
+    /**
+     * Checks if a log level should be output based on configuration.
+     * @param level - The log level to check
+     * @returns True if the level should be logged
+     */
+    shouldLog(level) {
+        return !this.silent && this.level <= logLevelMap[level];
+    }
+    /**
+     * Checks if debug logging is enabled.
+     * @returns True if debug logs should be output
+     */
+    isDebug() {
+        return this.shouldLog(exports.LogLevel.Debug);
+    }
+    /**
+     * Logs a debug message if debug logging is enabled.
+     * @param message - The message to log
+     * @param args - Additional arguments to log
+     */
+    debug(message, ...args) {
+        if (this.isDebug()) {
+            this.logger.debug(message, ...args);
+        }
+    }
+    /**
+     * Checks if info logging is enabled.
+     * @returns True if info logs should be output
+     */
+    isInfo() {
+        return this.shouldLog(exports.LogLevel.Info);
+    }
+    /**
+     * Logs an info message if info logging is enabled.
+     * @param message - The message to log
+     * @param args - Additional arguments to log
+     */
+    info(message, ...args) {
+        if (this.isInfo()) {
+            this.logger.info(message, ...args);
+        }
+    }
+    /**
+     * Checks if warning logging is enabled.
+     * @returns True if warning logs should be output
+     */
+    isWarn() {
+        return this.shouldLog(exports.LogLevel.Warn);
+    }
+    /**
+     * Logs a warning message if warning logging is enabled.
+     * @param message - The message to log
+     * @param args - Additional arguments to log
+     */
+    warn(message, ...args) {
+        if (this.isWarn()) {
+            this.logger.warn(message, ...args);
+        }
+    }
+    /**
+     * Checks if error logging is enabled.
+     * @returns True if error logs should be output
+     */
+    isError() {
+        return this.shouldLog(exports.LogLevel.Error);
+    }
+    /**
+     * Logs an error message if error logging is enabled.
+     * @param message - The message to log
+     * @param args - Additional arguments to log
+     */
+    error(message, ...args) {
+        if (this.isError()) {
+            this.logger.error(message, ...args);
+        }
+    }
+}
+exports.Logger = Logger;
+function createLogger(config) {
+    if (config == null) {
+        return defaultLogger;
+    }
+    if (config instanceof Logger) {
+        return config;
+    }
+    config = config ?? {};
+    config.level ??= exports.LogLevel.Info;
+    config.logger ??= new ConsoleLogger();
+    config.silent ??= true;
+    return new Logger(config);
+}
+const defaultLogger = new Logger({
+    level: exports.LogLevel.Info,
+    logger: new ConsoleLogger(),
+    silent: true,
+});

package/dist/api/service/core/runtime/index.d.ts

@@ -0,0 +1 @@
+export { RUNTIME } from "./runtime.js";

package/dist/api/service/core/runtime/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RUNTIME = void 0;
+var runtime_js_1 = require("./runtime.js");
+Object.defineProperty(exports, "RUNTIME", { enumerable: true, get: function () { return runtime_js_1.RUNTIME; } });

package/dist/api/service/core/runtime/runtime.d.ts

@@ -0,0 +1,9 @@
+/**
+ * A constant that indicates which environment and version the SDK is running in.
+ */
+export declare const RUNTIME: Runtime;
+export interface Runtime {
+    type: "browser" | "web-worker" | "deno" | "bun" | "node" | "react-native" | "unknown" | "workerd" | "edge-runtime";
+    version?: string;
+    parsedVersion?: number;
+}

package/dist/api/service/core/runtime/runtime.js

@@ -0,0 +1,102 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RUNTIME = void 0;
+/**
+ * A constant that indicates which environment and version the SDK is running in.
+ */
+exports.RUNTIME = evaluateRuntime();
+function evaluateRuntime() {
+    /**
+     * A constant that indicates whether the environment the code is running is a Web Browser.
+     */
+    const isBrowser = typeof window !== "undefined" && typeof window.document !== "undefined";
+    if (isBrowser) {
+        return {
+            type: "browser",
+            version: window.navigator.userAgent,
+        };
+    }
+    /**
+     * A constant that indicates whether the environment the code is running is Cloudflare.
+     * https://developers.cloudflare.com/workers/runtime-apis/web-standards/#navigatoruseragent
+     */
+    const isCloudflare = typeof globalThis !== "undefined" && globalThis?.navigator?.userAgent === "Cloudflare-Workers";
+    if (isCloudflare) {
+        return {
+            type: "workerd",
+        };
+    }
+    /**
+     * A constant that indicates whether the environment the code is running is Edge Runtime.
+     * https://vercel.com/docs/functions/runtimes/edge-runtime#check-if-you're-running-on-the-edge-runtime
+     */
+    const isEdgeRuntime = typeof EdgeRuntime === "string";
+    if (isEdgeRuntime) {
+        return {
+            type: "edge-runtime",
+        };
+    }
+    /**
+     * A constant that indicates whether the environment the code is running is a Web Worker.
+     */
+    const isWebWorker = typeof self === "object" &&
+        typeof self?.importScripts === "function" &&
+        (self.constructor?.name === "DedicatedWorkerGlobalScope" ||
+            self.constructor?.name === "ServiceWorkerGlobalScope" ||
+            self.constructor?.name === "SharedWorkerGlobalScope");
+    if (isWebWorker) {
+        return {
+            type: "web-worker",
+        };
+    }
+    /**
+     * A constant that indicates whether the environment the code is running is Deno.
+     * FYI Deno spoofs process.versions.node, see https://deno.land/std@0.177.0/node/process.ts?s=versions
+     */
+    const isDeno = typeof Deno !== "undefined" && typeof Deno.version !== "undefined" && typeof Deno.version.deno !== "undefined";
+    if (isDeno) {
+        return {
+            type: "deno",
+            version: Deno.version.deno,
+        };
+    }
+    /**
+     * A constant that indicates whether the environment the code is running is Bun.sh.
+     */
+    const isBun = typeof Bun !== "undefined" && typeof Bun.version !== "undefined";
+    if (isBun) {
+        return {
+            type: "bun",
+            version: Bun.version,
+        };
+    }
+    /**
+     * A constant that indicates whether the environment the code is running is in React-Native.
+     * This check should come before Node.js detection since React Native may have a process polyfill.
+     * https://github.com/facebook/react-native/blob/main/packages/react-native/Libraries/Core/setUpNavigator.js
+     */
+    const isReactNative = typeof navigator !== "undefined" && navigator?.product === "ReactNative";
+    if (isReactNative) {
+        return {
+            type: "react-native",
+        };
+    }
+    /**
+     * A constant that indicates whether the environment the code is running is Node.JS.
+     */
+    const isNode = typeof process !== "undefined" &&
+        "version" in process &&
+        !!process.version &&
+        "versions" in process &&
+        !!process.versions?.node;
+    if (isNode) {
+        return {
+            type: "node",
+            version: process.versions.node,
+            parsedVersion: Number(process.versions.node.split(".")[0]),
+        };
+    }
+    return {
+        type: "unknown",
+    };
+}

package/dist/api/service/core/url/encodePathParam.d.ts

@@ -0,0 +1 @@
+export declare function encodePathParam(param: unknown): string;

package/dist/api/service/core/url/encodePathParam.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.encodePathParam = encodePathParam;
+function encodePathParam(param) {
+    if (param === null) {
+        return "null";
+    }
+    const typeofParam = typeof param;
+    switch (typeofParam) {
+        case "undefined":
+            return "undefined";
+        case "string":
+        case "number":
+        case "boolean":
+            break;
+        default:
+            param = String(param);
+            break;
+    }
+    return encodeURIComponent(param);
+}

package/dist/api/service/core/url/index.d.ts

@@ -0,0 +1,3 @@
+export { encodePathParam } from "./encodePathParam.js";
+export { join } from "./join.js";
+export { toQueryString } from "./qs.js";

package/dist/api/service/core/url/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toQueryString = exports.join = exports.encodePathParam = void 0;
+var encodePathParam_js_1 = require("./encodePathParam.js");
+Object.defineProperty(exports, "encodePathParam", { enumerable: true, get: function () { return encodePathParam_js_1.encodePathParam; } });
+var join_js_1 = require("./join.js");
+Object.defineProperty(exports, "join", { enumerable: true, get: function () { return join_js_1.join; } });
+var qs_js_1 = require("./qs.js");
+Object.defineProperty(exports, "toQueryString", { enumerable: true, get: function () { return qs_js_1.toQueryString; } });

package/dist/api/service/core/url/join.d.ts

@@ -0,0 +1 @@
+export declare function join(base: string, ...segments: string[]): string;

package/dist/api/service/core/url/join.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.join = join;
+function join(base, ...segments) {
+    if (!base) {
+        return "";
+    }
+    if (segments.length === 0) {
+        return base;
+    }
+    if (base.includes("://")) {
+        let url;
+        try {
+            url = new URL(base);
+        }
+        catch {
+            return joinPath(base, ...segments);
+        }
+        const lastSegment = segments[segments.length - 1];
+        const shouldPreserveTrailingSlash = lastSegment?.endsWith("/");
+        for (const segment of segments) {
+            const cleanSegment = trimSlashes(segment);
+            if (cleanSegment) {
+                url.pathname = joinPathSegments(url.pathname, cleanSegment);
+            }
+        }
+        if (shouldPreserveTrailingSlash && !url.pathname.endsWith("/")) {
+            url.pathname += "/";
+        }
+        return url.toString();
+    }
+    return joinPath(base, ...segments);
+}
+function joinPath(base, ...segments) {
+    if (segments.length === 0) {
+        return base;
+    }
+    let result = base;
+    const lastSegment = segments[segments.length - 1];
+    const shouldPreserveTrailingSlash = lastSegment?.endsWith("/");
+    for (const segment of segments) {
+        const cleanSegment = trimSlashes(segment);
+        if (cleanSegment) {
+            result = joinPathSegments(result, cleanSegment);
+        }
+    }
+    if (shouldPreserveTrailingSlash && !result.endsWith("/")) {
+        result += "/";
+    }
+    return result;
+}
+function joinPathSegments(left, right) {
+    if (left.endsWith("/")) {
+        return left + right;
+    }
+    return `${left}/${right}`;
+}
+function trimSlashes(str) {
+    if (!str)
+        return str;
+    let start = 0;
+    let end = str.length;
+    if (str.startsWith("/"))
+        start = 1;
+    if (str.endsWith("/"))
+        end = str.length - 1;
+    return start === 0 && end === str.length ? str : str.slice(start, end);
+}

package/dist/api/service/core/url/qs.d.ts

@@ -0,0 +1,6 @@
+interface QueryStringOptions {
+    arrayFormat?: "indices" | "repeat";
+    encode?: boolean;
+}
+export declare function toQueryString(obj: unknown, options?: QueryStringOptions): string;
+export {};

package/dist/api/service/core/url/qs.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toQueryString = toQueryString;
+const defaultQsOptions = {
+    arrayFormat: "indices",
+    encode: true,
+};
+function encodeValue(value, shouldEncode) {
+    if (value === undefined) {
+        return "";
+    }
+    if (value === null) {
+        return "";
+    }
+    const stringValue = String(value);
+    return shouldEncode ? encodeURIComponent(stringValue) : stringValue;
+}
+function stringifyObject(obj, prefix = "", options) {
+    const parts = [];
+    for (const [key, value] of Object.entries(obj)) {
+        const fullKey = prefix ? `${prefix}[${key}]` : key;
+        if (value === undefined) {
+            continue;
+        }
+        if (Array.isArray(value)) {
+            if (value.length === 0) {
+                continue;
+            }
+            for (let i = 0; i < value.length; i++) {
+                const item = value[i];
+                if (item === undefined) {
+                    continue;
+                }
+                if (typeof item === "object" && !Array.isArray(item) && item !== null) {
+                    const arrayKey = options.arrayFormat === "indices" ? `${fullKey}[${i}]` : fullKey;
+                    parts.push(...stringifyObject(item, arrayKey, options));
+                }
+                else {
+                    const arrayKey = options.arrayFormat === "indices" ? `${fullKey}[${i}]` : fullKey;
+                    const encodedKey = options.encode ? encodeURIComponent(arrayKey) : arrayKey;
+                    parts.push(`${encodedKey}=${encodeValue(item, options.encode)}`);
+                }
+            }
+        }
+        else if (typeof value === "object" && value !== null) {
+            if (Object.keys(value).length === 0) {
+                continue;
+            }
+            parts.push(...stringifyObject(value, fullKey, options));
+        }
+        else {
+            const encodedKey = options.encode ? encodeURIComponent(fullKey) : fullKey;
+            parts.push(`${encodedKey}=${encodeValue(value, options.encode)}`);
+        }
+    }
+    return parts;
+}
+function toQueryString(obj, options) {
+    if (obj == null || typeof obj !== "object") {
+        return "";
+    }
+    const parts = stringifyObject(obj, "", {
+        ...defaultQsOptions,
+        ...options,
+    });
+    return parts.join("&");
+}

package/dist/api/service/environments.d.ts

@@ -0,0 +1,4 @@
+export declare const HubServiceEnvironment: {
+    readonly Default: "https://gateway.hub.kipu-quantum.com/<context>/<service>/<version>";
+};
+export type HubServiceEnvironment = typeof HubServiceEnvironment.Default;

package/dist/api/service/environments.js

@@ -0,0 +1,7 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HubServiceEnvironment = void 0;
+exports.HubServiceEnvironment = {
+    Default: "https://gateway.hub.kipu-quantum.com/<context>/<service>/<version>",
+};

package/dist/api/service/errors/HubServiceError.d.ts

@@ -0,0 +1,12 @@
+import type * as core from "../core/index.js";
+export declare class HubServiceError extends Error {
+    readonly statusCode?: number;
+    readonly body?: unknown;
+    readonly rawResponse?: core.RawResponse;
+    constructor({ message, statusCode, body, rawResponse, }: {
+        message?: string;
+        statusCode?: number;
+        body?: unknown;
+        rawResponse?: core.RawResponse;
+    });
+}

package/dist/api/service/errors/HubServiceError.js

@@ -0,0 +1,35 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HubServiceError = void 0;
+const json_js_1 = require("../core/json.js");
+class HubServiceError extends Error {
+    statusCode;
+    body;
+    rawResponse;
+    constructor({ message, statusCode, body, rawResponse, }) {
+        super(buildMessage({ message, statusCode, body }));
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+        this.name = this.constructor.name;
+        this.statusCode = statusCode;
+        this.body = body;
+        this.rawResponse = rawResponse;
+    }
+}
+exports.HubServiceError = HubServiceError;
+function buildMessage({ message, statusCode, body, }) {
+    const lines = [];
+    if (message != null) {
+        lines.push(message);
+    }
+    if (statusCode != null) {
+        lines.push(`Status code: ${statusCode.toString()}`);
+    }
+    if (body != null) {
+        lines.push(`Body: ${(0, json_js_1.toJson)(body, undefined, 2)}`);
+    }
+    return lines.join("\n");
+}

package/dist/api/service/errors/HubServiceTimeoutError.d.ts

@@ -0,0 +1,3 @@
+export declare class HubServiceTimeoutError extends Error {
+    constructor(message: string);
+}

package/dist/api/service/errors/HubServiceTimeoutError.js

@@ -0,0 +1,15 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HubServiceTimeoutError = void 0;
+class HubServiceTimeoutError extends Error {
+    constructor(message) {
+        super(message);
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+        this.name = this.constructor.name;
+    }
+}
+exports.HubServiceTimeoutError = HubServiceTimeoutError;

package/dist/api/service/errors/handleNonStatusCodeError.d.ts

@@ -0,0 +1,2 @@
+import type * as core from "../core/index.js";
+export declare function handleNonStatusCodeError(error: core.Fetcher.Error, rawResponse: core.RawResponse, method: string, path: string): never;

package/dist/api/service/errors/handleNonStatusCodeError.js

@@ -0,0 +1,65 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+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;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handleNonStatusCodeError = handleNonStatusCodeError;
+const errors = __importStar(require("./index.js"));
+function handleNonStatusCodeError(error, rawResponse, method, path) {
+    switch (error.reason) {
+        case "non-json":
+            throw new errors.HubServiceError({
+                statusCode: error.statusCode,
+                body: error.rawBody,
+                rawResponse: rawResponse,
+            });
+        case "body-is-null":
+            throw new errors.HubServiceError({
+                statusCode: error.statusCode,
+                rawResponse: rawResponse,
+            });
+        case "timeout":
+            throw new errors.HubServiceTimeoutError(`Timeout exceeded when calling ${method} ${path}.`);
+        case "unknown":
+            throw new errors.HubServiceError({
+                message: error.errorMessage,
+                rawResponse: rawResponse,
+            });
+        default:
+            throw new errors.HubServiceError({
+                message: "Unknown error",
+                rawResponse: rawResponse,
+            });
+    }
+}

package/dist/api/service/errors/index.d.ts

@@ -0,0 +1,2 @@
+export { HubServiceError } from "./HubServiceError.js";
+export { HubServiceTimeoutError } from "./HubServiceTimeoutError.js";

package/dist/api/service/errors/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HubServiceTimeoutError = exports.HubServiceError = void 0;
+var HubServiceError_js_1 = require("./HubServiceError.js");
+Object.defineProperty(exports, "HubServiceError", { enumerable: true, get: function () { return HubServiceError_js_1.HubServiceError; } });
+var HubServiceTimeoutError_js_1 = require("./HubServiceTimeoutError.js");
+Object.defineProperty(exports, "HubServiceTimeoutError", { enumerable: true, get: function () { return HubServiceTimeoutError_js_1.HubServiceTimeoutError; } });

package/dist/api/service/exports.d.ts

@@ -0,0 +1 @@
+export * from "./core/exports.js";

package/dist/api/service/exports.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("./core/exports.js"), exports);

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

@@ -0,0 +1,6 @@
+export * as HubService from "./api/index.js";
+export type { BaseClientOptions, BaseRequestOptions } from "./BaseClient.js";
+export { HubServiceClient } from "./Client.js";
+export { HubServiceEnvironment } from "./environments.js";
+export { HubServiceError, HubServiceTimeoutError } from "./errors/index.js";
+export * from "./exports.js";