@remit/api-openapi-types 0.0.40 → 0.0.41

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remit/api-openapi-types",
-  "version": "0.0.40",
+  "version": "0.0.41",
   "type": "module",
   "main": "types.d.ts",
   "types": "types.d.ts",

package/types.d.ts

@@ -265,6 +265,30 @@ distinguishable from a network failure without parsing prose.
      * Which piece of configuration a still-unbound folder reference belongs to. A mailbox id is regenerated by every discovery, so an imported file names folders by IMAP path and the binder writes the row once a path resolves.
      */
     export type ConfigImportRefKind = "FolderRole" | "MailboxOverride" | "FilterAction";
+    /**
+     * Display color for a calendar collection. Positional rather than named: the palette is a client-side concern, so the store carries the slot and the client owns what it renders (issue #15).
+     */
+    export type CalendarColor = "Cal1" | "Cal2" | "Cal3" | "Cal4" | "Cal5" | "Cal6";
+    /**
+     * Which iCalendar components a collection accepts (RFC 4791 supported-calendar-component-set). Only VEVENT is stored today; VTODO and VJOURNAL collections would be separate members, so the value is a property of the collection rather than of each object.
+     */
+    export type CalendarComponentSet = "VeventOnly";
+    /**
+     * Where a calendar collection came from. `Default` is the one provisioned per account config on first use and is never deleted; `UserCreated` is one a person made; `MailDerived` is one populated from mail rather than by a person.
+     */
+    export type CalendarSource = "Default" | "UserCreated" | "MailDerived";
+    /**
+     * Projection of a VEVENT's STATUS property (RFC 5545 3.8.1.11). A VEVENT with no STATUS projects as `Confirmed`, which is the value RFC 5545 gives an event whose status is unstated.
+     */
+    export type CalendarEventStatus = "Confirmed" | "Tentative" | "Cancelled";
+    /**
+     * Projection of a VEVENT's TRANSP property (RFC 5545 3.8.2.7) — whether the event consumes free/busy time. A VEVENT with no TRANSP projects as `Opaque`, the RFC default.
+     */
+    export type CalendarTransparency = "Opaque" | "Transparent";
+    /**
+     * How confidently a stored time was placed on the clock. A calendar that cannot say this hides its worst failure: an event read in the wrong zone is off by hours and looks exactly like an event read correctly.
+     */
+    export type ZoneCertainty = "Local" | "Explicit" | "Ambiguous";
     /**
      * Explicit state engine for a pending placement-move marker (issue #1271, epic #1281). Recovery keys off this field, not control-flow inference: a redelivered/retried call drives a marker forward from whichever state it is actually in, rather than re-deriving intent by comparing the message's current location.
      */
@@ -4927,6 +4951,202 @@ domain already uses"; it does not close it.
       createdAt: number;
       updatedAt: number;
     }
+    /**
+     * A calendar collection scoped to an account config (issue #15) — the CalDAV
+collection a client mounts, and the parent of every CalendarObject.
+
+`calendarId` is derived from `(accountConfigId, urlSegment)`, so the DAV path
+a client bookmarks resolves to a row without a lookup table, and provisioning
+the same collection twice writes the same row instead of a second one.
+`displayName` is the mutable human overlay and is never the key.
+
+`syncSequence` is the collection's monotonic change counter: every write
+through the calendar service's put path bumps it and stamps the new value on
+the object it wrote, which is what a later WebDAV-Sync `sync-token` reports
+and what `CalendarObject.bySyncSequence` pages by.
+     */
+    export interface CalendarCollection {
+      /**
+       * Primary identifier, derived from accountConfigId + urlSegment
+       */
+      calendarId: UUID;
+      /**
+       * Owning account configuration
+       */
+      accountConfigId: UUID;
+      /**
+       * Path segment this collection is addressed by, unique within the account config. Stored case-folded, the same folding `calendarId` is derived from — a DAV path is matched case-insensitively, and storing the writer's casing would let a lookup by segment and a lookup by derived id disagree about one path. The default collection provisioned on first use holds "default".
+       */
+      urlSegment: String64;
+      /**
+       * Human-readable collection name (display)
+       */
+      displayName: String140;
+      /**
+       * Display color slot for this collection
+       */
+      color: CalendarColor;
+      /**
+       * Which iCalendar components this collection accepts
+       */
+      componentSet: CalendarComponentSet;
+      /**
+       * Where this collection came from
+       */
+      source: CalendarSource;
+      /**
+       * IANA time zone this collection's floating times are read in, e.g. "Europe/Amsterdam". `""` when none is set, which reads as UTC.
+       */
+      timezone: String64;
+      /**
+       * Monotonic change counter for this collection. Bumped by every write to one of its objects; the value stamped on `CalendarObject.syncSequence` is the value this counter held after that write.
+       */
+      syncSequence: number;
+      createdAt: number;
+      updatedAt: number;
+    }
+    /**
+     * One calendar resource — the bytes behind one `.ics` URL (issue #15).
+
+`icalData` is the canonical value. Every other column on this row is a
+projection of it, computed on write and never written independently: a reader
+that needs a fact the projection does not carry re-parses `icalData` rather
+than adding a column that could disagree with it.
+
+The write path parses the bytes to validate and project them and then stores
+the bytes it was handed, never a reserialization of them. That is what keeps
+`etag` honest: the tag is a digest of exactly what the writer sent, so it
+moves only when a writer sends something different. It is not a digest that
+survives a round trip through the parser — ical.js refolds long lines and
+reorders properties, so a resource stored as its own reserialization would
+change tag without anyone editing it, and every client's cache would miss.
+
+`calendarObjectId` is derived from `(calendarId, resourceName)`: the resource
+name is the last path segment of the resource's URL, so the URL a client holds
+resolves to a row directly, and a repeated PUT of the same resource rewrites
+its own row.
+     */
+    export interface CalendarObject {
+      /**
+       * Primary identifier, derived from calendarId + resourceName
+       */
+      calendarObjectId: UUID;
+      /**
+       * Collection this resource belongs to
+       */
+      calendarId: UUID;
+      /**
+       * Last path segment of the resource's URL, e.g. "a1b2c3.ics". Unique within the collection and chosen by whoever wrote the resource, never derived from its contents — a client is free to rename a resource without changing the event it holds.
+       */
+      resourceName: String256;
+      /**
+       * The VEVENT's UID property (RFC 5545 3.8.4.7). Identifies the event across collections and servers, which `resourceName` does not.
+       */
+      icalUid: String512;
+      /**
+       * The complete VCALENDAR text, byte-for-byte as stored — CANONICAL. Line endings are CRLF and are never normalized; unknown properties and components are preserved verbatim.
+       */
+      icalData: string;
+      /**
+       * Strong entity tag over the stored `icalData` bytes, used for If-Match on a conditional write and for change detection on read.
+       */
+      etag: String64;
+      /**
+       * The VEVENT's SEQUENCE property (RFC 5545 3.8.7.4) — the organizer's own revision counter, carried for scheduling comparisons. `0` when the event declares none, which is the RFC default.
+       */
+      sequence: number;
+      /**
+       * Value the owning collection's `syncSequence` held after the write that produced this row. Pages the `bySyncSequence` read.
+       */
+      syncSequence: number;
+      /**
+       * Projection of the VEVENT's SUMMARY (RFC 5545 3.8.1.12). `""` when the event carries none.
+       */
+      summary: String512;
+      /**
+       * Projection of the master VEVENT's DTSTART as an ISO 8601 date-time with zone offset — a business date, not an epoch instant. An all-day event carries midnight in the event's own zone.
+       */
+      dtStart: String64;
+      /**
+       * Projection of the master VEVENT's effective end as an ISO 8601 date-time with zone offset, resolved from DTEND or from DTSTART + DURATION. An event with neither ends when it starts (RFC 5545 3.6.1).
+       */
+      dtEnd: String64;
+      /**
+       * Whether the master VEVENT's DTSTART is a DATE rather than a DATE-TIME (RFC 5545 3.3.4) — an all-day or multi-day event, whose end is exclusive.
+       */
+      allDay: boolean;
+      /**
+       * How the master VEVENT's DTSTART was placed on the clock. `Ambiguous` means the resource named a zone nothing could resolve, so `dtStart` and every occurrence expanded from it may be off by hours — a client shows the event and says so rather than presenting a guess as a fact.
+       */
+      zoneCertainty: ZoneCertainty;
+      /**
+       * Projection of the master VEVENT's STATUS
+       */
+      status: CalendarEventStatus;
+      /**
+       * Projection of the master VEVENT's TRANSP
+       */
+      transparency: CalendarTransparency;
+      /**
+       * Whether the resource expands to more than its master instance — an RRULE, an RDATE, or an override VEVENT. Overrides count on their own: a client that edits one instance and then drops the rule leaves a resource with a master and its exceptions, and each of those is still an occurrence.
+       */
+      hasRecurrence: boolean;
+      /**
+       * ISO 8601 UTC instant through which `CalendarEventIndex` rows exist for this resource, when the series runs past the expansion horizon and the index is therefore incomplete. `""` when the index is exhaustive — a single event, or a series that ends inside the horizon. A later live-expansion pass reads this to find the resources whose instances it must compute rather than query.
+       */
+      expandedThrough: String64;
+      createdAt: number;
+      updatedAt: number;
+    }
+    /**
+     * One occurrence of a CalendarObject, flattened so a date range can be queried
+instead of expanded (issue #15). Every row is derived from
+`CalendarObject.icalData` and is replaced wholesale whenever that resource is
+written — nothing here is authoritative, and nothing writes here alone.
+
+`recurrenceId` is `""` for a resource that does not recur — its one row. A
+resource that does recur has no `""` row at all: every occurrence carries its
+own RECURRENCE-ID slot, the first one included, so an occurrence is
+addressable without a caller having to know whether it happened to be the
+series' first. It is part of the sort key, so it can never be absent — an
+optional value there would make the index sparse and hide the single-event
+row from the range read that has to return it.
+
+Times here are UTC instants, unlike `CalendarObject.dtStart`, which carries
+the event's own offset. The two are different jobs: `dtStart` is the value a
+client displays, and a fixed-width UTC instant is the only form in which a
+sort key orders correctly — comparing offset-bearing strings would sort
+`09:00+02:00` after `09:00Z`, and a range read would silently drop
+occurrences from every zone but its own.
+     */
+    export interface CalendarEventIndex {
+      /**
+       * Collection this occurrence belongs to
+       */
+      calendarId: UUID;
+      /**
+       * Resource this occurrence was expanded from
+       */
+      calendarObjectId: UUID;
+      /**
+       * RECURRENCE-ID of this occurrence as an ISO 8601 UTC instant, or `""` for the one row of a resource that does not recur. Canonicalized to UTC by the same rule the expansion uses, so an override's RECURRENCE-ID and the occurrence it replaces resolve to the same value.
+       */
+      recurrenceId: String64;
+      /**
+       * When this occurrence starts, as an ISO 8601 UTC instant. An all-day occurrence starts at midnight of its civil date read in the collection's timezone.
+       */
+      startAt: String64;
+      /**
+       * When this occurrence ends, as an ISO 8601 UTC instant. Exclusive for an all-day occurrence, per RFC 5545 3.6.1.
+       */
+      endAt: String64;
+      /**
+       * Whether this occurrence is all-day, copied from the resource it came from so a range read never has to join back to it. A client renders an all-day occurrence as the civil date its start falls on in the collection's timezone, not as the instant stored here.
+       */
+      allDay: boolean;
+      createdAt: number;
+      updatedAt: number;
+    }
     /**
      * Junction whose existence *is* a label assignment (RFC 030). Holds only ids
 and is hydrated with `batchGet`. Keyed by a deterministic UUID v5 derived
@@ -6872,6 +7092,9 @@ export type BodyPartParameter = Components.Schemas.BodyPartParameter;
 export type RawMessageStorage = Components.Schemas.RawMessageStorage;
 export type BodyPartStorage = Components.Schemas.BodyPartStorage;
 export type BodyPartContent = Components.Schemas.BodyPartContent;
+export type CalendarCollection = Components.Schemas.CalendarCollection;
+export type CalendarObject = Components.Schemas.CalendarObject;
+export type CalendarEventIndex = Components.Schemas.CalendarEventIndex;
 export type MessageLabel = Components.Schemas.MessageLabel;
 export type FilterAnchor = Components.Schemas.FilterAnchor;
 export type MicrosoftOAuthStartRequest = Components.Schemas.MicrosoftOAuthStartRequest;
@@ -6931,6 +7154,12 @@ export type ContentEncoding = Components.Schemas.ContentEncoding;
 export type AccountSettingName = Components.Schemas.AccountSettingName;
 export type ConfigImportState = Components.Schemas.ConfigImportState;
 export type ConfigImportRefKind = Components.Schemas.ConfigImportRefKind;
+export type CalendarColor = Components.Schemas.CalendarColor;
+export type CalendarComponentSet = Components.Schemas.CalendarComponentSet;
+export type CalendarSource = Components.Schemas.CalendarSource;
+export type CalendarEventStatus = Components.Schemas.CalendarEventStatus;
+export type CalendarTransparency = Components.Schemas.CalendarTransparency;
+export type ZoneCertainty = Components.Schemas.ZoneCertainty;
 export type MessagePlacementMoveState = Components.Schemas.MessagePlacementMoveState;
 export type FlagPushOperation = Components.Schemas.FlagPushOperation;
 export type MessageFlagPushState = Components.Schemas.MessageFlagPushState;