brainfile 0.18.0

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"]
+    }
+  }
+}

package/dist/schemas/board.json

@@ -0,0 +1,290 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://brainfile.md/v1/board.json",
+  "title": "Brainfile Board Schema",
+  "description": "Schema for Kanban-style task boards. In v2 (per-task file architecture), the board file is config-only: it defines columns, rules, and project metadata. Tasks are standalone .md files in .brainfile/tasks/ (active) and .brainfile/logs/ (completed), each validated against task.json. In v1 (legacy), tasks are embedded in column arrays within this file.",
+  "x-brainfile-renderer": "kanban",
+  "x-brainfile-columns-path": "$.columns",
+  "x-brainfile-title-field": "title",
+  "x-brainfile-status-field": "priority",
+  "allOf": [
+    {
+      "$ref": "https://brainfile.md/v1/base.json"
+    },
+    {
+      "type": "object",
+      "required": [
+        "columns"
+      ],
+      "properties": {
+        "type": {
+          "const": "board"
+        },
+        "columns": {
+          "type": "array",
+          "description": "Board columns defining workflow stages. In v2, columns are config-only (no embedded tasks). In v1 (legacy), columns may contain a tasks array.",
+          "minItems": 1,
+          "items": {
+            "$ref": "#/definitions/column"
+          }
+        },
+        "types": {
+          "type": "object",
+          "description": "Optional map of document type definitions. Keys are type identifiers (e.g., 'epic', 'adr') that match the type field in task.json. In strict mode, this map is the allowlist for non-task types; the built-in task type is always implicitly valid. When omitted, all items are standard tasks.",
+          "additionalProperties": {
+            "$ref": "#/definitions/typeEntry"
+          },
+          "examples": [
+            {
+              "epic": {
+                "idPrefix": "epic",
+                "completable": false,
+                "schema": "https://brainfile.md/v1/examples/epic.json"
+              },
+              "adr": {
+                "idPrefix": "adr",
+                "completable": false,
+                "schema": "https://brainfile.md/v1/examples/adr.json"
+              }
+            }
+          ]
+        },
+        "strict": {
+          "type": "boolean",
+          "description": "Enables strict validation for CLI operations. When true, add rejects unknown task types and move rejects unknown columns. When false (default), unknown types and columns are allowed for backward compatibility. The task type is always implicitly valid even if not listed in types.",
+          "default": false
+        },
+        "statsConfig": {
+          "type": "object",
+          "description": "Configuration for statistics calculation",
+          "properties": {
+            "columns": {
+              "type": "array",
+              "description": "Column IDs to include in progress statistics",
+              "items": {
+                "type": "string"
+              }
+            }
+          },
+          "additionalProperties": false
+        },
+        "archive": {
+          "type": "array",
+          "description": "Deprecated in v2. In v1, holds archived tasks removed from active columns. In v2, completed tasks live as individual files in .brainfile/logs/.",
+          "x-brainfile-deprecated": true,
+          "items": {
+            "$ref": "#/definitions/task"
+          }
+        }
+      },
+      "additionalProperties": true
+    }
+  ],
+  "definitions": {
+    "typeEntry": {
+      "type": "object",
+      "description": "Configuration for a custom document type. Defines how items of this type behave within the board.",
+      "required": [
+        "idPrefix"
+      ],
+      "properties": {
+        "idPrefix": {
+          "type": "string",
+          "description": "Prefix for auto-generated IDs of this type (e.g., 'epic' produces 'epic-1', 'epic-2'). Must be unique across all type entries.",
+          "pattern": "^[a-z]+(-[a-z]+)*$",
+          "minLength": 1
+        },
+        "completable": {
+          "type": "boolean",
+          "description": "Whether items of this type can be completed (moved to completion columns and logs/). Defaults to true. Set to false for reference documents like ADRs or epics that are not completable tasks.",
+          "default": true
+        },
+        "schema": {
+          "type": "string",
+          "description": "Optional JSON Schema URL for validating the extended fields of this type. Can be a remote URI (https://) or a local file path relative to the project root.",
+          "format": "uri-reference",
+          "examples": [
+            "https://brainfile.md/v1/examples/epic.json",
+            ".brainfile/schemas/adr.json"
+          ]
+        }
+      },
+      "additionalProperties": true
+    },
+    "column": {
+      "type": "object",
+      "required": [
+        "id",
+        "title"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Unique column identifier in kebab-case (e.g., 'todo', 'in-progress'). Referenced by task.column in per-task files.",
+          "pattern": "^[a-z]+(-[a-z]+)*$",
+          "minLength": 1
+        },
+        "title": {
+          "type": "string",
+          "description": "Display title for the column",
+          "minLength": 1
+        },
+        "order": {
+          "type": "integer",
+          "description": "Display order for the column. Lower numbers appear first. Columns without order appear last.",
+          "minimum": 0
+        },
+        "completionColumn": {
+          "type": "boolean",
+          "description": "Marks this column as a completion column. When true, tasks moved to this column are considered complete. Enables explicit completion semantics for non-English column names and custom workflows.",
+          "default": false
+        },
+        "tasks": {
+          "type": "array",
+          "description": "Deprecated in v2. In v1, holds tasks embedded in this column. In v2, task membership is declared via the column field in each task's frontmatter (see task.json).",
+          "x-brainfile-deprecated": true,
+          "items": {
+            "$ref": "#/definitions/task"
+          }
+        }
+      },
+      "additionalProperties": true
+    },
+    "task": {
+      "type": "object",
+      "description": "Deprecated in v2. Inline task definition for v1 backward compatibility. In v2, use the standalone task.json schema instead.",
+      "x-brainfile-deprecated": true,
+      "x-brainfile-see": "https://brainfile.md/v1/task.json",
+      "required": [
+        "id",
+        "title"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Unique identifier following pattern '{type}-N'",
+          "pattern": "^[a-z][a-z0-9]*-[0-9]+$"
+        },
+        "title": {
+          "type": "string",
+          "description": "Task title",
+          "minLength": 1
+        },
+        "description": {
+          "type": "string",
+          "description": "Optional detailed task description (supports Markdown)"
+        },
+        "assignee": {
+          "type": "string",
+          "description": "Optional task assignee"
+        },
+        "tags": {
+          "type": "array",
+          "description": "Optional task tags",
+          "items": {
+            "type": "string"
+          }
+        },
+        "priority": {
+          "type": "string",
+          "description": "Optional task priority",
+          "enum": [
+            "low",
+            "medium",
+            "high",
+            "critical"
+          ]
+        },
+        "effort": {
+          "type": "string",
+          "description": "Optional effort estimation for AI planning",
+          "enum": [
+            "trivial",
+            "small",
+            "medium",
+            "large",
+            "xlarge"
+          ]
+        },
+        "blockedBy": {
+          "type": "array",
+          "description": "Optional list of item IDs that block this task",
+          "items": {
+            "type": "string",
+            "pattern": "^[a-z][a-z0-9]*-[0-9]+$"
+          }
+        },
+        "parentId": {
+          "type": "string",
+          "description": "Optional parent task/document ID for first-class parent-child linking",
+          "pattern": "^[a-z][a-z0-9]*-[0-9]+$"
+        },
+        "dueDate": {
+          "type": "string",
+          "description": "Optional due date in ISO 8601 format",
+          "format": "date"
+        },
+        "createdAt": {
+          "$ref": "https://brainfile.md/v1/base.json#/definitions/timestamp",
+          "description": "When the task was created"
+        },
+        "updatedAt": {
+          "$ref": "https://brainfile.md/v1/base.json#/definitions/timestamp",
+          "description": "When the task was last updated"
+        },
+        "relatedFiles": {
+          "type": "array",
+          "description": "Optional list of related file paths or code locations",
+          "items": {
+            "type": "string"
+          }
+        },
+        "subtasks": {
+          "type": "array",
+          "description": "Optional list of subtasks for tracking granular progress",
+          "items": {
+            "$ref": "#/definitions/subtask"
+          }
+        },
+        "template": {
+          "type": "string",
+          "description": "Optional task template type",
+          "enum": [
+            "bug",
+            "feature",
+            "refactor"
+          ]
+        },
+        "contract": {
+          "$ref": "https://brainfile.md/v1/contract.json"
+        }
+      },
+      "additionalProperties": true
+    },
+    "subtask": {
+      "type": "object",
+      "required": [
+        "id",
+        "title",
+        "completed"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Unique subtask identifier, typically 'task-N-M' pattern",
+          "minLength": 1
+        },
+        "title": {
+          "type": "string",
+          "description": "Subtask title",
+          "minLength": 1
+        },
+        "completed": {
+          "type": "boolean",
+          "description": "Whether the subtask is completed"
+        }
+      },
+      "additionalProperties": true
+    }
+  }
+}

package/dist/tui/BrainfileTUI.d.ts

@@ -0,0 +1,4 @@
+import React from 'react';
+import type { TUIProps } from './types.js';
+export declare function BrainfileTUI({ filePath }: TUIProps): React.JSX.Element;
+//# sourceMappingURL=BrainfileTUI.d.ts.map

package/dist/tui/BrainfileTUI.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BrainfileTUI.d.ts","sourceRoot":"","sources":["../../src/tui/BrainfileTUI.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAuC,MAAM,OAAO,CAAC;AAK5D,OAAO,KAAK,EAAY,QAAQ,EAAc,MAAM,YAAY,CAAC;AA0DjE,wBAAgB,YAAY,CAAC,EAAE,QAAQ,EAAE,EAAE,QAAQ,qBAiXlD"}