@remit/data-ports 0.0.67 → 0.0.68

package/package.json

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

package/src/folder-role.test.ts

@@ -9,6 +9,7 @@ import {
 import {
 	composeFolderRoleAppointmentLabelName,
 	composeFolderRoleAppointmentName,
+	isReservedFolderName,
 	meetsTrashAssurance,
 	parseFolderRoleAppointmentLabelName,
 	parseFolderRoleAppointmentName,
@@ -382,3 +383,40 @@ describe("the appointment name and its label sibling", () => {
 		});
 	});
 });
+
+describe("isReservedFolderName", () => {
+	/**
+	 * The sweep's own predicate. A folder whose leaf name is a role's
+	 * conventional name but which lacks the server's flag is read as a duplicate
+	 * and its row is deleted — under D8, with the folder's mail — as soon as
+	 * another folder holds the flag. A rename to one of these settles `synced`
+	 * and is then reaped, which is why the API refuses it (D5).
+	 */
+	for (const name of [
+		"archive",
+		"Archive",
+		"ARCHIVES",
+		"trash",
+		"Deleted Items",
+		"drafts",
+		"Sent Mail",
+		"junk",
+		"Spam",
+		"All Mail",
+	]) {
+		it(`reserves "${name}"`, () => {
+			assert.equal(isReservedFolderName(name), true);
+		});
+	}
+
+	/**
+	 * #843 dropped a bare "Deleted" and "Bin" from the Trash hints precisely
+	 * because they are ordinary folder names a user keeps mail in. Reserving
+	 * them here would refuse a rename nothing would ever have reaped.
+	 */
+	for (const name of ["Deleted", "Bin", "Receipts", "Work", "Inbox 2024"]) {
+		it(`leaves "${name}" alone`, () => {
+			assert.equal(isReservedFolderName(name), false);
+		});
+	}
+});

package/src/folder-role.ts

@@ -134,6 +134,41 @@ export const ROLE_NAME_HINTS: Partial<
 	[CanonicalMailboxRole.All]: ["all mail", "all"],
 };
 
+/**
+ * The role a folder's own leaf name is most conventionally for. A name that
+ * several roles list goes to the role that ranks it highest, so `All Mail` is
+ * an All folder rather than a lookalike of Archive.
+ *
+ * `name` is the leaf segment, lower case.
+ */
+export const roleForFolderName = (
+	name: string,
+): CanonicalMailboxRoleValue | undefined => {
+	let best: { role: CanonicalMailboxRoleValue; rank: number } | undefined;
+	for (const role of CANONICAL_ROLES) {
+		const rank = ROLE_NAME_HINTS[role]?.indexOf(name) ?? -1;
+		if (rank < 0) continue;
+		if (!best || rank < best.rank) best = { role, rank };
+	}
+	return best?.role;
+};
+
+/**
+ * Whether the mailbox sweep would read a folder with this leaf name as a
+ * duplicate of a role's canonical folder — and so delete its row, and under D8
+ * the mail in it, as soon as another folder carries the role's SPECIAL-USE
+ * flag. It is the sweep's own predicate, so a rename refused on it and a folder
+ * reaped by it can never disagree (docs/architecture/folder-rename-and-delete.md
+ * D5).
+ *
+ * A role with no flag to be a duplicate of is not reserved: nothing reaps a
+ * folder for it.
+ */
+export const isReservedFolderName = (name: string): boolean => {
+	const role = roleForFolderName(name.toLowerCase());
+	return role !== undefined && ROLE_SPECIAL_USE[role] !== undefined;
+};
+
 /**
  * The pane where a user appoints a folder to a role, named as it is labelled.
  * Every refusal that asks for an appointment points here, in one wording — the