pulse-ts-sdk 0.0.51 → 0.0.53

package/dist/esm/api/resources/jobs/index.d.mts

@@ -0,0 +1 @@
+export * from "./client/index.mjs";

package/dist/esm/api/resources/jobs/index.mjs

@@ -0,0 +1 @@
+export * from "./client/index.mjs";

package/dist/esm/api/resources/webhooks/client/Client.d.mts

@@ -0,0 +1,26 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.mjs";
+import { type NormalizedClientOptions } from "../../../../BaseClient.mjs";
+import * as core from "../../../../core/index.mjs";
+import * as Pulse from "../../../index.mjs";
+export declare namespace WebhooksClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class WebhooksClient {
+    protected readonly _options: NormalizedClientOptions<WebhooksClient.Options>;
+    constructor(options?: WebhooksClient.Options);
+    /**
+     * Generates a temporary link to the Svix webhook portal where users can manage their webhook endpoints and view message logs.
+     *
+     * @param {WebhooksClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pulse.UnauthorizedError}
+     * @throws {@link Pulse.InternalServerError}
+     *
+     * @example
+     *     await client.webhooks.createWebhookLink()
+     */
+    createWebhookLink(requestOptions?: WebhooksClient.RequestOptions): core.HttpResponsePromise<Pulse.CreateWebhookLinkResponse>;
+    private __createWebhookLink;
+}

package/dist/esm/api/resources/webhooks/client/Client.mjs

@@ -0,0 +1,71 @@
+// This file was auto-generated by Fern from our API Definition.
+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());
+    });
+};
+import { normalizeClientOptions } from "../../../../BaseClient.mjs";
+import { mergeHeaders } from "../../../../core/headers.mjs";
+import * as core from "../../../../core/index.mjs";
+import * as environments from "../../../../environments.mjs";
+import { handleNonStatusCodeError } from "../../../../errors/handleNonStatusCodeError.mjs";
+import * as errors from "../../../../errors/index.mjs";
+import * as Pulse from "../../../index.mjs";
+export class WebhooksClient {
+    constructor(options = {}) {
+        this._options = normalizeClientOptions(options);
+    }
+    /**
+     * Generates a temporary link to the Svix webhook portal where users can manage their webhook endpoints and view message logs.
+     *
+     * @param {WebhooksClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pulse.UnauthorizedError}
+     * @throws {@link Pulse.InternalServerError}
+     *
+     * @example
+     *     await client.webhooks.createWebhookLink()
+     */
+    createWebhookLink(requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__createWebhookLink(requestOptions));
+    }
+    __createWebhookLink(requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PulseEnvironment.Default, "webhook"),
+                method: "POST",
+                headers: _headers,
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
+                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 401:
+                        throw new Pulse.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new Pulse.InternalServerError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.PulseError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/webhook");
+        });
+    }
+}

package/dist/esm/api/resources/webhooks/client/index.d.mts

@@ -0,0 +1 @@
+export {};

package/dist/esm/api/resources/webhooks/client/index.mjs

@@ -0,0 +1 @@
+export {};

package/dist/esm/api/resources/webhooks/index.d.mts

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

package/dist/esm/api/resources/webhooks/index.mjs

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

package/dist/esm/api/resources/webhooks/types/CreateWebhookLinkResponse.d.mts

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

package/dist/esm/api/resources/webhooks/types/CreateWebhookLinkResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/webhooks/types/index.d.mts

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

package/dist/esm/api/resources/webhooks/types/index.mjs

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

package/dist/esm/api/types/ExtractAsyncInput.d.mts

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

package/dist/esm/api/types/ExtractAsyncInput.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/ExtractAsyncResponse.d.mts

@@ -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/esm/api/types/ExtractAsyncResponse.mjs

@@ -0,0 +1,12 @@
+// This file was auto-generated by Fern from our API Definition.
+export var ExtractAsyncResponse;
+(function (ExtractAsyncResponse) {
+    /** Initial status reported by the extractor. */
+    ExtractAsyncResponse.Status = {
+        Pending: "pending",
+        Processing: "processing",
+        Completed: "completed",
+        Failed: "failed",
+        Canceled: "canceled",
+    };
+})(ExtractAsyncResponse || (ExtractAsyncResponse = {}));

package/dist/esm/api/types/ExtractInput.d.mts

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

package/dist/esm/api/types/ExtractInput.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/ExtractJsonInput.d.mts

@@ -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/esm/api/types/ExtractJsonInput.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/ExtractMultipartInput.d.mts

@@ -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/esm/api/types/ExtractMultipartInput.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/ExtractOptions.d.mts

@@ -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/esm/api/types/ExtractOptions.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/ExtractResponse.d.mts

@@ -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/esm/api/types/ExtractResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/JobCancellationResponse.d.mts

@@ -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/esm/api/types/JobCancellationResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/JobStatus.d.mts

@@ -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/esm/api/types/JobStatus.mjs

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Lifecycle status for an asynchronous extraction job. */
+export const JobStatus = {
+    Pending: "pending",
+    Processing: "processing",
+    Completed: "completed",
+    Failed: "failed",
+    Canceled: "canceled",
+};

package/dist/esm/api/types/JobStatusResponse.d.mts

@@ -0,0 +1,17 @@
+import type * as Pulse from "../index.mjs";
+/**
+ * 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/esm/api/types/JobStatusResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/JsonSource.d.mts

@@ -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/esm/api/types/JsonSource.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/MultipartSource.d.mts

@@ -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/esm/api/types/MultipartSource.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/index.d.mts

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

package/dist/esm/api/types/index.mjs

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

package/dist/esm/auth/HeaderAuthProvider.d.mts

@@ -0,0 +1,16 @@
+import * as core from "../core/index.mjs";
+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/esm/auth/HeaderAuthProvider.mjs

@@ -0,0 +1,34 @@
+// This file was auto-generated by Fern from our API Definition.
+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());
+    });
+};
+import * as core from "../core/index.mjs";
+import * as errors from "../errors/index.mjs";
+export 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 },
+            };
+        });
+    }
+}

package/dist/esm/auth/index.d.mts

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

package/dist/esm/auth/index.mjs

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

package/dist/esm/core/auth/AuthProvider.d.mts

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

package/dist/esm/core/auth/AuthProvider.mjs

@@ -0,0 +1 @@
+export {};

package/dist/esm/core/auth/AuthRequest.d.mts

@@ -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/esm/core/auth/AuthRequest.mjs

@@ -0,0 +1 @@
+export {};

package/dist/esm/core/auth/BasicAuth.d.mts

@@ -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;
+};