jmap-kit 0.0.0 → 1.0.2

package/dist/src/capabilities/thread/thread.js

@@ -0,0 +1,70 @@
+import { EMAIL_CAPABILITY_URI } from "../../common/registry.js";
+import { Invocation } from "../../invocation/invocation.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 class ThreadInvocation extends Invocation {
+    get uri() {
+        return EMAIL_CAPABILITY_URI;
+    }
+    /**
+     * 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, args, methodCallId) {
+        super("Thread", method, args, methodCallId);
+    }
+    /**
+     * 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(method) {
+        /**
+         * An invocation factory function to create a `Thread/{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 ThreadInvocation(method, args, methodCallId);
+    }
+}
+export 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: ThreadInvocation.createInvocationFactory("get"),
+        /**
+         * 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: ThreadInvocation.createInvocationFactory("changes"),
+    },
+    response: {
+        get: ThreadInvocation.createInvocationFactory("get"),
+        changes: ThreadInvocation.createInvocationFactory("changes"),
+    },
+};
+//# sourceMappingURL=thread.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"thread.js","sourceRoot":"","sources":["../../../../src/capabilities/thread/thread.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAEhE,OAAO,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AAW5D;;;;;;;GAOG;AACH,MAAM,OAAO,gBAEX,SAAQ,UAAiB;IACvB,IAAI,GAAG;QACH,OAAO,oBAAoB,CAAC;IAChC,CAAC;IAED;;;;;;OAMG;IACH,YAAY,MAAsB,EAAE,IAA2B,EAAE,YAAqB;QAClF,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;IAChD,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,uBAAuB,CAC1B,MAAsB;QAEtB;;;;;;WAMG;QACH,OAAO,CAAC,IAAI,EAAE,YAAY,EAAE,EAAE,CAAC,IAAI,gBAAgB,CAAQ,MAAM,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;IAC3F,CAAC;CACJ;AAED,MAAM,CAAC,MAAM,MAAM,GAAG;IAClB,OAAO,EAAE;QACL;;;;;;;;WAQG;QACH,GAAG,EAAE,gBAAgB,CAAC,uBAAuB,CAAiC,KAAK,CAAC;QACpF;;;;;;;;WAQG;QACH,OAAO,EAAE,gBAAgB,CAAC,uBAAuB,CAAqC,SAAS,CAAC;KACnG;IACD,QAAQ,EAAE;QACN,GAAG,EAAE,gBAAgB,CAAC,uBAAuB,CAAkC,KAAK,CAAC;QACrF,OAAO,EAAE,gBAAgB,CAAC,uBAAuB,CAAsC,SAAS,CAAC;KACpG;CACkC,CAAC"}

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

@@ -0,0 +1,43 @@
+import type { Id } from "../../common/types.js";
+import type { BaseChangesRequestInvocationArgs, BaseChangesResponseInvocationArgs, BaseGetRequestInvocationArgs, BaseGetResponseInvocationArgs } from "../../invocation/types.js";
+/**
+ * ThreadObject properties set by the server.
+ */
+export type ThreadObjectServerSet = Readonly<{
+    /**
+     * (immutable) The id of the Thread.
+     */
+    id: Id;
+    /**
+     * The ids of the Emails in the Thread, sorted by the receivedAt date of the Email, oldest first.
+     */
+    emailIds: Id[];
+}>;
+/**
+ * Properties of the Thread object.
+ */
+export type ThreadObject = ThreadObjectServerSet;
+/**
+ * The arguments for fetching Thread objects via a Thread/get call
+ */
+export type ThreadGetRequestInvocationArgs = BaseGetRequestInvocationArgs<ThreadObject>;
+/**
+ * The response to a `Thread/get` call
+ */
+export type ThreadGetResponseInvocationArgs = BaseGetResponseInvocationArgs<ThreadObject>;
+/**
+ * The arguments for fetching Thread changes via a `Thread/changes` call
+ */
+export type ThreadChangesRequestInvocationArgs = BaseChangesRequestInvocationArgs;
+/**
+ * The response to a `Thread/changes` call
+ */
+export type ThreadChangesResponseInvocationArgs = BaseChangesResponseInvocationArgs;
+/**
+ * Union type of all Thread capability request invocation arguments
+ */
+export type ThreadRequestInvocationArgs = ThreadGetRequestInvocationArgs | ThreadChangesRequestInvocationArgs;
+/**
+ * Union type of all Thread capability response invocation arguments
+ */
+export type ThreadResponseInvocationArgs = ThreadGetResponseInvocationArgs | ThreadChangesResponseInvocationArgs;

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

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

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

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

package/dist/src/capabilities/utils/assert-invocation-datatype.d.ts

@@ -0,0 +1,7 @@
+import type { JMAPDataType } from "../../common/types.js";
+import { Invocation } from "../../invocation/invocation.js";
+import type { BaseInvocationArgs } from "../../invocation/types.js";
+/**
+ * Type assertion function to ensure an invocation has the specified method
+ */
+export declare function assertInvocationDataType<T extends BaseInvocationArgs>(invocation: Invocation<T>, dataType: JMAPDataType): asserts invocation is Invocation<T>;

package/dist/src/capabilities/utils/assert-invocation-datatype.js

@@ -0,0 +1,13 @@
+import { Invocation } from "../../invocation/invocation.js";
+/**
+ * Type assertion function to ensure an invocation has the specified method
+ */
+export function assertInvocationDataType(invocation, dataType) {
+    if (!(invocation instanceof Invocation)) {
+        throw new TypeError(`Invocation is required for ${dataType} requests`);
+    }
+    if (invocation.dataType !== dataType) {
+        throw new Error(`Expected invocation dataType to be '${dataType}', but got '${invocation.dataType}'`);
+    }
+}
+//# sourceMappingURL=assert-invocation-datatype.js.map

package/dist/src/capabilities/utils/assert-invocation-datatype.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"assert-invocation-datatype.js","sourceRoot":"","sources":["../../../../src/capabilities/utils/assert-invocation-datatype.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AAG5D;;GAEG;AACH,MAAM,UAAU,wBAAwB,CACpC,UAAyB,EACzB,QAAsB;IAEtB,IAAI,CAAC,CAAC,UAAU,YAAY,UAAU,CAAC,EAAE,CAAC;QACtC,MAAM,IAAI,SAAS,CAAC,8BAA8B,QAAQ,WAAW,CAAC,CAAC;IAC3E,CAAC;IAED,IAAI,UAAU,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;QACnC,MAAM,IAAI,KAAK,CAAC,uCAAuC,QAAQ,eAAe,UAAU,CAAC,QAAQ,GAAG,CAAC,CAAC;IAC1G,CAAC;AACL,CAAC"}

package/dist/src/capabilities/utils/assert-invocation-method.d.ts

@@ -0,0 +1,7 @@
+import type { JMAPMethodName } from "../../common/types.js";
+import { Invocation } from "../../invocation/invocation.js";
+import type { BaseInvocationArgs } from "../../invocation/types.js";
+/**
+ * Type assertion function to ensure an invocation has the specified method
+ */
+export declare function assertInvocationMethod<T extends BaseInvocationArgs>(invocation: Invocation<T>, method: JMAPMethodName): asserts invocation is Invocation<T>;

package/dist/src/capabilities/utils/assert-invocation-method.js

@@ -0,0 +1,13 @@
+import { Invocation } from "../../invocation/invocation.js";
+/**
+ * Type assertion function to ensure an invocation has the specified method
+ */
+export function assertInvocationMethod(invocation, method) {
+    if (!(invocation instanceof Invocation)) {
+        throw new TypeError(`Invocation is required for ${method} requests`);
+    }
+    if (invocation.method !== method) {
+        throw new Error(`Expected invocation method to be '${method}', but got '${invocation.method}'`);
+    }
+}
+//# sourceMappingURL=assert-invocation-method.js.map

package/dist/src/capabilities/utils/assert-invocation-method.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"assert-invocation-method.js","sourceRoot":"","sources":["../../../../src/capabilities/utils/assert-invocation-method.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AAG5D;;GAEG;AACH,MAAM,UAAU,sBAAsB,CAClC,UAAyB,EACzB,MAAsB;IAEtB,IAAI,CAAC,CAAC,UAAU,YAAY,UAAU,CAAC,EAAE,CAAC;QACtC,MAAM,IAAI,SAAS,CAAC,8BAA8B,MAAM,WAAW,CAAC,CAAC;IACzE,CAAC;IAED,IAAI,UAAU,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;QAC/B,MAAM,IAAI,KAAK,CAAC,qCAAqC,MAAM,eAAe,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC;IACpG,CAAC;AACL,CAAC"}

package/dist/src/capabilities/utils/assert-invocation.d.ts

@@ -0,0 +1,7 @@
+import type { JMAPDataType, JMAPMethodName } from "../../common/types.js";
+import type { Invocation } from "../../invocation/invocation.js";
+import type { BaseInvocationArgs } from "../../invocation/types.js";
+/**
+ * Type assertion function to ensure an invocation has the specified method
+ */
+export declare function assertInvocation<T extends BaseInvocationArgs>(invocation: Invocation<T>, dataType: JMAPDataType, method: JMAPMethodName): asserts invocation is Invocation<T>;

package/dist/src/capabilities/utils/assert-invocation.js

@@ -0,0 +1,22 @@
+import { assertInvocationDataType } from "./assert-invocation-datatype.js";
+import { assertInvocationMethod } from "./assert-invocation-method.js";
+/**
+ * Type assertion function to ensure an invocation has the specified method
+ */
+export function assertInvocation(invocation, dataType, method) {
+    try {
+        assertInvocationDataType(invocation, dataType);
+        assertInvocationMethod(invocation, method);
+    }
+    catch (err) {
+        if (err instanceof TypeError) {
+            throw err;
+        }
+        else {
+            throw new Error(`Expected invocation to be "${dataType}/${method}", but got "${invocation.name}"`, {
+                cause: err,
+            });
+        }
+    }
+}
+//# sourceMappingURL=assert-invocation.js.map

package/dist/src/capabilities/utils/assert-invocation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"assert-invocation.js","sourceRoot":"","sources":["../../../../src/capabilities/utils/assert-invocation.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,wBAAwB,EAAE,MAAM,iCAAiC,CAAC;AAC3E,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AAEvE;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAC5B,UAAyB,EACzB,QAAsB,EACtB,MAAsB;IAEtB,IAAI,CAAC;QACD,wBAAwB,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QAC/C,sBAAsB,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IAC/C,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACX,IAAI,GAAG,YAAY,SAAS,EAAE,CAAC;YAC3B,MAAM,GAAG,CAAC;QACd,CAAC;aAAM,CAAC;YACJ,MAAM,IAAI,KAAK,CAAC,8BAA8B,QAAQ,IAAI,MAAM,eAAe,UAAU,CAAC,IAAI,GAAG,EAAE;gBAC/F,KAAK,EAAE,GAAY;aACtB,CAAC,CAAC;QACP,CAAC;IACL,CAAC;AACL,CAAC"}

package/dist/src/capabilities/utils/assert-non-nullish.d.ts

@@ -0,0 +1 @@
+export declare function assertNonNullish<T>(value: T, label: string): asserts value is NonNullable<T>;

package/dist/src/capabilities/utils/assert-non-nullish.js

@@ -0,0 +1,6 @@
+export function assertNonNullish(value, label) {
+    if (value === null || value === undefined) {
+        throw new Error(`${label} is null or undefined`);
+    }
+}
+//# sourceMappingURL=assert-non-nullish.js.map

package/dist/src/capabilities/utils/assert-non-nullish.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"assert-non-nullish.js","sourceRoot":"","sources":["../../../../src/capabilities/utils/assert-non-nullish.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,gBAAgB,CAAI,KAAQ,EAAE,KAAa;IACvD,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxC,MAAM,IAAI,KAAK,CAAC,GAAG,KAAK,uBAAuB,CAAC,CAAC;IACrD,CAAC;AACL,CAAC"}

package/dist/src/capabilities/utils/create-readonly-account-validator.d.ts

@@ -0,0 +1,49 @@
+import type { ValidationPlugin, ValidationPluginTrigger } from "../../capability-registry/types.js";
+import type { Id } from "../../common/types.js";
+import type { BaseInvocationArgs } from "../../invocation/types.js";
+/**
+ * Factory function to create read-only account validation plugins.
+ *
+ * This factory reduces code duplication by centralising the common pattern of validating
+ * that an account is not read-only before allowing write operations.
+ *
+ * The factory automatically asserts the invocation type based on the trigger configuration:
+ * - If both `dataType` and `method` are specified, uses `assertInvocation()`
+ * - If only `method` is specified, uses `assertInvocationMethod()`
+ * - If only `dataType` is specified, uses `assertInvocationDataType()`
+ *
+ * @param config - Configuration for the validator
+ * @param config.name - Unique name for the validation plugin
+ * @param config.trigger - Trigger conditions defining when the validator runs
+ *
+ * @returns A ValidationPlugin that checks if the account is read-only
+ *
+ * @example
+ * ```typescript
+ * // For a specific method call like Blob/upload
+ * const validator = createReadOnlyAccountValidator({
+ *   name: "blob-prevent-upload-on-readonly-account",
+ *   trigger: { dataType: "Blob", method: "upload" },
+ * });
+ *
+ * // For all methods of a data type
+ * const validator = createReadOnlyAccountValidator({
+ *   name: "example-prevent-write-on-readonly",
+ *   trigger: { dataType: "Example" },
+ * });
+ *
+ * // For a specific method across data types
+ * const validator = createReadOnlyAccountValidator({
+ *   name: "prevent-set-on-readonly",
+ *   trigger: { method: "set" },
+ * });
+ * ```
+ */
+export declare function createReadOnlyAccountValidator<TArgs extends BaseInvocationArgs & {
+    accountId: Id;
+} = BaseInvocationArgs & {
+    accountId: Id;
+}>(config: {
+    name: string;
+    trigger: ValidationPluginTrigger<"invocation">;
+}): ValidationPlugin<"invocation", TArgs>;

package/dist/src/capabilities/utils/create-readonly-account-validator.js

@@ -0,0 +1,80 @@
+import { assertInvocationDataType } from "./assert-invocation-datatype.js";
+import { assertInvocationMethod } from "./assert-invocation-method.js";
+import { assertInvocation } from "./assert-invocation.js";
+/**
+ * Factory function to create read-only account validation plugins.
+ *
+ * This factory reduces code duplication by centralising the common pattern of validating
+ * that an account is not read-only before allowing write operations.
+ *
+ * The factory automatically asserts the invocation type based on the trigger configuration:
+ * - If both `dataType` and `method` are specified, uses `assertInvocation()`
+ * - If only `method` is specified, uses `assertInvocationMethod()`
+ * - If only `dataType` is specified, uses `assertInvocationDataType()`
+ *
+ * @param config - Configuration for the validator
+ * @param config.name - Unique name for the validation plugin
+ * @param config.trigger - Trigger conditions defining when the validator runs
+ *
+ * @returns A ValidationPlugin that checks if the account is read-only
+ *
+ * @example
+ * ```typescript
+ * // For a specific method call like Blob/upload
+ * const validator = createReadOnlyAccountValidator({
+ *   name: "blob-prevent-upload-on-readonly-account",
+ *   trigger: { dataType: "Blob", method: "upload" },
+ * });
+ *
+ * // For all methods of a data type
+ * const validator = createReadOnlyAccountValidator({
+ *   name: "example-prevent-write-on-readonly",
+ *   trigger: { dataType: "Example" },
+ * });
+ *
+ * // For a specific method across data types
+ * const validator = createReadOnlyAccountValidator({
+ *   name: "prevent-set-on-readonly",
+ *   trigger: { method: "set" },
+ * });
+ * ```
+ */
+export function createReadOnlyAccountValidator(config) {
+    return {
+        name: config.name,
+        hook: "invocation",
+        trigger: config.trigger,
+        validate(context) {
+            const { invocation, accounts } = context;
+            // Assert invocation type based on trigger configuration
+            if (config.trigger.dataType && config.trigger.method) {
+                assertInvocation(invocation, config.trigger.dataType, config.trigger.method);
+            }
+            else if (config.trigger.method) {
+                assertInvocationMethod(invocation, config.trigger.method);
+            }
+            else if (config.trigger.dataType) {
+                assertInvocationDataType(invocation, config.trigger.dataType);
+            }
+            else {
+                throw new Error(`Read-only account validator "${config.name}" must have at least a dataType or method trigger`);
+            }
+            const accountId = invocation.getArgument("accountId");
+            const account = accountId in accounts ? accounts[accountId] : undefined;
+            if (!account) {
+                return {
+                    valid: false,
+                    errors: [new Error(`Account "${accountId}" does not exist.`)],
+                };
+            }
+            if (account.isReadOnly) {
+                return {
+                    valid: false,
+                    errors: [new Error(`Account "${accountId}" is read-only`)],
+                };
+            }
+            return { valid: true };
+        },
+    };
+}
+//# sourceMappingURL=create-readonly-account-validator.js.map

package/dist/src/capabilities/utils/create-readonly-account-validator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-readonly-account-validator.js","sourceRoot":"","sources":["../../../../src/capabilities/utils/create-readonly-account-validator.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,wBAAwB,EAAE,MAAM,iCAAiC,CAAC;AAC3E,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AACvE,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE1D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,MAAM,UAAU,8BAA8B,CAE5C,MAAwE;IACtE,OAAO;QACH,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,IAAI,EAAE,YAAY;QAClB,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,QAAQ,CAAC,OAAO;YACZ,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC;YAEzC,wDAAwD;YACxD,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;gBACnD,gBAAgB,CAAC,UAAU,EAAE,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACjF,CAAC;iBAAM,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;gBAC/B,sBAAsB,CAAC,UAAU,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAC9D,CAAC;iBAAM,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;gBACjC,wBAAwB,CAAC,UAAU,EAAE,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YAClE,CAAC;iBAAM,CAAC;gBACJ,MAAM,IAAI,KAAK,CACX,gCAAgC,MAAM,CAAC,IAAI,mDAAmD,CACjG,CAAC;YACN,CAAC;YAED,MAAM,SAAS,GAAG,UAAU,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;YACtD,MAAM,OAAO,GAAG,SAAS,IAAI,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YACxE,IAAI,CAAC,OAAO,EAAE,CAAC;gBACX,OAAO;oBACH,KAAK,EAAE,KAAK;oBACZ,MAAM,EAAE,CAAC,IAAI,KAAK,CAAC,YAAY,SAAS,mBAAmB,CAAC,CAAC;iBAChE,CAAC;YACN,CAAC;YAED,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;gBACrB,OAAO;oBACH,KAAK,EAAE,KAAK;oBACZ,MAAM,EAAE,CAAC,IAAI,KAAK,CAAC,YAAY,SAAS,gBAAgB,CAAC,CAAC;iBAC7D,CAAC;YACN,CAAC;YAED,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;QAC3B,CAAC;KACJ,CAAC;AACN,CAAC"}

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

@@ -0,0 +1,100 @@
+import type { Id, UTCDate } from "../../common/types.js";
+import type { BaseGetRequestInvocationArgs, BaseGetResponseInvocationArgs, BaseSetRequestInvocationArgs, BaseSetResponseInvocationArgs } from "../../invocation/types.js";
+/**
+ * VacationResponseObject properties set by the server. These cannot be set by a
+ * `VacationResponse/set` call.
+ *
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-8 | RFC 8621 Section 8: Vacation Response}
+ */
+export type VacationResponseObjectServerSet = Readonly<{
+    /**
+     * (immutable; server-set) The id of the object. There is only ever one VacationResponse
+     * object, and its id is `singleton`.
+     */
+    id: Id;
+}>;
+/**
+ * VacationResponseObject properties that may be set via a `VacationResponse/set` call.
+ *
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-8 | RFC 8621 Section 8: Vacation Response}
+ */
+export type VacationResponseObjectSettable = {
+    /**
+     * Should a vacation response be sent if a message arrives between the `fromDate`
+     * and `toDate`?
+     */
+    isEnabled: boolean;
+    /**
+     * If `isEnabled` is `true`, messages that arrive on or after this date-time (but before
+     * the `toDate` if defined) should receive the user's vacation response. If `null`, the
+     * vacation response is effective immediately.
+     */
+    fromDate?: UTCDate | null;
+    /**
+     * If `isEnabled` is `true`, messages that arrive before this date-time (but on or after
+     * the `fromDate` if defined) should receive the user's vacation response. If `null`, the
+     * vacation response is effective indefinitely.
+     */
+    toDate?: UTCDate | null;
+    /**
+     * The subject that will be used by the message sent in response to messages when the
+     * vacation response is enabled. If `null`, an appropriate subject SHOULD be set by the
+     * server.
+     */
+    subject?: string | null;
+    /**
+     * The plaintext body to send in response to messages when the vacation response is enabled.
+     * If this is `null`, the server SHOULD generate a plaintext body part from the `htmlBody`
+     * when sending vacation responses but MAY choose to send the response as HTML only. If both
+     * `textBody` and `htmlBody` are `null`, an appropriate default body SHOULD be generated for
+     * responses by the server.
+     */
+    textBody?: string | null;
+    /**
+     * The HTML body to send in response to messages when the vacation response is enabled.
+     * If this is `null`, the server MAY choose to generate an HTML body part from the
+     * `textBody` when sending vacation responses or MAY choose to send the response as
+     * plaintext only.
+     */
+    htmlBody?: string | null;
+};
+/**
+ * Properties of the VacationResponse object.
+ *
+ * A VacationResponse object represents the state of vacation-response-related settings for an
+ * account. There is only ever one VacationResponse object in an account, and its id is `singleton`.
+ *
+ * Automated message sending can produce undesirable behaviour. To avoid this, implementors MUST
+ * follow the recommendations set forth in {@link https://www.rfc-editor.org/rfc/rfc3834.html RFC 3834}.
+ *
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-8 | RFC 8621 Section 8: Vacation Response}
+ */
+export type VacationResponseObject = VacationResponseObjectServerSet & VacationResponseObjectSettable;
+/**
+ * The arguments for fetching VacationResponse objects via a `VacationResponse/get` call.
+ *
+ * There MUST only be exactly one VacationResponse object in an account. It MUST have
+ * the id `singleton`.
+ */
+export type VacationResponseGetRequestInvocationArgs = BaseGetRequestInvocationArgs<VacationResponseObject>;
+/**
+ * The response to a `VacationResponse/get` call.
+ */
+export type VacationResponseGetResponseInvocationArgs = BaseGetResponseInvocationArgs<VacationResponseObject>;
+/**
+ * The arguments for creating, updating, and destroying VacationResponse objects via a
+ * `VacationResponse/set` call.
+ */
+export type VacationResponseSetRequestInvocationArgs = BaseSetRequestInvocationArgs<VacationResponseObjectSettable>;
+/**
+ * The response to a `VacationResponse/set` call.
+ */
+export type VacationResponseSetResponseInvocationArgs = BaseSetResponseInvocationArgs<VacationResponseObject>;
+/**
+ * Union type of all VacationResponse capability request invocation arguments.
+ */
+export type VacationResponseRequestInvocationArgs = VacationResponseGetRequestInvocationArgs | VacationResponseSetRequestInvocationArgs;
+/**
+ * Union type of all VacationResponse capability response invocation arguments.
+ */
+export type VacationResponseResponseInvocationArgs = VacationResponseGetResponseInvocationArgs | VacationResponseSetResponseInvocationArgs;

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

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

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

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

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

@@ -0,0 +1,61 @@
+import type { JMAPCapability, JMAPMethodName } from "../../common/types.js";
+import { Invocation } from "../../invocation/invocation.js";
+import type { InvocationArgs, InvocationFactory } from "../../invocation/types.js";
+import type { VacationResponseGetRequestInvocationArgs, VacationResponseGetResponseInvocationArgs, VacationResponseRequestInvocationArgs, VacationResponseResponseInvocationArgs, VacationResponseSetRequestInvocationArgs, VacationResponseSetResponseInvocationArgs } from "./types.js";
+/**
+ * VacationResponseInvocation represents a JMAP VacationResponse capability invocation.
+ *
+ * A VacationResponse object represents the state of vacation-response-related settings for an
+ * account. There is only ever one VacationResponse object, and its id is `singleton`.
+ *
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-8 | RFC 8621 Section 8: Vacation Response}
+ */
+export declare class VacationResponseInvocation<TArgs extends VacationResponseRequestInvocationArgs | VacationResponseResponseInvocationArgs> extends Invocation<TArgs> {
+    get uri(): JMAPCapability;
+    /**
+     * Constructs a VacationResponseInvocation
+     *
+     * @param method The name of the method being invoked (e.g., "get", "set")
+     * @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 VacationResponse invocation factory function for creating invocations of the specified type
+     */
+    static createInvocationFactory<TArgs extends VacationResponseRequestInvocationArgs | VacationResponseResponseInvocationArgs>(method: JMAPMethodName): InvocationFactory<TArgs, VacationResponseInvocation<TArgs>>;
+}
+export declare const VacationResponse: {
+    request: {
+        /**
+         * Retrieves the VacationResponse object.
+         *
+         * There MUST only be exactly one VacationResponse object in an account.
+         * It MUST have the id `singleton`.
+         *
+         * @param args The invocation arguments for VacationResponse/get
+         * @param methodCallId An optional unique symbol to identify this method call for result referencing
+         * @returns A VacationResponseInvocation representing the VacationResponse/get request
+         *
+         * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-8.1 | RFC 8621 Section 8.1: VacationResponse/get}
+         */
+        get: InvocationFactory<VacationResponseGetRequestInvocationArgs, VacationResponseInvocation<VacationResponseGetRequestInvocationArgs>>;
+        /**
+         * Updates the VacationResponse object.
+         *
+         * @param args The invocation arguments for VacationResponse/set
+         * @param methodCallId An optional unique symbol to identify this method call for result referencing
+         * @returns A VacationResponseInvocation representing the VacationResponse/set request
+         *
+         * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-8.2 | RFC 8621 Section 8.2: VacationResponse/set}
+         */
+        set: InvocationFactory<VacationResponseSetRequestInvocationArgs, VacationResponseInvocation<VacationResponseSetRequestInvocationArgs>>;
+    };
+    response: {
+        get: InvocationFactory<VacationResponseGetResponseInvocationArgs, VacationResponseInvocation<VacationResponseGetResponseInvocationArgs>>;
+        set: InvocationFactory<VacationResponseSetResponseInvocationArgs, VacationResponseInvocation<VacationResponseSetResponseInvocationArgs>>;
+    };
+};

package/dist/src/capabilities/vacationresponse/vacationresponse.js

@@ -0,0 +1,73 @@
+import { VACATIONRESPONSE_CAPABILITY_URI } from "../../common/registry.js";
+import { Invocation } from "../../invocation/invocation.js";
+/**
+ * VacationResponseInvocation represents a JMAP VacationResponse capability invocation.
+ *
+ * A VacationResponse object represents the state of vacation-response-related settings for an
+ * account. There is only ever one VacationResponse object, and its id is `singleton`.
+ *
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-8 | RFC 8621 Section 8: Vacation Response}
+ */
+export class VacationResponseInvocation extends Invocation {
+    get uri() {
+        return VACATIONRESPONSE_CAPABILITY_URI;
+    }
+    /**
+     * Constructs a VacationResponseInvocation
+     *
+     * @param method The name of the method being invoked (e.g., "get", "set")
+     * @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("VacationResponse", method, args, methodCallId);
+    }
+    /**
+     * Create an invocation factory function
+     *
+     * @param method The name of the method to create
+     * @returns A new VacationResponse invocation factory function for creating invocations of the specified type
+     */
+    static createInvocationFactory(method) {
+        /**
+         * An invocation factory function to create a `VacationResponse/{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 VacationResponseInvocation(method, args, methodCallId);
+    }
+}
+export const VacationResponse = {
+    request: {
+        /**
+         * Retrieves the VacationResponse object.
+         *
+         * There MUST only be exactly one VacationResponse object in an account.
+         * It MUST have the id `singleton`.
+         *
+         * @param args The invocation arguments for VacationResponse/get
+         * @param methodCallId An optional unique symbol to identify this method call for result referencing
+         * @returns A VacationResponseInvocation representing the VacationResponse/get request
+         *
+         * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-8.1 | RFC 8621 Section 8.1: VacationResponse/get}
+         */
+        get: VacationResponseInvocation.createInvocationFactory("get"),
+        /**
+         * Updates the VacationResponse object.
+         *
+         * @param args The invocation arguments for VacationResponse/set
+         * @param methodCallId An optional unique symbol to identify this method call for result referencing
+         * @returns A VacationResponseInvocation representing the VacationResponse/set request
+         *
+         * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-8.2 | RFC 8621 Section 8.2: VacationResponse/set}
+         */
+        set: VacationResponseInvocation.createInvocationFactory("set"),
+    },
+    response: {
+        get: VacationResponseInvocation.createInvocationFactory("get"),
+        set: VacationResponseInvocation.createInvocationFactory("set"),
+    },
+};
+//# sourceMappingURL=vacationresponse.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"vacationresponse.js","sourceRoot":"","sources":["../../../../src/capabilities/vacationresponse/vacationresponse.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,+BAA+B,EAAE,MAAM,0BAA0B,CAAC;AAE3E,OAAO,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AAW5D;;;;;;;GAOG;AACH,MAAM,OAAO,0BAEX,SAAQ,UAAiB;IACvB,IAAI,GAAG;QACH,OAAO,+BAA+B,CAAC;IAC3C,CAAC;IAED;;;;;;OAMG;IACH,YAAY,MAAsB,EAAE,IAA2B,EAAE,YAAqB;QAClF,KAAK,CAAC,kBAAkB,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,uBAAuB,CAE5B,MAAsB;QACpB;;;;;;WAMG;QACH,OAAO,CAAC,IAAI,EAAE,YAAY,EAAE,EAAE,CAAC,IAAI,0BAA0B,CAAQ,MAAM,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;IACrG,CAAC;CACJ;AAED,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC5B,OAAO,EAAE;QACL;;;;;;;;;;;WAWG;QACH,GAAG,EAAE,0BAA0B,CAAC,uBAAuB,CAA2C,KAAK,CAAC;QACxG;;;;;;;;WAQG;QACH,GAAG,EAAE,0BAA0B,CAAC,uBAAuB,CAA2C,KAAK,CAAC;KAC3G;IACD,QAAQ,EAAE;QACN,GAAG,EAAE,0BAA0B,CAAC,uBAAuB,CAA4C,KAAK,CAAC;QACzG,GAAG,EAAE,0BAA0B,CAAC,uBAAuB,CAA4C,KAAK,CAAC;KAC5G;CACkC,CAAC"}