@remit/api-openapi-types 0.0.48 → 0.0.50

package/package.json

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

package/types.d.ts

@@ -174,7 +174,7 @@ current enum emitter anyway, so the wire contract uses the bare form.
      */
     export type StarColor = "none" | "yellow" | "orange" | "red" | "purple" | "blue" | "teal" | "green" | "yellow_bang" | "red_bang" | "purple_question" | "blue_info" | "orange_guillemet" | "green_check" | "yellow_check" | "blue_star";
     /**
-     * Header-derived message category. Set by classifyByHeaders during body-sync. Defaults to `uncategorized` until the message is body-classified.
+     * Header-derived message category. Set by classifyByHeaders during body-sync. Defaults to `uncategorized`, which covers both a message that has not been classified yet and one the classifier declined to categorize; `Message.classificationState` is what tells those apart.
      */
     export type MessageCategory = "uncategorized" | "personal" | "newsletter" | "marketing" | "automated" | "transactional" | "social";
     /**
@@ -185,6 +185,14 @@ current enum emitter anyway, so the wire contract uses the bare form.
      * How the From display name relates to the From domain. `Corresponds` — the name is contained in the domain. `Lookalike` — the name is one or two characters away from a domain label. `ForeignAddress` — the name spells out an email address at a domain the sender does not send from. `Unrelated` — no relation. `NoClaim` — the name is empty, or is an address at the sending domain, so it claims no other identity.
      */
     export type DisplayNameCorrespondence = "Corresponds" | "Lookalike" | "ForeignAddress" | "Unrelated" | "NoClaim";
+    /**
+     * Message lifecycle status for move/delete operations
+     */
+    export type MessageStatus = "active" | "deleting" | "deleted" | "moving";
+    /**
+     * Sync status for message move/delete operations
+     */
+    export type MessageSyncStatus = "synced" | "pending" | "failed";
     /**
      * Actionable placement verdict — the direction Remit decided to move a message. `leave` is not represented: a left-in-place verdict means the placement sub-model is absent.
      */
@@ -214,13 +222,9 @@ distinguishable from a network failure without parsing prose.
      */
     export type OutboxAttachmentRejectionReason = "EmptyFile" | "UnusableFilename" | "FileTooLarge" | "MessageTooLarge" | "TooManyAttachments" | "ReservationExpired" | "UploadMissing" | "SizeMismatch";
     /**
-     * Message lifecycle status for move/delete operations
+     * Whether the header classifier has examined a message's body (issue #331). Persistence-level state on `Message`, deliberately off the wire: no response model carries it. It exists because `category` cannot answer this question — `uncategorized` is both the value a metadata-synced row starts at and the answer the classifier gives when it has nothing to say, so a guard reading `category` alone cannot tell "never examined" from "examined and declined" and re-reads the stored body on every sync pass forever.
      */
-    export type MessageStatus = "active" | "deleting" | "deleted" | "moving";
-    /**
-     * Sync status for message move/delete operations
-     */
-    export type MessageSyncStatus = "synced" | "pending" | "failed";
+    export type MessageClassificationState = "NotExamined" | "Examined";
     /**
      * Sender-authenticity tier for a message, resolved at body-sync from the trusted Authentication-Results header and the sender's pair-keyed standing. First match wins, in tier order: `Impersonation`, `Aligned`, `Authenticated`, `Routine`, `NotChecked`, `Caution`. `NotEvaluated` is the sentinel for a message the derivation has never run on — it is the default and what every message written before this field existed carries, and it is distinct from `NotChecked`, which is a result.
      */
@@ -3274,7 +3278,7 @@ asking "is this slot free" never has to do the merging itself.
        */
       snippet?: String256;
       /**
-       * Header-derived category, denormalized from the underlying Message. Defaults to `uncategorized` at metadata-sync and is set to the classified value at body-sync — that pending state is a named value, not absence.
+       * Header-derived category, denormalized from the underlying Message. Defaults to `uncategorized` at metadata-sync and is set to the classifier's answer at body-sync — `uncategorized` is a named value, not absence, and it is also the answer a classifier with nothing to say gives. Whether the classifier has run at all is `Message.classificationState`; this row has no column for it.
        */
       category: MessageCategory;
       createdAt: number;
@@ -3347,7 +3351,7 @@ asking "is this slot free" never has to do the merging itself.
       createdAt: number;
       updatedAt: number;
       /**
-       * Header-derived category for the message, served from the ThreadMessage row. Always present: the column is NOT NULL with an `uncategorized` default, and `uncategorized` is a named value for the not-yet-classified state, never a stand-in for `personal` (issue #45).
+       * Header-derived category for the message, served from the ThreadMessage row. Always present: the column is NOT NULL with an `uncategorized` default, and `uncategorized` is a named value — no category — never a stand-in for `personal` (issue #45).
        */
       category: MessageCategory;
       /**
@@ -3362,6 +3366,14 @@ asking "is this slot free" never has to do the merging itself.
        * Structured sender-authenticity signal derived from DKIM headers at classification time (from the underlying Message). Absent for messages classified before this field was introduced — absence means no signal.
        */
       authenticity?: MessageAuthenticity;
+      /**
+       * Mutation lifecycle of the underlying Message, projected at read time — the ThreadMessage row has no column of its own. `active` means no move or delete is outstanding; `moving` or `deleting` means one is, and this row's folder is a local write the mail server has not confirmed.
+       */
+      status: MessageStatus;
+      /**
+       * Sync status of the underlying Message, projected at read time. Read it WITH `status`, never alone: `message-move`, `message-delete` and `message-copy` all write `failed` on an ordinary transient attempt before a redelivery that usually succeeds, so `failed` by itself does not mean a mutation gave up. One pair does prove one: `active` + `failed`, written only by `abandonDelete` — a delete Remit refused to run and handed back. Nothing else here is decidable. A move that gave up leaves `moving` + `failed`, the same pair its first dropped connection leaves; a delete that exhausted its retries is repaired to `active` + `synced` and reads as settled; `flag-push` and `placement-move-push` never write either field.
+       */
+      syncStatus: MessageSyncStatus;
       /**
        * Account identifier attached at read time via a mailboxId→accountId map. Present on rows returned by `GET /threads`; absent on rows from per-mailbox endpoints (clients can resolve from the mailbox cache).
        */
@@ -4394,9 +4406,13 @@ either way and cannot tell which it received.
        */
       originalUid?: number;
       /**
-       * Header-derived category. Defaults to `uncategorized` for messages that have been metadata-synced but not yet body-classified — that pending state is a named value, not absence.
+       * Header-derived category. Defaults to `uncategorized`, a named value rather than absence. It covers two states — metadata-synced but not yet classified, and classified with nothing to say — and `classificationState` is what tells them apart.
        */
       category: MessageCategory;
+      /**
+       * Whether the header classifier has examined this message's body. Defaults to `NotExamined`, the named pending state every message written before this field existed carries. A field of its own rather than a reading of `category` or of `bodyStorageKey`: `uncategorized` is both the pending value and the classifier's own "nothing to say", and key presence is the storage fact, not the derivation's. Persistence-only — no response model exposes it — and it is what a later backfill selects the never-examined cohort by.
+       */
+      classificationState: MessageClassificationState;
       /**
        * Structured sender-authenticity signal derived from DKIM headers at classification time. Absent for messages classified before this field was introduced — absence means no signal.
        */
@@ -4552,6 +4568,14 @@ either way and cannot tell which it received.
        * Message-ID header value for quick reference
        */
       messageIdHeader?: string;
+      /**
+       * Message lifecycle status for move/delete operations. Defaults to `active` (normal, visible).
+       */
+      status: MessageStatus;
+      /**
+       * Sync status for move/delete operations. The `synced` column default only applies to a row written without the field: the repository always supplies one, and an ordinary inbound sync writes `pending`, which nothing later promotes. So `pending` here does not mean an outstanding move or delete — `status` names that, and `failed` marks a mutation that gave up.
+       */
+      syncStatus: MessageSyncStatus;
       /**
        * Structured sender-authenticity signal derived from DKIM headers at classification time. Absent for messages classified before this field was introduced — absence means no signal.
        */
@@ -4610,7 +4634,7 @@ either way and cannot tell which it received.
        */
       replyTo: EnvelopeAddressResponse[];
       /**
-       * Header-derived category for the message. Always present: `Message.category` is NOT NULL with an `uncategorized` default, and `uncategorized` names the not-yet-classified state rather than standing for absence (issue #45).
+       * Header-derived category for the message. Always present: `Message.category` is NOT NULL with an `uncategorized` default, and `uncategorized` is a named value — no category — rather than a stand-in for absence or for `personal` (issue #45).
        */
       category: MessageCategory;
       /**
@@ -8590,13 +8614,14 @@ export type StarColor = Components.Schemas.StarColor;
 export type MessageCategory = Components.Schemas.MessageCategory;
 export type SenderTrust = Components.Schemas.SenderTrust;
 export type DisplayNameCorrespondence = Components.Schemas.DisplayNameCorrespondence;
+export type MessageStatus = Components.Schemas.MessageStatus;
+export type MessageSyncStatus = Components.Schemas.MessageSyncStatus;
 export type PlacementAction = Components.Schemas.PlacementAction;
 export type SemanticSearchChunkType = Components.Schemas.SemanticSearchChunkType;
 export type OutboxMessageStatus = Components.Schemas.OutboxMessageStatus;
 export type OutboxAttachmentState = Components.Schemas.OutboxAttachmentState;
 export type OutboxAttachmentRejectionReason = Components.Schemas.OutboxAttachmentRejectionReason;
-export type MessageStatus = Components.Schemas.MessageStatus;
-export type MessageSyncStatus = Components.Schemas.MessageSyncStatus;
+export type MessageClassificationState = Components.Schemas.MessageClassificationState;
 export type AuthenticityVerdict = Components.Schemas.AuthenticityVerdict;
 export type AuthResultVerdict = Components.Schemas.AuthResultVerdict;
 export type PlacementConfidence = Components.Schemas.PlacementConfidence;