@remit/data-ports 0.0.43 → 0.0.45

package/package.json

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

package/src/id.test.ts

@@ -1,10 +1,19 @@
 import assert from "node:assert/strict";
 import { describe, it } from "node:test";
 import {
+	base36uuidv5,
+	deriveAddressId,
+	deriveBodyPartId,
 	deriveCopyMessageId,
+	deriveEnvelopeId,
 	deriveMessageId,
+	deriveMessageIdFromSource,
 	deriveQuarantineId,
+	deriveThreadId,
+	normalizeMessageIdHeader,
 	quarantineMessageIdHash,
+	REMIT_NAMESPACE,
+	ROOT_PART_PATH,
 } from "./id.js";
 
 const ACCOUNT = "acct-1";
@@ -90,3 +99,97 @@ describe("quarantineMessageIdHash", () => {
 		}
 	});
 });
+
+describe("derived ids are stored primary keys: a changed value orphans every row already written and needs a migration, never a new expectation here", () => {
+	const ACCOUNT = "account-golden";
+	const MESSAGE = "message-golden";
+	const MAILBOX = "mailbox-golden";
+	const ABSENT_HEADER_SOURCE = {
+		messageId: undefined,
+		mailboxId: MAILBOX,
+		uid: 40217,
+		date: "2026-08-23T00:00:00Z",
+		subject: "Golden",
+		fromMailbox: "golden",
+		fromHost: "example.com",
+	};
+
+	it("REMIT_NAMESPACE is the seed of every derived id and can never change", () => {
+		assert.equal(REMIT_NAMESPACE, "9e89694d-214b-4d9b-99f5-214b4d9b99f5");
+	});
+
+	it("base36uuidv5 pins the encoding every derivation below is built on", () => {
+		assert.equal(
+			base36uuidv5("golden-seed", REMIT_NAMESPACE),
+			"67hxxs95ofdk5frbprqyrgwmo",
+		);
+	});
+
+	it("deriveAddressId pins the address primary key, lowercased email included", () => {
+		assert.equal(
+			deriveAddressId(ACCOUNT, "Golden.User@Example.COM"),
+			"dzu01kz6aj1ro8fr8l375tfbr",
+		);
+	});
+
+	it("deriveMessageId pins the message primary key", () => {
+		assert.equal(
+			deriveMessageId(ACCOUNT, "<golden@example.com>"),
+			"bfthbm5n4279aacb5a1q1c94h",
+		);
+	});
+
+	it("normalizeMessageIdHeader pins the synthetic header that seeds a Message-ID-less message", () => {
+		assert.equal(
+			normalizeMessageIdHeader(ABSENT_HEADER_SOURCE),
+			"generated:mailbox-golden:40217:2026-08-23T00:00:00Z:Golden:golden:example.com",
+		);
+	});
+
+	it("deriveMessageIdFromSource pins the key of a message that declared no Message-ID", () => {
+		assert.equal(
+			deriveMessageIdFromSource(ACCOUNT, ABSENT_HEADER_SOURCE),
+			"0rae70onzy4ufhlnndqe7lwml",
+		);
+	});
+
+	it("deriveCopyMessageId pins the key of a message copied into another folder", () => {
+		assert.equal(
+			deriveCopyMessageId(MESSAGE, MAILBOX),
+			"43cwqvpfh4o1fcbmaciabmqo3",
+		);
+	});
+
+	it("deriveThreadId pins the thread primary key, lowercased root header included", () => {
+		assert.equal(
+			deriveThreadId(ACCOUNT, "<Golden.Root@Example.COM>"),
+			"bcy76e2uat5yq3xd1p7j7z4pr",
+		);
+	});
+
+	it("deriveEnvelopeId pins the envelope primary key", () => {
+		assert.equal(deriveEnvelopeId(MESSAGE), "f1bngysevoxuqt625rd5hvtzt");
+	});
+
+	it("ROOT_PART_PATH is baked into stored body part keys and S3 keys", () => {
+		assert.equal(ROOT_PART_PATH, "0");
+	});
+
+	it("deriveBodyPartId pins the body_part primary key", () => {
+		assert.equal(deriveBodyPartId(MESSAGE, "1.2"), "363nl1jzgh77ki2ojk1hqvxxe");
+	});
+
+	it("deriveQuarantineId pins the quarantine primary key", () => {
+		assert.equal(
+			deriveQuarantineId(ACCOUNT, MAILBOX, 1_700_000_000, 40217),
+			"4xg2y7x2j7nmvy0wtwgdq8b8p",
+		);
+	});
+
+	it("quarantineMessageIdHash pins the stored Message-ID hash that correlates reports", () => {
+		assert.equal(
+			quarantineMessageIdHash("<golden@example.com>"),
+			"sha256:5e888fd63760269e96a61e1a09b83ddec28556d0e3cda7e480897e58c8e6a2f5",
+		);
+	});
+});

package/src/id.ts

@@ -21,16 +21,6 @@ export const deriveAddressId = (
 		REMIT_NAMESPACE,
 	);
 
-export const deriveEnvelopeAddressId = (
-	messageId: string,
-	role: string,
-	order: number,
-): string =>
-	base36uuidv5(
-		`envelopeaddress:${messageId}:${role}:${order}`,
-		REMIT_NAMESPACE,
-	);
-
 export const isValidMessageId = (messageId: string | undefined): boolean => {
 	if (!messageId) return false;
 	const trimmed = messageId.trim();

package/src/types.ts

@@ -295,7 +295,7 @@ export type UpdateAddressInput = Partial<
 export type CreateEnvelopeAddressInput = Omit<
 	EnvelopeAddressItem,
 	"envelopeAddressId" | "createdAt" | "updatedAt"
-> & { envelopeAddressId: string };
+>;
 
 export type CreateEnvelopeInput = Omit<
 	EnvelopeItem,