@akanjs/cli 0.9.48 → 0.9.49

package/esm/src/guidelines/databaseModule/databaseModule.instruction.md

@@ -47,7 +47,7 @@ export const UserRole = enumOf(["user", "admin"] as const);
 export type UserRole = enumOf<typeof UserRole>;
 
 // Define input model (for create/update operations)
-@Model.Input("UserInput")
+
 export class UserInput {
   @Field.Prop(() => String, { validate: validate.email, type: "email", example: "user@example.com" })
   email: string;
@@ -57,7 +57,7 @@ export class UserInput {
 }
 
 // Define object model (full data model)
-@Model.Object("UserObject")
+
 export class UserObject extends via(UserInput) {
   @Field.Prop(() => [String], [{ enum: UserRole, example: ["user"] }])
   roles: (typeof UserRole.value)[];
@@ -67,7 +67,7 @@ export class UserObject extends via(UserInput) {
 }
 
 // Define light model (client-side model with essential fields)
-@Model.Light("LightUser")
+
 export class LightUser extends via(UserObject, ["email", "roles"] as const) {
   hasAccess(role: UserRole) {
     return this.roles.includes(role);
@@ -75,11 +75,11 @@ export class LightUser extends via(UserObject, ["email", "roles"] as const) {
 }
 
 // Define full model (server-side model with all fields)
-@Model.Full("User")
+
 export class User extends via(UserObject, LightUser) {}
 
 // Define filter model (for queries)
-@Model.Filter("UserFilter")
+
 export class UserFilter extends sortOf(User, {}) {
   @Filter.Mongo()
   byEmail(@Filter.Arg("email", () => String) email: string) {
@@ -99,12 +99,8 @@ import { hashPassword } from "@shared/nest";
 
 import * as cnst from "../cnst";
 
-// Input model for database operations
-@Database.Input(() => cnst.UserInput)
-export class UserInput extends by(cnst.UserInput) {}
-
 // Document model with methods
-@Database.Document(() => cnst.User)
+
 export class User extends by(cnst.User) {
   addRole(role: cnst.UserRole) {
     if (!this.roles.includes(role)) this.roles = [...this.roles, role];
@@ -118,7 +114,7 @@ export class User extends by(cnst.User) {
 }
 
 // Model with database operations
-@Database.Model(() => cnst.User)
+
 export class UserModel extends into(User, cnst.userCnst, ...user.models) {
   @Loader.ByField("email") userEmailLoader: Loader<string, User>;
 
@@ -132,7 +128,7 @@ export class UserModel extends into(User, cnst.userCnst, ...user.models) {
 }
 
 // Middleware for hooks and indexes
-@Database.Middleware(() => cnst.User)
+
 export class UserMiddleware extends beyond(UserModel, User) {
   onSchema(schema: SchemaOf<UserModel, User>) {
     // Hash password before saving
@@ -158,7 +154,7 @@ export class UserMiddleware extends beyond(UserModel, User) {
 Implement business logic in the service:
 
 ```typescript
-import { DbService, Service, Srv, Use } from "@akanjs/service";
+import { DbService, Srv, Use } from "@akanjs/service";
 import { Account, type Me } from "@akanjs/signal";
 import { isPasswordMatch } from "@shared/nest";
 
@@ -167,7 +163,6 @@ import * as db from "../db";
 import type * as option from "../option";
 import type * as srv from "../srv";
 
-@Service("UserService")
 export class UserService extends DbService(db.userDb) {
   @Use() protected readonly config: option.SecurityConfig;
   @Srv() protected readonly securityService: srv.util.SecurityService;
@@ -211,7 +206,6 @@ import { Account, Arg, DbSignal, Me, Mutation, Query, resolve, Signal } from "@a
 import * as cnst from "../cnst";
 import type * as db from "../db";
 
-@Signal(() => cnst.User)
 export class UserSignal extends DbSignal(cnst.userCnst, cnst.Srvs, {
   guards: { get: Query.Public, cru: Mutation.Admin },
 }) {
@@ -584,36 +578,30 @@ export const Layout = () => (
 ## Best Practices
 
 1. **Naming Conventions**
-
    - Use PascalCase for classes and components (e.g., `UserService`, `User.Unit.tsx`)
    - Use camelCase for files (e.g., `user.service.ts`, `user.document.ts`)
 
 2. **Security**
-
    - Use `@Field.Secret` for sensitive data like passwords
    - Apply proper permission guards to queries and mutations (`@Query.Admin`, `@Mutation.Public`)
    - Validate input data using the `validate` option in `@Field.Prop`
 
 3. **Code Organization**
-
    - Keep business logic in service files
    - Use signals for API calls only, not for business logic
    - Define reusable utility methods in document models
 
 4. **Performance**
-
    - Use dataloader pattern (`@Loader.ByField`) for efficient database access
    - Create proper indexes in the middleware
    - Use projections to limit returned fields when appropriate
 
 5. **Testing**
-
    - Create signal tests for each API endpoint
    - Mock services for unit testing signals
    - Use integration tests for testing complex workflows
 
 6. **UI Components**
-
    - Follow the separation between Template, Unit, View, and Zone components
    - Make components reusable across different parts of the application
    - Use dictionary files for all UI text to support internationalization

package/esm/src/guidelines/fieldDecorator/fieldDecorator.instruction.md

@@ -348,7 +348,6 @@ code: string;
 ### Input Models
 
 ```typescript
-@Model.Input("ProductInput")
 export class ProductInput {
   @Field.Prop(() => String)
   name: string;
@@ -361,7 +360,6 @@ export class ProductInput {
 ### Object Models
 
 ```typescript
-@Model.Object("ProductObject")
 export class ProductObject extends via(ProductInput) {
   @Field.Prop(() => Date, { default: dayjs() })
   createdAt: Dayjs;
@@ -371,21 +369,18 @@ export class ProductObject extends via(ProductInput) {
 ### Light Models
 
 ```typescript
-@Model.Light("LightProduct")
 export class LightProduct extends via(ProductObject, ["name", "price", "status"] as const) {}
 ```
 
 ### Full Models
 
 ```typescript
-@Model.Full("Product")
 export class Product extends via(ProductObject, LightProduct) {}
 ```
 
 ### Scalar Models
 
 ```typescript
-@Model.Scalar("Address")
 export class Address {
   @Field.Prop(() => String)
   street: string;

package/esm/src/guidelines/framework/framework.instruction.md

@@ -203,12 +203,10 @@ import { Project } from "./project.constant";
 import { projectService } from "./project.service";
 
 export class ProjectSignal {
-  @Signal()
   async projectList() {
     return projectService.getProjects();
   }
 
-  @Signal()
   async createProject(data: Partial<Project>) {
     return projectService.createProject(data);
   }
@@ -229,7 +227,11 @@ export const ProjectView = () => {
   return (
     <div>
       <h1>{l("project.modelName")}</h1>
-      <div className="grid gap-4">{data?.map((project) => <ProjectUnit key={project.id} project={project} />)}</div>
+      <div className="grid gap-4">
+        {data?.map((project) => (
+          <ProjectUnit key={project.id} project={project} />
+        ))}
+      </div>
     </div>
   );
 };
@@ -322,22 +324,18 @@ import { Task, TaskFilter } from "./task.constant";
 import { taskService } from "./task.service";
 
 export class TaskSignal {
-  @Signal()
   async taskList(query: TaskFilter, skip = 0, limit = 20) {
     return taskService.getTasks(query);
   }
 
-  @Signal()
   async task(taskId: string) {
     return taskService.getTask(taskId);
   }
 
-  @Signal()
   async createTask(data: Partial<Task>) {
     return taskService.createTask(data);
   }
 
-  @Signal()
   async updateTaskStatus(taskId: string, status: Task["status"]) {
     return taskService.updateTaskStatus(taskId, status);
   }
@@ -581,22 +579,18 @@ import { Product, ProductFilter } from "./product.constant";
 import { productService } from "./product.service";
 
 export class ProductSignal {
-  @Signal()
   async productList(query: ProductFilter, skip = 0, limit = 20) {
     return productService.getProducts(query, skip, limit);
   }
 
-  @Signal()
   async product(productId: string) {
     return productService.getProduct(productId);
   }
 
-  @Signal()
   async createProduct(data: Partial<Product>) {
     return productService.createProduct(data);
   }
 
-  @Signal()
   async updateProduct(productId: string, data: Partial<Product>) {
     return productService.updateProduct(productId, data);
   }
@@ -625,7 +619,11 @@ export const ProductList = () => {
       ) : error ? (
         <div>Error: {error.message}</div>
       ) : (
-        <ul>{products?.map((product) => <li key={product.id}>{product.name}</li>)}</ul>
+        <ul>
+          {products?.map((product) => (
+            <li key={product.id}>{product.name}</li>
+          ))}
+        </ul>
       )}
 
       <button onClick={() => createProduct({ name: "New Product" })} disabled={isCreating}>

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

@@ -63,13 +63,6 @@
       "filterText": "enumOf",
       "sample": 3
     },
-    {
-      "type": "example",
-      "description": "Models with custom Filter methods",
-      "path": "{apps,libs}/*/lib/*/*.constant.ts",
-      "filterText": "@Filter.Mongo",
-      "sample": 2
-    },
     {
       "type": "example",
       "description": "Models with reference fields",

package/esm/src/guidelines/modelConstant/modelConstant.instruction.md

@@ -48,21 +48,21 @@ export const StatusEnum = enumOf(["active", "inactive"] as const);
 export type StatusEnum = enumOf<typeof StatusEnum>;
 
 // 3. Input Model
-@Model.Input("DroneInput")
+
 export class DroneInput {
   @Field.Prop(() => String)
   name: string;
 }
 
 // 4. Object Model
-@Model.Object("DroneObject")
+
 export class DroneObject extends BaseModel(DroneInput) {
   @Field.Prop(() => String, { enum: StatusEnum, default: "offline" })
   status: StatusEnum;
 }
 
 // 5. Light Model
-@Model.Light("LightDrone")
+
 export class LightDrone extends Light(DroneObject, ["id", "name", "status"] as const) {
   isConnected() {
     return this.status !== "offline";
@@ -70,7 +70,7 @@ export class LightDrone extends Light(DroneObject, ["id", "name", "status"] as c
 }
 
 // 6. Full Model
-@Model.Full("Drone")
+
 export class Drone extends Full(DroneObject, LightDrone) {
   isAvailable() {
     return this.isConnected() && this.wsUri.startsWith("ws://");
@@ -78,7 +78,7 @@ export class Drone extends Full(DroneObject, LightDrone) {
 }
 
 // 7. Insight Model
-@Model.Insight("DroneInsight")
+
 export class DroneInsight {
   @Field.Prop(() => Int, { default: 0, accumulate: { $sum: 1 } })
   count: number;
@@ -113,7 +113,6 @@ import { LightCategory } from "../category/category.constant";
 The Input model defines fields required for data creation:
 
 ```typescript
-@Model.Input("DroneInput")
 export class DroneInput {
   @Field.Prop(() => String)
   name: string;
@@ -144,7 +143,6 @@ The Object model adds system-managed fields:
 export const droneStatuses = ["active", "offline", "inactive"] as const;
 export type DroneStatus = (typeof droneStatuses)[number];
 
-@Model.Object("DroneObject")
 export class DroneObject extends BaseModel(DroneInput) {
   @Field.Prop(() => String, { enum: droneStatuses, default: "offline" })
   status: DroneStatus;
@@ -172,7 +170,6 @@ const drone = st.use.drone(); // drone.status
 Light model defines lightweight schema for list queries:
 
 ```typescript
-@Model.Light("LightDrone")
 export class LightDrone extends Light(DroneObject, ["name", "status"] as const) {
   isConnected() {
     return this.status !== "offline";
@@ -196,7 +193,6 @@ const droneMap = st.use.droneMap(); // Map<string, LightDrone>
 Full model adds convenience functions:
 
 ```typescript
-@Model.Full("Drone")
 export class Drone extends Full(DroneObject, LightDrone) {
   static isDronesAllConnected(droneList: LightDrone[]) {
     return droneList.every((drone) => drone.isConnected());
@@ -226,7 +222,6 @@ const isAllConnected = cnst.Drone.isDroneAllConnected(droneList);
 Insight model defines statistical fields:
 
 ```typescript
-@Model.Insight("DroneInsight")
 export class DroneInsight {
   @Field.Prop(() => Int, { default: 0, accumulate: { $sum: 1 } })
   count: number;
@@ -371,13 +366,11 @@ graph LR
 ### 1. Scalar Embedded Style
 
 ```typescript
-@Model.Scalar("DronePhysicalState")
 export class DronePhysicalState {
   @Field.Prop(() => [Float], { default: [0, 0, 0] })
   rpy: [number, number, number];
 }
 
-@Model.Object("DroneObject")
 export class DroneObject {
   @Field.Prop(() => DronePhysicalState)
   physicalState: DronePhysicalState;
@@ -387,7 +380,6 @@ export class DroneObject {
 ### 2. Reference ID Style
 
 ```typescript
-@Model.Input("MissionInput")
 export class MissionInput {
   @Field.Prop(() => ID, { ref: "drone" })
   drone: string;
@@ -397,7 +389,6 @@ export class MissionInput {
 ### 3. Resolved Reference Style
 
 ```typescript
-@Model.Object("DroneObject")
 export class DroneObject {
   @Field.Prop(() => LightMission, { nullable: true })
   mission: LightMission | null;
@@ -417,6 +408,7 @@ import { LightMission } from "../cnst_";
 ## Best Practices for Maintainable Models
 
 1. **Consistent Naming**:
+
    - Input: `DroneInput`
    - Object: `DroneObject`
    - Light: `LightDrone`
@@ -424,16 +416,19 @@ import { LightMission } from "../cnst_";
    - Sort: `droneSort`
 
 2. **Reference Handling**:
+
    - Use Light models for references
    - Avoid circular dependencies
    - Prefer direct imports over barrel files
 
 3. **Field Design**:
+
    - Use proper field types (Prop, Hidden, Secret, Resolve)
    - Set appropriate defaults (especially for arrays)
    - Add validation where needed
 
 4. **Performance Optimization**:
+
    - Use Light models for list queries
    - Keep Insight/Summary models lean
    - Use appropriate indexes for queries
@@ -450,21 +445,21 @@ import { ID, Int, String } from "@akanjs/base";
 import { Field, Model } from "@akanjs/constant";
 
 // Input Model
-@Model.Input("DroneInput")
+
 export class DroneInput {
   @Field.Prop(() => String)
   name: string;
 }
 
 // Object Model
-@Model.Object("DroneObject")
+
 export class DroneObject extends BaseModel(DroneInput) {
   @Field.Prop(() => String, { enum: ["active", "offline"], default: "offline" })
   status: string;
 }
 
 // Light Model
-@Model.Light("LightDrone")
+
 export class LightDrone extends Light(DroneObject, ["id", "name", "status"] as const) {
   isConnected() {
     return this.status === "active";
@@ -472,7 +467,7 @@ export class LightDrone extends Light(DroneObject, ["id", "name", "status"] as c
 }
 
 // Full Model
-@Model.Full("Drone")
+
 export class Drone extends Full(DroneObject, LightDrone) {
   isAvailable() {
     return this.isConnected() && this.battery > 20;
@@ -480,7 +475,7 @@ export class Drone extends Full(DroneObject, LightDrone) {
 }
 
 // Insight Model
-@Model.Insight("DroneInsight")
+
 export class DroneInsight {
   @Field.Prop(() => Int, { accumulate: { $sum: 1 } })
   count: number;

package/esm/src/guidelines/modelDocument/modelDocument.instruction.md

@@ -16,21 +16,11 @@
 
 A `model.document.ts` file is structured into four distinct classes, each with a specific responsibility:
 
-### 1. Input Class
-
-Defines the data structure for create/update operations:
-
-```typescript
-@Database.Input(() => cnst.ExampleInput)
-export class ExampleInput extends by(cnst.ExampleInput) {}
-```
-
 ### 2. Document Class
 
 Represents a MongoDB document with instance methods:
 
 ```typescript
-@Database.Document(() => cnst.Example)
 export class Example extends by(cnst.Example) {
   // Document methods here
 }
@@ -41,7 +31,6 @@ export class Example extends by(cnst.Example) {
 Represents the MongoDB collection with static methods:
 
 ```typescript
-@Database.Model(() => cnst.Example)
 export class ExampleModel extends into(Example, cnst.exampleCnst) {
   // Model statics here
 }
@@ -52,7 +41,6 @@ export class ExampleModel extends into(Example, cnst.exampleCnst) {
 Defines schema hooks and indexes:
 
 ```typescript
-@Database.Middleware(() => cnst.Example)
 export class ExampleMiddleware extends beyond(ExampleModel, Example) {
   onSchema(schema) {
     // Middleware and indexes here
@@ -74,7 +62,6 @@ Document methods operate on individual document instances and typically follow t
 ### Example of Document Methods:
 
 ```typescript
-@Database.Document(() => cnst.User)
 export class User extends by(cnst.User) {
   // Simple transformation method (synchronous)
   addRole(role: string) {
@@ -113,7 +100,6 @@ Model statics operate on the entire collection and are typically asynchronous. T
 ### Example of Model Statics:
 
 ```typescript
-@Database.Model(() => cnst.Order)
 export class OrderModel extends into(Order, cnst.orderCnst) {
   // Query by specific criteria
   async findPendingOrders(userId: string) {
@@ -206,7 +192,6 @@ Middleware allows you to intercept and modify document operations at various lif
 ### Example Middleware Implementation:
 
 ```typescript
-@Database.Middleware(() => cnst.User)
 export class UserMiddleware extends beyond(UserModel, User) {
   onSchema(schema: SchemaOf<UserModel, User>) {
     // Pre-save hook for password hashing
@@ -258,7 +243,6 @@ Indexes are crucial for query performance. Define them in the Middleware's `onSc
 ### Example Index Implementation:
 
 ```typescript
-@Database.Middleware(() => cnst.Product)
 export class ProductMiddleware extends beyond(ProductModel, Product) {
   onSchema(schema: SchemaOf<ProductModel, Product>) {
     // Single field index (1=ascending, -1=descending)
@@ -346,7 +330,6 @@ DataLoader batches and caches database requests to optimize performance, especia
 ### Example DataLoader Implementation:
 
 ```typescript
-@Database.Model(() => cnst.Order)
 export class OrderModel extends into(Order, cnst.orderCnst) {
   // Load orders by user ID
   @Loader.ByField("userId")
@@ -461,7 +444,6 @@ const resultCount = await productModel.searchCountProduct("wireless headphones")
 Use transactions for operations that need to be atomic:
 
 ```typescript
-@Database.Model(() => cnst.Order)
 export class OrderModel extends into(Order, cnst.orderCnst) {
   @Transaction()
   async createOrderWithItems(orderData, items) {
@@ -497,10 +479,6 @@ import { dayjs } from "@akanjs/base";
 import { beyond, by, Database, into, Loader, SchemaOf } from "@akanjs/document";
 import * as cnst from "../cnst";
 
-@Database.Input(() => cnst.ProductInput)
-export class ProductInput extends by(cnst.ProductInput) {}
-
-@Database.Document(() => cnst.Product)
 export class Product extends by(cnst.Product) {
   applyDiscount(percentage: number) {
     if (percentage < 0 || percentage > 100) {
@@ -529,7 +507,6 @@ export class Product extends by(cnst.Product) {
   }
 }
 
-@Database.Model(() => cnst.Product)
 export class ProductModel extends into(Product, cnst.productCnst) {
   @Loader.ByField("category")
   categoryProductsLoader: Loader<string, Product[]>;
@@ -579,7 +556,6 @@ export class ProductModel extends into(Product, cnst.productCnst) {
   }
 }
 
-@Database.Middleware(() => cnst.Product)
 export class ProductMiddleware extends beyond(ProductModel, Product) {
   onSchema(schema: SchemaOf<ProductModel, Product>) {
     // Update stock status on save

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

@@ -24,13 +24,6 @@
       "path": "libs/shared/lib/user/user.service.ts",
       "sample": 1
     },
-    {
-      "type": "example",
-      "description": "@Service decorator examples",
-      "path": "{apps,libs}/*/lib/*/*.service.ts",
-      "filterText": "@Service",
-      "sample": 2
-    },
     {
       "type": "example",
       "description": "@Use decorator examples",
@@ -89,9 +82,9 @@
     },
     {
       "type": "example",
-      "description": "LogService examples",
+      "description": "serve examples",
       "path": "{apps,libs}/*/lib/*/*.service.ts",
-      "filterText": "LogService",
+      "filterText": "serve",
       "sample": 1
     },
     {
@@ -113,8 +106,8 @@
     "filePath": "./modelService.instruction.md",
     "contents": [
       "Purpose and role of model.service.ts files",
-      "Service structure and inheritance (DbService, LogService, MixSrvs)",
-      "Core decorators (@Service, @Srv, @Use, @Db, @Sig)",
+      "Service structure and inheritance (DbService, serve, MixSrvs)",
+      "Core decorators (@Srv, @Use, @Db, @Sig)",
       "Database operations (CRUD, queries, search)",
       "Customizing database operations (_preCreate, _postCreate, _preUpdate, _postUpdate, _preRemove, _postRemove)",
       "Working with other services (dependency injection patterns)",