@remit/data-ports 0.0.16 → 0.0.17

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remit/data-ports",
-  "version": "0.0.16",
+  "version": "0.0.17",
   "type": "module",
   "main": "src/index.ts",
   "types": "src/index.ts",

package/src/update-manifest.test.ts

@@ -97,4 +97,34 @@ describe("UpdateManifestSchema", () => {
 		const { summary, ...rest } = GOOD_MANIFEST;
 		assert.throws(() => UpdateManifestSchema.parse(rest));
 	});
+
+	it("accepts a non-negative integer schemaVersion", () => {
+		const withSchema = { ...GOOD_MANIFEST, schemaVersion: 9 };
+		assert.deepEqual(UpdateManifestSchema.parse(withSchema), withSchema);
+	});
+
+	it("accepts a manifest without a schemaVersion", () => {
+		assert.equal(
+			UpdateManifestSchema.parse(GOOD_MANIFEST).schemaVersion,
+			undefined,
+		);
+	});
+
+	it("rejects a non-integer schemaVersion", () => {
+		assert.throws(() =>
+			UpdateManifestSchema.parse({ ...GOOD_MANIFEST, schemaVersion: 9.5 }),
+		);
+	});
+
+	it("rejects a negative schemaVersion", () => {
+		assert.throws(() =>
+			UpdateManifestSchema.parse({ ...GOOD_MANIFEST, schemaVersion: -1 }),
+		);
+	});
+
+	it("rejects a schemaVersion that is not a number", () => {
+		assert.throws(() =>
+			UpdateManifestSchema.parse({ ...GOOD_MANIFEST, schemaVersion: "9" }),
+		);
+	});
 });

package/src/update-manifest.ts

@@ -13,6 +13,12 @@ export const UpdateManifestSchema = z.object({
 			message: "releaseNotesUrl must be an https:// URL",
 		}),
 	registry: z.string().min(1),
+	// The highest schema migration the release applies, as a count of the
+	// migrations shipped at that release. The updater compares it against the
+	// running instance's version to tell whether installing this release runs a
+	// migration. Optional so a manifest published before this field validates and
+	// reads as an unknown schema version rather than an error.
+	schemaVersion: z.number().int().nonnegative().optional(),
 });
 
 export type UpdateManifest = z.infer<typeof UpdateManifestSchema>;