@remit/config-format 0.0.1 → 0.0.2

package/package.json

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

package/schema/reader-config.v1.schema.json

@@ -41,8 +41,8 @@
 			"properties": {
 				"accountConfigId": {
 					"type": "string",
-					"format": "uuid",
-					"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
+					"minLength": 25,
+					"maxLength": 25
 				},
 				"instance": {
 					"type": "string"
@@ -59,6 +59,9 @@
 			"properties": {
 				"name": {
 					"type": "string"
+				},
+				"defaultComposerFormat": {
+					"type": "string"
 				}
 			},
 			"required": [
@@ -73,8 +76,8 @@
 				"properties": {
 					"accountId": {
 						"type": "string",
-						"format": "uuid",
-						"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
+						"minLength": 25,
+						"maxLength": 25
 					},
 					"email": {
 						"type": "string",
@@ -470,8 +473,8 @@
 								"properties": {
 									"accountId": {
 										"type": "string",
-										"format": "uuid",
-										"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
+										"minLength": 25,
+										"maxLength": 25
 									},
 									"folderPath": {
 										"type": "string",
@@ -506,8 +509,8 @@
 									},
 									"sourceMessageId": {
 										"type": "string",
-										"format": "uuid",
-										"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
+										"minLength": 25,
+										"maxLength": 25
 									}
 								},
 								"required": [
@@ -784,9 +787,6 @@
 				"density": {
 					"type": "string"
 				},
-				"defaultComposerFormat": {
-					"type": "string"
-				},
 				"savedSearches": {
 					"type": "array",
 					"items": {
@@ -811,7 +811,6 @@
 			"required": [
 				"theme",
 				"density",
-				"defaultComposerFormat",
 				"savedSearches"
 			],
 			"additionalProperties": false

package/src/document.test.ts

@@ -94,7 +94,7 @@ test("a filter names its label by name and its folder by account and path", () =
 		literalClauses: [{ field: FilterClauseField.ListId, value: "x.example" }],
 		actionLabelName: "Facturen",
 		actionFolder: {
-			accountId: "6f4c2c30-9a2c-4a7f-9f9f-1f2c3d4e5a6b",
+			accountId: "6f4c2c309a2c4a7f9f9f1f2c3",
 			folderPath: "INBOX.Facturen",
 		},
 		anchor: null,
@@ -108,7 +108,7 @@ test("a filter names its label by name and its folder by account and path", () =
 	assert.equal(
 		FilterSchema.safeParse({
 			...filter,
-			actionFolder: { mailboxId: "6f4c2c30-9a2c-4a7f-9f9f-1f2c3d4e5a6b" },
+			actionFolder: { mailboxId: "6f4c2c309a2c4a7f9f9f1f2c3" },
 		}).success,
 		false,
 	);
@@ -126,7 +126,7 @@ test("a filter anchor carries its source text and no vector", () => {
 		anchor: {
 			sourceText: "the release note we file every month",
 			embeddingId: "amazon.titan-embed-text-v2:0@1024",
-			sourceMessageId: "2c9e4b11-7d5a-4f60-9a31-5b8c0e7f2d44",
+			sourceMessageId: "2c9e4b117d5a4f609a315b8c0",
 		},
 	};
 
@@ -137,7 +137,7 @@ test("a filter anchor carries its source text and no vector", () => {
 			anchor: {
 				sourceText: "x",
 				embeddingId: "m@1",
-				sourceMessageId: "2c9e4b11-7d5a-4f60-9a31-5b8c0e7f2d44",
+				sourceMessageId: "2c9e4b117d5a4f609a315b8c0",
 				anchorEmbedding: [0.1, 0.2],
 			},
 		}).success,
@@ -205,6 +205,46 @@ test("the reserved decisions slot is defined and empty", () => {
 	assert.equal(MessageDecisionsSchema.safeParse([{}]).success, false);
 });
 
+test("an id is the stored 25-character form, never the RFC 4122 spelling", () => {
+	// Every id in this database is a UUID re-encoded base36 to 25 characters,
+	// and `UUID` in the API contract means exactly that. A schema that took the
+	// dashed spelling would refuse every id a real export produces, so the
+	// dashed one has to fail here for the stored one to be the contract.
+	const account = goldenAccount();
+	account.accountId = "6f4c2c30-9a2c-4a7f-9f9f-1f2c3d4e5a6b";
+
+	assert.equal(AccountSchema.safeParse(account).success, false);
+	assert.equal(
+		AccountSchema.safeParse({
+			...goldenAccount(),
+			accountId: "6f4c2c309a2c4a7f9f9f1f2c3",
+		}).success,
+		true,
+	);
+});
+
+test("the composer format is a server setting, not a browser one", () => {
+	// It lives in an AccountSetting row the server owns and a database drop
+	// takes with it, so it rides `accountConfig`. Carrying it in the block the
+	// server ignores would have the file record it and the import discard it.
+	const source = readGoldenConfigDocument() as {
+		accountConfig: Record<string, unknown>;
+		clientPreferences: Record<string, unknown>;
+	};
+
+	assert.equal(source.accountConfig.defaultComposerFormat, "markdown");
+	assert.equal(
+		ReaderConfigDocumentSchema.safeParse({
+			...source,
+			clientPreferences: {
+				...source.clientPreferences,
+				defaultComposerFormat: "markdown",
+			},
+		}).success,
+		false,
+	);
+});
+
 test("the document schema refuses an unknown top-level section", () => {
 	const source = readGoldenConfigDocument() as Record<string, unknown>;
 

package/src/document.ts

@@ -11,7 +11,15 @@ import { z } from "zod/v4";
 import { CONFIG_KIND, CURRENT_SCHEMA_VERSION } from "./version.js";
 
 const NonEmpty = z.string().min(1);
-const Uuid = z.uuid();
+
+/**
+ * A reader identifier in the form it is stored and travels: a UUID re-encoded
+ * base36 to a fixed 25 characters, which is what the `UUID` scalar in the API
+ * contract means here and what every id in the database actually holds. The
+ * account id crosses verbatim — resynced message ids hash from it — so the file
+ * has to accept the stored spelling rather than the RFC 4122 one.
+ */
+const StoredId = z.string().length(25);
 const IsoDateTime = z.iso.datetime({ offset: true });
 const Port = z.int().min(1).max(65535);
 const FlagTimestamp = z.int();
@@ -42,7 +50,7 @@ export const GeneratorSchema = z
  */
 export const ProvenanceSchema = z
 	.strictObject({
-		accountConfigId: Uuid,
+		accountConfigId: StoredId,
 		instance: z.string(),
 	})
 	.describe("The instance this file was exported from. Never applied.");
@@ -145,7 +153,7 @@ export const FolderOverrideSchema = z.strictObject({
 });
 
 export const AccountSchema = z.strictObject({
-	accountId: Uuid,
+	accountId: StoredId,
 	email: NonEmpty,
 	username: NonEmpty,
 	authType: z.enum(AccountAuthType),
@@ -165,6 +173,13 @@ export const AccountSchema = z.strictObject({
 
 export const AccountConfigSchema = z.strictObject({
 	name: z.string(),
+	/**
+	 * Which body format the composer opens on. A server-held setting rather than
+	 * a browser one — it is stored per configuration and travels with it, so a
+	 * database drop loses it unless the file carries it. Optional because a
+	 * configuration that has never been asked holds no row.
+	 */
+	defaultComposerFormat: z.string().optional(),
 });
 
 export const LabelSchema = z.strictObject({
@@ -187,12 +202,12 @@ export const FilterAnchorSchema = z.strictObject({
 	sourceText: z.string().min(1).max(512),
 	/** `<modelId>@<dimensions>` the vector was built with, for provenance. */
 	embeddingId: NonEmpty,
-	sourceMessageId: Uuid,
+	sourceMessageId: StoredId,
 });
 
 /** A folder named the only way it can be named across instances. */
 export const FolderRefSchema = z.strictObject({
-	accountId: Uuid,
+	accountId: StoredId,
 	folderPath: ImapPath,
 });
 
@@ -222,7 +237,6 @@ export const SavedSearchSchema = z.strictObject({
 export const ClientPreferencesSchema = z.strictObject({
 	theme: z.string(),
 	density: z.string(),
-	defaultComposerFormat: z.string(),
 	savedSearches: z.array(SavedSearchSchema),
 });
 

package/src/fixtures/reader-config.v1.json

@@ -7,15 +7,16 @@
 		"exportedAt": "2026-08-27T09:15:00+02:00"
 	},
 	"provenance": {
-		"accountConfigId": "0d9c8b7a-6e5f-4d3c-b2a1-0f9e8d7c6b5a",
+		"accountConfigId": "0d9c8b7a6e5f4d3cb2a10f9e8",
 		"instance": "reader.ischen.nl"
 	},
 	"accountConfig": {
-		"name": "Matthijs"
+		"name": "Matthijs",
+		"defaultComposerFormat": "markdown"
 	},
 	"accounts": [
 		{
-			"accountId": "6f4c2c30-9a2c-4a7f-9f9f-1f2c3d4e5a6b",
+			"accountId": "6f4c2c309a2c4a7f9f9f1f2c3",
 			"email": "matthijs@ischen.nl",
 			"username": "matthijs@ischen.nl",
 			"authType": "password",
@@ -63,7 +64,7 @@
 			"pinnedFolders": ["INBOX", "INBOX.Facturen"]
 		},
 		{
-			"accountId": "b3a1d0c7-5e64-4f1b-8c2a-77e9d3b40f18",
+			"accountId": "b3a1d0c75e644f1b8c2a77e9d",
 			"email": "work@example.com",
 			"username": "work@example.com",
 			"authType": "oauthMicrosoft",
@@ -108,7 +109,7 @@
 			],
 			"actionLabelName": "Facturen",
 			"actionFolder": {
-				"accountId": "6f4c2c30-9a2c-4a7f-9f9f-1f2c3d4e5a6b",
+				"accountId": "6f4c2c309a2c4a7f9f9f1f2c3",
 				"folderPath": "INBOX.Facturen"
 			},
 			"anchor": null
@@ -124,7 +125,7 @@
 			"anchor": {
 				"sourceText": "We have shipped version 4.2 of the runtime; the changelog covers the new scheduler.",
 				"embeddingId": "amazon.titan-embed-text-v2:0@1024",
-				"sourceMessageId": "2c9e4b11-7d5a-4f60-9a31-5b8c0e7f2d44"
+				"sourceMessageId": "2c9e4b117d5a4f609a315b8c0"
 			}
 		}
 	],
@@ -162,7 +163,6 @@
 	"clientPreferences": {
 		"theme": "dark",
 		"density": "comfortable",
-		"defaultComposerFormat": "markdown",
 		"savedSearches": [{ "name": "Unpaid invoices", "query": "label:Facturen is:unread" }]
 	},
 	"messageDecisions": []