agentmail 0.0.44 → 0.0.46

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

@@ -0,0 +1,31 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments.mjs";
+import * as core from "../../../../core/index.mjs";
+import { WebsocketsSocket } from "./Socket.mjs";
+export declare namespace Websockets {
+    interface Options {
+        environment?: core.Supplier<environments.AgentMailEnvironment | environments.AgentMailEnvironmentUrls>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        apiKey?: core.Supplier<core.BearerToken | undefined>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+    }
+    interface ConnectArgs {
+        auth_token?: string | undefined;
+        /** Arbitrary headers to send with the websocket connect request. */
+        headers?: Record<string, string>;
+        /** Enable debug mode on the websocket. Defaults to false. */
+        debug?: boolean;
+        /** Number of reconnect attempts. Defaults to 30. */
+        reconnectAttempts?: number;
+    }
+}
+export declare class Websockets {
+    protected readonly _options: Websockets.Options;
+    constructor(_options?: Websockets.Options);
+    connect(args?: Websockets.ConnectArgs): Promise<WebsocketsSocket>;
+    protected _getAuthorizationHeader(): Promise<string>;
+}

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

@@ -0,0 +1,52 @@
+/**
+ * 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 environments from "../../../../environments.mjs";
+import * as core from "../../../../core/index.mjs";
+import { WebsocketsSocket } from "./Socket.mjs";
+import * as errors from "../../../../errors/index.mjs";
+export class Websockets {
+    constructor(_options = {}) {
+        this._options = _options;
+    }
+    connect() {
+        return __awaiter(this, arguments, void 0, function* (args = {}) {
+            var _a, _b;
+            const { auth_token, headers, debug, reconnectAttempts } = args;
+            const _queryParams = {};
+            if (auth_token != null) {
+                _queryParams["auth_token"] = auth_token;
+            }
+            let _headers = Object.assign({}, headers);
+            const socket = new core.ReconnectingWebSocket({
+                url: core.url.join((_a = (yield core.Supplier.get(this._options["baseUrl"]))) !== null && _a !== void 0 ? _a : ((_b = (yield core.Supplier.get(this._options["environment"]))) !== null && _b !== void 0 ? _b : environments.AgentMailEnvironment.Production).websockets, "/v0"),
+                protocols: [],
+                queryParameters: _queryParams,
+                headers: _headers,
+                options: { debug: debug !== null && debug !== void 0 ? debug : false, maxRetries: reconnectAttempts !== null && reconnectAttempts !== void 0 ? reconnectAttempts : 30 },
+            });
+            return new WebsocketsSocket({ socket });
+        });
+    }
+    _getAuthorizationHeader() {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            const bearer = (_a = (yield core.Supplier.get(this._options.apiKey))) !== null && _a !== void 0 ? _a : process === null || process === void 0 ? void 0 : process.env["AGENTMAIL_API_KEY"];
+            if (bearer == null) {
+                throw new errors.AgentMailError({
+                    message: "Please specify a bearer by either passing it in to the constructor or initializing a AGENTMAIL_API_KEY environment variable",
+                });
+            }
+            return `Bearer ${bearer}`;
+        });
+    }
+}

package/dist/esm/api/resources/websockets/client/Socket.d.mts

@@ -0,0 +1,52 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as core from "../../../../core/index.mjs";
+import * as AgentMail from "../../../index.mjs";
+export declare namespace WebsocketsSocket {
+    interface Args {
+        socket: core.ReconnectingWebSocket;
+    }
+    type Response = AgentMail.Subscribed | AgentMail.MessageReceived;
+    type EventHandlers = {
+        open?: () => void;
+        message?: (message: Response) => void;
+        close?: (event: core.CloseEvent) => void;
+        error?: (error: Error) => void;
+    };
+}
+export declare class WebsocketsSocket {
+    readonly socket: core.ReconnectingWebSocket;
+    protected readonly eventHandlers: WebsocketsSocket.EventHandlers;
+    private handleOpen;
+    private handleMessage;
+    private handleClose;
+    private handleError;
+    constructor(args: WebsocketsSocket.Args);
+    /** The current state of the connection; this is one of the readyState constants. */
+    get readyState(): number;
+    /**
+     * @param event - The event to attach to.
+     * @param callback - The callback to run when the event is triggered.
+     * Usage:
+     * ```typescript
+     * this.on('open', () => {
+     *     console.log('The websocket is open');
+     * });
+     * ```
+     */
+    on<T extends keyof WebsocketsSocket.EventHandlers>(event: T, callback: WebsocketsSocket.EventHandlers[T]): void;
+    sendSubscribe(message: AgentMail.Subscribe): void;
+    /** Connect to the websocket and register event handlers. */
+    connect(): WebsocketsSocket;
+    /** Close the websocket and unregister event handlers. */
+    close(): void;
+    /** Returns a promise that resolves when the websocket is open. */
+    waitForOpen(): Promise<core.ReconnectingWebSocket>;
+    /** Asserts that the websocket is open. */
+    private assertSocketIsOpen;
+    /** Send a binary payload to the websocket. */
+    protected sendBinary(payload: ArrayBufferLike | Blob | ArrayBufferView): void;
+    /** Send a JSON payload to the websocket. */
+    protected sendJson(payload: AgentMail.Subscribe): void;
+}

package/dist/esm/api/resources/websockets/client/Socket.mjs

@@ -0,0 +1,115 @@
+/**
+ * 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 { fromJson, toJson } from "../../../../core/json.mjs";
+export class WebsocketsSocket {
+    constructor(args) {
+        this.eventHandlers = {};
+        this.handleOpen = () => {
+            var _a, _b;
+            (_b = (_a = this.eventHandlers).open) === null || _b === void 0 ? void 0 : _b.call(_a);
+        };
+        this.handleMessage = (event) => {
+            var _a, _b;
+            const data = fromJson(event.data);
+            (_b = (_a = this.eventHandlers).message) === null || _b === void 0 ? void 0 : _b.call(_a, data);
+        };
+        this.handleClose = (event) => {
+            var _a, _b;
+            (_b = (_a = this.eventHandlers).close) === null || _b === void 0 ? void 0 : _b.call(_a, event);
+        };
+        this.handleError = (event) => {
+            var _a, _b;
+            const message = event.message;
+            (_b = (_a = this.eventHandlers).error) === null || _b === void 0 ? void 0 : _b.call(_a, new Error(message));
+        };
+        this.socket = args.socket;
+        this.socket.addEventListener("open", this.handleOpen);
+        this.socket.addEventListener("message", this.handleMessage);
+        this.socket.addEventListener("close", this.handleClose);
+        this.socket.addEventListener("error", this.handleError);
+    }
+    /** The current state of the connection; this is one of the readyState constants. */
+    get readyState() {
+        return this.socket.readyState;
+    }
+    /**
+     * @param event - The event to attach to.
+     * @param callback - The callback to run when the event is triggered.
+     * Usage:
+     * ```typescript
+     * this.on('open', () => {
+     *     console.log('The websocket is open');
+     * });
+     * ```
+     */
+    on(event, callback) {
+        this.eventHandlers[event] = callback;
+    }
+    sendSubscribe(message) {
+        this.assertSocketIsOpen();
+        this.sendJson(message);
+    }
+    /** Connect to the websocket and register event handlers. */
+    connect() {
+        this.socket.reconnect();
+        this.socket.addEventListener("open", this.handleOpen);
+        this.socket.addEventListener("message", this.handleMessage);
+        this.socket.addEventListener("close", this.handleClose);
+        this.socket.addEventListener("error", this.handleError);
+        return this;
+    }
+    /** Close the websocket and unregister event handlers. */
+    close() {
+        this.socket.close();
+        this.handleClose({ code: 1000 });
+        this.socket.removeEventListener("open", this.handleOpen);
+        this.socket.removeEventListener("message", this.handleMessage);
+        this.socket.removeEventListener("close", this.handleClose);
+        this.socket.removeEventListener("error", this.handleError);
+    }
+    /** Returns a promise that resolves when the websocket is open. */
+    waitForOpen() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.socket.readyState === core.ReconnectingWebSocket.OPEN) {
+                return this.socket;
+            }
+            return new Promise((resolve, reject) => {
+                this.socket.addEventListener("open", () => {
+                    resolve(this.socket);
+                });
+                this.socket.addEventListener("error", (event) => {
+                    reject(event);
+                });
+            });
+        });
+    }
+    /** Asserts that the websocket is open. */
+    assertSocketIsOpen() {
+        if (!this.socket) {
+            throw new Error("Socket is not connected.");
+        }
+        if (this.socket.readyState !== core.ReconnectingWebSocket.OPEN) {
+            throw new Error("Socket is not open.");
+        }
+    }
+    /** Send a binary payload to the websocket. */
+    sendBinary(payload) {
+        this.socket.send(payload);
+    }
+    /** Send a JSON payload to the websocket. */
+    sendJson(payload) {
+        const jsonPayload = toJson(payload);
+        this.socket.send(jsonPayload);
+    }
+}

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

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

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

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

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

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

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

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

package/dist/esm/api/resources/websockets/types/EventId.mjs

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

package/dist/esm/api/resources/websockets/types/MessageReceived.d.mts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as AgentMail from "../../../index.mjs";
+export interface MessageReceived {
+    type: "event";
+    event_type: "message.received";
+    event_id: AgentMail.EventId;
+    message: AgentMail.Message;
+}

package/dist/esm/api/resources/websockets/types/MessageReceived.mjs

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

package/dist/esm/api/resources/websockets/types/Subscribe.d.mts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface Subscribe {
+    type: "subscribe";
+    /** IDs of the inboxes to subscribe to. */
+    inbox_ids: string[];
+}

package/dist/esm/api/resources/websockets/types/Subscribe.mjs

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

package/dist/esm/api/resources/websockets/types/Subscribed.d.mts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface Subscribed {
+    type: "subscribed";
+    /** IDs of the inboxes that have been subscribed to. */
+    inbox_ids: string[];
+}

package/dist/esm/api/resources/websockets/types/Subscribed.mjs

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

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

@@ -0,0 +1,4 @@
+export * from "./EventId.mjs";
+export * from "./Subscribe.mjs";
+export * from "./Subscribed.mjs";
+export * from "./MessageReceived.mjs";

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

@@ -0,0 +1,4 @@
+export * from "./EventId.mjs";
+export * from "./Subscribe.mjs";
+export * from "./Subscribed.mjs";
+export * from "./MessageReceived.mjs";

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

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

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

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

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

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

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

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as AgentMail from "../index.mjs";
+export interface ErrorResponse {
+    name: AgentMail.ErrorName;
+    /** Error message. */
+    message: string;
+}

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as AgentMail from "../index.mjs";
+export interface ValidationErrorResponse {
+    name: AgentMail.ErrorName;
+    /** Validation errors. */
+    errors?: unknown;
+}

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

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

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

@@ -0,0 +1,9 @@
+export * from "./Limit.mjs";
+export * from "./Count.mjs";
+export * from "./PageToken.mjs";
+export * from "./Labels.mjs";
+export * from "./Ascending.mjs";
+export * from "./OrganizationId.mjs";
+export * from "./ErrorName.mjs";
+export * from "./ErrorResponse.mjs";
+export * from "./ValidationErrorResponse.mjs";

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

@@ -0,0 +1,9 @@
+export * from "./Limit.mjs";
+export * from "./Count.mjs";
+export * from "./PageToken.mjs";
+export * from "./Labels.mjs";
+export * from "./Ascending.mjs";
+export * from "./OrganizationId.mjs";
+export * from "./ErrorName.mjs";
+export * from "./ErrorResponse.mjs";
+export * from "./ValidationErrorResponse.mjs";

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

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

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

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

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

@@ -0,0 +1,2 @@
+export { BasicAuth } from "./BasicAuth.mjs";
+export { BearerToken } from "./BearerToken.mjs";

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

@@ -0,0 +1,2 @@
+export { BasicAuth } from "./BasicAuth.mjs";
+export { BearerToken } from "./BearerToken.mjs";

package/dist/esm/core/base64.d.mts

@@ -0,0 +1,2 @@
+export declare function base64Encode(input: string): string;
+export declare function base64Decode(input: string): string;

package/dist/esm/core/base64.mjs

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

package/dist/esm/core/fetcher/APIResponse.d.mts

@@ -0,0 +1,20 @@
+import { RawResponse } from "./RawResponse.mjs";
+/**
+ * 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/dist/esm/core/fetcher/APIResponse.mjs

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

package/dist/esm/core/fetcher/BinaryResponse.d.mts

@@ -0,0 +1,20 @@
+import { ResponseWithBody } from "./ResponseWithBody.mjs";
+export type BinaryResponse = {
+    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/bodyUsed) */
+    bodyUsed: boolean;
+    /**
+     * Returns a ReadableStream of the response body.
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/body)
+     */
+    stream: () => ReadableStream<Uint8Array>;
+    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/arrayBuffer) */
+    arrayBuffer: () => Promise<ArrayBuffer>;
+    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/blob) */
+    blob: () => Promise<Blob>;
+    /**
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/bytes)
+     * Some versions of the Fetch API may not support this method.
+     */
+    bytes?(): Promise<Uint8Array>;
+};
+export declare function getBinaryResponse(response: ResponseWithBody): BinaryResponse;

package/dist/esm/core/fetcher/BinaryResponse.mjs

@@ -0,0 +1,14 @@
+export function getBinaryResponse(response) {
+    const 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/dist/esm/core/fetcher/Fetcher.d.mts

@@ -0,0 +1,40 @@
+import { APIResponse } from "./APIResponse.mjs";
+import { Supplier } from "./Supplier.mjs";
+export type FetchFunction = <R = unknown>(args: Fetcher.Args) => Promise<APIResponse<R, Fetcher.Error>>;
+export declare namespace Fetcher {
+    interface Args {
+        url: string;
+        method: string;
+        contentType?: string;
+        headers?: Record<string, string | Supplier<string | undefined> | undefined>;
+        queryParameters?: Record<string, string | string[] | object | object[] | null>;
+        body?: unknown;
+        timeoutMs?: number;
+        maxRetries?: number;
+        withCredentials?: boolean;
+        abortSignal?: AbortSignal;
+        requestType?: "json" | "file" | "bytes";
+        responseType?: "json" | "blob" | "sse" | "streaming" | "text" | "arrayBuffer" | "binary-response";
+        duplex?: "half";
+    }
+    type Error = FailedStatusCodeError | NonJsonError | TimeoutError | UnknownError;
+    interface FailedStatusCodeError {
+        reason: "status-code";
+        statusCode: number;
+        body: unknown;
+    }
+    interface NonJsonError {
+        reason: "non-json";
+        statusCode: number;
+        rawBody: string;
+    }
+    interface TimeoutError {
+        reason: "timeout";
+    }
+    interface UnknownError {
+        reason: "unknown";
+        errorMessage: string;
+    }
+}
+export declare function fetcherImpl<R = unknown>(args: Fetcher.Args): Promise<APIResponse<R, Fetcher.Error>>;
+export declare const fetcher: FetchFunction;