@remit/data-ports 0.0.35 → 0.0.37

package/package.json

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

package/src/id.ts

@@ -7,13 +7,6 @@ const translator = shortUuid.createTranslator(shortUuid.constants.uuid25Base36);
 
 export const base36uuid = (): string => translator.generate();
 
-export const fromUUID = (uuid: string): string => translator.fromUUID(uuid);
-
-export const toUUID = (shortId: string): string => translator.toUUID(shortId);
-
-export const generateUuidv5 = (name: string, namespace: string): string =>
-	uuidv5(name, namespace);
-
 export const base36uuidv5 = (name: string, namespace: string): string =>
 	translator.fromUUID(uuidv5(name, namespace));
 
@@ -118,16 +111,6 @@ export const ROOT_PART_PATH = "0";
 export const deriveBodyPartId = (messageId: string, partPath: string): string =>
 	base36uuidv5(`bodypart:${messageId}:${partPath}`, REMIT_NAMESPACE);
 
-export const deriveBodyPartParameterId = (
-	messageId: string,
-	partPath: string,
-	parameterName: string,
-): string =>
-	base36uuidv5(
-		`bodypartparam:${messageId}:${partPath}:${parameterName.toLowerCase()}`,
-		REMIT_NAMESPACE,
-	);
-
 /**
  * Identity of a quarantined message (issue #72). Derived rather than generated
  * so re-quarantining the same message rewrites its own row: the sync path can

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/mailbox-role.ts

@@ -1,5 +1,5 @@
 import { CanonicalMailboxRole } from "@remit/domain-enums";
-import { ROLE_NAME_HINTS, resolveMailboxForRole } from "./folder-role.js";
+import { ROLE_NAME_HINTS } from "./folder-role.js";
 
 /**
  * The conventional names for a role, taken from the one table every
@@ -12,34 +12,3 @@ export const JUNK_FOLDER_NAMES: readonly string[] =
 
 export const TRASH_FOLDER_NAMES: readonly string[] =
 	ROLE_NAME_HINTS[CanonicalMailboxRole.Trash] ?? [];
-
-export interface MailboxRole {
-	readonly fullPath: string;
-	readonly hierarchyDelimiter?: string;
-	readonly specialUse?: readonly string[];
-}
-
-/**
- * Whether one mailbox, considered alone, carries a role: its SPECIAL-USE flag
- * or its conventional name. A single mailbox carries no account context, so
- * this cannot see the user's appointment — a caller holding an accountId asks
- * `IMailboxSpecialUseRepository` instead, which does.
- */
-const carriesRole = (
-	mailbox: MailboxRole,
-	role: (typeof CanonicalMailboxRole)[keyof typeof CanonicalMailboxRole],
-): boolean =>
-	resolveMailboxForRole(role, [
-		{
-			mailboxId: "",
-			fullPath: mailbox.fullPath,
-			hierarchyDelimiter: mailbox.hierarchyDelimiter ?? "",
-			specialUse: mailbox.specialUse,
-		},
-	]) !== null;
-
-export const isJunkMailbox = (mailbox: MailboxRole): boolean =>
-	carriesRole(mailbox, CanonicalMailboxRole.Junk);
-
-export const isTrashMailbox = (mailbox: MailboxRole): boolean =>
-	carriesRole(mailbox, CanonicalMailboxRole.Trash);

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"