jmap-kit 0.0.0 → 1.0.2

package/dist/src/common/registry.js

@@ -0,0 +1,321 @@
+// Capability URIs
+/**
+ * Prefix for all IETF-registered JMAP capability URIs.
+ * @see {@link https://www.iana.org/assignments/jmap/jmap.xhtml IANA JMAP Capabilities Registry}
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8620.html#section-2 RFC 8620 Section 2}
+ */
+export const JMAP_CAPABILITY_PREFIX = "urn:ietf:params:jmap:";
+/**
+ * Prefix for JMAP request-level error types.
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8620.html#section-9.4.7 Registration for JMAP Error Placeholder in JMAP Capabilities Registry - RFC 8620 Section 9.4.7}
+
+ */
+export const ERROR_CAPABILITY_PREFIX = `${JMAP_CAPABILITY_PREFIX}error:`;
+/**
+ * JMAP Blob management capability.
+ * @see {@link https://www.iana.org/assignments/jmap/jmap.xhtml IANA JMAP Capabilities Registry}
+ * @see {@link https://www.rfc-editor.org/rfc/rfc9404.html#section-6.1 JMAP Capability Registration for "blob" - RFC 9404 Section 6.1}
+ */
+export const BLOB_CAPABILITY_URI = `${JMAP_CAPABILITY_PREFIX}blob`;
+/**
+ * JMAP Core capability. This capability is always supported by all JMAP servers.
+ * @see {@link https://www.iana.org/assignments/jmap/jmap.xhtml IANA JMAP Capabilities Registry}
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8620.html#section-9.4.6 Initial Registration for JMAP Core - RFC 8620 Section 9.4.6}
+
+ */
+export const CORE_CAPABILITY_URI = `${JMAP_CAPABILITY_PREFIX}core`;
+/**
+ * JMAP Mail capability.
+ * @see {@link https://www.iana.org/assignments/jmap/jmap.xhtml IANA JMAP Capabilities Registry}
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8621#section-10.1 JMAP Capability Registration for "mail" - RFC 8621 Section 10.1}
+
+ */
+export const EMAIL_CAPABILITY_URI = `${JMAP_CAPABILITY_PREFIX}mail`;
+/**
+ * JMAP Submission capability.
+ * @see {@link https://www.iana.org/assignments/jmap/jmap.xhtml IANA JMAP Capabilities Registry}
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8621#section-10.2 JMAP Capability Registration for "submission" - RFC 8621 Section 10.2}
+
+ */
+export const SUBMISSION_CAPABILITY_URI = `${JMAP_CAPABILITY_PREFIX}submission`;
+/**
+ * JMAP Vacation Response capability.
+ * @see {@link https://www.iana.org/assignments/jmap/jmap.xhtml IANA JMAP Capabilities Registry}
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8621#section-10.3 JMAP Capability Registration for "vacationresponse" - RFC 8621 Section 10.3}
+
+ */
+export const VACATIONRESPONSE_CAPABILITY_URI = `${JMAP_CAPABILITY_PREFIX}vacationresponse`;
+/**
+ * JMAP Message Disposition Notification (MDN) capability.
+ * @see {@link https://www.iana.org/assignments/jmap/jmap.xhtml IANA JMAP Capabilities Registry}
+ * @see {@link https://www.rfc-editor.org/rfc/rfc9007.html#section-4.1 JMAP Capability Registration for "mdn" - RFC 9007 Section 4.1}
+ */
+export const MDN_CAPABILITY_URI = `${JMAP_CAPABILITY_PREFIX}mdn`;
+/**
+ * JMAP S/MIME Signature Verification capability.
+ * @see {@link https://www.iana.org/assignments/jmap/jmap.xhtml IANA JMAP Capabilities Registry}
+ * @see {@link https://www.rfc-editor.org/rfc/rfc9219.html#section-5.1 JMAP Capability Registration for "smimeverify" - RFC 9219 Section 5.1}
+ */
+export const SMIMEVERIFY_CAPABILITY_URI = `${JMAP_CAPABILITY_PREFIX}smimeverify`;
+/**
+ * JMAP Quotas capability.
+ * @see {@link https://www.iana.org/assignments/jmap/jmap.xhtml IANA JMAP Capabilities Registry}
+ * @see {@link https://www.rfc-editor.org/rfc/rfc9425.html#section-7.1 JMAP Capability Registration for "quota" - RFC 9425 Section 7.1}
+ */
+export const QUOTA_CAPABILITY_URI = `${JMAP_CAPABILITY_PREFIX}quota`;
+/**
+ * JMAP WebPush VAPID capability.
+ * @see {@link https://www.iana.org/assignments/jmap/jmap.xhtml IANA JMAP Capabilities Registry}
+ * @see {@link https://www.rfc-editor.org/rfc/rfc9749.html#section-7.1 JMAP Capability Registration for VAPID - RFC 9749 Section 7.1}
+ */
+export const WEBPUSH_VAPID_CAPABILITY_URI = `${JMAP_CAPABILITY_PREFIX}webpush-vapid`;
+/**
+ * JMAP Calendars capability.
+ * @see {@link https://www.iana.org/assignments/jmap/jmap.xhtml IANA JMAP Capabilities Registry}
+ * @see {@link https://datatracker.ietf.org/doc/html/draft-ietf-jmap-calendars#section-10.1 JMAP Capability Registration for "calendars" - Draft IETF JMAP Calendars Section 10.1}
+
+ */
+export const CALENDARS_CAPABILITY_URI = `${JMAP_CAPABILITY_PREFIX}calendars`;
+/**
+ * JMAP Calendar event parsing capability.
+ * @see {@link https://www.iana.org/assignments/jmap/jmap.xhtml IANA JMAP Capabilities Registry}
+ * @see {@link https://datatracker.ietf.org/doc/html/draft-ietf-jmap-calendars#section-1.5.3 Draft IETF JMAP Calendars Section 1.5.3}
+
+ */
+export const CALENDARS_PARSE_CAPABILITY_URI = `${JMAP_CAPABILITY_PREFIX}calendars:parse`;
+/**
+ * JMAP Principals capability.
+ * @see {@link https://www.iana.org/assignments/jmap/jmap.xhtml IANA JMAP Capabilities Registry}
+ * @see {@link https://www.rfc-editor.org/rfc/rfc9670.html#section-7.1 JMAP Capability Registration for "principals" - RFC 9670 Section 7.1}
+
+ */
+export const PRINCIPALS_CAPABILITY_URI = `${JMAP_CAPABILITY_PREFIX}principals`;
+/**
+ * JMAP Service Provider availability capability.
+ * @see {@link https://www.iana.org/assignments/jmap/jmap.xhtml IANA JMAP Capabilities Registry}
+ * @see {@link https://datatracker.ietf.org/doc/html/draft-ietf-jmap-calendars#section-10.2 JMAP Capability Registration for "principals:availability" - Draft IETF JMAP Calendars Section 10.2}
+
+ */
+export const PRINCIPALS_AVAILABILITY_CAPABILITY_URI = `${JMAP_CAPABILITY_PREFIX}principals:availability`;
+/**
+ * JMAP Principal owner capability.
+ * @see {@link https://www.iana.org/assignments/jmap/jmap.xhtml IANA JMAP Capabilities Registry}
+ * @see {@link https://www.rfc-editor.org/rfc/rfc9670.html#section-7.2 JMAP Capability Registration for "principals:owner" - RFC 9670 Section 7.2}
+
+ */
+export const PRINCIPALS_OWNER_CAPABILITY_URI = `${JMAP_CAPABILITY_PREFIX}principals:owner`;
+/**
+ * JMAP Contacts capability.
+ * @see {@link https://www.iana.org/assignments/jmap/jmap.xhtml IANA JMAP Capabilities Registry}
+ * @see {@link https://www.rfc-editor.org/rfc/rfc9610.html#section-7.1 JMAP Capability Registration for "contacts" - RFC 9610 Section 7.1}
+
+ */
+export const CONTACTS_CAPABILITY_URI = `${JMAP_CAPABILITY_PREFIX}contacts`;
+/**
+ * JMAP Tasks capability.
+ * @see {@link https://www.iana.org/assignments/jmap/jmap.xhtml IANA JMAP Capabilities Registry}
+ * @see {@link https://datatracker.ietf.org/doc/html/draft-ietf-jmap-tasks#section-7.1 JMAP Capability Registration for "tasks" - Draft IETF JMAP Tasks Section 7.1}
+
+ */
+export const TASKS_CAPABILITY_URI = `${JMAP_CAPABILITY_PREFIX}tasks`;
+/**
+ * JMAP Tasks Recurrences capability.
+ * @see {@link https://www.iana.org/assignments/jmap/jmap.xhtml IANA JMAP Capabilities Registry}
+ * @see {@link https://datatracker.ietf.org/doc/html/draft-ietf-jmap-tasks#section-7.2 JMAP Capability Registration for "tasks:recurrences" - Draft IETF JMAP Tasks Section 7.2}
+
+ */
+export const TASKS_RECURRENCES_CAPABILITY_URI = `${JMAP_CAPABILITY_PREFIX}tasks:recurrences`;
+/**
+ * JMAP Tasks Assignees capability.
+ * @see {@link https://www.iana.org/assignments/jmap/jmap.xhtml IANA JMAP Capabilities Registry}
+ * @see {@link https://datatracker.ietf.org/doc/html/draft-ietf-jmap-tasks#section-7.3 JMAP Capability Registration for "tasks:assignees" - Draft IETF JMAP Tasks Section 7.3}
+
+ */
+export const TASKS_ASSIGNEES_CAPABILITY_URI = `${JMAP_CAPABILITY_PREFIX}tasks:assignees`;
+/**
+ * JMAP Tasks Alerts capability.
+ * @see {@link https://www.iana.org/assignments/jmap/jmap.xhtml IANA JMAP Capabilities Registry}
+ * @see {@link https://datatracker.ietf.org/doc/html/draft-ietf-jmap-tasks#section-7.4 JMAP Capability Registration for "tasks:alerts" - Draft IETF JMAP Tasks Section 7.4}
+
+ */
+export const TASKS_ALERTS_CAPABILITY_URI = `${JMAP_CAPABILITY_PREFIX}tasks:alerts`;
+/**
+ * JMAP Tasks Multilingual capability.
+ * @see {@link https://www.iana.org/assignments/jmap/jmap.xhtml IANA JMAP Capabilities Registry}
+ * @see {@link https://datatracker.ietf.org/doc/html/draft-ietf-jmap-tasks#section-7.5 JMAP Capability Registration for "tasks:multilingual" - Draft IETF JMAP Tasks Section 7.5}
+
+ */
+export const TASKS_MULTILINGUAL_CAPABILITY_URI = `${JMAP_CAPABILITY_PREFIX}tasks:multilingual`;
+/**
+ * JMAP Tasks Custom Timezones capability.
+ * @see {@link https://www.iana.org/assignments/jmap/jmap.xhtml IANA JMAP Capabilities Registry}
+ * @see {@link https://datatracker.ietf.org/doc/html/draft-ietf-jmap-tasks#section-7.6 JMAP Capability Registration for "tasks:customtimezones" - Draft IETF JMAP Tasks Section 7.6}
+
+ */
+export const TASKS_CUSTOMTIMEZONES_CAPABILITY_URI = `${JMAP_CAPABILITY_PREFIX}tasks:customtimezones`;
+/**
+ * FastMail Masked Email capability. This is a vendor-specific extension.
+ * @see {@link https://www.fastmail.com/dev/#masked-email-api FastMail Masked Email API Documentation}
+ */
+export const MASKED_EMAIL_CAPABILITY_URI = `https://www.fastmail.com/dev/maskedemail`;
+// Data Types
+/**
+ * Core data type for JMAP Core objects.
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8620.html#section-4 The Core/Echo Method - RFC 8620 Section 4 }
+
+ */ export const CORE_DATA_TYPE = "Core";
+/**
+ * Blob data type for binary data management.
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8620.html#section-6 Binary Data - RFC 8620 Section 6}
+ * @see {@link https://www.rfc-editor.org/rfc/rfc9404.html#name-blob-methods Blob Methods - RFC 9404 Section 4}
+
+ */
+export const BLOB_DATA_TYPE = "Blob";
+/**
+ * PushSubscription data type for push notifications.
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8620.html#section-7.2 PushSubscription - RFC 8620 Section 7.2}
+
+ */
+export const PUSHSUBSCRIPTION_DATA_TYPE = "PushSubscription";
+/**
+ * Mailbox data type for email mailbox objects.
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-2 Mailboxes - RFC 8621 Section 2}
+
+ */
+export const MAILBOX_DATA_TYPE = "Mailbox";
+/**
+ * Thread data type for email thread objects.
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-3 Threads - RFC 8621 Section 3}
+
+ */
+export const THREAD_DATA_TYPE = "Thread";
+/**
+ * Email data type for email message objects.
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-4 Emails - RFC 8621 Section 4}
+
+ */
+export const EMAIL_DATA_TYPE = "Email";
+/**
+ * EmailDelivery data type for push notifications. Has no methods; exists only to notify clients when new emails are added.
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-1.5 Push - RFC 8621 Section 1.5}
+
+ */
+export const EMAILDELIVERY_DATA_TYPE = "EmailDelivery";
+/**
+ * SearchSnippet data type for email search result snippets.
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-5 Search Snippets - RFC 8621 Section 5}
+
+ */
+export const SEARCHSNIPPET_DATA_TYPE = "SearchSnippet";
+/**
+ * Identity data type for sender identities in email submission.
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-6 Identity - RFC 8621 Section 6}
+
+ */
+export const IDENTITY_DATA_TYPE = "Identity";
+/**
+ * EmailSubmission data type for email submission objects.
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-7 Email Submission - RFC 8621 Section 7}
+
+ */
+export const EMAILSUBMISSION_DATA_TYPE = "EmailSubmission";
+/**
+ * VacationResponse data type for vacation/out-of-office responses.
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8621.html#section-8 Vacation Response - RFC 8621 Section 8}
+
+ */
+export const VACATIONRESPONSE_DATA_TYPE = "VacationResponse";
+/**
+ * MDN (Message Disposition Notification) data type.
+ * @see {@link https://www.rfc-editor.org/rfc/rfc9007.html#section-2 MDN - RFC 9007 Section 2}
+ */
+export const MDN_DATA_TYPE = "MDN";
+/**
+ * Quota data type for quota management.
+ * @see {@link https://www.rfc-editor.org/rfc/rfc9425.html#section-4 Quota - RFC 9425 Section 4}
+ */
+export const QUOTA_DATA_TYPE = "Quota";
+/**
+ * SieveScript data type for Sieve script management.
+ * @see {@link https://www.rfc-editor.org/rfc/rfc9661.html#section-2 SieveScript - RFC 9661 Section 2}
+ */
+export const SIEVESCRIPT_DATA_TYPE = "SieveScript";
+/**
+ * Principal data type for principal objects.
+ * @see {@link https://www.rfc-editor.org/rfc/rfc9670.html#section-2 Principals - RFC 9670 Section 2}
+
+ */
+export const PRINCIPAL_DATA_TYPE = "Principal";
+/**
+ * ShareNotification data type for share notifications.
+ * @see {@link https://www.rfc-editor.org/rfc/rfc9670.html#section-3 ShareNotifications - RFC 9670 Section 3}
+
+ */
+export const SHARENOTIFICATION_DATA_TYPE = "ShareNotification";
+/**
+ * AddressBook data type for address book objects.
+ * @see {@link https://www.rfc-editor.org/rfc/rfc9610.html#section-2 AddressBooks - RFC 9610 Section 2}
+
+ */
+export const ADDRESSBOOK_DATA_TYPE = "AddressBook";
+/**
+ * ContactCard data type for contact card objects.
+ * @see {@link https://www.rfc-editor.org/rfc/rfc9610.html#section-3 ContactCards - RFC 9610 Section 3}
+
+ */
+export const CONTACTCARD_DATA_TYPE = "ContactCard";
+/**
+ * Calendar data type for calendar objects.
+ * @see {@link https://datatracker.ietf.org/doc/html/draft-ietf-jmap-calendars#section-4 Calendars - Draft IETF JMAP Calendars Section 4}
+
+ */
+export const CALENDAR_DATA_TYPE = "Calendar";
+/**
+ * CalendarEvent data type for calendar event objects.
+ * @see {@link https://datatracker.ietf.org/doc/html/draft-ietf-jmap-calendars#section-5 Calendar Events - Draft IETF JMAP Calendars Section 5}
+
+ */
+export const CALENDAREVENT_DATA_TYPE = "CalendarEvent";
+/**
+ * CalendarEventNotification data type for calendar event notifications.
+ * @see {@link https://datatracker.ietf.org/doc/html/draft-ietf-jmap-calendars#section-7 Calendar Event Notifications - Draft IETF JMAP Calendars Section 7}
+
+ */
+export const CALENDAREVENTNOTIFICATION_DATA_TYPE = "CalendarEventNotification";
+/**
+ * ParticipantIdentity data type for participant identity objects.
+ * @see {@link https://datatracker.ietf.org/doc/html/draft-ietf-jmap-calendars#section-3 Participant Identities - Draft IETF JMAP Calendars Section 3}
+
+ */
+export const PARTICIPANTIDENTITY_DATA_TYPE = "ParticipantIdentity";
+/**
+ * MaskedEmail data type for FastMail's masked email feature.
+ * @see {@link https://www.fastmail.com/dev/#masked-email-api FastMail Masked Email API Documentation}
+ */
+export const MASKED_EMAIL_TYPE = "MaskedEmail";
+// Request Level Errors
+/**
+ * The client included a capability in the "using" property of the request
+ * that the server does not support.
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8620.html#section-3.6.1 RFC 8620 Section 3.6.1 - Request-Level Errors}
+ */
+export const UNKNOWN_CAPABILITY = `${ERROR_CAPABILITY_PREFIX}unknownCapability`;
+/**
+ * The content type of the request was not application/json or the request
+ * did not parse as I-JSON.
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8620.html#section-3.6.1 RFC 8620 Section 3.6.1 - Request-Level Errors}
+ */
+export const NOT_JSON = `${ERROR_CAPABILITY_PREFIX}notJSON`;
+/**
+ * The request parsed as JSON but did not match the type signature of the Request object.
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8620.html#section-3.6.1 RFC 8620 Section 3.6.1 - Request-Level Errors}
+ */
+export const NOT_REQUEST = `${ERROR_CAPABILITY_PREFIX}notRequest`;
+/**
+ * The request was rejected due to a server-defined limit.
+ * A "limit" property MUST also be present on the "problem details" object,
+ * containing the name of the limit being applied.
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8620.html#section-3.6.1 RFC 8620 Section 3.6.1 - Request-Level Errors}
+ */
+export const LIMIT = `${ERROR_CAPABILITY_PREFIX}limit`;
+//# sourceMappingURL=registry.js.map

package/dist/src/common/registry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"registry.js","sourceRoot":"","sources":["../../../src/common/registry.ts"],"names":[],"mappings":"AAAA,kBAAkB;AAElB;;;;GAIG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,uBAAuB,CAAC;AAE9D;;;;GAIG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,GAAG,sBAAsB,QAAQ,CAAC;AAEzE;;;;GAIG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,GAAG,sBAAsB,MAAM,CAAC;AAEnE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,GAAG,sBAAsB,MAAM,CAAC;AAEnE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,GAAG,sBAAsB,MAAM,CAAC;AAEpE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,GAAG,sBAAsB,YAAY,CAAC;AAE/E;;;;;GAKG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,GAAG,sBAAsB,kBAAkB,CAAC;AAE3F;;;;GAIG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,GAAG,sBAAsB,KAAK,CAAC;AAEjE;;;;GAIG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,GAAG,sBAAsB,aAAa,CAAC;AAEjF;;;;GAIG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,GAAG,sBAAsB,OAAO,CAAC;AAErE;;;;GAIG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,GAAG,sBAAsB,eAAe,CAAC;AAErF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,GAAG,sBAAsB,WAAW,CAAC;AAE7E;;;;;GAKG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,GAAG,sBAAsB,iBAAiB,CAAC;AAEzF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,GAAG,sBAAsB,YAAY,CAAC;AAE/E;;;;;GAKG;AACH,MAAM,CAAC,MAAM,sCAAsC,GAAG,GAAG,sBAAsB,yBAAyB,CAAC;AAEzG;;;;;GAKG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,GAAG,sBAAsB,kBAAkB,CAAC;AAE3F;;;;;GAKG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,GAAG,sBAAsB,UAAU,CAAC;AAE3E;;;;;GAKG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,GAAG,sBAAsB,OAAO,CAAC;AAErE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gCAAgC,GAAG,GAAG,sBAAsB,mBAAmB,CAAC;AAE7F;;;;;GAKG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,GAAG,sBAAsB,iBAAiB,CAAC;AAEzF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,GAAG,sBAAsB,cAAc,CAAC;AAEnF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,iCAAiC,GAAG,GAAG,sBAAsB,oBAAoB,CAAC;AAE/F;;;;;GAKG;AACH,MAAM,CAAC,MAAM,oCAAoC,GAAG,GAAG,sBAAsB,uBAAuB,CAAC;AAErG;;;GAGG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,0CAA0C,CAAC;AAyBtF,aAAa;AAEb;;;;GAIG,CAAC,MAAM,CAAC,MAAM,cAAc,GAAG,MAAM,CAAC;AAEzC;;;;;GAKG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,MAAM,CAAC;AAErC;;;;GAIG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,kBAAkB,CAAC;AAE7D;;;;GAIG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,SAAS,CAAC;AAE3C;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,QAAQ,CAAC;AAEzC;;;;GAIG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,OAAO,CAAC;AAEvC;;;;GAIG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,eAAe,CAAC;AAEvD;;;;GAIG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,eAAe,CAAC;AAEvD;;;;GAIG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,UAAU,CAAC;AAE7C;;;;GAIG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,iBAAiB,CAAC;AAE3D;;;;GAIG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,kBAAkB,CAAC;AAE7D;;;GAGG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,KAAK,CAAC;AAEnC;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,OAAO,CAAC;AAEvC;;;GAGG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,aAAa,CAAC;AAEnD;;;;GAIG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,WAAW,CAAC;AAE/C;;;;GAIG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,mBAAmB,CAAC;AAE/D;;;;GAIG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,aAAa,CAAC;AAEnD;;;;GAIG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,aAAa,CAAC;AAEnD;;;;GAIG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,UAAU,CAAC;AAE7C;;;;GAIG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,eAAe,CAAC;AAEvD;;;;GAIG;AACH,MAAM,CAAC,MAAM,mCAAmC,GAAG,2BAA2B,CAAC;AAE/E;;;;GAIG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,qBAAqB,CAAC;AAEnE;;;GAGG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,aAAa,CAAC;AA0B/C,uBAAuB;AACvB;;;;GAIG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,GAAG,uBAAuB,mBAAmB,CAAC;AAGhF;;;;GAIG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,GAAG,uBAAuB,SAAS,CAAC;AAG5D;;;GAGG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,GAAG,uBAAuB,YAAY,CAAC;AAGlE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG,GAAG,uBAAuB,OAAO,CAAC"}

package/dist/src/common/types.d.ts

@@ -0,0 +1,338 @@
+import { z } from "zod/v4";
+import type { ADDRESSBOOK_DATA_TYPE, BLOB_CAPABILITY_URI, BLOB_DATA_TYPE, CALENDAREVENTNOTIFICATION_DATA_TYPE, CALENDAREVENT_DATA_TYPE, CALENDARS_CAPABILITY_URI, CALENDARS_PARSE_CAPABILITY_URI, CALENDAR_DATA_TYPE, CONTACTCARD_DATA_TYPE, CONTACTS_CAPABILITY_URI, CORE_DATA_TYPE, EMAILDELIVERY_DATA_TYPE, EMAILSUBMISSION_DATA_TYPE, EMAIL_CAPABILITY_URI, EMAIL_DATA_TYPE, IDENTITY_DATA_TYPE, LIMIT, MAILBOX_DATA_TYPE, MASKED_EMAIL_CAPABILITY_URI, MASKED_EMAIL_TYPE, MDN_CAPABILITY_URI, MDN_DATA_TYPE, NOT_JSON, NOT_REQUEST, PARTICIPANTIDENTITY_DATA_TYPE, PRINCIPALS_AVAILABILITY_CAPABILITY_URI, PRINCIPALS_CAPABILITY_URI, PRINCIPALS_OWNER_CAPABILITY_URI, PRINCIPAL_DATA_TYPE, PUSHSUBSCRIPTION_DATA_TYPE, QUOTA_CAPABILITY_URI, QUOTA_DATA_TYPE, SEARCHSNIPPET_DATA_TYPE, SHARENOTIFICATION_DATA_TYPE, SIEVESCRIPT_DATA_TYPE, SMIMEVERIFY_CAPABILITY_URI, SUBMISSION_CAPABILITY_URI, TASKS_ALERTS_CAPABILITY_URI, TASKS_ASSIGNEES_CAPABILITY_URI, TASKS_CAPABILITY_URI, TASKS_CUSTOMTIMEZONES_CAPABILITY_URI, TASKS_MULTILINGUAL_CAPABILITY_URI, TASKS_RECURRENCES_CAPABILITY_URI, THREAD_DATA_TYPE, UNKNOWN_CAPABILITY, VACATIONRESPONSE_CAPABILITY_URI, VACATIONRESPONSE_DATA_TYPE, WEBPUSH_VAPID_CAPABILITY_URI } from "./registry.js";
+import { CORE_CAPABILITY_URI } from "./registry.js";
+/**
+ * Any primitive, object or array value that can be represented in JSON
+ */
+export type JSONValue = string | number | boolean | null | {
+    [member: string]: JSONValue;
+} | JSONValue[];
+/**
+ * An empty object
+ */
+export type EmptyObject = Record<string | symbol, never>;
+/**
+ * Any string value, with some known suggested values that may be used.
+ */
+export type HintedString<KnownValues extends string> = (string & {}) | KnownValues;
+/**
+ * From `T`, make the specified properties in the union `K` required,
+ * and make all other properties optional
+ */
+export type RequireSome<T, K extends keyof T> = Required<Pick<T, K>> & Partial<Omit<T, K>>;
+/**
+ * A type that can be either a value of type `T` or a Promise that resolves to a value of type `T`.
+ */
+export type MaybePromise<T> = T | Promise<T>;
+/**
+ * A string of at least 1 and a maximum of 255 octets in size, and it MUST only contain
+ * characters from the “URL and Filename Safe” base64 alphabet, as defined in Section 5
+ * of {@link https://www.rfc-editor.org/rfc/rfc4648.html RFC 4648}, excluding the pad character
+ * (`=`). This means the allowed characters are the ASCII alphanumeric characters
+ * (`A-Za-z0-9`), hyphen (`-`), and underscore (`_`).
+ */
+export type Id = string & {};
+/**
+ * An integer in the range -2^53+1 <= value <= 2^53-1, the safe range for integers stored
+ * in a floating-point double, represented as a JSON `Number`.
+ */
+export type Int = number & {};
+/**
+ * An `Int` where the value MUST be in the range 0 <= value <= 2^53-1.
+ */
+export type UnsignedInt = number & {};
+/**
+ * A string in date-time format {@link https://www.rfc-editor.org/rfc/rfc3339.html RFC 3339}.
+ * To ensure a normalised form, the time-secfrac MUST always be omitted if zero, and
+ * any letters in the string (e.g., “`T`” and “`Z`”) MUST be uppercase.
+ *
+ * For example, `"2014-10-30T14:12:00+08:00"`.
+ */
+export type TZDate = string & {};
+/**
+ * A `Date` where the time-offset component MUST be `Z` (i.e., it must be in UTC time).
+ *
+ * For example, `"2014-10-30T06:12:00Z"`.
+ */
+export type UTCDate = string & {};
+/**
+ * The list of data types defined in various JMAP specifications, including the core specification and extensions.
+ * This is not an exhaustive list of all possible data types, as servers may support additional private data types as well.
+ */
+export type JMAPDataType = HintedString<CORE_DATA_TYPE | BLOB_DATA_TYPE | PUSHSUBSCRIPTION_DATA_TYPE | MAILBOX_DATA_TYPE | THREAD_DATA_TYPE | EMAIL_DATA_TYPE | EMAILDELIVERY_DATA_TYPE | SEARCHSNIPPET_DATA_TYPE | IDENTITY_DATA_TYPE | EMAILSUBMISSION_DATA_TYPE | VACATIONRESPONSE_DATA_TYPE | MDN_DATA_TYPE | QUOTA_DATA_TYPE | SIEVESCRIPT_DATA_TYPE | PRINCIPAL_DATA_TYPE | SHARENOTIFICATION_DATA_TYPE | ADDRESSBOOK_DATA_TYPE | CONTACTCARD_DATA_TYPE | CALENDAR_DATA_TYPE | CALENDAREVENT_DATA_TYPE | CALENDAREVENTNOTIFICATION_DATA_TYPE | PARTICIPANTIDENTITY_DATA_TYPE | MASKED_EMAIL_TYPE>;
+/**
+ * The list of method names defined in the JMAP core specification ({@link https://www.rfc-editor.org/rfc/rfc8620.html RFC 8620}).
+ */
+export type JMAPMethodName = HintedString<"changes" | "copy" | "echo" | "get" | "import" | "lookup" | "parse" | "query" | "queryChanges" | "set" | "upload">;
+/**
+ * Zod schema for JMAPServerCapabilities.
+ *
+ * Validates the structural requirement that the Core capability key is present.
+ * Content validation of individual capabilities is handled by each capability's
+ * own StandardSchema, validated via {@link CapabilityRegistryInterface.validateServerCapabilities}.
+ */
+export declare const JMAPServerCapabilitiesSchema: z.ZodObject<{
+    "urn:ietf:params:jmap:core": z.ZodObject<{}, z.core.$loose>;
+}, z.core.$loose>;
+/**
+ * Registry of known server capability properties.
+ *
+ * This interface can be augmented by third-party plugins using `declare module` to add
+ * type-safe capability properties. `JMAPServerCapabilities` extends this interface
+ * and automatically picks up augmented properties.
+ *
+ * @example
+ * ```typescript
+ * declare module "jmap-kit" {
+ *     interface ServerCapabilityRegistry {
+ *         "https://example.com/custom-capability"?: { customProp: string };
+ *     }
+ * }
+ * ```
+ */
+export interface ServerCapabilityRegistry {
+    [key: string & {}]: unknown;
+}
+/**
+ * JMAPServerCapabilities
+ *
+ * Capabilities supported by the server, keyed by capability URI.
+ *
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8620.html#section-2 RFC 8620 Section 2 - The JMAP Session Resource}
+ */
+export interface JMAPServerCapabilities extends ServerCapabilityRegistry {
+    [key: string & {}]: unknown;
+}
+/**
+ * Zod schema for JMAPAccountCapabilities.
+ *
+ * Validates the structural shape of account capabilities. Content validation of individual
+ * capabilities is handled by each capability's own StandardSchema, validated via
+ * {@link CapabilityRegistryInterface.validateAccountCapabilities}.
+ */
+export declare const JMAPAccountCapabilitiesSchema: z.ZodObject<{}, z.core.$loose>;
+/**
+ * Registry of known account capability properties.
+ *
+ * This interface can be augmented by third-party plugins using `declare module` to add
+ * type-safe capability properties. `JMAPAccountCapabilities` extends this interface
+ * and automatically picks up augmented properties.
+ *
+ * @example
+ * ```typescript
+ * declare module “jmap-kit” {
+ *     interface AccountCapabilityRegistry {
+ *         “https://example.com/custom-capability”?: { customProp: string };
+ *     }
+ * }
+ * ```
+ */
+export interface AccountCapabilityRegistry {
+    [key: string & {}]: unknown;
+}
+/**
+ * JMAPAccountCapabilities
+ *
+ * Capabilities supported by an account, keyed by capability URI.
+ *
+ * @see {@link https://www.rfc-editor.org/rfc/rfc8620.html#section-1.6.2 RFC 8620 Section 1.6.2 - Accounts}
+ */
+export interface JMAPAccountCapabilities extends AccountCapabilityRegistry {
+    [key: string & {}]: unknown;
+}
+/**
+ * A capability is referenced by a URI. The JMAP capability URI can be a URN
+ * starting with urn:ietf:params:jmap: plus a unique suffix that is the index
+ * value in the jmap URN sub-namespace. These are registered in the
+ * {@link https://www.iana.org/assignments/jmap/jmap.xhtml JMAP Capabilities Register}.
+ *
+ * Identifiers for vendor extensions MUST be a URL belonging to a domain owned by
+ * the vendor, to avoid conflict. The URL SHOULD resolve to documentation for the
+ * changes the extension makes.
+ *
+ * This is the list of Capability URIs declared via the ServerCapabilityRegistry.
+ *
+ * @see {@link JMAPCapabilityUri}
+ *
+ */
+export type JMAPCapability = keyof JMAPServerCapabilities;
+/**
+ * A capability is referenced by a URI. The JMAP capability URI can be a URN
+ * starting with urn:ietf:params:jmap: plus a unique suffix that is the index
+ * value in the jmap URN sub-namespace. These are registered in the
+ * {@link https://www.iana.org/assignments/jmap/jmap.xhtml JMAP Capabilities Register}.
+ *
+ * Identifiers for vendor extensions MUST be a URL belonging to a domain owned by
+ * the vendor, to avoid conflict. The URL SHOULD resolve to documentation for the
+ * changes the extension makes.
+ *
+ * The` list of capability URIs defined in the JMAP core specification and extensions.
+ * This is not an exhaustive list of all possible capabilities, as servers may support
+ * additional private capabilities as well; or newer capabilities defined in future
+ * specifications.
+ *
+ * @see {@link JMAPCapability}
+ */
+export type JMAPCapabilityUri = HintedString<BLOB_CAPABILITY_URI | CORE_CAPABILITY_URI | EMAIL_CAPABILITY_URI | SUBMISSION_CAPABILITY_URI | VACATIONRESPONSE_CAPABILITY_URI | MDN_CAPABILITY_URI | SMIMEVERIFY_CAPABILITY_URI | QUOTA_CAPABILITY_URI | WEBPUSH_VAPID_CAPABILITY_URI | CALENDARS_CAPABILITY_URI | CALENDARS_PARSE_CAPABILITY_URI | PRINCIPALS_CAPABILITY_URI | PRINCIPALS_AVAILABILITY_CAPABILITY_URI | PRINCIPALS_OWNER_CAPABILITY_URI | CONTACTS_CAPABILITY_URI | TASKS_CAPABILITY_URI | TASKS_RECURRENCES_CAPABILITY_URI | TASKS_ASSIGNEES_CAPABILITY_URI | TASKS_ALERTS_CAPABILITY_URI | TASKS_MULTILINGUAL_CAPABILITY_URI | TASKS_CUSTOMTIMEZONES_CAPABILITY_URI | MASKED_EMAIL_CAPABILITY_URI> | JMAPCapability;
+/**
+ * A map of a (client-specified) creation id to the id the server assigned when
+ * a record was successfully created.
+ */
+export type IdMap = Record<Id, Id>;
+/**
+ * To allow clients to make more efficient use of the network and avoid round trips,
+ * an argument to one method can be taken from the result of a previous method call
+ * in the same request.
+ */
+export interface JMAPResultReference {
+    /**
+     * The method call id of a previous method call in the current request.
+     */
+    resultOf: string;
+    /**
+     * The required name of a response to that method call.
+     */
+    name: string;
+    /**
+     * A pointer into the arguments of the response selected via the name and resultOf properties.
+     * This is a JSON Pointer {@link https://www.rfc-editor.org/rfc/rfc6901.html RFC 6901}, except it also
+     * allows the use of `*` to map through an array.
+     */
+    path: string;
+}
+/**
+ * An object containing named arguments for a method request.
+ *
+ * The value of property names starting with a hash (`#`) must be Result References.
+ * All other property names may have any suitable value.
+ */
+export interface JMAPRequestInvocationArgs {
+    /**
+     * A named argument for a method.
+     */
+    [key: string]: JSONValue;
+    /**
+     * A Result Reference to the result of a previous method call in a request.
+     */
+    [ref: `#${string}`]: Omit<JSONValue & JMAPResultReference, "member">;
+}
+/**
+ * An object containing named arguments for a method response.
+ */
+export interface JMAPResponseInvocationArgs {
+    /**
+     * A named argument for a method.
+     */
+    [key: string]: JSONValue;
+    /**
+     * A Result Reference to the result of a previous method call cannot appear in a response.
+     */
+    [ref: `#${string}`]: never;
+}
+/**
+ * An object containing named arguments for a method response that represents an error.
+ */
+export type JMAPResponseInvocationErrorArgs = JMAPResponseInvocationArgs & {
+    /**
+     * The type of error that occurred, as a string. This is a HintedString, so it can be any string, but the JMAP core specification defines some known error types that servers may use.
+     */
+    type: HintedString<"serverUnavailable" | "serverFail" | "serverPartialFail" | "unknownMethod" | "invalidArguments" | "invalidResultReference" | "forbidden" | "accountNotFound" | "accountNotSupportedByMethod" | "accountReadOnly" | "requestTooLarge" | "cannotCalculateChanges" | "stateMismatch" | "anchorNotFound" | "unsupportedSort" | "unsupportedFilter" | "tooManyChanges">;
+    /**
+     * A human-readable description of the error, which may be used for debugging or logging purposes.
+     */
+    description?: string;
+};
+/**
+ * This is a tuple, represented as a JSON array containing three elements:
+ *
+ * - The name of the method to call.
+ * - An object containing named arguments for that method request.
+ * - The method call id: an arbitrary string from the client to be echoed
+ *   back with the responses emitted by that method call.
+ */
+export type JMAPRequestInvocation = [name: string, args: JMAPRequestInvocationArgs, methodCallId: Id];
+/**
+ * This is a tuple, represented as a JSON array containing three elements:
+ *
+ * - The name of the method response.
+ * - An object containing named arguments for that response.
+ * - The method call id: an arbitrary string from corresponding request method set by the client
+ */
+export type JMAPResponseInvocation = [name: string, args: JMAPResponseInvocationArgs, methodCallId: Id];
+/**
+ * A Request object.
+ */
+export type JMAPRequest = {
+    /**
+     * The set of capabilities the client wishes to use. The client MAY include
+     * capability identifiers even if the method calls it makes do not utilise
+     * those capabilities.
+     */
+    using: JMAPCapability[];
+    /**
+     * An array of method calls to process on the server.
+     */
+    methodCalls: JMAPRequestInvocation[];
+    /**
+     * An optional map of a (client-specified) creation id to the id the server
+     * assigned when a record was successfully created.
+     */
+    createdIds?: IdMap;
+};
+/**
+ * A Response object.
+ */
+export type JMAPResponse = {
+    /**
+     * An array of responses, in the same format as the methodCalls on the Request object.
+     */
+    methodResponses: JMAPResponseInvocation[];
+    /**
+     * A map of a (client-specified) creation id to the id the server assigned
+     * when a record was successfully created.
+     */
+    createdIds?: IdMap;
+    /**
+     * The current value of the `state` string on the Session object.
+     */
+    sessionState: string;
+};
+/**
+ * Known JMAP request-level error types defined in the JMAP core specification (RFC 8620).
+ */
+export type JMAPRequestErrorTypes = UNKNOWN_CAPABILITY | NOT_JSON | NOT_REQUEST | LIMIT;
+/**
+ * Structure of a Problem Details object used for JMAP request-level error responses.
+ *
+ * This follows {@link https://www.rfc-editor.org/rfc/rfc7807.html RFC 7807} "Problem Details for HTTP APIs" format.
+ */
+export interface ProblemDetails<T extends string = string> {
+    /**
+     * A URI reference that identifies the problem type.
+     * When dereferenced, it SHOULD provide human-readable documentation for the problem type.
+     * This MUST be a string in URI format.
+     */
+    type: HintedString<T>;
+    /**
+     * A short, human-readable summary of the problem type.
+     * It SHOULD NOT change from occurrence to occurrence of the problem,
+     * except for purposes of localization.
+     */
+    title?: string;
+    /**
+     * The HTTP status code for this occurrence of the problem.
+     */
+    status?: number;
+    /**
+     * A human-readable explanation specific to this occurrence of the problem.
+     */
+    detail?: string;
+    /**
+     * A URI reference that identifies the specific occurrence of the problem.
+     */
+    instance?: string;
+    /**
+     * Additional properties specific to the problem type.
+     */
+    [key: string]: JSONValue | undefined;
+}