@mdbase-dev/connect-dev 0.1.0-beta.124 → 0.1.0-beta.125

package/README.md

@@ -79,6 +79,28 @@ The helper validates each contract document and derives the exact semantic
 `provides` descriptors. Managed resources evolve with the pack; seed resources
 become collection-owned after their initial creation.
 
+A seed type may list the exact starters previously shipped for it, so a
+collection that still has any of them can be upgraded:
+
+```ts
+{
+  kind: "type",
+  mode: "seed",
+  source: "types/task/3.md",
+  target: "_types/task.md",
+  document: taskV3,
+  upgradeFrom: [{ document: taskV1 }, { document: taskV2 }]
+}
+```
+
+`defineTypePack` emits these as `upgrade_from` baselines, computing each
+digest and copying the `version` the document declares (an explicit `version`
+must match it). It rejects baselines on anything but a seed type, duplicates,
+the resource's own document, and documents of a different type kind or name,
+using the same validator as application manifests. An unedited starter is
+replaced exactly; an edited one is merged only against the baseline the
+collection's lock records as its origin, and is otherwise left unchanged.
+
 Native applications may add a reverse-domain private-use callback scheme that
 matches the v1 manifest's application ID, such as
 `example.tasks.desktop://auth/mdbase/callback` for

package/dist/index.d.ts

@@ -40,6 +40,15 @@ export interface TypePackResourceInput {
     target?: string;
     /** Exact UTF-8 resource document included in the provision. */
     document: string;
+    /**
+     * Seed types only: the exact starters previously shipped for this resource
+     * that a collection may be upgraded from, oldest first. Digests are computed
+     * from each document, and `version` defaults to the one the document declares.
+     */
+    upgradeFrom?: Array<{
+        document: string;
+        version?: number;
+    }>;
 }
 export interface TypePackDefinition {
     id: string;

package/dist/index.js

@@ -1,8 +1,8 @@
 import { createHash } from "node:crypto";
 import { Ajv2020 } from "ajv/dist/2020.js";
-import { parseDocument } from "yaml";
+import { isMap, parseDocument } from "yaml";
 import { connectError, MdbaseCollectionClient } from "@mdbase-dev/connect/advanced";
-import { formatManifestValidationIssues, validateAppManifest } from "@mdbase-dev/connect-protocol/manifest";
+import { formatManifestValidationIssues, validateAppManifest, validateTypePackProvision } from "@mdbase-dev/connect-protocol/manifest";
 import connectProblemSchema from "@mdbase-dev/connect-protocol/schemas/connect-problem.v1.schema.json" with { type: "json" };
 import dataContractSchema from "@mdbase-dev/connect-protocol/schemas/data-contract.schema.json" with { type: "json" };
 import connectProtocolSchema from "@mdbase-dev/connect-protocol/schemas/connect-protocol.v1.schema.json" with { type: "json" };
@@ -69,12 +69,13 @@ export function defineTypePack(definition) {
             version: definition.version,
             ...(definition.name ? { name: definition.name } : {}),
             ...(definition.description ? { description: definition.description } : {}),
-            resources: definition.resources.map(({ kind, mode, source, target = source, document }) => ({
+            resources: definition.resources.map(({ kind, mode, source, target = source, document, upgradeFrom }) => ({
+                ...(upgradeFrom ? { upgrade_from: upgradeFrom.map(upgradeBaseline) } : {}),
                 kind,
                 mode,
                 source,
                 target,
-                digest: `sha256:${createHash("sha256").update(document).digest("hex")}`
+                digest: sha256(document)
             }))
         },
         resources: definition.resources.map(({ source, document }) => ({ source, document })),
@@ -83,8 +84,28 @@ export function defineTypePack(definition) {
     const result = validateProtocolValue(provision, "typePackProvision");
     if (!result.valid)
         throw new TypePackDefinitionError(result.issues);
+    const issues = validateTypePackProvision(provision);
+    if (issues.length > 0)
+        throw new TypePackDefinitionError(issues);
     return provision;
 }
+function upgradeBaseline({ document, version }) {
+    const declared = version ?? declaredTypeVersion(document);
+    return { digest: sha256(document), document, ...(declared === undefined ? {} : { version: declared }) };
+}
+/** The positive integer `version` a type document declares, if any. */
+function declaredTypeVersion(document) {
+    const frontmatter = /^---\r?\n([\s\S]*?)\r?\n---(?:\r?\n|$)/u.exec(document)?.[1];
+    const parsed = frontmatter === undefined ? undefined : parseDocument(frontmatter, { uniqueKeys: true });
+    if (!parsed || parsed.errors.length > 0 || !isMap(parsed.contents))
+        return undefined;
+    // Read only `version`, so anchors elsewhere in a starter need no alias expansion.
+    const version = parsed.get("version");
+    return Number.isInteger(version) && Number(version) > 0 ? Number(version) : undefined;
+}
+function sha256(document) {
+    return `sha256:${createHash("sha256").update(document).digest("hex")}`;
+}
 function exactContractReferenceFromDocument(document, resourceIndex) {
     const frontmatter = /^---\r?\n([\s\S]*?)\r?\n---(?:\r?\n|$)/u.exec(document)?.[1];
     if (frontmatter === undefined) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mdbase-dev/connect-dev",
-  "version": "0.1.0-beta.124",
+  "version": "0.1.0-beta.125",
   "private": false,
   "type": "module",
   "license": "MIT",
@@ -26,8 +26,8 @@
   "dependencies": {
     "ajv": "^8.20.0",
     "yaml": "^2.9.1",
-    "@mdbase-dev/connect": "0.1.0-beta.124",
-    "@mdbase-dev/connect-protocol": "0.1.0-beta.124"
+    "@mdbase-dev/connect": "0.1.0-beta.125",
+    "@mdbase-dev/connect-protocol": "0.1.0-beta.125"
   },
   "devDependencies": {
     "@types/node": "^24.0.0",
@@ -36,7 +36,7 @@
   },
   "scripts": {
     "build": "node -e \"require('node:fs').rmSync('dist',{recursive:true,force:true})\" && tsc -p tsconfig.json && node -e \"require('node:fs').chmodSync('dist/cli.js',0o755)\"",
-    "test": "vitest run",
+    "test": "node ../../scripts/ci/vitest.mjs",
     "typecheck": "tsc -p tsconfig.json --noEmit"
   }
 }