@clearproof/content 0.5.0

package/dist/index.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getExplainer = exports.listExplainers = exports.getUpdate = exports.listUpdates = exports.getSignal = exports.listSignals = exports.getRecipeSteps = exports.getRecipe = exports.listRecipes = exports.getTopic = exports.listTopics = exports.CONTENT_DIR = exports.listContentSlugs = exports.readContentFile = exports.parseFrontmatter = void 0;
+var parser_js_1 = require("./parser.js");
+Object.defineProperty(exports, "parseFrontmatter", { enumerable: true, get: function () { return parser_js_1.parseFrontmatter; } });
+Object.defineProperty(exports, "readContentFile", { enumerable: true, get: function () { return parser_js_1.readContentFile; } });
+Object.defineProperty(exports, "listContentSlugs", { enumerable: true, get: function () { return parser_js_1.listContentSlugs; } });
+Object.defineProperty(exports, "CONTENT_DIR", { enumerable: true, get: function () { return parser_js_1.CONTENT_DIR; } });
+var topics_js_1 = require("./topics.js");
+Object.defineProperty(exports, "listTopics", { enumerable: true, get: function () { return topics_js_1.listTopics; } });
+Object.defineProperty(exports, "getTopic", { enumerable: true, get: function () { return topics_js_1.getTopic; } });
+var recipes_js_1 = require("./recipes.js");
+Object.defineProperty(exports, "listRecipes", { enumerable: true, get: function () { return recipes_js_1.listRecipes; } });
+Object.defineProperty(exports, "getRecipe", { enumerable: true, get: function () { return recipes_js_1.getRecipe; } });
+Object.defineProperty(exports, "getRecipeSteps", { enumerable: true, get: function () { return recipes_js_1.getRecipeSteps; } });
+var signals_js_1 = require("./signals.js");
+Object.defineProperty(exports, "listSignals", { enumerable: true, get: function () { return signals_js_1.listSignals; } });
+Object.defineProperty(exports, "getSignal", { enumerable: true, get: function () { return signals_js_1.getSignal; } });
+var updates_js_1 = require("./updates.js");
+Object.defineProperty(exports, "listUpdates", { enumerable: true, get: function () { return updates_js_1.listUpdates; } });
+Object.defineProperty(exports, "getUpdate", { enumerable: true, get: function () { return updates_js_1.getUpdate; } });
+var explainers_js_1 = require("./explainers.js");
+Object.defineProperty(exports, "listExplainers", { enumerable: true, get: function () { return explainers_js_1.listExplainers; } });
+Object.defineProperty(exports, "getExplainer", { enumerable: true, get: function () { return explainers_js_1.getExplainer; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,yCAA+F;AAAtF,6GAAA,gBAAgB,OAAA;AAAE,4GAAA,eAAe,OAAA;AAAE,6GAAA,gBAAgB,OAAA;AAAE,wGAAA,WAAW,OAAA;AAGzE,yCAAmD;AAA1C,uGAAA,UAAU,OAAA;AAAE,qGAAA,QAAQ,OAAA;AAG7B,2CAAsE;AAA7D,yGAAA,WAAW,OAAA;AAAE,uGAAA,SAAS,OAAA;AAAE,4GAAA,cAAc,OAAA;AAG/C,2CAAsD;AAA7C,yGAAA,WAAW,OAAA;AAAE,uGAAA,SAAS,OAAA;AAG/B,2CAAsD;AAA7C,yGAAA,WAAW,OAAA;AAAE,uGAAA,SAAS,OAAA;AAG/B,iDAA+D;AAAtD,+GAAA,cAAc,OAAA;AAAE,6GAAA,YAAY,OAAA"}

package/dist/parser.d.ts

@@ -0,0 +1,25 @@
+/** Base directory for all content files, resolved relative to this file's compiled location. */
+declare const CONTENT_DIR: string;
+export interface Frontmatter {
+    [key: string]: unknown;
+}
+export interface ParsedFile {
+    frontmatter: Frontmatter;
+    body: string;
+}
+/**
+ * Parse a markdown file with YAML frontmatter delimited by `---`.
+ * Uses a simple regex split -- no external frontmatter library needed.
+ */
+export declare function parseFrontmatter(raw: string): ParsedFile;
+/**
+ * Read and parse a markdown file from the content directory.
+ */
+export declare function readContentFile(relativePath: string): ParsedFile;
+/**
+ * List all .md files in a subdirectory of the content directory.
+ * Returns filenames without extension (slugs).
+ */
+export declare function listContentSlugs(subdir: string): string[];
+export { CONTENT_DIR };
+//# sourceMappingURL=parser.d.ts.map

package/dist/parser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parser.d.ts","sourceRoot":"","sources":["../src/parser.ts"],"names":[],"mappings":"AAIA,gGAAgG;AAChG,QAAA,MAAM,WAAW,QAAsC,CAAC;AAExD,MAAM,WAAW,WAAW;IAC1B,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,UAAU;IACzB,WAAW,EAAE,WAAW,CAAC;IACzB,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CA8DxD;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,UAAU,CAIhE;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAUzD;AAED,OAAO,EAAE,WAAW,EAAE,CAAC"}

package/dist/parser.js

@@ -0,0 +1,97 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CONTENT_DIR = void 0;
+exports.parseFrontmatter = parseFrontmatter;
+exports.readContentFile = readContentFile;
+exports.listContentSlugs = listContentSlugs;
+const node_fs_1 = require("node:fs");
+const node_path_1 = require("node:path");
+const node_fs_2 = require("node:fs");
+/** Base directory for all content files, resolved relative to this file's compiled location. */
+const CONTENT_DIR = (0, node_path_1.resolve)(__dirname, '..', 'content');
+exports.CONTENT_DIR = CONTENT_DIR;
+/**
+ * Parse a markdown file with YAML frontmatter delimited by `---`.
+ * Uses a simple regex split -- no external frontmatter library needed.
+ */
+function parseFrontmatter(raw) {
+    const match = raw.match(/^---\r?\n([\s\S]*?)\r?\n---\r?\n?([\s\S]*)$/);
+    if (!match) {
+        return { frontmatter: {}, body: raw };
+    }
+    const yamlBlock = match[1];
+    const body = match[2].trim();
+    // Simple YAML key-value parser (handles strings, numbers, arrays)
+    const frontmatter = {};
+    let currentKey = null;
+    let currentArray = null;
+    for (const line of yamlBlock.split('\n')) {
+        const trimmed = line.trim();
+        // Array item continuation
+        if (trimmed.startsWith('- ') && currentKey && currentArray !== null) {
+            currentArray.push(trimmed.slice(2).trim());
+            continue;
+        }
+        // Flush any pending array
+        if (currentKey && currentArray !== null) {
+            frontmatter[currentKey] = currentArray;
+            currentArray = null;
+            currentKey = null;
+        }
+        // Key-value pair
+        const kvMatch = trimmed.match(/^([a-zA-Z0-9_-]+):\s*(.*)$/);
+        if (!kvMatch)
+            continue;
+        const key = kvMatch[1];
+        const value = kvMatch[2].trim();
+        if (value === '') {
+            // Start of an array or empty value -- look ahead
+            currentKey = key;
+            currentArray = [];
+            continue;
+        }
+        // Parse value types
+        if (value === 'true') {
+            frontmatter[key] = true;
+        }
+        else if (value === 'false') {
+            frontmatter[key] = false;
+        }
+        else if (/^\d+$/.test(value)) {
+            frontmatter[key] = parseInt(value, 10);
+        }
+        else {
+            frontmatter[key] = value;
+        }
+    }
+    // Flush trailing array
+    if (currentKey && currentArray !== null) {
+        frontmatter[currentKey] = currentArray;
+    }
+    return { frontmatter, body };
+}
+/**
+ * Read and parse a markdown file from the content directory.
+ */
+function readContentFile(relativePath) {
+    const fullPath = (0, node_path_1.join)(CONTENT_DIR, relativePath);
+    const raw = (0, node_fs_1.readFileSync)(fullPath, 'utf-8');
+    return parseFrontmatter(raw);
+}
+/**
+ * List all .md files in a subdirectory of the content directory.
+ * Returns filenames without extension (slugs).
+ */
+function listContentSlugs(subdir) {
+    const dir = (0, node_path_1.join)(CONTENT_DIR, subdir);
+    try {
+        return (0, node_fs_2.readdirSync)(dir)
+            .filter((f) => f.endsWith('.md'))
+            .map((f) => f.replace(/\.md$/, ''))
+            .sort();
+    }
+    catch {
+        return [];
+    }
+}
+//# sourceMappingURL=parser.js.map

package/dist/parser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parser.js","sourceRoot":"","sources":["../src/parser.ts"],"names":[],"mappings":";;;AAoBA,4CA8DC;AAKD,0CAIC;AAMD,4CAUC;AA3GD,qCAAuC;AACvC,yCAA0C;AAC1C,qCAAsC;AAEtC,gGAAgG;AAChG,MAAM,WAAW,GAAG,IAAA,mBAAO,EAAC,SAAS,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;AAwG/C,kCAAW;AA7FpB;;;GAGG;AACH,SAAgB,gBAAgB,CAAC,GAAW;IAC1C,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,6CAA6C,CAAC,CAAC;IACvE,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,EAAE,WAAW,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC;IACxC,CAAC;IAED,MAAM,SAAS,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IAC3B,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAE7B,kEAAkE;IAClE,MAAM,WAAW,GAAgB,EAAE,CAAC;IACpC,IAAI,UAAU,GAAkB,IAAI,CAAC;IACrC,IAAI,YAAY,GAAoB,IAAI,CAAC;IAEzC,KAAK,MAAM,IAAI,IAAI,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QACzC,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;QAE5B,0BAA0B;QAC1B,IAAI,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,UAAU,IAAI,YAAY,KAAK,IAAI,EAAE,CAAC;YACpE,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;YAC3C,SAAS;QACX,CAAC;QAED,0BAA0B;QAC1B,IAAI,UAAU,IAAI,YAAY,KAAK,IAAI,EAAE,CAAC;YACxC,WAAW,CAAC,UAAU,CAAC,GAAG,YAAY,CAAC;YACvC,YAAY,GAAG,IAAI,CAAC;YACpB,UAAU,GAAG,IAAI,CAAC;QACpB,CAAC;QAED,iBAAiB;QACjB,MAAM,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAC5D,IAAI,CAAC,OAAO;YAAE,SAAS;QAEvB,MAAM,GAAG,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;QACvB,MAAM,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAEhC,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;YACjB,iDAAiD;YACjD,UAAU,GAAG,GAAG,CAAC;YACjB,YAAY,GAAG,EAAE,CAAC;YAClB,SAAS;QACX,CAAC;QAED,oBAAoB;QACpB,IAAI,KAAK,KAAK,MAAM,EAAE,CAAC;YACrB,WAAW,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;QAC1B,CAAC;aAAM,IAAI,KAAK,KAAK,OAAO,EAAE,CAAC;YAC7B,WAAW,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QAC3B,CAAC;aAAM,IAAI,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAC/B,WAAW,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACzC,CAAC;aAAM,CAAC;YACN,WAAW,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QAC3B,CAAC;IACH,CAAC;IAED,uBAAuB;IACvB,IAAI,UAAU,IAAI,YAAY,KAAK,IAAI,EAAE,CAAC;QACxC,WAAW,CAAC,UAAU,CAAC,GAAG,YAAY,CAAC;IACzC,CAAC;IAED,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC;AAC/B,CAAC;AAED;;GAEG;AACH,SAAgB,eAAe,CAAC,YAAoB;IAClD,MAAM,QAAQ,GAAG,IAAA,gBAAI,EAAC,WAAW,EAAE,YAAY,CAAC,CAAC;IACjD,MAAM,GAAG,GAAG,IAAA,sBAAY,EAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC5C,OAAO,gBAAgB,CAAC,GAAG,CAAC,CAAC;AAC/B,CAAC;AAED;;;GAGG;AACH,SAAgB,gBAAgB,CAAC,MAAc;IAC7C,MAAM,GAAG,GAAG,IAAA,gBAAI,EAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IACtC,IAAI,CAAC;QACH,OAAO,IAAA,qBAAW,EAAC,GAAG,CAAC;aACpB,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;aAChC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;aAClC,IAAI,EAAE,CAAC;IACZ,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,CAAC;IACZ,CAAC;AACH,CAAC"}

package/dist/recipes.d.ts

@@ -0,0 +1,28 @@
+export interface RecipeMeta {
+    slug: string;
+    title: string;
+    prereqs: string[];
+    estimatedTime: string;
+}
+export interface Recipe extends RecipeMeta {
+    body: string;
+    steps: RecipeStep[];
+}
+export interface RecipeStep {
+    description: string;
+    command: string;
+    expected: string;
+}
+/**
+ * List all available recipes with metadata (no body or steps).
+ */
+export declare function listRecipes(): RecipeMeta[];
+/**
+ * Get a single recipe by slug, including body and parsed steps.
+ */
+export declare function getRecipe(slug: string): Recipe | null;
+/**
+ * Get just the executable steps for a recipe.
+ */
+export declare function getRecipeSteps(slug: string): RecipeStep[];
+//# sourceMappingURL=recipes.d.ts.map

package/dist/recipes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"recipes.d.ts","sourceRoot":"","sources":["../src/recipes.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,MAAO,SAAQ,UAAU;IACxC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,UAAU,EAAE,CAAC;CACrB;AAED,MAAM,WAAW,UAAU;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;CAClB;AA8DD;;GAEG;AACH,wBAAgB,WAAW,IAAI,UAAU,EAAE,CAe1C;AAED;;GAEG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAcrD;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,EAAE,CAGzD"}

package/dist/recipes.js

@@ -0,0 +1,103 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.listRecipes = listRecipes;
+exports.getRecipe = getRecipe;
+exports.getRecipeSteps = getRecipeSteps;
+const parser_js_1 = require("./parser.js");
+/**
+ * Parse ```bash:run fenced code blocks and the "Expected:" line that follows each one.
+ * Returns structured steps with description, command, and expected output.
+ */
+function parseSteps(body) {
+    const steps = [];
+    const lines = body.split('\n');
+    let i = 0;
+    while (i < lines.length) {
+        // Look for ```bash:run
+        if (lines[i].trim() === '```bash:run') {
+            // Walk backwards to find the description (last non-empty line before the fence)
+            let description = '';
+            for (let j = i - 1; j >= 0; j--) {
+                const trimmed = lines[j].trim();
+                if (trimmed !== '') {
+                    // Strip markdown heading prefix
+                    description = trimmed.replace(/^#+\s*/, '');
+                    break;
+                }
+            }
+            // Collect the command (everything between the fences)
+            i++;
+            const commandLines = [];
+            while (i < lines.length && lines[i].trim() !== '```') {
+                commandLines.push(lines[i]);
+                i++;
+            }
+            // Skip closing fence
+            if (i < lines.length)
+                i++;
+            const command = commandLines.join('\n').trim();
+            // Look for "Expected:" line after the code block
+            let expected = '';
+            while (i < lines.length) {
+                const trimmed = lines[i].trim();
+                if (trimmed === '') {
+                    i++;
+                    continue;
+                }
+                if (trimmed.toLowerCase().startsWith('expected:')) {
+                    expected = trimmed.replace(/^expected:\s*/i, '').trim();
+                    i++;
+                }
+                break;
+            }
+            steps.push({ description, command, expected });
+            continue;
+        }
+        i++;
+    }
+    return steps;
+}
+/**
+ * List all available recipes with metadata (no body or steps).
+ */
+function listRecipes() {
+    const slugs = (0, parser_js_1.listContentSlugs)('recipes');
+    const recipes = [];
+    for (const slug of slugs) {
+        const { frontmatter } = (0, parser_js_1.readContentFile)(`recipes/${slug}.md`);
+        recipes.push({
+            slug,
+            title: frontmatter['title'] ?? slug,
+            prereqs: frontmatter['prereqs'] ?? [],
+            estimatedTime: frontmatter['estimated-time'] ?? 'unknown',
+        });
+    }
+    return recipes;
+}
+/**
+ * Get a single recipe by slug, including body and parsed steps.
+ */
+function getRecipe(slug) {
+    try {
+        const { frontmatter, body } = (0, parser_js_1.readContentFile)(`recipes/${slug}.md`);
+        return {
+            slug,
+            title: frontmatter['title'] ?? slug,
+            prereqs: frontmatter['prereqs'] ?? [],
+            estimatedTime: frontmatter['estimated-time'] ?? 'unknown',
+            body,
+            steps: parseSteps(body),
+        };
+    }
+    catch {
+        return null;
+    }
+}
+/**
+ * Get just the executable steps for a recipe.
+ */
+function getRecipeSteps(slug) {
+    const recipe = getRecipe(slug);
+    return recipe?.steps ?? [];
+}
+//# sourceMappingURL=recipes.js.map

package/dist/recipes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"recipes.js","sourceRoot":"","sources":["../src/recipes.ts"],"names":[],"mappings":";;AAmFA,kCAeC;AAKD,8BAcC;AAKD,wCAGC;AA7HD,2CAAgE;AAoBhE;;;GAGG;AACH,SAAS,UAAU,CAAC,IAAY;IAC9B,MAAM,KAAK,GAAiB,EAAE,CAAC;IAC/B,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAE/B,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,OAAO,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;QACxB,uBAAuB;QACvB,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,aAAa,EAAE,CAAC;YACtC,gFAAgF;YAChF,IAAI,WAAW,GAAG,EAAE,CAAC;YACrB,KAAK,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;gBAChC,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;gBAChC,IAAI,OAAO,KAAK,EAAE,EAAE,CAAC;oBACnB,gCAAgC;oBAChC,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;oBAC5C,MAAM;gBACR,CAAC;YACH,CAAC;YAED,sDAAsD;YACtD,CAAC,EAAE,CAAC;YACJ,MAAM,YAAY,GAAa,EAAE,CAAC;YAClC,OAAO,CAAC,GAAG,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,KAAK,EAAE,CAAC;gBACrD,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC5B,CAAC,EAAE,CAAC;YACN,CAAC;YACD,qBAAqB;YACrB,IAAI,CAAC,GAAG,KAAK,CAAC,MAAM;gBAAE,CAAC,EAAE,CAAC;YAE1B,MAAM,OAAO,GAAG,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC;YAE/C,iDAAiD;YACjD,IAAI,QAAQ,GAAG,EAAE,CAAC;YAClB,OAAO,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;gBACxB,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;gBAChC,IAAI,OAAO,KAAK,EAAE,EAAE,CAAC;oBACnB,CAAC,EAAE,CAAC;oBACJ,SAAS;gBACX,CAAC;gBACD,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;oBAClD,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;oBACxD,CAAC,EAAE,CAAC;gBACN,CAAC;gBACD,MAAM;YACR,CAAC;YAED,KAAK,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC;YAC/C,SAAS;QACX,CAAC;QAED,CAAC,EAAE,CAAC;IACN,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;GAEG;AACH,SAAgB,WAAW;IACzB,MAAM,KAAK,GAAG,IAAA,4BAAgB,EAAC,SAAS,CAAC,CAAC;IAC1C,MAAM,OAAO,GAAiB,EAAE,CAAC;IAEjC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,EAAE,WAAW,EAAE,GAAG,IAAA,2BAAe,EAAC,WAAW,IAAI,KAAK,CAAC,CAAC;QAC9D,OAAO,CAAC,IAAI,CAAC;YACX,IAAI;YACJ,KAAK,EAAG,WAAW,CAAC,OAAO,CAAY,IAAI,IAAI;YAC/C,OAAO,EAAG,WAAW,CAAC,SAAS,CAAc,IAAI,EAAE;YACnD,aAAa,EAAG,WAAW,CAAC,gBAAgB,CAAY,IAAI,SAAS;SACtE,CAAC,CAAC;IACL,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;GAEG;AACH,SAAgB,SAAS,CAAC,IAAY;IACpC,IAAI,CAAC;QACH,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,GAAG,IAAA,2BAAe,EAAC,WAAW,IAAI,KAAK,CAAC,CAAC;QACpE,OAAO;YACL,IAAI;YACJ,KAAK,EAAG,WAAW,CAAC,OAAO,CAAY,IAAI,IAAI;YAC/C,OAAO,EAAG,WAAW,CAAC,SAAS,CAAc,IAAI,EAAE;YACnD,aAAa,EAAG,WAAW,CAAC,gBAAgB,CAAY,IAAI,SAAS;YACrE,IAAI;YACJ,KAAK,EAAE,UAAU,CAAC,IAAI,CAAC;SACxB,CAAC;IACJ,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED;;GAEG;AACH,SAAgB,cAAc,CAAC,IAAY;IACzC,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;IAC/B,OAAO,MAAM,EAAE,KAAK,IAAI,EAAE,CAAC;AAC7B,CAAC"}

package/dist/signals.d.ts

@@ -0,0 +1,18 @@
+export interface Signal {
+    index: number;
+    name: string;
+    type: string;
+    description: string;
+    source: string;
+    onChainUsage: string;
+    isOutput: boolean;
+}
+/**
+ * List all 16 public circuit signals.
+ */
+export declare function listSignals(): Signal[];
+/**
+ * Get a single signal by name.
+ */
+export declare function getSignal(name: string): Signal | null;
+//# sourceMappingURL=signals.d.ts.map

package/dist/signals.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"signals.d.ts","sourceRoot":"","sources":["../src/signals.ts"],"names":[],"mappings":"AAKA,MAAM,WAAW,MAAM;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;CACnB;AAgBD;;GAEG;AACH,wBAAgB,WAAW,IAAI,MAAM,EAAE,CAEtC;AAED;;GAEG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAGrD"}

package/dist/signals.js

@@ -0,0 +1,34 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.listSignals = listSignals;
+exports.getSignal = getSignal;
+const node_fs_1 = require("node:fs");
+const node_path_1 = require("node:path");
+const js_yaml_1 = __importDefault(require("js-yaml"));
+const parser_js_1 = require("./parser.js");
+/**
+ * Read and parse the signals.yaml file.
+ */
+function loadSignals() {
+    const filePath = (0, node_path_1.resolve)(parser_js_1.CONTENT_DIR, 'signals.yaml');
+    const raw = (0, node_fs_1.readFileSync)(filePath, 'utf-8');
+    const data = js_yaml_1.default.load(raw);
+    return data.signals ?? [];
+}
+/**
+ * List all 16 public circuit signals.
+ */
+function listSignals() {
+    return loadSignals();
+}
+/**
+ * Get a single signal by name.
+ */
+function getSignal(name) {
+    const signals = loadSignals();
+    return signals.find((s) => s.name === name) ?? null;
+}
+//# sourceMappingURL=signals.js.map

package/dist/signals.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"signals.js","sourceRoot":"","sources":["../src/signals.ts"],"names":[],"mappings":";;;;;AAgCA,kCAEC;AAKD,8BAGC;AA1CD,qCAAuC;AACvC,yCAAoC;AACpC,sDAA2B;AAC3B,2CAA0C;AAgB1C;;GAEG;AACH,SAAS,WAAW;IAClB,MAAM,QAAQ,GAAG,IAAA,mBAAO,EAAC,uBAAW,EAAE,cAAc,CAAC,CAAC;IACtD,MAAM,GAAG,GAAG,IAAA,sBAAY,EAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC5C,MAAM,IAAI,GAAG,iBAAI,CAAC,IAAI,CAAC,GAAG,CAAgB,CAAC;IAC3C,OAAO,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;AAC5B,CAAC;AAED;;GAEG;AACH,SAAgB,WAAW;IACzB,OAAO,WAAW,EAAE,CAAC;AACvB,CAAC;AAED;;GAEG;AACH,SAAgB,SAAS,CAAC,IAAY;IACpC,MAAM,OAAO,GAAG,WAAW,EAAE,CAAC;IAC9B,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,IAAI,CAAC;AACtD,CAAC"}

package/dist/topics.d.ts

@@ -0,0 +1,18 @@
+export interface TopicMeta {
+    slug: string;
+    title: string;
+    category: string;
+    order: number;
+}
+export interface Topic extends TopicMeta {
+    body: string;
+}
+/**
+ * List all available topics with metadata (no body).
+ */
+export declare function listTopics(): TopicMeta[];
+/**
+ * Get a single topic by slug, including the markdown body.
+ */
+export declare function getTopic(slug: string): Topic | null;
+//# sourceMappingURL=topics.d.ts.map

package/dist/topics.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"topics.d.ts","sourceRoot":"","sources":["../src/topics.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,KAAM,SAAQ,SAAS;IACtC,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,wBAAgB,UAAU,IAAI,SAAS,EAAE,CAexC;AAED;;GAEG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK,GAAG,IAAI,CAanD"}

package/dist/topics.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.listTopics = listTopics;
+exports.getTopic = getTopic;
+const parser_js_1 = require("./parser.js");
+/**
+ * List all available topics with metadata (no body).
+ */
+function listTopics() {
+    const slugs = (0, parser_js_1.listContentSlugs)('topics');
+    const topics = [];
+    for (const slug of slugs) {
+        const { frontmatter } = (0, parser_js_1.readContentFile)(`topics/${slug}.md`);
+        topics.push({
+            slug,
+            title: frontmatter['title'] ?? slug,
+            category: frontmatter['category'] ?? 'general',
+            order: frontmatter['order'] ?? 999,
+        });
+    }
+    return topics.sort((a, b) => a.order - b.order);
+}
+/**
+ * Get a single topic by slug, including the markdown body.
+ */
+function getTopic(slug) {
+    try {
+        const { frontmatter, body } = (0, parser_js_1.readContentFile)(`topics/${slug}.md`);
+        return {
+            slug,
+            title: frontmatter['title'] ?? slug,
+            category: frontmatter['category'] ?? 'general',
+            order: frontmatter['order'] ?? 999,
+            body,
+        };
+    }
+    catch {
+        return null;
+    }
+}
+//# sourceMappingURL=topics.js.map

package/dist/topics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"topics.js","sourceRoot":"","sources":["../src/topics.ts"],"names":[],"mappings":";;AAgBA,gCAeC;AAKD,4BAaC;AAjDD,2CAAgE;AAahE;;GAEG;AACH,SAAgB,UAAU;IACxB,MAAM,KAAK,GAAG,IAAA,4BAAgB,EAAC,QAAQ,CAAC,CAAC;IACzC,MAAM,MAAM,GAAgB,EAAE,CAAC;IAE/B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,EAAE,WAAW,EAAE,GAAG,IAAA,2BAAe,EAAC,UAAU,IAAI,KAAK,CAAC,CAAC;QAC7D,MAAM,CAAC,IAAI,CAAC;YACV,IAAI;YACJ,KAAK,EAAG,WAAW,CAAC,OAAO,CAAY,IAAI,IAAI;YAC/C,QAAQ,EAAG,WAAW,CAAC,UAAU,CAAY,IAAI,SAAS;YAC1D,KAAK,EAAG,WAAW,CAAC,OAAO,CAAY,IAAI,GAAG;SAC/C,CAAC,CAAC;IACL,CAAC;IAED,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC;AAClD,CAAC;AAED;;GAEG;AACH,SAAgB,QAAQ,CAAC,IAAY;IACnC,IAAI,CAAC;QACH,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,GAAG,IAAA,2BAAe,EAAC,UAAU,IAAI,KAAK,CAAC,CAAC;QACnE,OAAO;YACL,IAAI;YACJ,KAAK,EAAG,WAAW,CAAC,OAAO,CAAY,IAAI,IAAI;YAC/C,QAAQ,EAAG,WAAW,CAAC,UAAU,CAAY,IAAI,SAAS;YAC1D,KAAK,EAAG,WAAW,CAAC,OAAO,CAAY,IAAI,GAAG;YAC9C,IAAI;SACL,CAAC;IACJ,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC"}

package/dist/updates.d.ts

@@ -0,0 +1,27 @@
+import { CONTENT_DIR } from './parser.js';
+export interface UpdateMeta {
+    id: string;
+    slug: string;
+    title: string;
+    date: string;
+    /** UTC timestamp after which the update may be published. */
+    publishAfter: string;
+    /** Source revision the claims were validated against. */
+    sourceCommit: string;
+    claimRefs: string[];
+    status: 'draft' | 'validated' | 'approved' | 'published';
+    summary: string;
+}
+export interface Update extends UpdateMeta {
+    body: string;
+}
+/**
+ * List all updates with metadata (no body), sorted newest first by ISO date.
+ */
+export declare function listUpdates(): UpdateMeta[];
+/**
+ * Get a single update by slug, including the markdown body.
+ */
+export declare function getUpdate(slug: string): Update | null;
+export { CONTENT_DIR };
+//# sourceMappingURL=updates.d.ts.map

package/dist/updates.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"updates.d.ts","sourceRoot":"","sources":["../src/updates.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqC,WAAW,EAAE,MAAM,aAAa,CAAC;AAE7E,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,6DAA6D;IAC7D,YAAY,EAAE,MAAM,CAAC;IACrB,yDAAyD;IACzD,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,MAAM,EAAE,OAAO,GAAG,WAAW,GAAG,UAAU,GAAG,WAAW,CAAC;IACzD,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,MAAO,SAAQ,UAAU;IACxC,IAAI,EAAE,MAAM,CAAC;CACd;AAuCD;;GAEG;AACH,wBAAgB,WAAW,IAAI,UAAU,EAAE,CAS1C;AAED;;GAEG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAQrD;AAED,OAAO,EAAE,WAAW,EAAE,CAAC"}

package/dist/updates.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CONTENT_DIR = void 0;
+exports.listUpdates = listUpdates;
+exports.getUpdate = getUpdate;
+const parser_js_1 = require("./parser.js");
+Object.defineProperty(exports, "CONTENT_DIR", { enumerable: true, get: function () { return parser_js_1.CONTENT_DIR; } });
+const UPDATE_FIELDS = [
+    'id',
+    'title',
+    'date',
+    'publishAfter',
+    'sourceCommit',
+    'status',
+    'summary',
+];
+function requiredStringFields(frontmatter) {
+    return UPDATE_FIELDS.filter((field) => typeof frontmatter[field] !== 'string' || frontmatter[field] === '');
+}
+function normalizeStatus(value) {
+    return ['draft', 'validated', 'approved', 'published'].includes(value)
+        ? value
+        : 'draft';
+}
+function toMeta(slug, frontmatter) {
+    const missing = requiredStringFields(frontmatter);
+    if (missing.length > 0)
+        return null;
+    const claimRefs = frontmatter['claimRefs'];
+    return {
+        id: frontmatter['id'],
+        slug,
+        title: frontmatter['title'],
+        date: frontmatter['date'],
+        publishAfter: frontmatter['publishAfter'],
+        sourceCommit: frontmatter['sourceCommit'],
+        claimRefs: Array.isArray(claimRefs) ? claimRefs.filter((ref) => typeof ref === 'string') : [],
+        status: normalizeStatus(frontmatter['status']),
+        summary: frontmatter['summary'],
+    };
+}
+/**
+ * List all updates with metadata (no body), sorted newest first by ISO date.
+ */
+function listUpdates() {
+    const slugs = (0, parser_js_1.listContentSlugs)('updates');
+    const updates = [];
+    for (const slug of slugs) {
+        const { frontmatter } = (0, parser_js_1.readContentFile)(`updates/${slug}.md`);
+        const meta = toMeta(slug, frontmatter);
+        if (meta)
+            updates.push(meta);
+    }
+    return updates.sort((a, b) => (a.date < b.date ? 1 : a.date > b.date ? -1 : a.slug.localeCompare(b.slug)));
+}
+/**
+ * Get a single update by slug, including the markdown body.
+ */
+function getUpdate(slug) {
+    try {
+        const { frontmatter, body } = (0, parser_js_1.readContentFile)(`updates/${slug}.md`);
+        const meta = toMeta(slug, frontmatter);
+        return meta ? { ...meta, body } : null;
+    }
+    catch {
+        return null;
+    }
+}
+//# sourceMappingURL=updates.js.map

package/dist/updates.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"updates.js","sourceRoot":"","sources":["../src/updates.ts"],"names":[],"mappings":";;;AA4DA,kCASC;AAKD,8BAQC;AAlFD,2CAA6E;AAoFpE,4FApFmC,uBAAW,OAoFnC;AAhEpB,MAAM,aAAa,GAAG;IACpB,IAAI;IACJ,OAAO;IACP,MAAM;IACN,cAAc;IACd,cAAc;IACd,QAAQ;IACR,SAAS;CACD,CAAC;AAEX,SAAS,oBAAoB,CAAC,WAAoC;IAChE,OAAO,aAAa,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,WAAW,CAAC,KAAK,CAAC,KAAK,QAAQ,IAAI,WAAW,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC;AAC9G,CAAC;AAED,SAAS,eAAe,CAAC,KAAa;IACpC,OAAQ,CAAC,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,WAAW,CAAW,CAAC,QAAQ,CAAC,KAAc,CAAC;QACxF,CAAC,CAAE,KAA8B;QACjC,CAAC,CAAC,OAAO,CAAC;AACd,CAAC;AAED,SAAS,MAAM,CAAC,IAAY,EAAE,WAAoC;IAChE,MAAM,OAAO,GAAG,oBAAoB,CAAC,WAAW,CAAC,CAAC;IAClD,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,IAAI,CAAC;IACpC,MAAM,SAAS,GAAG,WAAW,CAAC,WAAW,CAAC,CAAC;IAC3C,OAAO;QACL,EAAE,EAAE,WAAW,CAAC,IAAI,CAAW;QAC/B,IAAI;QACJ,KAAK,EAAE,WAAW,CAAC,OAAO,CAAW;QACrC,IAAI,EAAE,WAAW,CAAC,MAAM,CAAW;QACnC,YAAY,EAAE,WAAW,CAAC,cAAc,CAAW;QACnD,YAAY,EAAE,WAAW,CAAC,cAAc,CAAW;QACnD,SAAS,EAAE,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,GAAG,EAAiB,EAAE,CAAC,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE;QAC5G,MAAM,EAAE,eAAe,CAAC,WAAW,CAAC,QAAQ,CAAW,CAAC;QACxD,OAAO,EAAE,WAAW,CAAC,SAAS,CAAW;KAC1C,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,SAAgB,WAAW;IACzB,MAAM,KAAK,GAAG,IAAA,4BAAgB,EAAC,SAAS,CAAC,CAAC;IAC1C,MAAM,OAAO,GAAiB,EAAE,CAAC;IACjC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,EAAE,WAAW,EAAE,GAAG,IAAA,2BAAe,EAAC,WAAW,IAAI,KAAK,CAAC,CAAC;QAC9D,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QACvC,IAAI,IAAI;YAAE,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IACD,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAC7G,CAAC;AAED;;GAEG;AACH,SAAgB,SAAS,CAAC,IAAY;IACpC,IAAI,CAAC;QACH,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,GAAG,IAAA,2BAAe,EAAC,WAAW,IAAI,KAAK,CAAC,CAAC;QACpE,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QACvC,OAAO,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;IACzC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC"}

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@clearproof/content",
+  "version": "0.5.0",
+  "description": "Single source of truth for all clearproof developer-facing content",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "license": "Apache-2.0",
+  "files": [
+    "dist",
+    "content"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/repfigit/clearproof.git",
+    "directory": "packages/content"
+  },
+  "homepage": "https://github.com/repfigit/clearproof",
+  "keywords": [
+    "clearproof",
+    "content",
+    "documentation",
+    "zk",
+    "compliance"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "build": "tsc",
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage --coverage.include=\"src/**/*.ts\" --coverage.reporter=text --coverage.reporter=json-summary --coverage.reporter=lcov --coverage.thresholds.lines=100 --coverage.thresholds.branches=100 --coverage.thresholds.functions=100 --coverage.thresholds.statements=100"
+  },
+  "dependencies": {
+    "js-yaml": "^4.1.0"
+  },
+  "devDependencies": {
+    "@types/js-yaml": "^4.0.9",
+    "@vitest/coverage-v8": "^4.1.11",
+    "typescript": "^5.4",
+    "vitest": "^4.1.5"
+  }
+}