@remit/config-format 0.0.6 → 0.0.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remit/config-format",
-  "version": "0.0.6",
+  "version": "0.0.8",
   "type": "module",
   "main": "src/index.ts",
   "types": "src/index.ts",

package/schema/{reader-config.v1.schema.json → reader-config.v2.schema.json}

@@ -8,7 +8,7 @@
 		},
 		"schemaVersion": {
 			"type": "number",
-			"const": 1
+			"const": 2
 		},
 		"generator": {
 			"description": "Which reader wrote this file, and when.",
@@ -429,6 +429,7 @@
 						]
 					},
 					"literalClauses": {
+						"minItems": 1,
 						"type": "array",
 						"items": {
 							"type": "object",
@@ -494,38 +495,6 @@
 								"type": "null"
 							}
 						]
-					},
-					"anchor": {
-						"anyOf": [
-							{
-								"type": "object",
-								"properties": {
-									"sourceText": {
-										"type": "string",
-										"minLength": 1,
-										"maxLength": 512
-									},
-									"embeddingId": {
-										"type": "string",
-										"minLength": 1
-									},
-									"sourceMessageId": {
-										"type": "string",
-										"minLength": 25,
-										"maxLength": 25
-									}
-								},
-								"required": [
-									"sourceText",
-									"embeddingId",
-									"sourceMessageId"
-								],
-								"additionalProperties": false
-							},
-							{
-								"type": "null"
-							}
-						]
 					}
 				},
 				"required": [
@@ -535,8 +504,7 @@
 					"matchOperator",
 					"literalClauses",
 					"actionLabelName",
-					"actionFolder",
-					"anchor"
+					"actionFolder"
 				],
 				"additionalProperties": false
 			}
@@ -616,6 +584,36 @@
 								],
 								"additionalProperties": false
 							},
+							"neverSpam": {
+								"type": "object",
+								"properties": {
+									"value": {
+										"type": "boolean"
+									},
+									"setAt": {
+										"description": "Epoch milliseconds the flag was set. 0 means it was set at an unknown time, on a row written before the field existed.",
+										"type": "integer",
+										"minimum": -9007199254740991,
+										"maximum": 9007199254740991
+									},
+									"setBy": {
+										"type": "string"
+									},
+									"expiresAt": {
+										"type": "integer",
+										"minimum": -9007199254740991,
+										"maximum": 9007199254740991
+									},
+									"reason": {
+										"type": "string"
+									}
+								},
+								"required": [
+									"value",
+									"setAt"
+								],
+								"additionalProperties": false
+							},
 							"muted": {
 								"type": "object",
 								"properties": {
@@ -822,6 +820,6 @@
 		"addressFlags"
 	],
 	"additionalProperties": false,
-	"$id": "https://schemas.remit.email/reader-config.v1.schema.json",
-	"title": "reader configuration document, v1"
+	"$id": "https://schemas.remit.email/reader-config.v2.schema.json",
+	"title": "reader configuration document, v2"
 }

package/src/document.test.ts

@@ -97,7 +97,6 @@ test("a filter names its label by name and its folder by account and path", () =
 			accountId: "6f4c2c309a2c4a7f9f9f1f2c3",
 			folderPath: "INBOX.Facturen",
 		},
-		anchor: null,
 	};
 
 	assert.equal(FilterSchema.safeParse(filter).success, true);
@@ -114,37 +113,6 @@ test("a filter names its label by name and its folder by account and path", () =
 	);
 });
 
-test("a filter anchor carries its source text and no vector", () => {
-	const anchored = {
-		name: "like this",
-		scope: "Standing",
-		expiresAt: null,
-		matchOperator: "And",
-		literalClauses: [],
-		actionLabelName: null,
-		actionFolder: null,
-		anchor: {
-			sourceText: "the release note we file every month",
-			embeddingId: "amazon.titan-embed-text-v2:0@1024",
-			sourceMessageId: "2c9e4b117d5a4f609a315b8c0",
-		},
-	};
-
-	assert.equal(FilterSchema.safeParse(anchored).success, true);
-	assert.equal(
-		FilterSchema.safeParse({
-			...anchored,
-			anchor: {
-				sourceText: "x",
-				embeddingId: "m@1",
-				sourceMessageId: "2c9e4b117d5a4f609a315b8c0",
-				anchorEmbedding: [0.1, 0.2],
-			},
-		}).success,
-		false,
-	);
-});
-
 test("an address flag keeps its whole payload", () => {
 	const entry = {
 		normalizedEmail: "post@bank.example",

package/src/document.ts

@@ -98,6 +98,7 @@ const CategoryFlagSchema = z.strictObject({
 export const AddressFlagsSchema = z.strictObject({
 	trusted: FlagMetadataSchema.optional(),
 	blocked: FlagMetadataSchema.optional(),
+	neverSpam: FlagMetadataSchema.optional(),
 	muted: FlagMetadataSchema.optional(),
 	vip: FlagMetadataSchema.optional(),
 	category: CategoryFlagSchema.optional(),
@@ -202,19 +203,6 @@ export const FilterClauseSchema = z.strictObject({
 	value: z.string().min(1).max(256),
 });
 
-/**
- * A semantic anchor as text, never as numbers. The vector is a function of the
- * embedding model that produced it, so it means nothing on an instance running
- * a different one; the source text re-embeds against whatever model the
- * importing instance actually has.
- */
-export const FilterAnchorSchema = z.strictObject({
-	sourceText: z.string().min(1).max(512),
-	/** `<modelId>@<dimensions>` the vector was built with, for provenance. */
-	embeddingId: NonEmpty,
-	sourceMessageId: StoredId,
-});
-
 /** A folder named the only way it can be named across instances. */
 export const FolderRefSchema = z.strictObject({
 	accountId: StoredId,
@@ -227,11 +215,10 @@ export const FilterSchema = z.strictObject({
 	/** ISO 8601 with offset when the scope is Temporary, otherwise null. */
 	expiresAt: IsoDateTime.nullable(),
 	matchOperator: z.enum(FilterMatchOperator),
-	literalClauses: z.array(FilterClauseSchema),
+	literalClauses: z.array(FilterClauseSchema).min(1),
 	/** The label this filter applies, by name — ids are local to an instance. */
 	actionLabelName: z.string().min(1).max(140).nullable(),
 	actionFolder: FolderRefSchema.nullable(),
-	anchor: FilterAnchorSchema.nullable(),
 });
 
 /**

package/src/golden.test.ts

@@ -1,10 +1,11 @@
 import assert from "node:assert/strict";
 import { test } from "node:test";
 import { readGoldenConfigDocument } from "./fixtures.js";
+import { liftToCurrentVersion } from "./migrations.js";
 import { readConfigDocument } from "./read.js";
 import { CURRENT_SCHEMA_VERSION } from "./version.js";
 
-test("the golden v1 document parses", () => {
+test("the golden v1 document reads at the current version", () => {
 	const document = readConfigDocument(readGoldenConfigDocument());
 
 	assert.equal(document.schemaVersion, CURRENT_SCHEMA_VERSION);
@@ -15,8 +16,11 @@ test("the golden v1 document parses", () => {
 	);
 });
 
-test("the golden v1 document round-trips through JSON unchanged", () => {
-	const source = readGoldenConfigDocument();
+test("the lifted golden document round-trips through JSON unchanged", () => {
+	const source = liftToCurrentVersion(
+		readGoldenConfigDocument() as Record<string, unknown>,
+		1,
+	);
 
 	const parsed = readConfigDocument(source);
 
@@ -39,7 +43,7 @@ test("the golden v1 document carries the parts a move has to preserve", () => {
 	);
 	assert.equal(document.filters[0]?.actionFolder?.folderPath, "INBOX.Facturen");
 	assert.equal(document.filters[0]?.actionLabelName, "Facturen");
-	assert.ok(document.filters[1]?.anchor?.sourceText);
+	assert.equal(document.filters.length, 1, "the anchor-only filter is dropped");
 	assert.equal(document.addressFlags[0]?.flags.vip?.reason, "payment alerts");
 	assert.equal(
 		document.addressFlags[1]?.flags.unsubscribed?.expiresAt,

package/src/json-schema.test.ts

@@ -6,7 +6,11 @@ import {
 	serializeConfigJsonSchema,
 } from "./json-schema.js";
 import { artifactSchemaPath, committedSchemaPath } from "./schema-artifact.js";
-import { CONFIG_SCHEMA_ARTIFACT_PATH, CONFIG_SCHEMA_ID } from "./version.js";
+import {
+	CONFIG_SCHEMA_ARTIFACT_PATH,
+	CONFIG_SCHEMA_ID,
+	CURRENT_SCHEMA_VERSION,
+} from "./version.js";
 
 type JsonObject = Record<string, unknown>;
 
@@ -24,7 +28,10 @@ test("the emitted schema pins the envelope and closes the document", () => {
 	const properties = emitted.properties as JsonObject;
 
 	assert.deepEqual((properties.kind as JsonObject).const, "reader.config");
-	assert.deepEqual((properties.schemaVersion as JsonObject).const, 1);
+	assert.deepEqual(
+		(properties.schemaVersion as JsonObject).const,
+		CURRENT_SCHEMA_VERSION,
+	);
 	assert.equal(emitted.additionalProperties, false);
 	assert.deepEqual(emitted.required, [
 		"kind",

package/src/migrations.test.ts

@@ -10,8 +10,20 @@ import {
 import { readConfigDocument } from "./read.js";
 import { CURRENT_SCHEMA_VERSION } from "./version.js";
 
-test("v1 needs no migrations, and the chain is empty rather than absent", () => {
-	assert.deepEqual(configMigrations, []);
+test("v1 lifts to v2 by dropping each anchor and every anchor-only filter", () => {
+	const source = readGoldenConfigDocument() as Record<string, unknown>;
+
+	const lifted = liftToCurrentVersion(source, 1, configMigrations, 2);
+
+	assert.equal(lifted.schemaVersion, 2);
+	const filters = lifted.filters as Record<string, unknown>[];
+	assert.deepEqual(
+		filters.map((filter) => filter.name),
+		["Invoices to Facturen"],
+	);
+	for (const filter of filters) {
+		assert.equal("anchor" in filter, false);
+	}
 });
 
 test("a document already at the current version passes through untouched", () => {
@@ -72,7 +84,11 @@ test("a document already at the current version never enters the chain", () => {
 		},
 	];
 
-	const parsed = readConfigDocument(readGoldenConfigDocument(), migrations);
+	const current = liftToCurrentVersion(
+		readGoldenConfigDocument() as Record<string, unknown>,
+		1,
+	);
+	const parsed = readConfigDocument(current, migrations);
 
 	assert.equal(ran, 0);
 	assert.equal(parsed.schemaVersion, CURRENT_SCHEMA_VERSION);

package/src/migrations.ts

@@ -1,3 +1,4 @@
+import { z } from "zod/v4";
 import { ConfigVersionError } from "./errors.js";
 import { CURRENT_SCHEMA_VERSION } from "./version.js";
 
@@ -15,12 +16,29 @@ export type ConfigMigration = {
 	migrate(document: ConfigDocumentShape): ConfigDocumentShape;
 };
 
+const V1FiltersSchema = z.array(
+	z.looseObject({ literalClauses: z.array(z.unknown()), anchor: z.unknown() }),
+);
+
+/** An anchor-only filter has no clauses left to match on, so it goes with its anchor. */
+const dropFilterAnchors: ConfigMigration = {
+	from: 1,
+	to: 2,
+	migrate: (document) => ({
+		...document,
+		schemaVersion: 2,
+		filters: V1FiltersSchema.parse(document.filters)
+			.filter((filter) => filter.literalClauses.length > 0)
+			.map(({ anchor: _anchor, ...filter }) => filter),
+	}),
+};
+
 /**
- * Empty at v1, and the golden fixture is the seed that keeps it honest: the
- * first migration added here has a committed v1 document to lift, so the chain
- * is exercised by the same test that proves v1 still parses.
+ * The golden v1 fixture is the seed that keeps the chain honest: every step
+ * has a committed v1 document to lift, so the chain is exercised by the same
+ * test that proves v1 still reads.
  */
-export const configMigrations: readonly ConfigMigration[] = [];
+export const configMigrations: readonly ConfigMigration[] = [dropFilterAnchors];
 
 /**
  * Apply the chain from `fromVersion` up to the current version. A gap in the

package/src/read.test.ts

@@ -11,6 +11,7 @@ import {
 } from "./errors.js";
 import { readGoldenConfigDocument } from "./fixtures.js";
 import { readConfigDocument } from "./read.js";
+import { CURRENT_SCHEMA_VERSION } from "./version.js";
 
 type Mutable = Record<string, unknown>;
 type MutableAccount = Record<string, unknown>;
@@ -50,14 +51,15 @@ test("a document with no kind at all is refused as the wrong kind", () => {
 });
 
 test("a newer document is refused by version, before its shape is judged", () => {
-	const source = { ...document(), schemaVersion: 2, somethingV2Added: true };
+	const newer = CURRENT_SCHEMA_VERSION + 1;
+	const source = { ...document(), schemaVersion: newer, somethingAdded: true };
 
 	assert.throws(
 		() => readConfigDocument(source),
 		(error: unknown) => {
 			assert.ok(error instanceof ConfigVersionError);
-			assert.equal(error.documentVersion, 2);
-			assert.equal(error.supportedVersion, 1);
+			assert.equal(error.documentVersion, newer);
+			assert.equal(error.supportedVersion, CURRENT_SCHEMA_VERSION);
 			return true;
 		},
 	);

package/src/schema-artifact.ts

@@ -9,7 +9,7 @@ import { CONFIG_SCHEMA_ARTIFACT_PATH } from "./version.js";
  */
 export const committedSchemaPath = (): string =>
 	fileURLToPath(
-		new URL("../schema/reader-config.v1.schema.json", import.meta.url),
+		new URL("../schema/reader-config.v2.schema.json", import.meta.url),
 	);
 
 /** The generated artifact, at its path under the repository root. */

package/src/version.ts

@@ -7,12 +7,12 @@
 export const CONFIG_KIND = "reader.config";
 
 /** The document version this package writes and can read up to. */
-export const CURRENT_SCHEMA_VERSION = 1;
+export const CURRENT_SCHEMA_VERSION = 2;
 
 /** `$id` of the emitted JSON Schema artifact. */
 export const CONFIG_SCHEMA_ID =
-	"https://schemas.remit.email/reader-config.v1.schema.json";
+	"https://schemas.remit.email/reader-config.v2.schema.json";
 
 /** Path of the emitted JSON Schema artifact, relative to the repository root. */
 export const CONFIG_SCHEMA_ARTIFACT_PATH =
-	"build/config-schema/reader-config.v1.schema.json";
+	"build/config-schema/reader-config.v2.schema.json";