jmap-kit 0.0.0 → 1.0.2

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

@@ -0,0 +1,124 @@
+import type { JMAPCapability, JMAPMethodName } from "../../common/types.js";
+import { Invocation } from "../../invocation/invocation.js";
+import type { InvocationArgs, InvocationFactory } from "../../invocation/types.js";
+import type { EmailCopyRequestInvocationArgs, EmailCopyResponseInvocationArgs, EmailGetRequestInvocationArgs, EmailGetResponseInvocationArgs, EmailImportRequestInvocationArgs, EmailImportResponseInvocationArgs, EmailParseRequestInvocationArgs, EmailParseResponseInvocationArgs, EmailQueryChangesRequestInvocationArgs, EmailQueryRequestInvocationArgs, EmailRequestInvocationArgs, EmailResponseInvocationArgs, EmailSetRequestInvocationArgs, EmailSetResponseInvocationArgs } from "./types.js";
+/**
+ * EmailInvocation represents a JMAP Email capability invocation.
+ *
+ * The Email data type represents email messages as defined in RFC 8621. It supports standard
+ * JMAP methods for retrieving, querying, copying, modifying, importing, and parsing email messages.
+ *
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-4 | RFC 8621 Section 4: Emails}
+ */
+export declare class EmailInvocation<TArgs extends EmailRequestInvocationArgs> extends Invocation<TArgs> {
+    get uri(): JMAPCapability;
+    /**
+     * Constructs an EmailInvocation
+     *
+     * @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: JMAPMethodName, args: InvocationArgs<TArgs>, methodCallId?: symbol);
+    /**
+     * Create an invocation factory function
+     *
+     * @param method The name of the method to create
+     * @returns A new Email invocation factory function for creating invocations of the specified type
+     */
+    static createInvocationFactory<TArgs extends EmailRequestInvocationArgs | EmailResponseInvocationArgs>(method: JMAPMethodName): InvocationFactory<TArgs, EmailInvocation<TArgs>>;
+}
+export declare const Email: {
+    request: {
+        /**
+         * Retrieves Email objects by their IDs.
+         *
+         * @param args The invocation arguments for Email/get
+         * @param methodCallId An optional unique symbol to identify this method call for result referencing
+         * @returns An EmailInvocation representing the Email/get request
+         *
+         * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-4.2 | RFC 8621 Section 4.2: Email/get}
+         */
+        get: InvocationFactory<EmailGetRequestInvocationArgs, EmailInvocation<EmailGetRequestInvocationArgs>>;
+        /**
+         * Returns changes to Email objects since a given state.
+         *
+         * @param args The invocation arguments for Email/changes
+         * @param methodCallId An optional unique symbol to identify this method call for result referencing
+         * @returns An EmailInvocation representing the Email/changes request
+         *
+         * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-4.3 | RFC 8621 Section 4.3: Email/changes}
+         */
+        changes: InvocationFactory<import("../../invocation/types.js").BaseChangesRequestInvocationArgs, EmailInvocation<import("../../invocation/types.js").BaseChangesRequestInvocationArgs>>;
+        /**
+         * Queries for Email objects matching specified criteria.
+         *
+         * @param args The invocation arguments for Email/query
+         * @param methodCallId An optional unique symbol to identify this method call for result referencing
+         * @returns An EmailInvocation representing the Email/query request
+         *
+         * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-4.4 | RFC 8621 Section 4.4: Email/query}
+         */
+        query: InvocationFactory<EmailQueryRequestInvocationArgs, EmailInvocation<EmailQueryRequestInvocationArgs>>;
+        /**
+         * Returns changes to a query result since a given state.
+         *
+         * @param args The invocation arguments for Email/queryChanges
+         * @param methodCallId An optional unique symbol to identify this method call for result referencing
+         * @returns An EmailInvocation representing the Email/queryChanges request
+         *
+         * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-4.5 | RFC 8621 Section 4.5: Email/queryChanges}
+         */
+        queryChanges: InvocationFactory<EmailQueryChangesRequestInvocationArgs, EmailInvocation<EmailQueryChangesRequestInvocationArgs>>;
+        /**
+         * Copies Email objects from one account to another.
+         *
+         * @param args The invocation arguments for Email/copy
+         * @param methodCallId An optional unique symbol to identify this method call for result referencing
+         * @returns An EmailInvocation representing the Email/copy request
+         *
+         * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-4.7 | RFC 8621 Section 4.7: Email/copy}
+         */
+        copy: InvocationFactory<EmailCopyRequestInvocationArgs, EmailInvocation<EmailCopyRequestInvocationArgs>>;
+        /**
+         * Creates, updates, or destroys Email objects.
+         *
+         * @param args The invocation arguments for Email/set
+         * @param methodCallId An optional unique symbol to identify this method call for result referencing
+         * @returns An EmailInvocation representing the Email/set request
+         *
+         * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-4.6 | RFC 8621 Section 4.6: Email/set}
+         */
+        set: InvocationFactory<EmailSetRequestInvocationArgs, EmailInvocation<EmailSetRequestInvocationArgs>>;
+        /**
+         * Imports email messages from raw RFC 5322 message data.
+         *
+         * @param args The invocation arguments for Email/import
+         * @param methodCallId An optional unique symbol to identify this method call for result referencing
+         * @returns An EmailInvocation representing the Email/import request
+         *
+         * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-4.8 | RFC 8621 Section 4.8: Email/import}
+         */
+        import: InvocationFactory<EmailImportRequestInvocationArgs, EmailInvocation<EmailImportRequestInvocationArgs>>;
+        /**
+         * Parses email messages to extract structured information without importing them.
+         *
+         * @param args The invocation arguments for Email/parse
+         * @param methodCallId An optional unique symbol to identify this method call for result referencing
+         * @returns An EmailInvocation representing the Email/parse request
+         *
+         * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-4.9 | RFC 8621 Section 4.9: Email/parse}
+         */
+        parse: InvocationFactory<EmailParseRequestInvocationArgs, EmailInvocation<EmailParseRequestInvocationArgs>>;
+    };
+    response: {
+        get: InvocationFactory<EmailGetResponseInvocationArgs, EmailInvocation<EmailGetResponseInvocationArgs>>;
+        changes: InvocationFactory<import("../../invocation/types.js").BaseChangesResponseInvocationArgs, EmailInvocation<import("../../invocation/types.js").BaseChangesResponseInvocationArgs>>;
+        query: InvocationFactory<import("../../invocation/types.js").BaseQueryResponseInvocationArgs, EmailInvocation<import("../../invocation/types.js").BaseQueryResponseInvocationArgs>>;
+        queryChanges: InvocationFactory<import("../../invocation/types.js").BaseQueryChangesResponseInvocationArgs, EmailInvocation<import("../../invocation/types.js").BaseQueryChangesResponseInvocationArgs>>;
+        copy: InvocationFactory<EmailCopyResponseInvocationArgs, EmailInvocation<EmailCopyResponseInvocationArgs>>;
+        set: InvocationFactory<EmailSetResponseInvocationArgs, EmailInvocation<EmailSetResponseInvocationArgs>>;
+        import: InvocationFactory<EmailImportResponseInvocationArgs, EmailInvocation<EmailImportResponseInvocationArgs>>;
+        parse: InvocationFactory<EmailParseResponseInvocationArgs, EmailInvocation<EmailParseResponseInvocationArgs>>;
+    };
+};

package/dist/src/capabilities/email/email.js

@@ -0,0 +1,136 @@
+import { EMAIL_CAPABILITY_URI } from "../../common/registry.js";
+import { Invocation } from "../../invocation/invocation.js";
+/**
+ * EmailInvocation represents a JMAP Email capability invocation.
+ *
+ * The Email data type represents email messages as defined in RFC 8621. It supports standard
+ * JMAP methods for retrieving, querying, copying, modifying, importing, and parsing email messages.
+ *
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-4 | RFC 8621 Section 4: Emails}
+ */
+export class EmailInvocation extends Invocation {
+    get uri() {
+        return EMAIL_CAPABILITY_URI;
+    }
+    /**
+     * Constructs an EmailInvocation
+     *
+     * @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("Email", method, args, methodCallId);
+    }
+    /**
+     * Create an invocation factory function
+     *
+     * @param method The name of the method to create
+     * @returns A new Email invocation factory function for creating invocations of the specified type
+     */
+    static createInvocationFactory(method) {
+        /**
+         * An invocation factory function to create a `Email/*` 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 EmailInvocation(method, args, methodCallId);
+    }
+}
+export const Email = {
+    request: {
+        /**
+         * Retrieves Email objects by their IDs.
+         *
+         * @param args The invocation arguments for Email/get
+         * @param methodCallId An optional unique symbol to identify this method call for result referencing
+         * @returns An EmailInvocation representing the Email/get request
+         *
+         * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-4.2 | RFC 8621 Section 4.2: Email/get}
+         */
+        get: EmailInvocation.createInvocationFactory("get"),
+        /**
+         * Returns changes to Email objects since a given state.
+         *
+         * @param args The invocation arguments for Email/changes
+         * @param methodCallId An optional unique symbol to identify this method call for result referencing
+         * @returns An EmailInvocation representing the Email/changes request
+         *
+         * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-4.3 | RFC 8621 Section 4.3: Email/changes}
+         */
+        changes: EmailInvocation.createInvocationFactory("changes"),
+        /**
+         * Queries for Email objects matching specified criteria.
+         *
+         * @param args The invocation arguments for Email/query
+         * @param methodCallId An optional unique symbol to identify this method call for result referencing
+         * @returns An EmailInvocation representing the Email/query request
+         *
+         * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-4.4 | RFC 8621 Section 4.4: Email/query}
+         */
+        query: EmailInvocation.createInvocationFactory("query"),
+        /**
+         * Returns changes to a query result since a given state.
+         *
+         * @param args The invocation arguments for Email/queryChanges
+         * @param methodCallId An optional unique symbol to identify this method call for result referencing
+         * @returns An EmailInvocation representing the Email/queryChanges request
+         *
+         * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-4.5 | RFC 8621 Section 4.5: Email/queryChanges}
+         */
+        queryChanges: EmailInvocation.createInvocationFactory("queryChanges"),
+        /**
+         * Copies Email objects from one account to another.
+         *
+         * @param args The invocation arguments for Email/copy
+         * @param methodCallId An optional unique symbol to identify this method call for result referencing
+         * @returns An EmailInvocation representing the Email/copy request
+         *
+         * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-4.7 | RFC 8621 Section 4.7: Email/copy}
+         */
+        copy: EmailInvocation.createInvocationFactory("copy"),
+        /**
+         * Creates, updates, or destroys Email objects.
+         *
+         * @param args The invocation arguments for Email/set
+         * @param methodCallId An optional unique symbol to identify this method call for result referencing
+         * @returns An EmailInvocation representing the Email/set request
+         *
+         * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-4.6 | RFC 8621 Section 4.6: Email/set}
+         */
+        set: EmailInvocation.createInvocationFactory("set"),
+        /**
+         * Imports email messages from raw RFC 5322 message data.
+         *
+         * @param args The invocation arguments for Email/import
+         * @param methodCallId An optional unique symbol to identify this method call for result referencing
+         * @returns An EmailInvocation representing the Email/import request
+         *
+         * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-4.8 | RFC 8621 Section 4.8: Email/import}
+         */
+        import: EmailInvocation.createInvocationFactory("import"),
+        /**
+         * Parses email messages to extract structured information without importing them.
+         *
+         * @param args The invocation arguments for Email/parse
+         * @param methodCallId An optional unique symbol to identify this method call for result referencing
+         * @returns An EmailInvocation representing the Email/parse request
+         *
+         * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-4.9 | RFC 8621 Section 4.9: Email/parse}
+         */
+        parse: EmailInvocation.createInvocationFactory("parse"),
+    },
+    response: {
+        get: EmailInvocation.createInvocationFactory("get"),
+        changes: EmailInvocation.createInvocationFactory("changes"),
+        query: EmailInvocation.createInvocationFactory("query"),
+        queryChanges: EmailInvocation.createInvocationFactory("queryChanges"),
+        copy: EmailInvocation.createInvocationFactory("copy"),
+        set: EmailInvocation.createInvocationFactory("set"),
+        import: EmailInvocation.createInvocationFactory("import"),
+        parse: EmailInvocation.createInvocationFactory("parse"),
+    },
+};
+//# sourceMappingURL=email.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"email.js","sourceRoot":"","sources":["../../../../src/capabilities/email/email.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAEhE,OAAO,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AAuB5D;;;;;;;GAOG;AACH,MAAM,OAAO,eAA0D,SAAQ,UAAiB;IAC5F,IAAI,GAAG;QACH,OAAO,oBAAoB,CAAC;IAChC,CAAC;IAED;;;;;;OAMG;IACH,YAAY,MAAsB,EAAE,IAA2B,EAAE,YAAqB;QAClF,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;IAC/C,CAAC;IACD;;;;;OAKG;IACH,MAAM,CAAC,uBAAuB,CAC1B,MAAsB;QAEtB;;;;;;WAMG;QACH,OAAO,CAAC,IAAI,EAAE,YAAY,EAAE,EAAE,CAAC,IAAI,eAAe,CAAQ,MAAM,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;IAC1F,CAAC;CACJ;AAED,MAAM,CAAC,MAAM,KAAK,GAAG;IACjB,OAAO,EAAE;QACL;;;;;;;;WAQG;QACH,GAAG,EAAE,eAAe,CAAC,uBAAuB,CAAgC,KAAK,CAAC;QAClF;;;;;;;;WAQG;QACH,OAAO,EAAE,eAAe,CAAC,uBAAuB,CAAoC,SAAS,CAAC;QAC9F;;;;;;;;WAQG;QACH,KAAK,EAAE,eAAe,CAAC,uBAAuB,CAAkC,OAAO,CAAC;QACxF;;;;;;;;WAQG;QACH,YAAY,EAAE,eAAe,CAAC,uBAAuB,CAAyC,cAAc,CAAC;QAC7G;;;;;;;;WAQG;QACH,IAAI,EAAE,eAAe,CAAC,uBAAuB,CAAiC,MAAM,CAAC;QACrF;;;;;;;;WAQG;QACH,GAAG,EAAE,eAAe,CAAC,uBAAuB,CAAgC,KAAK,CAAC;QAClF;;;;;;;;WAQG;QACH,MAAM,EAAE,eAAe,CAAC,uBAAuB,CAAmC,QAAQ,CAAC;QAC3F;;;;;;;;WAQG;QACH,KAAK,EAAE,eAAe,CAAC,uBAAuB,CAAkC,OAAO,CAAC;KAC3F;IACD,QAAQ,EAAE;QACN,GAAG,EAAE,eAAe,CAAC,uBAAuB,CAAiC,KAAK,CAAC;QACnF,OAAO,EAAE,eAAe,CAAC,uBAAuB,CAAqC,SAAS,CAAC;QAC/F,KAAK,EAAE,eAAe,CAAC,uBAAuB,CAAmC,OAAO,CAAC;QACzF,YAAY,EAAE,eAAe,CAAC,uBAAuB,CAA0C,cAAc,CAAC;QAC9G,IAAI,EAAE,eAAe,CAAC,uBAAuB,CAAkC,MAAM,CAAC;QACtF,GAAG,EAAE,eAAe,CAAC,uBAAuB,CAAiC,KAAK,CAAC;QACnF,MAAM,EAAE,eAAe,CAAC,uBAAuB,CAAoC,QAAQ,CAAC;QAC5F,KAAK,EAAE,eAAe,CAAC,uBAAuB,CAAmC,OAAO,CAAC;KAC5F;CACkC,CAAC"}