jmap-kit 0.0.0 → 1.0.2

package/dist/src/capabilities/blob-capability.d.ts

@@ -0,0 +1,195 @@
+import { z } from "zod/v4";
+import type { ValidationPlugin } from "../capability-registry/types.js";
+import { BLOB_CAPABILITY_URI } from "../common/registry.js";
+import type { BlobCopyRequestInvocationArgs, BlobUploadRequestInvocationArgs, HTTPDigestAlgorithm } from "./blob/types.js";
+/**
+ * Validates that invocations using the Blob capability have a valid accountId that supports the Blob capability.
+ *
+ * This plugin performs three critical validation checks:
+ * 1. Verifies the invocation includes a valid `accountId` argument (non-empty string)
+ * 2. Confirms the account exists in the session's accounts collection
+ * 3. Ensures the account's `accountCapabilities` includes the Blob capability URI
+ *
+ * This validation applies to all Blob capability invocations (`Blob/upload`, `Blob/get`, `Blob/lookup`)
+ * and implements the account capability checks for the Blob Management Extension (RFC 9404).
+ *
+ * Note: `Blob/copy` is part of the Core capability and is validated separately in core-capability.ts.
+ *
+ * @see {@link https://www.rfc-editor.org/rfc/rfc9404.html | RFC 9404: JMAP Blob Management Extension}
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8620.html#section-1.6.2 | RFC 8620 Section 1.6.2: Accounts}
+ */
+export declare const blobAccountSupportPlugin: ValidationPlugin<"invocation">;
+/**
+ * Validates server-defined constraints for Blob/copy operations.
+ *
+ * This plugin enforces the requirement that Blob/copy operations must copy between
+ * different accounts. Attempting to copy blobs within the same account is invalid and would
+ * be rejected by the server.
+ *
+ * **Same-Account Copy Prevention (RFC 8620 Section 6.3):**
+ * - Validates that `fromAccountId` and `accountId` are different
+ * - `Blob/copy` is designed for cross-account blob sharing
+ * - Blobs within the same account are already accessible without copying
+ * - Prevents unnecessary server operations and resource usage
+ *
+ * This validation catches the error client-side before making a server request, providing
+ * immediate feedback and avoiding unnecessary network round-trips.
+ *
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8620.html#section-6.3 | RFC 8620 Section 6.3: Blob/copy}
+ */
+export declare const blobCopyValidationPlugin: ValidationPlugin<"invocation", BlobCopyRequestInvocationArgs>;
+/**
+ * Validates server-defined constraints for `Blob/upload` operations.
+ *
+ * This plugin enforces account-specific blob creation limits defined in the Blob capability:
+ *
+ * **Blob Size Limit (RFC 9404 Section 4.1):**
+ * - Validates that the total blob size does not exceed `maxSizeBlobSet` octets
+ * - The limit is server-defined and specified in the account's Blob capability object
+ * - If `maxSizeBlobSet` is null, no client-side size limit is enforced
+ * - Calculates size from all DataSourceObjects (literal data and referenced blobs)
+ * - Note: For referenced blobs, size validation requires the client to know the blob sizes
+ *
+ * **Data Source Count Limit (RFC 9404 Section 4.1):**
+ * - Validates that the number of DataSourceObjects does not exceed `maxDataSources`
+ * - Servers MUST support at least 64 DataSourceObjects per creation
+ * - This limit prevents excessive resource usage during blob concatenation
+ *
+ * These validations catch client errors before sending requests to the server, providing
+ * immediate feedback and avoiding unnecessary network round-trips. Note that servers may
+ * still reject uploads for other reasons (disk space, rate limits, etc.).
+ *
+ * @see {@link https://www.rfc-editor.org/rfc/rfc9404.html#section-4.1 | RFC 9404 Section 4.1: Blob/upload}
+ * @see {@link https://www.rfc-editor.org/rfc/rfc9404.html#section-2 | RFC 9404 Section 2: Addition to the Capabilities Object}
+ */
+export declare const blobUploadValidationPlugin: ValidationPlugin<"invocation", BlobUploadRequestInvocationArgs>;
+/**
+ * Prevents Blob/upload operations on read-only accounts.
+ *
+ * **Read-Only Account Protection for Blob/upload:**
+ * - Validates that the target account's `isReadOnly` property is `false`
+ * - Blob/upload creates new blobs in the account, requiring write access
+ * - Attempting to upload to a read-only account would fail with an `accountReadOnly` error
+ *
+ * This validator catches the error client-side before making a server request, providing
+ * immediate feedback when attempting to upload blobs to read-only accounts.
+ *
+ * **Common read-only scenarios:**
+ * - Shared accounts with read-only permissions
+ * - Archive or backup accounts
+ * - Accounts in maintenance mode
+ *
+ * @see {@link https://www.rfc-editor.org/rfc/rfc9404.html#section-4.1 | RFC 9404 Section 4.1: Blob/upload}
+ */
+export declare const preventBlobUploadOnReadOnlyAccountPlugin: ValidationPlugin<"invocation", BlobUploadRequestInvocationArgs>;
+/**
+ * Defines the Blob capability, including Blob invocations (except Blob/copy which is in Core)
+ * and validation plugins for the Blob Management Extension.
+ */
+export declare const BlobCapability: {
+    uri: "urn:ietf:params:jmap:blob";
+    invocations: {
+        Blob: {
+            request: {
+                upload: import("../index.js").InvocationFactory<BlobUploadRequestInvocationArgs, import("./blob/blob.js").BlobInvocation<BlobUploadRequestInvocationArgs>>;
+                get: import("../index.js").InvocationFactory<import("./blob/types.js").BlobGetRequestInvocationArgs, import("./blob/blob.js").BlobInvocation<import("./blob/types.js").BlobGetRequestInvocationArgs>>;
+                lookup: import("../index.js").InvocationFactory<import("./blob/types.js").BlobLookupRequestInvocationArgs, import("./blob/blob.js").BlobInvocation<import("./blob/types.js").BlobLookupRequestInvocationArgs>>;
+            };
+            response: {
+                upload: import("../index.js").InvocationFactory<import("./blob/types.js").BlobUploadResponseInvocationArgs, import("./blob/blob.js").BlobInvocation<import("./blob/types.js").BlobUploadResponseInvocationArgs>>;
+                get: import("../index.js").InvocationFactory<import("./blob/types.js").BlobGetResponseInvocationArgs, import("./blob/blob.js").BlobInvocation<import("./blob/types.js").BlobGetResponseInvocationArgs>>;
+                lookup: import("../index.js").InvocationFactory<import("./blob/types.js").BlobLookupResponseInvocationArgs, import("./blob/blob.js").BlobInvocation<import("./blob/types.js").BlobLookupResponseInvocationArgs>>;
+            };
+        };
+    };
+    validators: ({
+        name: string;
+        hook: "invocation";
+        trigger: {
+            capabilityUri?: import("../index.js").JMAPCapability;
+            dataType?: import("../index.js").JMAPDataType;
+            method?: import("../index.js").JMAPMethodName;
+        };
+        validate(this: void, context: import("../capability-registry/types.js").BasePluginContext & {
+            invocation: import("../index.js").Invocation<BlobCopyRequestInvocationArgs>;
+        }): import("../index.js").MaybePromise<import("../capability-registry/types.js").ValidationResult>;
+    } | {
+        name: string;
+        hook: "invocation";
+        trigger: {
+            capabilityUri?: import("../index.js").JMAPCapability;
+            dataType?: import("../index.js").JMAPDataType;
+            method?: import("../index.js").JMAPMethodName;
+        };
+        validate(this: void, context: import("../capability-registry/types.js").BasePluginContext & {
+            invocation: import("../index.js").Invocation<import("../index.js").BaseInvocationArgs>;
+        }): import("../index.js").MaybePromise<import("../capability-registry/types.js").ValidationResult>;
+    } | {
+        name: string;
+        hook: "invocation";
+        trigger: {
+            capabilityUri?: import("../index.js").JMAPCapability;
+            dataType?: import("../index.js").JMAPDataType;
+            method?: import("../index.js").JMAPMethodName;
+        };
+        validate(this: void, context: import("../capability-registry/types.js").BasePluginContext & {
+            invocation: import("../index.js").Invocation<BlobUploadRequestInvocationArgs>;
+        }): import("../index.js").MaybePromise<import("../capability-registry/types.js").ValidationResult>;
+    })[];
+    schema: {
+        accountCapability: z.ZodObject<{
+            maxSizeBlobSet: z.ZodNullable<z.ZodNumber>;
+            maxDataSources: z.ZodNumber;
+            supportedTypeNames: z.ZodArray<z.ZodString>;
+            supportedDigestAlgorithms: z.ZodArray<z.ZodEnum<{
+                adler32: "adler32";
+                crc32c: "crc32c";
+                md5: "md5";
+                sha: "sha";
+                "sha-256": "sha-256";
+                "sha-512": "sha-512";
+                unixsum: "unixsum";
+                unixcksum: "unixcksum";
+            }>>;
+        }, z.core.$loose>;
+    };
+};
+declare module "../common/types.js" {
+    interface ServerCapabilityRegistry {
+        [BLOB_CAPABILITY_URI]?: EmptyObject;
+    }
+    interface AccountCapabilityRegistry {
+        [BLOB_CAPABILITY_URI]?: {
+            /**
+             * The maximum size of the blob (in octets) that the server will allow to be created
+             * (including blobs created by concatenating multiple data sources together).Clients
+             * MUST NOT attempt to create blobs larger than this size.If this value is null, then
+             * clients are not required to limit the size of the blob they try to create, though
+             * servers can always reject creation of blobs regardless of size, e.g., due to lack
+             * of disk space or per-user rate limits.
+             */
+            maxSizeBlobSet: UnsignedInt | null;
+            /**
+             * The maximum number of DataSourceObjects allowed per creation in a Blob/upload.
+             * Servers MUST allow at least 64 DataSourceObjects per creation.
+             */
+            maxDataSources: UnsignedInt;
+            /**
+             * An array of data type names that are supported for Blob/lookup. If the server does not
+             * support lookups, then this will be the empty list. Note that the supportedTypeNames list
+             * may include private types that are not in the "JMAP Data Types" registry defined by this
+             * document. Clients MUST ignore type names they do not recognise.
+             */
+            supportedTypeNames: JMAPDataType[];
+            /**
+             * An array of supported digest algorithms that are supported for Blob/get. If the server
+             * does not support calculating blob digests, then this will be the empty list. Algorithms
+             * in this list MUST be present in the "HTTP Digest Algorithm Values" registry defined by
+             * {@link https://www.rfc-editor.org/rfc/rfc3230.html RFC 3230}; however, in JMAP, they must be
+             * lowercased, e.g., "md5" rather than "MD5".Clients SHOULD prefer algorithms listed earlier
+             * in this list.
+             */
+            supportedDigestAlgorithms: HTTPDigestAlgorithm[];
+        };
+    }
+}

package/dist/src/capabilities/blob-capability.js

@@ -0,0 +1,277 @@
+import { z } from "zod/v4";
+import { BLOB_CAPABILITY_URI } from "../common/registry.js";
+import { Blob } from "./blob/blob.js";
+import { HTTPDigestAlgorithmSchema } from "./blob/types.js";
+import { assertInvocation } from "./utils/assert-invocation.js";
+import { createReadOnlyAccountValidator } from "./utils/create-readonly-account-validator.js";
+/**
+ * Validates that invocations using the Blob capability have a valid accountId that supports the Blob capability.
+ *
+ * This plugin performs three critical validation checks:
+ * 1. Verifies the invocation includes a valid `accountId` argument (non-empty string)
+ * 2. Confirms the account exists in the session's accounts collection
+ * 3. Ensures the account's `accountCapabilities` includes the Blob capability URI
+ *
+ * This validation applies to all Blob capability invocations (`Blob/upload`, `Blob/get`, `Blob/lookup`)
+ * and implements the account capability checks for the Blob Management Extension (RFC 9404).
+ *
+ * Note: `Blob/copy` is part of the Core capability and is validated separately in core-capability.ts.
+ *
+ * @see {@link https://www.rfc-editor.org/rfc/rfc9404.html | RFC 9404: JMAP Blob Management Extension}
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8620.html#section-1.6.2 | RFC 8620 Section 1.6.2: Accounts}
+ */
+export const blobAccountSupportPlugin = {
+    name: "blob-account-support",
+    hook: "invocation",
+    trigger: {
+        capabilityUri: BLOB_CAPABILITY_URI,
+    },
+    validate(context) {
+        const { invocation, accounts } = context;
+        const accountId = invocation.getArgument("accountId");
+        if (typeof accountId !== "string" || accountId === "") {
+            return {
+                valid: false,
+                errors: [new Error(`Invocation is missing a valid accountId argument.`)],
+            };
+        }
+        const account = accounts[accountId];
+        if (!account) {
+            return {
+                valid: false,
+                errors: [new Error(`Account "${accountId}" does not exist.`)],
+            };
+        }
+        if (!account.accountCapabilities[BLOB_CAPABILITY_URI]) {
+            return {
+                valid: false,
+                errors: [new Error(`Account "${accountId}" does not support the Blob capability.`)],
+            };
+        }
+        return { valid: true };
+    },
+};
+/**
+ * Validates server-defined constraints for Blob/copy operations.
+ *
+ * This plugin enforces the requirement that Blob/copy operations must copy between
+ * different accounts. Attempting to copy blobs within the same account is invalid and would
+ * be rejected by the server.
+ *
+ * **Same-Account Copy Prevention (RFC 8620 Section 6.3):**
+ * - Validates that `fromAccountId` and `accountId` are different
+ * - `Blob/copy` is designed for cross-account blob sharing
+ * - Blobs within the same account are already accessible without copying
+ * - Prevents unnecessary server operations and resource usage
+ *
+ * This validation catches the error client-side before making a server request, providing
+ * immediate feedback and avoiding unnecessary network round-trips.
+ *
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8620.html#section-6.3 | RFC 8620 Section 6.3: Blob/copy}
+ */
+export const blobCopyValidationPlugin = {
+    name: "blob-copy-validation",
+    hook: "invocation",
+    trigger: {
+        dataType: "Blob",
+        method: "copy",
+    },
+    validate(context) {
+        const { invocation, accounts } = context;
+        assertInvocation(invocation, "Blob", "copy");
+        const accountId = invocation.getArgument("accountId");
+        const fromAccountId = invocation.getArgument("fromAccountId");
+        if (accountId === fromAccountId) {
+            return {
+                valid: false,
+                errors: [new Error(`Cannot copy blobs to the same account. fromAccountId and accountId must differ.`)],
+            };
+        }
+        // Validate both accounts exist
+        const errors = [];
+        if (!accounts[accountId]) {
+            errors.push(new Error(`Account "${accountId}" does not exist.`));
+        }
+        if (!accounts[fromAccountId]) {
+            errors.push(new Error(`Account "${fromAccountId}" does not exist.`));
+        }
+        if (errors.length > 0) {
+            return { valid: false, errors };
+        }
+        return { valid: true };
+    },
+};
+/**
+ * Calculates the total size in octets for an array of DataSourceObjects.
+ * Returns null if the size cannot be calculated (e.g., when referencing external blobs).
+ */
+function calculateDataSourceSize(data) {
+    let totalSize = 0;
+    for (const source of data) {
+        if ("data:asText" in source && source["data:asText"] !== null) {
+            // UTF-8 encoded text
+            totalSize += new TextEncoder().encode(source["data:asText"]).length;
+        }
+        else if ("data:asBase64" in source && source["data:asBase64"] !== null) {
+            // Base64 encoded data (decode to get actual size)
+            const base64 = source["data:asBase64"];
+            // Each base64 group of 4 chars represents 3 bytes
+            // Remove padding characters to calculate accurate size
+            const paddingChars = (base64.match(/=/g) ?? []).length;
+            totalSize += (base64.length * 3) / 4 - paddingChars;
+        }
+        else /* ("blobId" in source) */ {
+            // Referenced blob - we can't validate size without knowing the blob size
+            // Server will validate this
+            return null;
+        }
+    }
+    return totalSize;
+}
+/**
+ * Validates a single blob upload against account limits.
+ */
+function validateBlobUpload(creationId, uploadObject, maxDataSources, maxSizeBlobSet) {
+    const errors = [];
+    const data = uploadObject.data;
+    if (!Array.isArray(data)) {
+        return errors;
+    }
+    // Check data source count
+    if (data.length > maxDataSources) {
+        errors.push(new Error(`Blob "${creationId}" has ${data.length} data sources, but account limit is ${maxDataSources}`));
+    }
+    // Check blob size if maxSizeBlobSet is set
+    if (maxSizeBlobSet !== null) {
+        const totalSize = calculateDataSourceSize(data);
+        if (totalSize !== null && totalSize > maxSizeBlobSet) {
+            const sizeInKB = (totalSize / 1000).toFixed(2);
+            const maxSizeInKB = (maxSizeBlobSet / 1000).toFixed(2);
+            errors.push(new Error(`Blob "${creationId}" size (${sizeInKB} KB) exceeds account limit of ${maxSizeInKB} KB`));
+        }
+    }
+    return errors;
+}
+/**
+ * Validates server-defined constraints for `Blob/upload` operations.
+ *
+ * This plugin enforces account-specific blob creation limits defined in the Blob capability:
+ *
+ * **Blob Size Limit (RFC 9404 Section 4.1):**
+ * - Validates that the total blob size does not exceed `maxSizeBlobSet` octets
+ * - The limit is server-defined and specified in the account's Blob capability object
+ * - If `maxSizeBlobSet` is null, no client-side size limit is enforced
+ * - Calculates size from all DataSourceObjects (literal data and referenced blobs)
+ * - Note: For referenced blobs, size validation requires the client to know the blob sizes
+ *
+ * **Data Source Count Limit (RFC 9404 Section 4.1):**
+ * - Validates that the number of DataSourceObjects does not exceed `maxDataSources`
+ * - Servers MUST support at least 64 DataSourceObjects per creation
+ * - This limit prevents excessive resource usage during blob concatenation
+ *
+ * These validations catch client errors before sending requests to the server, providing
+ * immediate feedback and avoiding unnecessary network round-trips. Note that servers may
+ * still reject uploads for other reasons (disk space, rate limits, etc.).
+ *
+ * @see {@link https://www.rfc-editor.org/rfc/rfc9404.html#section-4.1 | RFC 9404 Section 4.1: Blob/upload}
+ * @see {@link https://www.rfc-editor.org/rfc/rfc9404.html#section-2 | RFC 9404 Section 2: Addition to the Capabilities Object}
+ */
+export const blobUploadValidationPlugin = {
+    name: "blob-upload-validation",
+    hook: "invocation",
+    trigger: {
+        dataType: "Blob",
+        method: "upload",
+    },
+    validate(context) {
+        const { invocation, accounts } = context;
+        assertInvocation(invocation, "Blob", "upload");
+        const accountId = invocation.getArgument("accountId");
+        const account = accounts[accountId];
+        if (!account) {
+            return {
+                valid: false,
+                errors: [new Error(`Account "${accountId}" does not exist.`)],
+            };
+        }
+        const blobCapability = account.accountCapabilities[BLOB_CAPABILITY_URI];
+        if (!blobCapability) {
+            return {
+                valid: false,
+                errors: [new Error(`Account "${accountId}" does not support the Blob capability.`)],
+            };
+        }
+        const create = invocation.getArgument("create");
+        const errors = [];
+        const { maxSizeBlobSet, maxDataSources } = blobCapability;
+        // Validate each blob creation
+        for (const [creationId, uploadObject] of Object.entries(create)) {
+            const blobErrors = validateBlobUpload(creationId, uploadObject, maxDataSources, maxSizeBlobSet);
+            errors.push(...blobErrors);
+        }
+        if (errors.length > 0) {
+            return { valid: false, errors };
+        }
+        return { valid: true };
+    },
+};
+/**
+ * Prevents Blob/upload operations on read-only accounts.
+ *
+ * **Read-Only Account Protection for Blob/upload:**
+ * - Validates that the target account's `isReadOnly` property is `false`
+ * - Blob/upload creates new blobs in the account, requiring write access
+ * - Attempting to upload to a read-only account would fail with an `accountReadOnly` error
+ *
+ * This validator catches the error client-side before making a server request, providing
+ * immediate feedback when attempting to upload blobs to read-only accounts.
+ *
+ * **Common read-only scenarios:**
+ * - Shared accounts with read-only permissions
+ * - Archive or backup accounts
+ * - Accounts in maintenance mode
+ *
+ * @see {@link https://www.rfc-editor.org/rfc/rfc9404.html#section-4.1 | RFC 9404 Section 4.1: Blob/upload}
+ */
+export const preventBlobUploadOnReadOnlyAccountPlugin = createReadOnlyAccountValidator({
+    name: "blob-prevent-upload-on-readonly-account",
+    trigger: {
+        dataType: "Blob",
+        method: "upload",
+    },
+});
+const blobAccountCapabilitySchema = z.looseObject({
+    maxSizeBlobSet: z.number().int().min(0).nullable(),
+    maxDataSources: z.number().int().min(1),
+    supportedTypeNames: z.array(z.string()),
+    supportedDigestAlgorithms: z.array(HTTPDigestAlgorithmSchema),
+});
+/**
+ * Defines the Blob capability, including Blob invocations (except Blob/copy which is in Core)
+ * and validation plugins for the Blob Management Extension.
+ */
+export const BlobCapability = {
+    uri: BLOB_CAPABILITY_URI,
+    invocations: {
+        Blob: {
+            request: {
+                upload: Blob.request.upload,
+                get: Blob.request.get,
+                lookup: Blob.request.lookup,
+            },
+            response: {
+                upload: Blob.response.upload,
+                get: Blob.response.get,
+                lookup: Blob.response.lookup,
+            },
+        },
+    },
+    validators: [
+        blobAccountSupportPlugin,
+        blobCopyValidationPlugin,
+        blobUploadValidationPlugin,
+        preventBlobUploadOnReadOnlyAccountPlugin,
+    ],
+    schema: { accountCapability: blobAccountCapabilitySchema },
+};
+//# sourceMappingURL=blob-capability.js.map

package/dist/src/capabilities/blob-capability.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"blob-capability.js","sourceRoot":"","sources":["../../../src/capabilities/blob-capability.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAC;AAE3B,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAOtC,OAAO,EAAE,yBAAyB,EAAE,MAAM,iBAAiB,CAAC;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAE,8BAA8B,EAAE,MAAM,8CAA8C,CAAC;AAE9F;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAmC;IACpE,IAAI,EAAE,sBAAsB;IAC5B,IAAI,EAAE,YAAY;IAClB,OAAO,EAAE;QACL,aAAa,EAAE,mBAAmB;KACrC;IACD,QAAQ,CAAC,OAAO;QACZ,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC;QACzC,MAAM,SAAS,GAAG,UAAU,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;QACtD,IAAI,OAAO,SAAS,KAAK,QAAQ,IAAI,SAAS,KAAK,EAAE,EAAE,CAAC;YACpD,OAAO;gBACH,KAAK,EAAE,KAAK;gBACZ,MAAM,EAAE,CAAC,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;aAC3E,CAAC;QACN,CAAC;QACD,MAAM,OAAO,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC;QACpC,IAAI,CAAC,OAAO,EAAE,CAAC;YACX,OAAO;gBACH,KAAK,EAAE,KAAK;gBACZ,MAAM,EAAE,CAAC,IAAI,KAAK,CAAC,YAAY,SAAS,mBAAmB,CAAC,CAAC;aAChE,CAAC;QACN,CAAC;QACD,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,mBAAmB,CAAC,EAAE,CAAC;YACpD,OAAO;gBACH,KAAK,EAAE,KAAK;gBACZ,MAAM,EAAE,CAAC,IAAI,KAAK,CAAC,YAAY,SAAS,yCAAyC,CAAC,CAAC;aACtF,CAAC;QACN,CAAC;QAED,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;IAC3B,CAAC;CACJ,CAAC;AAEF;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAkE;IACnG,IAAI,EAAE,sBAAsB;IAC5B,IAAI,EAAE,YAAY;IAClB,OAAO,EAAE;QACL,QAAQ,EAAE,MAAM;QAChB,MAAM,EAAE,MAAM;KACjB;IACD,QAAQ,CAAC,OAAO;QACZ,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC;QAEzC,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;QAE7C,MAAM,SAAS,GAAG,UAAU,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;QACtD,MAAM,aAAa,GAAG,UAAU,CAAC,WAAW,CAAC,eAAe,CAAC,CAAC;QAE9D,IAAI,SAAS,KAAK,aAAa,EAAE,CAAC;YAC9B,OAAO;gBACH,KAAK,EAAE,KAAK;gBACZ,MAAM,EAAE,CAAC,IAAI,KAAK,CAAC,iFAAiF,CAAC,CAAC;aACzG,CAAC;QACN,CAAC;QAED,+BAA+B;QAC/B,MAAM,MAAM,GAAY,EAAE,CAAC;QAC3B,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;YACvB,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,YAAY,SAAS,mBAAmB,CAAC,CAAC,CAAC;QACrE,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC;YAC3B,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,YAAY,aAAa,mBAAmB,CAAC,CAAC,CAAC;QACzE,CAAC;QAED,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpB,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;QACpC,CAAC;QAED,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;IAC3B,CAAC;CACJ,CAAC;AAEF;;;GAGG;AACH,SAAS,uBAAuB,CAAC,IAAwB;IACrD,IAAI,SAAS,GAAG,CAAC,CAAC;IAElB,KAAK,MAAM,MAAM,IAAI,IAAI,EAAE,CAAC;QACxB,IAAI,aAAa,IAAI,MAAM,IAAI,MAAM,CAAC,aAAa,CAAC,KAAK,IAAI,EAAE,CAAC;YAC5D,qBAAqB;YACrB,SAAS,IAAI,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC;QACxE,CAAC;aAAM,IAAI,eAAe,IAAI,MAAM,IAAI,MAAM,CAAC,eAAe,CAAC,KAAK,IAAI,EAAE,CAAC;YACvE,kDAAkD;YAClD,MAAM,MAAM,GAAG,MAAM,CAAC,eAAe,CAAC,CAAC;YACvC,kDAAkD;YAClD,uDAAuD;YACvD,MAAM,YAAY,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC;YACvD,SAAS,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC;QACxD,CAAC;aAAM,0BAA0B,CAAC,CAAC;YAC/B,yEAAyE;YACzE,4BAA4B;YAC5B,OAAO,IAAI,CAAC;QAChB,CAAC;IACL,CAAC;IAED,OAAO,SAAS,CAAC;AACrB,CAAC;AAED;;GAEG;AACH,SAAS,kBAAkB,CACvB,UAAkB,EAClB,YAAqB,EACrB,cAAsB,EACtB,cAA6B;IAE7B,MAAM,MAAM,GAAY,EAAE,CAAC;IAE3B,MAAM,IAAI,GAAI,YAA8C,CAAC,IAAI,CAAC;IAClE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACvB,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,0BAA0B;IAC1B,IAAI,IAAI,CAAC,MAAM,GAAG,cAAc,EAAE,CAAC;QAC/B,MAAM,CAAC,IAAI,CACP,IAAI,KAAK,CAAC,SAAS,UAAU,SAAS,IAAI,CAAC,MAAM,uCAAuC,cAAc,EAAE,CAAC,CAC5G,CAAC;IACN,CAAC;IAED,2CAA2C;IAC3C,IAAI,cAAc,KAAK,IAAI,EAAE,CAAC;QAC1B,MAAM,SAAS,GAAG,uBAAuB,CAAC,IAAI,CAAC,CAAC;QAEhD,IAAI,SAAS,KAAK,IAAI,IAAI,SAAS,GAAG,cAAc,EAAE,CAAC;YACnD,MAAM,QAAQ,GAAG,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YAC/C,MAAM,WAAW,GAAG,CAAC,cAAc,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YACvD,MAAM,CAAC,IAAI,CACP,IAAI,KAAK,CAAC,SAAS,UAAU,WAAW,QAAQ,iCAAiC,WAAW,KAAK,CAAC,CACrG,CAAC;QACN,CAAC;IACL,CAAC;IAED,OAAO,MAAM,CAAC;AAClB,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAoE;IACvG,IAAI,EAAE,wBAAwB;IAC9B,IAAI,EAAE,YAAY;IAClB,OAAO,EAAE;QACL,QAAQ,EAAE,MAAM;QAChB,MAAM,EAAE,QAAQ;KACnB;IACD,QAAQ,CAAC,OAAO;QACZ,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC;QAEzC,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;QAE/C,MAAM,SAAS,GAAG,UAAU,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;QACtD,MAAM,OAAO,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC;QACpC,IAAI,CAAC,OAAO,EAAE,CAAC;YACX,OAAO;gBACH,KAAK,EAAE,KAAK;gBACZ,MAAM,EAAE,CAAC,IAAI,KAAK,CAAC,YAAY,SAAS,mBAAmB,CAAC,CAAC;aAChE,CAAC;QACN,CAAC;QAED,MAAM,cAAc,GAAG,OAAO,CAAC,mBAAmB,CAAC,mBAAmB,CAAC,CAAC;QACxE,IAAI,CAAC,cAAc,EAAE,CAAC;YAClB,OAAO;gBACH,KAAK,EAAE,KAAK;gBACZ,MAAM,EAAE,CAAC,IAAI,KAAK,CAAC,YAAY,SAAS,yCAAyC,CAAC,CAAC;aACtF,CAAC;QACN,CAAC;QAED,MAAM,MAAM,GAAG,UAAU,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QAEhD,MAAM,MAAM,GAAY,EAAE,CAAC;QAC3B,MAAM,EAAE,cAAc,EAAE,cAAc,EAAE,GAAG,cAAc,CAAC;QAE1D,8BAA8B;QAC9B,KAAK,MAAM,CAAC,UAAU,EAAE,YAAY,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAC9D,MAAM,UAAU,GAAG,kBAAkB,CAAC,UAAU,EAAE,YAAY,EAAE,cAAc,EAAE,cAAc,CAAC,CAAC;YAChG,MAAM,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,CAAC;QAC/B,CAAC;QAED,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpB,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;QACpC,CAAC;QAED,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;IAC3B,CAAC;CACJ,CAAC;AAEF;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,MAAM,wCAAwC,GACjD,8BAA8B,CAAkC;IAC5D,IAAI,EAAE,yCAAyC;IAC/C,OAAO,EAAE;QACL,QAAQ,EAAE,MAAM;QAChB,MAAM,EAAE,QAAQ;KACnB;CACJ,CAAC,CAAC;AAEP,MAAM,2BAA2B,GAAG,CAAC,CAAC,WAAW,CAAC;IAC9C,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IAClD,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACvC,kBAAkB,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACvC,yBAAyB,EAAE,CAAC,CAAC,KAAK,CAAC,yBAAyB,CAAC;CAChE,CAAC,CAAC;AAEH;;;GAGG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC1B,GAAG,EAAE,mBAAmB;IACxB,WAAW,EAAE;QACT,IAAI,EAAE;YACF,OAAO,EAAE;gBACL,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM;gBAC3B,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG;gBACrB,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM;aAC9B;YACD,QAAQ,EAAE;gBACN,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM;gBAC5B,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC,GAAG;gBACtB,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM;aAC/B;SACJ;KACJ;IACD,UAAU,EAAE;QACR,wBAAwB;QACxB,wBAAwB;QACxB,0BAA0B;QAC1B,wCAAwC;KAC3C;IACD,MAAM,EAAE,EAAE,iBAAiB,EAAE,2BAA2B,EAAE;CAC9B,CAAC"}

package/dist/src/capabilities/core/core.d.ts

@@ -0,0 +1,47 @@
+import type { JMAPCapability, JMAPMethodName } from "../../common/types.js";
+import { Invocation } from "../../invocation/invocation.js";
+import type { InvocationArgs, InvocationFactory } from "../../invocation/types.js";
+import type { CoreInvocationArgs } from "./types.js";
+/**
+ * CoreInvocation represents a JMAP Core capability invocation.
+ *
+ * The Core data type only exposes the `/echo` method and must be supported by all JMAP servers.
+ *
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8620.html#section-4 | RFC 8620 Section 4: The Core/echo Method}
+ */
+export declare class CoreInvocation<TArgs extends CoreInvocationArgs> extends Invocation<TArgs> {
+    get uri(): JMAPCapability;
+    /**
+     * Constructs a CoreInvocation
+     *
+     * @param method The name of the method being invoked (e.g., "echo")
+     * @param args The arguments for the method invocation
+     * @param methodCallId An optional unique symbol to identify this method call for result referencing
+     */
+    constructor(method: JMAPMethodName, args: InvocationArgs<TArgs>, methodCallId?: symbol);
+    /**
+     * Create an invocation factory function
+     *
+     * @param method The name of the method to create
+     * @returns A new Core invocation factory function for creating invocations of the specified type
+     */
+    static createInvocationFactory<TArgs extends CoreInvocationArgs>(method: JMAPMethodName): InvocationFactory<TArgs, CoreInvocation<TArgs>>;
+}
+export declare const Core: {
+    request: {
+        /**
+         * The Core/echo method returns exactly the same arguments as it is given. It is useful for
+         * testing if you have a valid authenticated connection to a JMAP API endpoint.
+         *
+         * @param args The invocation arguments for the specified `method`
+         * @param methodCallId An optional unique symbol to identify this method call for result referencing
+         * @returns An object representing the named arguments for the specified `method`
+         *
+         * @see {@link https://www.rfc-editor.org/rfc/rfc8620.html#section-4 | RFC 8620 Section 4: The Core/echo Method}
+         */
+        echo: InvocationFactory<import("../../invocation/types.js").BaseInvocationArgs, CoreInvocation<import("../../invocation/types.js").BaseInvocationArgs>>;
+    };
+    response: {
+        echo: InvocationFactory<import("../../invocation/types.js").BaseInvocationArgs, CoreInvocation<import("../../invocation/types.js").BaseInvocationArgs>>;
+    };
+};

package/dist/src/capabilities/core/core.js

@@ -0,0 +1,59 @@
+import { CORE_CAPABILITY_URI } from "../../common/registry.js";
+import { Invocation } from "../../invocation/invocation.js";
+/**
+ * CoreInvocation represents a JMAP Core capability invocation.
+ *
+ * The Core data type only exposes the `/echo` method and must be supported by all JMAP servers.
+ *
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8620.html#section-4 | RFC 8620 Section 4: The Core/echo Method}
+ */
+export class CoreInvocation extends Invocation {
+    get uri() {
+        return CORE_CAPABILITY_URI;
+    }
+    /**
+     * Constructs a CoreInvocation
+     *
+     * @param method The name of the method being invoked (e.g., "echo")
+     * @param args The arguments for the method invocation
+     * @param methodCallId An optional unique symbol to identify this method call for result referencing
+     */
+    constructor(method, args, methodCallId) {
+        super("Core", method, args, methodCallId);
+    }
+    /**
+     * Create an invocation factory function
+     *
+     * @param method The name of the method to create
+     * @returns A new Core invocation factory function for creating invocations of the specified type
+     */
+    static createInvocationFactory(method) {
+        /**
+         * An invocation factory function to create a `Core/*` invocation for the specified `method`
+         *
+         * @param args The invocation arguments for the specified `method`
+         * @param methodCallId An optional unique symbol to identify this method call for result referencing
+         * @returns An object representing the named arguments for the specified `method`
+         */
+        return (args, methodCallId) => new CoreInvocation(method, args, methodCallId);
+    }
+}
+export const Core = {
+    request: {
+        /**
+         * The Core/echo method returns exactly the same arguments as it is given. It is useful for
+         * testing if you have a valid authenticated connection to a JMAP API endpoint.
+         *
+         * @param args The invocation arguments for the specified `method`
+         * @param methodCallId An optional unique symbol to identify this method call for result referencing
+         * @returns An object representing the named arguments for the specified `method`
+         *
+         * @see {@link https://www.rfc-editor.org/rfc/rfc8620.html#section-4 | RFC 8620 Section 4: The Core/echo Method}
+         */
+        echo: CoreInvocation.createInvocationFactory("echo"),
+    },
+    response: {
+        echo: CoreInvocation.createInvocationFactory("echo"),
+    },
+};
+//# sourceMappingURL=core.js.map

package/dist/src/capabilities/core/core.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"core.js","sourceRoot":"","sources":["../../../../src/capabilities/core/core.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAE/D,OAAO,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AAI5D;;;;;;GAMG;AACH,MAAM,OAAO,cAAiD,SAAQ,UAAiB;IACnF,IAAI,GAAG;QACH,OAAO,mBAAmB,CAAC;IAC/B,CAAC;IAED;;;;;;OAMG;IACH,YAAY,MAAsB,EAAE,IAA2B,EAAE,YAAqB;QAClF,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,uBAAuB,CAC1B,MAAsB;QAEtB;;;;;;WAMG;QACH,OAAO,CAAC,IAAI,EAAE,YAAY,EAAE,EAAE,CAAC,IAAI,cAAc,CAAQ,MAAM,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;IACzF,CAAC;CACJ;AAED,MAAM,CAAC,MAAM,IAAI,GAAG;IAChB,OAAO,EAAE;QACL;;;;;;;;;WASG;QACH,IAAI,EAAE,cAAc,CAAC,uBAAuB,CAAgC,MAAM,CAAC;KACtF;IACD,QAAQ,EAAE;QACN,IAAI,EAAE,cAAc,CAAC,uBAAuB,CAAiC,MAAM,CAAC;KACvF;CACkC,CAAC"}

package/dist/src/capabilities/core/types.d.ts

@@ -0,0 +1,13 @@
+import type { BaseInvocationArgs } from "../../invocation/types.js";
+/**
+ * The arguments for a Core/echo request invocation
+ */
+export type CoreEchoRequestInvocationArgs = BaseInvocationArgs;
+/**
+ * The response arguments for a Core/echo response invocation
+ */
+export type CoreEchoResponseInvocationArgs = BaseInvocationArgs;
+/**
+ * Union type of all Core capability invocation arguments (request and response)
+ */
+export type CoreInvocationArgs = BaseInvocationArgs;

package/dist/src/capabilities/core/types.js

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

package/dist/src/capabilities/core/types.js.map

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