@remit/api-openapi-types 0.0.8 → 0.0.9

package/package.json

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

package/types.d.ts

@@ -20,13 +20,18 @@ declare namespace Components {
     /**
      * The pipeline step that refused a quarantined message.
 
-One member. No catch site on the sync path can currently tell a parse failure
-from an infrastructure failure: the per-message frame in `body-sync.ts` wraps
-the S3 body write, the parsed-body cache write, the body-part upserts, the
-placement move and the label and counter writes alongside the `simpleParser`
-call, and filters only connection drops out of it. A stage is added when a
-try block is narrowed far enough to attribute it, never ahead of that — an
-enum member that reached stored rows cannot be walked back.
+One member, and it is behind a real narrowing rather than a promise of one:
+the body parse has its own try block around the parse call and nothing else,
+so an error out of it can only be the message. S3, queue and database
+failures propagate and never become a record here — quarantining one would
+set a message aside for an outage, tell the user it was unreadable, and
+invite a public GitHub issue about it.
+
+A message that arrives with no ENVELOPE is deliberately NOT a member. Nothing
+can tell that apart from the FETCH row glitching (#408), and the IMAP client
+is far more often the cause than the message; the sync path holds its cursor
+and retries instead, so a transient glitch heals and a persistent one trips
+the stalled-cursor alert.
      */
     export type QuarantineFailureStage = "BodyParse";
     /**
@@ -35,9 +40,19 @@ enum member that reached stored rows cannot be walked back.
 Closed rather than free text: this is the one diagnostic that is interpolated
 into the title of an issue filed under the user's own GitHub account, so its
 publishability has to be a property of the type instead of a claim about the
-writer. Grows with the same narrowing that grows QuarantineFailureStage.
-     */
-    export type QuarantineFailureCode = "UnterminatedMultipartBoundary" | "UnknownCharset" | "TruncatedBody";
+writer.
+
+The vocabulary is total — every quarantine write picks a member, and a defect
+the writer cannot name is `UnreadableBody` rather than an invented code. It
+is deliberately small: the body parser reports its refusals as free text with
+no stable type or code, so a member exists only where the writer can identify
+the defect without reading parser prose. `UnterminatedMultipartBoundary` and
+`TruncatedBody` were provisional members carried by Phase 2 and are gone —
+nothing on the narrowed sync path could produce either, and a member no
+writer can reach is a vocabulary that lies about what the field means.
+`MissingEnvelope` is absent for the same reason: see QuarantineFailureStage.
+     */
+    export type QuarantineFailureCode = "UnknownCharset" | "UnreadableBody";
     /**
      * Lifecycle state of an account configuration
      */