@akanjs/cli 3.0.0-beta.17 → 3.0.0-beta.19

package/guidelines/docPageRule/docPageRule.generate.json

@@ -1,31 +0,0 @@
-{
-  "title": "Docs Page Rule",
-  "description": "Docs page writing rules",
-  "group": "core",
-  "docsSource": "apps/akan/page/(docs)/cheatsheet/dev/docs.tsx",
-  "codegenPriority": 3,
-  "deprecated": false,
-  "scans": [
-    {
-      "type": "docs",
-      "description": "Current docs source for Docs Page Rule",
-      "path": "apps/akan/page/(docs)/cheatsheet/dev/docs.tsx"
-    },
-    {
-      "type": "example",
-      "description": "Existing Akan implementation examples",
-      "path": "{apps,libs}/*/lib/**/*.ts",
-      "sample": 4
-    }
-  ],
-  "update": {
-    "filePath": "./docPageRule.instruction.md",
-    "contents": ["purpose", "file ownership", "current API patterns", "codegen rules", "validation checklist"],
-    "rules": [
-      "Use current Akan APIs only",
-      "Keep output parseable for codegen",
-      "Include ownership boundaries and review checklist"
-    ]
-  },
-  "page": "apps/akan/page/(docs)/cheatsheet/dev/docs.tsx"
-}

package/guidelines/docPageRule/docPageRule.instruction.md

@@ -1,25 +0,0 @@
-# Docs Page Rule Guideline
-
-## Purpose
-Use this when generating or updating Akan docs pages under the current docs route tree.
-
-## Ownership
-- Docs pages live under `apps/akan/page/(docs)`.
-- Pages use `Docs`, `Code`, `Scroll`, and app localization helpers used by nearby pages.
-- A docs page should teach one concept with examples, alerts, and navigation anchors.
-
-## Current Akan Patterns
-- Use current route groups: docs, conventions, references, cheatsheet, and plugins.
-- Prefer concise sections with code snippets and practical rules.
-- Use Mermaid only when it clarifies architecture or flow.
-
-## Codegen Rules
-- Do not write docs for removed route paths.
-- Do not generate placeholder pages when source docs already exist.
-- Do not include implementation claims that are not backed by code or nearby docs.
-
-## Review Checklist
-- The instruction points to current docs pages, not removed docs routes.
-- Generated examples use current Akan builder APIs and scanner-friendly filenames.
-- The output contract tells the model which file paths to return.
-- The guide avoids broad framework essays when a concrete file rule is better.

package/guidelines/docSyncRule/docSyncRule.generate.json

@@ -1,31 +0,0 @@
-{
-  "title": "Docs Sync Rule",
-  "description": "Docs to guideline sync rules",
-  "group": "core",
-  "docsSource": "apps/akan/page/(docs)/docs/_index.tsx",
-  "codegenPriority": 3,
-  "deprecated": false,
-  "scans": [
-    {
-      "type": "docs",
-      "description": "Current docs source for Docs Sync Rule",
-      "path": "apps/akan/page/(docs)/docs/_index.tsx"
-    },
-    {
-      "type": "example",
-      "description": "Existing Akan implementation examples",
-      "path": "{apps,libs}/*/lib/**/*.ts",
-      "sample": 4
-    }
-  ],
-  "update": {
-    "filePath": "./docSyncRule.instruction.md",
-    "contents": ["purpose", "file ownership", "current API patterns", "codegen rules", "validation checklist"],
-    "rules": [
-      "Use current Akan APIs only",
-      "Keep output parseable for codegen",
-      "Include ownership boundaries and review checklist"
-    ]
-  },
-  "page": "apps/akan/page/(docs)/docs/_index.tsx"
-}

package/guidelines/docSyncRule/docSyncRule.instruction.md

@@ -1,25 +0,0 @@
-# Docs To Guideline Sync Rule
-
-## Purpose
-Use this when applying current docs page information back into guideline instruction files.
-
-## Ownership
-- Docs pages are the source of truth for product-facing explanations.
-- Guideline instructions are compressed operational rules for AI codegen.
-- Sync should preserve codegen-specific output contracts and validation rules that docs pages may not mention.
-
-## Current Akan Patterns
-- Extract ownership boundaries, API names, file paths, examples, and warnings from docs pages.
-- Convert long explanatory sections into prompt-friendly bullet rules.
-- Keep docs links or source paths in `generate.json` metadata.
-
-## Codegen Rules
-- Do not copy large TSX page content directly into markdown instructions.
-- Do not remove codegen output format requirements during sync.
-- Do not let stale instruction examples override newer docs examples.
-
-## Review Checklist
-- The instruction points to current docs pages, not removed docs routes.
-- Generated examples use current Akan builder APIs and scanner-friendly filenames.
-- The output contract tells the model which file paths to return.
-- The guide avoids broad framework essays when a concrete file rule is better.

package/guidelines/enumConstant/enumConstant.generate.json

@@ -1,31 +0,0 @@
-{
-  "title": "Enum Constant",
-  "description": "enumOf category value rules",
-  "group": "core",
-  "docsSource": "apps/akan/page/(docs)/conventions/module/constant.tsx",
-  "codegenPriority": 2,
-  "deprecated": false,
-  "scans": [
-    {
-      "type": "docs",
-      "description": "Current docs source for Enum Constant",
-      "path": "apps/akan/page/(docs)/conventions/module/constant.tsx"
-    },
-    {
-      "type": "example",
-      "description": "Existing Akan implementation examples",
-      "path": "{apps,libs}/*/lib/**/*.ts",
-      "sample": 4
-    }
-  ],
-  "update": {
-    "filePath": "./enumConstant.instruction.md",
-    "contents": ["purpose", "file ownership", "current API patterns", "codegen rules", "validation checklist"],
-    "rules": [
-      "Use current Akan APIs only",
-      "Keep output parseable for codegen",
-      "Include ownership boundaries and review checklist"
-    ]
-  },
-  "page": "apps/akan/page/(docs)/conventions/module/constant.tsx"
-}

package/guidelines/enumConstant/enumConstant.instruction.md

@@ -1,28 +0,0 @@
-# enumOf Guideline
-
-## Purpose
-Use enum classes for categorical values that need type safety, defaults, dictionary entries, and stable API values.
-
-## Ownership
-- Define enum classes near the constant or scalar that owns the category.
-- Use camelCase values that are stable API/storage values.
-- Export the enum class so constants, dictionaries, UI, service, and signal can share it.
-- Provide dictionary entries for each public enum value and description.
-
-## Current Akan Patterns
-- Use enums for status, role, type, mode, channel, lifecycle, and similar finite sets.
-- Use boolean fields only when there are exactly two stable states and labels are obvious.
-- Use string fields only when the value is open-ended or user-defined.
-- Keep enum names domain-specific enough to avoid collisions.
-
-## Codegen Rules
-- Do not generate plain string unions when enum dictionary coverage is needed.
-- Do not rename stored enum values casually; persisted data may depend on them.
-- Do not add unused enum values just for hypothetical future UI.
-- Do not mix display labels into stored enum values.
-
-## Review Checklist
-- The instruction points to current docs pages, not removed docs routes.
-- Generated examples use current Akan builder APIs and scanner-friendly filenames.
-- The output contract tells the model which file paths to return.
-- The guide avoids broad framework essays when a concrete file rule is better.

package/guidelines/fieldRule/fieldRule.generate.json

@@ -1,31 +0,0 @@
-{
-  "title": "Field Rule",
-  "description": "Current via field helper rules",
-  "group": "core",
-  "docsSource": "apps/akan/page/(docs)/conventions/module/constant.tsx",
-  "codegenPriority": 1,
-  "deprecated": false,
-  "scans": [
-    {
-      "type": "docs",
-      "description": "Current docs source for Field Rule",
-      "path": "apps/akan/page/(docs)/conventions/module/constant.tsx"
-    },
-    {
-      "type": "example",
-      "description": "Existing Akan implementation examples",
-      "path": "{apps,libs}/*/lib/**/*.ts",
-      "sample": 4
-    }
-  ],
-  "update": {
-    "filePath": "./fieldRule.instruction.md",
-    "contents": ["purpose", "file ownership", "current API patterns", "codegen rules", "validation checklist"],
-    "rules": [
-      "Use current Akan APIs only",
-      "Keep output parseable for codegen",
-      "Include ownership boundaries and review checklist"
-    ]
-  },
-  "page": "apps/akan/page/(docs)/conventions/module/constant.tsx"
-}

package/guidelines/framework/framework.generate.json

@@ -1,32 +0,0 @@
-{
-  "title": "Akan.js Framework",
-  "description": "Compact global context for Akan AI codegen",
-  "group": "core",
-  "docsSource": "apps/akan/page/(docs)/docs/intro/fundamentals.tsx",
-  "codegenPriority": 1,
-  "deprecated": false,
-  "scans": [
-    {
-      "type": "docs",
-      "description": "Current docs source for Akan.js Framework",
-      "path": "apps/akan/page/(docs)/docs/intro/fundamentals.tsx"
-    },
-    {
-      "type": "example",
-      "description": "Existing Akan implementation examples",
-      "path": "{apps,libs}/*/lib/**/*.ts",
-      "sample": 4
-    }
-  ],
-  "update": {
-    "filePath": "./framework.instruction.md",
-    "contents": ["file ownership", "current API patterns", "codegen rules", "theming and UI customization"],
-    "rules": [
-      "Use current Akan APIs only",
-      "Keep output parseable for codegen",
-      "Include ownership boundaries",
-      "Carry no meta about this document itself — it renders into every workspace's always-loaded AGENTS.md"
-    ]
-  },
-  "page": "apps/akan/page/(docs)/docs/intro/fundamentals.tsx"
-}

package/guidelines/mcpRule/mcpRule.generate.json

@@ -1,35 +0,0 @@
-{
-  "title": "MCP Exposure Rule",
-  "description": "How Akan signals reach AI agents over MCP — guard-derived exposure, refusals, prompts, and resources",
-  "group": "core",
-  "codegenPriority": 4,
-  "deprecated": false,
-  "scans": [
-    {
-      "type": "example",
-      "description": "Signal files whose slices and endpoints declare the guards MCP exposure is derived from",
-      "path": "{apps,libs}/*/lib/*/*.signal.ts",
-      "sample": 4
-    }
-  ],
-  "update": {
-    "filePath": "./mcpRule.instruction.md",
-    "contents": [
-      "exposure rule",
-      "configuration",
-      "declaring endpoints",
-      "refusals and wire behaviour",
-      "prompts",
-      "rolling out to an app",
-      "choosing what to open",
-      "writing instructions",
-      "verifying an app"
-    ],
-    "rules": [
-      "Use current Akan APIs only",
-      "State the rule before the reason, and keep the reason to one clause",
-      "Name the env spelling beside every option field",
-      "Keep it workspace-neutral — no app or repo names"
-    ]
-  }
-}

package/guidelines/modelConstant/modelConstant.generate.json

@@ -1,32 +0,0 @@
-{
-  "title": "Model Constant",
-  "description": "Module constant generation rules",
-  "group": "module",
-  "docsSource": "apps/akan/page/(docs)/conventions/module/constant.tsx",
-  "codegenPriority": 1,
-  "deprecated": false,
-  "scans": [
-    {
-      "type": "docs",
-      "description": "Current docs source for Model Constant",
-      "path": "apps/akan/page/(docs)/conventions/module/constant.tsx"
-    },
-    {
-      "type": "example",
-      "description": "Existing Akan implementation examples",
-      "path": "{apps,libs}/*/lib/**/*.ts",
-      "sample": 4
-    }
-  ],
-  "update": {
-    "filePath": "./modelConstant.instruction.md",
-    "contents": ["purpose", "file ownership", "current API patterns", "codegen rules", "validation checklist"],
-    "rules": [
-      "Use current Akan APIs only",
-      "Use double quotes for all string literals in TypeScript code",
-      "Keep output parseable for codegen",
-      "Include ownership boundaries and review checklist"
-    ]
-  },
-  "page": "apps/akan/page/(docs)/conventions/module/constant.tsx"
-}

package/guidelines/modelDictionary/modelDictionary.generate.json

@@ -1,32 +0,0 @@
-{
-  "title": "Model Dictionary",
-  "description": "Module dictionary generation rules",
-  "group": "module",
-  "docsSource": "apps/akan/page/(docs)/conventions/module/dictionary.tsx",
-  "codegenPriority": 1,
-  "deprecated": false,
-  "scans": [
-    {
-      "type": "docs",
-      "description": "Current docs source for Model Dictionary",
-      "path": "apps/akan/page/(docs)/conventions/module/dictionary.tsx"
-    },
-    {
-      "type": "example",
-      "description": "Existing Akan implementation examples",
-      "path": "{apps,libs}/*/lib/**/*.ts",
-      "sample": 4
-    }
-  ],
-  "update": {
-    "filePath": "./modelDictionary.instruction.md",
-    "contents": ["purpose", "file ownership", "current API patterns", "codegen rules", "validation checklist"],
-    "rules": [
-      "Use current Akan APIs only",
-      "Use double quotes for all string literals in TypeScript code",
-      "Keep output parseable for codegen",
-      "Include ownership boundaries and review checklist"
-    ]
-  },
-  "page": "apps/akan/page/(docs)/conventions/module/dictionary.tsx"
-}

package/guidelines/modelDocument/modelDocument.generate.json

@@ -1,31 +0,0 @@
-{
-  "title": "Model Document",
-  "description": "Module persistence generation rules",
-  "group": "module",
-  "docsSource": "apps/akan/page/(docs)/conventions/module/document.tsx",
-  "codegenPriority": 1,
-  "deprecated": false,
-  "scans": [
-    {
-      "type": "docs",
-      "description": "Current docs source for Model Document",
-      "path": "apps/akan/page/(docs)/conventions/module/document.tsx"
-    },
-    {
-      "type": "example",
-      "description": "Existing Akan implementation examples",
-      "path": "{apps,libs}/*/lib/**/*.ts",
-      "sample": 4
-    }
-  ],
-  "update": {
-    "filePath": "./modelDocument.instruction.md",
-    "contents": ["purpose", "file ownership", "current API patterns", "codegen rules", "validation checklist"],
-    "rules": [
-      "Use current Akan APIs only",
-      "Keep output parseable for codegen",
-      "Include ownership boundaries and review checklist"
-    ]
-  },
-  "page": "apps/akan/page/(docs)/conventions/module/document.tsx"
-}

package/guidelines/modelService/modelService.generate.json

@@ -1,31 +0,0 @@
-{
-  "title": "Model Service",
-  "description": "Module service generation rules",
-  "group": "module",
-  "docsSource": "apps/akan/page/(docs)/conventions/module/service.tsx",
-  "codegenPriority": 2,
-  "deprecated": false,
-  "scans": [
-    {
-      "type": "docs",
-      "description": "Current docs source for Model Service",
-      "path": "apps/akan/page/(docs)/conventions/module/service.tsx"
-    },
-    {
-      "type": "example",
-      "description": "Existing Akan implementation examples",
-      "path": "{apps,libs}/*/lib/**/*.ts",
-      "sample": 4
-    }
-  ],
-  "update": {
-    "filePath": "./modelService.instruction.md",
-    "contents": ["purpose", "file ownership", "current API patterns", "codegen rules", "validation checklist"],
-    "rules": [
-      "Use current Akan APIs only",
-      "Keep output parseable for codegen",
-      "Include ownership boundaries and review checklist"
-    ]
-  },
-  "page": "apps/akan/page/(docs)/conventions/module/service.tsx"
-}

package/guidelines/modelSignal/modelSignal.generate.json

@@ -1,31 +0,0 @@
-{
-  "title": "Model Signal",
-  "description": "Module signal generation rules",
-  "group": "module",
-  "docsSource": "apps/akan/page/(docs)/conventions/module/signal.tsx",
-  "codegenPriority": 2,
-  "deprecated": false,
-  "scans": [
-    {
-      "type": "docs",
-      "description": "Current docs source for Model Signal",
-      "path": "apps/akan/page/(docs)/conventions/module/signal.tsx"
-    },
-    {
-      "type": "example",
-      "description": "Existing Akan implementation examples",
-      "path": "{apps,libs}/*/lib/**/*.ts",
-      "sample": 4
-    }
-  ],
-  "update": {
-    "filePath": "./modelSignal.instruction.md",
-    "contents": ["purpose", "file ownership", "current API patterns", "codegen rules", "validation checklist"],
-    "rules": [
-      "Use current Akan APIs only",
-      "Keep output parseable for codegen",
-      "Include ownership boundaries and review checklist"
-    ]
-  },
-  "page": "apps/akan/page/(docs)/conventions/module/signal.tsx"
-}

package/guidelines/modelStore/modelStore.generate.json

@@ -1,31 +0,0 @@
-{
-  "title": "Model Store",
-  "description": "Module store generation rules",
-  "group": "module",
-  "docsSource": "apps/akan/page/(docs)/conventions/module/store.tsx",
-  "codegenPriority": 2,
-  "deprecated": false,
-  "scans": [
-    {
-      "type": "docs",
-      "description": "Current docs source for Model Store",
-      "path": "apps/akan/page/(docs)/conventions/module/store.tsx"
-    },
-    {
-      "type": "example",
-      "description": "Existing Akan implementation examples",
-      "path": "{apps,libs}/*/lib/**/*.ts",
-      "sample": 4
-    }
-  ],
-  "update": {
-    "filePath": "./modelStore.instruction.md",
-    "contents": ["purpose", "file ownership", "current API patterns", "codegen rules", "validation checklist"],
-    "rules": [
-      "Use current Akan APIs only",
-      "Keep output parseable for codegen",
-      "Include ownership boundaries and review checklist"
-    ]
-  },
-  "page": "apps/akan/page/(docs)/conventions/module/store.tsx"
-}

package/guidelines/modelTemplate/modelTemplate.generate.json

@@ -1,31 +0,0 @@
-{
-  "title": "Model Template",
-  "description": "Module form UI generation rules",
-  "group": "module",
-  "docsSource": "apps/akan/page/(docs)/conventions/module/template.tsx",
-  "codegenPriority": 3,
-  "deprecated": false,
-  "scans": [
-    {
-      "type": "docs",
-      "description": "Current docs source for Model Template",
-      "path": "apps/akan/page/(docs)/conventions/module/template.tsx"
-    },
-    {
-      "type": "example",
-      "description": "Existing Akan implementation examples",
-      "path": "{apps,libs}/*/lib/**/*.ts",
-      "sample": 4
-    }
-  ],
-  "update": {
-    "filePath": "./modelTemplate.instruction.md",
-    "contents": ["purpose", "file ownership", "current API patterns", "codegen rules", "validation checklist"],
-    "rules": [
-      "Use current Akan APIs only",
-      "Keep output parseable for codegen",
-      "Include ownership boundaries and review checklist"
-    ]
-  },
-  "page": "apps/akan/page/(docs)/conventions/module/template.tsx"
-}

package/guidelines/modelUnit/modelUnit.generate.json

@@ -1,31 +0,0 @@
-{
-  "title": "Model Unit",
-  "description": "Module compact display UI rules",
-  "group": "module",
-  "docsSource": "apps/akan/page/(docs)/conventions/module/unit.tsx",
-  "codegenPriority": 3,
-  "deprecated": false,
-  "scans": [
-    {
-      "type": "docs",
-      "description": "Current docs source for Model Unit",
-      "path": "apps/akan/page/(docs)/conventions/module/unit.tsx"
-    },
-    {
-      "type": "example",
-      "description": "Existing Akan implementation examples",
-      "path": "{apps,libs}/*/lib/**/*.ts",
-      "sample": 4
-    }
-  ],
-  "update": {
-    "filePath": "./modelUnit.instruction.md",
-    "contents": ["purpose", "file ownership", "current API patterns", "codegen rules", "validation checklist"],
-    "rules": [
-      "Use current Akan APIs only",
-      "Keep output parseable for codegen",
-      "Include ownership boundaries and review checklist"
-    ]
-  },
-  "page": "apps/akan/page/(docs)/conventions/module/unit.tsx"
-}

package/guidelines/modelUtil/modelUtil.generate.json

@@ -1,31 +0,0 @@
-{
-  "title": "Model Util",
-  "description": "Module utility UI rules",
-  "group": "module",
-  "docsSource": "apps/akan/page/(docs)/conventions/module/util.tsx",
-  "codegenPriority": 3,
-  "deprecated": false,
-  "scans": [
-    {
-      "type": "docs",
-      "description": "Current docs source for Model Util",
-      "path": "apps/akan/page/(docs)/conventions/module/util.tsx"
-    },
-    {
-      "type": "example",
-      "description": "Existing Akan implementation examples",
-      "path": "{apps,libs}/*/lib/**/*.ts",
-      "sample": 4
-    }
-  ],
-  "update": {
-    "filePath": "./modelUtil.instruction.md",
-    "contents": ["purpose", "file ownership", "current API patterns", "codegen rules", "validation checklist"],
-    "rules": [
-      "Use current Akan APIs only",
-      "Keep output parseable for codegen",
-      "Include ownership boundaries and review checklist"
-    ]
-  },
-  "page": "apps/akan/page/(docs)/conventions/module/util.tsx"
-}

package/guidelines/modelView/modelView.generate.json

@@ -1,31 +0,0 @@
-{
-  "title": "Model View",
-  "description": "Module full detail UI rules",
-  "group": "module",
-  "docsSource": "apps/akan/page/(docs)/conventions/module/view.tsx",
-  "codegenPriority": 3,
-  "deprecated": false,
-  "scans": [
-    {
-      "type": "docs",
-      "description": "Current docs source for Model View",
-      "path": "apps/akan/page/(docs)/conventions/module/view.tsx"
-    },
-    {
-      "type": "example",
-      "description": "Existing Akan implementation examples",
-      "path": "{apps,libs}/*/lib/**/*.ts",
-      "sample": 4
-    }
-  ],
-  "update": {
-    "filePath": "./modelView.instruction.md",
-    "contents": ["purpose", "file ownership", "current API patterns", "codegen rules", "validation checklist"],
-    "rules": [
-      "Use current Akan APIs only",
-      "Keep output parseable for codegen",
-      "Include ownership boundaries and review checklist"
-    ]
-  },
-  "page": "apps/akan/page/(docs)/conventions/module/view.tsx"
-}

package/guidelines/modelZone/modelZone.generate.json

@@ -1,31 +0,0 @@
-{
-  "title": "Model Zone",
-  "description": "Module page section UI rules",
-  "group": "module",
-  "docsSource": "apps/akan/page/(docs)/conventions/module/zone.tsx",
-  "codegenPriority": 3,
-  "deprecated": false,
-  "scans": [
-    {
-      "type": "docs",
-      "description": "Current docs source for Model Zone",
-      "path": "apps/akan/page/(docs)/conventions/module/zone.tsx"
-    },
-    {
-      "type": "example",
-      "description": "Existing Akan implementation examples",
-      "path": "{apps,libs}/*/lib/**/*.ts",
-      "sample": 4
-    }
-  ],
-  "update": {
-    "filePath": "./modelZone.instruction.md",
-    "contents": ["purpose", "file ownership", "current API patterns", "codegen rules", "validation checklist"],
-    "rules": [
-      "Use current Akan APIs only",
-      "Keep output parseable for codegen",
-      "Include ownership boundaries and review checklist"
-    ]
-  },
-  "page": "apps/akan/page/(docs)/conventions/module/zone.tsx"
-}