@remit/web-client 0.0.325 → 0.0.326

package/src/lib/mailbox-sync-wait.ts

@@ -1,102 +0,0 @@
-import { MailboxSyncStatus } from "@remit/domain-enums";
-
-type MailboxSyncStatusValue =
-	(typeof MailboxSyncStatus)[keyof typeof MailboxSyncStatus];
-
-/**
- * A folder created for a dependent write — a filter that will move mail into it,
- * or a move that lands mail there — is not usable the instant the create is
- * queued: the row exists locally with `syncStatus: pending`, and the folder does
- * not exist on the mail server until the imap-worker confirms the create and
- * flips it to `synced`. Binding the dependent write to a `pending` row races the
- * folder into existence across separate FIFO queues and cannot report a create
- * that fails. This waits for the confirmation before the dependent write runs.
- *
- * The standalone create (a folder made in settings with no dependent write) does
- * not use this — it may stay optimistic. The wait is only for the dependent case.
- *
- * The wait honours an `AbortSignal`: the surface that started the create passes
- * one and aborts it on unmount/cancel/close, so a folder that confirms after the
- * surface is gone never resolves and never fires the dependent bind or move.
- */
-
-/** The read fields the wait needs off a mailbox row. */
-export interface MailboxSyncSignal {
-	mailboxId: string;
-	syncStatus?: MailboxSyncStatusValue;
-}
-
-export interface WaitForMailboxSyncedOptions<T extends MailboxSyncSignal> {
-	/** Reads the current mailbox rows; called once per poll (forces a fresh read). */
-	fetchMailboxes: () => Promise<readonly T[]>;
-	/** The row to wait on. */
-	mailboxId: string;
-	/** Aborts the wait; a late confirmation after abort resolves nothing. */
-	signal?: AbortSignal;
-	/** How long to wait for confirmation before giving up. */
-	timeoutMs?: number;
-	/** Gap between polls. */
-	pollIntervalMs?: number;
-	/** Injectable clock/sleep for tests. */
-	delay?: (ms: number, signal?: AbortSignal) => Promise<void>;
-	now?: () => number;
-}
-
-export const MAILBOX_SYNC_TIMEOUT_MS = 30_000;
-export const MAILBOX_SYNC_POLL_INTERVAL_MS = 1_000;
-
-export const MAILBOX_SYNC_FAILED_MESSAGE =
-	"The folder couldn't be created on the mail server. Please try again.";
-export const MAILBOX_SYNC_TIMEOUT_MESSAGE =
-	"The folder was created but the mail server hasn't confirmed it yet, so nothing was attached to it. It's in your folder list — try again in a moment.";
-
-/** `setTimeout` that rejects with the signal's reason instead of outliving it. */
-export const abortableDelay = (
-	ms: number,
-	signal?: AbortSignal,
-): Promise<void> =>
-	new Promise((resolve, reject) => {
-		if (signal?.aborted) {
-			reject(signal.reason);
-			return;
-		}
-		const timer = setTimeout(() => {
-			signal?.removeEventListener("abort", onAbort);
-			resolve();
-		}, ms);
-		const onAbort = () => {
-			clearTimeout(timer);
-			reject(signal?.reason);
-		};
-		signal?.addEventListener("abort", onAbort, { once: true });
-	});
-
-/**
- * Resolve with the mailbox row once its `syncStatus` reaches `synced` — the
- * server-confirmed row, carrying the path the server normalized the create to.
- * Reject with a failure message when the create is reported `failed`, with a
- * distinct timeout message when it never confirms within `timeoutMs`, and with
- * the signal's reason (an `AbortError`) when `signal` aborts. A row that is still
- * `pending` (or not yet in the list) keeps the poll running.
- */
-export async function waitForMailboxSynced<T extends MailboxSyncSignal>({
-	fetchMailboxes,
-	mailboxId,
-	signal,
-	timeoutMs = MAILBOX_SYNC_TIMEOUT_MS,
-	pollIntervalMs = MAILBOX_SYNC_POLL_INTERVAL_MS,
-	delay = abortableDelay,
-	now = Date.now,
-}: WaitForMailboxSyncedOptions<T>): Promise<T> {
-	const deadline = now() + timeoutMs;
-	for (;;) {
-		signal?.throwIfAborted();
-		const mailboxes = await fetchMailboxes();
-		const mailbox = mailboxes.find((entry) => entry.mailboxId === mailboxId);
-		if (mailbox?.syncStatus === MailboxSyncStatus.synced) return mailbox;
-		if (mailbox?.syncStatus === MailboxSyncStatus.failed)
-			throw new Error(MAILBOX_SYNC_FAILED_MESSAGE);
-		if (now() >= deadline) throw new Error(MAILBOX_SYNC_TIMEOUT_MESSAGE);
-		await delay(pollIntervalMs, signal);
-	}
-}

package/src/lib/message-attachments.test.ts

@@ -1,163 +0,0 @@
-import assert from "node:assert/strict";
-import { describe, it } from "node:test";
-import type { RemitImapBodyPartResponse } from "@remit/api-http-client/types.gen.ts";
-import { selectMessageAttachments } from "./message-attachments";
-
-const part = (
-	overrides: Partial<RemitImapBodyPartResponse>,
-): RemitImapBodyPartResponse =>
-	({
-		bodyPartId: "part-1",
-		partPath: "2",
-		mediaType: "APPLICATION",
-		mediaSubtype: "PDF",
-		sizeOctets: 2048,
-		disposition: "attachment",
-		dispositionFilename: "report.pdf",
-		contentUrl: "https://cdn.test/content/parts/2",
-		isMultipart: false,
-		...overrides,
-	}) as RemitImapBodyPartResponse;
-
-describe("selectMessageAttachments", () => {
-	it("keeps only attachment-disposition leaves", () => {
-		const parts = [
-			part({ bodyPartId: "body", disposition: "inline", mediaSubtype: "HTML" }),
-			part({ bodyPartId: "container", isMultipart: true }),
-			part({ bodyPartId: "file" }),
-		];
-		assert.deepEqual(
-			selectMessageAttachments(parts).map((a) => a.bodyPartId),
-			["file"],
-		);
-	});
-
-	it("drops a part with no content URL to fetch", () => {
-		assert.deepEqual(selectMessageAttachments([part({ contentUrl: "" })]), []);
-	});
-
-	it("preserves the order the message declares", () => {
-		const parts = [
-			part({ bodyPartId: "a", dispositionFilename: "a.pdf" }),
-			part({ bodyPartId: "b", dispositionFilename: "b.pdf" }),
-		];
-		assert.deepEqual(
-			selectMessageAttachments(parts).map((a) => a.filename),
-			["a.pdf", "b.pdf"],
-		);
-	});
-
-	it("carries filename, size and content URL through", () => {
-		const [attachment] = selectMessageAttachments([
-			part({ sizeOctets: 4096, contentUrl: "https://cdn.test/x" }),
-		]);
-		assert.equal(attachment.filename, "report.pdf");
-		assert.equal(attachment.typeLabel, "PDF");
-		assert.equal(attachment.sizeOctets, 4096);
-		assert.equal(attachment.contentUrl, "https://cdn.test/x");
-	});
-
-	it("sanitizes a filename that tries to escape the download directory", () => {
-		const [attachment] = selectMessageAttachments([
-			part({ dispositionFilename: "../../../etc/passwd" }),
-		]);
-		assert.equal(attachment.filename, "passwd");
-	});
-
-	it("names an unnamed attachment after its subtype", () => {
-		const [attachment] = selectMessageAttachments([
-			part({ dispositionFilename: undefined }),
-		]);
-		assert.equal(attachment.filename, "attachment.pdf");
-	});
-
-	it("falls back to a bare name when the subtype yields no extension", () => {
-		const [attachment] = selectMessageAttachments([
-			part({ dispositionFilename: undefined, mediaSubtype: "-" }),
-		]);
-		assert.equal(attachment.filename, "attachment");
-	});
-
-	it("labels an undifferentiated binary as a file rather than as its subtype", () => {
-		const [attachment] = selectMessageAttachments([
-			part({ mediaSubtype: "OCTET-STREAM" }),
-		]);
-		assert.equal(attachment.typeLabel, "FILE");
-	});
-
-	describe("a forwarded message", () => {
-		const forwarded = part({
-			bodyPartId: "forwarded",
-			partPath: "2",
-			mediaType: "MESSAGE",
-			mediaSubtype: "rfc822",
-			dispositionFilename: "forwarded.eml",
-		});
-		const inner = [
-			part({
-				bodyPartId: "inner-root",
-				partPath: "2.0",
-				mediaType: "MULTIPART",
-				mediaSubtype: "mixed",
-				isMultipart: true,
-				disposition: undefined,
-			}),
-			part({
-				bodyPartId: "inner-text",
-				partPath: "2.1",
-				mediaType: "TEXT",
-				mediaSubtype: "plain",
-				disposition: undefined,
-			}),
-			part({
-				bodyPartId: "inner-pdf",
-				partPath: "2.2",
-				dispositionFilename: "original.pdf",
-			}),
-		];
-
-		it("is listed as a message, and the attachment inside it is not", () => {
-			const attachments = selectMessageAttachments([
-				forwarded,
-				...inner,
-				part({ bodyPartId: "outer-pdf", partPath: "3" }),
-			]);
-			assert.deepEqual(
-				attachments.map((a) => [a.bodyPartId, a.kind, a.filename]),
-				[
-					["forwarded", "message", "forwarded.eml"],
-					["outer-pdf", "file", "report.pdf"],
-				],
-			);
-		});
-
-		it("is listed whatever disposition the sender gave it", () => {
-			const [attachment] = selectMessageAttachments([
-				{ ...forwarded, disposition: undefined },
-			]);
-			assert.equal(attachment?.kind, "message");
-			assert.equal(attachment?.filename, "forwarded.eml");
-			assert.equal(attachment?.typeLabel, "MESSAGE");
-		});
-
-		it("lists its own attachment once it is the message being read", () => {
-			assert.deepEqual(
-				selectMessageAttachments(inner).map((a) => a.bodyPartId),
-				["inner-pdf"],
-			);
-		});
-
-		it("is not confused with a delivery report", () => {
-			assert.deepEqual(
-				selectMessageAttachments([
-					part({
-						mediaType: "MESSAGE",
-						mediaSubtype: "delivery-status",
-						disposition: undefined,
-					}),
-				]),
-				[],
-			);
-		});
-	});
-});

package/src/lib/message-attachments.ts

@@ -1,70 +0,0 @@
-import type { RemitImapBodyPartResponse } from "@remit/api-http-client/types.gen.ts";
-import {
-	isEncapsulatedMessage,
-	ownParts,
-} from "@remit/data-ports/message-parts";
-import { ContentDisposition } from "@remit/domain-enums";
-import { type AttachmentKind, sanitizeAttachmentFilename } from "@remit/ui";
-
-/**
- * The attachment-disposition body parts of a message, in the order the message
- * declares them. `pickRenderablePart` (message-body-source.ts) drops exactly
- * these parts so the renderer never treats a PDF as a body; this is the other
- * half of that split. A forwarded message is listed whatever its disposition,
- * and the parts inside it are its own, not the carrying message's.
- */
-export interface MessageAttachment {
-	bodyPartId: string;
-	partPath: string;
-	kind: AttachmentKind;
-	/** Display and save name — sanitized once, used for both. */
-	filename: string;
-	typeLabel: string;
-	sizeOctets: number;
-	contentUrl: string;
-}
-
-const typeLabelFor = (kind: AttachmentKind, mediaSubtype: string): string => {
-	if (kind === "message") return "MESSAGE";
-	const label = mediaSubtype.toUpperCase();
-	return label === "OCTET-STREAM" ? "FILE" : label;
-};
-
-/**
- * `application/pdf` → `attachment.pdf`. Only used when the sender declared no
- * filename; a subtype with nothing alphanumeric in it yields a bare
- * `attachment`.
- */
-const fallbackFilenameFor = (mediaSubtype: string): string => {
-	const extension = mediaSubtype.toLowerCase().replace(/[^a-z0-9]/g, "");
-	return extension.length > 0 ? `attachment.${extension}` : "attachment";
-};
-
-export const selectMessageAttachments = (
-	parts: readonly RemitImapBodyPartResponse[],
-): MessageAttachment[] =>
-	ownParts(parts)
-		.filter(
-			(part) =>
-				!part.isMultipart &&
-				(part.disposition === ContentDisposition.Attachment ||
-					isEncapsulatedMessage(part)) &&
-				part.contentUrl.length > 0,
-		)
-		.map((part) => {
-			const kind: AttachmentKind = isEncapsulatedMessage(part)
-				? "message"
-				: "file";
-			return {
-				bodyPartId: part.bodyPartId,
-				partPath: part.partPath,
-				kind,
-				filename: sanitizeAttachmentFilename(
-					part.dispositionFilename ?? "",
-					fallbackFilenameFor(part.mediaSubtype),
-				),
-				typeLabel: typeLabelFor(kind, part.mediaSubtype),
-				sizeOctets: part.sizeOctets,
-				contentUrl: part.contentUrl,
-			};
-		});

package/src/lib/message-body-source.test.ts

@@ -1,115 +0,0 @@
-import assert from "node:assert/strict";
-import { describe, it } from "node:test";
-import {
-	pickRenderablePart,
-	type RenderableBodyPart,
-} from "./message-body-source";
-
-const make = (overrides: Partial<RenderableBodyPart>): RenderableBodyPart => ({
-	partPath: "1",
-	mediaType: "TEXT",
-	mediaSubtype: "PLAIN",
-	contentUrl: "https://cdn.test/content/x",
-	isMultipart: false,
-	...overrides,
-});
-
-describe("pickRenderablePart", () => {
-	it("prefers the first text/html part over text/plain", () => {
-		const html = make({
-			mediaSubtype: "HTML",
-			contentUrl: "https://cdn.test/html",
-		});
-		const text = make({
-			mediaSubtype: "PLAIN",
-			contentUrl: "https://cdn.test/text",
-		});
-		const picked = pickRenderablePart([text, html]);
-		assert.deepEqual(picked, {
-			kind: "html",
-			contentUrl: "https://cdn.test/html",
-		});
-	});
-
-	it("falls back to text/plain when no html part exists", () => {
-		const text = make({
-			mediaSubtype: "PLAIN",
-			contentUrl: "https://cdn.test/text",
-		});
-		const picked = pickRenderablePart([text]);
-		assert.deepEqual(picked, {
-			kind: "text",
-			contentUrl: "https://cdn.test/text",
-		});
-	});
-
-	it("ignores multipart container rows", () => {
-		const container = make({
-			mediaType: "MULTIPART",
-			mediaSubtype: "ALTERNATIVE",
-			isMultipart: true,
-		});
-		const text = make({ mediaSubtype: "PLAIN" });
-		const picked = pickRenderablePart([container, text]);
-		assert.equal(picked?.kind, "text");
-	});
-
-	it("ignores attachment-disposition parts so a PDF doesn't shadow the body", () => {
-		const attachment = make({
-			mediaSubtype: "HTML",
-			disposition: "attachment",
-			contentUrl: "https://cdn.test/attachment.html",
-		});
-		const text = make({
-			mediaSubtype: "PLAIN",
-			contentUrl: "https://cdn.test/text",
-		});
-		const picked = pickRenderablePart([attachment, text]);
-		assert.deepEqual(picked, {
-			kind: "text",
-			contentUrl: "https://cdn.test/text",
-		});
-	});
-
-	it("returns null when nothing renderable is present", () => {
-		const image = make({ mediaType: "IMAGE", mediaSubtype: "PNG" });
-		assert.equal(pickRenderablePart([image]), null);
-	});
-
-	it("treats casing variants of the subtype as equivalent (mailers are inconsistent)", () => {
-		const html = make({
-			mediaSubtype: "html",
-			contentUrl: "https://cdn.test/lower",
-		});
-		const picked = pickRenderablePart([html]);
-		assert.deepEqual(picked, {
-			kind: "html",
-			contentUrl: "https://cdn.test/lower",
-		});
-	});
-
-	it("skips parts with an empty contentUrl so the fetch never fires against the API root", () => {
-		const broken = make({ mediaSubtype: "HTML", contentUrl: "" });
-		assert.equal(pickRenderablePart([broken]), null);
-	});
-
-	it("never renders a forwarded message's body as the body carrying it", () => {
-		const outer = make({ partPath: "1", contentUrl: "https://cdn.test/outer" });
-		const forwarded = make({
-			partPath: "2",
-			mediaType: "MESSAGE",
-			mediaSubtype: "rfc822",
-			disposition: "attachment",
-			contentUrl: "https://cdn.test/forwarded",
-		});
-		const innerHtml = make({
-			partPath: "2.1",
-			mediaSubtype: "HTML",
-			contentUrl: "https://cdn.test/inner",
-		});
-		assert.deepEqual(pickRenderablePart([outer, forwarded, innerHtml]), {
-			kind: "text",
-			contentUrl: "https://cdn.test/outer",
-		});
-	});
-});

package/src/lib/message-body-source.ts

@@ -1,51 +0,0 @@
-/**
- * Pick the renderable body part from a `describeMessage` BodyPartResponse list
- * and fetch its content via CloudFront. The legacy inlined `bodyText` /
- * `bodyHtml` fields were removed in #224 PR 3 — body content lives at the
- * per-part `contentUrl`, JWT-authorized at the edge.
- *
- * Pure helpers (no React) so they can be unit-tested against the generated
- * type without standing up jsdom or DOMPurify.
- */
-
-import { ownParts } from "@remit/data-ports/message-parts";
-
-export type BodyContentKind = "html" | "text";
-
-export interface RenderableBodyPart {
-	partPath: string;
-	mediaType: string;
-	mediaSubtype: string;
-	disposition?: string;
-	contentUrl: string;
-	isMultipart: boolean;
-}
-
-export interface PickedBodyPart {
-	kind: BodyContentKind;
-	contentUrl: string;
-}
-
-/**
- * Pick the best body part to render: prefer the first inline `text/html`,
- * fall back to the first inline `text/plain`. Multipart container rows and
- * attachment-disposition parts are ignored — they carry no renderable
- * payload at this position — and so are the parts of a forwarded message. Returns `null` when nothing renderable is
- * available so callers can show an empty-body affordance.
- */
-export const pickRenderablePart = (
-	parts: readonly RenderableBodyPart[],
-): PickedBodyPart | null => {
-	const renderable = ownParts(parts).filter(
-		(p) =>
-			!p.isMultipart &&
-			p.disposition !== "attachment" &&
-			p.mediaType === "TEXT" &&
-			p.contentUrl.length > 0,
-	);
-	const html = renderable.find((p) => p.mediaSubtype.toUpperCase() === "HTML");
-	if (html) return { kind: "html", contentUrl: html.contentUrl };
-	const text = renderable.find((p) => p.mediaSubtype.toUpperCase() === "PLAIN");
-	if (text) return { kind: "text", contentUrl: text.contentUrl };
-	return null;
-};

package/src/lib/move-options.test.ts

@@ -1,154 +0,0 @@
-import assert from "node:assert";
-import { readFileSync } from "node:fs";
-import { describe, test } from "node:test";
-import { fileURLToPath } from "node:url";
-import type {
-	RemitImapFolderAppointment,
-	RemitImapMailboxResponse,
-} from "@remit/api-http-client/types.gen.ts";
-import { buildMoveOptions, folderDelimiter } from "./move-options.js";
-
-const englishBundle = JSON.parse(
-	readFileSync(
-		fileURLToPath(
-			new URL("../../public/locales/en/mail.json", import.meta.url),
-		),
-		"utf8",
-	),
-) as { sidebar: Record<string, string> };
-
-// The picker is handed the same shipped English bundle the app loads, so the
-// expected labels are the product's own, not strings restated by the test.
-const translate = (key: string, fallback: string): string =>
-	englishBundle.sidebar[key.replace("sidebar.", "")] ?? fallback;
-
-const make = (
-	overrides: Partial<RemitImapMailboxResponse> & {
-		mailboxId: string;
-		fullPath: string;
-	},
-): RemitImapMailboxResponse =>
-	({
-		accountId: "acct-1",
-		namespaceType: "personal",
-		namespacePrefix: "",
-		hierarchyDelimiter: "/",
-		messageCount: 0,
-		unseenCount: 0,
-		deletedCount: 0,
-		createdAt: 0,
-		updatedAt: 0,
-		...overrides,
-	}) as RemitImapMailboxResponse;
-
-const appoint = (
-	role: RemitImapFolderAppointment["role"],
-	mailboxId: string,
-): RemitImapFolderAppointment => ({ role, source: "Appointed", mailboxId });
-
-const applePaths = [
-	make({ mailboxId: "mb-inbox", fullPath: "INBOX" }),
-	make({ mailboxId: "mb-trash", fullPath: "INBOX/Deleted Messages" }),
-	make({ mailboxId: "mb-junk", fullPath: "INBOX/Junk" }),
-	make({ mailboxId: "mb-receipts", fullPath: "INBOX/Receipts" }),
-];
-
-const appleAppointments = [
-	appoint("Inbox", "mb-inbox"),
-	appoint("Trash", "mb-trash"),
-	appoint("Junk", "mb-junk"),
-];
-
-const labelOf = (
-	options: ReturnType<typeof buildMoveOptions>,
-	id: string,
-): string | undefined => options.find((option) => option.id === id)?.label;
-
-describe("buildMoveOptions", () => {
-	test("labels appointed folders by role, not by the provider's leaf", () => {
-		const options = buildMoveOptions({
-			mailboxes: applePaths,
-			folderAppointments: appleAppointments,
-			translator: translate,
-		});
-		assert.equal(labelOf(options, "mb-inbox"), "Inbox");
-		assert.equal(labelOf(options, "mb-trash"), "Trash");
-		assert.equal(labelOf(options, "mb-junk"), "Spam");
-	});
-
-	test("a displayNameOverride wins over the role label", () => {
-		const options = buildMoveOptions({
-			mailboxes: [
-				make({
-					mailboxId: "mb-trash",
-					fullPath: "INBOX/Deleted Messages",
-					displayNameOverride: "Bin",
-				}),
-			],
-			folderAppointments: [appoint("Trash", "mb-trash")],
-			translator: translate,
-		});
-		assert.equal(labelOf(options, "mb-trash"), "Bin");
-	});
-
-	test("an unappointed folder keeps its own name", () => {
-		const options = buildMoveOptions({
-			mailboxes: applePaths,
-			folderAppointments: appleAppointments,
-			translator: translate,
-		});
-		assert.equal(labelOf(options, "mb-receipts"), "Receipts");
-	});
-
-	test("a role label keeps the provider path it nests under", () => {
-		const options = buildMoveOptions({
-			mailboxes: applePaths,
-			folderAppointments: appleAppointments,
-			translator: translate,
-		});
-		const trash = options.find((option) => option.id === "mb-trash");
-		assert.equal(trash?.label, "Trash");
-		assert.equal(trash?.path, "INBOX/Deleted Messages");
-	});
-
-	test("the current mailbox is marked and nothing else is", () => {
-		const options = buildMoveOptions({
-			mailboxes: applePaths,
-			folderAppointments: appleAppointments,
-			currentMailboxId: "mb-junk",
-			translator: translate,
-		});
-		assert.deepStrictEqual(
-			options.filter((option) => option.isCurrent).map((option) => option.id),
-			["mb-junk"],
-		);
-	});
-
-	test("an excluded mailbox is not offered as a destination", () => {
-		const options = buildMoveOptions({
-			mailboxes: applePaths,
-			folderAppointments: appleAppointments,
-			excludeMailboxId: "mb-receipts",
-			translator: translate,
-		});
-		assert.equal(
-			options.some((option) => option.id === "mb-receipts"),
-			false,
-		);
-	});
-});
-
-describe("folderDelimiter", () => {
-	test("takes the account's own hierarchy separator", () => {
-		assert.equal(
-			folderDelimiter([
-				make({ mailboxId: "mb-1", fullPath: "INBOX", hierarchyDelimiter: "." }),
-			]),
-			".",
-		);
-	});
-
-	test("falls back to a slash when there are no mailboxes yet", () => {
-		assert.equal(folderDelimiter([]), "/");
-	});
-});