@remit/data-ports 0.0.94 → 1.0.0

package/dist/account-settings.d.ts

@@ -132,6 +132,10 @@ export declare const accountSettingRegistry: {
         kind: z.ZodLiteral<"String">;
         value: z.ZodString;
     }, z.core.$strip>;
+    readonly DefaultInvitationSenderAccountId: z.ZodObject<{
+        kind: z.ZodLiteral<"String">;
+        value: z.ZodString;
+    }, z.core.$strip>;
 };
 export type AccountSettingRegistry = typeof accountSettingRegistry;
 export type AccountSettingValueFor<N extends AccountSettingNameValue> = z.infer<AccountSettingRegistry[N]>;

package/dist/account-settings.js

@@ -77,6 +77,7 @@ export const accountSettingRegistry = {
      * write new rows under this name. Remove once the row-deletion migration ships.
      */
     [AccountSettingName.MailboxRole]: StringSettingSchema,
+    [AccountSettingName.DefaultInvitationSenderAccountId]: StringSettingSchema,
 };
 /**
  * Separator between a setting's base enum member and its per-target suffix in a

package/dist/id.d.ts

@@ -39,6 +39,8 @@ export declare const deriveCalendarFeedTokenId: (calendarId: string) => string;
  * row and silently lose the second.
  */
 export declare const deriveCalendarObjectId: (calendarId: string, resourceName: string) => string;
+/** Identity of a task, derived from its collection and resource name. */
+export declare const deriveCalendarTaskId: (calendarId: string, resourceName: string) => string;
 /**
  * Identity of a suggestion read out of a message (issue #1033). Derived from
  * the message, the MIME part the bytes came from and the event's iCalendar

package/dist/id.js

@@ -42,6 +42,8 @@ export const deriveCalendarFeedTokenId = (calendarId) => base36uuidv5(`calendarf
  * row and silently lose the second.
  */
 export const deriveCalendarObjectId = (calendarId, resourceName) => base36uuidv5(`calendarobject:${calendarId}:${resourceName}`, REMIT_NAMESPACE);
+/** Identity of a task, derived from its collection and resource name. */
+export const deriveCalendarTaskId = (calendarId, resourceName) => base36uuidv5(`calendartask:${calendarId}:${resourceName}`, REMIT_NAMESPACE);
 /**
  * Identity of a suggestion read out of a message (issue #1033). Derived from
  * the message, the MIME part the bytes came from and the event's iCalendar

package/dist/index.d.ts

@@ -10,8 +10,9 @@ export type { ICalendarCollectionRepository } from "./interfaces/calendar-collec
 export type { ICalendarEventIndexRepository } from "./interfaces/calendar-event-index.js";
 export type { ICalendarFeedTokenRepository } from "./interfaces/calendar-feed-token.js";
 export type { ICalendarObjectRepository } from "./interfaces/calendar-object.js";
-export type { CalendarRepositories, CalendarWrite, DeleteCalendarCollectionWrite, DeleteCalendarObjectWrite, ICalendarStore, PutCalendarObjectWrite, ReprojectCalendarObjectWrite, SettleCalendarSuggestionWrite, UpdateCalendarCollectionWrite, } from "./interfaces/calendar-store.js";
+export type { CalendarCommitReport, CalendarRepositories, CalendarWrite, DeleteCalendarCollectionWrite, DeleteCalendarObjectWrite, ICalendarStore, PutCalendarObjectWrite, ReprojectCalendarObjectWrite, SettleCalendarSuggestionWrite, UpdateCalendarCollectionWrite, } from "./interfaces/calendar-store.js";
 export type { ICalendarSuggestionRepository, SettleCalendarSuggestionInput, } from "./interfaces/calendar-suggestion.js";
+export type { ICalendarTaskRepository } from "./interfaces/calendar-task.js";
 export type { IConfigImportRepository } from "./interfaces/config-import.js";
 export type { IEnvelopeRepository } from "./interfaces/envelope.js";
 export type { IFilterRepository } from "./interfaces/filter.js";
@@ -29,6 +30,7 @@ export type { CreateOutboxAttachmentInput, IOutboxAttachmentRepository, OutboxAt
 export { holdsRoom } from "./interfaces/outbox-attachment.js";
 export type { IOutboxMessageRepository } from "./interfaces/outbox-message.js";
 export { APPENDED_UID_NONE, APPENDED_UID_UNREPORTED, isSentCopyFiled, } from "./interfaces/outbox-message.js";
+export type { IOutboxSchedulingPartRepository } from "./interfaces/outbox-scheduling-part.js";
 export type { IQuarantineRepository } from "./interfaces/quarantine.js";
 export { type FifoQueueMessage, type FifoQueueProducer, type GroupedQueueMessage, type GroupedQueueProducer, QUEUE_BATCH_LIMIT, type QueueBatchResult, type QueueKind, type QueueMessage, type QueueProducer, type QueueProducerOf, } from "./interfaces/queue.js";
 export type { ISenderSignerStandingRepository } from "./interfaces/sender-signer-standing.js";
@@ -37,4 +39,4 @@ export type { IThreadMessageRepository } from "./interfaces/thread-message.js";
 export type { MessageSettlementFields } from "./message-settlement.js";
 export { abandonedMutationOf, hasAbandonedDelete, hasAbandonedMove, } from "./message-settlement.js";
 export { FILTER_NO_ACTION, isSenderMuted, isSenderMuteFilter, } from "./sender-mute.js";
-export type { AccountConfigDescription, AccountConfigItem, AccountDescription, AccountExportRequestItem, AccountItem, AccountSchedulerPage, AccountSettingItem, AccountSettingValue, AddressFlags, AddressItem, BodyPartItem, BodyPartParameterItem, BodyPartParameterUpsertInput, BodyPartUpsertInput, CalendarCollectionItem, CalendarEventIndexItem, CalendarFeedTokenItem, CalendarObjectItem, CalendarOccurrenceInput, CalendarSuggestionItem, ConfigImportItem, ConfigImportUnresolvedRefItem, CreateAccountConfigInput, CreateAccountExportRequestInput, CreateAccountInput, CreateAddressInput, CreateCalendarCollectionInput, CreateConfigImportInput, CreateEnvelopeAddressInput, CreateEnvelopeInput, CreateFilterInput, CreateLabelInput, CreateMailboxInput, CreateMailboxResult, CreateMessageFlagInput, CreateMessageInput, CreateMessageLabelInput, CreateOrganizeJobRequestInput, CreateOutboxMessageInput, CreateThreadMessageInput, EnvelopeAddressItem, EnvelopeItem, FilterItem, FlagsMergePatch, LabelItem, ListOptions, MailboxItem, MailboxLockItem, MailboxSpecialUseItem, MailboxSpecialUseValue, MailboxStatePredicate, MailboxSubtreeTransitionIntent, MailboxTransitionIntent, MailboxTransitionWrite, MessageData, MessageDescription, MessageFlagItem, MessageFlagPushItem, MessageIdSource, MessageItem, MessageLabelItem, MessagePlacementMoveItem, MessageReferenceInput, MessageReferenceItem, ObserveSenderSignerStandingInput, OrganizeJobRequestItem, OutboxAttachmentItem, OutboxMessageItem, PlacementPredicate, PlacementTransitionInput, PutCalendarFeedTokenInput, PutCalendarObjectInput, PutCalendarSuggestionInput, PutMessageFlagPushInput, PutMessagePlacementMoveInput, QuarantineItem, QuarantineMimeNodeItem, QuarantineUpsertInput, RawMessageStorageItem, RemovableAccountField, ResultList, SearchOptions, SenderSignerStandingItem, SyncWarningItem, SyncWarningKey, ThreadMessageFieldTerm, ThreadMessageItem, UpdateAccountConfigInput, UpdateAccountExportRequestInput, UpdateAccountInput, UpdateAddressInput, UpdateCalendarCollectionInput, UpdateConfigImportInput, UpdateEnvelopeInput, UpdateFilterInput, UpdateLabelInput, UpdateMailboxInput, UpdateMessageInput, UpdateOrganizeJobRequestInput, UpdateOutboxMessageInput, UpdateThreadMessageInput, UpsertAccountSettingInput, WithMailboxLockResult, } from "./types.js";
+export type { AccountConfigDescription, AccountConfigItem, AccountDescription, AccountExportRequestItem, AccountItem, AccountSchedulerPage, AccountSettingItem, AccountSettingValue, AddressFlags, AddressItem, BodyPartItem, BodyPartParameterItem, BodyPartParameterUpsertInput, BodyPartUpsertInput, CalendarCollectionItem, CalendarEventIndexItem, CalendarFeedTokenItem, CalendarObjectItem, CalendarOccurrenceInput, CalendarSuggestionItem, CalendarTaskItem, ConfigImportItem, ConfigImportUnresolvedRefItem, CreateAccountConfigInput, CreateAccountExportRequestInput, CreateAccountInput, CreateAddressInput, CreateCalendarCollectionInput, CreateConfigImportInput, CreateEnvelopeAddressInput, CreateEnvelopeInput, CreateFilterInput, CreateLabelInput, CreateMailboxInput, CreateMailboxResult, CreateMessageFlagInput, CreateMessageInput, CreateMessageLabelInput, CreateOrganizeJobRequestInput, CreateOutboxMessageInput, CreateOutboxSchedulingPartInput, CreateThreadMessageInput, EnvelopeAddressItem, EnvelopeItem, FilterItem, FlagsMergePatch, LabelItem, ListOptions, MailboxItem, MailboxLockItem, MailboxSpecialUseItem, MailboxSpecialUseValue, MailboxStatePredicate, MailboxSubtreeTransitionIntent, MailboxTransitionIntent, MailboxTransitionWrite, MessageData, MessageDescription, MessageFlagItem, MessageFlagPushItem, MessageIdSource, MessageItem, MessageLabelItem, MessagePlacementMoveItem, MessageReferenceInput, MessageReferenceItem, ObserveSenderSignerStandingInput, OrganizeJobRequestItem, OutboxAttachmentItem, OutboxMessageItem, OutboxSchedulingPartItem, PlacementPredicate, PlacementTransitionInput, PutCalendarFeedTokenInput, PutCalendarObjectInput, PutCalendarSuggestionInput, PutCalendarTaskInput, PutMessageFlagPushInput, PutMessagePlacementMoveInput, QuarantineItem, QuarantineMimeNodeItem, QuarantineUpsertInput, RawMessageStorageItem, RemovableAccountField, ResultList, SearchOptions, SenderSignerStandingItem, SyncWarningItem, SyncWarningKey, ThreadMessageFieldTerm, ThreadMessageItem, UpdateAccountConfigInput, UpdateAccountExportRequestInput, UpdateAccountInput, UpdateAddressInput, UpdateCalendarCollectionInput, UpdateConfigImportInput, UpdateEnvelopeInput, UpdateFilterInput, UpdateLabelInput, UpdateMailboxInput, UpdateMessageInput, UpdateOrganizeJobRequestInput, UpdateOutboxMessageInput, UpdateThreadMessageInput, UpsertAccountSettingInput, WithMailboxLockResult, } from "./types.js";

package/dist/interfaces/calendar-store.d.ts

@@ -87,7 +87,15 @@ export type CalendarWrite = PutCalendarObjectWrite | ReprojectCalendarObjectWrit
  * returned before it, and a write that a stale read would get wrong is keyed so
  * that repeating or racing it converges (derived ids, upserts).
  */
+/** What a commit could not do because a read it was decided on went stale. */
+export interface CalendarCommitReport {
+    /**
+     * The resources whose `ReprojectObject` wrote nothing, because they were
+     * edited or deleted after they were read.
+     */
+    staleReprojections: string[];
+}
 export interface ICalendarStore {
     readonly repos: CalendarRepositories;
-    commit(writes: readonly CalendarWrite[]): Promise<void>;
+    commit(writes: readonly CalendarWrite[]): Promise<CalendarCommitReport>;
 }

package/dist/interfaces/calendar-task.d.ts

@@ -0,0 +1,13 @@
+import type { CalendarTaskItem, PutCalendarTaskInput } from "../types.js";
+/**
+ * The tasks of `VtodoOnly` collections. Every write is one row, so there is no
+ * write set: a task has no occurrence rows and no sync sequence to keep in step.
+ */
+export interface ICalendarTaskRepository {
+    put(input: PutCalendarTaskInput): Promise<CalendarTaskItem>;
+    find(calendarId: string, calendarTaskId: string): Promise<CalendarTaskItem | null>;
+    delete(calendarId: string, calendarTaskId: string): Promise<void>;
+    /** Tasks due within `[fromAt, toAt)`, UTC instants, in due order. */
+    listByDueRange(calendarId: string, fromAt: string, toAt: string): Promise<CalendarTaskItem[]>;
+    deleteByCalendar(calendarId: string): Promise<void>;
+}

package/dist/interfaces/calendar-task.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/outbox-message.d.ts

@@ -1,4 +1,4 @@
-import type { CreateOutboxMessageInput, OutboxMessageItem, ResultList, UpdateOutboxMessageInput } from "../types.js";
+import type { CreateOutboxMessageInput, CreateOutboxSchedulingPartInput, OutboxMessageItem, ResultList, UpdateOutboxMessageInput } from "../types.js";
 /** `appendedUid` when no IMAP APPEND has been confirmed for the row. */
 export declare const APPENDED_UID_NONE = 0;
 /**
@@ -20,7 +20,11 @@ export declare const APPENDED_UID_UNREPORTED = -1;
  */
 export declare const isSentCopyFiled: (message: Pick<OutboxMessageItem, "appendedUid">) => boolean;
 export interface IOutboxMessageRepository {
-    create(input: CreateOutboxMessageInput): Promise<OutboxMessageItem>;
+    /**
+     * With a scheduling part, the message and its part are one write: a queued
+     * invitation without its calendar part would go out as a bare mail.
+     */
+    create(input: CreateOutboxMessageInput, schedulingPart?: CreateOutboxSchedulingPartInput): Promise<OutboxMessageItem>;
     /**
      * `mode: "read"` (default) throws NotFoundError on a foreign message so a
      * GET doesn't leak existence. `mode: "act"` throws ForbiddenError instead,

package/dist/interfaces/outbox-scheduling-part.d.ts

@@ -0,0 +1,11 @@
+import type { OutboxSchedulingPartItem } from "../types.js";
+/**
+ * The scheduling parts of outbox messages. A part is written with its message
+ * (`IOutboxMessageRepository.create`) and removed with it, so it is only ever
+ * read here.
+ */
+export interface IOutboxSchedulingPartRepository {
+    find(outboxMessageId: string): Promise<OutboxSchedulingPartItem | null>;
+    /** The parts about one event whose messages are still in the outbox. */
+    listByCalendarObject(accountConfigId: string, calendarObjectId: string): Promise<OutboxSchedulingPartItem[]>;
+}

package/dist/interfaces/outbox-scheduling-part.js

@@ -0,0 +1 @@
+export {};

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-import type { AccountConfigSchema, AccountSchema, AddressSchema, BodyPartParameterSchema, BodyPartSchema, CalendarCollectionSchema, CalendarEventIndexSchema, CalendarFeedTokenSchema, CalendarObjectSchema, CalendarSuggestionSchema, ConfigImportSchema, ConfigImportUnresolvedRefSchema, EnvelopeAddressSchema, EnvelopeSchema, FilterSchema, LabelSchema, MailboxLockSchema, MailboxSchema, MailboxSpecialUseEntrySchema, MailboxSpecialUseSchema, MessageFlagPushSchema, MessageFlagSchema, MessageLabelSchema, MessagePlacementMoveSchema, MessageRecordSchema, OrganizeJobRequestSchema, OutboxAttachmentSchema, OutboxMessageSchema, QuarantineSchema, RawMessageStorageSchema, SenderSignerStandingSchema, SyncWarningSchema, ThreadMessageSchema } from "@remit/api-zod-schemas";
+import type { AccountConfigSchema, AccountSchema, AddressSchema, BodyPartParameterSchema, BodyPartSchema, CalendarCollectionSchema, CalendarEventIndexSchema, CalendarFeedTokenSchema, CalendarObjectSchema, CalendarSuggestionSchema, CalendarTaskSchema, ConfigImportSchema, ConfigImportUnresolvedRefSchema, EnvelopeAddressSchema, EnvelopeSchema, FilterSchema, LabelSchema, MailboxLockSchema, MailboxSchema, MailboxSpecialUseEntrySchema, MailboxSpecialUseSchema, MessageFlagPushSchema, MessageFlagSchema, MessageLabelSchema, MessagePlacementMoveSchema, MessageRecordSchema, OrganizeJobRequestSchema, OutboxAttachmentSchema, OutboxMessageSchema, OutboxSchedulingPartSchema, QuarantineSchema, RawMessageStorageSchema, SenderSignerStandingSchema, SyncWarningSchema, ThreadMessageSchema } from "@remit/api-zod-schemas";
 import type { ReferenceType } from "@remit/domain-enums";
 import type { z } from "zod";
 export type ResultList<T> = {
@@ -25,6 +25,12 @@ export type MailboxItem = z.infer<typeof MailboxSchema>;
 export type ThreadMessageItem = z.infer<typeof ThreadMessageSchema>;
 export type OutboxMessageItem = z.infer<typeof OutboxMessageSchema>;
 export type OutboxAttachmentItem = z.infer<typeof OutboxAttachmentSchema>;
+export type OutboxSchedulingPartItem = z.infer<typeof OutboxSchedulingPartSchema>;
+/**
+ * The scheduling part an outbox message is created with. Its `outboxMessageId`
+ * and `accountConfigId` are the message's own.
+ */
+export type CreateOutboxSchedulingPartInput = Pick<OutboxSchedulingPartItem, "calendarObjectId" | "recipient" | "method" | "sequence" | "icalData">;
 export type MessageItem = z.infer<typeof MessageRecordSchema>;
 export type MessageFlagItem = z.infer<typeof MessageFlagSchema>;
 export type BodyPartItem = z.infer<typeof BodyPartSchema>;
@@ -430,6 +436,13 @@ export type UpdateFilterInput = Partial<Omit<CreateFilterInput, "accountConfigId
 export type CalendarCollectionItem = z.infer<typeof CalendarCollectionSchema>;
 export type CalendarObjectItem = z.infer<typeof CalendarObjectSchema>;
 export type CalendarEventIndexItem = z.infer<typeof CalendarEventIndexSchema>;
+export type CalendarTaskItem = z.infer<typeof CalendarTaskSchema>;
+/**
+ * A whole task resource, every projected column supplied with the `icalData`
+ * it was projected from. `calendarTaskId` derives from calendarId +
+ * resourceName, so this is an upsert.
+ */
+export type PutCalendarTaskInput = Omit<CalendarTaskItem, "calendarTaskId" | "createdAt" | "updatedAt">;
 export type CreateCalendarCollectionInput = Omit<CalendarCollectionItem, "calendarId" | "syncSequence" | "createdAt" | "updatedAt" | "color" | "componentSet" | "source" | "timezone" | "subscriptionUrl" | "subscriptionEnabled" | "subscriptionCheckedAt" | "subscriptionFetchedAt" | "subscriptionError"> & {
     color?: CalendarCollectionItem["color"];
     componentSet?: CalendarCollectionItem["componentSet"];

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@remit/data-ports",
-	"version": "0.0.94",
+	"version": "1.0.0",
 	"type": "module",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",