laymos 0.0.6 → 0.0.7

package/dist/cli/lint/lint.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"lint.d.ts","sourceRoot":"","sources":["../../../src/cli/lint/lint.ts"],"names":[],"mappings":"AAAA,OAAO,EAAW,MAAM,EAAE,MAAM,QAAQ,CAAC;AACzC,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAQ9C,wBAAgB,eAAe,CAAC,CAAC,EAC/B,UAAU,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC,+QAW5C"}
+{"version":3,"file":"lint.d.ts","sourceRoot":"","sources":["../../../src/cli/lint/lint.ts"],"names":[],"mappings":"AAAA,OAAO,EAAW,MAAM,EAAE,MAAM,QAAQ,CAAC;AACzC,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAa9C,wBAAgB,eAAe,CAAC,CAAC,EAC/B,UAAU,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC,+QAW5C"}

package/dist/cli/lint/lint.js

@@ -1,10 +1,12 @@
 import { Console, Effect } from 'effect';
 import { Command } from 'effect/unstable/cli';
 import { analyzeProject } from '../../orchestrator/analyze-project/index.js';
+import { getStoryTree } from '../../orchestrator/run-stories/index.js';
 import { makeLayersCommand } from './layers/index.js';
 import { renderLayerReport } from './layers/report.js';
 import { makeModulesCommand } from './modules/index.js';
 import { renderModuleReport } from './modules/report.js';
+import { countGroupsWithoutPage, renderStoriesReport, } from './stories/index.js';
 export function makeLintCommand(configPath) {
     return Command.make('lint', {}, () => configPath.pipe(Effect.flatMap(runLint))).pipe(Command.withDescription('Check every configured architectural rule.'), Command.withSubcommands([
         makeLayersCommand(configPath),
@@ -16,11 +18,19 @@ function runLint(configPath) {
         const result = yield* analyzeProject(configPath);
         yield* Console.log(renderLayerReport(result.layerAnalysis));
         yield* Console.log(renderModuleReport(result.moduleAnalysis));
+        const missingPages = yield* lintStories(configPath);
         if (result.layerAnalysis.unassignedFiles.length > 0 ||
             result.layerAnalysis.forbiddenImports.length > 0 ||
             result.layerAnalysis.layersWithoutModules.length > 0 ||
-            result.moduleAnalysis.violations.length > 0) {
+            result.moduleAnalysis.violations.length > 0 ||
+            missingPages > 0) {
             process.exitCode = 1;
         }
     });
 }
+// A project without a Stories path has no Story Groups to lint.
+function lintStories(configPath) {
+    return getStoryTree(configPath).pipe(Effect.flatMap((tree) => Console.log(renderStoriesReport(tree)).pipe(Effect.as(countGroupsWithoutPage(tree)))), Effect.catchTag('StoriesError', (error) => error.reason === 'no-stories-path'
+        ? Effect.succeed(0)
+        : Effect.die(error)));
+}

package/dist/cli/lint/stories/index.d.ts

@@ -0,0 +1,2 @@
+export { countGroupsWithoutPage, renderStoriesReport } from './report.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/cli/lint/stories/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/cli/lint/stories/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,sBAAsB,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC"}

package/dist/cli/lint/stories/index.js

@@ -0,0 +1,2 @@
+// The lint command uses these to report Story Groups missing their page.
+export { countGroupsWithoutPage, renderStoriesReport } from './report.js';

package/dist/cli/lint/stories/report.d.ts

@@ -0,0 +1,4 @@
+import type { StoryTree } from '../../../story/schema/index.js';
+export declare function renderStoriesReport(tree: StoryTree): string;
+export declare function countGroupsWithoutPage(tree: StoryTree): number;
+//# sourceMappingURL=report.d.ts.map

package/dist/cli/lint/stories/report.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"report.d.ts","sourceRoot":"","sources":["../../../../src/cli/lint/stories/report.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAkB,MAAM,gCAAgC,CAAC;AAEhF,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,SAAS,GAAG,MAAM,CAY3D;AAED,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,SAAS,GAAG,MAAM,CAE9D"}

package/dist/cli/lint/stories/report.js

@@ -0,0 +1,24 @@
+import * as colors from 'yoctocolors';
+export function renderStoriesReport(tree) {
+    const missing = groupsWithoutPage(tree, []);
+    if (missing.length === 0) {
+        return colors.green('✓ Every Story Group has a page');
+    }
+    return [
+        colors.red('Story Groups without a page'),
+        '',
+        ...missing.map((id) => `  ${colors.yellow('✕')} ${id}`),
+        '',
+        `${missing.length} ${missing.length === 1 ? 'group' : 'groups'}`,
+    ].join('\n');
+}
+export function countGroupsWithoutPage(tree) {
+    return groupsWithoutPage(tree, []).length;
+}
+function groupsWithoutPage(group, path) {
+    const id = [...path, group.title];
+    return [
+        ...(group.page === null ? [id.join('/')] : []),
+        ...group.groups.flatMap((child) => groupsWithoutPage(child, id)),
+    ];
+}

package/dist/orchestrator/run-stories/run-stories.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"run-stories.d.ts","sourceRoot":"","sources":["../../../src/orchestrator/run-stories/run-stories.ts"],"names":[],"mappings":"AAIA,OAAO,EAAS,MAAM,EAAQ,MAAM,EAAE,MAAM,QAAQ,CAAC;AAWrD,OAAO,KAAK,EAOV,WAAW,EAEX,SAAS,EAEV,MAAM,6BAA6B,CAAC;AAErC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gCAAgC,CAAC;AAUlE,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAO3C,wBAAgB,YAAY,CAC1B,UAAU,EAAE,MAAM,GACjB,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,WAAW,GAAG,YAAY,CAAC,CAEtD;AAED,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC3C;AAED,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;CAC9C;AAID,wBAAgB,WAAW,CACzB,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,iBAAiB,GAC1B,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,WAAW,GAAG,YAAY,CAAC,CAYvD;AAED,wBAAgB,UAAU,CACxB,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,iBAAiB,GAC1B,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,WAAW,GAAG,YAAY,CAAC,CAIxD"}
+{"version":3,"file":"run-stories.d.ts","sourceRoot":"","sources":["../../../src/orchestrator/run-stories/run-stories.ts"],"names":[],"mappings":"AAIA,OAAO,EAAS,MAAM,EAAQ,MAAM,EAAE,MAAM,QAAQ,CAAC;AAWrD,OAAO,KAAK,EAQV,WAAW,EAEX,SAAS,EAEV,MAAM,6BAA6B,CAAC;AAErC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gCAAgC,CAAC;AAUlE,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAO3C,wBAAgB,YAAY,CAC1B,UAAU,EAAE,MAAM,GACjB,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,WAAW,GAAG,YAAY,CAAC,CAEtD;AAED,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC3C;AAED,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;CAC9C;AAID,wBAAgB,WAAW,CACzB,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,iBAAiB,GAC1B,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,WAAW,GAAG,YAAY,CAAC,CAYvD;AAED,wBAAgB,UAAU,CACxB,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,iBAAiB,GAC1B,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,WAAW,GAAG,YAAY,CAAC,CAIxD"}

package/dist/orchestrator/run-stories/run-stories.js

@@ -65,11 +65,17 @@ function loadRoot(configPath) {
                 cause: null,
             });
         }
-        return yield* indexGroup(root, [root.title], entryPoint, {
+        const options = {
             projectRoot: dirname(absoluteConfigPath),
             storiesRoot,
             supportCache: new Map(),
-        });
+            groupDirectories: new Map(),
+        };
+        const indexed = yield* indexGroup(root, [root.title], entryPoint, options);
+        return {
+            ...indexed,
+            tree: attachGroupPages(indexed.tree, indexed.directory, options.projectRoot, options.groupDirectories),
+        };
     }).pipe(Effect.provide(ConfigServiceLive), Effect.provide(NodeServices.layer));
 }
 function indexGroup(group, path, entryPoint, options) {
@@ -78,6 +84,7 @@ function indexGroup(group, path, entryPoint, options) {
         const groups = [];
         const leaves = [];
         const stories = [];
+        const directories = [];
         for (const child of group.children) {
             const id = [...path, child.title].join('/');
             if (isStory(child)) {
@@ -87,25 +94,102 @@ function indexGroup(group, path, entryPoint, options) {
                 leaves.push({
                     id,
                     title: child.title,
+                    description: child.description,
+                    spine: child.spine,
+                    page: resolveStoryPage(child, options.projectRoot),
                     setup: snippets.setup,
                     questions,
                     source,
                     support: resolveSupport(child, options),
                 });
                 stories.push({ id, story: child });
+                const directory = storyDirectory(child);
+                if (directory !== null)
+                    directories.push(directory);
             }
             else {
                 const indexed = yield* indexGroup(child, [...path, child.title], entryPoint, options);
                 groups.push(indexed.tree);
+                options.groupDirectories.set(indexed.tree, indexed.directory);
                 stories.push(...indexed.stories);
+                directories.push(...indexed.directories);
             }
         }
         return {
-            tree: { title: group.title, groups, stories: leaves },
+            tree: {
+                title: group.title,
+                description: group.description,
+                page: null,
+                groups,
+                stories: leaves,
+            },
             stories,
+            directories,
+            directory: commonDirectory(directories),
         };
     });
 }
+function storyDirectory(story) {
+    try {
+        return dirname(fileURLToPath(story.sourceUrl));
+    }
+    catch {
+        return null;
+    }
+}
+function readPage(filePath, projectRoot) {
+    if (!existsSync(filePath))
+        return null;
+    return {
+        path: relative(projectRoot, filePath),
+        content: readFileSync(filePath, 'utf8'),
+    };
+}
+function resolveStoryPage(story, projectRoot) {
+    let filePath;
+    try {
+        filePath = fileURLToPath(story.sourceUrl);
+    }
+    catch {
+        return null;
+    }
+    if (!filePath.endsWith('.ts'))
+        return null;
+    return readPage(`${filePath.slice(0, -3)}.md`, projectRoot);
+}
+// A Story Group owns the folder its descendant Stories share, and its page sits
+// there under the group's own title. Two groups can span one folder — a Learn
+// and a Reference trunk over the same Stories — so the title, not `index`, is
+// what keeps their pages apart.
+function groupPage(group, directory, projectRoot) {
+    if (directory === null)
+        return null;
+    return readPage(join(directory, `${slugifyQuestion(group.title)}.md`), projectRoot);
+}
+function attachGroupPages(group, directory, projectRoot, directoriesById) {
+    return {
+        ...group,
+        page: groupPage(group, directory, projectRoot),
+        groups: group.groups.map((child) => attachGroupPages(child, directoriesById.get(child) ?? null, projectRoot, directoriesById)),
+    };
+}
+function commonDirectory(directories) {
+    const [first, ...rest] = directories;
+    if (first === undefined)
+        return null;
+    let shared = first.split(sep);
+    for (const directory of rest) {
+        const segments = directory.split(sep);
+        let index = 0;
+        while (index < shared.length &&
+            index < segments.length &&
+            shared[index] === segments[index]) {
+            index += 1;
+        }
+        shared = shared.slice(0, index);
+    }
+    return shared.length === 0 ? null : shared.join(sep);
+}
 function indexQuestions(story, source, snippets) {
     return Effect.gen(function* () {
         const seen = new Set();

package/dist/story/schema/index.d.ts

@@ -1,6 +1,6 @@
 export { CapturedTraceSchema, QuestionReportSchema, QuestionSectionSchema, RecordedFlowSchema, StoryAssertionSchema, StoryReportSchema, StoryVerdictSchema, } from './story-report-schema.js';
 export type { CapturedTrace, JsonValue, QuestionReport, QuestionSection, RecordedFlow, StoryAssertion, StoryReport, StoryVerdict, } from './story-report-schema.js';
 export { slugifyQuestion } from './slug.js';
-export { QuestionLeafSchema, StoryLeafSchema, StorySourceSchema, StoryTreeGroupSchema, StoryTreeSchema, } from './story-tree-schema.js';
-export type { QuestionLeaf, StoryLeaf, StorySource, StoryTree, StoryTreeGroup, } from './story-tree-schema.js';
+export { QuestionLeafSchema, StoryLeafSchema, StoryPageSchema, StorySourceSchema, StoryTreeGroupSchema, StoryTreeSchema, } from './story-tree-schema.js';
+export type { QuestionLeaf, StoryLeaf, StoryPage, StorySource, StoryTree, StoryTreeGroup, } from './story-tree-schema.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/story/schema/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/story/schema/index.ts"],"names":[],"mappings":"AACA,OAAO,EACL,mBAAmB,EACnB,oBAAoB,EACpB,qBAAqB,EACrB,kBAAkB,EAClB,oBAAoB,EACpB,iBAAiB,EACjB,kBAAkB,GACnB,MAAM,0BAA0B,CAAC;AAClC,YAAY,EACV,aAAa,EACb,SAAS,EACT,cAAc,EACd,eAAe,EACf,YAAY,EACZ,cAAc,EACd,WAAW,EACX,YAAY,GACb,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAC5C,OAAO,EACL,kBAAkB,EAClB,eAAe,EACf,iBAAiB,EACjB,oBAAoB,EACpB,eAAe,GAChB,MAAM,wBAAwB,CAAC;AAChC,YAAY,EACV,YAAY,EACZ,SAAS,EACT,WAAW,EACX,SAAS,EACT,cAAc,GACf,MAAM,wBAAwB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/story/schema/index.ts"],"names":[],"mappings":"AACA,OAAO,EACL,mBAAmB,EACnB,oBAAoB,EACpB,qBAAqB,EACrB,kBAAkB,EAClB,oBAAoB,EACpB,iBAAiB,EACjB,kBAAkB,GACnB,MAAM,0BAA0B,CAAC;AAClC,YAAY,EACV,aAAa,EACb,SAAS,EACT,cAAc,EACd,eAAe,EACf,YAAY,EACZ,cAAc,EACd,WAAW,EACX,YAAY,GACb,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAC5C,OAAO,EACL,kBAAkB,EAClB,eAAe,EACf,eAAe,EACf,iBAAiB,EACjB,oBAAoB,EACpB,eAAe,GAChB,MAAM,wBAAwB,CAAC;AAChC,YAAY,EACV,YAAY,EACZ,SAAS,EACT,SAAS,EACT,WAAW,EACX,SAAS,EACT,cAAc,GACf,MAAM,wBAAwB,CAAC"}

package/dist/story/schema/index.js

@@ -1,4 +1,4 @@
 // RPC transports and renderers use this browser-safe Story report contract.
 export { CapturedTraceSchema, QuestionReportSchema, QuestionSectionSchema, RecordedFlowSchema, StoryAssertionSchema, StoryReportSchema, StoryVerdictSchema, } from './story-report-schema.js';
 export { slugifyQuestion } from './slug.js';
-export { QuestionLeafSchema, StoryLeafSchema, StorySourceSchema, StoryTreeGroupSchema, StoryTreeSchema, } from './story-tree-schema.js';
+export { QuestionLeafSchema, StoryLeafSchema, StoryPageSchema, StorySourceSchema, StoryTreeGroupSchema, StoryTreeSchema, } from './story-tree-schema.js';

package/dist/story/schema/story-tree-schema.d.ts

@@ -3,6 +3,10 @@ export declare const StorySourceSchema: Schema.Struct<{
     readonly path: Schema.String;
     readonly content: Schema.String;
 }>;
+export declare const StoryPageSchema: Schema.Struct<{
+    readonly path: Schema.String;
+    readonly content: Schema.String;
+}>;
 export declare const QuestionLeafSchema: Schema.Struct<{
     readonly slug: Schema.String;
     readonly question: Schema.String;
@@ -12,6 +16,12 @@ export declare const QuestionLeafSchema: Schema.Struct<{
 export declare const StoryLeafSchema: Schema.Struct<{
     readonly id: Schema.String;
     readonly title: Schema.String;
+    readonly description: Schema.String;
+    readonly spine: Schema.Boolean;
+    readonly page: Schema.NullOr<Schema.Struct<{
+        readonly path: Schema.String;
+        readonly content: Schema.String;
+    }>>;
     readonly setup: Schema.NullOr<Schema.String>;
     readonly questions: Schema.$Array<Schema.Struct<{
         readonly slug: Schema.String;
@@ -30,6 +40,8 @@ export declare const StoryLeafSchema: Schema.Struct<{
 }>;
 export interface StoryTreeGroup {
     readonly title: string;
+    readonly description: string;
+    readonly page: typeof StoryPageSchema.Type | null;
     readonly groups: readonly StoryTreeGroup[];
     readonly stories: readonly (typeof StoryLeafSchema.Type)[];
 }
@@ -38,5 +50,6 @@ export declare const StoryTreeSchema: Schema.Codec<StoryTreeGroup, StoryTreeGrou
 export type QuestionLeaf = typeof QuestionLeafSchema.Type;
 export type StoryLeaf = typeof StoryLeafSchema.Type;
 export type StorySource = typeof StorySourceSchema.Type;
+export type StoryPage = typeof StoryPageSchema.Type;
 export type StoryTree = StoryTreeGroup;
 //# sourceMappingURL=story-tree-schema.d.ts.map

package/dist/story/schema/story-tree-schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"story-tree-schema.d.ts","sourceRoot":"","sources":["../../../src/story/schema/story-tree-schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,eAAO,MAAM,iBAAiB;;;EAO5B,CAAC;AAEH,eAAO,MAAM,kBAAkB;;;;;EAS7B,CAAC;AAEH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;EAW1B,CAAC;AAEH,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,MAAM,EAAE,SAAS,cAAc,EAAE,CAAC;IAC3C,QAAQ,CAAC,OAAO,EAAE,SAAS,CAAC,OAAO,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC;CAC5D;AAED,eAAO,MAAM,oBAAoB,EAAE,MAAM,CAAC,KAAK,CAAC,cAAc,CAUjB,CAAC;AAE9C,eAAO,MAAM,eAAe,4DAI1B,CAAC;AAEH,MAAM,MAAM,YAAY,GAAG,OAAO,kBAAkB,CAAC,IAAI,CAAC;AAC1D,MAAM,MAAM,SAAS,GAAG,OAAO,eAAe,CAAC,IAAI,CAAC;AACpD,MAAM,MAAM,WAAW,GAAG,OAAO,iBAAiB,CAAC,IAAI,CAAC;AACxD,MAAM,MAAM,SAAS,GAAG,cAAc,CAAC"}
+{"version":3,"file":"story-tree-schema.d.ts","sourceRoot":"","sources":["../../../src/story/schema/story-tree-schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,eAAO,MAAM,iBAAiB;;;EAO5B,CAAC;AAEH,eAAO,MAAM,eAAe;;;EAO1B,CAAC;AAEH,eAAO,MAAM,kBAAkB;;;;;EAS7B,CAAC;AAEH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;EAc1B,CAAC;AAEH,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,IAAI,EAAE,OAAO,eAAe,CAAC,IAAI,GAAG,IAAI,CAAC;IAClD,QAAQ,CAAC,MAAM,EAAE,SAAS,cAAc,EAAE,CAAC;IAC3C,QAAQ,CAAC,OAAO,EAAE,SAAS,CAAC,OAAO,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC;CAC5D;AAED,eAAO,MAAM,oBAAoB,EAAE,MAAM,CAAC,KAAK,CAAC,cAAc,CAYjB,CAAC;AAE9C,eAAO,MAAM,eAAe,4DAI1B,CAAC;AAEH,MAAM,MAAM,YAAY,GAAG,OAAO,kBAAkB,CAAC,IAAI,CAAC;AAC1D,MAAM,MAAM,SAAS,GAAG,OAAO,eAAe,CAAC,IAAI,CAAC;AACpD,MAAM,MAAM,WAAW,GAAG,OAAO,iBAAiB,CAAC,IAAI,CAAC;AACxD,MAAM,MAAM,SAAS,GAAG,OAAO,eAAe,CAAC,IAAI,CAAC;AACpD,MAAM,MAAM,SAAS,GAAG,cAAc,CAAC"}

package/dist/story/schema/story-tree-schema.js

@@ -6,6 +6,13 @@ export const StorySourceSchema = Schema.Struct({
     title: 'Story Source',
     description: 'The full text of a project file backing a Story: the file the Story was authored in, or the support file its proofs import.',
 });
+export const StoryPageSchema = Schema.Struct({
+    path: Schema.String,
+    content: Schema.String,
+}).annotate({
+    title: 'Story Page',
+    description: "The markdown page narrating a Story or a Story Group: a Story's sibling `.md` file, or a Story Group's `index.md`. Null when the author wrote none.",
+});
 export const QuestionLeafSchema = Schema.Struct({
     slug: Schema.String,
     question: Schema.String,
@@ -18,21 +25,26 @@ export const QuestionLeafSchema = Schema.Struct({
 export const StoryLeafSchema = Schema.Struct({
     id: Schema.String,
     title: Schema.String,
+    description: Schema.String,
+    spine: Schema.Boolean,
+    page: Schema.NullOr(StoryPageSchema),
     setup: Schema.NullOr(Schema.String),
     questions: Schema.Array(QuestionLeafSchema),
     source: StorySourceSchema,
     support: Schema.NullOr(StorySourceSchema),
 }).annotate({
     title: 'Story Leaf',
-    description: 'One Story in the Story tree: its derived id, the shared setup snippet, its Questions in authored order, and the support file its proofs import. Never carries results.',
+    description: 'One Story in the Story tree: its derived id, its one-line description, whether it sits on the spine, its markdown page, the shared setup snippet, its Questions in authored order, and the support file its proofs import. Never carries results.',
 });
 export const StoryTreeGroupSchema = Schema.Struct({
     title: Schema.String,
+    description: Schema.String,
+    page: Schema.NullOr(StoryPageSchema),
     groups: Schema.Array(Schema.suspend(() => StoryTreeGroupSchema)),
     stories: Schema.Array(StoryLeafSchema),
 }).annotate({
     title: 'Story Group',
-    description: 'One node of the Story tree: a title over any mix of subgroups and Story leaves.',
+    description: 'One node of the Story tree: a title, a one-line description, its markdown page, over any mix of subgroups and Story leaves.',
 });
 export const StoryTreeSchema = StoryTreeGroupSchema.annotate({
     title: 'Story Tree',

package/dist/story/story.d.ts

@@ -13,21 +13,28 @@ export interface StoryQuestion {
 }
 export interface Story {
     readonly title: string;
+    readonly description: string;
+    readonly spine: boolean;
     readonly sourceUrl: string;
     readonly questions: readonly StoryQuestion[];
 }
 export interface StoryGroup {
     readonly title: string;
+    readonly description: string;
     readonly children: readonly StoryNode[];
 }
 export type StoryNode = Story | StoryGroup;
 export declare const Story: {
-    make(story: Story): Story;
+    make(story: Omit<Story, 'spine'> & {
+        readonly spine?: boolean;
+    }): Story;
     question(question: string, options: {
         readonly answer: string;
         readonly proof: Effect.Effect<unknown, unknown, StoryContext>;
     }): StoryQuestion;
-    group(title: string, children: readonly StoryNode[]): StoryGroup;
+    group(title: string, options: {
+        readonly description: string;
+    }, children: readonly StoryNode[]): StoryGroup;
     trace<A, E, R>(effect: Effect.Effect<A, E, R>): Effect.Effect<A, E, R | StoryContext>;
     flow<A, E, R>(effect: Effect.Effect<A, E, R>): Effect.Effect<A, E, R | StoryContext>;
     assert(description: string, passed: boolean): Effect.Effect<void, never, StoryContext>;

package/dist/story/story.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"story.d.ts","sourceRoot":"","sources":["../../src/story/story.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAGzC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;;2BAK9B,CAAC,OAAO,EAAE,eAAe,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC;qBACvD,CACf,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,OAAO,KACZ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC;;AAP5B,qBAAa,YAAa,SAAQ,iBASf;CAAG;AAEtB,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,YAAY,CAAC,CAAC;CAC/D;AAED,MAAM,WAAW,KAAK;IACpB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,SAAS,EAAE,SAAS,aAAa,EAAE,CAAC;CAC9C;AAED,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,QAAQ,EAAE,SAAS,SAAS,EAAE,CAAC;CACzC;AAED,MAAM,MAAM,SAAS,GAAG,KAAK,GAAG,UAAU,CAAC;AAE3C,eAAO,MAAM,KAAK;IAChB,IAAI,QAAQ,KAAK,GAAG,KAAK;IAIzB,QAAQ,WACI,MAAM,WACP;QACP,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;QACxB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,YAAY,CAAC,CAAC;KAC/D,GACA,aAAa;IAIhB,KAAK,QAAQ,MAAM,YAAY,SAAS,SAAS,EAAE,GAAG,UAAU;IAIhE,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,UACH,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAC7B,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,YAAY,CAAC;IAcxC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,UACF,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAC7B,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,YAAY,CAAC;IAgBxC,MAAM,cACS,MAAM,UACX,OAAO,GACd,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,YAAY,CAAC;CAK5C,CAAC;AAEF,wBAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,KAAK,CActD;AAED,wBAAgB,YAAY,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,UAAU,CAOhE"}
+{"version":3,"file":"story.d.ts","sourceRoot":"","sources":["../../src/story/story.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAGzC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;;2BAK9B,CAAC,OAAO,EAAE,eAAe,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC;qBACvD,CACf,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,OAAO,KACZ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC;;AAP5B,qBAAa,YAAa,SAAQ,iBASf;CAAG;AAEtB,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,YAAY,CAAC,CAAC;CAC/D;AAED,MAAM,WAAW,KAAK;IACpB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;IACxB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,SAAS,EAAE,SAAS,aAAa,EAAE,CAAC;CAC9C;AAED,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,QAAQ,EAAE,SAAS,SAAS,EAAE,CAAC;CACzC;AAED,MAAM,MAAM,SAAS,GAAG,KAAK,GAAG,UAAU,CAAC;AAE3C,eAAO,MAAM,KAAK;IAChB,IAAI,QAAQ,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,GAAG;QAAE,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,KAAK;IAIvE,QAAQ,WACI,MAAM,WACP;QACP,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;QACxB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,YAAY,CAAC,CAAC;KAC/D,GACA,aAAa;IAIhB,KAAK,QACI,MAAM,WACJ;QAAE,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;KAAE,YAC/B,SAAS,SAAS,EAAE,GAC7B,UAAU;IAIb,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,UACH,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAC7B,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,YAAY,CAAC;IAcxC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,UACF,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAC7B,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,YAAY,CAAC;IAgBxC,MAAM,cACS,MAAM,UACX,OAAO,GACd,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,YAAY,CAAC;CAK5C,CAAC;AAEF,wBAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,KAAK,CAgBtD;AAED,wBAAgB,YAAY,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,UAAU,CAWhE"}

package/dist/story/story.js

@@ -4,13 +4,13 @@ export class StoryContext extends Context.Service()('StoryContext') {
 }
 export const Story = {
     make(story) {
-        return story;
+        return { ...story, spine: story.spine ?? false };
     },
     question(question, options) {
         return { question, answer: options.answer, proof: options.proof };
     },
-    group(title, children) {
-        return { title, children };
+    group(title, options, children) {
+        return { title, description: options.description, children };
     },
     trace(effect) {
         return Effect.gen(function* () {
@@ -39,6 +39,8 @@ export function isStory(value) {
         return false;
     const story = value;
     return (typeof story.title === 'string' &&
+        typeof story.description === 'string' &&
+        typeof story.spine === 'boolean' &&
         typeof story.sourceUrl === 'string' &&
         Array.isArray(story.questions) &&
         story.questions.every((question) => typeof question.question === 'string' &&
@@ -49,7 +51,9 @@ export function isStoryGroup(value) {
     if (typeof value !== 'object' || value === null)
         return false;
     const group = value;
-    if (typeof group.title !== 'string' || !Array.isArray(group.children)) {
+    if (typeof group.title !== 'string' ||
+        typeof group.description !== 'string' ||
+        !Array.isArray(group.children)) {
         return false;
     }
     return group.children.every((child) => isStory(child) || isStoryGroup(child));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "laymos",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "private": false,
   "description": "Enforces architectural dependency rules and explores source dependencies.",
   "repository": {
@@ -53,7 +53,7 @@
     "oxc-resolver": "11.24.2",
     "tsx": "4.23.12",
     "yoctocolors": "2.2.0",
-    "@pkishorez/effect-tracer": "0.0.6"
+    "@pkishorez/effect-tracer": "0.0.7"
   },
   "devDependencies": {
     "@types/node": "26.2.0",