@remit/data-ports 0.0.82 → 0.0.84

package/{src/wellknown.ts → dist/wellknown.js}

@@ -20,66 +20,43 @@
  * existing `lastInboundAt` (the user is replying to an inbound, which
  * implies a recent inbound, but we still gate on it explicitly).
  */
-
 export const WELLKNOWN_INBOUND_THRESHOLD = 3;
 export const WELLKNOWN_REPLY_THRESHOLD = 1;
 export const WELLKNOWN_INBOUND_WINDOW_MS = 90 * 24 * 60 * 60 * 1000;
-
 /**
  * Categories and signals that make a sender "bulk". Bulk senders cannot be
  * promoted by inbound volume alone — only a real reply promotes them.
  */
-const BULK_CATEGORIES: ReadonlySet<string> = new Set([
-	"newsletter",
-	"marketing",
-	"automated",
+const BULK_CATEGORIES = new Set([
+    "newsletter",
+    "marketing",
+    "automated",
 ]);
-
-export interface WellknownEngagementSnapshot {
-	inboundCount?: number;
-	replyCount?: number;
-	lastInboundAt?: number;
-	/**
-	 * Whether this sender is a bulk/automated sender (newsletter, marketing,
-	 * automated category, or List-Unsubscribe header present). Bulk senders
-	 * can only be promoted via `replyCount >= 1`, not by inbound volume.
-	 */
-	isBulk?: boolean;
-	flags?: {
-		wellknown?: { value: boolean } | undefined;
-	};
-}
-
-export const shouldPromoteWellknown = (
-	snapshot: WellknownEngagementSnapshot,
-	now: number,
-): boolean => {
-	if (snapshot.flags?.wellknown?.value === true) return false;
-
-	const replyCount = snapshot.replyCount ?? 0;
-	const inboundCount = snapshot.inboundCount ?? 0;
-	const replied = replyCount >= WELLKNOWN_REPLY_THRESHOLD;
-	// Bulk senders are only promotable via a real reply, not inbound volume.
-	const inboundEnough =
-		!snapshot.isBulk && inboundCount >= WELLKNOWN_INBOUND_THRESHOLD;
-	if (!replied && !inboundEnough) return false;
-
-	const lastInboundAt = snapshot.lastInboundAt;
-	if (lastInboundAt === undefined) return false;
-	if (now - lastInboundAt > WELLKNOWN_INBOUND_WINDOW_MS) return false;
-
-	return true;
+export const shouldPromoteWellknown = (snapshot, now) => {
+    if (snapshot.flags?.wellknown?.value === true)
+        return false;
+    const replyCount = snapshot.replyCount ?? 0;
+    const inboundCount = snapshot.inboundCount ?? 0;
+    const replied = replyCount >= WELLKNOWN_REPLY_THRESHOLD;
+    // Bulk senders are only promotable via a real reply, not inbound volume.
+    const inboundEnough = !snapshot.isBulk && inboundCount >= WELLKNOWN_INBOUND_THRESHOLD;
+    if (!replied && !inboundEnough)
+        return false;
+    const lastInboundAt = snapshot.lastInboundAt;
+    if (lastInboundAt === undefined)
+        return false;
+    if (now - lastInboundAt > WELLKNOWN_INBOUND_WINDOW_MS)
+        return false;
+    return true;
 };
-
 /**
  * Returns true when the category or presence of List-Unsubscribe marks the
  * sender as bulk, meaning they cannot be promoted by inbound volume alone.
  */
-export function isBulkSender(
-	category: string | undefined,
-	hasListUnsubscribe: boolean,
-): boolean {
-	if (hasListUnsubscribe) return true;
-	if (category != null && BULK_CATEGORIES.has(category)) return true;
-	return false;
+export function isBulkSender(category, hasListUnsubscribe) {
+    if (hasListUnsubscribe)
+        return true;
+    if (category != null && BULK_CATEGORIES.has(category))
+        return true;
+    return false;
 }

package/package.json

@@ -1,81 +1,46 @@
 {
-  "name": "@remit/data-ports",
-  "version": "0.0.82",
-  "type": "module",
-  "main": "src/index.ts",
-  "types": "src/index.ts",
-  "exports": {
-    ".": {
-      "types": "./src/index.ts",
-      "default": "./src/index.ts"
-    },
-    "./conformance": {
-      "types": "./src/conformance/index.ts",
-      "default": "./src/conformance/index.ts"
-    },
-    "./errors": {
-      "types": "./src/errors.ts",
-      "default": "./src/errors.ts"
-    },
-    "./id": {
-      "types": "./src/id.ts",
-      "default": "./src/id.ts"
-    },
-    "./account-settings": {
-      "types": "./src/account-settings.ts",
-      "default": "./src/account-settings.ts"
-    },
-    "./display-name": {
-      "types": "./src/display-name.ts",
-      "default": "./src/display-name.ts"
-    },
-    "./folder-role": {
-      "types": "./src/folder-role.ts",
-      "default": "./src/folder-role.ts"
-    },
-    "./mutation-events": {
-      "types": "./src/mutation-events.ts",
-      "default": "./src/mutation-events.ts"
-    },
-    "./virtual-copy": {
-      "types": "./src/virtual-copy.ts",
-      "default": "./src/virtual-copy.ts"
-    },
-    "./mailbox-name": {
-      "types": "./src/mailbox-name.ts",
-      "default": "./src/mailbox-name.ts"
-    },
-    "./wellknown": {
-      "types": "./src/wellknown.ts",
-      "default": "./src/wellknown.ts"
-    },
-    "./update-manifest": {
-      "types": "./src/update-manifest.ts",
-      "default": "./src/update-manifest.ts"
-    },
-    "./message-settlement": {
-      "types": "./src/message-settlement.ts",
-      "default": "./src/message-settlement.ts"
-    }
-  },
-  "scripts": {
-    "test:typecheck": "tsgo --noEmit",
-    "test:run": "node $NODE_TEST_FLAGS --import tsx --experimental-test-coverage --test-coverage-include='src/**' --test-coverage-exclude='src/**/*.test.ts' --test-coverage-exclude='src/**/*.test.tsx' --test-coverage-lines=85 --test 'src/**/*.test.ts'"
-  },
-  "dependencies": {
-    "@remit/domain-enums": "*",
-    "short-uuid": "*",
-    "uuid": "*",
-    "zod": "^3.25.0",
-    "@remit/api-zod-schemas": "*"
-  },
-  "license": "MIT",
-  "publishConfig": {
-    "access": "public"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/remit-mail/reader.git",
-    "directory": "packages/data-ports"
-  }
+	"name": "@remit/data-ports",
+	"version": "0.0.84",
+	"type": "module",
+	"main": "dist/index.js",
+	"types": "dist/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/index.d.ts",
+			"default": "./dist/index.js"
+		},
+		"./conformance": {
+			"types": "./dist/conformance/index.d.ts",
+			"default": "./dist/conformance/index.js"
+		},
+		"./*": {
+			"types": "./dist/*.d.ts",
+			"default": "./dist/*.js"
+		}
+	},
+	"scripts": {
+		"prepack": "node ../../npm-scripts/pack-dist.mjs prepack",
+		"postpack": "node ../../npm-scripts/pack-dist.mjs postpack",
+		"test:typecheck": "tsgo --noEmit",
+		"test:run": "node $NODE_TEST_FLAGS --import tsx --experimental-test-coverage --test-coverage-include='src/**' --test-coverage-exclude='src/**/*.test.ts' --test-coverage-exclude='src/**/*.test.tsx' --test-coverage-lines=85 --test 'src/**/*.test.ts'"
+	},
+	"dependencies": {
+		"@remit/domain-enums": "*",
+		"short-uuid": "*",
+		"uuid": "*",
+		"zod": "^3.25.0",
+		"@remit/api-zod-schemas": "*"
+	},
+	"license": "MIT",
+	"publishConfig": {
+		"access": "public"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/remit-mail/reader.git",
+		"directory": "packages/data-ports"
+	},
+	"files": [
+		"dist"
+	]
 }

package/src/account-settings.ts

@@ -1,194 +0,0 @@
-import { AccountSettingName } from "@remit/domain-enums";
-import { z } from "zod";
-
-export type AccountSettingNameValue =
-	(typeof AccountSettingName)[keyof typeof AccountSettingName];
-
-/**
- * Per-`kind` value schemas, one per variant of the `AccountSettingValue`
- * discriminated union in TypeSpec (`AccountSetting.tsp`). Authored here because
- * the registry is the binding authority for what a value must satisfy — these
- * are the contract every read and write is validated against.
- */
-export const BooleanSettingSchema = z.object({
-	kind: z.literal("Boolean"),
-	value: z.boolean(),
-});
-export const StringSettingSchema = z.object({
-	kind: z.literal("String"),
-	value: z.string(),
-});
-export const NumberSettingSchema = z.object({
-	kind: z.literal("Number"),
-	value: z.number(),
-});
-export const StringListSettingSchema = z.object({
-	kind: z.literal("StringList"),
-	value: z.array(z.string()),
-});
-export const MapSettingSchema = z.object({
-	kind: z.literal("Map"),
-	value: z.record(z.string(), z.string()),
-});
-/**
- * MutedFlag-valued setting. The value is a rich mute object (`MutedFlag` in
- * TypeSpec / `@remit/api-openapi-types`): a boolean plus audit metadata. The
- * schema is authored here — generated packages ship only `.d.ts` for this shape,
- * so the registry owns the runtime contract a relocated mute flag is validated
- * against (RFC 032 lesson from the signature slice).
- */
-export const MutedFlagSettingSchema = z.object({
-	kind: z.literal("MutedFlag"),
-	value: z.object({
-		value: z.boolean(),
-		setAt: z.number(),
-		setBy: z.string().optional(),
-		expiresAt: z.number().optional(),
-		reason: z.string().optional(),
-	}),
-});
-
-/**
- * RFC 032 Tier 1 registry: binds each setting `name` to the zod schema its
- * `value` must satisfy. The discriminated union (`kind`) types the shape on the
- * wire; this registry binds a name to one concrete shape, so a read or write of
- * a given setting is validated against exactly the variant it requires.
- *
- * Adding a setting key is a deliberate change: extend the `AccountSettingName`
- * enum in TypeSpec and add an entry here — never an ad-hoc, unvalidated value.
- */
-export const accountSettingRegistry = {
-	[AccountSettingName.Theme]: StringSettingSchema,
-	[AccountSettingName.Density]: StringSettingSchema,
-	[AccountSettingName.DefaultComposerFormat]: StringSettingSchema,
-	[AccountSettingName.PinnedFolders]: StringListSettingSchema,
-	[AccountSettingName.AccountSignaturePlainText]: StringSettingSchema,
-	[AccountSettingName.AccountSignatureHtml]: StringSettingSchema,
-	[AccountSettingName.AccountDisplayName]: StringSettingSchema,
-	[AccountSettingName.AccountMuted]: MutedFlagSettingSchema,
-	[AccountSettingName.AccountComposeLanguages]: StringListSettingSchema,
-	[AccountSettingName.MailboxDisplayName]: StringSettingSchema,
-	[AccountSettingName.MailboxMuted]: MutedFlagSettingSchema,
-	[AccountSettingName.FolderRoleAppointment]: StringSettingSchema,
-	[AccountSettingName.FolderRoleAppointmentLabel]: StringSettingSchema,
-	/**
-	 * Deprecated tombstone: superseded by `FolderRoleAppointment` (RFC 032
-	 * exclusive-folder-appointment, #976). Kept only so `baseSettingName`
-	 * recognises leftover `MailboxRole#<mailboxId>` rows written by the #963/#964
-	 * backfill instead of throwing `Unknown account setting name`; the read-side
-	 * groupers (`groupAccountOverrides`, `groupMailboxOverrides`,
-	 * `groupFolderAppointmentsByAccount`) already skip any base they don't
-	 * explicitly handle, so a `MailboxRole` row is ignored, not surfaced. Do not
-	 * write new rows under this name. Remove once the row-deletion migration ships.
-	 */
-	[AccountSettingName.MailboxRole]: StringSettingSchema,
-} as const satisfies Record<AccountSettingNameValue, z.ZodTypeAny>;
-
-export type AccountSettingRegistry = typeof accountSettingRegistry;
-
-export type AccountSettingValueFor<N extends AccountSettingNameValue> = z.infer<
-	AccountSettingRegistry[N]
->;
-
-/**
- * Separator between a setting's base enum member and its per-target suffix in a
- * composite stored name (e.g. `AccountSignaturePlainText#<accountId>`). Some
- * settings are per-account, but `AccountSetting` is keyed per accountConfigId, so
- * the stored `name` encodes the target after this separator. The registry still
- * validates by the base member; readers filter by the suffix.
- */
-export const SETTING_NAME_SEPARATOR = "#";
-
-/**
- * A persisted setting `name`. Either a plain closed-enum member or a composite
- * `<base>#<suffix>` for a per-target setting. Always a `string` whose first
- * segment is a known base member.
- */
-export type StoredSettingName = string;
-
-/** Compose the stored name for a per-target setting (e.g. one signature per account). */
-export function composeSettingName(
-	base: AccountSettingNameValue,
-	target: string,
-): StoredSettingName {
-	return `${base}${SETTING_NAME_SEPARATOR}${target}`;
-}
-
-const isAccountSettingNameValue = (
-	value: string,
-): value is AccountSettingNameValue =>
-	Object.hasOwn(accountSettingRegistry, value);
-
-/**
- * Derive the base enum member from a stored name. Strips the `#<suffix>` from a
- * composite name; returns a plain name unchanged. Throws when the base segment
- * is not a registered setting (let-it-crash — an unknown key is a programmer
- * error, never an ad-hoc column).
- */
-export function baseSettingName(
-	name: StoredSettingName,
-): AccountSettingNameValue {
-	const base = name.split(SETTING_NAME_SEPARATOR)[0] ?? "";
-	if (!isAccountSettingNameValue(base)) {
-		throw new Error(`Unknown account setting name: ${name}`);
-	}
-	return base;
-}
-
-/**
- * Every value shape the registry can hold. Useful where a value is handled
- * generically (e.g. the persisted `value` attribute) rather than per-name.
- */
-export type AnyAccountSettingValue = z.infer<
-	| typeof BooleanSettingSchema
-	| typeof StringSettingSchema
-	| typeof NumberSettingSchema
-	| typeof StringListSettingSchema
-	| typeof MapSettingSchema
-	| typeof MutedFlagSettingSchema
->;
-
-/**
- * Parse-and-narrow a value against the schema registered for `name`. Accepts a
- * plain enum member or a composite `<base>#<suffix>` name; validation resolves
- * to the base member's schema. Throws a ZodError on mismatch (let-it-crash);
- * returns the value typed to the variant the name requires.
- */
-export function parseAccountSettingValue<N extends AccountSettingNameValue>(
-	name: N,
-	value: unknown,
-): AccountSettingValueFor<N>;
-export function parseAccountSettingValue(
-	name: StoredSettingName,
-	value: unknown,
-): AnyAccountSettingValue;
-export function parseAccountSettingValue(
-	name: StoredSettingName,
-	value: unknown,
-): AnyAccountSettingValue {
-	const schema = accountSettingRegistry[baseSettingName(name)];
-	return schema.parse(value) as AnyAccountSettingValue;
-}
-
-/**
- * Non-throwing variant: returns the zod SafeParse result so a caller with a
- * recovery path can branch on `success`. Accepts composite names like above.
- */
-export function safeParseAccountSettingValue<N extends AccountSettingNameValue>(
-	name: N,
-	value: unknown,
-): z.SafeParseReturnType<unknown, AccountSettingValueFor<N>>;
-export function safeParseAccountSettingValue(
-	name: StoredSettingName,
-	value: unknown,
-): z.SafeParseReturnType<unknown, AnyAccountSettingValue>;
-export function safeParseAccountSettingValue(
-	name: StoredSettingName,
-	value: unknown,
-): z.SafeParseReturnType<unknown, AnyAccountSettingValue> {
-	const schema = accountSettingRegistry[baseSettingName(name)];
-	return schema.safeParse(value) as z.SafeParseReturnType<
-		unknown,
-		AnyAccountSettingValue
-	>;
-}

package/src/conformance/account.ts

@@ -1,104 +0,0 @@
-import assert from "node:assert/strict";
-import { after, before, describe, test } from "node:test";
-import { AccountService, ConnectionState } from "@remit/domain-enums";
-import type { IAccountRepository } from "../interfaces/account.js";
-import type { CreateAccountInput } from "../types.js";
-import type { RepositoryConformanceHarness } from "./harness.js";
-
-const accountInput = (accountConfigId: string): CreateAccountInput => ({
-	accountConfigId,
-	username: "person@example.com",
-	email: "person@example.com",
-	imapHost: "imap.example.com",
-	imapPort: 993,
-	imapTls: true,
-	imapStartTls: false,
-	isActive: true,
-	connectionState: ConnectionState.NotAuthenticated,
-});
-
-export function accountRepositoryConformance(
-	harness: RepositoryConformanceHarness<IAccountRepository>,
-): void {
-	describe("IAccountRepository conformance", () => {
-		let repo: IAccountRepository;
-
-		before(async () => {
-			repo = await harness.createRepository();
-		});
-
-		after(() => harness.teardown());
-
-		test("an account created without a service selection syncs mail", async () => {
-			const created = await repo.create(accountInput(harness.makeId()));
-
-			assert.deepEqual(created.syncedServices, [AccountService.Mail]);
-			assert.deepEqual((await repo.get(created.accountId)).syncedServices, [
-				AccountService.Mail,
-			]);
-		});
-
-		test("an account keeps the selection it was created with", async () => {
-			const created = await repo.create({
-				...accountInput(harness.makeId()),
-				syncedServices: [AccountService.Calendar],
-			});
-
-			assert.deepEqual((await repo.get(created.accountId)).syncedServices, [
-				AccountService.Calendar,
-			]);
-		});
-
-		test("an update replaces the selection outright", async () => {
-			const created = await repo.create(accountInput(harness.makeId()));
-
-			const updated = await repo.update(created.accountId, {
-				syncedServices: [AccountService.Mail, AccountService.Calendar],
-			});
-
-			assert.deepEqual(updated.syncedServices, [
-				AccountService.Mail,
-				AccountService.Calendar,
-			]);
-			assert.deepEqual((await repo.get(created.accountId)).syncedServices, [
-				AccountService.Mail,
-				AccountService.Calendar,
-			]);
-		});
-
-		test("an update that leaves the selection out keeps it", async () => {
-			const created = await repo.create({
-				...accountInput(harness.makeId()),
-				syncedServices: [AccountService.Calendar],
-			});
-
-			await repo.update(created.accountId, { lastError: "timeout" });
-
-			assert.deepEqual((await repo.get(created.accountId)).syncedServices, [
-				AccountService.Calendar,
-			]);
-		});
-
-		test("the mail sources of a config leave out an account with mail off", async () => {
-			const accountConfigId = harness.makeId();
-			const mailOnly = await repo.create(accountInput(accountConfigId));
-			const both = await repo.create({
-				...accountInput(accountConfigId),
-				syncedServices: [AccountService.Mail, AccountService.Calendar],
-			});
-			await repo.create({
-				...accountInput(accountConfigId),
-				syncedServices: [AccountService.Calendar],
-			});
-			await repo.create(accountInput(harness.makeId()));
-
-			const sources =
-				await repo.listMailSourcesByAccountConfig(accountConfigId);
-
-			assert.deepEqual(
-				sources.map((account) => account.accountId).sort(),
-				[mailOnly.accountId, both.accountId].sort(),
-			);
-		});
-	});
-}