@remit/data-ports 0.0.35 → 0.0.36

package/package.json

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

package/src/index.ts

@@ -25,6 +25,11 @@ export type {
 } from "./interfaces/outbox-attachment.js";
 export { holdsRoom } from "./interfaces/outbox-attachment.js";
 export type { IOutboxMessageRepository } from "./interfaces/outbox-message.js";
+export {
+	APPENDED_UID_NONE,
+	APPENDED_UID_UNREPORTED,
+	isSentCopyFiled,
+} from "./interfaces/outbox-message.js";
 export type { IQuarantineRepository } from "./interfaces/quarantine.js";
 export type { ISenderSignerStandingRepository } from "./interfaces/sender-signer-standing.js";
 export type { IThreadMessageRepository } from "./interfaces/thread-message.js";

package/src/interfaces/outbox-message.ts

@@ -5,6 +5,32 @@ import type {
 	UpdateOutboxMessageInput,
 } from "../types.js";
 
+/** `appendedUid` when no IMAP APPEND has been confirmed for the row. */
+export const APPENDED_UID_NONE = 0;
+
+/**
+ * `appendedUid` when an APPEND was confirmed but the server named no uid for
+ * it. UIDPLUS is an extension; a server without it files the copy and reports
+ * nothing, and "filed" still has to be distinguishable from "not filed".
+ */
+export const APPENDED_UID_UNREPORTED = -1;
+
+/**
+ * Whether the copy in Sent exists. One definition, because the handler deciding
+ * whether to APPEND and the repair deciding what a stranded row means both have
+ * to agree on it exactly.
+ *
+ * Only the two values that mean "filed" say so, rather than everything that is
+ * not `APPENDED_UID_NONE`. The two mistakes are not each other's equal: reading
+ * a filed row as unfiled files a second copy the user then deletes, and reading
+ * an unfiled row as filed drops the row of a delivered message that is in no
+ * folder — the disappearance the whole repair exists to prevent (#824).
+ */
+export const isSentCopyFiled = (
+	message: Pick<OutboxMessageItem, "appendedUid">,
+): boolean =>
+	message.appendedUid > 0 || message.appendedUid === APPENDED_UID_UNREPORTED;
+
 export interface IOutboxMessageRepository {
 	create(input: CreateOutboxMessageInput): Promise<OutboxMessageItem>;
 	/**

package/src/types.ts

@@ -423,6 +423,7 @@ export type CreateOutboxMessageInput = Omit<
 	| "ccAddresses"
 	| "bccAddresses"
 	| "references"
+	| "appendedUid"
 > & {
 	ccAddresses?: string[];
 	bccAddresses?: string[];
@@ -437,6 +438,7 @@ export type UpdateOutboxMessageInput = Partial<
 		| "lastSmtpCode"
 		| "sentAt"
 		| "smtpMessageId"
+		| "appendedUid"
 		| "toAddresses"
 		| "ccAddresses"
 		| "bccAddresses"