jmap-kit 0.0.0 → 1.0.2

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

@@ -0,0 +1,166 @@
+import { MASKED_EMAIL_CAPABILITY_URI } from "../common/registry.js";
+import { MaskedEmail } from "./maskedemail/maskedemail.js";
+import { assertInvocation } from "./utils/assert-invocation.js";
+/**
+ * Validates that invocations using the MaskedEmail capability have a valid accountId that supports
+ * the MaskedEmail 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 MaskedEmail capability URI
+ *
+ * This validation applies to all MaskedEmail capability invocations (MaskedEmail/get, MaskedEmail/set)
+ * and implements the account capability checks for the FastMail Masked Email extension.
+ *
+ * @see {@link https://www.fastmail.com/dev/#masked-email-api | FastMail Developer Documentation - Masked Email API}
+ */
+export const maskedEmailAccountSupportPlugin = {
+    name: "maskedemail-account-support",
+    hook: "invocation",
+    trigger: {
+        capabilityUri: MASKED_EMAIL_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[MASKED_EMAIL_CAPABILITY_URI]) {
+            return {
+                valid: false,
+                errors: [new Error(`Account "${accountId}" does not support the MaskedEmail capability.`)],
+            };
+        }
+        return { valid: true };
+    },
+};
+/**
+ * Validates emailPrefix constraints for MaskedEmail creation.
+ *
+ * This plugin enforces FastMail's requirements for the emailPrefix property:
+ *
+ * **Email Prefix Constraints:**
+ * - Must be 64 characters or less
+ * - May only contain lowercase letters (a-z), digits (0-9), and underscores (_)
+ * - Only applicable during MaskedEmail creation (not updates)
+ *
+ * The emailPrefix is an optional property that allows clients to suggest a prefix for the
+ * generated masked email address. If not provided, the server generates one automatically.
+ *
+ * These validations catch invalid prefixes before sending requests to the server, providing
+ * immediate feedback and avoiding unnecessary network round-trips.
+ *
+ * @see {@link https://www.fastmail.com/dev/#masked-email-api | FastMail Developer Documentation - Masked Email API}
+ */
+export const maskedEmailPrefixValidationPlugin = {
+    name: "maskedemail-prefix-validation",
+    hook: "invocation",
+    trigger: {
+        dataType: "MaskedEmail",
+        method: "set",
+    },
+    validate(context) {
+        const { invocation } = context;
+        assertInvocation(invocation, "MaskedEmail", "set");
+        const create = invocation.getArgument("create");
+        if (!create || typeof create !== "object") {
+            return { valid: true }; // No creations to validate
+        }
+        const errors = [];
+        const prefixPattern = /^[a-z0-9_]+$/;
+        for (const [creationId, maskedEmail] of Object.entries(create)) {
+            const { emailPrefix } = maskedEmail;
+            if (emailPrefix !== undefined) {
+                // Check length constraint
+                if (emailPrefix.length > 64) {
+                    errors.push(new Error(`MaskedEmail "${creationId}" has emailPrefix of ${emailPrefix.length} characters, but maximum is 64`));
+                }
+                // Check character constraint
+                if (!prefixPattern.test(emailPrefix)) {
+                    errors.push(new Error(`MaskedEmail "${creationId}" has invalid emailPrefix. Only lowercase letters (a-z), digits (0-9), and underscores (_) are allowed`));
+                }
+            }
+        }
+        if (errors.length > 0) {
+            return { valid: false, errors };
+        }
+        return { valid: true };
+    },
+};
+/**
+ * Validates MaskedEmail state transition constraints.
+ *
+ * This plugin enforces FastMail's state machine rules for MaskedEmail objects:
+ *
+ * **State Transition Rules:**
+ * - Once a MaskedEmail transitions from "pending" to any other state, it cannot be set back to "pending"
+ * - Valid states: "pending", "enabled", "disabled", "deleted"
+ * - State can transition: pending → enabled/disabled/deleted
+ * - State can transition: enabled ⟷ disabled ⟷ deleted
+ * - State cannot transition: enabled/disabled/deleted → pending
+ *
+ * **Automatic Transitions:**
+ * - Pending addresses automatically become "enabled" when they receive their first message
+ * - Pending addresses are automatically deleted after 24 hours if unused
+ *
+ * This validation prevents invalid state transitions during updates, catching errors before
+ * they reach the server.
+ *
+ * @see {@link https://www.fastmail.com/dev/#masked-email-api | FastMail Developer Documentation - Masked Email API}
+ */
+export const maskedEmailStateValidationPlugin = {
+    name: "maskedemail-state-validation",
+    hook: "invocation",
+    trigger: {
+        dataType: "MaskedEmail",
+        method: "set",
+    },
+    validate(context) {
+        const { invocation } = context;
+        assertInvocation(invocation, "MaskedEmail", "set");
+        const update = invocation.getArgument("update");
+        if (!update || typeof update !== "object") {
+            return { valid: true }; // No updates to validate
+        }
+        const errors = [];
+        for (const [id, patch] of Object.entries(update)) {
+            const updateData = patch;
+            const { state } = updateData;
+            // Check if trying to set state back to pending
+            if (state === "pending") {
+                errors.push(new Error(`MaskedEmail "${id}" cannot be set to "pending" state. Once transitioned from pending, it cannot be set back`));
+            }
+        }
+        if (errors.length > 0) {
+            return { valid: false, errors };
+        }
+        return { valid: true };
+    },
+};
+/**
+ * Defines the MaskedEmail capability, including MaskedEmail invocations and validation plugins
+ * for the FastMail Masked Email extension.
+ *
+ * **Note:** Read-only account protection for MaskedEmail/set is handled by Core's generic
+ * `preventSetOnReadOnlyAccountPlugin`, which validates all `/set` methods.
+ */
+export const MaskedEmailCapability = {
+    uri: MASKED_EMAIL_CAPABILITY_URI,
+    invocations: {
+        MaskedEmail,
+    },
+    validators: [maskedEmailAccountSupportPlugin, maskedEmailPrefixValidationPlugin, maskedEmailStateValidationPlugin],
+};
+//# sourceMappingURL=maskedemail-capability.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"maskedemail-capability.js","sourceRoot":"","sources":["../../../src/capabilities/maskedemail-capability.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,2BAA2B,EAAE,MAAM,uBAAuB,CAAC;AACpE,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAE3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAEhE;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAmC;IAC3E,IAAI,EAAE,6BAA6B;IACnC,IAAI,EAAE,YAAY;IAClB,OAAO,EAAE;QACL,aAAa,EAAE,2BAA2B;KAC7C;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,2BAA2B,CAAC,EAAE,CAAC;YAC5D,OAAO;gBACH,KAAK,EAAE,KAAK;gBACZ,MAAM,EAAE,CAAC,IAAI,KAAK,CAAC,YAAY,SAAS,gDAAgD,CAAC,CAAC;aAC7F,CAAC;QACN,CAAC;QAED,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;IAC3B,CAAC;CACJ,CAAC;AAEF;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,MAAM,iCAAiC,GAAwE;IAClH,IAAI,EAAE,+BAA+B;IACrC,IAAI,EAAE,YAAY;IAClB,OAAO,EAAE;QACL,QAAQ,EAAE,aAAa;QACvB,MAAM,EAAE,KAAK;KAChB;IACD,QAAQ,CAAC,OAAO;QACZ,MAAM,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC;QAE/B,gBAAgB,CAAC,UAAU,EAAE,aAAa,EAAE,KAAK,CAAC,CAAC;QAEnD,MAAM,MAAM,GAAG,UAAU,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QAChD,IAAI,CAAC,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;YACxC,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,2BAA2B;QACvD,CAAC;QAED,MAAM,MAAM,GAAY,EAAE,CAAC;QAC3B,MAAM,aAAa,GAAG,cAAc,CAAC;QAErC,KAAK,MAAM,CAAC,UAAU,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAC7D,MAAM,EAAE,WAAW,EAAE,GAAG,WAAW,CAAC;YAEpC,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;gBAC5B,0BAA0B;gBAC1B,IAAI,WAAW,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC;oBAC1B,MAAM,CAAC,IAAI,CACP,IAAI,KAAK,CACL,gBAAgB,UAAU,wBAAwB,WAAW,CAAC,MAAM,gCAAgC,CACvG,CACJ,CAAC;gBACN,CAAC;gBAED,6BAA6B;gBAC7B,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;oBACnC,MAAM,CAAC,IAAI,CACP,IAAI,KAAK,CACL,gBAAgB,UAAU,wGAAwG,CACrI,CACJ,CAAC;gBACN,CAAC;YACL,CAAC;QACL,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;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,MAAM,gCAAgC,GAAwE;IACjH,IAAI,EAAE,8BAA8B;IACpC,IAAI,EAAE,YAAY;IAClB,OAAO,EAAE;QACL,QAAQ,EAAE,aAAa;QACvB,MAAM,EAAE,KAAK;KAChB;IACD,QAAQ,CAAC,OAAO;QACZ,MAAM,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC;QAE/B,gBAAgB,CAAC,UAAU,EAAE,aAAa,EAAE,KAAK,CAAC,CAAC;QAEnD,MAAM,MAAM,GAAG,UAAU,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QAChD,IAAI,CAAC,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;YACxC,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,yBAAyB;QACrD,CAAC;QAED,MAAM,MAAM,GAAY,EAAE,CAAC;QAE3B,KAAK,MAAM,CAAC,EAAE,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAC/C,MAAM,UAAU,GAAG,KAA2C,CAAC;YAC/D,MAAM,EAAE,KAAK,EAAE,GAAG,UAAU,CAAC;YAE7B,+CAA+C;YAC/C,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACtB,MAAM,CAAC,IAAI,CACP,IAAI,KAAK,CACL,gBAAgB,EAAE,2FAA2F,CAChH,CACJ,CAAC;YACN,CAAC;QACL,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;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACjC,GAAG,EAAE,2BAA2B;IAChC,WAAW,EAAE;QACT,WAAW;KACd;IACD,UAAU,EAAE,CAAC,+BAA+B,EAAE,iCAAiC,EAAE,gCAAgC,CAAC;CACtF,CAAC"}

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

@@ -0,0 +1,51 @@
+import type { JMAPCapability, JMAPMethodName } from "../../common/types.js";
+import { Invocation } from "../../invocation/invocation.js";
+import type { InvocationArgs, InvocationFactory } from "../../invocation/types.js";
+import type { SearchSnippetGetRequestInvocationArgs, SearchSnippetGetResponseInvocationArgs, SearchSnippetRequestInvocationArgs, SearchSnippetResponseInvocationArgs } from "./types.js";
+/**
+ * SearchSnippetInvocation represents a JMAP SearchSnippet capability invocation.
+ *
+ * When doing a search on a string property, the client may wish to show the relevant section
+ * of the body that matches the search as a preview and to highlight any matching terms in both
+ * this and the subject of the Email.
+ *
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-5 | RFC 8621 Section 5: Search Snippets}
+ */
+export declare class SearchSnippetInvocation<TArgs extends SearchSnippetRequestInvocationArgs | SearchSnippetResponseInvocationArgs> extends Invocation<TArgs> {
+    get uri(): JMAPCapability;
+    /**
+     * Constructs a SearchSnippetInvocation
+     *
+     * @param method The name of the method being invoked
+     * @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 SearchSnippet invocation factory function for creating invocations of the specified type
+     */
+    static createInvocationFactory<TArgs extends SearchSnippetRequestInvocationArgs | SearchSnippetResponseInvocationArgs>(method: JMAPMethodName): InvocationFactory<TArgs, SearchSnippetInvocation<TArgs>>;
+}
+export declare const SearchSnippet: {
+    request: {
+        /**
+         * Fetches search snippets for the given Email ids matching the given filter.
+         *
+         * This is NOT a standard `/get` method. The `ids` argument is replaced by `emailIds`,
+         * and an additional `filter` argument is required (the same filter as passed to `Email/query`).
+         *
+         * @param args The invocation arguments for SearchSnippet/get
+         * @param methodCallId An optional unique symbol to identify this method call for result referencing
+         * @returns A SearchSnippetInvocation representing the SearchSnippet/get request
+         *
+         * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-5.1 | RFC 8621 Section 5.1: SearchSnippet/get}
+         */
+        get: InvocationFactory<SearchSnippetGetRequestInvocationArgs, SearchSnippetInvocation<SearchSnippetGetRequestInvocationArgs>>;
+    };
+    response: {
+        get: InvocationFactory<SearchSnippetGetResponseInvocationArgs, SearchSnippetInvocation<SearchSnippetGetResponseInvocationArgs>>;
+    };
+};

package/dist/src/capabilities/searchsnippet/searchsnippet.js

@@ -0,0 +1,63 @@
+import { EMAIL_CAPABILITY_URI } from "../../common/registry.js";
+import { Invocation } from "../../invocation/invocation.js";
+/**
+ * SearchSnippetInvocation represents a JMAP SearchSnippet capability invocation.
+ *
+ * When doing a search on a string property, the client may wish to show the relevant section
+ * of the body that matches the search as a preview and to highlight any matching terms in both
+ * this and the subject of the Email.
+ *
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-5 | RFC 8621 Section 5: Search Snippets}
+ */
+export class SearchSnippetInvocation extends Invocation {
+    get uri() {
+        return EMAIL_CAPABILITY_URI;
+    }
+    /**
+     * Constructs a SearchSnippetInvocation
+     *
+     * @param method The name of the method being invoked
+     * @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("SearchSnippet", method, args, methodCallId);
+    }
+    /**
+     * Create an invocation factory function
+     *
+     * @param method The name of the method to create
+     * @returns A new SearchSnippet invocation factory function for creating invocations of the specified type
+     */
+    static createInvocationFactory(method) {
+        /**
+         * An invocation factory function to create a `SearchSnippet/{method}` invocation.
+         *
+         * @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 SearchSnippetInvocation(method, args, methodCallId);
+    }
+}
+export const SearchSnippet = {
+    request: {
+        /**
+         * Fetches search snippets for the given Email ids matching the given filter.
+         *
+         * This is NOT a standard `/get` method. The `ids` argument is replaced by `emailIds`,
+         * and an additional `filter` argument is required (the same filter as passed to `Email/query`).
+         *
+         * @param args The invocation arguments for SearchSnippet/get
+         * @param methodCallId An optional unique symbol to identify this method call for result referencing
+         * @returns A SearchSnippetInvocation representing the SearchSnippet/get request
+         *
+         * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-5.1 | RFC 8621 Section 5.1: SearchSnippet/get}
+         */
+        get: SearchSnippetInvocation.createInvocationFactory("get"),
+    },
+    response: {
+        get: SearchSnippetInvocation.createInvocationFactory("get"),
+    },
+};
+//# sourceMappingURL=searchsnippet.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"searchsnippet.js","sourceRoot":"","sources":["../../../../src/capabilities/searchsnippet/searchsnippet.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAEhE,OAAO,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AAS5D;;;;;;;;GAQG;AACH,MAAM,OAAO,uBAEX,SAAQ,UAAiB;IACvB,IAAI,GAAG;QACH,OAAO,oBAAoB,CAAC;IAChC,CAAC;IAED;;;;;;OAMG;IACH,YAAY,MAAsB,EAAE,IAA2B,EAAE,YAAqB;QAClF,KAAK,CAAC,eAAe,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;IACvD,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,uBAAuB,CAE5B,MAAsB;QACpB;;;;;;WAMG;QACH,OAAO,CAAC,IAAI,EAAE,YAAY,EAAE,EAAE,CAAC,IAAI,uBAAuB,CAAQ,MAAM,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;IAClG,CAAC;CACJ;AAED,MAAM,CAAC,MAAM,aAAa,GAAG;IACzB,OAAO,EAAE;QACL;;;;;;;;;;;WAWG;QACH,GAAG,EAAE,uBAAuB,CAAC,uBAAuB,CAAwC,KAAK,CAAC;KACrG;IACD,QAAQ,EAAE;QACN,GAAG,EAAE,uBAAuB,CAAC,uBAAuB,CAAyC,KAAK,CAAC;KACtG;CACkC,CAAC"}

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

@@ -0,0 +1,88 @@
+import type { Id } from "../../common/types.js";
+import type { FilterCondition, FilterOperator } from "../../invocation/types.js";
+import type { EmailFilterCondition } from "../email/types.js";
+/**
+ * A SearchSnippet object represents a relevant section of the body that matches a search,
+ * along with any matching terms highlighted in the subject.
+ *
+ * Note that unlike most data types, a SearchSnippet DOES NOT have a property called `id`.
+ *
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-5 | RFC 8621 Section 5: Search Snippets}
+ */
+export type SearchSnippetObject = {
+    /**
+     * The Email id the snippet applies to.
+     */
+    emailId: Id;
+    /**
+     * If text from the filter matches the subject, this is the subject of the Email with
+     * the following transformations:
+     *
+     * 1. Any instance of `&`, `<`, and `>` MUST be replaced by an appropriate HTML entity.
+     *    Other characters MAY also be replaced with an HTML entity form.
+     *
+     * 2. The matching words/phrases from the filter are wrapped in HTML `<mark></mark>` tags.
+     *
+     * If the subject does not match text from the filter, this property is `null`.
+     */
+    subject: string | null;
+    /**
+     * If text from the filter matches the plaintext or HTML body, this is the relevant section
+     * of the body (converted to plaintext if originally HTML), with the same transformations as
+     * the `subject` property. It MUST NOT be bigger than 255 octets in size. If the body does
+     * not contain a match for the text from the filter, this property is `null`.
+     */
+    preview: string | null;
+};
+/**
+ * The arguments for fetching SearchSnippet objects via a `SearchSnippet/get` call.
+ *
+ * This is NOT a standard `/get` method. It takes a filter (the same as passed to `Email/query`)
+ * and a list of Email ids, and returns search snippets for those Emails.
+ *
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-5.1 | RFC 8621 Section 5.1: SearchSnippet/get}
+ */
+export type SearchSnippetGetRequestInvocationArgs = {
+    /**
+     * The id of the account to use.
+     */
+    accountId: Id;
+    /**
+     * The same filter as passed to `Email/query`.
+     *
+     * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-4.4 | RFC 8621 Section 4.4: Email/query}
+     */
+    filter?: FilterOperator<EmailFilterCondition> | FilterCondition<EmailFilterCondition> | null;
+    /**
+     * The ids of the Emails to fetch snippets for.
+     */
+    emailIds: Id[];
+};
+/**
+ * The response to a `SearchSnippet/get` call.
+ *
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-5.1 | RFC 8621 Section 5.1: SearchSnippet/get}
+ */
+export type SearchSnippetGetResponseInvocationArgs = {
+    /**
+     * The id of the account used for the call.
+     */
+    accountId: Id;
+    /**
+     * An array of SearchSnippet objects for the requested Email ids. This may not be in the
+     * same order as the ids that were in the request.
+     */
+    list: SearchSnippetObject[];
+    /**
+     * An array of Email ids requested that could not be found, or `null` if all ids were found.
+     */
+    notFound: Id[] | null;
+};
+/**
+ * Union type of all SearchSnippet capability request invocation arguments.
+ */
+export type SearchSnippetRequestInvocationArgs = SearchSnippetGetRequestInvocationArgs;
+/**
+ * Union type of all SearchSnippet capability response invocation arguments.
+ */
+export type SearchSnippetResponseInvocationArgs = SearchSnippetGetResponseInvocationArgs;

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

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

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

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

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

@@ -0,0 +1,89 @@
+import { z } from "zod/v4";
+import type { ValidationPlugin } from "../capability-registry/types.js";
+import { SUBMISSION_CAPABILITY_URI } from "../common/registry.js";
+/**
+ * Validates that invocations using the Submission capability have a valid accountId that supports
+ * the Submission 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 Submission capability URI
+ *
+ * This validation applies to all Submission capability invocations (Identity and EmailSubmission
+ * method calls) and implements the account capability checks described in RFC 8621 Section 1.3.2.
+ *
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-1.3.2 | RFC 8621 Section 1.3.2: The Submission Capability}
+ */
+export declare const submissionAccountSupportPlugin: ValidationPlugin<"invocation">;
+export declare const SubmissionCapability: {
+    uri: "urn:ietf:params:jmap:submission";
+    invocations: {
+        EmailSubmission: {
+            request: {
+                get: import("../index.js").InvocationFactory<import("./emailsubmission/types.js").EmailSubmissionGetRequestInvocationArgs, import("./emailsubmission/emailsubmission.js").EmailSubmissionInvocation<import("./emailsubmission/types.js").EmailSubmissionGetRequestInvocationArgs>>;
+                changes: import("../index.js").InvocationFactory<import("../index.js").BaseChangesRequestInvocationArgs, import("./emailsubmission/emailsubmission.js").EmailSubmissionInvocation<import("../index.js").BaseChangesRequestInvocationArgs>>;
+                query: import("../index.js").InvocationFactory<import("./emailsubmission/types.js").EmailSubmissionQueryRequestInvocationArgs, import("./emailsubmission/emailsubmission.js").EmailSubmissionInvocation<import("./emailsubmission/types.js").EmailSubmissionQueryRequestInvocationArgs>>;
+                queryChanges: import("../index.js").InvocationFactory<import("./emailsubmission/types.js").EmailSubmissionQueryChangesRequestInvocationArgs, import("./emailsubmission/emailsubmission.js").EmailSubmissionInvocation<import("./emailsubmission/types.js").EmailSubmissionQueryChangesRequestInvocationArgs>>;
+                set: import("../index.js").InvocationFactory<import("./emailsubmission/types.js").EmailSubmissionSetRequestInvocationArgs, import("./emailsubmission/emailsubmission.js").EmailSubmissionInvocation<import("./emailsubmission/types.js").EmailSubmissionSetRequestInvocationArgs>>;
+            };
+            response: {
+                get: import("../index.js").InvocationFactory<import("./emailsubmission/types.js").EmailSubmissionGetResponseInvocationArgs, import("./emailsubmission/emailsubmission.js").EmailSubmissionInvocation<import("./emailsubmission/types.js").EmailSubmissionGetResponseInvocationArgs>>;
+                changes: import("../index.js").InvocationFactory<import("../index.js").BaseChangesResponseInvocationArgs, import("./emailsubmission/emailsubmission.js").EmailSubmissionInvocation<import("../index.js").BaseChangesResponseInvocationArgs>>;
+                query: import("../index.js").InvocationFactory<import("../index.js").BaseQueryResponseInvocationArgs, import("./emailsubmission/emailsubmission.js").EmailSubmissionInvocation<import("../index.js").BaseQueryResponseInvocationArgs>>;
+                queryChanges: import("../index.js").InvocationFactory<import("../index.js").BaseQueryChangesResponseInvocationArgs, import("./emailsubmission/emailsubmission.js").EmailSubmissionInvocation<import("../index.js").BaseQueryChangesResponseInvocationArgs>>;
+                set: import("../index.js").InvocationFactory<import("./emailsubmission/types.js").EmailSubmissionSetResponseInvocationArgs, import("./emailsubmission/emailsubmission.js").EmailSubmissionInvocation<import("./emailsubmission/types.js").EmailSubmissionSetResponseInvocationArgs>>;
+            };
+        };
+        Identity: {
+            request: {
+                get: import("../index.js").InvocationFactory<import("./identity/types.js").IdentityGetRequestInvocationArgs, import("./identity/identity.js").IdentityInvocation<import("./identity/types.js").IdentityGetRequestInvocationArgs>>;
+                changes: import("../index.js").InvocationFactory<import("../index.js").BaseChangesRequestInvocationArgs, import("./identity/identity.js").IdentityInvocation<import("../index.js").BaseChangesRequestInvocationArgs>>;
+                set: import("../index.js").InvocationFactory<import("./identity/types.js").IdentitySetRequestInvocationArgs, import("./identity/identity.js").IdentityInvocation<import("./identity/types.js").IdentitySetRequestInvocationArgs>>;
+            };
+            response: {
+                get: import("../index.js").InvocationFactory<import("./identity/types.js").IdentityGetResponseInvocationArgs, import("./identity/identity.js").IdentityInvocation<import("./identity/types.js").IdentityGetResponseInvocationArgs>>;
+                changes: import("../index.js").InvocationFactory<import("../index.js").BaseChangesResponseInvocationArgs, import("./identity/identity.js").IdentityInvocation<import("../index.js").BaseChangesResponseInvocationArgs>>;
+                set: import("../index.js").InvocationFactory<import("./identity/types.js").IdentitySetResponseInvocationArgs, import("./identity/identity.js").IdentityInvocation<import("./identity/types.js").IdentitySetResponseInvocationArgs>>;
+            };
+        };
+    };
+    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<import("../index.js").BaseInvocationArgs>;
+        }): import("../index.js").MaybePromise<import("../capability-registry/types.js").ValidationResult>;
+    }[];
+    schema: {
+        accountCapability: z.ZodObject<{
+            maxDelayedSend: z.ZodNumber;
+            submissionExtensions: z.ZodRecord<z.ZodString, z.ZodArray<z.ZodString>>;
+        }, z.core.$loose>;
+    };
+};
+declare module "../common/types.js" {
+    interface ServerCapabilityRegistry {
+        [SUBMISSION_CAPABILITY_URI]?: EmptyObject;
+    }
+    interface AccountCapabilityRegistry {
+        [SUBMISSION_CAPABILITY_URI]?: {
+            /**
+             * The number in seconds of the maximum delay the server supports in sending. This is 0 if
+             * the server does not support delayed send.
+             */
+            maxDelayedSend: UnsignedInt;
+            /**
+             * The set of SMTP submission extensions supported by the server, which the client may use
+             * when creating an EmailSubmission object (see Section 7). Each key in the object is the
+             * ehlo-name, and the value is a list of ehlo-args.
+             */
+            submissionExtensions: Record<string, string[]>;
+        };
+    }
+}

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

@@ -0,0 +1,75 @@
+import { z } from "zod/v4";
+import { SUBMISSION_CAPABILITY_URI } from "../common/registry.js";
+import { EmailSubmission } from "./emailsubmission/emailsubmission.js";
+import { Identity } from "./identity/identity.js";
+/**
+ * Validates that invocations using the Submission capability have a valid accountId that supports
+ * the Submission 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 Submission capability URI
+ *
+ * This validation applies to all Submission capability invocations (Identity and EmailSubmission
+ * method calls) and implements the account capability checks described in RFC 8621 Section 1.3.2.
+ *
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-1.3.2 | RFC 8621 Section 1.3.2: The Submission Capability}
+ */
+export const submissionAccountSupportPlugin = {
+    name: "submission-account-support",
+    hook: "invocation",
+    trigger: {
+        capabilityUri: SUBMISSION_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[SUBMISSION_CAPABILITY_URI]) {
+            return {
+                valid: false,
+                errors: [new Error(`Account "${accountId}" does not support the Submission capability.`)],
+            };
+        }
+        return { valid: true };
+    },
+};
+/**
+ * Defines the Submission capability, including all its associated invocations
+ * (EmailSubmission, Identity) and validation plugins.
+ *
+ * Per RFC 8621 Section 1.3.2, the `urn:ietf:params:jmap:submission` capability represents support
+ * for the Identity and EmailSubmission data types and associated API methods.
+ *
+ * Read-only account protection for `/set` methods is handled by Core's generic
+ * `preventSetOnReadOnlyAccountPlugin`.
+ *
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-1.3.2 | RFC 8621 Section 1.3.2: The Submission Capability}
+ */
+const submissionAccountCapabilitySchema = z.looseObject({
+    maxDelayedSend: z.number().int().min(0),
+    submissionExtensions: z.record(z.string(), z.array(z.string())),
+});
+export const SubmissionCapability = {
+    uri: SUBMISSION_CAPABILITY_URI,
+    invocations: {
+        EmailSubmission,
+        Identity,
+    },
+    validators: [submissionAccountSupportPlugin],
+    schema: { accountCapability: submissionAccountCapabilitySchema },
+};
+//# sourceMappingURL=submission-capability.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"submission-capability.js","sourceRoot":"","sources":["../../../src/capabilities/submission-capability.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAC;AAE3B,OAAO,EAAE,yBAAyB,EAAE,MAAM,uBAAuB,CAAC;AAClE,OAAO,EAAE,eAAe,EAAE,MAAM,sCAAsC,CAAC;AACvE,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAElD;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAmC;IAC1E,IAAI,EAAE,4BAA4B;IAClC,IAAI,EAAE,YAAY;IAClB,OAAO,EAAE;QACL,aAAa,EAAE,yBAAyB;KAC3C;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,yBAAyB,CAAC,EAAE,CAAC;YAC1D,OAAO;gBACH,KAAK,EAAE,KAAK;gBACZ,MAAM,EAAE,CAAC,IAAI,KAAK,CAAC,YAAY,SAAS,+CAA+C,CAAC,CAAC;aAC5F,CAAC;QACN,CAAC;QAED,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;IAC3B,CAAC;CACJ,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,MAAM,iCAAiC,GAAG,CAAC,CAAC,WAAW,CAAC;IACpD,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACvC,oBAAoB,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;CAClE,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAChC,GAAG,EAAE,yBAAyB;IAC9B,WAAW,EAAE;QACT,eAAe;QACf,QAAQ;KACX;IACD,UAAU,EAAE,CAAC,8BAA8B,CAAC;IAC5C,MAAM,EAAE,EAAE,iBAAiB,EAAE,iCAAiC,EAAE;CACpC,CAAC"}

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

@@ -0,0 +1,58 @@
+import type { JMAPCapability, JMAPMethodName } from "../../common/types.js";
+import { Invocation } from "../../invocation/invocation.js";
+import type { InvocationArgs, InvocationFactory } from "../../invocation/types.js";
+import type { ThreadGetRequestInvocationArgs, ThreadGetResponseInvocationArgs, ThreadRequestInvocationArgs, ThreadResponseInvocationArgs } from "./types.js";
+/**
+ * ThreadInvocation represents a JMAP Thread capability invocation.
+ *
+ * The Thread data type represents a conversation thread containing related email messages.
+ * It supports methods for retrieving threads and tracking changes.
+ *
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-3 | RFC 8621 Section 3: Threads}
+ */
+export declare class ThreadInvocation<TArgs extends ThreadRequestInvocationArgs | ThreadResponseInvocationArgs> extends Invocation<TArgs> {
+    get uri(): JMAPCapability;
+    /**
+     * Constructs a ThreadInvocation
+     *
+     * @param method The name of the method being invoked (e.g., "get", "changes")
+     * @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 Thread invocation factory function for creating invocations of the specified type
+     */
+    static createInvocationFactory<TArgs extends ThreadRequestInvocationArgs | ThreadResponseInvocationArgs>(method: JMAPMethodName): InvocationFactory<TArgs, ThreadInvocation<TArgs>>;
+}
+export declare const Thread: {
+    request: {
+        /**
+         * Retrieves Thread objects by their IDs.
+         *
+         * @param args The invocation arguments for Thread/get
+         * @param methodCallId An optional unique symbol to identify this method call for result referencing
+         * @returns A ThreadInvocation representing the Thread/get request
+         *
+         * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-3.1 | RFC 8621 Section 3.1: Thread/get}
+         */
+        get: InvocationFactory<ThreadGetRequestInvocationArgs, ThreadInvocation<ThreadGetRequestInvocationArgs>>;
+        /**
+         * Returns changes to Thread objects since a given state.
+         *
+         * @param args The invocation arguments for Thread/changes
+         * @param methodCallId An optional unique symbol to identify this method call for result referencing
+         * @returns A ThreadInvocation representing the Thread/changes request
+         *
+         * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-3.2 | RFC 8621 Section 3.2: Thread/changes}
+         */
+        changes: InvocationFactory<import("../../invocation/types.js").BaseChangesRequestInvocationArgs, ThreadInvocation<import("../../invocation/types.js").BaseChangesRequestInvocationArgs>>;
+    };
+    response: {
+        get: InvocationFactory<ThreadGetResponseInvocationArgs, ThreadInvocation<ThreadGetResponseInvocationArgs>>;
+        changes: InvocationFactory<import("../../invocation/types.js").BaseChangesResponseInvocationArgs, ThreadInvocation<import("../../invocation/types.js").BaseChangesResponseInvocationArgs>>;
+    };
+};