@remit/api-openapi-types 0.0.49 → 0.0.50

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remit/api-openapi-types",
-  "version": "0.0.49",
+  "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";
     /**
@@ -221,6 +221,10 @@ member (naming the file, the size and the cap), so a refusal must be
 distinguishable from a network failure without parsing prose.
      */
     export type OutboxAttachmentRejectionReason = "EmptyFile" | "UnusableFilename" | "FileTooLarge" | "MessageTooLarge" | "TooManyAttachments" | "ReservationExpired" | "UploadMissing" | "SizeMismatch";
+    /**
+     * 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 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;
       /**
@@ -4402,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.
        */
@@ -4626,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;
       /**
@@ -8613,6 +8621,7 @@ 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 MessageClassificationState = Components.Schemas.MessageClassificationState;
 export type AuthenticityVerdict = Components.Schemas.AuthenticityVerdict;
 export type AuthResultVerdict = Components.Schemas.AuthResultVerdict;
 export type PlacementConfidence = Components.Schemas.PlacementConfidence;