@sundaysf/cli-v2 0.0.3 → 1.0.0

package/dist/templates/backend-db-sql/README.md

@@ -1,34 +1,34 @@
-# Sundays Framework Project
-
-This directory contains the starter backend with embedded database module generated by the CLI.
-
-## Quick start
-
-1. Install dependencies:
-   ```
-   npm install
-   ```
-2. Copy `.env.example` to `.env` and set your environment variables (especially the `SQL_*` database variables).
-3. Run database migrations:
-   ```
-   npm run migrate:deploy
-   ```
-4. Start the development server:
-   ```
-   npm run start:dev
-   ```
-
-The server will run on the port specified in your `.env` file.
-
-## Database module
-
-The `db/` directory contains an independently publishable Knex.js database module. It can be used as part of this backend or published separately as an npm package.
-
-### Database commands
-
-- `npm run migrate:create` - Create a new migration
-- `npm run migrate:deploy` - Run pending migrations
-- `npm run seed:create` - Create a new seed file
-- `npm run seed:run` - Run seed files
-- `npm run db:build` - Compile the database module
-- `npm run db:publish` - Publish the database module to npm
+# Sundays Framework Project
+
+This directory contains the starter backend with embedded database module generated by the CLI.
+
+## Quick start
+
+1. Install dependencies:
+   ```
+   npm install
+   ```
+2. Copy `.env.example` to `.env` and set your environment variables (especially the `SQL_*` database variables).
+3. Run database migrations:
+   ```
+   npm run migrate:deploy
+   ```
+4. Start the development server:
+   ```
+   npm run start:dev
+   ```
+
+The server will run on the port specified in your `.env` file.
+
+## Database module
+
+The `db/` directory contains an independently publishable Knex.js database module. It can be used as part of this backend or published separately as an npm package.
+
+### Database commands
+
+- `npm run migrate:create` - Create a new migration
+- `npm run migrate:deploy` - Run pending migrations
+- `npm run seed:create` - Create a new seed file
+- `npm run seed:run` - Run seed files
+- `npm run db:build` - Compile the database module
+- `npm run db:publish` - Publish the database module to npm

package/dist/templates/backend-db-sql/db/knexfile.ts

@@ -1,33 +1,34 @@
-import type { Knex } from "knex";
-import dotenv from "dotenv";
-dotenv.config();
-
-const isLocalhost = process.env.SQL_HOST === 'localhost' || process.env.SQL_HOST === '127.0.0.1';
-const rejectUnauthorized = process.env.SQL_REJECT_UNAUTHORIZED !== 'false';
-
-const sharedConfig: Knex.Config = {
-  client: "postgresql",
-  connection: {
-    database: process.env.SQL_DB_NAME,
-    user: process.env.SQL_USER,
-    password: process.env.SQL_PASSWORD,
-    host: process.env.SQL_HOST,
-    port: process.env.SQL_PORT ? +process.env.SQL_PORT : 5432,
-    ssl: isLocalhost ? false : { rejectUnauthorized },
-  },
-  pool: {
-    min: 2,
-    max: 10,
-  },
-  migrations: {
-    tableName: "knex_migrations",
-  },
-};
-
-const config: { [key: string]: Knex.Config } = {
-  development: sharedConfig,
-  staging: sharedConfig,
-  production: sharedConfig,
-};
-
-export default config;
+import type { Knex } from "knex";
+import path from "path";
+import dotenv from "dotenv";
+dotenv.config({ path: path.resolve(__dirname, "..", ".env") });
+
+const isLocalhost = process.env.SQL_HOST === 'localhost' || process.env.SQL_HOST === '127.0.0.1';
+const rejectUnauthorized = process.env.SQL_REJECT_UNAUTHORIZED !== 'false';
+
+const sharedConfig: Knex.Config = {
+  client: "postgresql",
+  connection: {
+    database: process.env.SQL_DB_NAME,
+    user: process.env.SQL_USER,
+    password: process.env.SQL_PASSWORD,
+    host: process.env.SQL_HOST,
+    port: process.env.SQL_PORT ? +process.env.SQL_PORT : 5432,
+    ssl: isLocalhost ? false : { rejectUnauthorized },
+  },
+  pool: {
+    min: 2,
+    max: 10,
+  },
+  migrations: {
+    tableName: "knex_migrations",
+  },
+};
+
+const config: { [key: string]: Knex.Config } = {
+  development: sharedConfig,
+  staging: sharedConfig,
+  production: sharedConfig,
+};
+
+export default config;

package/dist/templates/backend-db-sql/db/migrations/001_create_sundays_package_version.ts

@@ -1,13 +1,13 @@
-import type { Knex } from "knex";
-
-export async function up(knex: Knex): Promise<void> {
-  await knex.schema.createTable("sundays_package_version", (table) => {
-    table.increments("id").primary();
-    table.string("versionName").notNullable();
-    table.timestamps(true, true); // created_at, updated_at
-  });
-}
-
-export async function down(knex: Knex): Promise<void> {
-  await knex.schema.dropTableIfExists("sundays_package_version");
+import type { Knex } from "knex";
+
+export async function up(knex: Knex): Promise<void> {
+  await knex.schema.createTable("sundays_package_version", (table) => {
+    table.increments("id").primary();
+    table.string("versionName").notNullable();
+    table.timestamps(true, true); // created_at, updated_at
+  });
+}
+
+export async function down(knex: Knex): Promise<void> {
+  await knex.schema.dropTableIfExists("sundays_package_version");
 }

package/dist/templates/backend-db-sql/db/seeds/001_sundays_package_version_seed.ts

@@ -1,11 +1,11 @@
-import { Knex } from "knex";
-
-export async function seed(knex: Knex): Promise<void> {
-    // Deletes ALL existing entries
-    await knex("sundays_package_version").del();
-
-    // Inserts seed entries
-    await knex("sundays_package_version").insert([
-        { versionName: "1.0.0" }
-    ]);
+import { Knex } from "knex";
+
+export async function seed(knex: Knex): Promise<void> {
+    // Deletes ALL existing entries
+    await knex("sundays_package_version").del();
+
+    // Inserts seed entries
+    await knex("sundays_package_version").insert([
+        { versionName: "1.0.0" }
+    ]);
 }

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

@@ -1,74 +1,74 @@
-import { knex, Knex } from 'knex';
-
-class KnexManager {
-  private static knexInstance: Knex<any, unknown[]> | null = null;
-
-  /**
-   * Open a new connection. Reuse the already existing one if there's any.
-   */
-  static async connect(
-    config?: Knex.Config,
-    connections?: number
-  ): Promise<Knex<any, unknown[]>> {
-    if (!KnexManager.knexInstance) {
-      const isLocalhost = process.env.SQL_HOST === 'localhost' || process.env.SQL_HOST === '127.0.0.1';
-      const rejectUnauthorized = process.env.SQL_REJECT_UNAUTHORIZED !== 'false';
-      const defaultConfig = {
-        client: 'pg',
-        connection: {
-          host: process.env.SQL_HOST,
-          user: process.env.SQL_USER,
-          password: process.env.SQL_PASSWORD,
-          database: process.env.SQL_DB_NAME,
-          port: Number(process.env.SQL_PORT) || 5432,
-          ssl: isLocalhost ? false : { rejectUnauthorized },
-        },
-        pool: {
-          min: 1,
-          max: connections || 15,
-          idleTimeoutMillis: 20000,
-          acquireTimeoutMillis: 30000,
-        },
-        migrations: {
-          tableName: 'knex_migrations',
-        },
-      };
-      KnexManager.knexInstance = knex(config || defaultConfig);
-      try {
-        await KnexManager.knexInstance.raw('SELECT 1');
-        console.info(`Knex connection established`);
-      } catch (error) {
-        console.error(`Failed to establish Knex connection:`, error);
-        KnexManager.knexInstance = null;
-        throw error;
-      }
-    }
-
-    return KnexManager.knexInstance;
-  }
-
-  /**
-   * Returns the active connection.
-   */
-  static getConnection(): Knex<any, unknown[]> {
-    if (!KnexManager.knexInstance) {
-      throw new Error(
-        'Knex connection has not been established. Call connect() first.'
-      );
-    }
-    return KnexManager.knexInstance;
-  }
-
-  /**
-   * Closes the connection and destroys the instance.
-   */
-  static async disconnect(): Promise<void> {
-    if (KnexManager.knexInstance) {
-      await KnexManager.knexInstance.destroy();
-      KnexManager.knexInstance = null;
-      console.info(`Knex connection closed`);
-    }
-  }
-}
-
-export default KnexManager;
+import { knex, Knex } from 'knex';
+
+class KnexManager {
+  private static knexInstance: Knex<any, unknown[]> | null = null;
+
+  /**
+   * Open a new connection. Reuse the already existing one if there's any.
+   */
+  static async connect(
+    config?: Knex.Config,
+    connections?: number
+  ): Promise<Knex<any, unknown[]>> {
+    if (!KnexManager.knexInstance) {
+      const isLocalhost = process.env.SQL_HOST === 'localhost' || process.env.SQL_HOST === '127.0.0.1';
+      const rejectUnauthorized = process.env.SQL_REJECT_UNAUTHORIZED !== 'false';
+      const defaultConfig = {
+        client: 'pg',
+        connection: {
+          host: process.env.SQL_HOST,
+          user: process.env.SQL_USER,
+          password: process.env.SQL_PASSWORD,
+          database: process.env.SQL_DB_NAME,
+          port: Number(process.env.SQL_PORT) || 5432,
+          ssl: isLocalhost ? false : { rejectUnauthorized },
+        },
+        pool: {
+          min: 1,
+          max: connections || 15,
+          idleTimeoutMillis: 20000,
+          acquireTimeoutMillis: 30000,
+        },
+        migrations: {
+          tableName: 'knex_migrations',
+        },
+      };
+      KnexManager.knexInstance = knex(config || defaultConfig);
+      try {
+        await KnexManager.knexInstance.raw('SELECT 1');
+        console.info(`Knex connection established`);
+      } catch (error) {
+        console.error(`Failed to establish Knex connection:`, error);
+        KnexManager.knexInstance = null;
+        throw error;
+      }
+    }
+
+    return KnexManager.knexInstance;
+  }
+
+  /**
+   * Returns the active connection.
+   */
+  static getConnection(): Knex<any, unknown[]> {
+    if (!KnexManager.knexInstance) {
+      throw new Error(
+        'Knex connection has not been established. Call connect() first.'
+      );
+    }
+    return KnexManager.knexInstance;
+  }
+
+  /**
+   * Closes the connection and destroys the instance.
+   */
+  static async disconnect(): Promise<void> {
+    if (KnexManager.knexInstance) {
+      await KnexManager.knexInstance.destroy();
+      KnexManager.knexInstance = null;
+      console.info(`Knex connection closed`);
+    }
+  }
+}
+
+export default KnexManager;

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

@@ -1,18 +1,18 @@
-export interface IBaseDAO<T> {
-    create(item: T): Promise<T>;
-    getById(id: number): Promise<T | null>;
-    getByUuid(uuid: string): Promise<T | null>;
-    update(id: number, item: Partial<T>): Promise<T | null>;
-    delete(id: number): Promise<boolean>;
-    getAll(page: number, limit: number): Promise<IDataPaginator<T>>;
-}
-
-export interface IDataPaginator<T> {
-    success: boolean;
-    data: T[];
-    page: number;
-    limit: number;
-    count: number;
-    totalCount: number;
-    totalPages: number;
-}
+export interface IBaseDAO<T> {
+    create(item: T): Promise<T>;
+    getById(id: number): Promise<T | null>;
+    getByUuid(uuid: string): Promise<T | null>;
+    update(id: number, item: Partial<T>): Promise<T | null>;
+    delete(id: number): Promise<boolean>;
+    getAll(page: number, limit: number): Promise<IDataPaginator<T>>;
+}
+
+export interface IDataPaginator<T> {
+    success: boolean;
+    data: T[];
+    page: number;
+    limit: number;
+    count: number;
+    totalCount: number;
+    totalPages: number;
+}

package/dist/templates/backend-db-sql/db/src/dao/sundays-package-version/sundays-package-version.dao.ts

@@ -1,71 +1,71 @@
-import { Knex } from "knex";
-import { IBaseDAO, IDataPaginator } from "../../d.types";
-import { ISundaysPackageVersion } from "../../interfaces/sundays-package-version/sundays-package-version.interfaces";
-import KnexManager from "../../KnexConnection";
-
-export class SundaysPackageVersionDAO implements IBaseDAO<ISundaysPackageVersion> {
-    private _knex: Knex<any, unknown[]> = KnexManager.getConnection();
-
-    async create(item: ISundaysPackageVersion): Promise<ISundaysPackageVersion> {
-        const [created] = await this._knex("sundays_package_version").insert(item).returning("*");
-        return created;
-    }
-
-    async getById(id: number): Promise<ISundaysPackageVersion | null> {
-        const result = await this._knex("sundays_package_version")
-            .select("*")
-            .where("id", id)
-            .first();
-        return result || null;
-    }
-
-    async getByUuid(uuid: string): Promise<ISundaysPackageVersion | null> {
-        const result = await this._knex("sundays_package_version")
-            .select("*")
-            .where("uuid", uuid)
-            .first();
-        return result || null;
-    }
-
-    async update(id: number, item: Partial<ISundaysPackageVersion>): Promise<ISundaysPackageVersion | null> {
-        const [updated] = await this._knex("sundays_package_version")
-            .where({ id })
-            .update(item)
-            .returning("*");
-        return updated || null;
-    }
-
-    async delete(id: number): Promise<boolean> {
-        const result = await this._knex("sundays_package_version").where({ id }).del();
-        return result > 0;
-    }
-
-    async getAll(page: number, limit: number): Promise<IDataPaginator<ISundaysPackageVersion>> {
-        const safeLimit = Math.max(limit, 1);
-        const offset = (page - 1) * safeLimit;
-
-        const query = this._knex("sundays_package_version").select("*");
-
-        const [countResult] = await query.clone().clearSelect().count("* as count");
-        const totalCount = +countResult.count;
-        const data = await query.clone().limit(safeLimit).offset(offset).orderBy("id", "desc");
-
-        return {
-            success: true,
-            data,
-            page,
-            limit: safeLimit,
-            count: data.length,
-            totalCount,
-            totalPages: Math.ceil(totalCount / safeLimit),
-        };
-    }
-
-    async getLatestVersion(): Promise<ISundaysPackageVersion | null> {
-        const result = await this._knex("sundays_package_version")
-            .select("*")
-            .orderBy("id", "desc")
-            .first();
-        return result || null;
-    }
-}
+import { Knex } from "knex";
+import { IBaseDAO, IDataPaginator } from "../../d.types";
+import { ISundaysPackageVersion } from "../../interfaces/sundays-package-version/sundays-package-version.interfaces";
+import KnexManager from "../../KnexConnection";
+
+export class SundaysPackageVersionDAO implements IBaseDAO<ISundaysPackageVersion> {
+    private _knex: Knex<any, unknown[]> = KnexManager.getConnection();
+
+    async create(item: ISundaysPackageVersion): Promise<ISundaysPackageVersion> {
+        const [created] = await this._knex("sundays_package_version").insert(item).returning("*");
+        return created;
+    }
+
+    async getById(id: number): Promise<ISundaysPackageVersion | null> {
+        const result = await this._knex("sundays_package_version")
+            .select("*")
+            .where("id", id)
+            .first();
+        return result || null;
+    }
+
+    async getByUuid(uuid: string): Promise<ISundaysPackageVersion | null> {
+        const result = await this._knex("sundays_package_version")
+            .select("*")
+            .where("uuid", uuid)
+            .first();
+        return result || null;
+    }
+
+    async update(id: number, item: Partial<ISundaysPackageVersion>): Promise<ISundaysPackageVersion | null> {
+        const [updated] = await this._knex("sundays_package_version")
+            .where({ id })
+            .update(item)
+            .returning("*");
+        return updated || null;
+    }
+
+    async delete(id: number): Promise<boolean> {
+        const result = await this._knex("sundays_package_version").where({ id }).del();
+        return result > 0;
+    }
+
+    async getAll(page: number, limit: number): Promise<IDataPaginator<ISundaysPackageVersion>> {
+        const safeLimit = Math.max(limit, 1);
+        const offset = (page - 1) * safeLimit;
+
+        const query = this._knex("sundays_package_version").select("*");
+
+        const [countResult] = await query.clone().clearSelect().count("* as count");
+        const totalCount = +countResult.count;
+        const data = await query.clone().limit(safeLimit).offset(offset).orderBy("id", "desc");
+
+        return {
+            success: true,
+            data,
+            page,
+            limit: safeLimit,
+            count: data.length,
+            totalCount,
+            totalPages: Math.ceil(totalCount / safeLimit),
+        };
+    }
+
+    async getLatestVersion(): Promise<ISundaysPackageVersion | null> {
+        const result = await this._knex("sundays_package_version")
+            .select("*")
+            .orderBy("id", "desc")
+            .first();
+        return result || null;
+    }
+}

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

@@ -1,9 +1,9 @@
-// DAOs
-export { SundaysPackageVersionDAO } from "./dao/sundays-package-version/sundays-package-version.dao";
-
-// Interfaces
-export { IDataPaginator } from "./d.types";
-export { ISundaysPackageVersion } from "./interfaces/sundays-package-version/sundays-package-version.interfaces";
-
-import KnexManager from './KnexConnection';
-export { KnexManager };
+// DAOs
+export { SundaysPackageVersionDAO } from "./dao/sundays-package-version/sundays-package-version.dao";
+
+// Interfaces
+export { IDataPaginator } from "./d.types";
+export { ISundaysPackageVersion } from "./interfaces/sundays-package-version/sundays-package-version.interfaces";
+
+import KnexManager from './KnexConnection';
+export { KnexManager };

package/dist/templates/backend-db-sql/db/src/interfaces/sundays-package-version/sundays-package-version.interfaces.ts

@@ -1,6 +1,6 @@
-export interface ISundaysPackageVersion {
-  id: number;
-  versionName: string;
-  createdAt: string;
-  updatedAt: string;
-}
+export interface ISundaysPackageVersion {
+  id: number;
+  versionName: string;
+  createdAt: string;
+  updatedAt: string;
+}

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

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

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/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);
 };