@akanjs/cli 3.0.0-beta.2 → 3.0.0-beta.20

package/guidelines/moduleCodegen/moduleCodegen.generate.json

@@ -1,31 +0,0 @@
-{
-  "title": "Module Codegen",
-  "description": "AI module generation orchestration",
-  "group": "module",
-  "docsSource": "apps/akan/page/(docs)/conventions/module/overview.tsx",
-  "codegenPriority": 1,
-  "deprecated": false,
-  "scans": [
-    {
-      "type": "docs",
-      "description": "Current docs source for Module Codegen",
-      "path": "apps/akan/page/(docs)/conventions/module/overview.tsx"
-    },
-    {
-      "type": "example",
-      "description": "Existing Akan implementation examples",
-      "path": "{apps,libs}/*/lib/**/*.ts",
-      "sample": 4
-    }
-  ],
-  "update": {
-    "filePath": "./moduleCodegen.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/overview.tsx"
-}

package/guidelines/moduleCodegen/moduleCodegen.instruction.md

@@ -1,28 +0,0 @@
-# Module Codegen Orchestration Guideline
-
-## Purpose
-Use this to orchestrate AI-assisted module creation. The model should emit small, parseable file blocks and preserve Akan ownership boundaries.
-
-## Ownership
-- Input description explains the business object, lifecycle, actions, queries, UI needs, and relations.
-- The first output pass should prioritize data shape and persistence over decorative UI.
-- Each returned code block must start with `// File: <relative path>` so `AiSession.writeTypescripts()` can parse it.
-- Generated files must target `lib/<model>/...` or `lib/__scalar/<scalar>/...` only unless explicitly requested.
-
-## Current Akan Patterns
-- Phase 1: generate or update `model.constant.ts`, `model.dictionary.ts`, and `model.document.ts`.
-- Phase 2: generate service, signal, and store only when there are business workflows or page-callable actions.
-- Phase 3: generate UI files only after store/signal data flow is known.
-- Use docs-backed examples from the current app and connected libs before inventing patterns.
-
-## Codegen Rules
-- Return only file blocks for writes, plus no prose in codegen responses unless explicitly requested.
-- Prefer conservative defaults: one useful query, one insight only if analytics are requested, and minimal UI variants.
-- Avoid broad abstractions; create helper functions only when they remove clear duplication inside the target module.
-- When unsure whether a value should be scalar or module, choose scalar for embedded value objects and module for independent lifecycle or permissions.
-
-## 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/moduleOverview/moduleOverview.generate.json

@@ -1,31 +0,0 @@
-{
-  "title": "Module Overview",
-  "description": "Module file roles and growth order",
-  "group": "core",
-  "docsSource": "apps/akan/page/(docs)/conventions/module/overview.tsx",
-  "codegenPriority": 1,
-  "deprecated": false,
-  "scans": [
-    {
-      "type": "docs",
-      "description": "Current docs source for Module Overview",
-      "path": "apps/akan/page/(docs)/conventions/module/overview.tsx"
-    },
-    {
-      "type": "example",
-      "description": "Existing Akan implementation examples",
-      "path": "{apps,libs}/*/lib/**/*.ts",
-      "sample": 4
-    }
-  ],
-  "update": {
-    "filePath": "./moduleOverview.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/overview.tsx"
-}

package/guidelines/queryRule/queryRule.generate.json

@@ -1,31 +0,0 @@
-{
-  "title": "Query Rule",
-  "description": "Akan data access — filters, slices and hydration, full-text search, and cascade removal",
-  "group": "core",
-  "codegenPriority": 4,
-  "deprecated": false,
-  "scans": [
-    {
-      "type": "example",
-      "description": "Filter and model declarations that drive the generated query surface",
-      "path": "{apps,libs}/*/lib/*/*.document.ts",
-      "sample": 4
-    },
-    {
-      "type": "example",
-      "description": "Slice declarations that expose a query to a client store",
-      "path": "{apps,libs}/*/lib/*/*.signal.ts",
-      "sample": 4
-    }
-  ],
-  "update": {
-    "filePath": "./queryRule.instruction.md",
-    "contents": ["slices and hydration", "generated filter methods", "text search", "cascade removal"],
-    "rules": [
-      "Use current Akan APIs only",
-      "State the rule and the reason it exists, never restate a type signature",
-      "Say which generated methods fire hooks and which do not",
-      "Keep it workspace-neutral — no app or repo names"
-    ]
-  }
-}

package/guidelines/recipeRule/recipeRule.generate.json

@@ -1,31 +0,0 @@
-{
-  "title": "Recipe Rule",
-  "description": "Akan UI recipe authoring and consumption rules (reusable-look layer)",
-  "group": "core",
-  "docsSource": "apps/akan/page/(docs)/docs/arch/ui-recipe.tsx",
-  "codegenPriority": 3,
-  "deprecated": false,
-  "scans": [
-    {
-      "type": "docs",
-      "description": "Current docs source for Recipe Rule",
-      "path": "apps/akan/page/(docs)/docs/arch/ui-recipe.tsx"
-    },
-    {
-      "type": "example",
-      "description": "Existing recipe definitions",
-      "path": "{apps,libs}/*/ui/Recipe/*.ts",
-      "sample": 4
-    }
-  ],
-  "update": {
-    "filePath": "./recipeRule.instruction.md",
-    "contents": ["purpose", "ownership", "consuming", "authoring", "codegen rules", "review checklist"],
-    "rules": [
-      "Use current Akan APIs only",
-      "Keep output parseable for codegen",
-      "Include ownership boundaries and review checklist"
-    ]
-  },
-  "page": "apps/akan/page/(docs)/docs/arch/ui-recipe.tsx"
-}

package/guidelines/runtimeRule/runtimeRule.generate.json

@@ -1,25 +0,0 @@
-{
-  "title": "Runtime Rule",
-  "description": "Akan build and runtime surfaces — web/csr toggles, the gateway/solo process model, logging, the generated image, and shipped assets",
-  "group": "core",
-  "codegenPriority": 4,
-  "deprecated": false,
-  "scans": [
-    {
-      "type": "example",
-      "description": "App and lib runtime declarations",
-      "path": "{apps,libs}/*/akan.config.ts",
-      "sample": 4
-    }
-  ],
-  "update": {
-    "filePath": "./runtimeRule.instruction.md",
-    "contents": ["web surface toggles", "process model", "logging and live tail", "generated image", "shipped assets"],
-    "rules": [
-      "Use current Akan APIs only",
-      "State the rule and the reason it exists, never restate a type signature",
-      "Name the env that narrows a build-time declaration wherever one exists",
-      "Keep it workspace-neutral — no app or repo names"
-    ]
-  }
-}

package/guidelines/scalarConstant/scalarConstant.generate.json

@@ -1,32 +0,0 @@
-{
-  "title": "Scalar Constant",
-  "description": "Scalar constant generation rules",
-  "group": "scalar",
-  "docsSource": "apps/akan/page/(docs)/conventions/scalar/constant.tsx",
-  "codegenPriority": 1,
-  "deprecated": false,
-  "scans": [
-    {
-      "type": "docs",
-      "description": "Current docs source for Scalar Constant",
-      "path": "apps/akan/page/(docs)/conventions/scalar/constant.tsx"
-    },
-    {
-      "type": "example",
-      "description": "Existing Akan implementation examples",
-      "path": "{apps,libs}/*/lib/**/*.ts",
-      "sample": 4
-    }
-  ],
-  "update": {
-    "filePath": "./scalarConstant.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/scalar/constant.tsx"
-}

package/guidelines/scalarDictionary/scalarDictionary.generate.json

@@ -1,32 +0,0 @@
-{
-  "title": "Scalar Dictionary",
-  "description": "Scalar dictionary generation rules",
-  "group": "scalar",
-  "docsSource": "apps/akan/page/(docs)/conventions/scalar/dictionary.tsx",
-  "codegenPriority": 1,
-  "deprecated": false,
-  "scans": [
-    {
-      "type": "docs",
-      "description": "Current docs source for Scalar Dictionary",
-      "path": "apps/akan/page/(docs)/conventions/scalar/dictionary.tsx"
-    },
-    {
-      "type": "example",
-      "description": "Existing Akan implementation examples",
-      "path": "{apps,libs}/*/lib/**/*.ts",
-      "sample": 4
-    }
-  ],
-  "update": {
-    "filePath": "./scalarDictionary.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/scalar/dictionary.tsx"
-}

package/guidelines/scalarModule/scalarModule.generate.json

@@ -1,31 +0,0 @@
-{
-  "title": "Scalar Module",
-  "description": "Scalar module overview rules",
-  "group": "scalar",
-  "docsSource": "apps/akan/page/(docs)/conventions/scalar/overview.tsx",
-  "codegenPriority": 1,
-  "deprecated": false,
-  "scans": [
-    {
-      "type": "docs",
-      "description": "Current docs source for Scalar Module",
-      "path": "apps/akan/page/(docs)/conventions/scalar/overview.tsx"
-    },
-    {
-      "type": "example",
-      "description": "Existing Akan implementation examples",
-      "path": "{apps,libs}/*/lib/**/*.ts",
-      "sample": 4
-    }
-  ],
-  "update": {
-    "filePath": "./scalarModule.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/scalar/overview.tsx"
-}

package/guidelines/sharedUiUsage/sharedUiUsage.generate.json

@@ -1,31 +0,0 @@
-{
-  "title": "Shared UI Usage",
-  "description": "Shared UI usage rules",
-  "group": "core",
-  "docsSource": "apps/akan/page/(docs)/references/ui/overview.tsx",
-  "codegenPriority": 3,
-  "deprecated": false,
-  "scans": [
-    {
-      "type": "docs",
-      "description": "Current docs source for Shared UI Usage",
-      "path": "apps/akan/page/(docs)/references/ui/overview.tsx"
-    },
-    {
-      "type": "example",
-      "description": "Existing Akan implementation examples",
-      "path": "{apps,libs}/*/lib/**/*.ts",
-      "sample": 4
-    }
-  ],
-  "update": {
-    "filePath": "./sharedUiUsage.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)/references/ui/overview.tsx"
-}

package/guidelines/sharedUiUsage/sharedUiUsage.instruction.md

@@ -1,25 +0,0 @@
-# Shared UI Usage Guideline
-
-## Purpose
-Use shared UI components when building app or module UI that should stay consistent across products.
-
-## Ownership
-- Shared UI components provide reusable display, form, overlay, and layout primitives.
-- Prefer documented props and local examples before inventing new wrappers.
-- Shared UI should remain domain-neutral.
-
-## Current Akan Patterns
-- Import from the project shared UI entrypoints already used nearby.
-- Wrap shared UI only when the module needs domain-specific labels or behavior.
-- Preserve accessibility and theming assumptions from the shared component.
-
-## Codegen Rules
-- Do not copy shared UI internals into module files.
-- Do not pass unsupported props.
-- Do not make shared UI depend on one app domain.
-
-## 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/ssrRule/ssrRule.generate.json

@@ -1,31 +0,0 @@
-{
-  "title": "SSR Rule",
-  "description": "Akan SSR-first rendering rules — keep JSX on the server and justify every client boundary",
-  "group": "core",
-  "codegenPriority": 3,
-  "deprecated": false,
-  "scans": [
-    {
-      "type": "example",
-      "description": "Client boundary shells that render server children untouched",
-      "path": "{apps,libs}/*/ui/**/*.tsx",
-      "sample": 4
-    },
-    {
-      "type": "example",
-      "description": "Module UI split across client Zone/Template/Util and server Unit/View",
-      "path": "{apps,libs}/*/lib/*/*.tsx",
-      "sample": 4
-    }
-  ],
-  "update": {
-    "filePath": "./ssrRule.instruction.md",
-    "contents": ["purpose", "when a client boundary is earned", "quality rules", "implementation playbook"],
-    "rules": [
-      "Use current Akan APIs only",
-      "Keep output parseable for codegen",
-      "Name the akan.ssr.* rule ids the quality scanner emits",
-      "Ground every pattern in a file that exists in the workspace"
-    ]
-  }
-}

package/guidelines/transportRule/transportRule.generate.json

@@ -1,31 +0,0 @@
-{
-  "title": "Transport Rule",
-  "description": "How a call reaches an Akan signal — guards across HTTP and websocket, socket identity and cleanup, binary pubsub frames, and mutation HTTP verbs",
-  "group": "core",
-  "codegenPriority": 4,
-  "deprecated": false,
-  "scans": [
-    {
-      "type": "example",
-      "description": "Guard classes and their scope markers",
-      "path": "{apps,libs}/*/srvkit/guards.ts",
-      "sample": 2
-    },
-    {
-      "type": "example",
-      "description": "Signal endpoints declaring guards, pubsub, and message handlers",
-      "path": "{apps,libs}/*/lib/*/*.signal.ts",
-      "sample": 4
-    }
-  ],
-  "update": {
-    "filePath": "./transportRule.instruction.md",
-    "contents": ["guards across transports", "signal body types", "binary pubsub", "mutation HTTP verbs"],
-    "rules": [
-      "Use current Akan APIs only",
-      "State the rule and the reason it exists, never restate a type signature",
-      "Say what leaks or breaks when a rule is ignored",
-      "Keep it workspace-neutral — no app or repo names"
-    ]
-  }
-}

package/guidelines/utilUiUsage/utilUiUsage.generate.json

@@ -1,31 +0,0 @@
-{
-  "title": "Util UI Usage",
-  "description": "Utility UI usage rules",
-  "group": "core",
-  "docsSource": "apps/akan/page/(docs)/references/ui/core.tsx",
-  "codegenPriority": 3,
-  "deprecated": false,
-  "scans": [
-    {
-      "type": "docs",
-      "description": "Current docs source for Util UI Usage",
-      "path": "apps/akan/page/(docs)/references/ui/core.tsx"
-    },
-    {
-      "type": "example",
-      "description": "Existing Akan implementation examples",
-      "path": "{apps,libs}/*/lib/**/*.ts",
-      "sample": 4
-    }
-  ],
-  "update": {
-    "filePath": "./utilUiUsage.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)/references/ui/core.tsx"
-}

package/guidelines/utilUiUsage/utilUiUsage.instruction.md

@@ -1,25 +0,0 @@
-# Util UI Usage Guideline
-
-## Purpose
-Use utility UI components for common application interactions, layout helpers, scrolling, loading, and small display patterns.
-
-## Ownership
-- Utility UI is for cross-domain layout and interaction helpers.
-- Module-specific controls still belong in Model.Util.
-- Docs pages may use utility UI for scroll sections and navigation.
-
-## Current Akan Patterns
-- Prefer existing utility components before adding custom layout code.
-- Keep imported utility UI usage close to nearby docs and app examples.
-- Forward className and preserve composition.
-
-## Codegen Rules
-- Do not make utility UI carry model-specific business behavior.
-- Do not duplicate util components in each module.
-- Do not use utility components without checking expected props.
-
-## 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/workspaceOnboarding/workspaceOnboarding.generate.json

@@ -1,24 +0,0 @@
-{
-  "title": "Workspace Onboarding",
-  "description": "Product-workspace orientation — layout, decision matrix, workflow recipes, and query gotchas",
-  "group": "core",
-  "codegenPriority": 2,
-  "deprecated": false,
-  "scans": [],
-  "update": {
-    "filePath": "./workspaceOnboarding.instruction.md",
-    "contents": [
-      "workspace layout and generated files",
-      "agent workflow and common commands",
-      "where-do-I-put-this decision matrix",
-      "workflow recipes",
-      "modeling and query gotchas"
-    ],
-    "rules": [
-      "Use current Akan APIs only",
-      "Write for someone building a product on Akan, not for someone changing Akan",
-      "Refer to the app as <%= appName %>; the renderer substitutes the workspace's first app",
-      "Do not repeat a rule that the conventions guideline already states"
-    ]
-  }
-}

package/guidelines/workspaceRecipes/workspaceRecipes.generate.json

@@ -1,33 +0,0 @@
-{
-  "title": "Workspace Recipes",
-  "description": "Worked step-by-step recipes for common Akan changes, plus the auto-generated signal/service/store/document API reference",
-  "group": "core",
-  "codegenPriority": 5,
-  "deprecated": false,
-  "scans": [
-    {
-      "type": "example",
-      "description": "Module files a recipe walks through",
-      "path": "{apps,libs}/*/lib/*/*.{constant,document,service,signal,store}.ts",
-      "sample": 5
-    }
-  ],
-  "update": {
-    "filePath": "./workspaceRecipes.instruction.md",
-    "contents": [
-      "add a field",
-      "inject a dependency",
-      "create a slice",
-      "create a mutation",
-      "internal triggers",
-      "insights",
-      "auto-generated API reference"
-    ],
-    "rules": [
-      "Use current Akan APIs only",
-      "Every recipe names the files to edit and the order to edit them in",
-      "Keep the <%= appName %> placeholder so the rendered guide names this workspace's app",
-      "Never duplicate a rule that workspaceOnboarding already states — link to it instead"
-    ]
-  }
-}