jmap-kit 0.0.0 → 1.0.2

package/dist/src/capabilities/emailsubmission/emailsubmission.js

@@ -0,0 +1,107 @@
+import { SUBMISSION_CAPABILITY_URI } from "../../common/registry.js";
+import { Invocation } from "../../invocation/invocation.js";
+/**
+ * EmailSubmissionInvocation represents a JMAP EmailSubmission capability invocation.
+ *
+ * An EmailSubmission object represents the submission of an Email for delivery to one or more
+ * recipients. It supports standard JMAP methods for retrieving, querying, and modifying submissions.
+ *
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-7 | RFC 8621 Section 7: Email Submission}
+ */
+export class EmailSubmissionInvocation extends Invocation {
+    get uri() {
+        return SUBMISSION_CAPABILITY_URI;
+    }
+    /**
+     * Constructs an EmailSubmissionInvocation
+     *
+     * @param method The name of the method being invoked (e.g., "get", "set", "query")
+     * @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("EmailSubmission", method, args, methodCallId);
+    }
+    /**
+     * Create an invocation factory function
+     *
+     * @param method The name of the method to create
+     * @returns A new EmailSubmission invocation factory function for creating invocations of the specified type
+     */
+    static createInvocationFactory(method) {
+        /**
+         * An invocation factory function to create an `EmailSubmission/{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 EmailSubmissionInvocation(method, args, methodCallId);
+    }
+}
+export const EmailSubmission = {
+    request: {
+        /**
+         * Retrieves EmailSubmission objects by their IDs.
+         *
+         * @param args The invocation arguments for EmailSubmission/get
+         * @param methodCallId An optional unique symbol to identify this method call for result referencing
+         * @returns An EmailSubmissionInvocation representing the EmailSubmission/get request
+         *
+         * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-7.1 | RFC 8621 Section 7.1: EmailSubmission/get}
+         */
+        get: EmailSubmissionInvocation.createInvocationFactory("get"),
+        /**
+         * Returns changes to EmailSubmission objects since a given state.
+         *
+         * @param args The invocation arguments for EmailSubmission/changes
+         * @param methodCallId An optional unique symbol to identify this method call for result referencing
+         * @returns An EmailSubmissionInvocation representing the EmailSubmission/changes request
+         *
+         * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-7.2 | RFC 8621 Section 7.2: EmailSubmission/changes}
+         */
+        changes: EmailSubmissionInvocation.createInvocationFactory("changes"),
+        /**
+         * Queries for EmailSubmission objects matching specified criteria.
+         *
+         * @param args The invocation arguments for EmailSubmission/query
+         * @param methodCallId An optional unique symbol to identify this method call for result referencing
+         * @returns An EmailSubmissionInvocation representing the EmailSubmission/query request
+         *
+         * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-7.3 | RFC 8621 Section 7.3: EmailSubmission/query}
+         */
+        query: EmailSubmissionInvocation.createInvocationFactory("query"),
+        /**
+         * Returns changes to a query result since a given state.
+         *
+         * @param args The invocation arguments for EmailSubmission/queryChanges
+         * @param methodCallId An optional unique symbol to identify this method call for result referencing
+         * @returns An EmailSubmissionInvocation representing the EmailSubmission/queryChanges request
+         *
+         * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-7.4 | RFC 8621 Section 7.4: EmailSubmission/queryChanges}
+         */
+        queryChanges: EmailSubmissionInvocation.createInvocationFactory("queryChanges"),
+        /**
+         * Creates, updates, or destroys EmailSubmission objects.
+         *
+         * An Email is sent by creating an EmailSubmission object. Additional `onSuccessUpdateEmail`
+         * and `onSuccessDestroyEmail` arguments allow updating or destroying the referenced Email
+         * upon successful submission.
+         *
+         * @param args The invocation arguments for EmailSubmission/set
+         * @param methodCallId An optional unique symbol to identify this method call for result referencing
+         * @returns An EmailSubmissionInvocation representing the EmailSubmission/set request
+         *
+         * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-7.5 | RFC 8621 Section 7.5: EmailSubmission/set}
+         */
+        set: EmailSubmissionInvocation.createInvocationFactory("set"),
+    },
+    response: {
+        get: EmailSubmissionInvocation.createInvocationFactory("get"),
+        changes: EmailSubmissionInvocation.createInvocationFactory("changes"),
+        query: EmailSubmissionInvocation.createInvocationFactory("query"),
+        queryChanges: EmailSubmissionInvocation.createInvocationFactory("queryChanges"),
+        set: EmailSubmissionInvocation.createInvocationFactory("set"),
+    },
+};
+//# sourceMappingURL=emailsubmission.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"emailsubmission.js","sourceRoot":"","sources":["../../../../src/capabilities/emailsubmission/emailsubmission.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yBAAyB,EAAE,MAAM,0BAA0B,CAAC;AAErE,OAAO,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AAiB5D;;;;;;;GAOG;AACH,MAAM,OAAO,yBAEX,SAAQ,UAAiB;IACvB,IAAI,GAAG;QACH,OAAO,yBAAyB,CAAC;IACrC,CAAC;IAED;;;;;;OAMG;IACH,YAAY,MAAsB,EAAE,IAA2B,EAAE,YAAqB;QAClF,KAAK,CAAC,iBAAiB,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;IACzD,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,uBAAuB,CAE5B,MAAsB;QACpB;;;;;;WAMG;QACH,OAAO,CAAC,IAAI,EAAE,YAAY,EAAE,EAAE,CAAC,IAAI,yBAAyB,CAAQ,MAAM,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;IACpG,CAAC;CACJ;AAED,MAAM,CAAC,MAAM,eAAe,GAAG;IAC3B,OAAO,EAAE;QACL;;;;;;;;WAQG;QACH,GAAG,EAAE,yBAAyB,CAAC,uBAAuB,CAA0C,KAAK,CAAC;QACtG;;;;;;;;WAQG;QACH,OAAO,EACH,yBAAyB,CAAC,uBAAuB,CAA8C,SAAS,CAAC;QAC7G;;;;;;;;WAQG;QACH,KAAK,EAAE,yBAAyB,CAAC,uBAAuB,CAA4C,OAAO,CAAC;QAC5G;;;;;;;;WAQG;QACH,YAAY,EACR,yBAAyB,CAAC,uBAAuB,CAC7C,cAAc,CACjB;QACL;;;;;;;;;;;;WAYG;QACH,GAAG,EAAE,yBAAyB,CAAC,uBAAuB,CAA0C,KAAK,CAAC;KACzG;IACD,QAAQ,EAAE;QACN,GAAG,EAAE,yBAAyB,CAAC,uBAAuB,CAA2C,KAAK,CAAC;QACvG,OAAO,EACH,yBAAyB,CAAC,uBAAuB,CAA+C,SAAS,CAAC;QAC9G,KAAK,EAAE,yBAAyB,CAAC,uBAAuB,CAA6C,OAAO,CAAC;QAC7G,YAAY,EACR,yBAAyB,CAAC,uBAAuB,CAC7C,cAAc,CACjB;QACL,GAAG,EAAE,yBAAyB,CAAC,uBAAuB,CAA2C,KAAK,CAAC;KAC1G;CACkC,CAAC"}

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

@@ -0,0 +1,256 @@
+import type { Id, UTCDate } from "../../common/types.js";
+import type { BaseChangesRequestInvocationArgs, BaseChangesResponseInvocationArgs, BaseGetRequestInvocationArgs, BaseGetResponseInvocationArgs, BaseQueryChangesRequestInvocationArgs, BaseQueryChangesResponseInvocationArgs, BaseQueryRequestInvocationArgs, BaseQueryResponseInvocationArgs, BaseSetRequestInvocationArgs, BaseSetResponseInvocationArgs, PatchObject } from "../../invocation/types.js";
+/**
+ * An Address object used in the Envelope for SMTP submission.
+ *
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-7 | RFC 8621 Section 7: Email Submission}
+ */
+export type EmailSubmissionAddress = {
+    /**
+     * The email address being represented by the object. This is a `Mailbox` as used in the
+     * Reverse-path or Forward-path of the MAIL FROM or RCPT TO command in
+     * {@link https://www.rfc-editor.org/rfc/rfc5321.html RFC 5321}.
+     */
+    email: string;
+    /**
+     * Any parameters to send with the email address (either mail-parameter or rcpt-parameter
+     * as appropriate, as specified in {@link https://www.rfc-editor.org/rfc/rfc5321.html RFC 5321}).
+     * If supplied, each key in the object is a parameter name, and the value is either the
+     * parameter value (type `String`) or `null` if the parameter does not take a value.
+     */
+    parameters?: Record<string, string | null> | null;
+};
+/**
+ * An Envelope object containing the information for use when sending via SMTP.
+ *
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-7 | RFC 8621 Section 7: Email Submission}
+ */
+export type EmailSubmissionEnvelope = {
+    /**
+     * The email address to use as the return address in the SMTP submission, plus any
+     * parameters to pass with the MAIL FROM address. The JMAP server MAY allow the
+     * address to be the empty string.
+     */
+    mailFrom: EmailSubmissionAddress;
+    /**
+     * The email addresses to send the message to, and any RCPT TO parameters to pass
+     * with the recipient.
+     */
+    rcptTo: EmailSubmissionAddress[];
+};
+/**
+ * A DeliveryStatus object representing the delivery status for a recipient.
+ *
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-7 | RFC 8621 Section 7: Email Submission}
+ */
+export type DeliveryStatus = {
+    /**
+     * The SMTP reply string returned for this recipient when the server last tried to relay
+     * the message, or in a later Delivery Status Notification (DSN, as defined in
+     * {@link https://www.rfc-editor.org/rfc/rfc3464.html RFC 3464}) response for the message.
+     */
+    smtpReply: string;
+    /**
+     * Represents whether the message has been successfully delivered to the recipient.
+     * This MUST be one of the following values:
+     * - `queued`: The message is in a local mail queue and the status will change once
+     *   it exits the local mail queues.
+     * - `yes`: The message was successfully delivered to the mail store of the recipient.
+     * - `no`: Delivery to the recipient permanently failed.
+     * - `unknown`: The final delivery status is unknown.
+     */
+    delivered: "queued" | "yes" | "no" | "unknown";
+    /**
+     * Represents whether the message has been displayed to the recipient.
+     * This MUST be one of the following values:
+     * - `unknown`: The display status is unknown. This is the initial value.
+     * - `yes`: The recipient's system claims the message content has been displayed
+     *   to the recipient.
+     */
+    displayed: "unknown" | "yes";
+};
+/**
+ * EmailSubmissionObject properties set by the server. These cannot be set by an
+ * `EmailSubmission/set` call.
+ *
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-7 | RFC 8621 Section 7: Email Submission}
+ */
+export type EmailSubmissionObjectServerSet = Readonly<{
+    /**
+     * (immutable; server-set) The id of the EmailSubmission.
+     */
+    id: Id;
+    /**
+     * (immutable; server-set) The Thread id of the Email to send. This is set by the server
+     * to the `threadId` property of the Email referenced by the `emailId`.
+     */
+    threadId: Id;
+    /**
+     * (immutable; server-set) The date the submission was/will be released for delivery.
+     * If the client successfully used FUTURERELEASE
+     * ({@link https://www.rfc-editor.org/rfc/rfc4865.html RFC 4865}) with the submission,
+     * this MUST be the time when the server will release the message; otherwise, it MUST be
+     * the time the EmailSubmission was created.
+     */
+    sendAt: UTCDate;
+    /**
+     * (server-set) This represents the delivery status for each of the submission's recipients,
+     * if known. This property MAY not be supported by all servers, in which case it will remain
+     * `null`. Servers that support it SHOULD update the EmailSubmission object each time the
+     * status of any of the recipients changes, even if some recipients are still being retried.
+     *
+     * This value is a map from the email address of each recipient to a DeliveryStatus object.
+     */
+    deliveryStatus: Record<string, DeliveryStatus> | null;
+    /**
+     * (server-set) A list of blob ids for DSNs
+     * ({@link https://www.rfc-editor.org/rfc/rfc3464.html RFC 3464}) received for this
+     * submission, in order of receipt, oldest first.
+     */
+    dsnBlobIds: Id[];
+    /**
+     * (server-set) A list of blob ids for MDNs
+     * ({@link https://www.rfc-editor.org/rfc/rfc8098.html RFC 8098}) received for this
+     * submission, in order of receipt, oldest first.
+     */
+    mdnBlobIds: Id[];
+}>;
+/**
+ * EmailSubmissionObject properties that may be set via an `EmailSubmission/set` call.
+ *
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-7 | RFC 8621 Section 7: Email Submission}
+ */
+export type EmailSubmissionObjectSettable = {
+    /**
+     * (immutable) The id of the Identity to associate with this submission.
+     */
+    readonly identityId: Id;
+    /**
+     * (immutable) The id of the Email to send. The Email being sent does not have to be a
+     * draft, for example, when "redirecting" an existing Email to a different address.
+     */
+    readonly emailId: Id;
+    /**
+     * (immutable) Information for use when sending via SMTP. If `null` or omitted on creation,
+     * the server MUST generate this from the referenced Email.
+     */
+    readonly envelope?: EmailSubmissionEnvelope | null;
+    /**
+     * This represents whether the submission may be canceled. This is server set on create
+     * and MUST be one of the following values:
+     * - `pending`: It may be possible to cancel this submission.
+     * - `final`: The message has been relayed to at least one recipient in a manner that
+     *   cannot be recalled. It is no longer possible to cancel this submission.
+     * - `canceled`: The submission was canceled and will not be delivered to any recipient.
+     */
+    undoStatus?: "pending" | "final" | "canceled";
+};
+/**
+ * Properties of the EmailSubmission object.
+ *
+ * An EmailSubmission object represents the submission of an Email for delivery to one or
+ * more recipients.
+ *
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-7 | RFC 8621 Section 7: Email Submission}
+ */
+export type EmailSubmissionObject = EmailSubmissionObjectServerSet & EmailSubmissionObjectSettable;
+/**
+ * The arguments for fetching EmailSubmission objects via an `EmailSubmission/get` call.
+ */
+export type EmailSubmissionGetRequestInvocationArgs = BaseGetRequestInvocationArgs<EmailSubmissionObject>;
+/**
+ * The response to an `EmailSubmission/get` call.
+ */
+export type EmailSubmissionGetResponseInvocationArgs = BaseGetResponseInvocationArgs<EmailSubmissionObject>;
+/**
+ * The arguments for fetching EmailSubmission changes via an `EmailSubmission/changes` call.
+ */
+export type EmailSubmissionChangesRequestInvocationArgs = BaseChangesRequestInvocationArgs;
+/**
+ * The response to an `EmailSubmission/changes` call.
+ */
+export type EmailSubmissionChangesResponseInvocationArgs = BaseChangesResponseInvocationArgs;
+/**
+ * Filter conditions for `EmailSubmission/query`.
+ *
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-7.3 | RFC 8621 Section 7.3: EmailSubmission/query}
+ */
+export type EmailSubmissionFilterCondition = Partial<{
+    /**
+     * The EmailSubmission `identityId` property must be in this list to match the condition.
+     */
+    identityIds: Id[];
+    /**
+     * The EmailSubmission `emailId` property must be in this list to match the condition.
+     */
+    emailIds: Id[];
+    /**
+     * The EmailSubmission `threadId` property must be in this list to match the condition.
+     */
+    threadIds: Id[];
+    /**
+     * The EmailSubmission `undoStatus` property must be identical to the value given to
+     * match the condition.
+     */
+    undoStatus: string;
+    /**
+     * The `sendAt` property of the EmailSubmission object must be before this date-time
+     * to match the condition.
+     */
+    before: UTCDate;
+    /**
+     * The `sendAt` property of the EmailSubmission object must be the same as or after
+     * this date-time to match the condition.
+     */
+    after: UTCDate;
+}>;
+/**
+ * The arguments to query EmailSubmission objects via an `EmailSubmission/query` call.
+ */
+export type EmailSubmissionQueryRequestInvocationArgs = BaseQueryRequestInvocationArgs<EmailSubmissionObject, EmailSubmissionFilterCondition>;
+/**
+ * The response to an `EmailSubmission/query` call.
+ */
+export type EmailSubmissionQueryResponseInvocationArgs = BaseQueryResponseInvocationArgs;
+/**
+ * The arguments to query changes to EmailSubmission objects via an
+ * `EmailSubmission/queryChanges` call.
+ */
+export type EmailSubmissionQueryChangesRequestInvocationArgs = BaseQueryChangesRequestInvocationArgs<EmailSubmissionObject, EmailSubmissionFilterCondition>;
+/**
+ * The response to an `EmailSubmission/queryChanges` call.
+ */
+export type EmailSubmissionQueryChangesResponseInvocationArgs = BaseQueryChangesResponseInvocationArgs;
+/**
+ * The arguments for creating, updating, and destroying EmailSubmission objects via an
+ * `EmailSubmission/set` call.
+ *
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-7.5 | RFC 8621 Section 7.5: EmailSubmission/set}
+ */
+export type EmailSubmissionSetRequestInvocationArgs = BaseSetRequestInvocationArgs<EmailSubmissionObjectSettable> & {
+    /**
+     * A map of EmailSubmission id to an object containing properties to update on the Email
+     * object referenced by the EmailSubmission if the create/update/destroy succeeds. For
+     * references to EmailSubmissions created in the same `/set` invocation, the id will be
+     * the creation id prefixed with a `#`.
+     */
+    onSuccessUpdateEmail?: Record<Id, PatchObject> | null;
+    /**
+     * A list of EmailSubmission ids for which the Email with the corresponding `emailId`
+     * should be destroyed if the create/update/destroy succeeds. For references to
+     * EmailSubmission creations, the id will be the creation id prefixed with a `#`.
+     */
+    onSuccessDestroyEmail?: Id[] | null;
+};
+/**
+ * The response to an `EmailSubmission/set` call.
+ */
+export type EmailSubmissionSetResponseInvocationArgs = BaseSetResponseInvocationArgs<EmailSubmissionObject>;
+/**
+ * Union type of all EmailSubmission capability request invocation arguments.
+ */
+export type EmailSubmissionRequestInvocationArgs = EmailSubmissionGetRequestInvocationArgs | EmailSubmissionChangesRequestInvocationArgs | EmailSubmissionQueryRequestInvocationArgs | EmailSubmissionQueryChangesRequestInvocationArgs | EmailSubmissionSetRequestInvocationArgs;
+/**
+ * Union type of all EmailSubmission capability response invocation arguments.
+ */
+export type EmailSubmissionResponseInvocationArgs = EmailSubmissionGetResponseInvocationArgs | EmailSubmissionChangesResponseInvocationArgs | EmailSubmissionQueryResponseInvocationArgs | EmailSubmissionQueryChangesResponseInvocationArgs | EmailSubmissionSetResponseInvocationArgs;

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

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

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

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

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

@@ -0,0 +1,80 @@
+import type { JMAPCapability, JMAPMethodName } from "../../common/types.js";
+import { Invocation } from "../../invocation/invocation.js";
+import type { InvocationArgs, InvocationFactory } from "../../invocation/types.js";
+import type { ExampleGetRequestInvocationArgs, ExampleGetResponseInvocationArgs, ExampleInvocationArgs, ExampleQueryRequestInvocationArgs, ExampleSetRequestInvocationArgs, ExampleSetResponseInvocationArgs } from "./types.js";
+/**
+ * ExampleInvocation represents an illustrative example JMAP capability invocation.
+ *
+ * This capability serves as a reference implementation demonstrating how to define custom
+ * invocations in this library. It implements standard JMAP method patterns (echo, get, set, query)
+ * and is used internally for testing the invocation framework, request building, and response handling.
+ *
+ * **Note:** This is not a real JMAP invocation - it exists purely for documentation and testing purposes.
+ */
+export declare class ExampleInvocation<TArgs extends ExampleInvocationArgs> extends Invocation<TArgs> {
+    get uri(): JMAPCapability;
+    /**
+     * Constructs an ExampleInvocation
+     *
+     * @param method The name of the method being invoked (e.g., "echo", "get", "set", "query")
+     * @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 Example invocation factory function for creating invocations of the specified type
+     */
+    static createInvocationFactory<TArgs extends ExampleInvocationArgs>(method: JMAPMethodName): InvocationFactory<TArgs, ExampleInvocation<TArgs>>;
+}
+export declare const Example: {
+    request: {
+        /**
+         * An example echo method that returns the same arguments it receives.
+         *
+         * This method demonstrates a simple request-only pattern used for testing.
+         *
+         * @param args The invocation arguments for Example/echo
+         * @param methodCallId An optional unique symbol to identify this method call for result referencing
+         * @returns An ExampleInvocation representing the Example/echo request
+         */
+        echo: InvocationFactory<import("../../invocation/types.js").BaseInvocationArgs, ExampleInvocation<import("../../invocation/types.js").BaseInvocationArgs>>;
+        /**
+         * An example get method that retrieves Example objects by their IDs.
+         *
+         * This method demonstrates the standard JMAP /get pattern used for testing.
+         *
+         * @param args The invocation arguments for Example/get
+         * @param methodCallId An optional unique symbol to identify this method call for result referencing
+         * @returns An ExampleInvocation representing the Example/get request
+         */
+        get: InvocationFactory<ExampleGetRequestInvocationArgs, ExampleInvocation<ExampleGetRequestInvocationArgs>>;
+        /**
+         * An example set method that creates, updates, or destroys Example objects.
+         *
+         * This method demonstrates the standard JMAP /set pattern used for testing.
+         *
+         * @param args The invocation arguments for Example/set
+         * @param methodCallId An optional unique symbol to identify this method call for result referencing
+         * @returns An ExampleInvocation representing the Example/set request
+         */
+        set: InvocationFactory<ExampleSetRequestInvocationArgs, ExampleInvocation<ExampleSetRequestInvocationArgs>>;
+        /**
+         * An example query method that searches for Example objects matching criteria.
+         *
+         * This method demonstrates the standard JMAP /query pattern used for testing.
+         *
+         * @param args The invocation arguments for Example/query
+         * @param methodCallId An optional unique symbol to identify this method call for result referencing
+         * @returns An ExampleInvocation representing the Example/query request
+         */
+        query: InvocationFactory<ExampleQueryRequestInvocationArgs, ExampleInvocation<ExampleQueryRequestInvocationArgs>>;
+    };
+    response: {
+        get: InvocationFactory<ExampleGetResponseInvocationArgs, ExampleInvocation<ExampleGetResponseInvocationArgs>>;
+        set: InvocationFactory<ExampleSetResponseInvocationArgs, ExampleInvocation<ExampleSetResponseInvocationArgs>>;
+        query: InvocationFactory<import("../../invocation/types.js").BaseQueryResponseInvocationArgs, ExampleInvocation<import("../../invocation/types.js").BaseQueryResponseInvocationArgs>>;
+    };
+};

package/dist/src/capabilities/example/example.js

@@ -0,0 +1,91 @@
+import { Invocation } from "../../invocation/invocation.js";
+/**
+ * ExampleInvocation represents an illustrative example JMAP capability invocation.
+ *
+ * This capability serves as a reference implementation demonstrating how to define custom
+ * invocations in this library. It implements standard JMAP method patterns (echo, get, set, query)
+ * and is used internally for testing the invocation framework, request building, and response handling.
+ *
+ * **Note:** This is not a real JMAP invocation - it exists purely for documentation and testing purposes.
+ */
+export class ExampleInvocation extends Invocation {
+    get uri() {
+        return "urn:example";
+    }
+    /**
+     * Constructs an ExampleInvocation
+     *
+     * @param method The name of the method being invoked (e.g., "echo", "get", "set", "query")
+     * @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("Example", method, args, methodCallId);
+    }
+    /**
+     * Create an invocation factory function
+     *
+     * @param method The name of the method to create
+     * @returns A new Example invocation factory function for creating invocations of the specified type
+     */
+    static createInvocationFactory(method) {
+        /**
+         * An invocation factory function to create an `Example/*` 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 ExampleInvocation(method, args, methodCallId);
+    }
+}
+export const Example = {
+    request: {
+        /**
+         * An example echo method that returns the same arguments it receives.
+         *
+         * This method demonstrates a simple request-only pattern used for testing.
+         *
+         * @param args The invocation arguments for Example/echo
+         * @param methodCallId An optional unique symbol to identify this method call for result referencing
+         * @returns An ExampleInvocation representing the Example/echo request
+         */
+        echo: ExampleInvocation.createInvocationFactory("echo"),
+        /**
+         * An example get method that retrieves Example objects by their IDs.
+         *
+         * This method demonstrates the standard JMAP /get pattern used for testing.
+         *
+         * @param args The invocation arguments for Example/get
+         * @param methodCallId An optional unique symbol to identify this method call for result referencing
+         * @returns An ExampleInvocation representing the Example/get request
+         */
+        get: ExampleInvocation.createInvocationFactory("get"),
+        /**
+         * An example set method that creates, updates, or destroys Example objects.
+         *
+         * This method demonstrates the standard JMAP /set pattern used for testing.
+         *
+         * @param args The invocation arguments for Example/set
+         * @param methodCallId An optional unique symbol to identify this method call for result referencing
+         * @returns An ExampleInvocation representing the Example/set request
+         */
+        set: ExampleInvocation.createInvocationFactory("set"),
+        /**
+         * An example query method that searches for Example objects matching criteria.
+         *
+         * This method demonstrates the standard JMAP /query pattern used for testing.
+         *
+         * @param args The invocation arguments for Example/query
+         * @param methodCallId An optional unique symbol to identify this method call for result referencing
+         * @returns An ExampleInvocation representing the Example/query request
+         */
+        query: ExampleInvocation.createInvocationFactory("query"),
+    },
+    response: {
+        get: ExampleInvocation.createInvocationFactory("get"),
+        set: ExampleInvocation.createInvocationFactory("set"),
+        query: ExampleInvocation.createInvocationFactory("query"),
+    },
+};
+//# sourceMappingURL=example.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"example.js","sourceRoot":"","sources":["../../../../src/capabilities/example/example.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AAa5D;;;;;;;;GAQG;AACH,MAAM,OAAO,iBAAuD,SAAQ,UAAiB;IACzF,IAAI,GAAG;QACH,OAAO,aAAa,CAAC;IACzB,CAAC;IAED;;;;;;OAMG;IACH,YAAY,MAAsB,EAAE,IAA2B,EAAE,YAAqB;QAClF,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;IACjD,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,uBAAuB,CAC1B,MAAsB;QAEtB;;;;;;WAMG;QACH,OAAO,CAAC,IAAI,EAAE,YAAY,EAAE,EAAE,CAAC,IAAI,iBAAiB,CAAQ,MAAM,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;IAC5F,CAAC;CACJ;AAED,MAAM,CAAC,MAAM,OAAO,GAAG;IACnB,OAAO,EAAE;QACL;;;;;;;;WAQG;QACH,IAAI,EAAE,iBAAiB,CAAC,uBAAuB,CAAmC,MAAM,CAAC;QACzF;;;;;;;;WAQG;QACH,GAAG,EAAE,iBAAiB,CAAC,uBAAuB,CAAkC,KAAK,CAAC;QACtF;;;;;;;;WAQG;QACH,GAAG,EAAE,iBAAiB,CAAC,uBAAuB,CAAkC,KAAK,CAAC;QACtF;;;;;;;;WAQG;QACH,KAAK,EAAE,iBAAiB,CAAC,uBAAuB,CAAoC,OAAO,CAAC;KAC/F;IACD,QAAQ,EAAE;QACN,GAAG,EAAE,iBAAiB,CAAC,uBAAuB,CAAmC,KAAK,CAAC;QACvF,GAAG,EAAE,iBAAiB,CAAC,uBAAuB,CAAmC,KAAK,CAAC;QACvF,KAAK,EAAE,iBAAiB,CAAC,uBAAuB,CAAqC,OAAO,CAAC;KAChG;CACkC,CAAC"}

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

@@ -0,0 +1,33 @@
+import type { BaseFilterCondition, BaseGetRequestInvocationArgs, BaseGetResponseInvocationArgs, BaseInvocationArgs, BaseQueryRequestInvocationArgs, BaseQueryResponseInvocationArgs, BaseSetRequestInvocationArgs, BaseSetResponseInvocationArgs } from "../../invocation/types.js";
+/**
+ * The arguments for an Example/echo request invocation (illustrative example)
+ */
+export type ExampleEchoRequestInvocationArgs = BaseInvocationArgs;
+/**
+ * The arguments for an Example/get request invocation (illustrative example)
+ */
+export type ExampleGetRequestInvocationArgs = BaseGetRequestInvocationArgs<BaseInvocationArgs>;
+/**
+ * The arguments for an Example/set request invocation (illustrative example)
+ */
+export type ExampleSetRequestInvocationArgs = BaseSetRequestInvocationArgs<BaseInvocationArgs>;
+/**
+ * The arguments for an Example/query request invocation (illustrative example)
+ */
+export type ExampleQueryRequestInvocationArgs = BaseQueryRequestInvocationArgs<BaseInvocationArgs, BaseFilterCondition>;
+/**
+ * The response arguments for an Example/get response invocation (illustrative example)
+ */
+export type ExampleGetResponseInvocationArgs = BaseGetResponseInvocationArgs<BaseInvocationArgs>;
+/**
+ * The response arguments for an Example/set response invocation (illustrative example)
+ */
+export type ExampleSetResponseInvocationArgs = BaseSetResponseInvocationArgs<BaseInvocationArgs>;
+/**
+ * The response arguments for an Example/query response invocation (illustrative example)
+ */
+export type ExampleQueryResponseInvocationArgs = BaseQueryResponseInvocationArgs;
+/**
+ * Union type of all Example capability invocation arguments (request and response, illustrative example)
+ */
+export type ExampleInvocationArgs = ExampleEchoRequestInvocationArgs | ExampleGetRequestInvocationArgs | ExampleSetRequestInvocationArgs | ExampleQueryRequestInvocationArgs | ExampleGetResponseInvocationArgs | ExampleSetResponseInvocationArgs | ExampleQueryResponseInvocationArgs;

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

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

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

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