pulse-ts-sdk 0.0.51 → 0.0.53

package/dist/cjs/api/resources/webhooks/types/CreateWebhookLinkResponse.d.ts

@@ -0,0 +1,4 @@
+export interface CreateWebhookLinkResponse {
+    /** URL to the Svix webhook portal */
+    link: string;
+}

package/dist/cjs/api/resources/webhooks/types/CreateWebhookLinkResponse.js

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

package/dist/cjs/api/resources/webhooks/types/index.d.ts

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

package/dist/cjs/api/resources/webhooks/types/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("./CreateWebhookLinkResponse.js"), exports);

package/dist/cjs/api/types/ExtractAsyncInput.d.ts

@@ -0,0 +1 @@
+export type ExtractAsyncInput = unknown;

package/dist/cjs/api/types/ExtractAsyncInput.js

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

package/dist/cjs/api/types/ExtractAsyncResponse.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Metadata describing the enqueued asynchronous extraction job.
+ */
+export interface ExtractAsyncResponse {
+    /** Identifier assigned to the asynchronous extraction job. */
+    job_id: string;
+    /** Initial status reported by the extractor. */
+    status: ExtractAsyncResponse.Status;
+    /** Timestamp indicating when the job was accepted. */
+    queuedAt?: string;
+}
+export declare namespace ExtractAsyncResponse {
+    /** Initial status reported by the extractor. */
+    const Status: {
+        readonly Pending: "pending";
+        readonly Processing: "processing";
+        readonly Completed: "completed";
+        readonly Failed: "failed";
+        readonly Canceled: "canceled";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+}

package/dist/cjs/api/types/ExtractAsyncResponse.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.ExtractAsyncResponse = void 0;
+var ExtractAsyncResponse;
+(function (ExtractAsyncResponse) {
+    /** Initial status reported by the extractor. */
+    ExtractAsyncResponse.Status = {
+        Pending: "pending",
+        Processing: "processing",
+        Completed: "completed",
+        Failed: "failed",
+        Canceled: "canceled",
+    };
+})(ExtractAsyncResponse || (exports.ExtractAsyncResponse = ExtractAsyncResponse = {}));

package/dist/cjs/api/types/ExtractInput.d.ts

@@ -0,0 +1 @@
+export type ExtractInput = unknown;

package/dist/cjs/api/types/ExtractInput.js

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

package/dist/cjs/api/types/ExtractJsonInput.d.ts

@@ -0,0 +1,61 @@
+/**
+ * Input schema for JSON requests (fileUrl only).
+ */
+export interface ExtractJsonInput {
+    /** Public or pre-signed URL that Pulse will download and extract. */
+    fileUrl: string;
+    /** Recommended method for schema-guided extraction. Contains the schema and optional prompt in a single object. */
+    structuredOutput?: ExtractJsonInput.StructuredOutput;
+    /** (Deprecated) JSON schema describing structured data to extract. Use structuredOutput instead. Accepts either a JSON object or a stringified JSON representation. */
+    schema?: ExtractJsonInput.Schema;
+    /** (Deprecated) Experimental schema definition used for feature flagged behaviour. Accepts either a JSON object or a stringified JSON representation. */
+    experimentalSchema?: ExtractJsonInput.ExperimentalSchema;
+    /** (Deprecated) Natural language prompt for schema-guided extraction. Use structuredOutput.schemaPrompt instead. */
+    schemaPrompt?: string;
+    /** (Deprecated) Custom instructions that augment the default extraction behaviour. */
+    customPrompt?: string;
+    /** Comma-separated list of chunking strategies to apply (for example `semantic,header,page,recursive`). */
+    chunking?: string;
+    /** Override for maximum characters per chunk when chunking is enabled. */
+    chunkSize?: number;
+    /** Page range filter supporting segments such as `1-2` or mixed ranges like `1-2,5`. */
+    pages?: string;
+    /** Toggle to enable figure extraction in results. */
+    extractFigure?: boolean;
+    /** Toggle to generate descriptive captions for extracted figures. */
+    figureDescription?: boolean;
+    /** Whether to include HTML representation alongside markdown in the response. */
+    returnHtml?: boolean;
+    /** (Deprecated) Enables expanded rationale output for debugging. */
+    thinking?: boolean;
+    /** Options for persisting extraction artifacts. When enabled (default), artifacts are saved to storage and a database record is created. */
+    storage?: ExtractJsonInput.Storage;
+}
+export declare namespace ExtractJsonInput {
+    /**
+     * Recommended method for schema-guided extraction. Contains the schema and optional prompt in a single object.
+     */
+    interface StructuredOutput {
+        /** JSON schema describing the structured data to extract. */
+        schema?: Record<string, unknown>;
+        /** Natural language prompt with additional extraction instructions. */
+        schemaPrompt?: string;
+    }
+    /**
+     * (Deprecated) JSON schema describing structured data to extract. Use structuredOutput instead. Accepts either a JSON object or a stringified JSON representation.
+     */
+    type Schema = Record<string, unknown> | string;
+    /**
+     * (Deprecated) Experimental schema definition used for feature flagged behaviour. Accepts either a JSON object or a stringified JSON representation.
+     */
+    type ExperimentalSchema = Record<string, unknown> | string;
+    /**
+     * Options for persisting extraction artifacts. When enabled (default), artifacts are saved to storage and a database record is created.
+     */
+    interface Storage {
+        /** Whether to persist extraction artifacts. Set to false for temporary extractions with no storage or database record. */
+        enabled?: boolean;
+        /** Target folder name to save the extraction to. Creates the folder if it doesn't exist. */
+        folderName?: string;
+    }
+}

package/dist/cjs/api/types/ExtractJsonInput.js

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

package/dist/cjs/api/types/ExtractMultipartInput.d.ts

@@ -0,0 +1,63 @@
+/**
+ * Input schema for multipart/form-data requests (file upload or fileUrl).
+ */
+export interface ExtractMultipartInput {
+    /** Document to upload directly. Required unless fileUrl is provided. */
+    file?: string;
+    /** Public or pre-signed URL that Pulse will download and extract. Required unless file is provided. */
+    fileUrl?: string;
+    /** Recommended method for schema-guided extraction. Contains the schema and optional prompt in a single object. */
+    structuredOutput?: ExtractMultipartInput.StructuredOutput;
+    /** (Deprecated) JSON schema describing structured data to extract. Use structuredOutput instead. Accepts either a JSON object or a stringified JSON representation. */
+    schema?: ExtractMultipartInput.Schema;
+    /** (Deprecated) Experimental schema definition used for feature flagged behaviour. Accepts either a JSON object or a stringified JSON representation. */
+    experimentalSchema?: ExtractMultipartInput.ExperimentalSchema;
+    /** (Deprecated) Natural language prompt for schema-guided extraction. Use structuredOutput.schemaPrompt instead. */
+    schemaPrompt?: string;
+    /** (Deprecated) Custom instructions that augment the default extraction behaviour. */
+    customPrompt?: string;
+    /** Comma-separated list of chunking strategies to apply (for example `semantic,header,page,recursive`). */
+    chunking?: string;
+    /** Override for maximum characters per chunk when chunking is enabled. */
+    chunkSize?: number;
+    /** Page range filter supporting segments such as `1-2` or mixed ranges like `1-2,5`. */
+    pages?: string;
+    /** Toggle to enable figure extraction in results. */
+    extractFigure?: boolean;
+    /** Toggle to generate descriptive captions for extracted figures. */
+    figureDescription?: boolean;
+    /** Whether to include HTML representation alongside markdown in the response. */
+    returnHtml?: boolean;
+    /** (Deprecated) Enables expanded rationale output for debugging. */
+    thinking?: boolean;
+    /** Options for persisting extraction artifacts. When enabled (default), artifacts are saved to storage and a database record is created. */
+    storage?: ExtractMultipartInput.Storage;
+}
+export declare namespace ExtractMultipartInput {
+    /**
+     * Recommended method for schema-guided extraction. Contains the schema and optional prompt in a single object.
+     */
+    interface StructuredOutput {
+        /** JSON schema describing the structured data to extract. */
+        schema?: Record<string, unknown>;
+        /** Natural language prompt with additional extraction instructions. */
+        schemaPrompt?: string;
+    }
+    /**
+     * (Deprecated) JSON schema describing structured data to extract. Use structuredOutput instead. Accepts either a JSON object or a stringified JSON representation.
+     */
+    type Schema = Record<string, unknown> | string;
+    /**
+     * (Deprecated) Experimental schema definition used for feature flagged behaviour. Accepts either a JSON object or a stringified JSON representation.
+     */
+    type ExperimentalSchema = Record<string, unknown> | string;
+    /**
+     * Options for persisting extraction artifacts. When enabled (default), artifacts are saved to storage and a database record is created.
+     */
+    interface Storage {
+        /** Whether to persist extraction artifacts. Set to false for temporary extractions with no storage or database record. */
+        enabled?: boolean;
+        /** Target folder name to save the extraction to. Creates the folder if it doesn't exist. */
+        folderName?: string;
+    }
+}

package/dist/cjs/api/types/ExtractMultipartInput.js

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

package/dist/cjs/api/types/ExtractOptions.d.ts

@@ -0,0 +1,59 @@
+/**
+ * Common extraction options shared by synchronous and asynchronous endpoints.
+ */
+export interface ExtractOptions {
+    /** Recommended method for schema-guided extraction. Contains the schema and optional prompt in a single object. */
+    structuredOutput?: ExtractOptions.StructuredOutput;
+    /** (Deprecated) JSON schema describing structured data to extract. Use structuredOutput instead. Accepts either a JSON object or a stringified JSON representation. */
+    schema?: ExtractOptions.Schema;
+    /** (Deprecated) Experimental schema definition used for feature flagged behaviour. Accepts either a JSON object or a stringified JSON representation. */
+    experimentalSchema?: ExtractOptions.ExperimentalSchema;
+    /** (Deprecated) Natural language prompt for schema-guided extraction. Use structuredOutput.schemaPrompt instead. */
+    schemaPrompt?: string;
+    /** (Deprecated) Custom instructions that augment the default extraction behaviour. */
+    customPrompt?: string;
+    /** Comma-separated list of chunking strategies to apply (for example `semantic,header,page,recursive`). */
+    chunking?: string;
+    /** Override for maximum characters per chunk when chunking is enabled. */
+    chunkSize?: number;
+    /** Page range filter supporting segments such as `1-2` or mixed ranges like `1-2,5`. */
+    pages?: string;
+    /** Toggle to enable figure extraction in results. */
+    extractFigure?: boolean;
+    /** Toggle to generate descriptive captions for extracted figures. */
+    figureDescription?: boolean;
+    /** Whether to include HTML representation alongside markdown in the response. */
+    returnHtml?: boolean;
+    /** (Deprecated) Enables expanded rationale output for debugging. */
+    thinking?: boolean;
+    /** Options for persisting extraction artifacts. When enabled (default), artifacts are saved to storage and a database record is created. */
+    storage?: ExtractOptions.Storage;
+}
+export declare namespace ExtractOptions {
+    /**
+     * Recommended method for schema-guided extraction. Contains the schema and optional prompt in a single object.
+     */
+    interface StructuredOutput {
+        /** JSON schema describing the structured data to extract. */
+        schema?: Record<string, unknown>;
+        /** Natural language prompt with additional extraction instructions. */
+        schemaPrompt?: string;
+    }
+    /**
+     * (Deprecated) JSON schema describing structured data to extract. Use structuredOutput instead. Accepts either a JSON object or a stringified JSON representation.
+     */
+    type Schema = Record<string, unknown> | string;
+    /**
+     * (Deprecated) Experimental schema definition used for feature flagged behaviour. Accepts either a JSON object or a stringified JSON representation.
+     */
+    type ExperimentalSchema = Record<string, unknown> | string;
+    /**
+     * Options for persisting extraction artifacts. When enabled (default), artifacts are saved to storage and a database record is created.
+     */
+    interface Storage {
+        /** Whether to persist extraction artifacts. Set to false for temporary extractions with no storage or database record. */
+        enabled?: boolean;
+        /** Target folder name to save the extraction to. Creates the folder if it doesn't exist. */
+        folderName?: string;
+    }
+}

package/dist/cjs/api/types/ExtractOptions.js

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

package/dist/cjs/api/types/ExtractResponse.d.ts

@@ -0,0 +1,17 @@
+/**
+ * High-level structure returned by the synchronous extract API.
+ */
+export interface ExtractResponse {
+    /** Primary markdown content extracted from the document. */
+    content?: string;
+    /** Optional HTML representation when returnHtml is true. */
+    html?: string;
+    /** Identifier assigned to the extraction job. */
+    job_id?: string;
+    /** Non-fatal warnings generated during extraction. */
+    warnings?: string[];
+    /** Additional metadata supplied by the backend. */
+    metadata?: Record<string, unknown>;
+    /** Accepts any additional properties */
+    [key: string]: any;
+}

package/dist/cjs/api/types/ExtractResponse.js

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

package/dist/cjs/api/types/JobCancellationResponse.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Confirmation payload returned after successfully canceling a job.
+ */
+export interface JobCancellationResponse {
+    /** Identifier of the job that was cancelled. */
+    job_id: string;
+    /** Human-readable confirmation message. */
+    message: string;
+}

package/dist/cjs/api/types/JobCancellationResponse.js

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

package/dist/cjs/api/types/JobStatus.d.ts

@@ -0,0 +1,9 @@
+/** Lifecycle status for an asynchronous extraction job. */
+export declare const JobStatus: {
+    readonly Pending: "pending";
+    readonly Processing: "processing";
+    readonly Completed: "completed";
+    readonly Failed: "failed";
+    readonly Canceled: "canceled";
+};
+export type JobStatus = (typeof JobStatus)[keyof typeof JobStatus];

package/dist/cjs/api/types/JobStatus.js

@@ -0,0 +1,12 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JobStatus = void 0;
+/** Lifecycle status for an asynchronous extraction job. */
+exports.JobStatus = {
+    Pending: "pending",
+    Processing: "processing",
+    Completed: "completed",
+    Failed: "failed",
+    Canceled: "canceled",
+};

package/dist/cjs/api/types/JobStatusResponse.d.ts

@@ -0,0 +1,17 @@
+import type * as Pulse from "../index.js";
+/**
+ * Current status and metadata for an asynchronous extraction job.
+ */
+export interface JobStatusResponse {
+    /** Identifier assigned to the asynchronous extraction job. */
+    job_id: string;
+    status: Pulse.JobStatus;
+    /** Timestamp when the job was accepted. */
+    created_at: string;
+    /** Timestamp of the last status update, if available. */
+    updated_at?: string;
+    /** Structured payload that contains extraction output when the job is completed. */
+    result?: Record<string, unknown>;
+    /** Error message describing why the job failed, if applicable. */
+    error?: string;
+}

package/dist/cjs/api/types/JobStatusResponse.js

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

package/dist/cjs/api/types/JsonSource.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Document source definition for JSON requests.
+ */
+export interface JsonSource {
+    /** Public or pre-signed URL that Pulse will download and extract. */
+    fileUrl: string;
+}

package/dist/cjs/api/types/JsonSource.js

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

package/dist/cjs/api/types/MultipartSource.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Document source definition for multipart/form-data requests. Provide exactly one of `file` (direct upload) or `fileUrl` (remote URL).
+ */
+export interface MultipartSource {
+    /** Document to upload directly. Required unless fileUrl is provided. */
+    file?: string;
+    /** Public or pre-signed URL that Pulse will download and extract. Required unless file is provided. */
+    fileUrl?: string;
+}

package/dist/cjs/api/types/MultipartSource.js

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

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

@@ -0,0 +1,12 @@
+export * from "./ExtractAsyncInput.js";
+export * from "./ExtractAsyncResponse.js";
+export * from "./ExtractInput.js";
+export * from "./ExtractJsonInput.js";
+export * from "./ExtractMultipartInput.js";
+export * from "./ExtractOptions.js";
+export * from "./ExtractResponse.js";
+export * from "./JobCancellationResponse.js";
+export * from "./JobStatus.js";
+export * from "./JobStatusResponse.js";
+export * from "./JsonSource.js";
+export * from "./MultipartSource.js";

package/dist/cjs/api/types/index.js

@@ -0,0 +1,28 @@
+"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("./ExtractAsyncInput.js"), exports);
+__exportStar(require("./ExtractAsyncResponse.js"), exports);
+__exportStar(require("./ExtractInput.js"), exports);
+__exportStar(require("./ExtractJsonInput.js"), exports);
+__exportStar(require("./ExtractMultipartInput.js"), exports);
+__exportStar(require("./ExtractOptions.js"), exports);
+__exportStar(require("./ExtractResponse.js"), exports);
+__exportStar(require("./JobCancellationResponse.js"), exports);
+__exportStar(require("./JobStatus.js"), exports);
+__exportStar(require("./JobStatusResponse.js"), exports);
+__exportStar(require("./JsonSource.js"), exports);
+__exportStar(require("./MultipartSource.js"), exports);

package/dist/cjs/auth/HeaderAuthProvider.d.ts

@@ -0,0 +1,16 @@
+import * as core from "../core/index.js";
+export declare namespace HeaderAuthProvider {
+    interface AuthOptions {
+        apiKey?: core.Supplier<string>;
+    }
+    interface Options extends AuthOptions {
+    }
+}
+export declare class HeaderAuthProvider implements core.AuthProvider {
+    private readonly headerValue;
+    constructor(options: HeaderAuthProvider.Options);
+    static canCreate(options: HeaderAuthProvider.Options): boolean;
+    getAuthRequest(_arg?: {
+        endpointMetadata?: core.EndpointMetadata;
+    }): Promise<core.AuthRequest>;
+}

package/dist/cjs/auth/HeaderAuthProvider.js

@@ -0,0 +1,71 @@
+"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;
+    };
+})();
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HeaderAuthProvider = void 0;
+const core = __importStar(require("../core/index.js"));
+const errors = __importStar(require("../errors/index.js"));
+class HeaderAuthProvider {
+    constructor(options) {
+        this.headerValue = options.apiKey;
+    }
+    static canCreate(options) {
+        return options.apiKey != null;
+    }
+    getAuthRequest(_arg) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const apiKey = yield core.Supplier.get(this.headerValue);
+            if (apiKey == null) {
+                throw new errors.PulseError({
+                    message: "Please specify a apiKey by passing it in to the constructor",
+                });
+            }
+            const headerValue = apiKey;
+            return {
+                headers: { "x-api-key": headerValue },
+            };
+        });
+    }
+}
+exports.HeaderAuthProvider = HeaderAuthProvider;

package/dist/cjs/auth/index.d.ts

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

package/dist/cjs/auth/index.js

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

package/dist/cjs/core/auth/AuthProvider.d.ts

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

package/dist/cjs/core/auth/AuthProvider.js

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

package/dist/cjs/core/auth/AuthRequest.d.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/dist/cjs/core/auth/AuthRequest.js

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

package/dist/cjs/core/auth/BasicAuth.d.ts

@@ -0,0 +1,8 @@
+export interface BasicAuth {
+    username: string;
+    password: string;
+}
+export declare const BasicAuth: {
+    toAuthorizationHeader: (basicAuth: BasicAuth | undefined) => string | undefined;
+    fromAuthorizationHeader: (header: string) => BasicAuth;
+};

package/dist/cjs/core/auth/BasicAuth.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BasicAuth = void 0;
+const base64_js_1 = require("../base64.js");
+const BASIC_AUTH_HEADER_PREFIX = /^Basic /i;
+exports.BasicAuth = {
+    toAuthorizationHeader: (basicAuth) => {
+        if (basicAuth == null) {
+            return undefined;
+        }
+        const token = (0, base64_js_1.base64Encode)(`${basicAuth.username}:${basicAuth.password}`);
+        return `Basic ${token}`;
+    },
+    fromAuthorizationHeader: (header) => {
+        const credentials = header.replace(BASIC_AUTH_HEADER_PREFIX, "");
+        const decoded = (0, base64_js_1.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/dist/cjs/core/auth/BearerToken.d.ts

@@ -0,0 +1,7 @@
+export type BearerToken = string;
+declare function toAuthorizationHeader(token: string | undefined): string | undefined;
+export declare const BearerToken: {
+    toAuthorizationHeader: typeof toAuthorizationHeader;
+    fromAuthorizationHeader: (header: string) => BearerToken;
+};
+export {};