jmap-kit 0.0.0 → 1.0.2

package/dist/src/invocation/utils.js

@@ -0,0 +1,30 @@
+import { ErrorInvocation } from "./error-invocation.js";
+import { ResultReference } from "./result-reference.js";
+/**
+ * Type guard to check if a value is an instance of ResultReference.
+ * @param value The value to check.
+ * @returns True if the value is a ResultReference, false otherwise.
+ */
+export function isResultReference(value) {
+    return value instanceof ResultReference;
+}
+/**
+ * Type guard to check if an object is an ErrorInvocation instance.
+ * @param obj The object to check.
+ * @returns True if the object is an ErrorInvocation, false otherwise.
+ */
+export function isErrorInvocation(obj) {
+    return obj instanceof ErrorInvocation;
+}
+/**
+ * Type guard to check if an object is a valid JMAPResponseInvocationErrorArgs.
+ * @param args The object to check.
+ * @returns True if the object has a string `type` property, false otherwise.
+ */
+export function isJMAPResponseInvocationErrorArgs(args) {
+    return (typeof args === "object" &&
+        args !== null &&
+        "type" in args &&
+        typeof args.type === "string");
+}
+//# sourceMappingURL=utils.js.map

package/dist/src/invocation/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/invocation/utils.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAExD;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAAC,KAAc;IAC5C,OAAO,KAAK,YAAY,eAAe,CAAC;AAC5C,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAAC,GAAY;IAC1C,OAAO,GAAG,YAAY,eAAe,CAAC;AAC1C,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,iCAAiC,CAAC,IAAa;IAC3D,OAAO,CACH,OAAO,IAAI,KAAK,QAAQ;QACxB,IAAI,KAAK,IAAI;QACb,MAAM,IAAI,IAAI;QACd,OAAQ,IAA0B,CAAC,IAAI,KAAK,QAAQ,CACvD,CAAC;AACN,CAAC"}

package/dist/src/invocation-factory/invocation-factory-manager.d.ts

@@ -0,0 +1,20 @@
+import type { Id, JMAPResponseInvocation } from "../common/types.js";
+import type { ClientContext, JMAPClientInterface } from "../jmap-client/types.js";
+import { InvocationList } from "./invocation-list.js";
+/**
+ * Manages construction of invocations from JMAP method responses using the capability registry.
+ */
+export declare class InvocationFactoryManager {
+    #private;
+    constructor(client: JMAPClientInterface<unknown>, { logger, emitter }: ClientContext);
+    /**
+     * Construct invocation objects from JMAP method responses.
+     *
+     * @param methodResponses The array of JMAP method responses.
+     * @param reverseIdMap Map from method call IDs to internal symbols.
+     * @returns An InvocationList containing the constructed invocation objects.
+     * @throws If no factory is registered for a data type, or there's no factory
+     *         function for the particular method.
+     */
+    createInvocations(methodResponses: JMAPResponseInvocation[], reverseIdMap: Map<Id, symbol>): InvocationList<import("../index.js").BaseInvocationArgs>;
+}

package/dist/src/invocation-factory/invocation-factory-manager.js

@@ -0,0 +1,50 @@
+import { ErrorInvocation } from "../invocation/error-invocation.js";
+import { isJMAPResponseInvocationErrorArgs } from "../invocation/utils.js";
+import { InvocationList } from "./invocation-list.js";
+/**
+ * Manages construction of invocations from JMAP method responses using the capability registry.
+ */
+export class InvocationFactoryManager {
+    #logger;
+    #emitter;
+    #client;
+    constructor(client, { logger, emitter }) {
+        this.#logger = logger;
+        this.#emitter = emitter;
+        this.#client = client;
+    }
+    /**
+     * Construct invocation objects from JMAP method responses.
+     *
+     * @param methodResponses The array of JMAP method responses.
+     * @param reverseIdMap Map from method call IDs to internal symbols.
+     * @returns An InvocationList containing the constructed invocation objects.
+     * @throws If no factory is registered for a data type, or there's no factory
+     *         function for the particular method.
+     */
+    createInvocations(methodResponses, reverseIdMap) {
+        const responses = methodResponses.map(([name, args, methodCallId]) => {
+            const id = reverseIdMap.get(methodCallId);
+            if (!id)
+                this.#logger.warn(`No corresponding ID found for ${methodCallId} in the Request Builder`);
+            if (name === "error") {
+                this.#logger.warn(`Received error response for invocation with ID: ${methodCallId}`);
+                if (!isJMAPResponseInvocationErrorArgs(args)) {
+                    this.#logger.warn(`Error response missing "type" property for invocation with ID: ${methodCallId}, defaulting to "serverFail"`);
+                    return new ErrorInvocation({ ...args, type: "serverFail" }, id);
+                }
+                return new ErrorInvocation(args, id);
+            }
+            this.#logger.info(`Constructing ${name} invocation with ID: ${methodCallId}`);
+            const [dataType, methodName] = name.split("/");
+            const factoryFn = this.#client.capabilityRegistry.getInvocationResponseFactory(dataType, methodName);
+            if (!factoryFn) {
+                this.#logger.error(`No response factory function available for ${name}`);
+                throw new Error(`No response factory function available for ${name}`);
+            }
+            return factoryFn(args, id);
+        });
+        return new InvocationList(responses, { logger: this.#logger, emitter: this.#emitter });
+    }
+}
+//# sourceMappingURL=invocation-factory-manager.js.map

package/dist/src/invocation-factory/invocation-factory-manager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"invocation-factory-manager.js","sourceRoot":"","sources":["../../../src/invocation-factory/invocation-factory-manager.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,mCAAmC,CAAC;AACpE,OAAO,EAAE,iCAAiC,EAAE,MAAM,wBAAwB,CAAC;AAE3E,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAEtD;;GAEG;AACH,MAAM,OAAO,wBAAwB;IACxB,OAAO,CAAS;IAChB,QAAQ,CAAiB;IACzB,OAAO,CAA+B;IAE/C,YAAY,MAAoC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAiB;QAChF,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IAC1B,CAAC;IAED;;;;;;;;OAQG;IACH,iBAAiB,CAAC,eAAyC,EAAE,YAA6B;QACtF,MAAM,SAAS,GAAG,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,YAAY,CAAC,EAAE,EAAE;YACjE,MAAM,EAAE,GAAG,YAAY,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;YAC1C,IAAI,CAAC,EAAE;gBAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iCAAiC,YAAY,yBAAyB,CAAC,CAAC;YAEnG,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;gBACnB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mDAAmD,YAAY,EAAE,CAAC,CAAC;gBAErF,IAAI,CAAC,iCAAiC,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC3C,IAAI,CAAC,OAAO,CAAC,IAAI,CACb,kEAAkE,YAAY,8BAA8B,CAC/G,CAAC;oBACF,OAAO,IAAI,eAAe,CAAC,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,EAAE,EAAE,CAAC,CAAC;gBACpE,CAAC;gBAED,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YACzC,CAAC;YAED,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,IAAI,wBAAwB,YAAY,EAAE,CAAC,CAAC;YAC9E,MAAM,CAAC,QAAQ,EAAE,UAAU,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAmC,CAAC;YAEjF,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,4BAA4B,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;YACrG,IAAI,CAAC,SAAS,EAAE,CAAC;gBACb,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,8CAA8C,IAAI,EAAE,CAAC,CAAC;gBACzE,MAAM,IAAI,KAAK,CAAC,8CAA8C,IAAI,EAAE,CAAC,CAAC;YAC1E,CAAC;YAED,OAAO,SAAS,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,cAAc,CAAC,SAAS,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC3F,CAAC;CACJ"}

package/dist/src/invocation-factory/invocation-list.d.ts

@@ -0,0 +1,32 @@
+import type { ErrorInvocation } from "../invocation/error-invocation.js";
+import type { Invocation } from "../invocation/invocation.js";
+import type { BaseInvocationArgs } from "../invocation/types.js";
+import type { ClientContext } from "../jmap-client/types.js";
+import type { HandlerFn, InvocationHandlerMap } from "./types.js";
+export declare class InvocationList<T extends BaseInvocationArgs> implements Iterable<Invocation<T> | ErrorInvocation> {
+    #private;
+    /**
+     * @param invocations The list of invocations (or errors) to manage.
+     * @param logger Optional logger instance for logging within the invocation list.
+     */
+    constructor(invocations: (Invocation<T> | ErrorInvocation)[], { logger }: ClientContext);
+    /**
+     * @returns An iterator over the invocations and errors in the list.
+     */
+    [Symbol.iterator](): ArrayIterator<ErrorInvocation | Invocation<T>>;
+    /**
+     * Get the number of invocations and errors in the list.
+     */
+    get size(): number;
+    /**
+     * Dispatch each invocation or error in the list to the appropriate handler function.
+     *
+     * @param handlers An object mapping method IDs (symbols), method names (e.g., "Mailbox/get"),
+     *        data types (e.g. "Mailbox"), or the special property `error` to handler functions.
+     *        - Each handler receives the invocation of the appropriate type.
+     *        - The `error` property, if present, will be called for error invocations.
+     * @param defaultHandler Optional handler for invocations with no registered handler.
+     * @returns A promise that resolves when all handlers have been called.
+     */
+    dispatch(handlers: InvocationHandlerMap, defaultHandler?: HandlerFn): Promise<void>;
+}

package/dist/src/invocation-factory/invocation-list.js

@@ -0,0 +1,77 @@
+import { isErrorInvocation } from "../invocation/utils.js";
+export class InvocationList {
+    #invocations;
+    #logger;
+    /**
+     * @param invocations The list of invocations (or errors) to manage.
+     * @param logger Optional logger instance for logging within the invocation list.
+     */
+    constructor(invocations, { logger }) {
+        this.#invocations = invocations;
+        this.#logger = logger;
+    }
+    /**
+     * @returns An iterator over the invocations and errors in the list.
+     */
+    [Symbol.iterator]() {
+        return this.#invocations[Symbol.iterator]();
+    }
+    /**
+     * Get the number of invocations and errors in the list.
+     */
+    get size() {
+        return this.#invocations.length;
+    }
+    /**
+     * Log debug information about handler dispatch.
+     * @param invocation The invocation being dispatched
+     * @param handlerType The type of handler being used
+     */
+    #logDispatch(invocation, handlerType) {
+        const messages = {
+            id: `Dispatching invocation for ${invocation.name} to handler by ID`,
+            name: `Dispatching invocation for ${invocation.name} to handler: ${invocation.name}`,
+            dataType: `Dispatching invocation for ${invocation.name} to handler: ${invocation.dataType}`,
+            default: `Dispatching invocation for ${invocation.name} to default handler`,
+        };
+        this.#logger.debug(messages[handlerType]);
+    }
+    /**
+     * Dispatch each invocation or error in the list to the appropriate handler function.
+     *
+     * @param handlers An object mapping method IDs (symbols), method names (e.g., "Mailbox/get"),
+     *        data types (e.g. "Mailbox"), or the special property `error` to handler functions.
+     *        - Each handler receives the invocation of the appropriate type.
+     *        - The `error` property, if present, will be called for error invocations.
+     * @param defaultHandler Optional handler for invocations with no registered handler.
+     * @returns A promise that resolves when all handlers have been called.
+     */
+    async dispatch(handlers, defaultHandler) {
+        for (const invocation of this) {
+            if (isErrorInvocation(invocation)) {
+                this.#logger.warn(`Dispatching error invocation: ${invocation.type}`);
+                await handlers.error?.(invocation);
+                continue;
+            }
+            let handler = handlers[invocation.id];
+            if (handler !== undefined) {
+                this.#logDispatch(invocation, "id");
+            }
+            else if ((handler = handlers[invocation.name]) !== undefined) {
+                this.#logDispatch(invocation, "name");
+            }
+            else if ((handler = handlers[invocation.dataType]) !== undefined) {
+                this.#logDispatch(invocation, "dataType");
+            }
+            else if ((handler = defaultHandler) !== undefined) /* NOSONAR */ {
+                this.#logDispatch(invocation, "default");
+            }
+            else {
+                this.#logger.info(`No handler found for invocation: ${invocation.name}`);
+                continue;
+            }
+            await handler(invocation);
+        }
+    }
+}
+//# sourceMappingURL=invocation-list.js.map

package/dist/src/invocation-factory/invocation-list.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"invocation-list.js","sourceRoot":"","sources":["../../../src/invocation-factory/invocation-list.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAI3D,MAAM,OAAO,cAAc;IACd,YAAY,CAAsC;IAClD,OAAO,CAAS;IAEzB;;;OAGG;IACH,YAAY,WAAgD,EAAE,EAAE,MAAM,EAAiB;QACnF,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;QAChC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IAC1B,CAAC;IAED;;OAEG;IACH,CAAC,MAAM,CAAC,QAAQ,CAAC;QACb,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;IAChD,CAAC;IAED;;OAEG;IACH,IAAI,IAAI;QACJ,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC;IACpC,CAAC;IAED;;;;OAIG;IACH,YAAY,CAAC,UAAyB,EAAE,WAAmD;QACvF,MAAM,QAAQ,GAAG;YACb,EAAE,EAAE,8BAA8B,UAAU,CAAC,IAAI,mBAAmB;YACpE,IAAI,EAAE,8BAA8B,UAAU,CAAC,IAAI,gBAAgB,UAAU,CAAC,IAAI,EAAE;YACpF,QAAQ,EAAE,8BAA8B,UAAU,CAAC,IAAI,gBAAgB,UAAU,CAAC,QAAQ,EAAE;YAC5F,OAAO,EAAE,8BAA8B,UAAU,CAAC,IAAI,qBAAqB;SAC9E,CAAC;QACF,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,QAAQ,CAAC,QAA8B,EAAE,cAA0B;QACrE,KAAK,MAAM,UAAU,IAAI,IAAI,EAAE,CAAC;YAC5B,IAAI,iBAAiB,CAAC,UAAU,CAAC,EAAE,CAAC;gBAChC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iCAAiC,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC;gBACtE,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC,UAAU,CAAC,CAAC;gBAEnC,SAAS;YACb,CAAC;YAED,IAAI,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;YACtC,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;gBACxB,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;YACxC,CAAC;iBAAM,IAAI,CAAC,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC;gBAC7D,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;YAC1C,CAAC;iBAAM,IAAI,CAAC,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC;gBACjE,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;YAC9C,CAAC;iBAAM,IAAI,CAAC,OAAO,GAAG,cAAc,CAAC,KAAK,SAAS,EAAE,aAAa,CAAC,CAAC;gBAChE,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;YAC7C,CAAC;iBAAM,CAAC;gBACJ,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oCAAoC,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC;gBACzE,SAAS;YACb,CAAC;YACD,MAAM,OAAO,CAAC,UAAU,CAAC,CAAC;QAC9B,CAAC;IACL,CAAC;CACJ"}

package/dist/src/invocation-factory/types.d.ts

@@ -0,0 +1,11 @@
+/**
+ * A function that handles processing a response invocation.
+ */
+export type HandlerFn = (invocation: any) => void | Promise<void>;
+/**
+ * A mapping of invocation IDs (symbols), method names (e.g., "Mailbox/get"), data types (e.g. "Mailbox"),
+ * or the special property `error` to handler functions.
+ */
+export type InvocationHandlerMap = Record<string | symbol, HandlerFn> & {
+    error?: HandlerFn;
+};

package/dist/src/invocation-factory/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/src/invocation-factory/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/invocation-factory/types.ts"],"names":[],"mappings":""}

package/dist/src/jmap-client/jmap-client.d.ts

@@ -0,0 +1,252 @@
+/**
+ * JMAP Client class implementation
+ * @module jmap-client
+ * @license MIT
+ *
+ * @example
+ * import { JMAPClient } from 'jmap-client';
+ * const transport = // ... create a transport
+ *
+ * const client = new JMAPClient(transport, {
+ *     hostname: "api.example.com",
+ * });
+ *
+ * await client.connect();
+ *
+ * // Do something with the client
+ */
+import type { CapabilityDefinition, CapabilityRegistryInterface } from "../capability-registry/types.js";
+import type { Id, JMAPCapability, JMAPServerCapabilities } from "../common/types.js";
+import { RequestBuilder } from "../request-builder/request-builder.js";
+import type { CapabilityRegistrationResult, ConnectionStatus, EventEmitterFn, HeadersInit, JMAPAccount, JMAPClientInterface, JMAPClientOptions, JMAPUploadResponse, Logger, Transport } from "./types.js";
+/**
+ * JMAP Client for interacting with a JMAP server.
+ *
+ * This class manages the connection lifecycle, session state, and provides methods for
+ * interacting with the JMAP API, including capability checks, file downloads, and
+ * invocation requests and responses.
+ */
+export declare class JMAPClient implements JMAPClientInterface<RequestBuilder> {
+    #private;
+    /**
+     * The current connection status of the client.
+     */
+    get connectionStatus(): ConnectionStatus;
+    /**
+     * Create a new JMAPClient instance.
+     *
+     * The provided Transport is responsible for all HTTP request concerns, including authentication,
+     * network errors, and any custom headers or request logic required by the server. The client
+     * itself does not handle authentication or low-level HTTP details.
+     *
+     * If the port is not specified, it defaults to 443.
+     *
+     * @param transport The transport implementation for HTTP requests, including authentication.
+     * @param options JMAP client options including hostname, port, headers, logger, and emitter.
+     */
+    constructor(transport: Transport, { hostname, port, headers, logger, emitter }: JMAPClientOptions);
+    /**
+     * Register one or more capabilities with the client.
+     *
+     * When called after the client is connected, each capability's schema is validated against
+     * the session data. Capabilities that fail validation are rejected and not registered.
+     * When called before connecting, capabilities are registered without validation.
+     *
+     * If called while the client is in the process of connecting, registration waits for the
+     * connection to complete before validating. If the connection fails, capabilities are
+     * registered without validation (no session to validate against).
+     *
+     * @param capabilities The capability definitions to register
+     * @returns A result object containing arrays of validation failures (empty arrays if all succeeded)
+     */
+    registerCapabilities(...capabilities: CapabilityDefinition[]): Promise<CapabilityRegistrationResult>;
+    /**
+     * Set the hostname for the JMAP server. Only allowed while disconnected.
+     *
+     * @param hostname The hostname of the JMAP server
+     * @throws Error if called after connecting.
+     * @returns This client instance (for chaining).
+     */
+    withHostname(hostname: string): this;
+    /**
+     * Set the port for the JMAP server. Only allowed while disconnected.
+     *
+     * @param port Port number.
+     * @throws Error if called after connecting.
+     * @returns This client instance (for chaining).
+     */
+    withPort(port: number): this;
+    /**
+     * Set additional headers for requests.
+     *
+     * @param headers Additional headers to merge.
+     * @returns This client instance (for chaining).
+     */
+    withHeaders(headers: HeadersInit): this;
+    /**
+     * Set a custom logger for the client.
+     *
+     * @param logger The logger instance or function.
+     * @returns This client instance (for chaining).
+     */
+    withLogger(logger: Logger): this;
+    /**
+     * Set a custom event emitter for the client.
+     *
+     * @param emitter The event emitter function to handle events.
+     * @returns This client instance (for chaining).
+     */
+    withEmitter(emitter: EventEmitterFn): this;
+    /**
+     * Connect to the JMAP server and fetch the session object.
+     *
+     * This method is idempotent: if called multiple times while a connection is already in progress,
+     * each call will return a new Promise that resolves or rejects with the same result as the in-progress connection.
+     * Only one connection attempt will be made at a time; concurrent calls will not trigger multiple connections.
+     *
+     * @throws Error if hostname is not set or connection fails.
+     */
+    connect(signal?: AbortSignal): Promise<void>;
+    /**
+     * Disconnect from the JMAP server and clear session state.
+     *
+     * This method is asynchronous and will not set the status to 'disconnected' until all
+     * in-flight requests have settled (resolved or rejected) after being aborted.
+     * It is idempotent: if already disconnecting, it returns the same promise.
+     */
+    disconnect(): Promise<void>;
+    /**
+     * Get the capability registry.
+     *
+     * This provides read-only access to the registry of JMAP capabilities.
+     * To register new capabilities, use the registerCapability method.
+     */
+    get capabilityRegistry(): CapabilityRegistryInterface;
+    /**
+     * The server capabilities from the session object, or null if not connected.
+     */
+    get serverCapabilities(): Readonly<JMAPServerCapabilities> | null;
+    /**
+     * Determines if a given capability identified by its URN is supported by the server.
+     * @param urn The URN of the JMAP capability being queried.
+     * @returns True if supported, false otherwise.
+     */
+    isSupported(urn: JMAPCapability): boolean;
+    /**
+     * The accounts from the session object, or null if not connected.
+     */
+    get accounts(): Readonly<Record<Id, JMAPAccount>> | null;
+    /**
+     * The primary accounts from the session object, or an empty object if not connected.
+     */
+    get primaryAccounts(): Readonly<Partial<Record<JMAPCapability, Id>>>;
+    /**
+     * The username from the session object, or an empty string if not connected.
+     */
+    get username(): string;
+    /**
+     * The API URL from the session object, or an empty string if not connected.
+     */
+    get apiUrl(): string;
+    /**
+     * The download URL template from the session object, or an empty string if not connected.
+     */
+    get downloadUrl(): string;
+    /**
+     * The upload URL template from the session object, or an empty string if not connected.
+     */
+    get uploadUrl(): string;
+    /**
+     * The event source URL template from the session object, or an empty string if not connected.
+     */
+    get eventSourceUrl(): string;
+    /**
+     * Download a file from the server.
+     *
+     * @param accountId The id of the account to which the record with the blobId belongs.
+     * @param blobId The blobId representing the data of the file to download.
+     * @param name The name for the file; the server MUST return this as the filename if it sets a Content-Disposition header.
+     * @param type The type for the server to set in the Content-Type header of the response; the blobId only represents the binary data and does not have a content-type innately associated with it.
+     * @param signal Optional AbortSignal to cancel the request.
+     * @throws Error if the client is not connected, downloadUrl is missing from session, accountId is not listed in the session's accounts.
+     * @throws JMAPRequestError for JMAP protocol errors (non-200 status codes with {@link https://www.rfc-editor.org/rfc/rfc7807.html RFC 7807} Problem Details).
+     * @throws TypeError If parsing the response fails.
+     * @throws If a network error, timeout, or other transport failure occurs.
+     * @returns A promise that resolves to a Blob containing the data of the file.
+     */
+    downloadFile(accountId: Id, blobId: Id, name: string, type: string, signal?: AbortSignal): Promise<Blob>;
+    /**
+     * Upload a file to the server.
+     *
+     * @param accountId The id of the account to upload to.
+     * @param file The file data to upload. Can be a Blob, ArrayBuffer, or File.
+     * @param signal Optional AbortSignal to cancel the request.
+     * @throws Error if the file size exceeds the maxSizeUpload limit from server capabilities.
+     * @throws Error if the client is not connected, uploadUrl is missing from session, or accountId is not listed in the session's accounts.
+     * @throws JMAPRequestError for JMAP protocol errors (non-200 status codes with {@link https://www.rfc-editor.org/rfc/rfc7807.html RFC 7807} Problem Details).
+     * @throws TypeError If parsing the response fails.
+     * @throws If a network error, timeout, or other transport failure occurs.
+     * @returns A promise that resolves to the upload response from the server.
+     */
+    uploadFile(accountId: Id, file: Blob | ArrayBuffer | File, signal?: AbortSignal): Promise<JMAPUploadResponse>;
+    /**
+     * Get the parsed download URL for a file.
+     *
+     * @param accountId The id of the account to which the record with the blobId belongs.
+     * @param blobId The blobId representing the data of the file to download.
+     * @param name The name for the file; the server MUST return this as the filename if it sets a Content-Disposition header.
+     * @param type The type for the server to set in the Content-Type header of the response; the blobId only represents the binary data and does not have a content-type innately associated with it.
+     * @throws Error if the Client is not connected to a JMAP server
+     * @throws Error if downloadUrl is missing from session
+     * @throws Error if accountId is not listed in the session's accounts
+     * @returns the download URL with variables expanded
+     */
+    getDownloadUrl(accountId: Id, blobId: Id, name: string, type: string): URL;
+    /**
+     * Get the parsed upload URL for a file.
+     *
+     * @param accountId The id of the account to upload the file to.
+     * @throws Error if the Client is not connected to a JMAP server
+     * @throws Error if uploadUrl is missing from session
+     * @throws Error if accountId is not listed in the session's accounts
+     * @returns the upload URL with variables expanded
+     */
+    getUploadUrl(accountId: Id): URL;
+    /**
+     * Get the parsed event source URL.
+     *
+     * @param types Either an array of event types to listen for, or "*" to listen for all types.
+     * @param closeafter Either "state" (end response after pushing a state event) or "no" (persist connection).
+     * @param ping Positive integer value in seconds. If non-zero, the server will send a ping event after this time elapses since the previous event.
+     * @throws Error if the Client is not connected to a JMAP server
+     * @throws Error if eventSourceUrl is missing from session
+     * @throws Error if ping is negative
+     * @returns the event source URL with variables expanded
+     */
+    getEventSourceUrl(types: string[] | "*", closeafter: "state" | "no", ping: number): URL;
+    /**
+     * Create a new RequestBuilder instance linked to this client.
+     *
+     * The builder will have access to the client's current capabilities and session state,
+     * allowing it to validate requests and enforce server limits.
+     *
+     * @returns A new RequestBuilder instance
+     */
+    createRequestBuilder(): RequestBuilder;
+    /**
+     * Send an API request to the JMAP server.
+     *
+     * @param jmapRequest The request builder instance.
+     * @param signal Optional AbortSignal to cancel the request.
+     * @throws Error if the client is not connected, disconnecting, or failed to connect.
+     * @throws JMAPRequestError for JMAP protocol errors (non-200 status codes with {@link https://www.rfc-editor.org/rfc/rfc7807.html RFC 7807} Problem Details).
+     * @throws TypeError If parsing the response fails.
+     * @throws If a network error, timeout, or other transport failure occurs.
+     * @returns The parsed response from the server.
+     */
+    sendAPIRequest(jmapRequest: RequestBuilder, signal?: AbortSignal): Promise<{
+        methodResponses: import("../invocation-factory/invocation-list.js").InvocationList<import("../index.js").BaseInvocationArgs>;
+        sessionState: string;
+        createdIds: import("../common/types.js").IdMap;
+    }>;
+}