@akanjs/cli 0.0.149 → 0.0.150

package/cjs/src/guidelines/modelSignal/modelSignal.generate.json

@@ -0,0 +1,202 @@
+{
+  "title": "Model Signal",
+  "description": "How to create and implement model.signal.ts files in Akan.js",
+  "scans": [
+    {
+      "type": "source",
+      "description": "Core signal implementation files",
+      "path": "pkgs/@akanjs/signal/src/*.ts"
+    },
+    {
+      "type": "source",
+      "description": "Signal decorator implementation",
+      "path": "pkgs/@akanjs/signal/src/decorator/*.ts"
+    },
+    {
+      "type": "source",
+      "description": "DbSignal and other signal higher-order functions",
+      "path": "pkgs/@akanjs/signal/src/function/*.ts"
+    },
+    {
+      "type": "source",
+      "description": "Signal helper functions (resolve, emit, done, subscribe)",
+      "path": "pkgs/@akanjs/signal/src/helper/*.ts"
+    },
+    {
+      "type": "source",
+      "description": "Signal converts to nestjs module",
+      "path": "pkgs/@akanjs/server/src/module.ts"
+    },
+    {
+      "type": "example",
+      "description": "Signal converts to nestjs controller",
+      "path": "pkgs/@akanjs/server/src/controller.ts"
+    },
+    {
+      "type": "example",
+      "description": "Signal converts to nestjs resolver",
+      "path": "pkgs/@akanjs/server/src/resolver.ts"
+    },
+    {
+      "type": "example",
+      "description": "Signal converts to nestjs processor",
+      "path": "pkgs/@akanjs/server/src/processor.ts"
+    },
+    {
+      "type": "example",
+      "description": "Signal converts to nestjs websocket",
+      "path": "pkgs/@akanjs/server/src/websocket.ts"
+    },
+    {
+      "type": "example",
+      "description": "DbSignal usage examples",
+      "path": "{apps,libs}/*/lib/*/*.signal.ts",
+      "filterText": "extends DbSignal",
+      "sample": 3
+    },
+    {
+      "type": "example",
+      "description": "@Query.Public decorator examples",
+      "path": "{apps,libs}/*/lib/*/*.signal.ts",
+      "filterText": "@Query.Public",
+      "sample": 2
+    },
+    {
+      "type": "example",
+      "description": "@Query.User decorator examples",
+      "path": "{apps,libs}/*/lib/*/*.signal.ts",
+      "filterText": "@Query.User",
+      "sample": 2
+    },
+    {
+      "type": "example",
+      "description": "@Query.Admin decorator examples",
+      "path": "{apps,libs}/*/lib/*/*.signal.ts",
+      "filterText": "@Query.Admin",
+      "sample": 2
+    },
+    {
+      "type": "example",
+      "description": "@Mutation.User decorator examples",
+      "path": "{apps,libs}/*/lib/*/*.signal.ts",
+      "filterText": "@Mutation.User",
+      "sample": 2
+    },
+    {
+      "type": "example",
+      "description": "@Mutation.Admin decorator examples",
+      "path": "{apps,libs}/*/lib/*/*.signal.ts",
+      "filterText": "@Mutation.Admin",
+      "sample": 2
+    },
+    {
+      "type": "example",
+      "description": "@Message decorator examples",
+      "path": "{apps,libs}/*/lib/*/*.signal.ts",
+      "filterText": "@Message",
+      "sample": 2
+    },
+    {
+      "type": "example",
+      "description": "@Process decorator examples",
+      "path": "{apps,libs}/*/lib/*/*.signal.ts",
+      "filterText": "@Process",
+      "sample": 2
+    },
+    {
+      "type": "example",
+      "description": "@Pubsub decorator examples",
+      "path": "{apps,libs}/*/lib/*/*.signal.ts",
+      "filterText": "@Pubsub",
+      "sample": 2
+    },
+    {
+      "type": "example",
+      "description": "How to create slice signals with modelListIn<SliceName>",
+      "path": "{apps,libs}/*/lib/*/*.signal.ts",
+      "filterText": "ListIn",
+      "sample": 3
+    },
+    {
+      "type": "example",
+      "description": "How to create slice insights with modelInsightIn<SliceName>",
+      "path": "{apps,libs}/*/lib/*/*.signal.ts",
+      "filterText": "InsightIn",
+      "sample": 3
+    },
+    {
+      "type": "example",
+      "description": "Complete real-time chat implementation",
+      "path": "libs/social/lib/chatRoom/chatRoom.signal.ts",
+      "sample": 1
+    },
+    {
+      "type": "example",
+      "description": "Background processing examples",
+      "path": "apps/akasys/lib/dbBackup/dbBackup.signal.ts",
+      "sample": 1
+    },
+    {
+      "type": "example",
+      "description": "Search functionality examples",
+      "path": "libs/util/lib/_search/search.signal.ts",
+      "sample": 1
+    },
+    {
+      "type": "example",
+      "description": "API argument decorators usage",
+      "path": "{apps,libs}/*/lib/*/*.signal.ts",
+      "filterText": "@Arg",
+      "sample": 4
+    },
+    {
+      "type": "example",
+      "description": "Examples of @Self() decorator usage",
+      "path": "{apps,libs}/*/lib/*/*.signal.ts",
+      "filterText": "@Self()",
+      "sample": 3
+    },
+    {
+      "type": "example",
+      "description": "Error handling in signals",
+      "path": "{apps,libs}/*/lib/*/*.signal.ts",
+      "filterText": "try {",
+      "sample": 2
+    },
+    {
+      "type": "example",
+      "description": "Client-side signal imports",
+      "path": "{apps,libs}/*/lib/*/*.store.ts",
+      "filterText": "import {",
+      "sample": 3
+    }
+  ],
+  "update": {
+    "filePath": "./modelSignal.instruction.md",
+    "contents": [
+      "Purpose and role of model.signal.ts files",
+      "Signal class structure and core components",
+      "@Signal decorator and Signal class definition",
+      "DbSignal and other higher-order functions",
+      "Endpoint decorators (@Query, @Mutation, @Message, @Process, @Pubsub)",
+      "Parameter decorators (@Arg.Query, @Arg.Param, @Arg.Body, @Self, etc.)",
+      "Return helper functions (resolve, emit, done, subscribe)",
+      "Slice pattern for data access (modelListIn<SliceName>, modelInsightIn<SliceName>)",
+      "Client-side signal usage (direct API calls, store integration)",
+      "React component integration with signals",
+      "Real-time communication with Message and Pubsub",
+      "Background processing with Process decorator",
+      "Advanced patterns and best practices",
+      "Troubleshooting and debugging tips",
+      "Type safety and code generation"
+    ],
+    "rules": [
+      "Signal should be pure JavaScript/TypeScript, and should not use any other libraries or frameworks. It is imported and converted from both server and client side.",
+      "Always use parameter decorators (@Arg.*) for all method parameters in signals.",
+      "Always use appropriate helper functions to return data (resolve, emit, done, subscribe).",
+      "Always specify explicit return types in decorators and helper functions.",
+      "Follow consistent naming conventions for signals, especially for slice methods."
+    ]
+  },
+  "page": "/[lang]/akanjs/(docs)/docs/module/signal/page.tsx"
+}

package/cjs/src/guidelines/modelStore/modelStore.generate.json

@@ -0,0 +1,130 @@
+{
+  "title": "Model Store",
+  "description": "How to create and implement model.store.ts files in Akan.js",
+  "scans": [
+    {
+      "type": "source",
+      "description": "Core store implementation",
+      "path": "pkgs/@akanjs/store/src/stateOf.ts"
+    },
+    {
+      "type": "source",
+      "description": "Store decorator implementation",
+      "path": "pkgs/@akanjs/store/src/Store.ts"
+    },
+    {
+      "type": "source",
+      "description": "Toast decorator implementation",
+      "path": "pkgs/@akanjs/store/src/Toast.ts"
+    },
+    {
+      "type": "source",
+      "description": "Store utility functions",
+      "path": "pkgs/@akanjs/store/src/makeStore.ts"
+    },
+    {
+      "type": "example",
+      "description": "Basic store implementation examples",
+      "path": "{apps,libs}/*/lib/*/*.store.ts",
+      "filterText": "@Store",
+      "sample": 5
+    },
+    {
+      "type": "example",
+      "description": "Store examples with custom actions",
+      "path": "{apps,libs}/*/lib/*/*.store.ts",
+      "filterText": "async",
+      "sample": 5
+    },
+    {
+      "type": "example",
+      "description": "Store examples with toast notifications",
+      "path": "{apps,libs}/*/lib/*/*.store.ts",
+      "filterText": "@Toast",
+      "sample": 3
+    },
+    {
+      "type": "example",
+      "description": "Complex state management examples",
+      "path": "{apps,libs}/*/lib/*/*.store.ts",
+      "filterText": "this.pick",
+      "sample": 3
+    },
+    {
+      "type": "example",
+      "description": "Store composition examples",
+      "path": "{apps,libs}/*/lib/store.ts",
+      "filterText": "MixStore",
+      "sample": 3
+    },
+    {
+      "type": "usage",
+      "description": "Store usage in forms (Template files)",
+      "path": "{apps,libs}/*/lib/*/*.Template.ts{,x}",
+      "filterText": "st.use.modelForm",
+      "sample": 3
+    },
+    {
+      "type": "usage",
+      "description": "Store form submission examples",
+      "path": "{apps,libs}/*/lib/*/*.Template.ts{,x}",
+      "filterText": "submitModel",
+      "sample": 3
+    },
+    {
+      "type": "usage",
+      "description": "Store list rendering examples",
+      "path": "{apps,libs}/*/lib/*/*.Zone.ts{,x}",
+      "filterText": "st.use.modelList",
+      "sample": 3
+    },
+    {
+      "type": "usage",
+      "description": "Store pagination examples",
+      "path": "{apps,libs}/*/lib/*/*.Zone.ts{,x}",
+      "filterText": "setPageOf",
+      "sample": 3
+    },
+    {
+      "type": "usage",
+      "description": "Store filtering examples",
+      "path": "{apps,libs}/*/lib/*/*.Util.ts{,x}",
+      "filterText": "setQueryArgsOf",
+      "sample": 3
+    },
+    {
+      "type": "usage",
+      "description": "Store slice initialization examples",
+      "path": "{apps,libs}/*/lib/*/*.{View,Zone}.ts{,x}",
+      "filterText": "initModelList",
+      "sample": 3
+    }
+  ],
+  "update": {
+    "filePath": "./modelStore.instruction.md",
+    "contents": [
+      "Purpose and role of model.store.ts files",
+      "Store architecture overview and integration with other framework components",
+      "Basic store implementation with Store decorator and stateOf",
+      "State management: base state, custom state, and accessing state",
+      "Store actions: core CRUD operations and custom business logic",
+      "Using slices for contextual list operations",
+      "Form management: state handling, field updates, and submission",
+      "Advanced patterns: store composition, cross-store operations, optimistic updates, real-time",
+      "Best practices for naming, state management, performance, error handling, and testing",
+      "Complete example with comprehensive implementation",
+      "File structure conventions"
+    ],
+    "rules": [
+      "Include diagrams showing store architecture",
+      "Provide real-world examples for all major concepts",
+      "Explain both simple and advanced usage patterns",
+      "Cover form handling in detail",
+      "Include error handling and loading state management",
+      "Explain the relationship with model.signal.ts and GraphQL operations",
+      "Include performance optimization techniques",
+      "Provide testing strategies for stores"
+    ]
+  },
+  "page": "/[lang]/akanjs/(docs)/docs/module/store/page.tsx"
+}

package/cjs/src/guidelines/modelTemplate/modelTemplate.generate.json

@@ -0,0 +1,104 @@
+{
+  "title": "Model Template",
+  "description": "How to create and implement Model.Template.ts files in Akan.js",
+  "scans": [
+    {
+      "type": "example",
+      "description": "Model Template examples",
+      "path": "{apps,libs}/*/lib/*/*.Template.ts{,x}",
+      "sample": 5
+    },
+    {
+      "type": "usage",
+      "description": "Model Template usage in pages",
+      "path": "apps/*/app/**/page.tsx",
+      "filterText": ".Template.",
+      "sample": 3
+    },
+    {
+      "type": "usage",
+      "description": "Model Template usage in Utils",
+      "path": "{apps,libs}/*/lib/*/*.Util.tsx",
+      "filterText": ".Template.",
+      "sample": 3
+    },
+    {
+      "type": "usage",
+      "description": "Model Template usage in Zones",
+      "path": "{apps,libs}/*/lib/*/*.Zone.tsx",
+      "filterText": ".Template.",
+      "sample": 3
+    },
+    {
+      "type": "reference",
+      "description": "Form Field components",
+      "path": "libs/shared/ui/Field.tsx",
+      "sample": 5
+    },
+    {
+      "type": "reference",
+      "description": "Form validation examples",
+      "path": "{apps,libs}/*/lib/**/*.Template.tsx",
+      "filterText": "validate",
+      "sample": 3
+    },
+    {
+      "type": "reference",
+      "description": "Store integration examples",
+      "path": "{apps,libs}/*/lib/**/*.store.ts",
+      "filterText": "Form",
+      "sample": 3
+    },
+    {
+      "type": "reference",
+      "description": "Internationalization with usePage",
+      "path": "{apps,libs}/*/lib/**/usePage.{ts,tsx}",
+      "sample": 1
+    },
+    {
+      "type": "reference",
+      "description": "Integration with Model.constant.ts",
+      "path": "{apps,libs}/*/lib/**/*.constant.ts",
+      "filterText": "@Model.Input",
+      "sample": 3
+    }
+  ],
+  "update": {
+    "filePath": "./modelTemplate.instruction.md",
+    "contents": [
+      "Purpose and role of Model.Template.tsx files",
+      "File location and naming conventions",
+      "Basic structure and component patterns",
+      "Integration with store state management",
+      "Field types and form components",
+      "Form validation approaches",
+      "Internationalization with usePage",
+      "Form layout patterns and best practices",
+      "Using templates in pages, utilities, and zones",
+      "State management and lifecycle methods",
+      "Performance optimization techniques",
+      "Accessibility considerations",
+      "Common patterns and reusable components",
+      "Form state integration with database models",
+      "Troubleshooting common issues",
+      "Integration with API calls and form submission"
+    ],
+    "rules": [
+      "Model.Template.tsx is a client component, so it should include 'use client' directive",
+      "Model.Template.tsx components should accept an optional id parameter to support both creation and editing",
+      "Use Form components from the Field namespace for consistent UI and validation",
+      "Always connect form state to Zustand store via st.use.[model]Form()",
+      "Update form state using st.do.set[Field]On[Model]() actions",
+      "Use usePage() hook for internationalization of labels and messages",
+      "Implement form validation at field level when possible",
+      "Reset form state on component unmount to prevent stale data",
+      "Split complex forms into smaller, focused components",
+      "Follow accessibility best practices for all form fields",
+      "Use consistent layout patterns across the application",
+      "Provide clear validation feedback and error messages",
+      "Initialize form data from API when editing existing models",
+      "Implement proper error handling for form submissions"
+    ]
+  },
+  "page": "/[lang]/akanjs/(docs)/docs/module/template/page.tsx"
+}

package/cjs/src/guidelines/modelUnit/modelUnit.generate.json

@@ -0,0 +1,92 @@
+{
+  "title": "Model Unit",
+  "description": "How to create and implement Model.Unit.tsx files in Akan.js",
+  "scans": [
+    {
+      "type": "example",
+      "description": "Model Unit examples",
+      "path": "{apps,libs}/*/lib/*/*.Unit.tsx",
+      "sample": 5
+    },
+    {
+      "type": "implementation",
+      "description": "Model Unit typical implementations",
+      "path": "{apps,libs}/*/lib/**/*.Unit.tsx",
+      "filterText": "export const Abstract",
+      "sample": 3
+    },
+    {
+      "type": "implementation",
+      "description": "Model Unit Card implementations",
+      "path": "{apps,libs}/*/lib/**/*.Unit.tsx",
+      "filterText": "export const Card",
+      "sample": 2
+    },
+    {
+      "type": "usage",
+      "description": "Model Unit usage in pages",
+      "path": "apps/*/app/**/page.tsx",
+      "filterText": ".Unit.",
+      "sample": 1
+    },
+    {
+      "type": "usage",
+      "description": "Model Unit usage in Utils",
+      "path": "{apps,libs}/*/lib/*/*.Util.tsx",
+      "filterText": ".Unit.",
+      "sample": 1
+    },
+    {
+      "type": "usage",
+      "description": "Model Unit usage in Templates",
+      "path": "{apps,libs}/*/lib/*/*.Template.tsx",
+      "filterText": ".Unit.",
+      "sample": 1
+    },
+    {
+      "type": "usage",
+      "description": "Model Unit usage in Zones",
+      "path": "{apps,libs}/*/lib/*/*.Zone.tsx",
+      "filterText": ".Unit.",
+      "sample": 3
+    },
+    {
+      "type": "reference",
+      "description": "Integration with database models",
+      "path": "{apps,libs}/*/lib/*/*.document.ts",
+      "sample": 1
+    },
+    {
+      "type": "reference",
+      "description": "Integration with model constants",
+      "path": "{apps,libs}/*/lib/*/*.constant.ts",
+      "sample": 1
+    }
+  ],
+  "update": {
+    "filePath": "./modelUnit.instruction.md",
+    "contents": [
+      "Purpose and role of Model.Unit.tsx files",
+      "How to create Model.Unit.tsx files",
+      "Common export patterns (Abstract, Card, Full, etc.)",
+      "Integration with LightModel types from constants",
+      "How to use Model.Unit.tsx files in pages",
+      "How to use Model.Unit.tsx files in Utils",
+      "How to use Model.Unit.tsx files in Zones",
+      "How to use Model.Unit.tsx files in Templates",
+      "Best practices for performance optimization",
+      "Common component patterns and variations"
+    ],
+    "rules": [
+      "Model.Unit.tsx is a server component, so it should not use client-side hooks like useEffect, useState, etc.",
+      "Model.Unit.tsx is a presentation component of cnst.LightModel to reuse in pages, Utils, Zones, and Templates, etc.",
+      "Always accept className prop for styling customization",
+      "Create multiple export variations (Abstract, Card, Full) for different use cases",
+      "Use semantic HTML and ensure accessibility",
+      "Focus on presentation only - do not include business logic",
+      "Include href prop for navigation when appropriate",
+      "Ensure proper image handling with the Image component from @util/ui"
+    ]
+  },
+  "page": "/[lang]/akanjs/(docs)/docs/module/unit/page.tsx"
+}

package/cjs/src/guidelines/modelUtil/modelUtil.generate.json

@@ -0,0 +1,93 @@
+{
+  "title": "Model Util",
+  "description": "How to create and implement Model.Util.ts files in Akan.js",
+  "scans": [
+    {
+      "type": "example",
+      "description": "Model Util examples",
+      "path": "{apps,libs}/*/lib/*/*.Util.ts{,x}",
+      "sample": 5
+    },
+    {
+      "type": "source",
+      "description": "Example of high-quality Model.Util implementation",
+      "path": "libs/shared/lib/admin/Admin.Util.tsx"
+    },
+    {
+      "type": "source",
+      "description": "Example of complex Model.Util implementation",
+      "path": "libs/shared/lib/user/User.Util.tsx"
+    },
+    {
+      "type": "usage",
+      "description": "Model Util usage in pages",
+      "path": "apps/*/app/**/page.tsx",
+      "filterText": ".Util.",
+      "sample": 3
+    },
+    {
+      "type": "usage",
+      "description": "Model Util usage in Units",
+      "path": "{apps,libs}/*/lib/*/*.Unit.tsx",
+      "filterText": ".Util.",
+      "sample": 3
+    },
+    {
+      "type": "usage",
+      "description": "Model Util usage in Templates",
+      "path": "{apps,libs}/*/lib/*/*.Template.tsx",
+      "filterText": ".Util.",
+      "sample": 2
+    },
+    {
+      "type": "usage",
+      "description": "Model Util usage in Views",
+      "path": "{apps,libs}/*/lib/*/*.View.tsx",
+      "filterText": ".Util.",
+      "sample": 3
+    },
+    {
+      "type": "usage",
+      "description": "Model Util usage in Zones",
+      "path": "{apps,libs}/*/lib/*/*.Zone.tsx",
+      "filterText": ".Util.",
+      "sample": 3
+    },
+    {
+      "type": "related",
+      "description": "Relationship with model.store.ts",
+      "path": "{apps,libs}/*/lib/*/*.{store,signal}.ts",
+      "sample": 2
+    }
+  ],
+  "update": {
+    "filePath": "./modelUtil.instruction.md",
+    "contents": [
+      "Purpose and role of Model.Util.ts files",
+      "How to create Model.Util.ts files",
+      "Common patterns and implementations",
+      "Using with store actions and state",
+      "Using with signal API calls",
+      "Performance optimization techniques",
+      "How to use Model.Util.ts files in pages",
+      "How to use Model.Util.ts files in Units",
+      "How to use Model.Util.ts files in Templates",
+      "How to use Model.Util.ts files in Views",
+      "How to use Model.Util.ts files in Zones",
+      "Best practices and error handling"
+    ],
+    "rules": [
+      "Model.Util.tsx is a client component, so it can use client-side hooks like useEffect, useState, etc.",
+      "Model.Util.tsx is a utility component to reuse in pages, Units, Templates, Views, and Zones, etc.",
+      "Util components should be focused on a single responsibility",
+      "Util can be a wrapper component for using in server components",
+      "Util can be a wrapper component for store actions or signal api calls",
+      "Util components should handle their own loading and error states",
+      "Always use TypeScript for type safety in props and returned values",
+      "Consider memoization for performance-critical components",
+      "Follow consistent naming conventions (e.g., ActionButton, FilterPanel)",
+      "Document props with JSDoc comments for better IDE support"
+    ]
+  },
+  "page": "/[lang]/akanjs/(docs)/docs/module/util/page.tsx"
+}