@brainfile/cli 0.13.2 → 0.13.3

package/dist/commands/schema.js

@@ -0,0 +1,369 @@
+"use strict";
+/**
+ * Schema command for Brainfile CLI
+ *
+ * View and manage brainfile schemas locally, eliminating network access for basic usage.
+ *
+ * Usage:
+ *   brainfile schema                # List available schemas
+ *   brainfile schema <name>         # Display specific schema
+ *   brainfile schema update         # Check for and download schema updates
+ *   brainfile schema --json         # Output in JSON format
+ *
+ * @packageDocumentation
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SCHEMA_COMMAND_HELP = void 0;
+exports.schemaCommand = schemaCommand;
+exports.schemaUpdateCommand = schemaUpdateCommand;
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const chalk_1 = __importDefault(require("chalk"));
+const logger_1 = require("../utils/logger");
+const cli_error_1 = require("../utils/cli-error");
+const errorHandler_1 = require("../utils/errorHandler");
+const config_1 = require("../utils/config");
+// ============================================================================
+// Constants
+// ============================================================================
+const SCHEMA_BASE_URL = 'https://brainfile.md/v1';
+const CHECK_INTERVAL_MS = 24 * 60 * 60 * 1000; // 24 hours
+// Get bundled schemas directory (relative to this file after compilation)
+function getBundledSchemasDir() {
+    // In development: cli/src/schemas
+    // In production:  cli/dist/schemas
+    const distPath = path.join(__dirname, '..', 'schemas');
+    const srcPath = path.join(__dirname, '..', '..', 'src', 'schemas');
+    if (fs.existsSync(distPath)) {
+        return distPath;
+    }
+    if (fs.existsSync(srcPath)) {
+        return srcPath;
+    }
+    // Fallback for development
+    return path.join(__dirname, 'schemas');
+}
+// Schema metadata
+const BUNDLED_SCHEMAS = [
+    {
+        id: 'board',
+        description: 'Board structure (columns, tasks, contracts)',
+        file: 'board.json',
+    },
+    {
+        id: 'base',
+        description: 'Base types (rules, agent instructions)',
+        file: 'base.json',
+    },
+];
+// ============================================================================
+// Help Text
+// ============================================================================
+exports.SCHEMA_COMMAND_HELP = `
+Examples:
+  brainfile schema                # List available schemas
+  brainfile schema board          # View the board schema
+  brainfile schema base           # View the base schema
+  brainfile schema update         # Check for schema updates
+  brainfile schema board --json   # Output board schema as JSON
+
+Bundled schemas:
+  board  - Board structure (columns, tasks, contracts)
+  base   - Base types (rules, agent instructions)
+
+Notes:
+  - Schemas are bundled with the CLI (no network required for basic usage)
+  - Use 'schema update' to check for newer versions from brainfile.md
+  - Auto-checks once per 24 hours (non-blocking notification)
+`.trimEnd();
+// ============================================================================
+// Main Command
+// ============================================================================
+function schemaCommand(options, logger = logger_1.defaultLogger) {
+    const { name, json } = options;
+    // Handle update subcommand
+    if (name === 'update') {
+        return schemaUpdateCommand({ json }, logger);
+    }
+    // Handle show specific schema
+    if (name) {
+        return schemaShowCommand(name, { json }, logger);
+    }
+    // List all schemas
+    return schemaListCommand({ json }, logger);
+}
+// ============================================================================
+// List Schemas
+// ============================================================================
+function schemaListCommand(options, logger) {
+    if (options.json) {
+        const output = {
+            schemas: BUNDLED_SCHEMAS.map((s) => ({
+                id: s.id,
+                description: s.description,
+            })),
+        };
+        logger.log(JSON.stringify(output, null, 2));
+    }
+    else {
+        logger.log('');
+        logger.log(chalk_1.default.bold('Available schemas:'));
+        logger.log('');
+        const maxIdLen = Math.max(...BUNDLED_SCHEMAS.map((s) => s.id.length));
+        for (const schema of BUNDLED_SCHEMAS) {
+            logger.log(`  ${chalk_1.default.cyan(schema.id.padEnd(maxIdLen))}  ${chalk_1.default.gray('-')} ${schema.description}`);
+        }
+        logger.log('');
+        logger.log(chalk_1.default.gray('Run: brainfile schema <name> to view schema'));
+        logger.log(chalk_1.default.gray('Run: brainfile schema update to check for updates'));
+    }
+    // Check for auto-update (non-blocking)
+    checkAutoUpdate(logger);
+    return {
+        success: true,
+        action: 'list',
+        schemas: BUNDLED_SCHEMAS.map((s) => s.id),
+    };
+}
+// ============================================================================
+// Show Schema
+// ============================================================================
+function schemaShowCommand(name, options, logger) {
+    const schemaInfo = BUNDLED_SCHEMAS.find((s) => s.id === name);
+    if (!schemaInfo) {
+        const availableIds = BUNDLED_SCHEMAS.map((s) => s.id).join(', ');
+        throw new cli_error_1.CLIError(`Unknown schema: ${name}`, errorHandler_1.ExitCode.USER_ERROR, `Available schemas: ${availableIds}`);
+    }
+    const schemasDir = getBundledSchemasDir();
+    const schemaPath = path.join(schemasDir, schemaInfo.file);
+    if (!fs.existsSync(schemaPath)) {
+        throw new cli_error_1.CLIError(`Schema file not found: ${schemaInfo.file}`, errorHandler_1.ExitCode.USER_ERROR, `Expected at: ${schemaPath}`);
+    }
+    const content = fs.readFileSync(schemaPath, 'utf-8');
+    const schema = JSON.parse(content);
+    if (options.json) {
+        logger.log(JSON.stringify(schema, null, 2));
+    }
+    else {
+        logger.log('');
+        logger.log(chalk_1.default.bold(`Schema: ${name}`));
+        logger.log(chalk_1.default.gray(`Description: ${schemaInfo.description}`));
+        logger.log(chalk_1.default.gray(`Source: ${SCHEMA_BASE_URL}/${schemaInfo.file}`));
+        logger.log('');
+        logger.log(JSON.stringify(schema, null, 2));
+    }
+    return {
+        success: true,
+        action: 'show',
+        schema,
+    };
+}
+// ============================================================================
+// Update Schemas
+// ============================================================================
+async function fetchWithTimeout(url, timeoutMs) {
+    const controller = new AbortController();
+    const timeout = setTimeout(() => controller.abort(), timeoutMs);
+    try {
+        const response = await fetch(url, { signal: controller.signal });
+        return response;
+    }
+    finally {
+        clearTimeout(timeout);
+    }
+}
+function schemaUpdateCommand(options, logger = logger_1.defaultLogger) {
+    // Run the async update and handle synchronously for CLI
+    schemaUpdateAsync(options, logger);
+    return {
+        success: true,
+        action: 'update',
+        updated: false, // Will be updated by async function
+    };
+}
+async function schemaUpdateAsync(options, logger) {
+    if (!options.json) {
+        logger.log('');
+        logger.log(chalk_1.default.bold('Checking for schema updates...'));
+        logger.log('');
+    }
+    const schemasDir = getBundledSchemasDir();
+    const results = [];
+    for (const schemaInfo of BUNDLED_SCHEMAS) {
+        const url = `${SCHEMA_BASE_URL}/${schemaInfo.file}`;
+        const localPath = path.join(schemasDir, schemaInfo.file);
+        try {
+            const response = await fetchWithTimeout(url, 10000);
+            if (!response.ok) {
+                results.push({
+                    id: schemaInfo.id,
+                    status: 'error',
+                    error: `HTTP ${response.status}`,
+                });
+                continue;
+            }
+            const remoteContent = await response.text();
+            const remoteSchema = JSON.parse(remoteContent);
+            // Compare with local
+            let localSchema = null;
+            if (fs.existsSync(localPath)) {
+                const localContent = fs.readFileSync(localPath, 'utf-8');
+                localSchema = JSON.parse(localContent);
+            }
+            // Simple comparison using JSON stringification
+            const remoteStr = JSON.stringify(remoteSchema);
+            const localStr = localSchema ? JSON.stringify(localSchema) : '';
+            if (remoteStr !== localStr) {
+                // Update local schema
+                fs.writeFileSync(localPath, JSON.stringify(remoteSchema, null, 2));
+                results.push({ id: schemaInfo.id, status: 'updated' });
+            }
+            else {
+                results.push({ id: schemaInfo.id, status: 'current' });
+            }
+        }
+        catch (error) {
+            const errorMsg = error instanceof Error ? error.message : String(error);
+            results.push({ id: schemaInfo.id, status: 'error', error: errorMsg });
+        }
+    }
+    // Update last check time
+    updateLastCheckTime();
+    // Output results
+    if (options.json) {
+        logger.log(JSON.stringify({ schemas: results }, null, 2));
+    }
+    else {
+        for (const result of results) {
+            if (result.status === 'updated') {
+                logger.log(`  ${chalk_1.default.green('+')} ${chalk_1.default.cyan(result.id)} - Updated`);
+            }
+            else if (result.status === 'current') {
+                logger.log(`  ${chalk_1.default.gray('=')} ${chalk_1.default.cyan(result.id)} - Up to date`);
+            }
+            else {
+                logger.log(`  ${chalk_1.default.red('!')} ${chalk_1.default.cyan(result.id)} - Error: ${result.error}`);
+            }
+        }
+        const updatedCount = results.filter((r) => r.status === 'updated').length;
+        logger.log('');
+        if (updatedCount > 0) {
+            logger.log(chalk_1.default.green(`Updated ${updatedCount} schema(s)`));
+        }
+        else {
+            logger.log(chalk_1.default.gray('All schemas are up to date'));
+        }
+    }
+}
+// ============================================================================
+// Auto-Update Check
+// ============================================================================
+function getSchemaConfig() {
+    const config = (0, config_1.loadConfig)();
+    return config.schema || {};
+}
+function saveSchemaConfig(schemaConfig) {
+    const config = (0, config_1.loadConfig)();
+    config.schema = schemaConfig;
+    (0, config_1.saveConfig)(config);
+}
+function updateLastCheckTime() {
+    const schemaConfig = getSchemaConfig();
+    schemaConfig.lastCheck = new Date().toISOString();
+    saveSchemaConfig(schemaConfig);
+}
+function shouldAutoCheck() {
+    const schemaConfig = getSchemaConfig();
+    if (!schemaConfig.lastCheck) {
+        return true;
+    }
+    const lastCheck = new Date(schemaConfig.lastCheck).getTime();
+    const now = Date.now();
+    return now - lastCheck > CHECK_INTERVAL_MS;
+}
+function checkAutoUpdate(logger) {
+    if (!shouldAutoCheck()) {
+        return;
+    }
+    // Run async check in background (non-blocking)
+    checkForUpdatesAsync(logger).catch(() => {
+        // Silently ignore errors during auto-check
+    });
+}
+async function checkForUpdatesAsync(logger) {
+    const schemasDir = getBundledSchemasDir();
+    let hasUpdates = false;
+    for (const schemaInfo of BUNDLED_SCHEMAS) {
+        const url = `${SCHEMA_BASE_URL}/${schemaInfo.file}`;
+        const localPath = path.join(schemasDir, schemaInfo.file);
+        try {
+            const response = await fetchWithTimeout(url, 5000);
+            if (!response.ok) {
+                continue;
+            }
+            const remoteContent = await response.text();
+            const remoteSchema = JSON.parse(remoteContent);
+            // Compare with local
+            if (fs.existsSync(localPath)) {
+                const localContent = fs.readFileSync(localPath, 'utf-8');
+                const localSchema = JSON.parse(localContent);
+                const remoteStr = JSON.stringify(remoteSchema);
+                const localStr = JSON.stringify(localSchema);
+                if (remoteStr !== localStr) {
+                    hasUpdates = true;
+                    break;
+                }
+            }
+        }
+        catch {
+            // Silently ignore errors during auto-check
+        }
+    }
+    // Update last check time
+    updateLastCheckTime();
+    // Notify user if updates available
+    if (hasUpdates) {
+        logger.log('');
+        logger.log(chalk_1.default.yellow('Hint: ') +
+            'Schema updates available. Run ' +
+            chalk_1.default.cyan('brainfile schema update') +
+            ' to update.');
+    }
+}
+//# sourceMappingURL=schema.js.map

package/dist/commands/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../src/commands/schema.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;GAYG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4GH,sCAkBC;AAiHD,kDAYC;AAzPD,uCAAyB;AACzB,2CAA6B;AAC7B,kDAA0B;AAC1B,4CAA6D;AAC7D,kDAA8C;AAC9C,wDAAiD;AACjD,4CAKyB;AA8BzB,+EAA+E;AAC/E,YAAY;AACZ,+EAA+E;AAE/E,MAAM,eAAe,GAAG,yBAAyB,CAAC;AAClD,MAAM,iBAAiB,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,WAAW;AAE1D,0EAA0E;AAC1E,SAAS,oBAAoB;IAC3B,kCAAkC;IAClC,mCAAmC;IACnC,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;IACvD,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC;IAEnE,IAAI,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC5B,OAAO,QAAQ,CAAC;IAClB,CAAC;IACD,IAAI,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;QAC3B,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,2BAA2B;IAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;AACzC,CAAC;AAED,kBAAkB;AAClB,MAAM,eAAe,GAAiB;IACpC;QACE,EAAE,EAAE,OAAO;QACX,WAAW,EAAE,6CAA6C;QAC1D,IAAI,EAAE,YAAY;KACnB;IACD;QACE,EAAE,EAAE,MAAM;QACV,WAAW,EAAE,wCAAwC;QACrD,IAAI,EAAE,WAAW;KAClB;CACF,CAAC;AAEF,+EAA+E;AAC/E,YAAY;AACZ,+EAA+E;AAElE,QAAA,mBAAmB,GAAG;;;;;;;;;;;;;;;;CAgBlC,CAAC,OAAO,EAAE,CAAC;AAEZ,+EAA+E;AAC/E,eAAe;AACf,+EAA+E;AAE/E,SAAgB,aAAa,CAC3B,OAAsB,EACtB,SAAiB,sBAAa;IAE9B,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;IAE/B,2BAA2B;IAC3B,IAAI,IAAI,KAAK,QAAQ,EAAE,CAAC;QACtB,OAAO,mBAAmB,CAAC,EAAE,IAAI,EAAE,EAAE,MAAM,CAAC,CAAC;IAC/C,CAAC;IAED,8BAA8B;IAC9B,IAAI,IAAI,EAAE,CAAC;QACT,OAAO,iBAAiB,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,EAAE,MAAM,CAAC,CAAC;IACnD,CAAC;IAED,mBAAmB;IACnB,OAAO,iBAAiB,CAAC,EAAE,IAAI,EAAE,EAAE,MAAM,CAAC,CAAC;AAC7C,CAAC;AAED,+EAA+E;AAC/E,eAAe;AACf,+EAA+E;AAE/E,SAAS,iBAAiB,CACxB,OAA2B,EAC3B,MAAc;IAEd,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;QACjB,MAAM,MAAM,GAAG;YACb,OAAO,EAAE,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;gBACnC,EAAE,EAAE,CAAC,CAAC,EAAE;gBACR,WAAW,EAAE,CAAC,CAAC,WAAW;aAC3B,CAAC,CAAC;SACJ,CAAC;QACF,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IAC9C,CAAC;SAAM,CAAC;QACN,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACf,MAAM,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC;QAC7C,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAEf,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;QACtE,KAAK,MAAM,MAAM,IAAI,eAAe,EAAE,CAAC;YACrC,MAAM,CAAC,GAAG,CACR,KAAK,eAAK,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,KAAK,eAAK,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,WAAW,EAAE,CACxF,CAAC;QACJ,CAAC;QAED,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACf,MAAM,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,6CAA6C,CAAC,CAAC,CAAC;QACtE,MAAM,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,mDAAmD,CAAC,CAAC,CAAC;IAC9E,CAAC;IAED,uCAAuC;IACvC,eAAe,CAAC,MAAM,CAAC,CAAC;IAExB,OAAO;QACL,OAAO,EAAE,IAAI;QACb,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC1C,CAAC;AACJ,CAAC;AAED,+EAA+E;AAC/E,cAAc;AACd,+EAA+E;AAE/E,SAAS,iBAAiB,CACxB,IAAY,EACZ,OAA2B,EAC3B,MAAc;IAEd,MAAM,UAAU,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,IAAI,CAAC,CAAC;IAE9D,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,MAAM,YAAY,GAAG,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjE,MAAM,IAAI,oBAAQ,CAChB,mBAAmB,IAAI,EAAE,EACzB,uBAAQ,CAAC,UAAU,EACnB,sBAAsB,YAAY,EAAE,CACrC,CAAC;IACJ,CAAC;IAED,MAAM,UAAU,GAAG,oBAAoB,EAAE,CAAC;IAC1C,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;IAE1D,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,oBAAQ,CAChB,0BAA0B,UAAU,CAAC,IAAI,EAAE,EAC3C,uBAAQ,CAAC,UAAU,EACnB,gBAAgB,UAAU,EAAE,CAC7B,CAAC;IACJ,CAAC;IAED,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IACrD,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAEnC,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;QACjB,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IAC9C,CAAC;SAAM,CAAC;QACN,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACf,MAAM,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC,CAAC;QAC1C,MAAM,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,gBAAgB,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;QACjE,MAAM,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,WAAW,eAAe,IAAI,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;QACxE,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACf,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IAC9C,CAAC;IAED,OAAO;QACL,OAAO,EAAE,IAAI;QACb,MAAM,EAAE,MAAM;QACd,MAAM;KACP,CAAC;AACJ,CAAC;AAED,+EAA+E;AAC/E,iBAAiB;AACjB,+EAA+E;AAE/E,KAAK,UAAU,gBAAgB,CAAC,GAAW,EAAE,SAAiB;IAC5D,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;IACzC,MAAM,OAAO,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,EAAE,SAAS,CAAC,CAAC;IAEhE,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC;QACjE,OAAO,QAAQ,CAAC;IAClB,CAAC;YAAS,CAAC;QACT,YAAY,CAAC,OAAO,CAAC,CAAC;IACxB,CAAC;AACH,CAAC;AAED,SAAgB,mBAAmB,CACjC,OAA2B,EAC3B,SAAiB,sBAAa;IAE9B,wDAAwD;IACxD,iBAAiB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAEnC,OAAO;QACL,OAAO,EAAE,IAAI;QACb,MAAM,EAAE,QAAQ;QAChB,OAAO,EAAE,KAAK,EAAE,oCAAoC;KACrD,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,iBAAiB,CAC9B,OAA2B,EAC3B,MAAc;IAEd,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;QAClB,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACf,MAAM,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAC,CAAC;QACzD,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IAED,MAAM,UAAU,GAAG,oBAAoB,EAAE,CAAC;IAC1C,MAAM,OAAO,GAAmF,EAAE,CAAC;IAEnG,KAAK,MAAM,UAAU,IAAI,eAAe,EAAE,CAAC;QACzC,MAAM,GAAG,GAAG,GAAG,eAAe,IAAI,UAAU,CAAC,IAAI,EAAE,CAAC;QACpD,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;QAEzD,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,gBAAgB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YAEpD,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;gBACjB,OAAO,CAAC,IAAI,CAAC;oBACX,EAAE,EAAE,UAAU,CAAC,EAAE;oBACjB,MAAM,EAAE,OAAO;oBACf,KAAK,EAAE,QAAQ,QAAQ,CAAC,MAAM,EAAE;iBACjC,CAAC,CAAC;gBACH,SAAS;YACX,CAAC;YAED,MAAM,aAAa,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YAC5C,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;YAE/C,qBAAqB;YACrB,IAAI,WAAW,GAAkB,IAAI,CAAC;YACtC,IAAI,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC7B,MAAM,YAAY,GAAG,EAAE,CAAC,YAAY,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;gBACzD,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;YACzC,CAAC;YAED,+CAA+C;YAC/C,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;YAC/C,MAAM,QAAQ,GAAG,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAEhE,IAAI,SAAS,KAAK,QAAQ,EAAE,CAAC;gBAC3B,sBAAsB;gBACtB,EAAE,CAAC,aAAa,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;gBACnE,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;YACzD,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;YACzD,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,QAAQ,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACxE,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;QACxE,CAAC;IACH,CAAC;IAED,yBAAyB;IACzB,mBAAmB,EAAE,CAAC;IAEtB,iBAAiB;IACjB,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;QACjB,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IAC5D,CAAC;SAAM,CAAC;QACN,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;gBAChC,MAAM,CAAC,GAAG,CAAC,KAAK,eAAK,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,eAAK,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC;YACzE,CAAC;iBAAM,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;gBACvC,MAAM,CAAC,GAAG,CAAC,KAAK,eAAK,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,eAAK,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,eAAe,CAAC,CAAC;YAC3E,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,GAAG,CACR,KAAK,eAAK,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,eAAK,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,aAAa,MAAM,CAAC,KAAK,EAAE,CACxE,CAAC;YACJ,CAAC;QACH,CAAC;QAED,MAAM,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,MAAM,CAAC;QAC1E,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACf,IAAI,YAAY,GAAG,CAAC,EAAE,CAAC;YACrB,MAAM,CAAC,GAAG,CAAC,eAAK,CAAC,KAAK,CAAC,WAAW,YAAY,YAAY,CAAC,CAAC,CAAC;QAC/D,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC,CAAC;QACvD,CAAC;IACH,CAAC;AACH,CAAC;AAED,+EAA+E;AAC/E,oBAAoB;AACpB,+EAA+E;AAE/E,SAAS,eAAe;IACtB,MAAM,MAAM,GAAG,IAAA,mBAAU,GAAE,CAAC;IAC5B,OAAQ,MAAc,CAAC,MAAM,IAAI,EAAE,CAAC;AACtC,CAAC;AAED,SAAS,gBAAgB,CAAC,YAA0B;IAClD,MAAM,MAAM,GAAG,IAAA,mBAAU,GAAE,CAAC;IAC3B,MAAc,CAAC,MAAM,GAAG,YAAY,CAAC;IACtC,IAAA,mBAAU,EAAC,MAAM,CAAC,CAAC;AACrB,CAAC;AAED,SAAS,mBAAmB;IAC1B,MAAM,YAAY,GAAG,eAAe,EAAE,CAAC;IACvC,YAAY,CAAC,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IAClD,gBAAgB,CAAC,YAAY,CAAC,CAAC;AACjC,CAAC;AAED,SAAS,eAAe;IACtB,MAAM,YAAY,GAAG,eAAe,EAAE,CAAC;IAEvC,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,SAAS,GAAG,IAAI,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,CAAC;IAC7D,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAEvB,OAAO,GAAG,GAAG,SAAS,GAAG,iBAAiB,CAAC;AAC7C,CAAC;AAED,SAAS,eAAe,CAAC,MAAc;IACrC,IAAI,CAAC,eAAe,EAAE,EAAE,CAAC;QACvB,OAAO;IACT,CAAC;IAED,+CAA+C;IAC/C,oBAAoB,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE;QACtC,2CAA2C;IAC7C,CAAC,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,oBAAoB,CAAC,MAAc;IAChD,MAAM,UAAU,GAAG,oBAAoB,EAAE,CAAC;IAC1C,IAAI,UAAU,GAAG,KAAK,CAAC;IAEvB,KAAK,MAAM,UAAU,IAAI,eAAe,EAAE,CAAC;QACzC,MAAM,GAAG,GAAG,GAAG,eAAe,IAAI,UAAU,CAAC,IAAI,EAAE,CAAC;QACpD,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;QAEzD,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,gBAAgB,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YAEnD,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;gBACjB,SAAS;YACX,CAAC;YAED,MAAM,aAAa,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YAC5C,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;YAE/C,qBAAqB;YACrB,IAAI,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC7B,MAAM,YAAY,GAAG,EAAE,CAAC,YAAY,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;gBACzD,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;gBAE7C,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;gBAC/C,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;gBAE7C,IAAI,SAAS,KAAK,QAAQ,EAAE,CAAC;oBAC3B,UAAU,GAAG,IAAI,CAAC;oBAClB,MAAM;gBACR,CAAC;YACH,CAAC;QACH,CAAC;QAAC,MAAM,CAAC;YACP,2CAA2C;QAC7C,CAAC;IACH,CAAC;IAED,yBAAyB;IACzB,mBAAmB,EAAE,CAAC;IAEtB,mCAAmC;IACnC,IAAI,UAAU,EAAE,CAAC;QACf,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACf,MAAM,CAAC,GAAG,CACR,eAAK,CAAC,MAAM,CAAC,QAAQ,CAAC;YACpB,gCAAgC;YAChC,eAAK,CAAC,IAAI,CAAC,yBAAyB,CAAC;YACrC,aAAa,CAChB,CAAC;IACJ,CAAC;AACH,CAAC"}

package/dist/schemas/base.json

@@ -0,0 +1,159 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://brainfile.md/v1/base.json",
+  "title": "Brainfile Base Schema",
+  "description": "Base schema that all brainfile types extend. Defines shared fields across all types. Community types can extend this schema with custom fields.",
+  "type": "object",
+  "required": ["title"],
+  "properties": {
+    "type": {
+      "type": "string",
+      "description": "Type identifier. Default: board.",
+      "minLength": 1,
+      "examples": ["board"]
+    },
+    "schema": {
+      "type": "string",
+      "description": "Schema URL for validation. Official types default to brainfile.md/v1/{type}.json. Community types MUST provide a schema URL for validation. Can be a remote URI (https://) or local file path.",
+      "examples": [
+        "https://brainfile.md/v1/board.json"
+      ]
+    },
+    "title": {
+      "type": "string",
+      "description": "Title of the brainfile",
+      "minLength": 1,
+      "examples": ["My Project", "Dev Log 2025", "Reading List"]
+    },
+    "protocolVersion": {
+      "type": "string",
+      "description": "Version of the Brainfile protocol this file uses",
+      "pattern": "^[0-9]+\\.[0-9]+\\.[0-9]+$",
+      "default": "1.0.0"
+    },
+    "agent": {
+      "type": "object",
+      "description": "Instructions for AI agents interacting with the brainfile",
+      "properties": {
+        "instructions": {
+          "type": "array",
+          "description": "List of instructions for AI agents",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          },
+          "examples": [
+            ["Modify only the YAML frontmatter", "Preserve all IDs", "Use ISO dates for entries"]
+          ]
+        },
+        "llmNotes": {
+          "type": "string",
+          "description": "Free-form notes about how this project prefers AI work to be structured"
+        },
+        "tools": {
+          "type": "object",
+          "description": "CLI tools and commands available for agents to use. Reduces token usage vs manual file editing.",
+          "additionalProperties": {
+            "type": "object",
+            "description": "Tool configuration",
+            "properties": {
+              "description": {
+                "type": "string",
+                "description": "What this tool is for"
+              },
+              "alias": {
+                "type": "string",
+                "description": "Command alias if different from tool name"
+              },
+              "prefer": {
+                "type": ["boolean", "string"],
+                "description": "Whether to prefer this tool, or a note about when to prefer it"
+              },
+              "commands": {
+                "type": "array",
+                "description": "Available commands with their syntax",
+                "items": {
+                  "type": "string"
+                }
+              }
+            },
+            "additionalProperties": true
+          },
+          "examples": [
+            {
+              "brainfile": {
+                "prefer": true,
+                "commands": ["move --task <id> --column <id>", "add --title \"...\" --column <id>", "list"]
+              },
+              "ripgrep": {
+                "alias": "rg",
+                "prefer": "use for all file content searches"
+              }
+            }
+          ]
+        }
+      },
+      "additionalProperties": true
+    },
+    "rules": {
+      "type": "object",
+      "description": "Project rules organized by category",
+      "properties": {
+        "always": {
+          "type": "array",
+          "description": "Rules that must always be followed",
+          "items": {
+            "$ref": "#/definitions/rule"
+          }
+        },
+        "never": {
+          "type": "array",
+          "description": "Rules that must never be violated",
+          "items": {
+            "$ref": "#/definitions/rule"
+          }
+        },
+        "prefer": {
+          "type": "array",
+          "description": "Preferred approaches or patterns",
+          "items": {
+            "$ref": "#/definitions/rule"
+          }
+        },
+        "context": {
+          "type": "array",
+          "description": "Contextual information and constraints",
+          "items": {
+            "$ref": "#/definitions/rule"
+          }
+        }
+      },
+      "additionalProperties": true
+    }
+  },
+  "additionalProperties": true,
+  "definitions": {
+    "rule": {
+      "type": "object",
+      "required": ["id", "rule"],
+      "properties": {
+        "id": {
+          "type": ["integer", "string"],
+          "description": "Unique identifier within the rule category"
+        },
+        "rule": {
+          "type": "string",
+          "description": "The rule text",
+          "minLength": 1
+        }
+      },
+      "additionalProperties": true
+    },
+    "timestamp": {
+      "type": "string",
+      "description": "ISO 8601 timestamp",
+      "format": "date-time",
+      "examples": ["2025-11-24T10:30:00Z", "2025-11-24T14:22:00-08:00"]
+    }
+  }
+}