@remit/mailbox-service 0.0.112 → 0.0.114

package/src/thread-message-rows.ts

@@ -1,77 +0,0 @@
-import type { ThreadMessageItem } from "@remit/data-ports";
-
-/**
- * Build the `set` and `composites` payload for the ThreadMessage update on a
- * MESSAGE_DELETE move-to-trash.
- *
- * The CURRENT row state goes in `composites`; the NEW values go in `set`.
- * ElectroDB uses `composites` to run the conditional check on the existing row
- * AND to compute the previous sort-key values needed to recompute the new ones.
- * Passing the NEW values in `composites` makes the conditional check fail with
- * ConditionalCheckFailedException, which ElectroDB wraps as NotFoundError, and
- * the caller silently drops the update. Same root cause as PR #186 fixed for
- * `flag-queue.ts`.
- */
-export type ThreadMessageRowState = Pick<
-	ThreadMessageItem,
-	| "sentDate"
-	| "mailboxId"
-	| "isRead"
-	| "isDeleted"
-	| "hasStars"
-	| "hasAttachment"
->;
-
-const currentComposites = (threadMessage: ThreadMessageRowState) => ({
-	sentDate: threadMessage.sentDate,
-	mailboxId: threadMessage.mailboxId,
-	isRead: threadMessage.isRead,
-	isDeleted: threadMessage.isDeleted,
-	hasStars: threadMessage.hasStars,
-	hasAttachment: threadMessage.hasAttachment,
-});
-
-export const buildThreadMessageTrashUpdate = (
-	threadMessage: ThreadMessageRowState,
-	newUid: number,
-	destinationMailboxId: string,
-) => ({
-	set: {
-		uid: newUid,
-		mailboxId: destinationMailboxId,
-		isDeleted: true,
-	},
-	composites: currentComposites(threadMessage),
-});
-
-/**
- * The inverse payload: put the thread row back where the message still is on
- * the server. The delete was recorded optimistically, so a delete that gives up
- * with the message still at its source has to hand the row back rather than
- * leave it claiming Trash — an invisible `failed` on a row the user cannot see
- * is the shape of the incident this whole change is about.
- */
-export const buildThreadMessageMoveRevert = (
-	threadMessage: ThreadMessageRowState,
-	sourceUid: number,
-	sourceMailboxId: string,
-) => ({
-	set: {
-		uid: sourceUid,
-		mailboxId: sourceMailboxId,
-		isDeleted: false,
-	},
-	composites: currentComposites(threadMessage),
-});
-
-/**
- * Hand a row back after an abandoned expunge. The mail never left Trash, so
- * only the deletion mark reverts — the uid and mailbox on the row are still
- * where the server has it.
- */
-export const buildThreadMessageUndelete = (
-	threadMessage: ThreadMessageRowState,
-) => ({
-	set: { isDeleted: false },
-	composites: currentComposites(threadMessage),
-});

package/src/thread-root.test.ts

@@ -1,29 +0,0 @@
-import assert from "node:assert/strict";
-import { describe, it } from "node:test";
-import { threadRootOf } from "./thread-root.js";
-
-const headers = (inReplyTo = "") => ({
-	messageId: "<self@example.com>",
-	inReplyTo,
-});
-
-describe("threadRootOf", () => {
-	it("reads a doubled References root in its wire spelling", () => {
-		assert.equal(
-			threadRootOf(headers("<p@example.com>"), ["<<root@example.com>>"], "m"),
-			"<root@example.com>",
-		);
-	});
-
-	it("falls back to a doubled In-Reply-To, then to the message itself", () => {
-		assert.equal(
-			threadRootOf(headers("<<p@example.com>>"), undefined, "m"),
-			"<p@example.com>",
-		);
-		assert.equal(threadRootOf(headers(), undefined, "m"), "<self@example.com>");
-		assert.equal(
-			threadRootOf({ messageId: "<>", inReplyTo: "" }, [], "m"),
-			"m",
-		);
-	});
-});

package/src/thread-root.ts

@@ -1,51 +0,0 @@
-import type { MessageReferenceInput } from "@remit/data-ports";
-import {
-	bareMessageId,
-	isValidMessageId,
-	wireMessageId,
-} from "@remit/data-ports/id";
-import { ReferenceType } from "@remit/domain-enums";
-import type { ImapEnvelope } from "./types.js";
-
-type ThreadingHeaders = Pick<ImapEnvelope, "messageId" | "inReplyTo">;
-
-const firstUsable = (
-	candidates: readonly (string | undefined)[],
-): string | undefined => {
-	const found = candidates.find(isValidMessageId);
-	return found === undefined ? undefined : wireMessageId(found);
-};
-
-export const threadRootOf = (
-	envelope: ThreadingHeaders,
-	references: readonly string[] | undefined,
-	messageId: string,
-): string =>
-	firstUsable([references?.[0], envelope.inReplyTo, envelope.messageId]) ??
-	messageId;
-
-export const parentOf = (
-	envelope: ThreadingHeaders,
-	references: readonly string[] | undefined,
-): string | undefined =>
-	firstUsable([envelope.inReplyTo, references?.[references.length - 1]]);
-
-export const messageReferencesOf = (
-	envelope: ThreadingHeaders,
-	references: readonly string[] | undefined,
-): MessageReferenceInput[] => [
-	...(isValidMessageId(envelope.inReplyTo)
-		? [
-				{
-					messageIdValue: bareMessageId(envelope.inReplyTo),
-					referenceType: ReferenceType.InReplyTo,
-					referenceOrder: 0,
-				},
-			]
-		: []),
-	...(references ?? []).filter(isValidMessageId).map((reference, index) => ({
-		messageIdValue: bareMessageId(reference),
-		referenceType: ReferenceType.References,
-		referenceOrder: index,
-	})),
-];

package/src/types/mailparser-augment.d.ts

@@ -1,23 +0,0 @@
-/**
- * `mailparser`'s `simpleParser` populates `partId` on every entry in
- * `parsed.attachments[]` at runtime (set inside `mail-parser.js:860`), but
- * the field is missing from `@types/mailparser`. Format is the IMAP
- * dot-numbered path (`"1"`, `"2.2.2"`, `"3"`) — the same shape mime-walker
- * writes to `BodyPart.partPath`. The body-part mapper uses it as the
- * primary structural pairing signal.
- */
-declare module "mailparser" {
-	interface Attachment {
-		partId?: string;
-	}
-	/**
-	 * Not a mailparser option: mailparser hands its options to its MIME
-	 * splitter, mailsplit, whose `ignoreEmbedded` keeps a message/rfc822 part
-	 * one leaf.
-	 */
-	interface MailParserOptions {
-		ignoreEmbedded?: boolean;
-	}
-}
-
-export {};

package/src/types/natural-porter-stemmer.d.ts

@@ -1,50 +0,0 @@
-// `natural` ships no per-file type declarations for its stemmer submodules —
-// only the package-root barrel (`natural/lib/natural/index.d.ts`) and the
-// `stemmers` submodule barrel (`natural/lib/natural/stemmers/index.d.ts`) are
-// typed. Both barrels are CommonJS, so importing either unconditionally
-// requires every stemmer they list — including Japanese (`stemmer_ja.js`,
-// which pulls in its own `tokenizer_ja.js`) and Indonesian
-// (`indonesian/stemmer_id.js`) — even when unused. Importing each Porter
-// stemmer file this module actually uses, directly, avoids that; these
-// ambient declarations cover the resulting import paths. Referenced via a
-// triple-slash directive from normalizer.ts so tsc includes it in any
-// program that type-checks normalizer.ts, even a consuming package's (whose
-// own tsconfig `include` doesn't reach into this package's src/types).
-interface NaturalStemmer {
-	stem: (token: string) => string;
-}
-
-declare module "natural/lib/natural/stemmers/porter_stemmer.js" {
-	const stemmer: NaturalStemmer;
-	export default stemmer;
-}
-
-declare module "natural/lib/natural/stemmers/porter_stemmer_de.js" {
-	const stemmer: NaturalStemmer;
-	export default stemmer;
-}
-
-declare module "natural/lib/natural/stemmers/porter_stemmer_es.js" {
-	const stemmer: NaturalStemmer;
-	export default stemmer;
-}
-
-declare module "natural/lib/natural/stemmers/porter_stemmer_fr.js" {
-	const stemmer: NaturalStemmer;
-	export default stemmer;
-}
-
-declare module "natural/lib/natural/stemmers/porter_stemmer_it.js" {
-	const stemmer: NaturalStemmer;
-	export default stemmer;
-}
-
-declare module "natural/lib/natural/stemmers/porter_stemmer_nl.js" {
-	const stemmer: NaturalStemmer;
-	export default stemmer;
-}
-
-declare module "natural/lib/natural/stemmers/porter_stemmer_pt.js" {
-	const stemmer: NaturalStemmer;
-	export default stemmer;
-}

package/src/types/stopword.d.ts

@@ -1,69 +0,0 @@
-declare module "stopword" {
-	export function removeStopwords(
-		words: string[],
-		stopwords?: string[],
-	): string[];
-
-	export const afr: string[];
-	export const ara: string[];
-	export const ben: string[];
-	export const bre: string[];
-	export const bul: string[];
-	export const cat: string[];
-	export const ces: string[];
-	export const dan: string[];
-	export const deu: string[];
-	export const ell: string[];
-	export const eng: string[];
-	export const epo: string[];
-	export const est: string[];
-	export const eus: string[];
-	export const fas: string[];
-	export const fin: string[];
-	export const fra: string[];
-	export const glg: string[];
-	export const guj: string[];
-	export const hau: string[];
-	export const heb: string[];
-	export const hin: string[];
-	export const hrv: string[];
-	export const hun: string[];
-	export const hye: string[];
-	export const ind: string[];
-	export const ita: string[];
-	export const jpn: string[];
-	export const kor: string[];
-	export const kur: string[];
-	export const lat: string[];
-	export const lav: string[];
-	export const lit: string[];
-	export const lgg: string[];
-	export const lggNd: string[];
-	export const mar: string[];
-	export const msa: string[];
-	export const mya: string[];
-	export const nld: string[];
-	export const nob: string[];
-	export const pan: string[];
-	export const pol: string[];
-	export const por: string[];
-	export const porBr: string[];
-	export const ron: string[];
-	export const rus: string[];
-	export const slk: string[];
-	export const slv: string[];
-	export const som: string[];
-	export const sot: string[];
-	export const spa: string[];
-	export const swa: string[];
-	export const swe: string[];
-	export const tgl: string[];
-	export const tha: string[];
-	export const tur: string[];
-	export const ukr: string[];
-	export const urd: string[];
-	export const vie: string[];
-	export const yor: string[];
-	export const zho: string[];
-	export const zul: string[];
-}

package/src/types.ts

@@ -1,371 +0,0 @@
-/**
- * Types for the remit-mailbox-service
- */
-
-import type { Readable } from "node:stream";
-
-/**
- * Discriminated union of mail authentication credentials.
- *
- * Exactly one credential kind can be present at a time — the union makes
- * "both password and accessToken simultaneously" unrepresentable.
- */
-export type MailCredentials =
-	| { kind: "password"; password: string }
-	| { kind: "accessToken"; accessToken: string };
-
-/**
- * Classification of mail connection errors.
- */
-export type MailConnectionErrorKind = "auth" | "network";
-
-/**
- * Typed error for IMAP/SMTP connection failures.
- *
- * `kind: "auth"` — authentication rejected (bad credentials / token expired).
- * `kind: "network"` — transport-level failure (ECONNREFUSED, ETIMEDOUT, etc.).
- *
- * IMPORTANT: access tokens must NEVER appear in error messages or causes.
- */
-export class MailConnectionError extends Error {
-	readonly kind: MailConnectionErrorKind;
-
-	constructor(kind: MailConnectionErrorKind, message: string, cause?: unknown) {
-		super(message, { cause });
-		this.name = "MailConnectionError";
-		this.kind = kind;
-	}
-}
-
-/**
- * IMAP connection configuration
- */
-export interface ImapConnectionConfig {
-	host: string;
-	port: number;
-	user: string;
-	credentials: MailCredentials;
-	tls: boolean;
-	tlsOptions?: {
-		rejectUnauthorized?: boolean;
-		servername?: string;
-	};
-	/** Connection timeout in milliseconds */
-	connTimeout?: number;
-	/** Authentication timeout in milliseconds */
-	authTimeout?: number;
-}
-
-/**
- * IMAP connection state
- */
-export type ImapConnectionState =
-	| "disconnected"
-	| "connecting"
-	| "connected"
-	| "authenticated"
-	| "error";
-
-/**
- * Namespace structure from IMAP NAMESPACE command
- */
-export interface ImapNamespace {
-	prefix: string;
-	delimiter: string | false;
-	extensions?: Array<{
-		name: string;
-		params: string[] | null;
-	}>;
-}
-
-/**
- * IMAP namespaces grouped by type
- */
-export interface ImapNamespaces {
-	personal: ImapNamespace[];
-	other: ImapNamespace[];
-	shared: ImapNamespace[];
-}
-
-/**
- * IMAP mailbox status after opening
- */
-export interface ImapBoxStatus {
-	name: string;
-	readOnly: boolean;
-	uidvalidity: number;
-	uidnext: number;
-	flags: string[];
-	permFlags: string[];
-	persistentUIDs: boolean;
-	messages: {
-		total: number;
-		new: number;
-	};
-	newKeywords: boolean;
-}
-
-/**
- * IMAP mailbox status from STATUS command
- */
-export interface ImapMailboxStatus {
-	messages: number;
-	recent: number;
-	unseen: number;
-	uidNext: number;
-	uidValidity: number;
-	/** Highest modification sequence (CONDSTORE) as decimal digits of an unsigned 64-bit value. "0" if the server does not support CONDSTORE. */
-	highestModseq: string;
-	/** Count of messages flagged \Deleted but not yet expunged. */
-	deletedCount: number;
-}
-
-/**
- * Flattened mailbox info for processing
- */
-export interface FlatMailboxInfo {
-	fullPath: string;
-	name: string;
-	delimiter: string;
-	attributes: string[];
-	parentPath: string | null;
-}
-
-export interface ImapAddress {
-	name?: string;
-	mailbox: string;
-	host: string;
-}
-
-export interface ImapEnvelope {
-	date: string;
-	subject: string;
-	from: ImapAddress[];
-	sender: ImapAddress[];
-	replyTo: ImapAddress[];
-	to: ImapAddress[];
-	cc: ImapAddress[];
-	bcc: ImapAddress[];
-	inReplyTo: string;
-	messageId: string;
-}
-
-/**
- * Subset of imapflow's `MessageStructureObject` we depend on. Restated
- * here so non-imapflow code (and tests) can build fixtures without pulling
- * the imapflow types in.
- */
-export interface ImapBodyStructure {
-	/** Dot-numbered MIME path; absent on the root node. */
-	part?: string;
-	/** Full Content-Type, e.g. "text/plain" or "multipart/mixed". */
-	type: string;
-	parameters?: Record<string, string>;
-	id?: string;
-	description?: string;
-	encoding?: string;
-	size?: number;
-	lineCount?: number;
-	md5?: string;
-	disposition?: string;
-	dispositionParameters?: Record<string, string>;
-	language?: string[];
-	location?: string;
-	childNodes?: ImapBodyStructure[];
-}
-
-/**
- * One server message from the cheap envelope-only FETCH the UIDVALIDITY
- * cursor rebuild uses (#1272): UID + Message-ID + INTERNALDATE, nothing
- * else — no flags, no BODYSTRUCTURE, no body fetch.
- */
-export interface ImapEnvelopeSnapshot {
-	uid: number;
-	/** Raw RFC 822 Message-ID header; empty string when absent/unparseable. */
-	messageId: string;
-	internalDate: Date;
-}
-
-export interface ImapMessage {
-	uid: number;
-	seq: number;
-	flags: string[];
-	internalDate: Date;
-	size: number;
-	envelope?: ImapEnvelope;
-	/**
-	 * References header from RFC 2822.
-	 * Contains Message-IDs of ancestor messages, with the first being the thread root.
-	 */
-	references?: string[];
-	/** Parsed BODYSTRUCTURE tree (RFC 9051 Section 7.5.2). */
-	bodyStructure?: ImapBodyStructure;
-	/**
-	 * Per-message MODSEQ (RFC 7162) as decimal digits of an unsigned 64-bit
-	 * value. Absent when the session has no CONDSTORE.
-	 */
-	modseq?: string;
-}
-
-/**
- * Result of a mailbox sync operation
- */
-export interface MailboxSyncResult {
-	created: number;
-	updated: number;
-	deleted: number;
-}
-
-/**
- * Common interface for IMAP connections
- */
-export interface IImapConnection {
-	readonly state: ImapConnectionState;
-	readonly isConnected: boolean;
-	connect(): Promise<void>;
-	disconnect(): Promise<void>;
-	getNamespaces(): Promise<ImapNamespaces>;
-	listMailboxes(nsPrefix?: string): Promise<FlatMailboxInfo[]>;
-	openBox(mailboxPath: string, readOnly?: boolean): Promise<ImapBoxStatus>;
-	closeBox(expunge?: boolean): Promise<void>;
-	search(criteria: unknown[]): Promise<number[]>;
-	fetchMessages(uids: number[]): Promise<ImapMessage[]>;
-	/**
-	 * True when the session negotiated CONDSTORE (RFC 7162) AND the currently
-	 * open mailbox keeps persistent mod-sequences. A mailbox that answered
-	 * NOMODSEQ on SELECT reports false, as does any server that never
-	 * advertised the extension. Requires a mailbox to be open.
-	 */
-	supportsCondstore(): boolean;
-	/**
-	 * FETCH every message in the open mailbox whose MODSEQ is strictly greater
-	 * than `sinceModseq` (RFC 7162 CHANGEDSINCE) — both messages that arrived
-	 * and messages whose metadata changed. Requires a mailbox to be open.
-	 *
-	 * Throws when CONDSTORE is unavailable: the underlying client drops the
-	 * modifier in that case, which would silently turn the call into a fetch of
-	 * the entire mailbox.
-	 */
-	fetchMessagesChangedSince(sinceModseq: bigint): Promise<ImapMessage[]>;
-	/**
-	 * Cheap envelope-only pass for the UIDVALIDITY cursor rebuild (#1272): UID
-	 * + Message-ID + INTERNALDATE for every UID, no BODYSTRUCTURE, no flags,
-	 * no body. Requires a mailbox to be open.
-	 */
-	fetchEnvelopeSnapshots(uids: number[]): Promise<ImapEnvelopeSnapshot[]>;
-	fetchMessageBody(uid: number): Promise<Buffer | null>;
-	/**
-	 * Fetch full message bodies for many UIDs in ONE pipelined ranged UID FETCH.
-	 * Yields `{ uid, source }` per message; `source` is a readable stream the
-	 * caller must consume before requesting the next item. Requires a mailbox to
-	 * be open (one SELECT for the whole batch).
-	 */
-	fetchMessageBodies(
-		uids: number[],
-	): AsyncGenerator<{ uid: number; source: Readable }>;
-	/**
-	 * Add flags to messages by UID.
-	 * Requires mailbox to be open.
-	 */
-	addFlags(uids: number[], flags: string[]): Promise<void>;
-	/**
-	 * Remove flags from messages by UID.
-	 * Requires mailbox to be open.
-	 */
-	removeFlags(uids: number[], flags: string[]): Promise<void>;
-	/**
-	 * Replace all flags on messages by UID.
-	 * Requires mailbox to be open.
-	 */
-	setFlags(uids: number[], flags: string[]): Promise<void>;
-	/**
-	 * Create a new mailbox.
-	 */
-	createMailbox(path: string): Promise<{ path: string; created: boolean }>;
-	/**
-	 * Delete a mailbox.
-	 */
-	deleteMailbox(path: string): Promise<{ path: string }>;
-	/**
-	 * Rename a mailbox.
-	 */
-	renameMailbox(
-		oldPath: string,
-		newPath: string,
-	): Promise<{ path: string; newPath: string }>;
-	/**
-	 * Subscribe to a mailbox.
-	 */
-	subscribeMailbox(path: string): Promise<void>;
-	/**
-	 * Unsubscribe from a mailbox.
-	 */
-	unsubscribeMailbox(path: string): Promise<void>;
-	/**
-	 * Move messages to another mailbox.
-	 * Returns mapping of source UIDs to destination UIDs.
-	 * Requires mailbox to be open.
-	 *
-	 * @param uids - Array of message UIDs to move
-	 * @param destination - Destination mailbox path
-	 * @returns Object with destination path, uidValidity, and uidMap
-	 */
-	moveMessages(
-		uids: number[],
-		destination: string,
-	): Promise<{
-		destination: string;
-		uidValidity: number;
-		uidMap: Map<number, number>;
-	}>;
-	/**
-	 * Copy messages to another mailbox.
-	 * Returns mapping of source UIDs to destination UIDs.
-	 * Requires mailbox to be open.
-	 *
-	 * @param uids - Array of message UIDs to copy
-	 * @param destination - Destination mailbox path
-	 * @returns Object with destination path, uidValidity, and uidMap
-	 */
-	copyMessages(
-		uids: number[],
-		destination: string,
-	): Promise<{
-		destination: string;
-		uidValidity: number;
-		uidMap: Map<number, number>;
-	}>;
-	/**
-	 * Permanently delete messages (mark \Deleted + expunge).
-	 * Requires mailbox to be open.
-	 *
-	 * @param uids - Array of message UIDs to delete
-	 * @returns Number of messages deleted
-	 */
-	deleteMessages(uids: number[]): Promise<number>;
-	/**
-	 * Get mailbox status without opening it.
-	 * Uses IMAP STATUS command to get message counts.
-	 *
-	 * @param mailboxPath - Full path to the mailbox
-	 * @returns Mailbox status including unseen count
-	 */
-	getMailboxStatus(mailboxPath: string): Promise<ImapMailboxStatus>;
-	/**
-	 * Append a message to a mailbox via IMAP APPEND command.
-	 *
-	 * @param mailbox - Full path of the target mailbox
-	 * @param message - RFC 822 message content
-	 * @param flags - Optional flags to set on the message
-	 * @returns Object with destination path, uidValidity, and uid of the appended message
-	 */
-	append(
-		mailbox: string,
-		message: string | Buffer,
-		flags?: string[],
-	): Promise<{
-		destination: string;
-		uidValidity: number;
-		uid: number;
-	}>;
-}

package/tsconfig.json

@@ -1,8 +0,0 @@
-{
-	"extends": "../../tsconfig.json",
-	"compilerOptions": {
-		"outDir": "dist",
-		"rootDir": "src"
-	},
-	"include": ["src/**/*.ts"]
-}