@remit/data-ports 0.0.41 → 0.0.43

package/package.json

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

package/src/errors.ts

@@ -80,6 +80,24 @@ export class FolderRoleUnresolvedError extends ConflictError {
 	}
 }
 
+/**
+ * A role cannot be appointed to a mailbox the mail server has not settled yet
+ * (imap-mutations R2: wait). Its own code, because the role is not unresolved —
+ * the target is: the client words a wait, not a retry. Clearing a role is never
+ * refused this way.
+ */
+export class MailboxNotSettledError extends ConflictError {
+	name = "MailboxNotSettledError";
+
+	constructor(message: string, mailboxId: string, syncStatus: string) {
+		super(message);
+		this.publicApiError = {
+			code: "mailbox_not_settled",
+			details: { mailboxId, syncStatus },
+		};
+	}
+}
+
 /**
  * A message exists but its body could not be fetched/parsed after every
  * body-sync retry was spent (issue #1270 / epic #1281 invariant 3). This is

package/src/folder-role.test.ts

@@ -1,6 +1,10 @@
 import assert from "node:assert/strict";
 import { describe, it } from "node:test";
-import { CanonicalMailboxRole, MailboxSpecialUse } from "@remit/domain-enums";
+import {
+	CanonicalMailboxRole,
+	MailboxSpecialUse,
+	MailboxSyncStatus,
+} from "@remit/domain-enums";
 import {
 	composeFolderRoleAppointmentLabelName,
 	composeFolderRoleAppointmentName,
@@ -173,6 +177,24 @@ describe("resolveConfirmedMailboxForRole", () => {
 });
 
 describe("resolveRoleForAccount", () => {
+	it("resolves an appointment naming a mailbox whose last sync failed", () => {
+		// `failed` has three writers (imap-worker mailbox-management: create :166
+		// rolls nothing back, rename :275 restores oldPath, delete :384 leaves the
+		// folder) and in two the folder is really at the path the row names.
+		const failed: RoleMailboxCandidate & { syncStatus: string } = {
+			...mailbox("mb-trash", "INBOX/Prullenbak"),
+			syncStatus: MailboxSyncStatus.failed,
+		};
+		assert.deepEqual(
+			resolveRoleForAccount(
+				CanonicalMailboxRole.Trash,
+				[mailbox("mb-inbox", "INBOX"), failed],
+				"mb-trash",
+			),
+			{ kind: "appointed", mailbox: failed },
+		);
+	});
+
 	it("answers none when nothing names a Trash folder", () => {
 		// #887 Done item 4: an account whose folders happen to include a Dutch
 		// "Prullenbak" has no Trash reader may act on — no flag, no appointment,

package/src/mailbox-name.test.ts

@@ -1,6 +1,6 @@
 import assert from "node:assert/strict";
 import { describe, it } from "node:test";
-import { resolveMailboxByLeafName } from "./mailbox-name.js";
+import { mailboxLeafName, resolveMailboxByLeafName } from "./mailbox-name.js";
 
 const JUNK_NAMES = ["junk", "spam", "junk e-mail", "junk email", "bulk mail"];
 
@@ -68,3 +68,39 @@ describe("resolveMailboxByLeafName", () => {
 		assert.equal(found, null);
 	});
 });
+
+describe("mailboxLeafName", () => {
+	it("takes the leaf under a dot-delimited namespace", () => {
+		assert.equal(
+			mailboxLeafName({
+				fullPath: "INBOX.Projects.Q3",
+				hierarchyDelimiter: ".",
+			}),
+			"Q3",
+		);
+	});
+
+	it("takes the leaf under a slash-delimited namespace", () => {
+		assert.equal(
+			mailboxLeafName({
+				fullPath: "INBOX/Sent Messages",
+				hierarchyDelimiter: "/",
+			}),
+			"Sent Messages",
+		);
+	});
+
+	it("keeps the whole name when the server reports no delimiter", () => {
+		assert.equal(
+			mailboxLeafName({ fullPath: "Projects/Q3", hierarchyDelimiter: "" }),
+			"Projects/Q3",
+		);
+	});
+
+	it("keeps a top-level name that carries no delimiter", () => {
+		assert.equal(
+			mailboxLeafName({ fullPath: "INBOX", hierarchyDelimiter: "." }),
+			"INBOX",
+		);
+	});
+});

package/src/mailbox-name.ts

@@ -1,24 +1,35 @@
-export interface MailboxNameCandidate {
-	mailboxId: string;
+export interface MailboxPath {
 	fullPath: string;
 	hierarchyDelimiter: string;
 }
 
+export interface MailboxNameCandidate extends MailboxPath {
+	mailboxId: string;
+}
+
 // A flat mailbox namespace reports no delimiter at all — ImapFlow gives `""`
 // for a NIL LIST delimiter — and splitting on "" returns single characters, so
 // the path is its own leaf.
-const segments = (mailbox: MailboxNameCandidate): string[] =>
+const segments = (mailbox: MailboxPath): string[] =>
 	mailbox.hierarchyDelimiter.length === 0
 		? [mailbox.fullPath]
 		: mailbox.fullPath.split(mailbox.hierarchyDelimiter);
 
+/**
+ * The folder's own name: the last segment of its path under the delimiter its
+ * own server reports (`INBOX/Spam` → `Spam`, `INBOX.Projects.Q3` → `Q3`).
+ */
+export const mailboxLeafName = (mailbox: MailboxPath): string => {
+	const parts = segments(mailbox);
+	return parts[parts.length - 1] || mailbox.fullPath;
+};
+
 const rank = (
 	mailbox: MailboxNameCandidate,
 	names: readonly string[],
 ): number | null => {
 	const parts = segments(mailbox);
-	const leaf = parts[parts.length - 1] ?? mailbox.fullPath;
-	const nameIndex = names.indexOf(leaf.toLowerCase());
+	const nameIndex = names.indexOf(mailboxLeafName(mailbox).toLowerCase());
 	if (nameIndex < 0) return null;
 	// Depth outranks the name: a "Spam" buried under Trash or an archive must
 	// never beat the account's real "Junk" one level up.