@remit/data-ports 0.0.83 → 0.0.84

package/src/conformance/sender-signer-standing.ts

@@ -1,117 +0,0 @@
-import assert from "node:assert/strict";
-import { after, before, describe, test } from "node:test";
-import type { ISenderSignerStandingRepository } from "../interfaces/sender-signer-standing.js";
-import type { RepositoryConformanceHarness } from "./harness.js";
-
-export function senderSignerStandingRepositoryConformance(
-	harness: RepositoryConformanceHarness<ISenderSignerStandingRepository>,
-): void {
-	describe("ISenderSignerStandingRepository conformance", () => {
-		let repo: ISenderSignerStandingRepository;
-
-		before(async () => {
-			repo = await harness.createRepository();
-		});
-
-		after(() => harness.teardown());
-
-		test("the first observation creates the row at a count of one", async () => {
-			const accountConfigId = harness.makeId();
-			const observedAt = 1_700_000_000_000;
-
-			const standing = await repo.observe({
-				accountConfigId,
-				senderKey: "example.com",
-				signerDomain: "esp.example",
-				observedAt,
-			});
-
-			assert.equal(standing.messageCount, 1);
-			assert.equal(standing.firstSeenAt, observedAt);
-			assert.equal(standing.lastSeenAt, observedAt);
-			assert.equal(standing.userAffirmedAt, 0);
-		});
-
-		test("a repeat observation increments the count", async () => {
-			const accountConfigId = harness.makeId();
-			const key = {
-				accountConfigId,
-				senderKey: "example.com",
-				signerDomain: "esp.example",
-			};
-
-			await repo.observe({ ...key, observedAt: 1_700_000_000_000 });
-			const second = await repo.observe({
-				...key,
-				observedAt: 1_700_000_060_000,
-			});
-
-			assert.equal(second.messageCount, 2);
-			assert.equal(
-				(await repo.get(accountConfigId, key.senderKey, key.signerDomain))
-					.messageCount,
-				2,
-			);
-		});
-
-		test("firstSeenAt survives every later observation while lastSeenAt advances", async () => {
-			const accountConfigId = harness.makeId();
-			const key = {
-				accountConfigId,
-				senderKey: "news.example.com",
-				signerDomain: "unverified",
-			};
-			const first = 1_700_000_000_000;
-
-			await repo.observe({ ...key, observedAt: first });
-			await repo.observe({ ...key, observedAt: first + 60_000 });
-			const third = await repo.observe({ ...key, observedAt: first + 120_000 });
-
-			assert.equal(third.messageCount, 3);
-			assert.equal(third.firstSeenAt, first);
-			assert.equal(third.lastSeenAt, first + 120_000);
-
-			const reread = await repo.get(
-				accountConfigId,
-				key.senderKey,
-				key.signerDomain,
-			);
-			assert.equal(reread.firstSeenAt, first);
-			assert.equal(reread.lastSeenAt, first + 120_000);
-		});
-
-		test("a key differing only in signer domain is a separate row", async () => {
-			const accountConfigId = harness.makeId();
-			const observedAt = 1_700_000_000_000;
-
-			await repo.observe({
-				accountConfigId,
-				senderKey: "example.com",
-				signerDomain: "esp-one.example",
-				observedAt,
-			});
-			const other = await repo.observe({
-				accountConfigId,
-				senderKey: "example.com",
-				signerDomain: "esp-two.example",
-				observedAt,
-			});
-
-			assert.equal(other.messageCount, 1);
-		});
-
-		test("get reports not-found for a key never observed, and does not create it", async () => {
-			const accountConfigId = harness.makeId();
-
-			await assert.rejects(
-				repo.get(accountConfigId, "stranger.example", "esp.example"),
-				(error) => harness.isNotFoundError(error),
-			);
-
-			await assert.rejects(
-				repo.get(accountConfigId, "stranger.example", "esp.example"),
-				(error) => harness.isNotFoundError(error),
-			);
-		});
-	});
-}

package/src/display-name.test.ts

@@ -1,101 +0,0 @@
-import assert from "node:assert/strict";
-import { describe, it } from "node:test";
-import { storedDisplayName } from "./display-name.js";
-
-const OWN = "matthijs@ischen.nl";
-const SPOOFED = "aramirez@secresaludguaviare.gov.co";
-
-const emptied: ReadonlyArray<readonly [string, string]> = [
-	["the incident", "matthijs@ischen.nl"],
-	["quoted", '"matthijs@ischen.nl"'],
-	["angle-bracketed", "<matthijs@ischen.nl>"],
-	["BATV-wrapped", "prvs=0068b51f37=matthijs@ischen.nl"],
-	["upper case", "MATTHIJS@ISCHEN.NL"],
-	["a subdomain apart", "matthijs@mail.ischen.nl"],
-	["separated by a tab", "\tmatthijs@ischen.nl"],
-	["separated by a no-break space", " matthijs@ischen.nl"],
-	["separated by a zero-width space", "​matthijs@ischen.nl"],
-	["a non-ASCII local part", "Özcan@example.com"],
-];
-
-const stripped: ReadonlyArray<readonly [string, string, string]> = [
-	["parenthesised", "Support (support@acme.com)", "Support"],
-	["angle-bracketed", "Matthijs <matthijs@ischen.nl>", "Matthijs"],
-	["comma-separated", "matthijs@ischen.nl, team", "team"],
-	["semicolon-separated", "Team; matthijs@ischen.nl", "Team"],
-	["colon-separated", "Reply to: matthijs@ischen.nl", "Reply to"],
-	["leading and parenthesised", "(matthijs@ischen.nl) Support", "Support"],
-	["mid-name", "Support <matthijs@ischen.nl> Team", "Support Team"],
-	["with a trailing verb", "matthijs@ischen.nl wrote", "wrote"],
-	[
-		"quoted around a name",
-		'Bob "The Builder" <bob@acme.com>',
-		'Bob "The Builder"',
-	],
-	["a tab away from the name", "Support\tmatthijs@ischen.nl", "Support"],
-];
-
-const kept: ReadonlyArray<readonly [string, string]> = [
-	["an ordinary human name", "Matthijs van Henten"],
-	["a name with a full stop", "Dr. M. van Henten"],
-	["a company name", "ING Bank N.V."],
-	["a bare word", "Newsletter"],
-	["an empty name", ""],
-	["a name with an at-sign but no domain", "me @ home"],
-	["a social handle", "@matthijs"],
-	["a version string", "release 2.11"],
-	["a domain with no local part", "ischen.nl"],
-	["a single-letter tld", "a@b.c"],
-];
-
-describe("a display name that claims to be an address", () => {
-	for (const [what, name] of emptied) {
-		it(`empties ${what}`, () => {
-			assert.equal(storedDisplayName(name, SPOOFED), "");
-		});
-	}
-
-	for (const [what, name, remainder] of stripped) {
-		it(`keeps what is left after ${what}`, () => {
-			assert.equal(storedDisplayName(name, SPOOFED), remainder);
-		});
-	}
-
-	for (const [what, name] of kept) {
-		it(`leaves ${what} alone`, () => {
-			assert.equal(storedDisplayName(name, OWN), name);
-		});
-	}
-
-	it("keeps the address it labels", () => {
-		assert.equal(storedDisplayName(OWN, OWN), OWN);
-	});
-
-	it("keeps its own address inside a longer name", () => {
-		const name = "Matthijs <matthijs@ischen.nl>";
-		assert.equal(storedDisplayName(name, OWN), name);
-	});
-
-	it("folds case beyond ASCII on both sides", () => {
-		assert.equal(
-			storedDisplayName("Özcan@example.com", "özcan@example.com"),
-			"Özcan@example.com",
-		);
-		assert.equal(
-			storedDisplayName("ÖZCAN@EXAMPLE.COM", "özcan@example.com"),
-			"ÖZCAN@EXAMPLE.COM",
-		);
-	});
-
-	it("removes any address when the envelope carried none", () => {
-		assert.equal(storedDisplayName(`Support ${OWN}`, undefined), "Support");
-		assert.equal(storedDisplayName("Matthijs", undefined), "Matthijs");
-	});
-
-	it("removes a second address and keeps its own", () => {
-		assert.equal(
-			storedDisplayName(`${OWN} on behalf of ${SPOOFED}`, OWN),
-			`${OWN} on behalf of`,
-		);
-	});
-});

package/src/display-name.ts

@@ -1,40 +0,0 @@
-const EMBEDDED_ADDRESS =
-	/[^\s@<>()[\],;:"'\\]+@[^\s@<>()[\],;:"'\\]+\.[^\s@<>()[\],;:"'\\.]{2,}/gu;
-
-const DELIMITER_PAIR_LEFT_EMPTY = /[<([{"']\s*[>)\]}"']/gu;
-
-const LEADING_OR_TRAILING_SEPARATORS = /^[\s,;:|/\\-]+|[\s,;:|/\\-]+$/gu;
-
-const tidyAfterAddressRemoval = (text: string): string =>
-	text
-		.replace(DELIMITER_PAIR_LEFT_EMPTY, " ")
-		.replace(/\s+/gu, " ")
-		.replace(LEADING_OR_TRAILING_SEPARATORS, "")
-		.trim();
-
-const carriesAddressOtherThan = (
-	text: string,
-	ownAddress: string | undefined,
-): boolean => {
-	for (const [address] of text.matchAll(EMBEDDED_ADDRESS)) {
-		if (address.toLowerCase() !== ownAddress) return true;
-	}
-	return false;
-};
-
-export const storedDisplayName = (
-	displayName: string | undefined,
-	normalizedEmail: string | undefined,
-): string => {
-	if (!displayName) return "";
-	const ownAddress = normalizedEmail?.toLowerCase();
-	if (!carriesAddressOtherThan(displayName, ownAddress)) return displayName;
-
-	const remainder = tidyAfterAddressRemoval(
-		displayName.replace(EMBEDDED_ADDRESS, (address) =>
-			address.toLowerCase() === ownAddress ? address : " ",
-		),
-	);
-	if (!remainder || carriesAddressOtherThan(remainder, ownAddress)) return "";
-	return remainder;
-};

package/src/errors.ts

@@ -1,244 +0,0 @@
-import type {
-	CanonicalMailboxRoleValue,
-	FolderRoleUnresolvedReason,
-} from "./folder-role.js";
-
-export type { FolderRoleUnresolvedReason };
-
-/**
- * The half of an error a client may read: a stable `code` it branches on and
- * string `details` it words its own prompt from. Opt-in — an error that
- * declares none keeps today's `{ message }` body, so no response gains a
- * shape the API never promised and no internal failure leaks its innards.
- */
-export interface PublicApiError {
-	code: string;
-	details?: Record<string, string>;
-}
-
-export const isPublicApiError = (value: unknown): value is PublicApiError => {
-	if (typeof value !== "object" || value === null) return false;
-	if (!("code" in value) || typeof value.code !== "string") return false;
-	if (!("details" in value) || value.details === undefined) return true;
-	if (typeof value.details !== "object" || value.details === null) return false;
-	return Object.values(value.details).every(
-		(detail) => typeof detail === "string",
-	);
-};
-
-export class HTTPError extends Error {
-	public statusCode = 500;
-	publicApiError?: PublicApiError;
-}
-
-export class BadRequestError extends HTTPError {
-	name = "BadRequestError";
-	public statusCode = 400;
-}
-
-export class ClientError extends HTTPError {
-	name = "ClientError";
-	public statusCode = 401;
-}
-
-export class ForbiddenError extends HTTPError {
-	name = "ForbiddenError";
-	public statusCode = 403;
-}
-
-export class NotFoundError extends HTTPError {
-	name = "NotFoundError";
-	public statusCode = 404;
-}
-
-export class ConflictError extends HTTPError {
-	name = "ConflictError";
-	public statusCode = 409;
-}
-
-/**
- * A destructive action refused because the role it needs is unresolved. The
- * client reads `code` and words its prompt from `details` — never from the
- * message — so the copy can change without breaking the branch, and the
- * account the prompt has to appoint a folder on travels with the refusal
- * (the delete endpoint's body carries no accountId).
- */
-export class FolderRoleUnresolvedError extends ConflictError {
-	name = "FolderRoleUnresolvedError";
-
-	constructor(
-		message: string,
-		role: CanonicalMailboxRoleValue,
-		reason: FolderRoleUnresolvedReason,
-		accountId: string,
-	) {
-		super(message);
-		this.publicApiError = {
-			code: "folder_role_unresolved",
-			details: { role, reason, accountId },
-		};
-	}
-}
-
-/**
- * A durable reference cannot be bound to a mailbox whose own mutation has not
- * settled (folder-rename-and-delete.md D12, 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.
- *
- * **422, not 409** (D4). 409 already means "this folder is being changed right
- * now, refresh"; this means "the folder you are pointing at has not settled
- * yet", which is a different sentence and a different remedy. The status is
- * what separates them for a client that reads no further.
- */
-export class MailboxNotSettledError extends HTTPError {
-	name = "MailboxNotSettledError";
-	public statusCode = 422;
-
-	constructor(message: string, mailboxId: string, syncStatus: string) {
-		super(message);
-		this.publicApiError = {
-			code: "mailbox_not_settled",
-			details: { mailboxId, syncStatus },
-		};
-	}
-}
-
-/**
- * Why the row's folder and uid do not name the same message. One value, because
- * one state produces it: a mutation is still in flight and the pair clears on
- * its own, so the client words a wait rather than a repair. A mutation that
- * gave up does not reach here — it hands the row back to a placement the server
- * confirmed first (docs/architecture/imap-mutations.md R3), which is a pair
- * every dependent mutation can act on.
- */
-export type MessagePlacementUnsettledReason = "in_flight";
-
-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 },
-		};
-	}
-}
-
-/**
- * The row named a message the mail server no longer holds at that UID —
- * another client expunged it or moved it away. Distinct from a plain
- * not-found so the client can say where the message went rather than
- * claiming the user deleted it.
- */
-export class MessageGoneFromServerError extends NotFoundError {
-	name = "MessageGoneFromServerError";
-
-	constructor(messageId: string) {
-		super("This message is no longer on the mail server.");
-		this.publicApiError = {
-			code: "message_gone_from_server",
-			details: { messageId },
-		};
-	}
-}
-
-/**
- * A configuration import refused because this configuration is not empty
- * (#1021). The default is to refuse rather than to fold the file in: a person
- * importing over a configuration they forgot they had should hear about it
- * before anything moves. `details` counts what is already here, so the client
- * can say what would be merged, and the same request with `onExisting: merge`
- * goes through.
- */
-export class ConfigNotEmptyError extends ConflictError {
-	name = "ConfigNotEmptyError";
-
-	constructor(message: string, details: Record<string, string>) {
-		super(message);
-		this.publicApiError = { code: "config_not_empty", details };
-	}
-}
-
-/**
- * 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
- * distinct from `NotFoundError`: the message is real, but its content is
- * permanently unavailable — the client must show an explicit, actionable
- * error instead of retrying (no 202, no silent skip).
- */
-export class UnrecoverableBodyError extends HTTPError {
-	name = "UnrecoverableBodyError";
-	public statusCode = 422;
-}
-
-export class CreateFailedConflictError extends ConflictError {
-	public statusCode = 409;
-	name = "CreateFailedConflictError";
-	constructor(resourceType: string, params: unknown) {
-		super(
-			`${resourceType} with properties "${JSON.stringify(params)}" already exists.`,
-		);
-	}
-}
-
-export class UnhandledError extends HTTPError {
-	name = "UnhandledError";
-	public statusCode = 500;
-	readonly cause: Error | undefined;
-
-	constructor(message: string, cause?: Error) {
-		super(message);
-		this.message = message;
-		if (cause) this.cause = cause;
-	}
-
-	toJSON() {
-		return {
-			message: this.message,
-			cause: this.cause?.message,
-			stack: this.cause?.stack || this.stack,
-		};
-	}
-}
-
-export class InternalServerError extends UnhandledError {
-	name = "InternalServerError";
-	public statusCode = 500;
-}
-
-/**
- * A repository lookup or write for a row that no longer exists rejects with a
- * `NotFoundError`, name-matched rather than by `instanceof`: the class crosses
- * the adapter boundary and an adapter may throw its own.
- *
- * A worker event that references a deliberately-deleted mailbox is completed or
- * moot work, never a transient fault: every redelivery re-throws the same
- * `NotFoundError`, and because the sync queues carry `MessageGroupId=accountId`
- * that permanently-failing head message stalls the whole account's per-group
- * FIFO. Handlers use this predicate to resolve such an event terminally (ack
- * with a WARN) instead of retrying forever (issues #287, #289, #290).
- *
- * The guard is narrow on purpose: only a genuine not-found terminates. Real
- * IMAP/infra failures carry other errors and must still propagate to be retried.
- */
-export const isNotFoundError = (error: unknown): boolean =>
-	(error as { name?: string })?.name === "NotFoundError";
-
-export class MailSyncOffError extends BadRequestError {
-	name = "MailSyncOffError";
-
-	constructor(message: string, accountId: string) {
-		super(message);
-		this.publicApiError = {
-			code: "mail_sync_off",
-			details: { accountId },
-		};
-	}
-}