@remit/data-ports 0.0.11 → 0.0.13

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remit/data-ports",
-  "version": "0.0.11",
+  "version": "0.0.13",
   "type": "module",
   "main": "src/index.ts",
   "types": "src/index.ts",
@@ -28,11 +28,15 @@
     "./wellknown": {
       "types": "./src/wellknown.ts",
       "default": "./src/wellknown.ts"
+    },
+    "./update-manifest": {
+      "types": "./src/update-manifest.ts",
+      "default": "./src/update-manifest.ts"
     }
   },
   "scripts": {
     "test:typecheck": "tsgo --noEmit",
-    "test:run": "node --import tsx --test 'src/**/*.test.ts'"
+    "test:run": "node --import tsx --experimental-test-coverage --test-coverage-include='src/**' --test-coverage-exclude='src/**/*.test.ts' --test-coverage-exclude='src/**/*.test.tsx' --test-coverage-lines=50 --test 'src/**/*.test.ts'"
   },
   "dependencies": {
     "@remit/domain-enums": "*",

package/src/update-manifest.test.ts

@@ -0,0 +1,100 @@
+import assert from "node:assert/strict";
+import { describe, it } from "node:test";
+import { UpdateManifestSchema } from "./update-manifest.js";
+
+const GOOD_MANIFEST = {
+	version: "v1.5.0",
+	publishedAt: "2026-07-18T09:00:00Z",
+	summary: "Faster search and a fix for attachments over 25 MB.",
+	releaseNotesUrl: "https://github.com/remit-mail/reader/releases/tag/v1.5.0",
+	registry: "ghcr.io/remit-mail/reader",
+};
+
+describe("UpdateManifestSchema", () => {
+	it("accepts the documented manifest shape", () => {
+		assert.deepEqual(UpdateManifestSchema.parse(GOOD_MANIFEST), GOOD_MANIFEST);
+	});
+
+	it("rejects a version that is not vX.Y.Z", () => {
+		assert.throws(() =>
+			UpdateManifestSchema.parse({ ...GOOD_MANIFEST, version: "1.5.0" }),
+		);
+		assert.throws(() =>
+			UpdateManifestSchema.parse({ ...GOOD_MANIFEST, version: "v1.5" }),
+		);
+		assert.throws(() =>
+			UpdateManifestSchema.parse({ ...GOOD_MANIFEST, version: "v1.5.0-rc1" }),
+		);
+	});
+
+	it("rejects a publishedAt that is not ISO 8601", () => {
+		assert.throws(() =>
+			UpdateManifestSchema.parse({
+				...GOOD_MANIFEST,
+				publishedAt: "18 July 2026",
+			}),
+		);
+	});
+
+	it("rejects an empty summary", () => {
+		assert.throws(() =>
+			UpdateManifestSchema.parse({ ...GOOD_MANIFEST, summary: "" }),
+		);
+	});
+
+	it("rejects a summary over 140 characters", () => {
+		assert.throws(() =>
+			UpdateManifestSchema.parse({
+				...GOOD_MANIFEST,
+				summary: "x".repeat(141),
+			}),
+		);
+	});
+
+	it("accepts a summary at exactly 140 characters", () => {
+		const summary = "x".repeat(140);
+		assert.equal(
+			UpdateManifestSchema.parse({ ...GOOD_MANIFEST, summary }).summary,
+			summary,
+		);
+	});
+
+	it("rejects a releaseNotesUrl that is not a URL", () => {
+		assert.throws(() =>
+			UpdateManifestSchema.parse({
+				...GOOD_MANIFEST,
+				releaseNotesUrl: "not-a-url",
+			}),
+		);
+	});
+
+	it("rejects a releaseNotesUrl that is not https", () => {
+		assert.throws(() =>
+			UpdateManifestSchema.parse({
+				...GOOD_MANIFEST,
+				releaseNotesUrl:
+					"http://github.com/remit-mail/reader/releases/tag/v1.5.0",
+			}),
+		);
+	});
+
+	it("rejects a releaseNotesUrl using a non-http(s) scheme", () => {
+		assert.throws(() =>
+			UpdateManifestSchema.parse({
+				...GOOD_MANIFEST,
+				releaseNotesUrl: "javascript:alert(1)",
+			}),
+		);
+	});
+
+	it("rejects an empty registry", () => {
+		assert.throws(() =>
+			UpdateManifestSchema.parse({ ...GOOD_MANIFEST, registry: "" }),
+		);
+	});
+
+	it("rejects a manifest missing a required field", () => {
+		const { summary, ...rest } = GOOD_MANIFEST;
+		assert.throws(() => UpdateManifestSchema.parse(rest));
+	});
+});

package/src/update-manifest.ts

@@ -0,0 +1,18 @@
+import { z } from "zod";
+
+export const SUMMARY_MAX_LENGTH = 140;
+
+export const UpdateManifestSchema = z.object({
+	version: z.string().regex(/^v\d+\.\d+\.\d+$/),
+	publishedAt: z.string().datetime(),
+	summary: z.string().min(1).max(SUMMARY_MAX_LENGTH),
+	releaseNotesUrl: z
+		.string()
+		.url()
+		.refine((url) => url.startsWith("https://"), {
+			message: "releaseNotesUrl must be an https:// URL",
+		}),
+	registry: z.string().min(1),
+});
+
+export type UpdateManifest = z.infer<typeof UpdateManifestSchema>;