@remit/data-ports 0.0.9 → 0.0.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remit/data-ports",
-  "version": "0.0.9",
+  "version": "0.0.10",
   "type": "module",
   "main": "src/index.ts",
   "types": "src/index.ts",

package/src/index.ts

@@ -83,6 +83,7 @@ export type {
 	PutMessagePlacementMoveInput,
 	QuarantineItem,
 	QuarantineMimeNodeItem,
+	QuarantineUpsertInput,
 	RawMessageStorageItem,
 	ResultList,
 	SearchOptions,

package/src/interfaces/quarantine.ts

@@ -1,4 +1,4 @@
-import type { QuarantineItem } from "../types.js";
+import type { QuarantineItem, QuarantineUpsertInput } from "../types.js";
 
 export interface IQuarantineRepository {
 	/**
@@ -7,4 +7,16 @@ export interface IQuarantineRepository {
 	 * surface and by a sync round that keeps it in memory.
 	 */
 	listByAccountConfigId(accountConfigId: string): Promise<QuarantineItem[]>;
+
+	/**
+	 * Record a message the sync path could not apply.
+	 *
+	 * Idempotent on the message's identity: the row is keyed by an id derived
+	 * from (accountId, mailboxId, uidValidity, uid), so quarantining the same
+	 * message twice rewrites one row instead of accumulating. The derivation
+	 * happens here rather than at the call site — see `QuarantineUpsertInput`.
+	 *
+	 * A cursor may only move past a message once this has resolved.
+	 */
+	upsert(input: QuarantineUpsertInput): Promise<void>;
 }

package/src/types.ts

@@ -89,6 +89,21 @@ export type MessageFlagPushItem = z.infer<typeof MessageFlagPushSchema>;
 export type QuarantineItem = z.infer<typeof QuarantineSchema>;
 export type QuarantineMimeNodeItem = QuarantineItem["structure"][number];
 
+/**
+ * What a caller supplies to quarantine a message.
+ *
+ * `quarantineId` is absent on purpose. The column carries a random-id default
+ * (the house pattern for every entity here), so an input that merely allowed
+ * the id would let a writer omit it, take a fresh random one on every retry,
+ * and turn the idempotent write this record depends on into an accumulating
+ * pile of rows that the derived-id lookup never finds. The repository derives
+ * it from the four fields that name the message, which are all required here.
+ */
+export type QuarantineUpsertInput = Omit<
+	QuarantineItem,
+	"quarantineId" | "createdAt" | "updatedAt" | "structure"
+> & { structure?: QuarantineMimeNodeItem[] };
+
 export type MailboxSpecialUseValue = z.infer<typeof MailboxSpecialUseSchema>;
 
 export type AccountSettingValue =