@remit/mailbox-service 0.0.112 → 0.0.113

package/src/index.ts

@@ -1,397 +0,0 @@
-/**
- * remit-mailbox-service
- *
- * IMAP mailbox synchronization service for Remit
- */
-
-export {
-	type AccountCredentialsDeps,
-	type ConnectionStateValue,
-	type CredentialResolution,
-	encryptRefreshToken,
-	hasStoredCredential,
-	type MissingCredential,
-	resolveConnectionCredentials,
-	type StoredCredentialFields,
-} from "./account-credentials.js";
-export {
-	hasChildren,
-	isNoSelect,
-	type ParsedAttributes,
-	parseImapAttributes,
-} from "./attribute-mapper.js";
-export {
-	BodyParseError,
-	parseMessageBody,
-} from "./body-parse.js";
-export {
-	type BodySyncFolder,
-	type BodySyncLogger,
-	type BodySyncRoundFolder,
-	BodySyncService,
-	type ConnectionGetter,
-	extractSnippet,
-	type FetchBodyResult,
-	type PlacementConfig,
-	type QuarantineConfig,
-	type SyncBodiesResult,
-	toParsedBody,
-} from "./body-sync.js";
-export {
-	type BodySyncQueueConfig,
-	type BodySyncQueueLogger,
-	BodySyncQueueService,
-	type RequestBodySyncInput,
-} from "./body-sync-queue.js";
-export {
-	isMessageBodySyncBroken,
-	type ResolveExhaustedBodySyncDeps,
-	type ResolveExhaustedBodySyncInput,
-	type ResolveExhaustedBodySyncResult,
-	resolveExhaustedBodySyncFailures,
-} from "./body-sync-terminal.js";
-export {
-	backfillClassifications,
-	type ClassificationBackfillCheckpoint,
-	type ClassificationBackfillCheckpointStore,
-	type ClassificationBackfillDeps,
-	type ClassificationBackfillLogger,
-	type ClassificationBackfillOptions,
-	type ClassificationBackfillProgress,
-	type ClassificationBackfillResult,
-	type ClassificationBackfillTotals,
-} from "./classification-backfill.js";
-export {
-	classifyParsedMessage,
-	extractPrimaryFromEmail,
-} from "./classify-message.js";
-// Connection factory
-export {
-	createConnection,
-	createConnectionFromAccount,
-	createConnectionWithCredentials,
-	createManagedConnectionFactory,
-	type ManagedConnectionFactory,
-} from "./connection-factory.js";
-// Connection testing
-export {
-	type ImapTestConfig,
-	type SmtpTestConfig,
-	type TestResult,
-	testImapConnection,
-	testSmtpConnection,
-} from "./connection-test.js";
-export {
-	type CreatedFilter,
-	createFilter,
-	type FilterPage,
-	type FilterPatch,
-	listFilters,
-	type NewFilter,
-	resolveFilterUpdate,
-	updateFilter,
-} from "./filter-operations.js";
-export { extractListId, normalizeListId } from "./filters/list-id.js";
-export {
-	clauseMatches,
-	type FilterMessage,
-	type LiteralClauseNarrowing,
-	literalClausesMatch,
-	literalClauseTerms,
-	NO_ACTION,
-	selectMoveWinner,
-} from "./filters/match.js";
-export {
-	type FilterConfig,
-	type FilterDecision,
-	type FilterLogger,
-	FilterPipeline,
-} from "./filters/pipeline.js";
-export {
-	type FlagPushConfig,
-	type FlagPushEvent,
-	type FlagPushLogger,
-	type FlagPushOperationValue,
-	FlagPushService,
-} from "./flag-push.js";
-export {
-	type FlagPushTerminalOutcome,
-	type ResolveExhaustedFlagPushDeps,
-	type ResolveExhaustedFlagPushInput,
-	type ResolveExhaustedFlagPushResult,
-	resolveExhaustedFlagPushFailure,
-} from "./flag-push-terminal.js";
-export {
-	type FlagQueueConfig,
-	type FlagQueueLogger,
-	FlagQueueService,
-	type UpdateFlagsInput,
-	type UpdateFlagsResult,
-} from "./flag-queue.js";
-export {
-	type CreateFolderDeps,
-	changeFolderPath,
-	createFolder,
-	type FolderPathChange,
-	type FolderPathDeps,
-	type FolderPathOutcome,
-	type NewFolder,
-	type NewFolderOutcome,
-	ownedFolder,
-} from "./folder-operations.js";
-export {
-	type FolderPlacementLookup,
-	resolveAccountFolderPlacements,
-	resolveFolderPlacement,
-} from "./folder-placement.js";
-export {
-	classifyByHeaders,
-	extractAuthenticity,
-	extractAuthResult,
-	extractHasListUnsubscribe,
-	extractProviderSpam,
-	type MessageAuthenticity,
-	type MessageAuthResult,
-	type MessageProviderSpam,
-} from "./heuristics/classifyByHeaders.js";
-export {
-	classifyPlacement,
-	type FolderPlacement,
-	type PlacementAction,
-	type PlacementVerdict,
-} from "./heuristics/classifyPlacement.js";
-export {
-	classifyDisplayNameCorrespondence,
-	extractOffDomainLinkDomains,
-	extractSenderMismatch,
-	type SenderMismatchContext,
-	type SenderMismatchSignals,
-} from "./heuristics/senderMismatch.js";
-export { SOCIAL_DOMAINS } from "./heuristics/socialDomains.js";
-export { TRANSACTIONAL_DOMAINS } from "./heuristics/transactionalDomains.js";
-// IMAP connection (ImapFlow-based)
-export {
-	createImapFlowConnectionFromAccount,
-	createImapFlowConnectionWithCredentials,
-	ImapFlowConnection,
-} from "./imapflow-connection.js";
-export {
-	backfillListIds,
-	type ListIdBackfillCheckpoint,
-	type ListIdBackfillCheckpointStore,
-	type ListIdBackfillDeps,
-	type ListIdBackfillLogger,
-	type ListIdBackfillOptions,
-	type ListIdBackfillProgress,
-	type ListIdBackfillResult,
-	type ListIdBackfillTotals,
-} from "./list-id-backfill.js";
-export {
-	guardConnectionCursor,
-	guardMailboxCursor,
-	isCursorRebuildNeeded,
-	type MailboxCursorCheck,
-	type MailboxCursorGuardDeps,
-	MailboxCursorPausedError,
-} from "./mailbox-cursor.js";
-export {
-	type CursorRebuildMatch,
-	type CursorRebuildMatchResult,
-	type CursorRebuildRow,
-	type CursorRebuildSnapshot,
-	matchCursorRebuild,
-} from "./mailbox-cursor-rebuild.js";
-export { folderInFlight } from "./mailbox-intent.js";
-export {
-	type CreateMailboxInput,
-	type DeleteMailboxInput,
-	type MailboxManagementLogger,
-	MailboxManagementService,
-	type MailboxManagementSyncResult,
-	parseMailboxPath,
-	type RenameMailboxInput,
-	validateMailboxOperation,
-	validateMailboxPath,
-} from "./mailbox-management.js";
-export {
-	EVERY_MAILBOX_STATE,
-	isFolderMutationInFlight,
-	isMailboxMutationInFlight,
-} from "./mailbox-presence.js";
-export {
-	type CreateMailboxQueueInput,
-	type MailboxQueueConfig,
-	type MailboxQueueLogger,
-	MailboxQueueService,
-} from "./mailbox-queue.js";
-export {
-	MailboxSyncService,
-	type SyncAccountInfo,
-} from "./mailbox-sync.js";
-export {
-	FolderGoneUpstreamError,
-	FolderRenameSettleError,
-	isMailboxAbsentUpstream,
-	isMailboxPresentUpstream,
-	isMailboxRefusedUpstream,
-	upstreamFailureReason,
-} from "./mailbox-upstream.js";
-export {
-	denormalizeMessageCategory,
-	type MessageCategoryDenormalizeDeps,
-	type MessageCategoryDenormalizeInput,
-	type MessageCategoryValue,
-} from "./message-category.js";
-export {
-	type DeleteMessagesOutcome,
-	type DeleteOptions,
-	type MessageMoveConfig,
-	type MessageMoveLogger,
-	MessageMoveService,
-	NoTrashMailboxError,
-	requireTrashMailbox,
-	StaleTrashAppointmentError,
-	UnconfirmedTrashMailboxError,
-} from "./message-move.js";
-export {
-	type ParsedMessageContent,
-	parseMessageContent,
-} from "./message-parser.js";
-export { isMessageGoneFromOpenMailbox } from "./message-presence.js";
-export {
-	type BodyPartMaterializer,
-	type BodySyncCue,
-	type MaterializeLogger,
-	type MaterializeResult,
-	materializeBodyParts,
-} from "./message-read.js";
-export {
-	type ImapConnectionFactory,
-	MessageSyncService,
-	type SyncedMessage,
-	type SyncMessagesResult,
-} from "./message-sync.js";
-export {
-	type OrganizeJobDeps,
-	type OrganizeJobLogger,
-	type OrganizeJobOwner,
-	type OrganizeJobPredicate,
-	type OrganizeJobRequest,
-	queueOrganizeJob,
-} from "./organize-job.js";
-export {
-	type CompleteOutboxAttachmentInput,
-	type CompleteOutboxAttachmentOutcome,
-	type MintOutboxAttachmentInput,
-	type MintOutboxAttachmentOutcome,
-	OUTBOX_ATTACHMENT_MAX_COUNT,
-	OUTBOX_ATTACHMENT_MAX_TOTAL_BYTES,
-	type OutboxAttachmentConfig,
-	type OutboxAttachmentRejectionDetail,
-	type OutboxAttachmentRejectionReasonValue,
-	type OutboxAttachmentReservation,
-	OutboxAttachmentService,
-} from "./outbox-attachment.js";
-export {
-	FALLBACK_CONTENT_TYPE,
-	normalizeAttachmentContentType,
-	sanitizeAttachmentFilename,
-} from "./outbox-attachment-filename.js";
-export {
-	type CreateDraftInput,
-	type OutboxQueueConfig,
-	type OutboxQueueLogger,
-	OutboxQueueService,
-	type UpdateDraftInput,
-} from "./outbox-queue.js";
-export {
-	folderInAccount,
-	type MessageOwnershipClient,
-	ownedAccount,
-	ownedMessages,
-	settledFolder,
-} from "./ownership.js";
-export {
-	type PlacementMoveConfig,
-	type PlacementMoveLogger,
-	type PlacementMovePushEvent,
-	PlacementMoveService,
-} from "./placement-move.js";
-export {
-	type PlacementMoveTerminalOutcome,
-	type ResolveExhaustedPlacementMoveDeps,
-	type ResolveExhaustedPlacementMoveInput,
-	type ResolveExhaustedPlacementMoveResult,
-	resolveExhaustedPlacementMoveFailure,
-} from "./placement-move-terminal.js";
-export {
-	carriesForeignUid,
-	isPlacementUnsettled,
-	type PlacementBinding,
-	placementBindingOf,
-	uidMailboxIdOf,
-} from "./placement-settled.js";
-export {
-	type QuarantineContext,
-	QuarantinedUids,
-	type QuarantineFailure,
-	type QuarantineLogger,
-	type QuarantineMessageShape,
-	QuarantineService,
-	resolveMailboxRole,
-	shapeFromMessageData,
-} from "./quarantine.js";
-export {
-	type AccessMode,
-	accept,
-	invalid,
-	type Refusable,
-	type Refusal,
-	type Refused,
-	refuse,
-} from "./refusal.js";
-export {
-	type RestoreSourcePlacementDeps,
-	type RestoreSourcePlacementInput,
-	type RestoreSourcePlacementOutcome,
-	restoreSourcePlacement,
-} from "./restore-source-placement.js";
-export {
-	extractSnippetFromEmail,
-	generateSnippet,
-	normalizeSubject,
-	removeQuotedContent,
-} from "./snippet.js";
-export {
-	MoveNotSettledError,
-	NoJunkMailboxError,
-	type SpamReportConfig,
-	type SpamReportLogger,
-	type SpamReportParams,
-	SpamReportService,
-} from "./spam-report.js";
-export {
-	type ServerUids,
-	type SyncWarningContext,
-	type SyncWarningRound,
-	SyncWarningService,
-} from "./sync-warning.js";
-export {
-	buildThreadMessageMoveRevert,
-	buildThreadMessageTrashUpdate,
-	buildThreadMessageUndelete,
-	type ThreadMessageRowState,
-} from "./thread-message-rows.js";
-export type {
-	FlatMailboxInfo,
-	IImapConnection,
-	ImapBoxStatus,
-	ImapConnectionConfig,
-	ImapConnectionState,
-	ImapNamespace,
-	ImapNamespaces,
-	MailboxSyncResult,
-	MailConnectionErrorKind,
-	MailCredentials,
-} from "./types.js";
-export { MailConnectionError } from "./types.js";

package/src/list-id-backfill.test.ts

@@ -1,207 +0,0 @@
-import assert from "node:assert/strict";
-import { afterEach, beforeEach, describe, it } from "node:test";
-import type { AccountItem, MailboxItem } from "@remit/data-ports";
-import type { StorageService } from "@remit/storage-service";
-import {
-	backfillListIds,
-	type ListIdBackfillCheckpoint,
-} from "./list-id-backfill.js";
-import { eml, FakeImapServer } from "./test-helpers/fake-imap.js";
-import {
-	arriveAt,
-	openStore,
-	type Store,
-	seedAccount,
-	seedMailbox,
-	storeBody,
-} from "./test-helpers/test-store.js";
-
-const LIST = eml({
-	From: "Weekly News <news@example.com>",
-	"List-Id": "Weekly News <weekly.news.example.com>",
-});
-
-const PLAIN = eml({ From: "Alice <alice@example.com>" });
-
-const MALFORMED = Buffer.from(
-	[
-		"From: Weird <weird@example.com>",
-		"Subject: Odd header",
-		"List-Id:",
-		"Content-Type: text/plain",
-		"",
-		"body",
-	].join("\r\n"),
-);
-
-let store: Store;
-let storage: StorageService;
-let imap: FakeImapServer;
-let account: AccountItem;
-let inbox: MailboxItem;
-
-beforeEach(async () => {
-	store = await openStore();
-	storage = store.storage();
-	imap = new FakeImapServer();
-	imap.addFolder("INBOX");
-	account = await seedAccount(store);
-	inbox = await seedMailbox(store, account, "INBOX");
-});
-
-afterEach(() => store.close());
-
-const stored = async (
-	raw: Buffer,
-	owner: AccountItem = account,
-	mailbox: MailboxItem = inbox,
-): Promise<string> => {
-	const messageId = await arriveAt(store, imap, owner, mailbox, raw);
-	await storeBody(store, storage, owner, messageId, raw);
-	return messageId;
-};
-
-const deps = () => ({
-	accountConfigService: store.accountConfig,
-	threadMessageService: store.threadMessage,
-	messageService: store.message,
-	storageService: storage,
-});
-
-const listIdOf = async (messageId: string, owner: AccountItem = account) =>
-	(
-		await store.threadMessage.findAllByMessageId(
-			owner.accountConfigId,
-			messageId,
-		)
-	)[0].listId;
-
-const memoryCheckpoint = () => {
-	let saved: ListIdBackfillCheckpoint | undefined;
-	return {
-		load: async () => saved,
-		save: async (next: ListIdBackfillCheckpoint) => {
-			saved = next;
-		},
-		clear: async () => {
-			saved = undefined;
-		},
-	};
-};
-
-describe("backfillListIds", () => {
-	it("writes the List-Id a stored body carries", async () => {
-		const messageId = await stored(LIST);
-
-		const result = await backfillListIds(deps());
-
-		assert.equal(result.backfilled, 1);
-		assert.equal(await listIdOf(messageId), "weekly.news.example.com");
-	});
-
-	it("leaves the field empty for mail with no or a malformed List-Id", async () => {
-		const plain = await stored(PLAIN);
-		const malformed = await stored(MALFORMED);
-
-		const result = await backfillListIds(deps());
-
-		assert.equal(result.noListId, 2);
-		assert.equal(result.failed, 0);
-		assert.equal(await listIdOf(plain), undefined);
-		assert.equal(await listIdOf(malformed), undefined);
-	});
-
-	it("skips rows already carrying a List-Id and rows with no stored body", async () => {
-		const set = await stored(LIST);
-		const [row] = await store.threadMessage.findAllByMessageId(
-			account.accountConfigId,
-			set,
-		);
-		await store.threadMessage.update(
-			account.accountConfigId,
-			row.threadMessageId,
-			{ listId: "already.set" },
-		);
-		await arriveAt(store, imap, account, inbox, LIST);
-
-		const result = await backfillListIds(deps());
-
-		assert.equal(result.alreadySet, 1);
-		assert.equal(result.skippedNoBody, 1);
-		assert.equal(await listIdOf(set), "already.set");
-	});
-
-	it("contains a storage failure to the one message and keeps going", async () => {
-		const lost = await arriveAt(store, imap, account, inbox, LIST);
-		await store.message.update(lost, {
-			bodyStorageKey: "file:///nonexistent/remit/body.eml",
-		});
-		const fine = await stored(LIST);
-
-		const result = await backfillListIds(deps());
-
-		assert.equal(result.failed, 1);
-		assert.equal(await listIdOf(fine), "weekly.news.example.com");
-	});
-
-	it("resumes the account it was in after an earlier account is removed", async () => {
-		const owners = [
-			await seedAccount(store, { accountConfigId: "cfg-1" }),
-			await seedAccount(store, { accountConfigId: "cfg-2" }),
-			await seedAccount(store, { accountConfigId: "cfg-3" }),
-		];
-		const ids = new Map<string, string[]>();
-		for (const owner of owners) {
-			imap.addFolder(`INBOX-${owner.accountConfigId}`);
-			const mailbox = await seedMailbox(
-				store,
-				owner,
-				`INBOX-${owner.accountConfigId}`,
-			);
-			const count = owner.accountConfigId === "cfg-2" ? 2 : 1;
-			const mine: string[] = [];
-			for (let i = 0; i < count; i++)
-				mine.push(await stored(LIST, owner, mailbox));
-			ids.set(owner.accountConfigId, mine);
-		}
-		await store.accountConfig.delete(account.accountConfigId);
-		const checkpointStore = memoryCheckpoint();
-		let pages = 0;
-
-		await assert.rejects(
-			backfillListIds(deps(), {
-				batchSize: 1,
-				checkpointStore,
-				onProgress: (progress) => {
-					if (progress.accountConfigId === "cfg-2" && ++pages === 1) {
-						throw new Error("killed");
-					}
-				},
-			}),
-		);
-		await store.accountConfig.delete("cfg-1");
-		const resumed = await backfillListIds(deps(), {
-			batchSize: 1,
-			checkpointStore,
-		});
-
-		assert.equal(resumed.backfilled, 2);
-		assert.equal(resumed.scanned, 2);
-	});
-
-	it("restarts the pass when the checkpointed account no longer exists", async () => {
-		for (let i = 0; i < 3; i++) await stored(LIST);
-
-		const result = await backfillListIds(deps(), {
-			batchSize: 2,
-			checkpointStore: {
-				load: async () => ({ accountConfigId: "cfg-removed" }),
-				save: async () => {},
-				clear: async () => {},
-			},
-		});
-
-		assert.equal(result.scanned, 3);
-		assert.equal(result.backfilled, 3);
-	});
-});