@akanjs/cli 2.3.9-rc.0 → 2.3.9-rc.1

package/templates/workspaceRoot/docs/AI-DEVELOPMENT.md.template

@@ -0,0 +1,51 @@
+# AI Development Guide
+
+This workspace is an Akan.js project. Keep business intent in source files and let `akan sync` regenerate the
+repeated surfaces.
+
+## Domain Module Shape
+
+- `apps/<app>/lib/<model>` is for database-backed domain modules.
+- `apps/<app>/lib/_<service>` is for service modules without their own database document.
+- `apps/<app>/lib/__scalar/<scalar>` is for reusable embedded value shapes.
+- Put model behavior in the local module before creating a parallel architecture.
+
+## Data Flow
+
+Follow this order for domain changes:
+
+1. `constant` defines fields, enums, and model layers.
+2. `document` defines queries, filters, and document state transitions.
+3. `service` owns business workflows and orchestration.
+4. `signal` exposes typed endpoints, slices, and internal jobs.
+5. `store` owns reusable client workflow state and actions.
+6. UI files render forms, lists, details, and actions.
+
+## When To Run Sync
+
+Run this after adding, deleting, or renaming module, UI, webkit, srvkit, or common files:
+
+```bash
+akan sync <%= appName %>
+```
+
+Sync regenerates barrels such as `cnst.ts`, `db.ts`, `srv.ts`, `sig.ts`, `st.ts`, `useClient.ts`, `useServer.ts`,
+and module `index.ts` files. Without sync, imports can point at stale generated files.
+
+## Generated Files
+
+Do not hand-edit generated Akan files. Edit source files in the owning module and run sync or build instead.
+See `docs/GENERATED.md` for the generated file list.
+
+## Server And Client Boundary
+
+- Keep server-only APIs such as `fs`, `Bun`, secrets, database adaptors, and server env access out of client code.
+- Client surfaces include `ui/`, `webkit/`, `*.Template.tsx`, `*.Zone.tsx`, and `*.Util.tsx` files that use
+  `"use client"`.
+- Server-oriented surfaces include pages, `*.Unit.tsx`, `*.View.tsx`, `lib/`, `srvkit/`, and server entrypoints.
+- Treat `AKAN_PUBLIC_*` values as public.
+
+## Abstract Documents
+
+Update `*.abstract.md` when business invariants, workflows, user-visible behavior, cross-module relationships, or
+agent guidance changes. Do not update it for purely mechanical formatting or regenerated file changes.

package/templates/workspaceRoot/docs/GENERATED.md.template

@@ -0,0 +1,54 @@
+# Generated Akan Files
+
+These files are generated by `akan sync`, `akan start`, or `akan build`. Do not edit them by hand because the next
+sync or build can overwrite local changes.
+
+## App Entrypoints
+
+| File | Purpose |
+| --- | --- |
+| `apps/*/client.ts` | App-wide client entrypoint for generated fetch, store, and client runtime exports. |
+| `apps/*/server.ts` | App-wide server entrypoint for generated server, service, signal, database, and dictionary exports. |
+
+## App Library Barrels
+
+| File | Purpose |
+| --- | --- |
+| `apps/*/lib/cnst.ts` | Re-exports constants and model shapes from module `*.constant.ts` files. |
+| `apps/*/lib/db.ts` | Re-exports database models from module `*.document.ts` files. |
+| `apps/*/lib/dict.ts` | Re-exports dictionaries from module `*.dictionary.ts` files. |
+| `apps/*/lib/option.ts` | Re-exports generated option helpers. |
+| `apps/*/lib/srv.ts` | Re-exports services from module `*.service.ts` files. |
+| `apps/*/lib/sig.ts` | Re-exports endpoints, slices, and internals from module `*.signal.ts` files. |
+| `apps/*/lib/st.ts` | Re-exports stores from module `*.store.ts` files. |
+| `apps/*/lib/useClient.ts` | Client-safe generated imports for fetch, message, signal, and store usage. |
+| `apps/*/lib/useServer.ts` | Server-safe generated imports for service, database, signal, and dictionary usage. |
+| `apps/*/lib/**/index.ts` | Per-module generated barrel files. |
+
+## Shared Surface Barrels
+
+| File | Purpose |
+| --- | --- |
+| `*/ui/index.ts` | Re-exports UI component files. |
+| `*/webkit/index.ts` | Re-exports webkit/browser helper files. |
+| `*/srvkit/index.ts` | Re-exports server-kit helper files. |
+| `*/common/index.ts` | Re-exports common helper files. |
+
+## How To Change Generated Output
+
+1. Prefer `akan mcp --mode plan` to find an allowlisted workflow before editing files directly.
+2. If a workflow or repair tool exists, use `akan mcp --mode apply` for `apply_workflow`, `run_validation`, or
+   `repair_generated`.
+3. Edit the source file that owns the behavior, such as `task.constant.ts`, `task.document.ts`, `task.service.ts`,
+   `task.signal.ts`, or `task.store.ts`.
+4. Run:
+
+```bash
+akan sync <%= appName %>
+# or: akan repair generated --app <%= appName %>
+```
+
+5. Re-run the smallest relevant check, usually `akan test <%= appName %>`, `akan lint <%= appName %>`,
+   `akan doctor --strict`, or `akan build <%= appName %>`.
+
+If a generated file looks wrong, fix the source convention or sync input rather than patching the generated file.

package/templates/workspaceRoot/package.json.template

@@ -2,6 +2,15 @@
   "name": "<%= repoName %>",
   "description": "<%= repoName %> workspace",
   "version": "0.0.1",
+  "scripts": {
+    "sync": "akan sync",
+    "dev": "akan start",
+    "lint": "akan lint",
+    "typecheck": "akan typecheck",
+    "test": "akan test",
+    "setup:agent": "akan agent install all",
+    "build": "akan build"
+  },
   "dependencies": {},
   "devDependencies": {},
   "patchedDependencies": {

package/templates/workspaceRoot/Untitled

@@ -1 +0,0 @@
-android?: "auto" | "edge-to-edge" | "none";