@akanjs/cli 0.0.149 → 0.0.150

package/esm/src/guidelines/componentRule/componentRule.generate.json

@@ -0,0 +1,131 @@
+{
+  "title": "Component Rule",
+  "description": "Comprehensive guidelines for creating React components in the Akan.js framework",
+  "scans": [
+    {
+      "type": "source",
+      "description": "Cookie management utilities for web and mobile",
+      "path": "pkgs/@akanjs/client/src/cookie.ts"
+    },
+    {
+      "type": "source",
+      "description": "Storage utilities for persistent data",
+      "path": "pkgs/@akanjs/client/src/storage.ts"
+    },
+    {
+      "type": "source",
+      "description": "Device capabilities and platform detection",
+      "path": "pkgs/@akanjs/client/src/device.ts"
+    },
+    {
+      "type": "source",
+      "description": "Navigation and routing utilities",
+      "path": "pkgs/@akanjs/client/src/router.ts"
+    },
+    {
+      "type": "source",
+      "description": "Type utilities including clsx for class management",
+      "path": "pkgs/@akanjs/client/src/types.ts"
+    },
+    {
+      "type": "example",
+      "description": "Unit components (list items/cards)",
+      "path": "{apps,libs}/*/lib/*/*.Unit.tsx",
+      "sample": 3
+    },
+    {
+      "type": "example",
+      "description": "View components (detailed displays)",
+      "path": "{apps,libs}/*/lib/*/*.View.tsx",
+      "sample": 3
+    },
+    {
+      "type": "example",
+      "description": "Template components (forms/edit screens)",
+      "path": "{apps,libs}/*/lib/*/*.Template.tsx",
+      "sample": 3
+    },
+    {
+      "type": "example",
+      "description": "Utility components (toolbars/helpers)",
+      "path": "{apps,libs}/*/lib/*/*.Util.tsx",
+      "sample": 3
+    },
+    {
+      "type": "example",
+      "description": "Zone components (data containers)",
+      "path": "{apps,libs}/*/lib/*/*.Zone.tsx",
+      "sample": 3
+    },
+    {
+      "type": "example",
+      "description": "Reusable UI components",
+      "path": "{libs,apps}/*/ui/**/*.tsx",
+      "sample": 5
+    },
+    {
+      "type": "usage",
+      "description": "Component composition patterns",
+      "path": "{apps,libs}/*/lib/*/*.Zone.tsx",
+      "filterText": "renderItem",
+      "sample": 3
+    },
+    {
+      "type": "usage",
+      "description": "Form state management with stores",
+      "path": "{apps,libs}/*/lib/*/*.Template.tsx",
+      "filterText": "st.use",
+      "sample": 3
+    },
+    {
+      "type": "usage",
+      "description": "Conditional rendering with TailwindCSS",
+      "path": "{apps,libs}/*/lib/*/*.tsx",
+      "filterText": "clsx",
+      "sample": 3
+    },
+    {
+      "type": "usage",
+      "description": "Data fetching with Load components",
+      "path": "{apps,libs}/*/lib/*/*.Zone.tsx",
+      "filterText": "<Load.",
+      "sample": 3
+    },
+    {
+      "type": "usage",
+      "description": "Responsive design patterns",
+      "path": "{apps,libs}/*/lib/*/*.tsx",
+      "filterText": "md:",
+      "sample": 3
+    }
+  ],
+  "update": {
+    "filePath": "./componentRule.instruction.md",
+    "contents": [
+      "Component Architecture - Core structure and organization",
+      "Component Types - Purpose and responsibility of each component type",
+      "File Naming Conventions - Standardized naming patterns",
+      "Utility Functions - Core framework utilities",
+      "Best Practices - Guidelines for components",
+      "State Management - Integration with Zustand store and signals",
+      "Responsive Design - Mobile-first approach",
+      "Accessibility - Core principles",
+      "Performance Optimization - Memoization and lazy loading",
+      "Data Fetching - Using Load components",
+      "Composition Patterns - Component rendering methods",
+      "Complete Examples - Full implementation examples"
+    ],
+    "rules": [
+      "Component types (.Unit, .View, .Template, .Util, .Zone) should follow standard patterns and responsibilities",
+      "Every component file should maintain a consistent organization pattern with logical sections",
+      "Responsive design should use Tailwind's mobile-first approach with sm:, md:, lg: prefixes",
+      "Form components should use the framework state management pattern with st.use and st.do",
+      "Data containers should follow the Load.Units/Load.View pattern for consistent data fetching",
+      "Component files should export named components rather than default exports",
+      "Props should use explicit TypeScript interfaces with proper JSDoc comments where helpful",
+      "Separate business logic from presentation components",
+      "Follow Akan.js project structure and module organization"
+    ]
+  },
+  "page": "/[lang]/akanjs/(docs)/docs/codebase/component/page.tsx"
+}

package/esm/src/guidelines/cssRule/cssRule.generate.json

@@ -0,0 +1,93 @@
+{
+  "title": "CSS Rule with TailwindCSS and DaisyUI",
+  "description": "Comprehensive guidelines for creating CSS with TailwindCSS and DaisyUI in the Akan.js framework",
+  "scans": [
+    {
+      "type": "source",
+      "description": "clsx utility for class name management",
+      "path": "pkgs/@akanjs/client/src/types.ts"
+    },
+    {
+      "type": "example",
+      "description": "Unit components (list items/cards)",
+      "path": "{apps,libs}/*/lib/*/*.Unit.tsx",
+      "sample": 3
+    },
+    {
+      "type": "example",
+      "description": "View components (detailed displays)",
+      "path": "{apps,libs}/*/lib/*/*.View.tsx",
+      "sample": 3
+    },
+    {
+      "type": "example",
+      "description": "Edit components (forms for data creation/editing)",
+      "path": "{apps,libs}/*/lib/*/*.Edit.tsx",
+      "sample": 2
+    },
+    {
+      "type": "example",
+      "description": "Util components (special function components)",
+      "path": "{apps,libs}/*/lib/*/*.Util.tsx",
+      "sample": 2
+    },
+    {
+      "type": "example",
+      "description": "Zone components (container components)",
+      "path": "{apps,libs}/*/lib/*/*.Zone.tsx",
+      "sample": 2
+    },
+    {
+      "type": "example",
+      "description": "Reusable UI components",
+      "path": "{libs,apps}/*/ui/**/*.tsx",
+      "sample": 3
+    },
+    {
+      "type": "usage",
+      "description": "Conditional rendering with clsx",
+      "path": "{apps,libs}/*/lib/*/*.tsx",
+      "filterText": "clsx",
+      "sample": 3
+    },
+    {
+      "type": "usage",
+      "description": "DaisyUI color usage",
+      "path": "{apps,libs}/*/lib/*/*.tsx",
+      "filterText": "bg-primary|bg-secondary|bg-accent|bg-info|bg-success|bg-warning|bg-error",
+      "sample": 3
+    },
+    {
+      "type": "usage",
+      "description": "Responsive design patterns",
+      "path": "{apps,libs}/*/lib/*/*.tsx",
+      "filterText": "sm:|md:|lg:|xl:|2xl:",
+      "sample": 3
+    }
+  ],
+  "update": {
+    "filePath": "./cssRule.instruction.md",
+    "contents": [
+      "Core Principles - Fundamental styling concepts",
+      "Class Management with clsx - How to handle conditional class names",
+      "Component Structure Best Practices - Consistent component styling",
+      "Component Types in Akan.js - Styling patterns for different component types",
+      "Common UI Patterns - Reusable design patterns",
+      "Best Practices - Guidelines for maintainable CSS",
+      "Common Mistakes to Avoid - What not to do",
+      "Troubleshooting - Fixing common issues"
+    ],
+    "rules": [
+      "clsx should be used for conditional class names and className composition",
+      "Every component should accept and properly handle className prop for composition",
+      "Color system of DaisyUI should be used for colors (primary, secondary, accent, etc.) - hardcoded colors should be avoided",
+      "Components should follow responsive design principles with mobile-first approach",
+      "Use Tailwind's spacing scale consistently for margins and padding",
+      "Group related classes together for better readability",
+      "DaisyUI components should be used for common UI elements when available",
+      "Apply proper focus, hover, and active states for interactive elements",
+      "Respect the naming conventions for component types (Unit, View, Edit, Util, Zone)"
+    ]
+  },
+  "page": "/[lang]/akanjs/(docs)/docs/codebase/css/page.tsx"
+}

package/esm/src/guidelines/databaseModule/databaseModule.generate.json

@@ -0,0 +1,51 @@
+{
+  "title": "Database Module",
+  "description": "Structure of database module",
+  "scans": [
+    {
+      "type": "source",
+      "description": "core database module source code",
+      "path": "pkgs/@akanjs/server/src/module.ts"
+    },
+    {
+      "type": "source",
+      "description": "how to boot modules in Nest.js server",
+      "path": "pkgs/@akanjs/server/src/boot.ts"
+    },
+    {
+      "type": "source",
+      "description": "constant model decorators, database schema decorators, signal decorators reference",
+      "path": "pkgs/@akanjs/constant/src/decorator.ts"
+    },
+    {
+      "type": "example",
+      "description": "example database module of admin",
+      "path": "libs/shared/lib/admin/*"
+    }
+  ],
+  "update": {
+    "filePath": "./databaseModule.instruction.md",
+    "contents": [
+      "Purpose of database modules in Akan.js",
+      "File structure and location conventions",
+      "How to create database modules",
+      "How to use database modules in Nest.js server",
+      "How to use components, stores, and signals in client side",
+      "Real-time features with websockets and subscriptions",
+      "Best practices for data modeling and schema design",
+      "Authentication and authorization patterns",
+      "Performance optimization techniques",
+      "Error handling strategies"
+    ],
+    "rules": [
+      "Database module is a domain specific module to manage business logic of database",
+      "Follow consistent naming conventions with PascalCase for classes and camelCase for files",
+      "Keep business logic in service files, not in signals or documents",
+      "Use field validation in constant models to ensure data integrity",
+      "Create proper indexes in middleware for performance optimization",
+      "Apply appropriate authorization guards to protect sensitive operations",
+      "Use dictionary files for all UI text to support internationalization"
+    ]
+  },
+  "page": "/[lang]/akanjs/(docs)/docs/module/overview/page.tsx"
+}

package/esm/src/guidelines/docPageRule/docPageRule.generate.json

@@ -0,0 +1,72 @@
+{
+  "title": "How to create doc page",
+  "description": "How to create documentation page of Akan.js framework",
+  "scans": [
+    {
+      "type": "example",
+      "description": "Example of a system architecture documentation page",
+      "path": "apps/angelo/app/[lang]/akanjs/(docs)/docs/systemArch/frontend/page.tsx"
+    },
+    {
+      "type": "example",
+      "description": "Example of a module documentation page with API reference",
+      "path": "apps/angelo/app/[lang]/akanjs/(docs)/docs/module/signal/page.tsx"
+    },
+    {
+      "type": "source",
+      "description": "Documentation utility components",
+      "path": "apps/angelo/ui/Docs/index.ts"
+    },
+    {
+      "type": "source",
+      "description": "Code snippet component for syntax highlighting",
+      "path": "apps/angelo/ui/Docs/CodeSnippet.tsx"
+    },
+    {
+      "type": "source",
+      "description": "Title component for main headings",
+      "path": "apps/angelo/ui/Docs/Title.tsx"
+    },
+    {
+      "type": "source",
+      "description": "Description component for explanatory text",
+      "path": "apps/angelo/ui/Docs/Description.tsx"
+    },
+    {
+      "type": "source",
+      "description": "Option table component for displaying parameters",
+      "path": "apps/angelo/ui/Docs/OptionTable.tsx"
+    },
+    {
+      "type": "source",
+      "description": "Introduction table component for listing features",
+      "path": "apps/angelo/ui/Docs/IntroTable.tsx"
+    }
+  ],
+  "update": {
+    "filePath": "./docPageRule.instruction.md",
+    "contents": [
+      "Purpose of doc page in Akan.js",
+      "How to create doc page",
+      "Page organization and structure",
+      "Utility components",
+      "Best practices for documentation",
+      "Internationalization guidelines",
+      "Code example guidelines",
+      "Complete example implementation",
+      "Troubleshooting common issues"
+    ],
+    "rules": [
+      "Docs.Layout is already set on the top of layout.tsx file in the root of the project, so you don't need to use it in your page",
+      "Docs utility should be used with `Docs` prefix, like <Docs.Title>, do not use object destructuring",
+      "Always wrap user-facing text in l.trans() with at least English and Korean translations",
+      "Use a logical hierarchy of headings (Title → SubTitle → SubSubTitle)",
+      "Include a divider (<div className=\"divider\"></div>) between major sections",
+      "For long pages, use anchor links with hidden divs for navigation",
+      "Code examples should be realistic and include proper comments",
+      "Tables should use the appropriate type (OptionTable for parameters, IntroTable for features)",
+      "Always specify the correct language for CodeSnippet components"
+    ]
+  },
+  "page": "/[lang]/akanjs/(docs)/docs/[category]/[pageName]/page"
+}

package/esm/src/guidelines/enumConstant/enumConstant.generate.json

@@ -0,0 +1,24 @@
+{
+  "title": "Enum Constant",
+  "description": "how to generate a enumOf usage in constant.ts file",
+  "scans": [
+    {
+      "type": "source",
+      "description": "base enum library source code",
+      "path": "pkgs/@akanjs/base/src/base.ts"
+    },
+    {
+      "type": "example",
+      "description": "enumOf usage in constant.ts files",
+      "path": "{apps,libs}/*/lib/*/*.constant.ts",
+      "filterText": "enumOf",
+      "sample": 10
+    }
+  ],
+  "update": {
+    "filePath": "./enumConstant.instruction.md",
+    "contents": ["Structure of enumOf usage in constant.ts file", "How to add enumOf usage in constant.ts file"],
+    "rules": []
+  },
+  "page": "/[lang]/akanjs/(docs)/docs/codebase/enum/page.tsx"
+}

package/esm/src/guidelines/fieldDecorator/fieldDecorator.generate.json

@@ -0,0 +1,135 @@
+{
+  "title": "Field Decorator",
+  "description": "How to use @Field decorators in Akan.js",
+  "scans": [
+    {
+      "type": "source",
+      "description": "Field decorator implementation",
+      "path": "pkgs/@akanjs/constant/src/fieldMeta.ts"
+    },
+    {
+      "type": "source",
+      "description": "Field options and metadata interface",
+      "path": "pkgs/@akanjs/constant/src/scalar.ts"
+    },
+    {
+      "type": "source",
+      "description": "Base enum and type definitions",
+      "path": "pkgs/@akanjs/base/src/base.ts"
+    },
+    {
+      "type": "source",
+      "description": "Scalar type definitions",
+      "path": "pkgs/@akanjs/base/src/scalar.ts"
+    },
+    {
+      "type": "source",
+      "description": "Model class metadata implementation",
+      "path": "pkgs/@akanjs/constant/src/classMeta.ts"
+    },
+    {
+      "type": "source",
+      "description": "GraphQL type generation from field metadata",
+      "path": "pkgs/@akanjs/server/src/gql.ts"
+    },
+    {
+      "type": "source",
+      "description": "MongoDB schema generation from field metadata",
+      "path": "pkgs/@akanjs/server/src/schema.ts"
+    },
+    {
+      "type": "source",
+      "description": "Search indexing based on field metadata",
+      "path": "pkgs/@akanjs/server/src/searchDaemon.ts"
+    },
+    {
+      "type": "example",
+      "description": "Examples of Field.Prop with basic options",
+      "path": "{apps,libs}/**/lib/__scalar/*/*.constant.ts",
+      "query": "/Field\\.Prop.*default/",
+      "sample": 3
+    },
+    {
+      "type": "example",
+      "description": "Examples of Field.Hidden and Field.Secret",
+      "path": "{apps,libs}/**/lib/*/*.constant.ts",
+      "query": "/Field\\.(Hidden|Secret)/",
+      "sample": 3
+    },
+    {
+      "type": "example",
+      "description": "Examples of Field.Resolve for computed properties",
+      "path": "{apps,libs}/**/lib/*/*.constant.ts",
+      "query": "/Field\\.Resolve/",
+      "sample": 2
+    },
+    {
+      "type": "example",
+      "description": "Examples of array field decorators",
+      "path": "{apps,libs}/**/lib/*/*.constant.ts",
+      "query": "/Field\\.Prop\\(\\(\\)\\s*=>\\s*\\[/",
+      "sample": 3
+    },
+    {
+      "type": "example",
+      "description": "Examples of enum usage with Field.Prop",
+      "path": "{apps,libs}/**/lib/*/*.constant.ts",
+      "query": "/Field\\.Prop.*enum:/",
+      "sample": 3
+    },
+    {
+      "type": "example",
+      "description": "Examples of text search and filter options",
+      "path": "{apps,libs}/**/lib/*/*.constant.ts",
+      "query": "/Field\\.Prop.*text:/",
+      "sample": 2
+    },
+    {
+      "type": "example",
+      "description": "Examples of validation options (min, max, minlength, etc.)",
+      "path": "{apps,libs}/**/lib/*/*.constant.ts",
+      "query": "/Field\\.Prop.*(min:|max:|minlength:|maxlength:|validate:)/",
+      "sample": 3
+    }
+  ],
+  "update": {
+    "filePath": "./fieldDecorator.instruction.md",
+    "contents": [
+      "Purpose and types of Field decorators",
+      "Basic syntax and structure",
+      "Field.Prop for standard properties",
+      "Field.Hidden for database-only fields",
+      "Field.Secret for sensitive data",
+      "Field.Resolve for computed properties",
+      "Field options reference",
+      "Working with primitive types",
+      "Working with enums",
+      "Working with arrays and nested structures",
+      "Reference fields and relationships",
+      "Date and special type handling",
+      "Validation and constraints",
+      "Search optimization",
+      "Default values and immutability",
+      "Integration with Model types",
+      "Best practices",
+      "Troubleshooting common issues"
+    ],
+    "rules": [
+      "Always use arrow function syntax for type specification: () => Type",
+      "Field type in the arrow function must match the TypeScript type",
+      "Use bracket notation for arrays: () => [Type] (not Array<Type>)",
+      "Always provide a default value for required fields",
+      "Mark sensitive fields with Field.Secret instead of Field.Prop",
+      "For nullable fields, add both { nullable: true } option and Type | null in TypeScript",
+      "When using enums, always create them with enumOf() and export both const and type",
+      "For date fields, use Date in the arrow function but Dayjs as the TypeScript type",
+      "Always specify the 'of' option when using Map type",
+      "Use text: 'search' for full-text searchable fields and text: 'filter' for filterable fields",
+      "Use immutable: true for fields that shouldn't change after creation",
+      "Array fields should have [] as the default value",
+      "Prefer Field.Resolve for computed properties instead of getters",
+      "Use Field.Hidden for internal fields that shouldn't be exposed in GraphQL"
+    ]
+  },
+  "page": "/[lang]/akanjs/(docs)/docs/codebase/field/page.tsx"
+}

package/esm/src/guidelines/framework/framework.generate.json

@@ -0,0 +1,119 @@
+{
+  "title": "Akan.js Framework",
+  "description": "Comprehensive guide to the Akan.js framework architecture, concepts, and development patterns",
+  "scans": [
+    {
+      "type": "source",
+      "description": "Core framework packages",
+      "path": "pkgs/@akanjs/**/src/index.ts"
+    },
+    {
+      "type": "source",
+      "description": "Library implementations",
+      "path": "libs/*/index.ts"
+    },
+    {
+      "type": "example",
+      "description": "Application configurations",
+      "path": "apps/*/akan.config.ts",
+      "sample": 3
+    },
+    {
+      "type": "example",
+      "description": "Main application entry points",
+      "path": "apps/*/main.ts",
+      "sample": 3
+    },
+    {
+      "type": "example",
+      "description": "Client-side entry points",
+      "path": "apps/*/client.ts",
+      "sample": 3
+    },
+    {
+      "type": "example",
+      "description": "Server-side entry points",
+      "path": "apps/*/server.ts",
+      "sample": 3
+    },
+    {
+      "type": "example",
+      "description": "Model implementation patterns",
+      "path": "apps/*/lib/[!_]*/*.{constant,service,signal,store}.ts",
+      "sample": 4
+    },
+    {
+      "type": "example",
+      "description": "Component implementation patterns",
+      "path": "apps/*/lib/[!_]*/*.{View,Unit,Template,Zone}.tsx",
+      "sample": 4
+    },
+    {
+      "type": "usage",
+      "description": "Multi-environment configuration",
+      "path": "apps/*/env/*.ts",
+      "sample": 3
+    },
+    {
+      "type": "usage",
+      "description": "Routing implementation",
+      "path": "apps/*/app/**/*.tsx",
+      "sample": 3
+    },
+    {
+      "type": "usage",
+      "description": "State management with signals",
+      "path": "{apps,libs}/*/lib/[!_]*/*.signal.ts",
+      "sample": 3
+    },
+    {
+      "type": "usage",
+      "description": "Nestjs server integrations",
+      "path": "{apps,libs}/*/nest/*.ts",
+      "sample": 3
+    }
+  ],
+  "update": {
+    "filePath": "./framework.instruction.md",
+    "contents": [
+      "Introduction to Akan.js Framework",
+      "Key Features and Benefits",
+      "Architecture Overview",
+      "Environment and Configuration",
+      "Domain-Driven Development Pattern",
+      "Full-Stack Development Workflow",
+      "Model Architecture (constants, services, signals, stores)",
+      "Component Architecture (View, Unit, Template, Zone)",
+      "API Integration Pattern",
+      "State Management Pattern",
+      "Multi-Platform Support (Web, Mobile, SSR, CSR)",
+      "Type Safety and Code Generation",
+      "Internationalization (i18n) System",
+      "Security Best Practices",
+      "Deployment and CI/CD Integration",
+      "Performance Optimization Techniques",
+      "Development Tools and Commands",
+      "Database Integration Pattern",
+      "Authentication and Authorization System",
+      "File Management System",
+      "Real-time Communication Features",
+      "AI Integration and Code Generation",
+      "Testing and Quality Assurance",
+      "Best Practices and Common Patterns",
+      "Troubleshooting and Common Issues"
+    ],
+    "rules": [
+      "Emphasize the full-stack nature of the framework across all sections",
+      "Provide clear examples for each architectural pattern",
+      "Include code snippets demonstrating type safety across layers",
+      "Explain how components interact across client, server, and database",
+      "Highlight the automatic integration between layers",
+      "Provide both basic and advanced usage patterns",
+      "Include command-line examples for common development tasks",
+      "Organize content to flow from basic concepts to advanced usage",
+      "Use consistent terminology throughout the documentation",
+      "Include diagrams or visual aids to explain architectural concepts"
+    ]
+  },
+  "page": "/[lang]/akanjs/(docs)/docs/overview/page.tsx"
+}