@soulguard/openclaw 0.1.3 → 0.2.0

package/src/templates.ts

@@ -1,113 +1,104 @@
 /**
- * OpenClaw configuration templates for Soulguard.
+ * OpenClaw protection templates for Soulguard.
  *
- * Every known path is explicitly placed in vault, ledger, or unprotected.
- * Tests validate that all paths are accounted for in every template.
+ * Each template partitions the same set of known paths into protect, watch,
+ * and release tiers. This makes templates authoritative — switching from
+ * paranoid to relaxed will release previously protected paths.
+ *
+ * Paths are relative to the OpenClaw home directory (~/.openclaw/).
+ * Trailing "/" marks directories.
+ * soulguard.json is omitted — init auto-protects it.
  */
 
-import type { SoulguardConfig } from "@soulguard/core";
-
-// ── Known path groups ──────────────────────────────────────────────────
-
-export const SOULGUARD_CONFIG = ["soulguard.json"] as const;
-export const CORE_IDENTITY = ["SOUL.md", "AGENTS.md", "IDENTITY.md", "USER.md"] as const;
-export const CORE_SESSION = ["TOOLS.md", "HEARTBEAT.md", "BOOTSTRAP.md"] as const;
-export const CORE_MEMORY = ["MEMORY.md"] as const;
-export const MEMORY_DIR = ["memory/**"] as const;
-export const SKILLS = ["skills/**"] as const;
-export const OPENCLAW_CONFIG = ["openclaw.json"] as const;
-export const CRON = ["cron/jobs.json"] as const;
-export const EXTENSIONS = ["extensions/**"] as const;
-export const SESSIONS = ["sessions/**"] as const;
-
-/** All known paths — every template must account for all of these */
-export const ALL_KNOWN_PATHS = [
-  ...SOULGUARD_CONFIG,
-  ...CORE_IDENTITY,
-  ...CORE_SESSION,
-  ...CORE_MEMORY,
-  ...MEMORY_DIR,
-  ...SKILLS,
-  ...OPENCLAW_CONFIG,
-  ...CRON,
-  ...EXTENSIONS,
-  ...SESSIONS,
-] as const;
-
-// ── Template type ──────────────────────────────────────────────────────
-
 export type TemplateName = "default" | "paranoid" | "relaxed";
 
 export type Template = {
   name: TemplateName;
   description: string;
-  vault: readonly string[];
-  ledger: readonly string[];
-  unprotected: readonly string[];
+  protect: readonly string[];
+  watch: readonly string[];
+  release: readonly string[];
 };
 
-/** Extract just the SoulguardConfig from a template */
-export function templateToConfig(template: Template): SoulguardConfig {
-  return {
-    vault: [...template.vault],
-    ledger: [...template.ledger],
-  };
-}
-
-// ── Templates ──────────────────────────────────────────────────────────
-
-export const defaultTemplate: Template = {
-  name: "default",
-  description: "Core identity and config in vault, memory and skills tracked in ledger",
-  vault: [
-    ...SOULGUARD_CONFIG,
-    ...CORE_IDENTITY,
-    ...CORE_SESSION,
-    ...OPENCLAW_CONFIG,
-    ...CRON,
-    ...EXTENSIONS,
-  ],
-  ledger: [...CORE_MEMORY, ...MEMORY_DIR, ...SKILLS],
-  unprotected: [...SESSIONS],
-};
+/** All known paths — every template must partition exactly this set. */
+export const ALL_KNOWN_PATHS = [
+  "workspace/SOUL.md",
+  "workspace/AGENTS.md",
+  "workspace/IDENTITY.md",
+  "workspace/USER.md",
+  "workspace/TOOLS.md",
+  "workspace/HEARTBEAT.md",
+  "workspace/BOOTSTRAP.md",
+  "workspace/MEMORY.md",
+  "workspace/memory/",
+  "workspace/skills/",
+  "workspace/sessions/",
+  "openclaw.json",
+  "cron/",
+  "extensions/",
+] as const;
 
-export const paranoidTemplate: Template = {
-  name: "paranoid",
-  description: "Everything possible in vault, only skills in ledger",
-  vault: [
-    ...SOULGUARD_CONFIG,
-    ...CORE_IDENTITY,
-    ...CORE_SESSION,
-    ...CORE_MEMORY,
-    ...MEMORY_DIR,
-    ...SKILLS,
-    ...OPENCLAW_CONFIG,
-    ...CRON,
-    ...EXTENSIONS,
-  ],
-  ledger: [...SESSIONS],
-  unprotected: [],
-};
+export const templates: Record<TemplateName, Template> = {
+  default: {
+    name: "default",
+    description: "Core identity and config protected, memory and skills watched",
+    protect: [
+      "workspace/SOUL.md",
+      "workspace/AGENTS.md",
+      "workspace/IDENTITY.md",
+      "workspace/USER.md",
+      "workspace/TOOLS.md",
+      "workspace/HEARTBEAT.md",
+      "workspace/BOOTSTRAP.md",
+      "openclaw.json",
+      "cron/",
+      "extensions/",
+    ],
+    watch: ["workspace/MEMORY.md", "workspace/memory/", "workspace/skills/"],
+    release: ["workspace/sessions/"],
+  },
 
-export const relaxedTemplate: Template = {
-  name: "relaxed",
-  description: "Only soulguard config locked, everything else tracked — good for initial setup",
-  vault: [...SOULGUARD_CONFIG],
-  ledger: [
-    ...CORE_IDENTITY,
-    ...CORE_SESSION,
-    ...CORE_MEMORY,
-    ...MEMORY_DIR,
-    ...SKILLS,
-    ...OPENCLAW_CONFIG,
-    ...CRON,
-    ...EXTENSIONS,
-  ],
-  unprotected: [...SESSIONS],
-};
+  paranoid: {
+    name: "paranoid",
+    description: "Everything protected, only sessions watched",
+    protect: [
+      "workspace/SOUL.md",
+      "workspace/AGENTS.md",
+      "workspace/IDENTITY.md",
+      "workspace/USER.md",
+      "workspace/TOOLS.md",
+      "workspace/HEARTBEAT.md",
+      "workspace/BOOTSTRAP.md",
+      "workspace/MEMORY.md",
+      "workspace/memory/",
+      "workspace/skills/",
+      "openclaw.json",
+      "cron/",
+      "extensions/",
+    ],
+    watch: ["workspace/sessions/"],
+    release: [],
+  },
 
-export const templates: Record<TemplateName, Template> = {
-  default: defaultTemplate,
-  paranoid: paranoidTemplate,
-  relaxed: relaxedTemplate,
+  relaxed: {
+    name: "relaxed",
+    description: "Everything watched — good for initial setup",
+    protect: [],
+    watch: [
+      "workspace/SOUL.md",
+      "workspace/AGENTS.md",
+      "workspace/IDENTITY.md",
+      "workspace/USER.md",
+      "workspace/TOOLS.md",
+      "workspace/HEARTBEAT.md",
+      "workspace/BOOTSTRAP.md",
+      "workspace/MEMORY.md",
+      "workspace/memory/",
+      "workspace/skills/",
+      "openclaw.json",
+      "cron/",
+      "extensions/",
+    ],
+    release: ["workspace/sessions/"],
+  },
 };