filegrc 0.4.0 → 0.5.0

package/README.md

@@ -34,15 +34,23 @@ npx filegrc prepare-audit audit-id
 npx filegrc evidence-packet --start 2026-01-01 --end 2026-06-30 --audit audit-id
 ```
 
-## Upgrade a model v1 workspace
+## Upgrade an existing workspace
 
-The normal runtime uses data model v2. A model v1 workspace must be migrated before other commands can change it. Start with a read-only preview:
+The normal runtime uses data model v3. Start a model v2 upgrade with a read-only preview:
+
+```sh
+npx filegrc migrate --to-model 3 --preview --json
+```
+
+Review every automatic, review-required, and unsupported item. Resolve unsupported items before applying the same migration with `--yes`. The migration writes one atomic batch, validates model v3, changes no Git history, and is safe to rerun. The [model v3 upgrade guide](https://github.com/Sunpeak-AI/filegrc/blob/main/docs/upgrading-to-model-v3.md) explains every migration class and the review that follows.
+
+A model v1 workspace must migrate to v2 first:
 
 ```sh
 npx filegrc migrate --to-model 2 --preview --json
 ```
 
-Resolve every item in `missing`, `conflicts`, and `manualActions`. Then rerun the same command with `--yes`. The migration writes one atomic batch, validates model v2, changes no Git history, and is safe to rerun. The [model v2 upgrade guide](https://github.com/Sunpeak-AI/filegrc/blob/main/docs/upgrading-to-model-v2.md) lists every field mapping and review step.
+Follow the [model v2 upgrade guide](https://github.com/Sunpeak-AI/filegrc/blob/main/docs/upgrading-to-model-v2.md), then run the model v3 preview.
 
 `filegrc serve --help` prints bind, port, environment, and safety options without starting the server. The editable server defaults to `127.0.0.1:8787`; set `FILEGRC_HOST`, `FILEGRC_PORT`, or the matching flags when needed. In trunk mode, browser saves synchronize, commit, and push from the authoritative branch. Use `--allow-non-authoritative-writes` for local development in a task checkout; the override never commits or pushes.
 

package/model/index.js

@@ -1,14 +1,18 @@
 import { readFileSync } from "node:fs";
 
-export function loadModel(version = "2") {
+export const ACTIVE_MODEL_VERSION = "3";
+export const SUPPORTED_MODEL_VERSIONS = Object.freeze(["2", ACTIVE_MODEL_VERSION]);
+
+export function loadModel(version = ACTIVE_MODEL_VERSION) {
   const requested = String(version);
-  if (requested !== "2") {
+  if (!SUPPORTED_MODEL_VERSIONS.includes(requested)) {
+    const migrationTarget = requested === "1" ? "2" : "3";
     throw new Error(
-      `Unsupported data model version "${requested}". This filegrc release uses model v2. `
-      + "Run `npx filegrc migrate --to-model 2 --preview --json` from the workspace root."
+      `Unsupported data model version "${requested}". This filegrc release supports models v2 and v3. `
+      + `Run \`npx filegrc migrate --to-model ${migrationTarget} --preview --json\` from the workspace root.`
     );
   }
-  const model = JSON.parse(readFileSync(new URL("./v2.json", import.meta.url), "utf8"));
+  const model = JSON.parse(readFileSync(new URL(`./v${requested}.json`, import.meta.url), "utf8"));
   for (const [type, definition] of Object.entries(model.resources)) {
     for (const [name, field] of Object.entries({ ...model.commonFields, ...definition.fields })) {
       expandRegistryReference(model, field, `${type}.${name}`);