@workflow-cannon/workspace-kit 0.18.0 → 0.24.0

package/src/modules/documentation/view-models.ts

@@ -0,0 +1,132 @@
+import { readdir, readFile } from "node:fs/promises";
+import { existsSync } from "node:fs";
+import { resolve } from "node:path";
+import { dirname } from "node:path";
+import { fileURLToPath } from "node:url";
+import type { ViewModelDefinition, ViewModelSection, ViewRenderPolicy } from "./types.js";
+
+function parseScalar(raw: string): string | number | boolean {
+  const v = raw.trim();
+  if (v === "true") return true;
+  if (v === "false") return false;
+  if (/^-?\d+$/.test(v)) return Number.parseInt(v, 10);
+  return v.replace(/^"(.*)"$/, "$1");
+}
+
+function parseBlock(lines: string[], start: number, indent: number): { end: number; items: Record<string, unknown>[] } {
+  const items: Record<string, unknown>[] = [];
+  let idx = start;
+  while (idx < lines.length) {
+    const line = lines[idx];
+    const currentIndent = line.search(/\S|$/);
+    if (currentIndent < indent) break;
+    const trimmed = line.trim();
+    if (!trimmed.startsWith("- ")) {
+      idx += 1;
+      continue;
+    }
+    const item: Record<string, unknown> = {};
+    const first = trimmed.slice(2);
+    if (first.includes(":")) {
+      const split = first.indexOf(":");
+      const k = first.slice(0, split).trim();
+      const v = first.slice(split + 1).trim();
+      item[k] = parseScalar(v);
+    }
+    idx += 1;
+    while (idx < lines.length) {
+      const next = lines[idx];
+      const nextIndent = next.search(/\S|$/);
+      if (nextIndent <= currentIndent) break;
+      const t = next.trim();
+      const split = t.indexOf(":");
+      if (split > 0) {
+        const k = t.slice(0, split).trim();
+        const v = t.slice(split + 1).trim();
+        item[k] = parseScalar(v);
+      }
+      idx += 1;
+    }
+    items.push(item);
+  }
+  return { end: idx, items };
+}
+
+function parseViewModelYaml(text: string): ViewModelDefinition {
+  const lines = text
+    .split("\n")
+    .map((l) => l.replace(/\t/g, "  "))
+    .filter((l) => l.trim().length > 0 && !l.trim().startsWith("#"));
+  const root: Record<string, unknown> = {};
+  let idx = 0;
+  while (idx < lines.length) {
+    const line = lines[idx];
+    const trimmed = line.trim();
+    const split = trimmed.indexOf(":");
+    if (split <= 0) {
+      idx += 1;
+      continue;
+    }
+    const key = trimmed.slice(0, split).trim();
+    const value = trimmed.slice(split + 1).trim();
+    if (!value) {
+      const parsed = parseBlock(lines, idx + 1, line.search(/\S|$/) + 2);
+      root[key] = parsed.items;
+      idx = parsed.end;
+      continue;
+    }
+    root[key] = parseScalar(value);
+    idx += 1;
+  }
+
+  const sections = (root["sections"] as Record<string, unknown>[] | undefined) ?? [];
+  const renderPolicies = (root["render_policies"] as Record<string, unknown>[] | undefined) ?? [];
+  return {
+    id: String(root["id"] ?? ""),
+    version: Number(root["version"] ?? 1),
+    docType: String(root["doc_type"] ?? ""),
+    target: String(root["target"] ?? ""),
+    profile: root["source_profile"] as ViewModelDefinition["profile"],
+    sections: sections.map(
+      (s) =>
+        ({
+          id: String(s["id"] ?? ""),
+          title: s["title"] ? String(s["title"]) : undefined,
+          description: s["description"] ? String(s["description"]) : undefined,
+          renderer: String(s["renderer"] ?? ""),
+          source: String(s["source"] ?? "meta") as ViewModelSection["source"],
+          template: s["template"] ? String(s["template"]) : undefined
+        }) satisfies ViewModelSection
+    ),
+    renderPolicies: renderPolicies.map(
+      (p) =>
+        ({
+          id: String(p["id"] ?? ""),
+          mode: String(p["mode"] ?? "append") as ViewRenderPolicy["mode"],
+          when: p["when"] ? String(p["when"]) : undefined
+        }) satisfies ViewRenderPolicy
+    )
+  };
+}
+
+export async function loadViewModel(workspacePath: string, viewFile: string): Promise<ViewModelDefinition> {
+  const fullPath = resolve(resolveViewsRoot(workspacePath), viewFile);
+  const content = await readFile(fullPath, "utf8");
+  return parseViewModelYaml(content);
+}
+
+export async function listViewModels(workspacePath: string): Promise<string[]> {
+  const viewsPath = resolveViewsRoot(workspacePath);
+  const entries = await readdir(viewsPath, { withFileTypes: true });
+  return entries
+    .filter((e) => e.isFile() && e.name.endsWith(".view.yaml"))
+    .map((e) => e.name)
+    .sort();
+}
+
+function resolveViewsRoot(workspacePath: string): string {
+  const local = resolve(workspacePath, "src/modules/documentation/views");
+  if (existsSync(local)) return local;
+  const runtimeSourceRoot = resolve(dirname(fileURLToPath(import.meta.url)), "..", "..", "..");
+  return resolve(runtimeSourceRoot, "src/modules/documentation/views");
+}

package/src/modules/documentation/views/agents.view.yaml

@@ -0,0 +1,18 @@
+id: agents
+version: 1
+doc_type: agents
+target: AGENTS.md
+source_profile: core
+sections:
+  - id: meta
+    source: meta
+    renderer: renderMetaSection
+  - id: rules
+    source: rules
+    renderer: renderRuleSection
+  - id: decisions
+    source: decisions
+    renderer: renderDecisionSection
+render_policies:
+  - id: default
+    mode: append

package/src/modules/documentation/views/architecture.view.yaml

@@ -0,0 +1,18 @@
+id: architecture
+version: 1
+doc_type: architecture
+target: ARCHITECTURE.md
+source_profile: core
+sections:
+  - id: meta
+    source: meta
+    renderer: renderMetaSection
+  - id: rules
+    source: rules
+    renderer: renderRuleSection
+  - id: decisions
+    source: decisions
+    renderer: renderDecisionSection
+render_policies:
+  - id: default
+    mode: append

package/src/modules/documentation/views/principles.view.yaml

@@ -0,0 +1,18 @@
+id: principles
+version: 1
+doc_type: principles
+target: PRINCIPLES.md
+source_profile: core
+sections:
+  - id: meta
+    source: meta
+    renderer: renderMetaSection
+  - id: rules
+    source: rules
+    renderer: renderRuleSection
+  - id: decisions
+    source: decisions
+    renderer: renderDecisionSection
+render_policies:
+  - id: default
+    mode: append

package/src/modules/documentation/views/readme.view.yaml

@@ -0,0 +1,18 @@
+id: readme
+version: 1
+doc_type: readme
+target: README.md
+source_profile: core
+sections:
+  - id: meta
+    source: meta
+    renderer: renderMetaSection
+  - id: rules
+    source: rules
+    renderer: renderRuleSection
+  - id: decisions
+    source: decisions
+    renderer: renderDecisionSection
+render_policies:
+  - id: default
+    mode: append

package/src/modules/documentation/views/releasing.view.yaml

@@ -0,0 +1,18 @@
+id: releasing
+version: 1
+doc_type: releasing
+target: RELEASING.md
+source_profile: core
+sections:
+  - id: meta
+    source: meta
+    renderer: renderMetaSection
+  - id: rules
+    source: rules
+    renderer: renderRuleSection
+  - id: decisions
+    source: decisions
+    renderer: renderDecisionSection
+render_policies:
+  - id: default
+    mode: append

package/src/modules/documentation/views/roadmap.view.yaml

@@ -0,0 +1,18 @@
+id: roadmap
+version: 1
+doc_type: roadmap
+target: ROADMAP.md
+source_profile: core
+sections:
+  - id: meta
+    source: meta
+    renderer: renderMetaSection
+  - id: rules
+    source: rules
+    renderer: renderRuleSection
+  - id: decisions
+    source: decisions
+    renderer: renderDecisionSection
+render_policies:
+  - id: default
+    mode: append

package/src/modules/documentation/views/runbooks-consumer-cadence.view.yaml

@@ -0,0 +1,18 @@
+id: runbooks-consumer-cadence
+version: 1
+doc_type: runbooks-consumer-cadence
+target: runbooks/consumer-cadence.md
+source_profile: runbook
+sections:
+  - id: meta
+    source: meta
+    renderer: renderMetaSection
+  - id: rules
+    source: rules
+    renderer: renderRuleSection
+  - id: decisions
+    source: decisions
+    renderer: renderDecisionSection
+render_policies:
+  - id: default
+    mode: append

package/src/modules/documentation/views/runbooks-parity-validation-flow.view.yaml

@@ -0,0 +1,18 @@
+id: runbooks-parity-validation-flow
+version: 1
+doc_type: runbooks-parity-validation-flow
+target: runbooks/parity-validation-flow.md
+source_profile: runbook
+sections:
+  - id: meta
+    source: meta
+    renderer: renderMetaSection
+  - id: rules
+    source: rules
+    renderer: renderRuleSection
+  - id: decisions
+    source: decisions
+    renderer: renderDecisionSection
+render_policies:
+  - id: default
+    mode: append

package/src/modules/documentation/views/runbooks-release-channels.view.yaml

@@ -0,0 +1,18 @@
+id: runbooks-release-channels
+version: 1
+doc_type: runbooks-release-channels
+target: runbooks/release-channels.md
+source_profile: runbook
+sections:
+  - id: meta
+    source: meta
+    renderer: renderMetaSection
+  - id: rules
+    source: rules
+    renderer: renderRuleSection
+  - id: decisions
+    source: decisions
+    renderer: renderDecisionSection
+render_policies:
+  - id: default
+    mode: append

package/src/modules/documentation/views/security.view.yaml

@@ -0,0 +1,18 @@
+id: security
+version: 1
+doc_type: security
+target: SECURITY.md
+source_profile: core
+sections:
+  - id: meta
+    source: meta
+    renderer: renderMetaSection
+  - id: rules
+    source: rules
+    renderer: renderRuleSection
+  - id: decisions
+    source: decisions
+    renderer: renderDecisionSection
+render_policies:
+  - id: default
+    mode: append

package/src/modules/documentation/views/support.view.yaml

@@ -0,0 +1,18 @@
+id: support
+version: 1
+doc_type: support
+target: SUPPORT.md
+source_profile: core
+sections:
+  - id: meta
+    source: meta
+    renderer: renderMetaSection
+  - id: rules
+    source: rules
+    renderer: renderRuleSection
+  - id: decisions
+    source: decisions
+    renderer: renderDecisionSection
+render_policies:
+  - id: default
+    mode: append

package/src/modules/documentation/views/terms.view.yaml

@@ -0,0 +1,18 @@
+id: terms
+version: 1
+doc_type: terms
+target: TERMS.md
+source_profile: core
+sections:
+  - id: meta
+    source: meta
+    renderer: renderMetaSection
+  - id: rules
+    source: rules
+    renderer: renderRuleSection
+  - id: decisions
+    source: decisions
+    renderer: renderDecisionSection
+render_policies:
+  - id: default
+    mode: append

package/src/modules/documentation/views/workbooks-phase2-config-policy-workbook.view.yaml

@@ -0,0 +1,18 @@
+id: workbooks-phase2-config-policy-workbook
+version: 1
+doc_type: workbooks-phase2-config-policy-workbook
+target: workbooks/phase2-config-policy-workbook.md
+source_profile: workbook
+sections:
+  - id: meta
+    source: meta
+    renderer: renderMetaSection
+  - id: rules
+    source: rules
+    renderer: renderRuleSection
+  - id: decisions
+    source: decisions
+    renderer: renderDecisionSection
+render_policies:
+  - id: default
+    mode: append

package/src/modules/documentation/views/workbooks-task-engine-workbook.view.yaml

@@ -0,0 +1,18 @@
+id: workbooks-task-engine-workbook
+version: 1
+doc_type: workbooks-task-engine-workbook
+target: workbooks/task-engine-workbook.md
+source_profile: workbook
+sections:
+  - id: meta
+    source: meta
+    renderer: renderMetaSection
+  - id: rules
+    source: rules
+    renderer: renderRuleSection
+  - id: decisions
+    source: decisions
+    renderer: renderDecisionSection
+render_policies:
+  - id: default
+    mode: append

package/src/modules/documentation/views/workbooks-transcript-automation-baseline.view.yaml

@@ -0,0 +1,18 @@
+id: workbooks-transcript-automation-baseline
+version: 1
+doc_type: workbooks-transcript-automation-baseline
+target: workbooks/transcript-automation-baseline.md
+source_profile: workbook
+sections:
+  - id: meta
+    source: meta
+    renderer: renderMetaSection
+  - id: rules
+    source: rules
+    renderer: renderRuleSection
+  - id: decisions
+    source: decisions
+    renderer: renderDecisionSection
+render_policies:
+  - id: default
+    mode: append

package/src/modules/documentation/state.md

@@ -1,8 +0,0 @@
-# Documentation Module State
-
-Tracks current module runtime state and generation metadata.
-
-- `lastRunAt`: last successful generation timestamp
-- `lastRunInputs`: summary of source inputs and command arguments
-- `lastRunOutputs`: generated file list and checks
-- `lastRunStatus`: `ok` or `failed`