filegrc 0.7.1 → 0.8.0

package/README.md

@@ -44,13 +44,13 @@ npx filegrc policy-library
 
 The command shows an exact diff only when the current text still matches the prior starter default. It skips customized, approved, active, superseded, and retired Policy content. Accept one named proposal revision only with the command printed by the review, which includes `--accept`, `--proposal-revision`, and `--yes`. Acceptance fails if the proposal changed after review. It changes only the listed defaults and does not approve a Policy, activate it, or mark a Control implemented.
 
-The normal runtime uses data model v4. Start a model v3 upgrade with a read-only preview:
+The normal runtime uses data model v5. Start a model v4 upgrade with a read-only preview:
 
 ```sh
-npx filegrc migrate --to-model 4 --preview --json
+npx filegrc migrate --to-model 5 --preview --json
 ```
 
-Review every automatic, review-required, and unsupported item. A v3 System may represent either a bounded System or a Component, so ambiguous records need an explicit decisions file. Resolve unsupported items before applying the same migration with `--yes`. The [model v4 upgrade guide](https://github.com/Alignbase/filegrc/blob/main/docs/upgrading-to-model-v4.md) documents the decisions shape and migration result.
+Review every automatic, review-required, and unsupported item. Model v4 combined Document approval and activation, so the migration preserves approval facts, assigns program or engagement scope, and moves active Documents that still need a distinct cutover to approved without inventing an activation actor, date, or revision. It preserves historical management Documents from issued or completed Audits with a visible legacy basis. Resolve unsupported items before applying the same migration with `--yes`. The [model v5 upgrade guide](https://github.com/Alignbase/filegrc/blob/main/docs/upgrading-to-model-v5.md) documents the migration and required Step 3 review.
 
 A model v2 workspace must migrate to v3 first:
 
@@ -58,7 +58,7 @@ A model v2 workspace must migrate to v3 first:
 npx filegrc migrate --to-model 3 --preview --json
 ```
 
-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/Alignbase/filegrc/blob/main/docs/upgrading-to-model-v3.md) explains every migration class and the review that follows. Apply it before previewing model v4.
+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/Alignbase/filegrc/blob/main/docs/upgrading-to-model-v3.md) explains every migration class and the review that follows. Apply it before previewing model v4, then model v5.
 
 A model v1 workspace must migrate to v2 first:
 
@@ -66,7 +66,7 @@ A model v1 workspace must migrate to v2 first:
 npx filegrc migrate --to-model 2 --preview --json
 ```
 
-Follow the [model v2 upgrade guide](https://github.com/Alignbase/filegrc/blob/main/docs/upgrading-to-model-v2.md), then run the model v3 and v4 previews in order.
+Follow the [model v2 upgrade guide](https://github.com/Alignbase/filegrc/blob/main/docs/upgrading-to-model-v2.md), then run the model v3, v4, and v5 previews in order.
 
 `filegrc serve --help` prints bind, port, environment, and safety options without starting the server. The editable server prefers `127.0.0.1:8787` and chooses another available port when that port is occupied. 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.
 
@@ -76,7 +76,7 @@ Follow the [model v2 upgrade guide](https://github.com/Alignbase/filegrc/blob/ma
 
 `filegrc program-readiness` reports whether management can start a candidate Type 2 period. Add `--summary --json` for compact stage counts and next actions, or omit `--summary` for every readiness item. Use `--require-ready` in automation. Pass `--program PROGRAM_ID` when more than one active Program exists. The command does not require an Audit ID or CPA firm.
 
-Control implementation includes each selected Control family’s expected evidence, authoritative source Components, and source-readiness checks. `filegrc evidence-map --json` provides a focused read-only diagnostic for those checks. Fix gaps in the Control and Component records. During Step 4, create an Evidence Artifact only when a real export, report, screenshot, signed file, or approved external reference exists, then link it to the supporting operating record when applicable.
+Step 2 completes and independently approves the intended values and exact revisions of required program plans and schedules. Step 3 implements their linked requirements and uses `filegrc activate-documents --scaffold` to record the active Person, separate activation date, and revision. Control implementation also checks expected evidence, authoritative source Components, and source readiness. During Step 4, create Evidence only when operation produces a real record or artifact. Keep engagement-scoped terms, management assertions, representation letters, and other audit-specific Documents in Step 5. Link each one to one Audit and use `filegrc activate-documents --audit AUDIT_ID --scaffold` after approval. Model v5 evidence packets export both lifecycle events and their exact revisions in `document-lifecycle-index.csv`.
 
 `filegrc obligations` shows recurring work and a task-level preview for each Policy Event, including owners, deadlines, and requested proof. `filegrc trigger` adds the event and all of its Action Items to the Work Queue atomically, then prints the created task IDs and deadlines.
 

package/model/index.js

@@ -1,14 +1,31 @@
 import { readFileSync } from "node:fs";
 
-export const ACTIVE_MODEL_VERSION = "4";
-export const SUPPORTED_MODEL_VERSIONS = Object.freeze(["2", "3", ACTIVE_MODEL_VERSION]);
+export const ACTIVE_MODEL_VERSION = "5";
+export const SUPPORTED_MODEL_VERSIONS = Object.freeze(["2", "3", "4", ACTIVE_MODEL_VERSION]);
+export const MODEL_CAPABILITY_VERSIONS = Object.freeze({
+  "guided-workflow": 3,
+  "program-scope": 4,
+  "component-sources": 4,
+  "evidence-artifacts": 4,
+  "governed-document-activation": 5,
+  "document-workflow-scope": 5
+});
+
+export function modelSupports(modelOrVersion, capability) {
+  const introduced = MODEL_CAPABILITY_VERSIONS[capability];
+  if (!introduced) throw new Error(`Unknown model capability "${capability}".`);
+  const version = typeof modelOrVersion === "object"
+    ? modelOrVersion?.modelVersion
+    : modelOrVersion;
+  return Number(version || 0) >= introduced;
+}
 
 export function loadModel(version = ACTIVE_MODEL_VERSION) {
   const requested = String(version);
   if (!SUPPORTED_MODEL_VERSIONS.includes(requested)) {
-    const migrationTarget = requested === "1" ? "2" : requested === "2" ? "3" : "4";
+    const migrationTarget = requested === "1" ? "2" : requested === "2" ? "3" : requested === "3" ? "4" : "5";
     throw new Error(
-      `Unsupported data model version "${requested}". This filegrc release supports models v2, v3, and v4. `
+      `Unsupported data model version "${requested}". This filegrc release supports models v2, v3, v4, and v5. `
       + `Run \`npx filegrc migrate --to-model ${migrationTarget} --preview --json\` from the workspace root.`
     );
   }