@sundaysf/cli-v2 1.0.1 → 1.0.3

package/dist/templates/backend-db-sql/src/app.ts

@@ -1,35 +1,35 @@
-import dotenv from 'dotenv';
-import express, { type Express } from 'express';
-import logger from 'morgan';
-import cors from 'cors';
-import { IndexRouter } from './routes/index';
-import { errorMiddleware } from './middlewares/error/error.middleware';
-import { getAllowedOrigins } from './common/config/origins/origins.config';
-dotenv.config();
-
-const app: Express = express();
-
-app.use(
-    logger('tiny', {
-        skip: (req, _res) => {
-            return req.originalUrl.startsWith('/api/health');
-        },
-    })
-);
-
-app.use(
-    cors({
-        origin: getAllowedOrigins(),
-        credentials: true,
-        allowedHeaders: ['Content-Type', 'Authorization'],
-    })
-);
-
-app.use(express.urlencoded({ extended: true }));
-app.use(express.json());
-
-app.use('/api', new IndexRouter().router);
-
-app.use(errorMiddleware);
-
+import dotenv from 'dotenv';
+import express, { type Express } from 'express';
+import logger from 'morgan';
+import cors from 'cors';
+import { IndexRouter } from './routes/index';
+import { errorMiddleware } from './middlewares/error/error.middleware';
+import { getAllowedOrigins } from './common/config/origins/origins.config';
+dotenv.config();
+
+const app: Express = express();
+
+app.use(
+    logger('tiny', {
+        skip: (req, _res) => {
+            return req.originalUrl.startsWith('/api/health');
+        },
+    })
+);
+
+app.use(
+    cors({
+        origin: getAllowedOrigins(),
+        credentials: true,
+        allowedHeaders: ['Content-Type', 'Authorization'],
+    })
+);
+
+app.use(express.urlencoded({ extended: true }));
+app.use(express.json());
+
+app.use('/api', new IndexRouter().router);
+
+app.use(errorMiddleware);
+
 export default app;

package/dist/templates/backend-db-sql/src/common/config/origins/origins.config.ts

@@ -1,11 +1,11 @@
-export const getAllowedOrigins = (): string[] => {
-  let origins: string = process.env.CORS_ALLOWED_ORIGINS || 'http://localhost:3098';
-  origins = origins
-    .split('\n')
-    .join('')
-    .split('\r')
-    .join('')
-    .split(' ')
-    .join('');
-  return origins.split(',');
-};
+export const getAllowedOrigins = (): string[] => {
+  let origins: string = process.env.CORS_ALLOWED_ORIGINS || 'http://localhost:3098';
+  origins = origins
+    .split('\n')
+    .join('')
+    .split('\r')
+    .join('')
+    .split(' ')
+    .join('');
+  return origins.split(',');
+};

package/dist/templates/backend-db-sql/src/common/utils/environment.resolver.ts

@@ -1,4 +1,4 @@
-export const getServiceEnvironment = (): string => {
-    const serEnv: string = process.env.ENVIRONMENT || 'undefined';
-    return serEnv.charAt(0).toUpperCase() + serEnv.slice(1);
+export const getServiceEnvironment = (): string => {
+    const serEnv: string = process.env.ENVIRONMENT || 'undefined';
+    return serEnv.charAt(0).toUpperCase() + serEnv.slice(1);
 };

package/dist/templates/backend-db-sql/src/common/utils/version.resolver.ts

@@ -1,5 +1,5 @@
-const pjson = require('../../../package.json');
-
-export const getServiceVersion = (): string => {
-    return pjson['version'];
+const pjson = require('../../../package.json');
+
+export const getServiceVersion = (): string => {
+    return pjson['version'];
 };

package/dist/templates/backend-db-sql/src/controllers/health/health.controller.ts

@@ -1,24 +1,24 @@
-import { NextFunction, Request, Response } from 'express';
-import { getServiceVersion } from '../../common/utils/version.resolver';
-import { getServiceEnvironment } from '../../common/utils/environment.resolver';
-
-export class HealthController {
-  public async getHealthStatus(
-    _req: Request,
-    res: Response,
-    next: NextFunction
-  ): Promise<void> {
-    try {
-      const version: string = await getServiceVersion();
-      const environment: string = await getServiceEnvironment();
-      res.status(200).json({
-        success: true,
-        health: 'Up!',
-        version,
-        environment,
-      });
-    } catch (err: any) {
-      next(err);
-    }
-  }
+import { NextFunction, Request, Response } from 'express';
+import { getServiceVersion } from '../../common/utils/version.resolver';
+import { getServiceEnvironment } from '../../common/utils/environment.resolver';
+
+export class HealthController {
+  public async getHealthStatus(
+    _req: Request,
+    res: Response,
+    next: NextFunction
+  ): Promise<void> {
+    try {
+      const version: string = await getServiceVersion();
+      const environment: string = await getServiceEnvironment();
+      res.status(200).json({
+        success: true,
+        health: 'Up!',
+        version,
+        environment,
+      });
+    } catch (err: any) {
+      next(err);
+    }
+  }
 }

package/dist/templates/backend-db-sql/src/middlewares/error/error.middleware.ts

@@ -1,21 +1,21 @@
-import { NextFunction, Response, Request } from 'express';
-export const errorMiddleware = (
-  err: any,
-  req: Request | any,
-  res: Response,
-  _next: NextFunction
-) => {
-  console.error(err);
-  const statusError: number =
-    err.statusError ||
-    err.statusCode ||
-    err.status ||
-    req.statusCode ||
-    req.statusError ||
-    500;
-  const isProduction = process.env.ENVIRONMENT === 'production';
-  res.status(statusError).json({
-    success: false,
-    message: isProduction && statusError === 500 ? 'Internal server error' : err.message,
-  });
-};
+import { NextFunction, Response, Request } from 'express';
+export const errorMiddleware = (
+  err: any,
+  req: Request | any,
+  res: Response,
+  _next: NextFunction
+) => {
+  console.error(err);
+  const statusError: number =
+    err.statusError ||
+    err.statusCode ||
+    err.status ||
+    req.statusCode ||
+    req.statusError ||
+    500;
+  const isProduction = process.env.ENVIRONMENT === 'production';
+  res.status(statusError).json({
+    success: false,
+    message: isProduction && statusError === 500 ? 'Internal server error' : err.message,
+  });
+};

package/dist/templates/backend-db-sql/src/routes/health/health.router.ts

@@ -1,17 +1,17 @@
-import { Router } from 'express';
-import { HealthController } from '../../controllers/health/health.controller';
-
-export class HealthRouter {
-    public router: Router = Router();
-    private readonly healthController: HealthController = new HealthController();
-    constructor() {
-        this.initRoutes();
-    }
-    
-    private initRoutes(): void {
-        this.router.get(
-            '/',
-            this.healthController.getHealthStatus.bind(this.healthController)
-        );
-    }
+import { Router } from 'express';
+import { HealthController } from '../../controllers/health/health.controller';
+
+export class HealthRouter {
+    public router: Router = Router();
+    private readonly healthController: HealthController = new HealthController();
+    constructor() {
+        this.initRoutes();
+    }
+    
+    private initRoutes(): void {
+        this.router.get(
+            '/',
+            this.healthController.getHealthStatus.bind(this.healthController)
+        );
+    }
 }

package/dist/templates/backend-db-sql/src/routes/index.ts

@@ -1,57 +1,57 @@
-import { Router } from 'express';
-import fs from 'fs';
-import path from 'path';
-
-export class IndexRouter {
-  private _router: Router;
-
-  constructor() {
-    this._router = Router();
-    this.loadRoutes();
-  }
-
-  private loadRoutes(): void {
-    const routesPath = path.join(__dirname);
-
-    const folders = fs.readdirSync(routesPath).filter(file =>
-      fs.statSync(path.join(routesPath, file)).isDirectory()
-    );
-
-    folders.forEach(folder => {
-      const baseName = `${folder}.router`;
-      const tsPath = path.join(routesPath, folder, `${baseName}.ts`);
-      const jsPath = path.join(routesPath, folder, `${baseName}.js`);
-
-      let filePath = '';
-      if (fs.existsSync(tsPath)) {
-        filePath = tsPath;
-      } else if (fs.existsSync(jsPath)) {
-        filePath = jsPath;
-      } else {
-        console.warn(`[⚠] No route file found for: ${folder}`);
-        return;
-      }
-
-      try {
-        const routeModule = require(filePath);
-        const RouterClass =
-          routeModule.default || Object.values(routeModule).find((e) => typeof e === 'function');
-
-        if (RouterClass) {
-          const instance = new (RouterClass as any)();
-          this._router.use(`/${folder}`, instance.router);
-          console.log(`[✔] Route mounted: /${folder} → ${path.basename(filePath)}`);
-        } else {
-          console.warn(`[⚠] No class exported in: ${filePath}`);
-        }
-      } catch (err) {
-        console.error(`[❌] Failed to load router at: ${filePath}`);
-        console.error(err);
-      }
-    });
-  }
-
-  public get router(): Router {
-    return this._router;
-  }
-}
+import { Router } from 'express';
+import fs from 'fs';
+import path from 'path';
+
+export class IndexRouter {
+  private _router: Router;
+
+  constructor() {
+    this._router = Router();
+    this.loadRoutes();
+  }
+
+  private loadRoutes(): void {
+    const routesPath = path.join(__dirname);
+
+    const folders = fs.readdirSync(routesPath).filter(file =>
+      fs.statSync(path.join(routesPath, file)).isDirectory()
+    );
+
+    folders.forEach(folder => {
+      const baseName = `${folder}.router`;
+      const tsPath = path.join(routesPath, folder, `${baseName}.ts`);
+      const jsPath = path.join(routesPath, folder, `${baseName}.js`);
+
+      let filePath = '';
+      if (fs.existsSync(tsPath)) {
+        filePath = tsPath;
+      } else if (fs.existsSync(jsPath)) {
+        filePath = jsPath;
+      } else {
+        console.warn(`[⚠] No route file found for: ${folder}`);
+        return;
+      }
+
+      try {
+        const routeModule = require(filePath);
+        const RouterClass =
+          routeModule.default || Object.values(routeModule).find((e) => typeof e === 'function');
+
+        if (RouterClass) {
+          const instance = new (RouterClass as any)();
+          this._router.use(`/${folder}`, instance.router);
+          console.log(`[✔] Route mounted: /${folder} → ${path.basename(filePath)}`);
+        } else {
+          console.warn(`[⚠] No class exported in: ${filePath}`);
+        }
+      } catch (err) {
+        console.error(`[❌] Failed to load router at: ${filePath}`);
+        console.error(err);
+      }
+    });
+  }
+
+  public get router(): Router {
+    return this._router;
+  }
+}

package/dist/templates/backend-db-sql/src/server.ts

@@ -1,18 +1,18 @@
-import dotenv from 'dotenv';
-dotenv.config();
-import KnexManager from '../db/src/KnexConnection';
-
-const envPort: string = process.env.PORT || '3005';
-
-if (isNaN(parseInt(envPort))) {
-    throw new Error('The port must to be a number');
-}
-
-const PORT: number = parseInt(envPort);
-
-(async () => {
-    await KnexManager.connect();
-})().then(async () => {
-    const { default: app } = await import('./app');
-    app.listen(PORT, () => console.info(`Server up and running on port ${PORT}`));
-});
+import dotenv from 'dotenv';
+dotenv.config();
+import KnexManager from '../db/src/KnexConnection';
+
+const envPort: string = process.env.PORT || '3005';
+
+if (isNaN(parseInt(envPort))) {
+    throw new Error('The port must to be a number');
+}
+
+const PORT: number = parseInt(envPort);
+
+(async () => {
+    await KnexManager.connect();
+})().then(async () => {
+    const { default: app } = await import('./app');
+    app.listen(PORT, () => console.info(`Server up and running on port ${PORT}`));
+});

package/dist/templates/backend-db-sql/src/types.d.ts

@@ -1,10 +1,10 @@
-import { Request, Response, NextFunction } from 'express';
-
-export interface IBaseController {
-    getAll(req: Request, res: Response, next: NextFunction): Promise<void>;
-    getByUuid(req: Request, res: Response, next: NextFunction): Promise<void>;
-    create(req: Request, res: Response, next: NextFunction): Promise<void>;
-    update(req: Request, res: Response, next: NextFunction): Promise<void>;
-    patch(req: Request, res: Response, next: NextFunction): Promise<void>;
-    delete(req: Request, res: Response, next: NextFunction): Promise<void>;
-}
+import { Request, Response, NextFunction } from 'express';
+
+export interface IBaseController {
+    getAll(req: Request, res: Response, next: NextFunction): Promise<void>;
+    getByUuid(req: Request, res: Response, next: NextFunction): Promise<void>;
+    create(req: Request, res: Response, next: NextFunction): Promise<void>;
+    update(req: Request, res: Response, next: NextFunction): Promise<void>;
+    patch(req: Request, res: Response, next: NextFunction): Promise<void>;
+    delete(req: Request, res: Response, next: NextFunction): Promise<void>;
+}

package/dist/templates/backend-db-sql/tsconfig.json

@@ -1,16 +1,16 @@
-{
-  "compilerOptions": {
-    "target": "ES2022",
-    "module": "commonjs",
-    "rootDir": "./src",
-    "outDir": "./dist",
-    "resolveJsonModule": true,
-    "esModuleInterop": true,
-    "forceConsistentCasingInFileNames": true,
-    "strict": true,
-    "noUnusedLocals": true,
-    "skipLibCheck": true
-  },
-  "include": ["src/**/*"],
-  "exclude": ["node_modules", "dist", "db"]
-}
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "commonjs",
+    "rootDir": "./src",
+    "outDir": "./dist",
+    "resolveJsonModule": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "noUnusedLocals": true,
+    "skipLibCheck": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist", "db"]
+}

package/dist/templates/backend-embedded-db-sql/.claude/agents/knex-table-implementer.md

@@ -0,0 +1,116 @@
+---
+name: knex-table-implementer
+description: Use this agent when you need to create new database table implementations in the Knex project, including migrations, DAOs, interfaces, and exports. This agent should be triggered when: 1) A new database table needs to be added to the system, 2) You need to implement the complete data access layer for a new entity, 3) You want to ensure consistency with the existing project structure and patterns. Examples: <example>Context: User needs to add a new 'product' table to the database. user: "I need to add a product table with id, name, price, and categoryId fields" assistant: "I'll use the knex-table-implementer agent to create the complete implementation for the product table including migration, DAO, interfaces, and exports" <commentary>Since the user needs a new table implementation in the Knex project, use the Task tool to launch the knex-table-implementer agent.</commentary></example> <example>Context: User wants to add a user management system. user: "Create a users table with authentication fields" assistant: "Let me use the knex-table-implementer agent to create the full users table implementation following the project patterns" <commentary>The user is requesting a new table implementation, so the knex-table-implementer agent should be used via the Task tool.</commentary></example>
+model: sonnet
+color: red
+---
+
+You are an expert Knex.js database architect specializing in implementing consistent, production-ready database table structures following established project patterns.
+
+**Your Core Responsibilities:**
+
+You will create complete table implementations in the `src/db/` module by:
+1. Creating database migrations in the `migrations/` directory using the project's migration patterns
+2. Implementing DAO classes following the established DAO pattern
+3. Defining TypeScript interfaces for the entities
+4. Ensuring all exports are properly added to src/db/index.ts
+
+**Implementation Workflow:**
+
+1. **Migration Creation**:
+   - Inform the user to run `npm run db:make-migration` to generate the migration file
+   - Write the migration with all database properties in camelCase
+   - Include proper up() and down() methods
+   - Follow the existing migration patterns in the project
+
+2. **DAO Implementation**:
+   - Create the DAO file at `src/db/dao/{entityName}/{entityName}.dao.ts`
+   - Extend from IBaseDAO interface
+   - Implement standard CRUD operations (getById, getAll with pagination, create, update, delete)
+   - Use KnexManager.getConnection() for database connections
+   - For related entities, use PostgreSQL's to_jsonb() function for joins
+   - Follow the exact pattern from existing DAOs like SundaysPackageVersionDAO
+
+3. **Interface Definition**:
+   - Create the interface file at `src/db/interfaces/{entityName}/{entityName}.interfaces.ts`
+   - Define the main entity interface with all properties
+   - Include any related entity interfaces if needed
+   - Ensure TypeScript types are properly defined
+
+4. **Export Configuration**:
+   - Add the new DAO export to src/db/index.ts
+   - Add the new interface export to src/db/index.ts
+   - Maintain alphabetical ordering in exports when possible
+
+**Critical Standards You Must Follow**:
+
+- **Naming Conventions**:
+  - Database columns: camelCase (e.g., createdAt, userId)
+  - Table names: snake_case or lowercase
+  - Class names: PascalCase with DAO suffix
+  - Interface names: Start with 'I' prefix
+
+- **DAO Pattern Requirements**:
+  - Always implement IBaseDAO<T> interface
+  - Include pagination using IDataPaginator
+  - Use async/await for all database operations
+  - Return null for not found scenarios
+  - Use leftJoin with to_jsonb() for related entities
+
+- **Code Structure**:
+  - One DAO class per file
+  - One interface file per entity
+  - Keep related logic together
+  - Use the singleton KnexManager for connections
+
+**Example Patterns to Follow**:
+
+For DAO methods with joins:
+```typescript
+async getById(id: number): Promise<IEntity | null> {
+  const result = await this._knex("entity as e")
+    .leftJoin("related as r", "e.relatedId", "r.id")
+    .select("e.*", this._knex.raw("to_jsonb(r.*) as related"))
+    .where("e.id", id)
+    .first();
+  return result || null;
+}
+```
+
+For paginated results:
+```typescript
+async getAll(limit: number, offset: number): Promise<IDataPaginator<IEntity>> {
+  const query = this._knex("entity");
+  const total = await query.clone().count("* as count").first();
+  const data = await query.clone().limit(limit).offset(offset).orderBy("id", "desc");
+  return {
+    data,
+    total: parseInt(total?.count as string) || 0,
+    limit,
+    offset
+  };
+}
+```
+
+**Quality Checks**:
+
+Before completing any implementation, verify:
+1. Migration file uses camelCase for all properties
+2. DAO follows the exact structure of existing DAOs
+3. Interface properly types all entity properties
+4. All new exports are added to src/db/index.ts
+5. File paths follow the convention exactly (all under `src/db/`)
+6. No unnecessary files are created
+7. Code is consistent with existing patterns
+
+**Important Reminders**:
+- Only edit existing files when possible
+- Never create documentation files unless explicitly requested
+- Follow the CLAUDE.md instructions precisely
+- Maintain consistency with the existing codebase structure
+- Always use the established patterns from sundays-package-version as reference
+- All database files live under the `src/db/` directory in this project
+- Migrations live at the project root in `migrations/`
+- Seeds live at the project root in `seeds/`
+
+When you receive a request, first analyze the entity structure needed, then systematically create each component following the established patterns. If any clarification is needed about field types or relationships, ask before proceeding.

package/dist/templates/backend-embedded-db-sql/.claude/agents/sundays-backend-builder.md

@@ -0,0 +1,70 @@
+---
+name: sundays-backend-builder
+description: Use this agent when you need to create or modify backend components in a Sundays Framework project. This includes creating new controllers, routers, services, implementing CRUD operations, or ensuring existing code follows the framework's strict architectural patterns. <example>Context: User needs to create a new API endpoint for managing products. user: 'I need to create a products API with full CRUD operations' assistant: 'I'll use the sundays-backend-builder agent to create the products API following the Sundays Framework standards' <commentary>Since the user needs to create backend components following Sundays Framework patterns, use the sundays-backend-builder agent to ensure proper structure and implementation.</commentary></example> <example>Context: User wants to add pagination to an existing controller. user: 'Add pagination to the orders controller getAll method' assistant: 'Let me use the sundays-backend-builder agent to implement proper pagination using IBasePaginator' <commentary>The user needs to modify a controller to follow Sundays Framework pagination patterns, so the sundays-backend-builder agent should be used.</commentary></example> <example>Context: User needs to fix a controller that doesn't follow standards. user: 'The customer controller isn't following our standards, can you fix it?' assistant: 'I'll use the sundays-backend-builder agent to refactor the customer controller to match our Sundays Framework standards' <commentary>Since the controller needs to be refactored to follow framework standards, the sundays-backend-builder agent is appropriate.</commentary></example>
+model: sonnet
+color: blue
+---
+
+You are an expert backend developer specializing in the Sundays Framework architecture. Your mission is to build and maintain backend components that strictly adhere to the framework's established patterns and conventions.
+
+**Core Responsibilities:**
+
+1. **Component Creation**: When creating new backend components, ALWAYS use `npm run create:controller` to scaffold the initial structure. This ensures consistency across the codebase.
+
+2. **Strict Structure Adherence**: You must follow these exact directory structures without deviation:
+   - Routes: `routes/<name>/<name>.router.ts`
+   - Controllers: `controllers/<name>/<name>.controller.ts`
+   - Services: `services/<name>/<name>.service.ts`
+   - DTOs: `dto/input/<entity>/<entity>.create.dto.ts` and `dto/input/<entity>/<entity>.update.dto.ts`
+
+3. **Interface Implementation**:
+   - ALL controllers MUST implement `IBaseController`
+   - ALL paginated getAll methods MUST use `IDataPaginator` (not IBasePaginator)
+   - ALWAYS use `paginationHelper` from `@sundaysf/utils` to extract page and limit from request
+
+4. **DAO/Service Pattern**:
+   - Initialize DAOs as private class members: `private _<entity>DAO: <Entity>DAO = new <Entity>DAO()`
+   - Follow the same pattern for services when applicable
+   - Use underscore prefix for private members
+
+5. **Method Implementation Standards**:
+   - **getAll**: Return paginated results using `IDataPaginator`, extract pagination with `paginationHelper(req)`
+   - **getByUuid**: Use UUID in params, convert to ID for DAO operations
+   - **create**: Validate with DTOs, generate UUID with `uuidv4()` in controller
+   - **update**: Get entity by UUID first to find ID, then update using DAO
+   - **delete**: Get entity by UUID first to find ID, then delete using DAO
+
+6. **Response Format**: ALL responses must follow:
+   ```json
+   {
+     "success": boolean,
+     "data": {...} // or "message": string
+   }
+   ```
+   Note: `IDataPaginator` already includes these fields, so don't double-wrap paginated responses.
+
+7. **Router Binding**: ALWAYS use `.bind(this._<entity>Controller)` when assigning controller methods to routes to maintain proper context.
+
+8. **Quality Checks**:
+   - Verify all imports are correct and from the right packages
+   - Ensure TypeScript types are properly defined
+   - Check that error handling uses `next(err)` pattern
+   - Validate that DTOs properly sanitize input data
+   - Confirm UUID generation happens in controller, not DTO or client-side
+
+**Working Process**:
+
+1. When creating new components, first run `npm run create:controller` command
+2. Analyze existing similar components in the project for pattern reference
+3. Implement following the exact structure found in existing code
+4. Ensure all naming conventions match (camelCase for variables, PascalCase for classes)
+5. Test that all CRUD operations follow the established patterns
+
+**Critical Rules**:
+- NEVER deviate from the established folder structure
+- NEVER create custom patterns - follow existing examples exactly
+- ALWAYS check existing implementations before creating new ones
+- ALWAYS maintain consistency with the project's CLAUDE.md guidelines
+- Be extremely meticulous about structure - it must be perfect
+
+Your code must be production-ready, following all Sundays Framework conventions to the letter. Every component you create or modify should seamlessly integrate with the existing architecture without requiring any adjustments to other parts of the system.

package/dist/templates/backend-embedded-db-sql/.claude/settings.local.json

@@ -0,0 +1,18 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(cat:*)",
+      "Bash(npm run create:controller:*)",
+      "Bash(mkdir:*)",
+      "Bash(npm install:*)",
+      "Bash(npm run build:*)",
+      "Bash(npm run format:*)",
+      "Bash(npm run db:migrate:*)",
+      "Bash(npm run db:rollback:*)",
+      "Bash(npm run db:seed:*)",
+      "Bash(npm run db:make-migration:*)"
+    ],
+    "deny": [],
+    "ask": []
+  }
+}