jmap-kit 0.0.0 → 1.0.2

package/dist/src/request-builder/request-builder.js

@@ -0,0 +1,343 @@
+import { CORE_CAPABILITY_URI } from "../common/registry.js";
+import { idGenerator } from "../common/utils.js";
+const ID_PREFIX = "id_";
+export class RequestBuilder {
+    #client;
+    #logger;
+    // readonly #emitter: EventEmitterFn;
+    #methods = new Set();
+    #createdIds = null;
+    #idMap = new Map();
+    constructor(client, { logger }) {
+        this.#client = client;
+        this.#logger = logger;
+    }
+    /** Get the set of unique URIs that will be included in the `using` parameter of the JMAP request */
+    get using() {
+        // RFC 8620 errata (EID 6606) clarifies that core MUST be present in `using` for every request.
+        return new Set([CORE_CAPABILITY_URI, ...[...this.#methods].map((invocation) => invocation.uri)]);
+    }
+    /** Get the collection of method calls that are included in this request */
+    get methodCalls() {
+        return Object.freeze([...this.#methods]);
+    }
+    /** Get the map of created IDs that are included in this request */
+    get createdIds() {
+        return this.#createdIds ? Object.freeze(Object.fromEntries(this.#createdIds)) : null;
+    }
+    /** Get the map of client-specified creation IDs to server-assigned IDs */
+    get idMap() {
+        const entries = [...this.#idMap];
+        return new Map(entries);
+    }
+    /** Get the reverse map of server-assigned IDs to client-specified creation IDs */
+    get reverseIdMap() {
+        const entries = [...this.#idMap].map(([symbol, id]) => [id, symbol]);
+        return new Map(entries);
+    }
+    /**
+     * Add a method call to the request. All methods must be unique. If the method
+     * already exists in the request, it will not be added again.
+     *
+     * @param method The method call to add to the request
+     * @returns The invocation builder instance to allow for method chaining
+     * @throws Error if the method's capability is not registered with the client
+     * @throws Error if adding this method would exceed the server's maxCallsInRequest limit
+     * @throws AggregateError if the invocation validation fails
+     */
+    add(method) {
+        // Ensure the method's capability is registered with the client
+        if (!this.#client.capabilityRegistry.has(method.uri)) {
+            this.#logger.error(`Cannot add method: Unknown capability '${method.uri}'`);
+            throw new Error(`Unknown capability: ${method.uri}`);
+        }
+        // Check if the method is already in the set
+        if (this.#methods.has(method)) {
+            this.#logger.debug(`Method ${method.name} already exists in request, skipping`);
+            return this;
+        }
+        // Check if adding this method would exceed the server's maxCallsInRequest limit
+        const serverCapabilities = this.#client.serverCapabilities;
+        if (serverCapabilities) {
+            const { maxCallsInRequest } = serverCapabilities[CORE_CAPABILITY_URI];
+            if (this.#methods.size + 1 > maxCallsInRequest) {
+                this.#logger.error(`Cannot add method ${method.name}: Would exceed server limit of ${maxCallsInRequest} method calls (current: ${this.#methods.size})`);
+                throw new Error(`Cannot add method: Request would exceed the server limit of ${maxCallsInRequest} method calls.`);
+            }
+        }
+        this.#logger.debug(`Adding method ${method.name} to request (${this.#methods.size + 1} total methods)`);
+        this.#methods.add(method);
+        return this;
+    }
+    /**
+     * Remove a method call from the request. If the method does not exist in the
+     * request, this method will do nothing.
+     *
+     * @param method The method call to remove from the request
+     * @returns The invocation builder instance to allow for method chaining
+     */
+    remove(method) {
+        if (this.#methods.has(method)) {
+            this.#logger.debug(`Removing method ${method.name} from request`);
+            this.#methods.delete(method);
+        }
+        else {
+            this.#logger.debug(`Method ${method.name} not found in request, nothing to remove`);
+        }
+        return this;
+    }
+    /**
+     * Add the map of client specified creation IDs to server assigned IDs, to be included in the request.
+     *
+     * This may be invoked with an empty object to initialise the createdIds for the first request,
+     * or with a map of client-specified creation IDs to the server-assigned IDs that were obtained from a
+     * previous response.
+     *
+     * @param createdIds The map of client-specified creation IDs to the server assigned IDs
+     * @returns The invocation builder instance to allow for method chaining
+     */
+    addCreatedIds(createdIds) {
+        const entries = Object.entries(createdIds);
+        this.#logger.debug(`Adding ${entries.length} created IDs to request`);
+        this.#createdIds ??= new Map();
+        for (const [key, value] of entries) {
+            this.#createdIds.set(key, value);
+        }
+        return this;
+    }
+    /**
+     * Reset the map of creation ids to remove any that had been previously added.
+     * After invoking this, the createdIds property will will be omitted from the request.
+     */
+    clearCreatedIds() {
+        const previousCount = this.#createdIds?.size ?? 0;
+        if (previousCount > 0) {
+            this.#logger.debug(`Clearing ${previousCount} created IDs from request`);
+        }
+        this.#createdIds = null;
+        return this;
+    }
+    /**
+     * Build the JMAP request object from the current state of the builder.
+     *
+     * This will generate unique IDs for each method call, and resolve any
+     * client-specified creation IDs to server-assigned IDs if they were provided.
+     *
+     * @param idPrefix The prefix to use for generated IDs (default is "id_")
+     * @returns The constructed JMAP request object
+     * @throws AggregateError if the pre-build validation fails
+     */
+    build(idPrefix = ID_PREFIX) {
+        this.#logger.debug(`Building JMAP request with ${this.#methods.size} method calls`);
+        const generateId = idGenerator(idPrefix);
+        // Map invocations to request format with IDs
+        const methodCalls = this.methodCalls.map((invocation) => {
+            const newId = generateId.next().value;
+            this.#idMap.set(invocation.id, newId);
+            return invocation.resolve(newId, (id) => this.#idMap.get(id));
+        });
+        const createdIds = this.#createdIds ? Object.fromEntries(this.#createdIds) : null;
+        // Create initial request object
+        const request = {
+            using: [...this.using],
+            methodCalls,
+            ...(createdIds && {
+                createdIds,
+            }),
+        };
+        this.#logger.debug(`Built JMAP request using capabilities: ${[...this.using].join(", ")}`);
+        return request;
+    }
+    /**
+     * Serialise the request for sending as a request body.
+     * By default, returns a JSON string, but can be extended to support other formats.
+     *
+     * @returns The serialised request (string, Blob, ArrayBuffer, etc.)
+     * @throws AggregateError if the pre-serialization validation fails
+     * @throws AggregateError if the post-serialization validation fails
+     */
+    async serialize() {
+        this.#logger.info(`Serialising JMAP request with ${this.#methods.size} method calls`);
+        // Validate all invocations
+        await this.validateInvocations();
+        // Build the request first
+        const builtRequest = this.build();
+        // Run pre-build validators
+        let { valid, errors = [] } = await this.#validateLifecycleHook("pre-build", builtRequest);
+        if (!valid) {
+            this.#logger.error(`Pre-build validation failed with ${errors.length} errors`);
+            throw new AggregateError(errors, "Pre-build validation failed");
+        }
+        // Apply pre-serialization transformers
+        const transformedRequest = await this.#transformBuild(builtRequest);
+        // Run pre-serialization validators
+        ({ valid, errors = [] } = await this.#validateLifecycleHook("pre-serialization", transformedRequest));
+        if (!valid) {
+            this.#logger.error(`Pre-serialization validation failed with ${errors.length} errors`);
+            throw new AggregateError(errors, `Pre-serialization validation failed`);
+        }
+        // Serialise to JSON
+        const body = JSON.stringify(transformedRequest);
+        const serializedData = {
+            body,
+            headers: new Headers({
+                "Content-Type": "application/json",
+            }),
+        };
+        const transformedSerialization = await this.#transformSerialization(serializedData);
+        // Run post-serialization validators on the serialised string
+        ({ valid, errors = [] } = await this.#validateSerialization(transformedSerialization));
+        if (!valid) {
+            this.#logger.error(`Post-serialization validation failed with ${errors.length} errors`);
+            throw new AggregateError(errors, `Post-serialization validation failed`);
+        }
+        this.#logger.debug(`Successfully serialised JMAP request (${body.length} characters)`);
+        return transformedSerialization;
+    }
+    /**
+     * Send this request to the JMAP server using the associated client.
+     *
+     * @param signal Optional AbortSignal to cancel the request.
+     * @returns The parsed response from the server.
+     */
+    async send(signal) {
+        this.#logger.info(`Sending JMAP request with ${this.#methods.size} method ${this.#methods.size === 1 ? "call" : "calls"}`);
+        return this.#client.sendAPIRequest(this, signal);
+    }
+    toJSON() {
+        return this.build();
+    }
+    /**
+     * Validate all invocations currently in the request.
+     *
+     * @returns A Promise resolving to the invocation builder instance
+     * @throws AggregateError if any invocation validation fails
+     */
+    async validateInvocations() {
+        this.#logger.debug(`Validating ${this.methodCalls.length} invocations`);
+        // Validate all invocations. Aggregate the errors from all of them before throwing
+        const validationErrors = [];
+        for (const invocation of this.methodCalls) {
+            const { valid, errors = [] } = await this.#validateInvocation(invocation);
+            if (!valid) {
+                this.#logger.warn(`Validation failed for ${invocation.name}: ${errors.length} errors`);
+                validationErrors.push(...errors);
+            }
+        }
+        if (validationErrors.length > 0) {
+            this.#logger.error(`Invocation validation failed with ${validationErrors.length} total errors`);
+            throw new AggregateError(validationErrors, `Invocation validation failed`);
+        }
+        this.#logger.debug(`All invocations validated successfully`);
+        return this;
+    }
+    /**
+     * Validates an invocation against registered validators
+     *
+     * @param invocation The invocation to validate
+     */
+    async #validateInvocation(invocation) {
+        // Only run validation if the client is connected (i.e., has serverCapabilities and accounts)
+        const serverCapabilities = this.#client.serverCapabilities;
+        const accounts = this.#client.accounts;
+        if (!serverCapabilities || !accounts)
+            return { valid: true };
+        const registry = this.#client.capabilityRegistry;
+        // Use the unified executeValidators method with the invocation context
+        return registry.executeValidators({
+            hook: "invocation",
+            context: {
+                invocation,
+                serverCapabilities,
+                accounts,
+            },
+        });
+    }
+    /**
+     * Validates a request against registered lifecycle hook validators
+     *
+     * @param hook The lifecycle hook to validate for
+     * @param data The request data to validate
+     */
+    async #validateLifecycleHook(hook, data) {
+        // Only run validation if the client is connected (i.e., has serverCapabilities and accounts)
+        const serverCapabilities = this.#client.serverCapabilities;
+        const accounts = this.#client.accounts;
+        if (!serverCapabilities || !accounts)
+            return { valid: true };
+        const registry = this.#client.capabilityRegistry;
+        const executionContext = {
+            hook,
+            context: {
+                data,
+                serverCapabilities,
+                accounts,
+            },
+        };
+        return registry.executeValidators(executionContext);
+    }
+    /**
+     * Validates serialised request data against registered post-serialization validators
+     *
+     * @param data The serialised data
+     */
+    async #validateSerialization(data) {
+        // Only run validation if the client is connected (i.e., has serverCapabilities and accounts)
+        const serverCapabilities = this.#client.serverCapabilities;
+        const accounts = this.#client.accounts;
+        if (!serverCapabilities || !accounts)
+            return { valid: true };
+        const registry = this.#client.capabilityRegistry;
+        // Use the unified executeValidators method with the post-serialization context
+        return registry.executeValidators({
+            hook: "post-serialization",
+            context: {
+                data,
+                serverCapabilities,
+                accounts,
+            },
+        });
+    }
+    /**
+     * Applies transformation plugins for the pre-serialization hook
+     *
+     * @param hook The lifecycle hook to transform for
+     * @param data The request data to transform
+     */
+    async #transformBuild(data) {
+        const serverCapabilities = this.#client.serverCapabilities;
+        const accounts = this.#client.accounts;
+        if (!serverCapabilities || !accounts)
+            return data;
+        const registry = this.#client.capabilityRegistry;
+        const executionContext = {
+            context: {
+                data,
+                serverCapabilities,
+                accounts,
+            },
+        };
+        return await registry.executeBuildTransformers(executionContext);
+    }
+    /**
+     * Applies transformation plugins for the post-serialization hook
+     *
+     * @param data The serialised data to transform
+     */
+    async #transformSerialization(data) {
+        const serverCapabilities = this.#client.serverCapabilities;
+        const accounts = this.#client.accounts;
+        if (!serverCapabilities || !accounts)
+            return data;
+        const registry = this.#client.capabilityRegistry;
+        const executionContext = {
+            context: {
+                data,
+                serverCapabilities,
+                accounts,
+            },
+        };
+        return await registry.executeSerializationTransformers(executionContext);
+    }
+}
+//# sourceMappingURL=request-builder.js.map

package/dist/src/request-builder/request-builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request-builder.js","sourceRoot":"","sources":["../../../src/request-builder/request-builder.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAKjD,MAAM,SAAS,GAAG,KAAK,CAAC;AAExB,MAAM,OAAO,cAAc;IACd,OAAO,CAAsC;IAE7C,OAAO,CAAS;IACzB,qCAAqC;IAE5B,QAAQ,GAAG,IAAI,GAAG,EAAkC,CAAC;IAC9D,WAAW,GAA+B,IAAI,CAAC;IACtC,MAAM,GAAG,IAAI,GAAG,EAAc,CAAC;IAExC,YAAY,MAA2C,EAAE,EAAE,MAAM,EAAiB;QAC9E,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IAC1B,CAAC;IAED,oGAAoG;IACpG,IAAI,KAAK;QACL,+FAA+F;QAC/F,OAAO,IAAI,GAAG,CAAC,CAAC,mBAAmB,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IACrG,CAAC;IAED,2EAA2E;IAC3E,IAAI,WAAW;QACX,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC7C,CAAC;IAED,mEAAmE;IACnE,IAAI,UAAU;QACV,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,CAAmB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC3G,CAAC;IAED,0EAA0E;IAC1E,IAAI,KAAK;QACL,MAAM,OAAO,GAAG,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;QACjC,OAAO,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC;IAC5B,CAAC;IAED,kFAAkF;IAClF,IAAI,YAAY;QACZ,MAAM,OAAO,GAAG,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,CAAe,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC;QACnF,OAAO,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC;IAC5B,CAAC;IAED;;;;;;;;;OASG;IACH,GAAG,CAAC,MAAsC;QACtC,+DAA+D;QAC/D,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;YACnD,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,0CAA0C,MAAM,CAAC,GAAG,GAAG,CAAC,CAAC;YAC5E,MAAM,IAAI,KAAK,CAAC,uBAAuB,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC;QACzD,CAAC;QAED,4CAA4C;QAC5C,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;YAC5B,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,MAAM,CAAC,IAAI,sCAAsC,CAAC,CAAC;YAChF,OAAO,IAAI,CAAC;QAChB,CAAC;QAED,gFAAgF;QAChF,MAAM,kBAAkB,GAAG,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC;QAC3D,IAAI,kBAAkB,EAAE,CAAC;YACrB,MAAM,EAAE,iBAAiB,EAAE,GAAG,kBAAkB,CAAC,mBAAmB,CAAC,CAAC;YACtE,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,GAAG,CAAC,GAAG,iBAAiB,EAAE,CAAC;gBAC7C,IAAI,CAAC,OAAO,CAAC,KAAK,CACd,qBAAqB,MAAM,CAAC,IAAI,kCAAkC,iBAAiB,2BAA2B,IAAI,CAAC,QAAQ,CAAC,IAAI,GAAG,CACtI,CAAC;gBACF,MAAM,IAAI,KAAK,CACX,+DAA+D,iBAAiB,gBAAgB,CACnG,CAAC;YACN,CAAC;QACL,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,iBAAiB,MAAM,CAAC,IAAI,gBAAgB,IAAI,CAAC,QAAQ,CAAC,IAAI,GAAG,CAAC,iBAAiB,CAAC,CAAC;QAExG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC1B,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,MAAsC;QACzC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;YAC5B,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,mBAAmB,MAAM,CAAC,IAAI,eAAe,CAAC,CAAC;YAClE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACjC,CAAC;aAAM,CAAC;YACJ,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,MAAM,CAAC,IAAI,0CAA0C,CAAC,CAAC;QACxF,CAAC;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;;;;;OASG;IACH,aAAa,CAAC,UAAiB;QAC3B,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QAC3C,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,OAAO,CAAC,MAAM,yBAAyB,CAAC,CAAC;QAEtE,IAAI,CAAC,WAAW,KAAK,IAAI,GAAG,EAAE,CAAC;QAE/B,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,OAAO,EAAE,CAAC;YACjC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACrC,CAAC;QAED,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;OAGG;IACH,eAAe;QACX,MAAM,aAAa,GAAG,IAAI,CAAC,WAAW,EAAE,IAAI,IAAI,CAAC,CAAC;QAClD,IAAI,aAAa,GAAG,CAAC,EAAE,CAAC;YACpB,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,YAAY,aAAa,2BAA2B,CAAC,CAAC;QAC7E,CAAC;QACD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QACxB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,QAAQ,GAAG,SAAS;QACtB,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,8BAA8B,IAAI,CAAC,QAAQ,CAAC,IAAI,eAAe,CAAC,CAAC;QAEpF,MAAM,UAAU,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC;QAEzC,6CAA6C;QAC7C,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAwB,CAAC,UAAU,EAAE,EAAE;YAC3E,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC;YACtC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;YACtC,OAAO,UAAU,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;QAClE,CAAC,CAAC,CAAC;QAEH,MAAM,UAAU,GAAiB,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAEhG,gCAAgC;QAChC,MAAM,OAAO,GAAgB;YACzB,KAAK,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC;YACtB,WAAW;YACX,GAAG,CAAC,UAAU,IAAI;gBACd,UAAU;aACb,CAAC;SACL,CAAC;QAEF,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,0CAA0C,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC3F,OAAO,OAAO,CAAC;IACnB,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,SAAS;QACX,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iCAAiC,IAAI,CAAC,QAAQ,CAAC,IAAI,eAAe,CAAC,CAAC;QAEtF,2BAA2B;QAC3B,MAAM,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAEjC,0BAA0B;QAC1B,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC;QAElC,2BAA2B;QAC3B,IAAI,EAAE,KAAK,EAAE,MAAM,GAAG,EAAE,EAAE,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;QAE1F,IAAI,CAAC,KAAK,EAAE,CAAC;YACT,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,oCAAoC,MAAM,CAAC,MAAM,SAAS,CAAC,CAAC;YAC/E,MAAM,IAAI,cAAc,CAAC,MAAM,EAAE,6BAA6B,CAAC,CAAC;QACpE,CAAC;QAED,uCAAuC;QACvC,MAAM,kBAAkB,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;QAEpE,mCAAmC;QACnC,CAAC,EAAE,KAAK,EAAE,MAAM,GAAG,EAAE,EAAE,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,mBAAmB,EAAE,kBAAkB,CAAC,CAAC,CAAC;QAEtG,IAAI,CAAC,KAAK,EAAE,CAAC;YACT,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,4CAA4C,MAAM,CAAC,MAAM,SAAS,CAAC,CAAC;YACvF,MAAM,IAAI,cAAc,CAAC,MAAM,EAAE,qCAAqC,CAAC,CAAC;QAC5E,CAAC;QAED,oBAAoB;QACpB,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC;QAEhD,MAAM,cAAc,GAAqC;YACrD,IAAI;YACJ,OAAO,EAAE,IAAI,OAAO,CAAC;gBACjB,cAAc,EAAE,kBAAkB;aACrC,CAAC;SACL,CAAC;QAEF,MAAM,wBAAwB,GAAG,MAAM,IAAI,CAAC,uBAAuB,CAAC,cAAc,CAAC,CAAC;QAEpF,6DAA6D;QAC7D,CAAC,EAAE,KAAK,EAAE,MAAM,GAAG,EAAE,EAAE,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,wBAAwB,CAAC,CAAC,CAAC;QAEvF,IAAI,CAAC,KAAK,EAAE,CAAC;YACT,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,6CAA6C,MAAM,CAAC,MAAM,SAAS,CAAC,CAAC;YACxF,MAAM,IAAI,cAAc,CAAC,MAAM,EAAE,sCAAsC,CAAC,CAAC;QAC7E,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,yCAAyC,IAAI,CAAC,MAAM,cAAc,CAAC,CAAC;QACvF,OAAO,wBAAwB,CAAC;IACpC,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CAAC,MAAoB;QAC3B,IAAI,CAAC,OAAO,CAAC,IAAI,CACb,6BAA6B,IAAI,CAAC,QAAQ,CAAC,IAAI,WAAW,IAAI,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,CAC1G,CAAC;QACF,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACrD,CAAC;IAED,MAAM;QACF,OAAO,IAAI,CAAC,KAAK,EAAE,CAAC;IACxB,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,mBAAmB;QACrB,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,cAAc,IAAI,CAAC,WAAW,CAAC,MAAM,cAAc,CAAC,CAAC;QAExE,kFAAkF;QAClF,MAAM,gBAAgB,GAAY,EAAE,CAAC;QACrC,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACxC,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,EAAE,EAAE,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;YAC1E,IAAI,CAAC,KAAK,EAAE,CAAC;gBACT,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,UAAU,CAAC,IAAI,KAAK,MAAM,CAAC,MAAM,SAAS,CAAC,CAAC;gBACvF,gBAAgB,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC;YACrC,CAAC;QACL,CAAC;QAED,IAAI,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC9B,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,qCAAqC,gBAAgB,CAAC,MAAM,eAAe,CAAC,CAAC;YAChG,MAAM,IAAI,cAAc,CAAC,gBAAgB,EAAE,8BAA8B,CAAC,CAAC;QAC/E,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,wCAAwC,CAAC,CAAC;QAC7D,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,mBAAmB,CAAC,UAA0C;QAChE,6FAA6F;QAC7F,MAAM,kBAAkB,GAAG,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC;QAC3D,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;QACvC,IAAI,CAAC,kBAAkB,IAAI,CAAC,QAAQ;YAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;QAE7D,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC;QAEjD,uEAAuE;QACvE,OAAO,QAAQ,CAAC,iBAAiB,CAAC;YAC9B,IAAI,EAAE,YAAY;YAClB,OAAO,EAAE;gBACL,UAAU;gBACV,kBAAkB;gBAClB,QAAQ;aACX;SACJ,CAAC,CAAC;IACP,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,sBAAsB,CACxB,IAAW,EACX,IAAuB;QAEvB,6FAA6F;QAC7F,MAAM,kBAAkB,GAAG,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC;QAC3D,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;QACvC,IAAI,CAAC,kBAAkB,IAAI,CAAC,QAAQ;YAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;QAE7D,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC;QAEjD,MAAM,gBAAgB,GAAiE;YACnF,IAAI;YACJ,OAAO,EAAE;gBACL,IAAI;gBACJ,kBAAkB;gBAClB,QAAQ;aACX;SACJ,CAAC;QAEF,OAAO,QAAQ,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,CAAC;IACxD,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,sBAAsB,CAAC,IAAsC;QAC/D,6FAA6F;QAC7F,MAAM,kBAAkB,GAAG,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC;QAC3D,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;QACvC,IAAI,CAAC,kBAAkB,IAAI,CAAC,QAAQ;YAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;QAE7D,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC;QAEjD,+EAA+E;QAC/E,OAAO,QAAQ,CAAC,iBAAiB,CAAC;YAC9B,IAAI,EAAE,oBAAoB;YAC1B,OAAO,EAAE;gBACL,IAAI;gBACJ,kBAAkB;gBAClB,QAAQ;aACX;SACJ,CAAC,CAAC;IACP,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,eAAe,CAAC,IAAqC;QACvD,MAAM,kBAAkB,GAAG,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC;QAC3D,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;QACvC,IAAI,CAAC,kBAAkB,IAAI,CAAC,QAAQ;YAAE,OAAO,IAAI,CAAC;QAElD,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC;QAEjD,MAAM,gBAAgB,GAAqD;YACvE,OAAO,EAAE;gBACL,IAAI;gBACJ,kBAAkB;gBAClB,QAAQ;aACX;SACJ,CAAC;QAEF,OAAO,MAAM,QAAQ,CAAC,wBAAwB,CAAC,gBAAgB,CAAC,CAAC;IACrE,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,uBAAuB,CAAC,IAAsC;QAChE,MAAM,kBAAkB,GAAG,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC;QAC3D,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;QACvC,IAAI,CAAC,kBAAkB,IAAI,CAAC,QAAQ;YAAE,OAAO,IAAI,CAAC;QAElD,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC;QAEjD,MAAM,gBAAgB,GAAsD;YACxE,OAAO,EAAE;gBACL,IAAI;gBACJ,kBAAkB;gBAClB,QAAQ;aACX;SACJ,CAAC;QAEF,OAAO,MAAM,QAAQ,CAAC,gCAAgC,CAAC,gBAAgB,CAAC,CAAC;IAC7E,CAAC;CACJ"}

package/dist/src/request-builder/types.d.ts

@@ -0,0 +1,32 @@
+/**
+ * A utility type that makes all properties of T optional recursively
+ *
+ * @template T - The type to make partially optional
+ * @template Depth - Maximum recursion depth (default: 5)
+ * @returns A new type where all properties of T are optional, recursively down to the specified
+ *          depth for nested objects
+ */
+export type DeepPartial<T, Depth extends number = 5> = [Depth] extends [0] ? T : T extends object ? {
+    [P in keyof T]?: T[P] extends (infer U)[] ? DeepPartial<U, Decrement<Depth>>[] : Extract<T[P], object> extends object ? DeepPartial<T[P], Decrement<Depth>> : T[P];
+} : T;
+/**
+ * Utility type to build a tuple of length L
+ * @template L - The desired length of the tuple. The length must be >= 0.
+ *               TypeScript limits tuples to a maximum length of 999.
+ * @template T - The type of each element in the tuple (default: unknown)
+ * @returns A tuple of length L with elements of type T, or never if L is negative.
+ */
+export type BuildTuple<L extends number, T extends unknown[] = []> = T["length"] extends L ? T : IsNegative<L> extends true ? never : BuildTuple<L, [unknown, ...T]>;
+/**
+ * Utility type to check if a number is negative
+ * @template N - The number to check
+ * @returns true if N is negative, false otherwise
+ */
+export type IsNegative<N extends number> = `${N}` extends `-${string}` ? true : false;
+/**
+ * Utility type to decrement a number by 1
+ * @template N - The positive number to decrement. If N is 0, it returns never.
+ *               If N is a negative number, it returns never.
+ * @returns The decremented number, or never if N is negative or 0.
+ */
+export type Decrement<N extends number> = IsNegative<N> extends true ? never : BuildTuple<N> extends [infer _, ...infer Rest] ? Rest["length"] : never;

package/dist/src/request-builder/types.js

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

package/dist/src/request-builder/types.js.map

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

package/package.json

@@ -1,8 +1,9 @@
 {
     "name": "jmap-kit",
-    "version": "0.0.0",
-    "description": "A comprehensive, type-safe JMAP SDK for building JMAP-based client applications",
+    "version": "1.0.2",
+    "packageManager": "yarn@4.13.0",
     "author": "Lachlan Hunt <lachlan.hunt@lachy.id.au> (https://lachy.id.au)",
+    "description": "A comprehensive, type-safe JMAP SDK for building JMAP-based client applications",
     "license": "MIT",
     "repository": {
         "type": "git",
@@ -19,5 +20,70 @@
         "rfc8621",
         "typescript",
         "client"
-    ]
+    ],
+    "scripts": {
+        "format:check": "prettier --check .",
+        "lint": "eslint .",
+        "test": "vitest",
+        "test:coverage": "vitest run --coverage",
+        "typecheck": "tsc --noEmit",
+        "build": "tsc --project tsconfig.build.json",
+        "bundle": "rollup -c",
+        "bundle:standalone": "rollup -c rollup.config.standalone.js",
+        "bundle:analyse": "NODE_ENV=production rollup -c",
+        "size-check": "yarn bundle && ls -lh dist/jmap-kit.bundle.js",
+        "docs": "typedoc"
+    },
+    "type": "module",
+    "exports": {
+        ".": {
+            "types": "./dist/src/index.d.ts",
+            "default": "./dist/src/index.js"
+        }
+    },
+    "sideEffects": false,
+    "main": "./dist/src/index.js",
+    "types": "./dist/src/index.d.ts",
+    "files": [
+        "dist/src/**",
+        "!dist/src/**/*.test.*",
+        "!dist/src/**/*.typestest.*",
+        "!dist/src/**/test-utils.*"
+    ],
+    "dependencies": {
+        "@standard-schema/spec": "^1.1.0",
+        "p-limit": "^7.3.0",
+        "url-template": "^3.1.1",
+        "zod": "^4.3.6"
+    },
+    "devDependencies": {
+        "@eslint/js": "^9.39.3",
+        "@rollup/plugin-node-resolve": "^16.0.3",
+        "@rollup/plugin-terser": "^0.4.4",
+        "@rollup/plugin-typescript": "^12.3.0",
+        "@types/node": "^24.10.13",
+        "@vitest/coverage-v8": "^4.0.18",
+        "@vitest/runner": "^4.0.18",
+        "@vitest/snapshot": "^4.0.18",
+        "dotenv": "^17.3.1",
+        "eslint": "^9.39.3",
+        "eslint-config-prettier": "^10.1.8",
+        "eslint-import-resolver-typescript": "^4.4.4",
+        "eslint-plugin-import": "^2.32.0",
+        "globals": "^16.5.0",
+        "husky": "^9.1.7",
+        "lint-staged": "^16.2.7",
+        "prettier": "3.8.1",
+        "rollup": "^4.59.0",
+        "rollup-plugin-visualizer": "^7.0.0",
+        "tsx": "^4.21.0",
+        "typedoc": "^0.28.15",
+        "typescript": "^5.9.3",
+        "typescript-eslint": "^8.56.1",
+        "vitest": "^4.0.18"
+    },
+    "lint-staged": {
+        "*.{ts,tsx,js,mjs}": "eslint --fix",
+        "**/*": "prettier --write --ignore-unknown"
+    }
 }