@sprig-and-prose/scene-example 0.1.0

package/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@sprig-and-prose/scene-example",
+  "version": "0.1.0",
+  "type": "module",
+  "description": "Example package: compile sprig prose to scene manifests",
+  "scripts": {
+    "compile": "node scripts/compile.js",
+    "run:tools": "npx tsx scripts/run-tools.js",
+    "run:skills": "npx tsx scripts/run-skills.js",
+    "run:skills-many": "npx tsx scripts/run-skills-many.js",
+    "run:trace": "npx tsx scripts/run-trace.js"
+  },
+  "dependencies": {
+    "@sprig-and-prose/sprig-scene-engine": "*",
+    "@sprig-and-prose/sprig-scenes": "*"
+  }
+}

package/scripts/compile.js

@@ -0,0 +1,30 @@
+/**
+ * @fileoverview Compile sprig/*.prose into .sprig/*.scene.json
+ */
+
+import { readdir, writeFile, mkdir } from 'node:fs/promises';
+import { join, dirname } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { compileSceneFile } from '@sprig-and-prose/sprig-scenes/compiler';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+const sprigDir = join(__dirname, '..', 'sprig');
+const outDir = join(__dirname, '..', '.sprig');
+
+const entries = await readdir(sprigDir);
+const proseFiles = entries.filter((entry) => entry.endsWith('.prose')).sort();
+
+await mkdir(outDir, { recursive: true });
+
+for (const entry of proseFiles) {
+  const inputPath = join(sprigDir, entry);
+  const outputBase = entry.endsWith('.scene.prose')
+    ? entry.replace(/\.scene\.prose$/u, '.scene.json')
+    : `${entry.replace(/\.prose$/u, '')}.scene.json`;
+  const outputPath = join(outDir, outputBase);
+  const manifest = await compileSceneFile(inputPath);
+  const json = `${JSON.stringify(manifest, null, 2)}\n`;
+  await writeFile(outputPath, json, 'utf-8');
+}

package/scripts/run-skills-many.js

@@ -0,0 +1,44 @@
+/**
+ * Harness: load skills-many.scene.json, set test data, evaluate PlayerSkillMatches (many resolver).
+ * Run after compile: npm run compile && npm run run:skills-many
+ */
+
+import { readFile } from 'node:fs/promises';
+import { join, dirname } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { createSceneRuntime } from '@sprig-and-prose/sprig-scene-engine';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+const MANIFEST_PATH = join(__dirname, '..', '.sprig', 'skills-many.scene.json');
+
+const skills = [
+  { id: 10, name: 'X' },
+  { id: 10, name: 'X2' },
+  { id: 20, name: 'Y' },
+];
+
+const rawPlayerSkills = [
+  { playerId: 1, skillId: 10, experience: 5 },
+  { playerId: 2, skillId: 20, experience: 7 },
+];
+
+async function main() {
+  const raw = await readFile(MANIFEST_PATH, 'utf-8');
+  const manifest = JSON.parse(raw);
+
+  const runtime = createSceneRuntime(manifest);
+  runtime.setPortalData('Skills', skills);
+  runtime.setPortalData('RawPlayerSkills', rawPlayerSkills);
+
+  console.log('Derived results for skills-many.scene.json (many resolver demo):\n');
+
+  const result = runtime.getDerived('PlayerSkillMatches');
+  console.log('PlayerSkillMatches:', JSON.stringify(result, null, 2));
+}
+
+main().catch((err) => {
+  console.error(err);
+  process.exit(1);
+});

package/scripts/run-skills.js

@@ -0,0 +1,49 @@
+/**
+ * Harness: load skills.scene.json, set test data, evaluate PlayerSkills derived block.
+ * Run after compile: npm run compile && npm run run:skills
+ */
+
+import { readFile } from 'node:fs/promises';
+import { join, dirname } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { createSceneRuntime } from '@sprig-and-prose/sprig-scene-engine';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+const MANIFEST_PATH = join(__dirname, '..', '.sprig', 'skills.scene.json');
+
+const players = [
+  { id: 1, name: 'Alice' },
+  { id: 2, name: 'Bob' },
+];
+
+const skills = [
+  { id: 10, name: 'Coding' },
+  { id: 20, name: 'Hacking' },
+];
+
+const rawPlayerSkills = [
+  { playerId: 1, skillId: 10, experience: 5 },
+  { playerId: 2, skillId: 20, experience: 7 },
+];
+
+async function main() {
+  const raw = await readFile(MANIFEST_PATH, 'utf-8');
+  const manifest = JSON.parse(raw);
+
+  const runtime = createSceneRuntime(manifest);
+  runtime.setPortalData('Players', players);
+  runtime.setPortalData('Skills', skills);
+  runtime.setPortalData('RawPlayerSkills', rawPlayerSkills);
+
+  console.log('Derived results for skills.scene.json with test data:\n');
+
+  const result = runtime.getDerived('PlayerSkills');
+  console.log('PlayerSkills:', JSON.stringify(result, null, 2));
+}
+
+main().catch((err) => {
+  console.error(err);
+  process.exit(1);
+});

package/scripts/run-tools.js

@@ -0,0 +1,91 @@
+/**
+ * Harness: load tools.scene.json, set test data, evaluate derived blocks and print results.
+ * Run after compile: npm run compile && npm run run:tools
+ */
+
+import { readFile } from 'node:fs/promises';
+import { join, dirname } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { createSceneRuntime } from '@sprig-and-prose/sprig-scene-engine';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+const MANIFEST_PATH = join(__dirname, '..', '.sprig', 'tools.scene.json');
+
+// Test data matching portals: ContainerRows (array of ContainerRow), AnotherToolPortal (array of Paperdoll)
+const containerRows = [
+  {
+    item: {
+      id: 10,
+      tools: [
+        { id: 1, name: 'Hammer' },
+        { id: 2, name: 'Wrench' },
+      ],
+    },
+    count: 2,
+  },
+  {
+    item: {
+      id: 11,
+      tools: [
+        { id: 3, name: 'Hammer' },
+        { id: 4, name: 'Pliers' },
+      ],
+    },
+    count: 1,
+  },
+  {
+    item: {
+      id: 12,
+      tools: [{ id: 5, name: 'Wrench' }],
+    },
+    count: 1,
+  },
+];
+
+const anotherToolPortal = [
+  {
+    tools: [{ id: 10, name: 'Brush' }],
+  },
+];
+
+const DERIVED_BLOCK_NAMES = [
+  'RowCount',
+  'ToolNames',
+  'ToolCount',
+  'ToolString1',
+  'ToolString2',
+  'MultipleExtracts',
+];
+
+async function main() {
+  const raw = await readFile(MANIFEST_PATH, 'utf-8');
+  const manifest = JSON.parse(raw);
+
+  const runtime = createSceneRuntime(manifest);
+  runtime.setPortalData('ContainerRows', containerRows);
+  runtime.setPortalData('AnotherToolPortal', anotherToolPortal);
+
+  console.log('Derived results for tools.scene.json with test data:\n');
+
+  for (const name of DERIVED_BLOCK_NAMES) {
+    try {
+      const result = runtime.getDerived(name);
+      const display =
+        typeof result === 'string'
+          ? result
+          : Array.isArray(result)
+            ? JSON.stringify(result)
+            : JSON.stringify(result);
+      console.log(`${name}: ${display}`);
+    } catch (err) {
+      console.log(`${name}: ERROR ${err.message}`);
+    }
+  }
+}
+
+main().catch((err) => {
+  console.error(err);
+  process.exit(1);
+});

package/scripts/run-trace.js

@@ -0,0 +1,22 @@
+import { evaluate, renderTraceToConsole, renderNarrative } from '@sprig-and-prose/sprig-scene-engine';
+import { readFile } from 'node:fs/promises';
+
+const manifest = JSON.parse(await readFile('.sprig/skills.scene.json', 'utf-8'));
+const portals = {
+  Players: [{ id: 1, name: 'Alice' }, { id: 2, name: 'Bob' }],
+  Skills: [{ id: 10, name: 'Coding' }, { id: 20, name: 'Hacking' }],
+  RawPlayerSkills: [
+    { playerId: 1, skillId: 10, experience: 5 },
+    { playerId: 2, skillId: 20, experience: 7 },
+  ],
+};
+
+const { results, trace } = evaluate(manifest, portals, { trace: true });
+
+console.log('Results:', JSON.stringify(results, null, 2));
+console.log('\n--- Trace (structured) ---');
+console.log(JSON.stringify(trace, null, 2));
+console.log('\n--- Trace (readable) ---');
+console.log(renderTraceToConsole(trace));
+console.log('\n--- Trace (narrative) ---');
+console.log(renderNarrative(trace));

package/sprig/actor.scene.prose

@@ -0,0 +1,8 @@
+scene LeftPanel {
+  actor Player {
+    kind {
+      id { integer }
+      name { string }
+    }
+  }
+}

package/sprig/skills-many.scene.prose

@@ -0,0 +1,52 @@
+scene SkillManyScene {
+  actors {
+    Skill {
+      kind {
+        id { integer }
+        name { string }
+      }
+
+      identity { id }
+    }
+
+    RawPlayerSkill {
+      kind {
+        playerId { integer }
+        skillId { integer }
+        experience { integer }
+      }
+
+      identity { playerId skillId }
+    }
+  }
+
+  portals {
+    Skills {
+      kind { [ Skill ] }
+    }
+
+    RawPlayerSkills {
+      kind { [ RawPlayerSkill ] }
+    }
+  }
+
+  derived {
+    PlayerSkillMatches {
+      each {
+        from { RawPlayerSkills[] }
+        named { row }
+        as {
+          skillMatches {
+            many {
+              from { Skills[] }
+              matches { row.skillId }
+              by { id }
+            }
+          }
+
+          experience { row.experience }
+        }
+      }
+    }
+  }
+}

package/sprig/skills.scene.prose

@@ -0,0 +1,85 @@
+scene SkillScene {
+  actors {
+    Skill {
+      kind {
+        id { integer }
+        name { string }
+      }
+
+      identity { id }
+    }
+
+    Player {
+      kind {
+        id { integer }
+        name { string }
+      }
+
+      identity { id }
+    }
+
+    RawPlayerSkill {
+      kind {
+        playerId { integer }
+        skillId { integer }
+        experience { integer }
+      }
+
+      identity { playerId, skillId }
+    }
+
+    PlayerSkill {
+      kind {
+        player { Player }
+        skill { Skill }
+        experience { integer }
+      }
+
+      identity { player skill }
+    }
+  }
+
+  portals {
+    Players {
+      kind { [ Player ] }
+    }
+
+    Skills {
+      kind { [ Skill ] }
+    }
+
+    RawPlayerSkills {
+      kind { [ RawPlayerSkill ] }
+    }
+  }
+
+  derived {
+    PlayerSkills {
+      kind { [ PlayerSkill ] }
+
+      each {
+        from { RawPlayerSkills[] }
+        named { row }
+        as {
+          player {
+            one {
+              from { Players[] }
+              matches { row.playerId }
+              by { id }
+            }
+          }
+
+          skill {
+            one {
+              from { Skills[] }
+              matches { row.skillId }
+              by { id }
+            }
+          }
+
+          experience { row.experience }
+        }
+      }
+    }
+  }
+}

package/sprig/tools.scene.prose

@@ -0,0 +1,82 @@
+scene ToolScene {
+  actors {
+    Tool {
+      kind {
+        id { integer }
+        name { string }
+      }
+
+      identity { id }
+    }
+
+    Item {
+      kind {
+        id { integer }
+        tools { [ Tool ] }
+      }
+
+      identity { id }
+    }
+
+    ContainerRow {
+      kind {
+        item { Item }
+        count { integer }
+      }
+
+      identity { item }
+    }
+
+    Paperdoll {
+      kind {
+        tools { [ Tool ] }
+      }
+    }
+  }
+
+  portals {
+    ContainerRows {
+      kind { [ ContainerRow ] }
+    }
+
+    AnotherToolPortal {
+      kind { [ Paperdoll ] }
+    }
+  }
+
+  derived {
+    RowCount {
+      count { ContainerRows }
+    }
+
+    MultipleExtracts {
+      values ContainerTools { ContainerRows[].item.tools[] }
+      values OtherTools     { AnotherToolPortal[].tools[] }
+      values CombinedTools  { ContainerTools[] OtherTools[] }
+    }
+
+    ToolNames {
+      values { ContainerRows[].item.tools[].name }
+      unique { values }
+      sort   {
+        from  { unique }
+        order { ascending }
+      }
+    }
+
+    ToolCount {
+      count { ToolNames }
+    }
+
+    ToolString1 {
+      join { ToolNames with { ', ' } }
+    }
+
+    ToolString2 {
+      join {
+        from { ToolNames }
+        with { ', ' }
+      }
+    }
+  }
+}