@remit/data-ports 0.0.47 → 0.0.49

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remit/data-ports",
-  "version": "0.0.47",
+  "version": "0.0.49",
   "type": "module",
   "main": "src/index.ts",
   "types": "src/index.ts",
@@ -25,10 +25,6 @@
       "types": "./src/account-settings.ts",
       "default": "./src/account-settings.ts"
     },
-    "./mailbox-role": {
-      "types": "./src/mailbox-role.ts",
-      "default": "./src/mailbox-role.ts"
-    },
     "./display-name": {
       "types": "./src/display-name.ts",
       "default": "./src/display-name.ts"

package/src/errors.ts

@@ -98,6 +98,30 @@ export class MailboxNotSettledError extends ConflictError {
 	}
 }
 
+/**
+ * Why the row's folder and uid do not name the same message. `in_flight` clears
+ * on its own, so the client words a wait; `unverified` does not, so it words a
+ * resync instead.
+ */
+export type MessagePlacementUnsettledReason = "in_flight" | "unverified";
+
+export class MessagePlacementUnsettledError extends ConflictError {
+	name = "MessagePlacementUnsettledError";
+
+	constructor(
+		message: string,
+		accountId: string,
+		messageId: string,
+		reason: MessagePlacementUnsettledReason,
+	) {
+		super(message);
+		this.publicApiError = {
+			code: "message_placement_unsettled",
+			details: { accountId, messageId, reason },
+		};
+	}
+}
+
 /**
  * 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.ts

@@ -168,6 +168,21 @@ export const STALE_TRASH_FOLDER_REASON = `The folder appointed as this account's
  */
 export const UNCONFIRMED_TRASH_FOLDER_REASON = `Nobody has confirmed which folder is this account's Trash, so nothing was deleted. Appoint one under ${FOLDER_ROLES_SETTINGS_PATH}, then try again.`;
 
+/**
+ * The mailboxes holding Junk and Trash across a set of accounts, as ids. The
+ * shape a SQL predicate needs when it must ask "is this message in Junk"
+ * without spelling the rule a second time: resolution happens once, here, and
+ * SQL compares mailbox ids.
+ *
+ * A role resolves to at most one mailbox per account, so each list holds one id
+ * per account that has that folder — and no entry at all for an account that
+ * has none.
+ */
+export interface JunkRoleMailboxes {
+	readonly junkMailboxIds: readonly string[];
+	readonly trashMailboxIds: readonly string[];
+}
+
 /** The minimal mailbox shape role resolution reads. */
 export interface RoleMailboxCandidate extends MailboxNameCandidate {
 	specialUse?: readonly string[];

package/src/interfaces/address.ts

@@ -1,3 +1,4 @@
+import type { JunkRoleMailboxes } from "../folder-role.js";
 import type {
 	AddressItem,
 	CreateAddressInput,
@@ -13,7 +14,15 @@ export interface IAddressRepository {
 	upsertAddress(input: CreateAddressInput): Promise<AddressItem>;
 	upsertCorrespondentAddress(input: CreateAddressInput): Promise<AddressItem>;
 	upsertJunkAddress(input: CreateAddressInput): Promise<AddressItem>;
-	reconcileJunkOnlyForMessage(messageId: string): Promise<void>;
+	/**
+	 * `roles` covers every account under the message's config, resolved by the
+	 * caller once per batch: this runs inside the per-message sync loop, and
+	 * role resolution is deliberately uncached.
+	 */
+	reconcileJunkOnlyForMessage(
+		messageId: string,
+		roles: JunkRoleMailboxes,
+	): Promise<void>;
 	getAddress(accountConfigId: string, addressId: string): Promise<AddressItem>;
 	getAddress(
 		accountConfigId: string,

package/src/interfaces/mailbox-special-use.ts

@@ -1,4 +1,4 @@
-import type { RoleResolution } from "../folder-role.js";
+import type { JunkRoleMailboxes, RoleResolution } from "../folder-role.js";
 import type {
 	MailboxSpecialUseItem,
 	MailboxSpecialUseValue,
@@ -47,4 +47,14 @@ export interface IMailboxSpecialUseRepository {
 	findJunkMailbox(
 		accountId: string,
 	): Promise<{ mailboxId: string; fullPath: string } | null>;
+	/**
+	 * Junk and Trash for every account under one config, as mailbox ids. The
+	 * address book is keyed by config and an address carries sightings from all
+	 * of them, so a predicate over an address must weigh every account's Junk —
+	 * resolving only the account in hand withholds a sender on one and restores
+	 * it on the next.
+	 */
+	resolveJunkRolesForConfig(
+		accountConfigId: string,
+	): Promise<JunkRoleMailboxes>;
 }

package/src/mailbox-role.ts

@@ -1,14 +0,0 @@
-import { CanonicalMailboxRole } from "@remit/domain-enums";
-import { ROLE_NAME_HINTS } from "./folder-role.js";
-
-/**
- * The conventional names for a role, taken from the one table every
- * special-folder lookup shares (`folder-role.ts`). Exported so the SQLite junk
- * repair can spell the same rule; a second list here is how `INBOX/Sent` and
- * `INBOX/Spam` came to be resolvable in one place and not another.
- */
-export const JUNK_FOLDER_NAMES: readonly string[] =
-	ROLE_NAME_HINTS[CanonicalMailboxRole.Junk] ?? [];
-
-export const TRASH_FOLDER_NAMES: readonly string[] =
-	ROLE_NAME_HINTS[CanonicalMailboxRole.Trash] ?? [];