@quantum-hub/qhub-api 1.0.4

package/src/api/service/auth/BearerAuthProvider.ts

@@ -0,0 +1,47 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import * as core from "../core/index.js";
+import * as errors from "../errors/index.js";
+
+const TOKEN_PARAM = "token" as const;
+
+export class BearerAuthProvider implements core.AuthProvider {
+    private readonly options: BearerAuthProvider.Options;
+
+    constructor(options: BearerAuthProvider.Options) {
+        this.options = options;
+    }
+
+    public static canCreate(options: Partial<BearerAuthProvider.Options>): boolean {
+        return options?.[TOKEN_PARAM] != null;
+    }
+
+    public async getAuthRequest({
+        endpointMetadata,
+    }: {
+        endpointMetadata?: core.EndpointMetadata;
+    } = {}): Promise<core.AuthRequest> {
+        const token = await core.Supplier.get(this.options[TOKEN_PARAM]);
+        if (token == null) {
+            throw new errors.HubServiceError({
+                message: BearerAuthProvider.AUTH_CONFIG_ERROR_MESSAGE,
+            });
+        }
+
+        return {
+            headers: { Authorization: `Bearer ${token}` },
+        };
+    }
+}
+
+export namespace BearerAuthProvider {
+    export const AUTH_SCHEME = "ApplicationCredentials" as const;
+    export const AUTH_CONFIG_ERROR_MESSAGE: string =
+        `Please provide '${TOKEN_PARAM}' when initializing the client` as const;
+    export type Options = AuthOptions;
+    export type AuthOptions = { [TOKEN_PARAM]: core.Supplier<core.BearerToken> };
+
+    export function createInstance(options: Options): core.AuthProvider {
+        return new BearerAuthProvider(options);
+    }
+}

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

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

package/src/api/service/core/auth/AuthProvider.ts

@@ -0,0 +1,6 @@
+import type { EndpointMetadata } from "../fetcher/EndpointMetadata.js";
+import type { AuthRequest } from "./AuthRequest.js";
+
+export interface AuthProvider {
+    getAuthRequest(arg?: { endpointMetadata?: EndpointMetadata }): Promise<AuthRequest>;
+}

package/src/api/service/core/auth/AuthRequest.ts

@@ -0,0 +1,9 @@
+/**
+ * Request parameters for authentication requests.
+ */
+export interface AuthRequest {
+    /**
+     * The headers to be included in the request.
+     */
+    headers: Record<string, string>;
+}

package/src/api/service/core/auth/BasicAuth.ts

@@ -0,0 +1,32 @@
+import { base64Decode, base64Encode } from "../base64.js";
+
+export interface BasicAuth {
+    username: string;
+    password: string;
+}
+
+const BASIC_AUTH_HEADER_PREFIX = /^Basic /i;
+
+export const BasicAuth = {
+    toAuthorizationHeader: (basicAuth: BasicAuth | undefined): string | undefined => {
+        if (basicAuth == null) {
+            return undefined;
+        }
+        const token = base64Encode(`${basicAuth.username}:${basicAuth.password}`);
+        return `Basic ${token}`;
+    },
+    fromAuthorizationHeader: (header: string): BasicAuth => {
+        const credentials = header.replace(BASIC_AUTH_HEADER_PREFIX, "");
+        const decoded = base64Decode(credentials);
+        const [username, ...passwordParts] = decoded.split(":");
+        const password = passwordParts.length > 0 ? passwordParts.join(":") : undefined;
+
+        if (username == null || password == null) {
+            throw new Error("Invalid basic auth");
+        }
+        return {
+            username,
+            password,
+        };
+    },
+};

package/src/api/service/core/auth/BearerToken.ts

@@ -0,0 +1,20 @@
+export type BearerToken = string;
+
+const BEARER_AUTH_HEADER_PREFIX = /^Bearer /i;
+
+function toAuthorizationHeader(token: string | undefined): string | undefined {
+    if (token == null) {
+        return undefined;
+    }
+    return `Bearer ${token}`;
+}
+
+export const BearerToken: {
+    toAuthorizationHeader: typeof toAuthorizationHeader;
+    fromAuthorizationHeader: (header: string) => BearerToken;
+} = {
+    toAuthorizationHeader: toAuthorizationHeader,
+    fromAuthorizationHeader: (header: string): BearerToken => {
+        return header.replace(BEARER_AUTH_HEADER_PREFIX, "").trim() as BearerToken;
+    },
+};

package/src/api/service/core/auth/NoOpAuthProvider.ts

@@ -0,0 +1,8 @@
+import type { AuthProvider } from "./AuthProvider.js";
+import type { AuthRequest } from "./AuthRequest.js";
+
+export class NoOpAuthProvider implements AuthProvider {
+    public getAuthRequest(): Promise<AuthRequest> {
+        return Promise.resolve({ headers: {} });
+    }
+}

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

@@ -0,0 +1,5 @@
+export type { AuthProvider } from "./AuthProvider.js";
+export type { AuthRequest } from "./AuthRequest.js";
+export { BasicAuth } from "./BasicAuth.js";
+export { BearerToken } from "./BearerToken.js";
+export { NoOpAuthProvider } from "./NoOpAuthProvider.js";

package/src/api/service/core/base64.ts

@@ -0,0 +1,27 @@
+function base64ToBytes(base64: string): Uint8Array {
+    const binString = atob(base64);
+    return Uint8Array.from(binString, (m) => m.codePointAt(0)!);
+}
+
+function bytesToBase64(bytes: Uint8Array): string {
+    const binString = String.fromCodePoint(...bytes);
+    return btoa(binString);
+}
+
+export function base64Encode(input: string): string {
+    if (typeof Buffer !== "undefined") {
+        return Buffer.from(input, "utf8").toString("base64");
+    }
+
+    const bytes = new TextEncoder().encode(input);
+    return bytesToBase64(bytes);
+}
+
+export function base64Decode(input: string): string {
+    if (typeof Buffer !== "undefined") {
+        return Buffer.from(input, "base64").toString("utf8");
+    }
+
+    const bytes = base64ToBytes(input);
+    return new TextDecoder().decode(bytes);
+}

package/src/api/service/core/exports.ts

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

package/src/api/service/core/fetcher/APIResponse.ts

@@ -0,0 +1,23 @@
+import type { 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/src/api/service/core/fetcher/BinaryResponse.ts

@@ -0,0 +1,34 @@
+export type BinaryResponse = {
+    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/bodyUsed) */
+    bodyUsed: Response["bodyUsed"];
+    /**
+     * Returns a ReadableStream of the response body.
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/body)
+     */
+    stream: () => Response["body"];
+    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/arrayBuffer) */
+    arrayBuffer: () => ReturnType<Response["arrayBuffer"]>;
+    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/blob) */
+    blob: () => ReturnType<Response["blob"]>;
+    /**
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/bytes)
+     * Some versions of the Fetch API may not support this method.
+     */
+    bytes?(): ReturnType<Response["bytes"]>;
+};
+
+export function getBinaryResponse(response: Response): BinaryResponse {
+    const binaryResponse: 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/src/api/service/core/fetcher/EndpointMetadata.ts

@@ -0,0 +1,13 @@
+export type SecuritySchemeKey = string;
+/**
+ * A collection of security schemes, where the key is the name of the security scheme and the value is the list of scopes required for that scheme.
+ * All schemes in the collection must be satisfied for authentication to be successful.
+ */
+export type SecuritySchemeCollection = Record<SecuritySchemeKey, AuthScope[]>;
+export type AuthScope = string;
+export type EndpointMetadata = {
+    /**
+     * An array of security scheme collections. Each collection represents an alternative way to authenticate.
+     */
+    security?: SecuritySchemeCollection[];
+};

package/src/api/service/core/fetcher/EndpointSupplier.ts

@@ -0,0 +1,14 @@
+import type { EndpointMetadata } from "./EndpointMetadata.js";
+import type { Supplier } from "./Supplier.js";
+
+type EndpointSupplierFn<T> = (arg: { endpointMetadata?: EndpointMetadata }) => T | Promise<T>;
+export type EndpointSupplier<T> = Supplier<T> | EndpointSupplierFn<T>;
+export const EndpointSupplier = {
+    get: async <T>(supplier: EndpointSupplier<T>, arg: { endpointMetadata?: EndpointMetadata }): Promise<T> => {
+        if (typeof supplier === "function") {
+            return (supplier as EndpointSupplierFn<T>)(arg);
+        } else {
+            return supplier;
+        }
+    },
+};

package/src/api/service/core/fetcher/Fetcher.ts

@@ -0,0 +1,397 @@
+import { toJson } from "../json.js";
+import { createLogger, type LogConfig, type Logger } from "../logging/logger.js";
+import type { APIResponse } from "./APIResponse.js";
+import { createRequestUrl } from "./createRequestUrl.js";
+import type { EndpointMetadata } from "./EndpointMetadata.js";
+import { EndpointSupplier } from "./EndpointSupplier.js";
+import { getErrorResponseBody } from "./getErrorResponseBody.js";
+import { getFetchFn } from "./getFetchFn.js";
+import { getRequestBody } from "./getRequestBody.js";
+import { getResponseBody } from "./getResponseBody.js";
+import { Headers } from "./Headers.js";
+import { makeRequest } from "./makeRequest.js";
+import { abortRawResponse, toRawResponse, unknownRawResponse } from "./RawResponse.js";
+import { requestWithRetries } from "./requestWithRetries.js";
+
+export type FetchFunction = <R = unknown>(args: Fetcher.Args) => Promise<APIResponse<R, Fetcher.Error>>;
+
+export declare namespace Fetcher {
+    export interface Args {
+        url: string;
+        method: string;
+        contentType?: string;
+        headers?: Record<string, unknown>;
+        queryParameters?: Record<string, unknown>;
+        body?: unknown;
+        timeoutMs?: number;
+        maxRetries?: number;
+        withCredentials?: boolean;
+        abortSignal?: AbortSignal;
+        requestType?: "json" | "file" | "bytes" | "form" | "other";
+        responseType?: "json" | "blob" | "sse" | "streaming" | "text" | "arrayBuffer" | "binary-response";
+        duplex?: "half";
+        endpointMetadata?: EndpointMetadata;
+        fetchFn?: typeof fetch;
+        logging?: LogConfig | Logger;
+    }
+
+    export type Error = FailedStatusCodeError | NonJsonError | BodyIsNullError | TimeoutError | UnknownError;
+
+    export interface FailedStatusCodeError {
+        reason: "status-code";
+        statusCode: number;
+        body: unknown;
+    }
+
+    export interface NonJsonError {
+        reason: "non-json";
+        statusCode: number;
+        rawBody: string;
+    }
+
+    export interface BodyIsNullError {
+        reason: "body-is-null";
+        statusCode: number;
+    }
+
+    export interface TimeoutError {
+        reason: "timeout";
+    }
+
+    export interface UnknownError {
+        reason: "unknown";
+        errorMessage: string;
+    }
+}
+
+const SENSITIVE_HEADERS = new Set([
+    "authorization",
+    "www-authenticate",
+    "x-api-key",
+    "api-key",
+    "apikey",
+    "x-api-token",
+    "x-auth-token",
+    "auth-token",
+    "cookie",
+    "set-cookie",
+    "proxy-authorization",
+    "proxy-authenticate",
+    "x-csrf-token",
+    "x-xsrf-token",
+    "x-session-token",
+    "x-access-token",
+]);
+
+function redactHeaders(headers: Headers | Record<string, string>): Record<string, string> {
+    const filtered: Record<string, string> = {};
+    for (const [key, value] of headers instanceof Headers ? headers.entries() : Object.entries(headers)) {
+        if (SENSITIVE_HEADERS.has(key.toLowerCase())) {
+            filtered[key] = "[REDACTED]";
+        } else {
+            filtered[key] = value;
+        }
+    }
+    return filtered;
+}
+
+const SENSITIVE_QUERY_PARAMS = new Set([
+    "api_key",
+    "api-key",
+    "apikey",
+    "token",
+    "access_token",
+    "access-token",
+    "auth_token",
+    "auth-token",
+    "password",
+    "passwd",
+    "secret",
+    "api_secret",
+    "api-secret",
+    "apisecret",
+    "key",
+    "session",
+    "session_id",
+    "session-id",
+]);
+
+function redactQueryParameters(queryParameters?: Record<string, unknown>): Record<string, unknown> | undefined {
+    if (queryParameters == null) {
+        return queryParameters;
+    }
+    const redacted: Record<string, unknown> = {};
+    for (const [key, value] of Object.entries(queryParameters)) {
+        if (SENSITIVE_QUERY_PARAMS.has(key.toLowerCase())) {
+            redacted[key] = "[REDACTED]";
+        } else {
+            redacted[key] = value;
+        }
+    }
+    return redacted;
+}
+
+function redactUrl(url: string): string {
+    const protocolIndex = url.indexOf("://");
+    if (protocolIndex === -1) return url;
+
+    const afterProtocol = protocolIndex + 3;
+
+    // Find the first delimiter that marks the end of the authority section
+    const pathStart = url.indexOf("/", afterProtocol);
+    let queryStart = url.indexOf("?", afterProtocol);
+    let fragmentStart = url.indexOf("#", afterProtocol);
+
+    const firstDelimiter = Math.min(
+        pathStart === -1 ? url.length : pathStart,
+        queryStart === -1 ? url.length : queryStart,
+        fragmentStart === -1 ? url.length : fragmentStart,
+    );
+
+    // Find the LAST @ before the delimiter (handles multiple @ in credentials)
+    let atIndex = -1;
+    for (let i = afterProtocol; i < firstDelimiter; i++) {
+        if (url[i] === "@") {
+            atIndex = i;
+        }
+    }
+
+    if (atIndex !== -1) {
+        url = `${url.slice(0, afterProtocol)}[REDACTED]@${url.slice(atIndex + 1)}`;
+    }
+
+    // Recalculate queryStart since url might have changed
+    queryStart = url.indexOf("?");
+    if (queryStart === -1) return url;
+
+    fragmentStart = url.indexOf("#", queryStart);
+    const queryEnd = fragmentStart !== -1 ? fragmentStart : url.length;
+    const queryString = url.slice(queryStart + 1, queryEnd);
+
+    if (queryString.length === 0) return url;
+
+    // FAST PATH: Quick check if any sensitive keywords present
+    // Using indexOf is faster than regex for simple substring matching
+    const lower = queryString.toLowerCase();
+    const hasSensitive =
+        lower.includes("token") ||
+        lower.includes("key") ||
+        lower.includes("password") ||
+        lower.includes("passwd") ||
+        lower.includes("secret") ||
+        lower.includes("session") ||
+        lower.includes("auth");
+
+    if (!hasSensitive) {
+        return url;
+    }
+
+    // SLOW PATH: Parse and redact
+    const redactedParams: string[] = [];
+    const params = queryString.split("&");
+
+    for (const param of params) {
+        const equalIndex = param.indexOf("=");
+        if (equalIndex === -1) {
+            redactedParams.push(param);
+            continue;
+        }
+
+        const key = param.slice(0, equalIndex);
+        let shouldRedact = SENSITIVE_QUERY_PARAMS.has(key.toLowerCase());
+
+        if (!shouldRedact && key.includes("%")) {
+            try {
+                const decodedKey = decodeURIComponent(key);
+                shouldRedact = SENSITIVE_QUERY_PARAMS.has(decodedKey.toLowerCase());
+            } catch {}
+        }
+
+        redactedParams.push(shouldRedact ? `${key}=[REDACTED]` : param);
+    }
+
+    return url.slice(0, queryStart + 1) + redactedParams.join("&") + url.slice(queryEnd);
+}
+
+async function getHeaders(args: Fetcher.Args): Promise<Headers> {
+    const newHeaders: Headers = new Headers();
+
+    newHeaders.set(
+        "Accept",
+        args.responseType === "json"
+            ? "application/json"
+            : args.responseType === "text"
+              ? "text/plain"
+              : args.responseType === "sse"
+                ? "text/event-stream"
+                : "*/*",
+    );
+    if (args.body !== undefined && args.contentType != null) {
+        newHeaders.set("Content-Type", args.contentType);
+    }
+
+    if (args.headers == null) {
+        return newHeaders;
+    }
+
+    for (const [key, value] of Object.entries(args.headers)) {
+        const result = await EndpointSupplier.get(value, { endpointMetadata: args.endpointMetadata ?? {} });
+        if (typeof result === "string") {
+            newHeaders.set(key, result);
+            continue;
+        }
+        if (result == null) {
+            continue;
+        }
+        newHeaders.set(key, `${result}`);
+    }
+    return newHeaders;
+}
+
+export async function fetcherImpl<R = unknown>(args: Fetcher.Args): Promise<APIResponse<R, Fetcher.Error>> {
+    const url = createRequestUrl(args.url, args.queryParameters);
+    const requestBody: BodyInit | undefined = await getRequestBody({
+        body: args.body,
+        type: args.requestType ?? "other",
+    });
+    const fetchFn = args.fetchFn ?? (await getFetchFn());
+    const headers = await getHeaders(args);
+    const logger = createLogger(args.logging);
+
+    if (logger.isDebug()) {
+        const metadata = {
+            method: args.method,
+            url: redactUrl(url),
+            headers: redactHeaders(headers),
+            queryParameters: redactQueryParameters(args.queryParameters),
+            hasBody: requestBody != null,
+        };
+        logger.debug("Making HTTP request", metadata);
+    }
+
+    try {
+        const response = await requestWithRetries(
+            async () =>
+                makeRequest(
+                    fetchFn,
+                    url,
+                    args.method,
+                    headers,
+                    requestBody,
+                    args.timeoutMs,
+                    args.abortSignal,
+                    args.withCredentials,
+                    args.duplex,
+                ),
+            args.maxRetries,
+        );
+
+        if (response.status >= 200 && response.status < 400) {
+            if (logger.isDebug()) {
+                const metadata = {
+                    method: args.method,
+                    url: redactUrl(url),
+                    statusCode: response.status,
+                    responseHeaders: redactHeaders(response.headers),
+                };
+                logger.debug("HTTP request succeeded", metadata);
+            }
+            const body = await getResponseBody(response, args.responseType);
+            return {
+                ok: true,
+                body: body as R,
+                headers: response.headers,
+                rawResponse: toRawResponse(response),
+            };
+        } else {
+            if (logger.isError()) {
+                const metadata = {
+                    method: args.method,
+                    url: redactUrl(url),
+                    statusCode: response.status,
+                    responseHeaders: redactHeaders(Object.fromEntries(response.headers.entries())),
+                };
+                logger.error("HTTP request failed with error status", metadata);
+            }
+            return {
+                ok: false,
+                error: {
+                    reason: "status-code",
+                    statusCode: response.status,
+                    body: await getErrorResponseBody(response),
+                },
+                rawResponse: toRawResponse(response),
+            };
+        }
+    } catch (error) {
+        if (args.abortSignal?.aborted) {
+            if (logger.isError()) {
+                const metadata = {
+                    method: args.method,
+                    url: redactUrl(url),
+                };
+                logger.error("HTTP request was aborted", metadata);
+            }
+            return {
+                ok: false,
+                error: {
+                    reason: "unknown",
+                    errorMessage: "The user aborted a request",
+                },
+                rawResponse: abortRawResponse,
+            };
+        } else if (error instanceof Error && error.name === "AbortError") {
+            if (logger.isError()) {
+                const metadata = {
+                    method: args.method,
+                    url: redactUrl(url),
+                    timeoutMs: args.timeoutMs,
+                };
+                logger.error("HTTP request timed out", metadata);
+            }
+            return {
+                ok: false,
+                error: {
+                    reason: "timeout",
+                },
+                rawResponse: abortRawResponse,
+            };
+        } else if (error instanceof Error) {
+            if (logger.isError()) {
+                const metadata = {
+                    method: args.method,
+                    url: redactUrl(url),
+                    errorMessage: error.message,
+                };
+                logger.error("HTTP request failed with error", metadata);
+            }
+            return {
+                ok: false,
+                error: {
+                    reason: "unknown",
+                    errorMessage: error.message,
+                },
+                rawResponse: unknownRawResponse,
+            };
+        }
+
+        if (logger.isError()) {
+            const metadata = {
+                method: args.method,
+                url: redactUrl(url),
+                error: toJson(error),
+            };
+            logger.error("HTTP request failed with unknown error", metadata);
+        }
+        return {
+            ok: false,
+            error: {
+                reason: "unknown",
+                errorMessage: toJson(error),
+            },
+            rawResponse: unknownRawResponse,
+        };
+    }
+}
+
+export const fetcher: FetchFunction = fetcherImpl;