@quantum-hub/qhub-api 1.0.4

package/src/api/platform/core/url/qs.ts

@@ -0,0 +1,74 @@
+interface QueryStringOptions {
+    arrayFormat?: "indices" | "repeat";
+    encode?: boolean;
+}
+
+const defaultQsOptions: Required<QueryStringOptions> = {
+    arrayFormat: "indices",
+    encode: true,
+} as const;
+
+function encodeValue(value: unknown, shouldEncode: boolean): string {
+    if (value === undefined) {
+        return "";
+    }
+    if (value === null) {
+        return "";
+    }
+    const stringValue = String(value);
+    return shouldEncode ? encodeURIComponent(stringValue) : stringValue;
+}
+
+function stringifyObject(obj: Record<string, unknown>, prefix = "", options: Required<QueryStringOptions>): string[] {
+    const parts: string[] = [];
+
+    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 as Record<string, unknown>, 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 as Record<string, unknown>).length === 0) {
+                continue;
+            }
+            parts.push(...stringifyObject(value as Record<string, unknown>, fullKey, options));
+        } else {
+            const encodedKey = options.encode ? encodeURIComponent(fullKey) : fullKey;
+            parts.push(`${encodedKey}=${encodeValue(value, options.encode)}`);
+        }
+    }
+
+    return parts;
+}
+
+export function toQueryString(obj: unknown, options?: QueryStringOptions): string {
+    if (obj == null || typeof obj !== "object") {
+        return "";
+    }
+
+    const parts = stringifyObject(obj as Record<string, unknown>, "", {
+        ...defaultQsOptions,
+        ...options,
+    });
+    return parts.join("&");
+}

package/src/api/platform/environments.ts

@@ -0,0 +1,7 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export const HubPlatformEnvironment = {
+    Default: "https://api.hub.kipu-quantum.com/qc-catalog",
+} as const;
+
+export type HubPlatformEnvironment = typeof HubPlatformEnvironment.Default;

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

@@ -0,0 +1,58 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as core from "../core/index.js";
+import { toJson } from "../core/json.js";
+
+export class HubPlatformError extends Error {
+    public readonly statusCode?: number;
+    public readonly body?: unknown;
+    public readonly rawResponse?: core.RawResponse;
+
+    constructor({
+        message,
+        statusCode,
+        body,
+        rawResponse,
+    }: {
+        message?: string;
+        statusCode?: number;
+        body?: unknown;
+        rawResponse?: core.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;
+    }
+}
+
+function buildMessage({
+    message,
+    statusCode,
+    body,
+}: {
+    message: string | undefined;
+    statusCode: number | undefined;
+    body: unknown | undefined;
+}): string {
+    const lines: string[] = [];
+    if (message != null) {
+        lines.push(message);
+    }
+
+    if (statusCode != null) {
+        lines.push(`Status code: ${statusCode.toString()}`);
+    }
+
+    if (body != null) {
+        lines.push(`Body: ${toJson(body, undefined, 2)}`);
+    }
+
+    return lines.join("\n");
+}

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

@@ -0,0 +1,13 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export class HubPlatformTimeoutError extends Error {
+    constructor(message: string) {
+        super(message);
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+
+        this.name = this.constructor.name;
+    }
+}

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

@@ -0,0 +1,37 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as core from "../core/index.js";
+import * as errors from "./index.js";
+
+export function handleNonStatusCodeError(
+    error: core.Fetcher.Error,
+    rawResponse: core.RawResponse,
+    method: string,
+    path: string,
+): never {
+    switch (error.reason) {
+        case "non-json":
+            throw new errors.HubPlatformError({
+                statusCode: error.statusCode,
+                body: error.rawBody,
+                rawResponse: rawResponse,
+            });
+        case "body-is-null":
+            throw new errors.HubPlatformError({
+                statusCode: error.statusCode,
+                rawResponse: rawResponse,
+            });
+        case "timeout":
+            throw new errors.HubPlatformTimeoutError(`Timeout exceeded when calling ${method} ${path}.`);
+        case "unknown":
+            throw new errors.HubPlatformError({
+                message: error.errorMessage,
+                rawResponse: rawResponse,
+            });
+        default:
+            throw new errors.HubPlatformError({
+                message: "Unknown error",
+                rawResponse: rawResponse,
+            });
+    }
+}

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

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

package/src/api/platform/exports.ts

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

package/src/api/platform/index.ts

@@ -0,0 +1,6 @@
+export * as HubPlatform from "./api/index.js";
+export type { BaseClientOptions, BaseRequestOptions } from "./BaseClient.js";
+export { HubPlatformClient } from "./Client.js";
+export { HubPlatformEnvironment } from "./environments.js";
+export { HubPlatformError, HubPlatformTimeoutError } from "./errors/index.js";
+export * from "./exports.js";

package/src/api/service/BaseClient.ts

@@ -0,0 +1,82 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import { BearerAuthProvider } from "./auth/BearerAuthProvider.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.HubServiceEnvironment | string>;
+    /** Specify a custom URL to connect the client to. */
+    baseUrl?: core.Supplier<string>;
+    /** 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;
+} & BearerAuthProvider.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;
+    /** 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,
+        },
+        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 BearerAuthProvider(normalizedWithNoOpAuthProvider);
+    return normalized;
+}
+
+function withNoOpAuthProvider<T extends BaseClientOptions = BaseClientOptions>(
+    options: NormalizedClientOptions<T>,
+): NormalizedClientOptionsWithAuth<T> {
+    return {
+        ...options,
+        authProvider: new core.NoOpAuthProvider(),
+    };
+}

package/src/api/service/Client.ts

@@ -0,0 +1,24 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import { ServiceApiClient } from "./api/resources/serviceApi/client/Client.js";
+import type { BaseClientOptions, BaseRequestOptions } from "./BaseClient.js";
+import { type NormalizedClientOptionsWithAuth, normalizeClientOptionsWithAuth } from "./BaseClient.js";
+
+export declare namespace HubServiceClient {
+    export type Options = BaseClientOptions;
+
+    export interface RequestOptions extends BaseRequestOptions {}
+}
+
+export class HubServiceClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<HubServiceClient.Options>;
+    protected _serviceApi: ServiceApiClient | undefined;
+
+    constructor(options: HubServiceClient.Options) {
+        this._options = normalizeClientOptionsWithAuth(options);
+    }
+
+    public get serviceApi(): ServiceApiClient {
+        return (this._serviceApi ??= new ServiceApiClient(this._options));
+    }
+}

package/src/api/service/api/index.ts

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

package/src/api/service/api/resources/index.ts

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