@ontrails/core 1.0.0-beta.13 → 1.0.0-beta.14

package/src/__tests__/derive.test.ts

@@ -2,13 +2,45 @@ import { describe, test, expect } from 'bun:test';
 
 import { z } from 'zod';
 
-import { deriveFields } from '../derive.js';
+import { deriveCliPath, deriveFields } from '../derive.js';
 
 // ---------------------------------------------------------------------------
 // Tests
 // ---------------------------------------------------------------------------
 
 describe('derive', () => {
+  describe('cli paths', () => {
+    test('top-level trail IDs derive to a one-segment CLI path', () => {
+      expect(deriveCliPath('search')).toEqual(['search']);
+    });
+
+    test('multi-dot trail IDs derive to the full ordered CLI path', () => {
+      expect(deriveCliPath('topo.pin.remove')).toEqual([
+        'topo',
+        'pin',
+        'remove',
+      ]);
+    });
+
+    test('trail IDs with consecutive dots throw a ValidationError', () => {
+      expect(() => deriveCliPath('topo..pin')).toThrow(
+        'Trail ID "topo..pin" contains an empty segment'
+      );
+    });
+
+    test('trail IDs with a leading dot throw a ValidationError', () => {
+      expect(() => deriveCliPath('.pin')).toThrow(
+        'Trail ID ".pin" contains an empty segment'
+      );
+    });
+
+    test('trail IDs with a trailing dot throw a ValidationError', () => {
+      expect(() => deriveCliPath('pin.')).toThrow(
+        'Trail ID "pin." contains an empty segment'
+      );
+    });
+  });
+
   describe('primitive types', () => {
     test('z.string() derives string field', () => {
       const schema = z.object({ name: z.string() });
@@ -119,6 +151,31 @@ describe('derive', () => {
       expect(fields[0]?.type).toBe('string[]');
       expect(fields[0]?.default).toEqual(['a', 'b']);
     });
+
+    test('z.array(z.object(...)) is omitted when it cannot be represented faithfully', () => {
+      const schema = z.object({
+        files: z.array(
+          z.object({
+            content: z.string(),
+            filename: z.string(),
+          })
+        ),
+      });
+
+      expect(deriveFields(schema)).toEqual([]);
+    });
+  });
+
+  describe('unsupported shapes', () => {
+    test('nested objects are omitted when they cannot be represented faithfully', () => {
+      const schema = z.object({
+        filter: z.object({
+          query: z.string(),
+        }),
+      });
+
+      expect(deriveFields(schema)).toEqual([]);
+    });
   });
 
   describe('modifiers', () => {

package/src/__tests__/topo-store-read.test.ts

@@ -0,0 +1,251 @@
+import { afterEach, describe, expect, test } from 'bun:test';
+import { mkdtempSync, rmSync } from 'node:fs';
+import { tmpdir } from 'node:os';
+import { join } from 'node:path';
+
+import { z } from 'zod';
+
+import {
+  createMockTopoStore,
+  createTopoStore,
+  provision,
+  Result,
+  signal,
+  topo,
+  topoStore,
+  trail,
+} from '../index.js';
+import { pinTopoSave } from '../internal/topo-saves.js';
+import type { TopoSaveRecord } from '../internal/topo-saves.js';
+import { persistEstablishedTopoSave } from '../internal/topo-store.js';
+import { openWriteTrailsDb } from '../internal/trails-db.js';
+
+const noop = () => Result.ok({ ok: true });
+
+const expectOk = async <T>(
+  result: Promise<Result<T, Error>> | Result<T, Error>
+): Promise<T> => {
+  const resolved = await result;
+  if (resolved.isErr()) {
+    throw resolved.error;
+  }
+  return resolved.value;
+};
+
+const requireValue = <T>(value: T | undefined, message: string): T => {
+  if (value === undefined) {
+    throw new Error(message);
+  }
+  return value;
+};
+
+const exampleApp = () => {
+  const dbMain = provision('db.main', {
+    create: () => Result.ok({ source: 'factory' }),
+    description: 'Primary database',
+    health: () => Result.ok({ ok: true }),
+    mock: () => ({ source: 'mock' }),
+  });
+
+  const entityAdded = signal('entity.added', {
+    description: 'An entity was added',
+    from: ['entity.add'],
+    payload: z.object({ id: z.string() }),
+  });
+
+  const entityAdd = trail('entity.add', {
+    blaze: (input: { readonly name: string }) =>
+      Result.ok({ id: input.name.toLowerCase(), ok: true }),
+    description: 'Add a new entity',
+    examples: [
+      {
+        expected: { id: 'ada', ok: true },
+        input: { name: 'Ada' },
+        name: 'Add Ada',
+      },
+    ],
+    input: z.object({ name: z.string() }),
+    output: z.object({ id: z.string(), ok: z.boolean() }),
+    provisions: [dbMain],
+  });
+
+  const entityList = trail('entity.list', {
+    blaze: noop,
+    crosses: ['entity.add'],
+    description: 'List entities',
+    detours: {
+      ConflictError: ['entity.add'],
+    },
+    idempotent: true,
+    input: z.object({}),
+    intent: 'read',
+    output: z.object({ ok: z.boolean() }),
+    provisions: [dbMain],
+  });
+
+  return topo('projection-app', {
+    dbMain,
+    entityAdd,
+    entityAdded,
+    entityList,
+  });
+};
+
+describe('read-only topo store', () => {
+  let tmpRoot: string | undefined;
+
+  afterEach(() => {
+    if (tmpRoot) {
+      rmSync(tmpRoot, { force: true, recursive: true });
+      tmpRoot = undefined;
+    }
+  });
+
+  const makeRoot = (): string => {
+    tmpRoot = mkdtempSync(join(tmpdir(), 'topo-store-read-'));
+    return tmpRoot;
+  };
+
+  const seedStore = (): {
+    readonly rootDir: string;
+    readonly save: TopoSaveRecord;
+  } => {
+    const rootDir = makeRoot();
+    const db = openWriteTrailsDb({ rootDir });
+
+    try {
+      const result = persistEstablishedTopoSave(db, exampleApp(), {
+        createdAt: '2026-04-03T14:00:00.000Z',
+        gitSha: 'abc123',
+      });
+      if (result.isErr()) {
+        throw result.error;
+      }
+      const save = result.value;
+      pinTopoSave(db, { name: 'baseline', saveId: save.id });
+      return { rootDir, save };
+    } finally {
+      db.close();
+    }
+  };
+
+  test('lists save-scoped trails and provisions through typed accessors', () => {
+    const { rootDir, save } = seedStore();
+    const store = createTopoStore({ rootDir });
+
+    expect(store.saves.latest()?.id).toBe(save.id);
+    expect(store.pins.get('baseline')?.saveId).toBe(save.id);
+
+    expect(store.trails.list({ save: { saveId: save.id } })).toEqual([
+      expect.objectContaining({
+        description: 'Add a new entity',
+        exampleCount: 1,
+        hasOutput: true,
+        id: 'entity.add',
+        intent: 'write',
+      }),
+      expect.objectContaining({
+        description: 'List entities',
+        exampleCount: 0,
+        id: 'entity.list',
+        intent: 'read',
+        safety: 'read',
+      }),
+    ]);
+
+    expect(store.provisions.list({ save: { saveId: save.id } })).toEqual([
+      expect.objectContaining({
+        description: 'Primary database',
+        health: 'available',
+        id: 'db.main',
+        usedBy: ['entity.add', 'entity.list'],
+      }),
+    ]);
+  });
+
+  test('filters trails by intent', () => {
+    const { rootDir, save } = seedStore();
+    const store = createTopoStore({ rootDir });
+
+    const writeTrails = store.trails.list({
+      intent: 'write',
+      save: { saveId: save.id },
+    });
+    expect(writeTrails).toHaveLength(1);
+    expect(writeTrails[0]?.id).toBe('entity.add');
+
+    const readTrails = store.trails.list({
+      intent: 'read',
+      save: { saveId: save.id },
+    });
+    expect(readTrails).toHaveLength(1);
+    expect(readTrails[0]?.id).toBe('entity.list');
+  });
+
+  test('returns detailed trail and export views, plus a query escape hatch', () => {
+    const { rootDir, save } = seedStore();
+    const store = createTopoStore({ rootDir });
+
+    const detail = store.trails.get('entity.list', {
+      save: { saveId: save.id },
+    });
+    expect(detail).toEqual(
+      expect.objectContaining({
+        crosses: ['entity.add'],
+        detours: { ConflictError: ['entity.add'] },
+        id: 'entity.list',
+        provisions: ['db.main'],
+      })
+    );
+    expect(detail?.examples).toEqual([]);
+
+    const exported = store.exports.get({ pin: 'baseline' });
+    expect(exported?.save.id).toBe(save.id);
+    expect(exported?.trailheadHash).toHaveLength(64);
+
+    const rows = store.query<{ id: string }>(
+      'SELECT id FROM topo_trails WHERE save_id = ? ORDER BY id ASC',
+      [save.id]
+    );
+    expect(rows).toEqual([{ id: 'entity.add' }, { id: 'entity.list' }]);
+  });
+
+  test('fails loudly when no saved topo state exists', () => {
+    const rootDir = makeRoot();
+    const store = createTopoStore({ rootDir });
+
+    expect(() => store.saves.latest()).toThrow('No saved topo state found');
+    expect(() => store.trails.list()).toThrow('No saved topo state found');
+    expect(() => store.exports.get()).toThrow('No saved topo state found');
+  });
+
+  test('exposes a provision factory and mock for topoStore', async () => {
+    const { rootDir } = seedStore();
+
+    const created = await expectOk(
+      topoStore.create({
+        config: undefined,
+        cwd: rootDir,
+        env: {},
+        workspaceRoot: rootDir,
+      })
+    );
+
+    expect(created.saves.latest()).toBeDefined();
+    expect(
+      created.query<{ count: number }>(
+        'SELECT COUNT(*) as count FROM topo_saves'
+      )[0]?.count
+    ).toBe(1);
+
+    expect(topoStore.mock).toBeDefined();
+    const mock = await requireValue(
+      topoStore.mock,
+      'Expected topoStore to define a mock factory'
+    )();
+    expect(mock).toBeDefined();
+    expect(() =>
+      createMockTopoStore().query('SELECT id FROM topo_trails')
+    ).toThrow('Mock topoStore.query() is unsupported');
+  });
+});