@tsed/cli 6.6.2 → 7.0.0-alpha.1

package/lib/esm/templates/interceptor.template.js

@@ -0,0 +1,31 @@
+import { defineTemplate } from "../utils/defineTemplate.js";
+export default defineTemplate({
+    id: "interceptor",
+    label: "Interceptor",
+    fileName: "{{symbolName}}.interceptor",
+    outputDir: "{{srcDir}}/interceptors",
+    render(symbolName) {
+        return `import {InterceptorMethods, InterceptorContext, InterceptorMethods, Interceptor} from "@tsed/di";
+
+@Interceptor()
+export class ${symbolName} implements InterceptorMethods {
+  /**
+   * ctx: The context that holds the dynamic data related to the method execution and the proceed method
+   * to proceed with the original method execution
+   *
+   * opts: Static params that can be provided when the interceptor is attached to a specific method
+   */
+  async intercept(context: InterceptorContext<any>, next: InterceptorMethods) {
+    console.log(\`the method \${context.propertyKey} will be executed with args \${context.args} and static data \${context.options}\`);
+    // let the original method by calling next function
+    const result = await next();
+
+    console.log(\`the method was executed, and returned \${result}\`);
+
+    // must return the returned value back to the caller
+    return result;
+  }
+}
+`;
+    }
+});

package/lib/esm/templates/interface.template.js

@@ -0,0 +1,13 @@
+import { defineTemplate } from "../utils/defineTemplate.js";
+export default defineTemplate({
+    id: "interface",
+    label: "Interface",
+    fileName: "{{symbolName}}.interface",
+    outputDir: "{{srcDir}}/interfaces",
+    render(symbolName) {
+        return `export interface ${symbolName} {
+
+}
+`;
+    }
+});

package/lib/esm/templates/middleware.template.js

@@ -0,0 +1,34 @@
+import { defineTemplate } from "../utils/defineTemplate.js";
+export default defineTemplate({
+    id: "middleware",
+    label: "Middleware",
+    fileName: "{{symbolName}}.middleware",
+    outputDir: "{{srcDir}}/middlewares",
+    prompts: (data) => [
+        {
+            type: "list",
+            name: "middlewarePosition",
+            message: () => `The middleware should be called:`,
+            choices: [
+                { name: "Before the endpoint", value: "before" },
+                { name: "After the endpoint", value: "after" }
+            ],
+            when(state) {
+                return !!((["decorator"].includes(state.type || data.type) && ["middleware"].includes(state.templateType)) ||
+                    data.middlewarePosition);
+            }
+        }
+    ],
+    render(symbolName) {
+        return `import {Middleware, MiddlewareMethods} from "@tsed/platform-middlewares";
+import {Context} from "@tsed/platform-params";
+
+@Middleware()
+export class ${symbolName} implements MiddlewareMethods {
+  use(@Context() ctx: Context) {
+
+  }
+}
+`;
+    }
+});

package/lib/esm/templates/model.template.js

@@ -0,0 +1,16 @@
+import { defineTemplate } from "../utils/defineTemplate.js";
+export default defineTemplate({
+    id: "model",
+    label: "Model",
+    fileName: "{{symbolName}}.model",
+    outputDir: "{{srcDir}}/models",
+    render(symbolName) {
+        return `import {Property} from "@tsed/schema";
+
+export class ${symbolName} {
+  @Property()
+  id: string;
+}
+`;
+    }
+});

package/lib/esm/templates/module.template.js

@@ -0,0 +1,16 @@
+import { defineTemplate } from "../utils/defineTemplate.js";
+export default defineTemplate({
+    id: "module",
+    label: "Module",
+    fileName: "{{symbolName}}.module",
+    outputDir: "{{srcDir}}",
+    render(symbolName) {
+        return `import {Module} from "@tsed/di";
+
+@Module()
+export class ${symbolName} {
+
+}
+`;
+    }
+});

package/lib/esm/templates/pipe.template.js

@@ -0,0 +1,19 @@
+import { defineTemplate } from "../utils/defineTemplate.js";
+export default defineTemplate({
+    id: "pipe",
+    label: "Pipe",
+    fileName: "{{symbolName}}.pipe",
+    outputDir: "{{srcDir}}/pipes",
+    render(symbolName) {
+        return `import {Injectable} from "@tsed/di";
+import {PipeMethods, ParamMetadata} from "@tsed/platform-params";
+
+@Injectable()
+export class ${symbolName} extends PipeMethods {
+  transform(value: any, param: ParamMetadata) {
+    return null;
+  }
+}
+`;
+    }
+});

package/lib/esm/templates/pm2.template.js

@@ -0,0 +1,111 @@
+import { defineTemplate } from "../utils/defineTemplate.js";
+import { constant } from "@tsed/di";
+defineTemplate({
+    id: "pm2.node-loader",
+    label: "PM2 Ecosystem for Node with loader",
+    description: "Add a PM2 ecosystem file to manage your application running with node",
+    type: "pm2",
+    fileName: "processes.config",
+    ext: "cjs",
+    outputDir: ".",
+    preserveCase: true,
+    hidden: true,
+    render() {
+        return `'use strict'
+
+const path = require('path')
+const defaultLogFile = path.join(__dirname, '/logs/project-server.log')
+
+module.exports = {
+  'apps': [
+    {
+      name: 'api',
+      'interpreter': 'node',
+      interpreter_args: '--import @swc-node/register/esm-register --enable-source-maps',
+      'script': \`\${process.env.WORKDIR}${constant("projectDir.srcDir")}/index.ts\`,
+      'cwd': process.env.WORKDIR,
+      exec_mode: 'cluster',
+      instances: process.env.NODE_ENV === 'test' ? 1 : process.env.NB_INSTANCES || 2,
+      autorestart: true,
+      max_memory_restart: process.env.MAX_MEMORY_RESTART || '750M',
+      'out_file': defaultLogFile,
+      'error_file': defaultLogFile,
+      'merge_logs': true,
+      'kill_timeout': 30000,
+    }
+  ]
+}
+`;
+    }
+});
+defineTemplate({
+    id: "pm2.node-compiled",
+    label: "PM2 Ecosystem for Node Compiled",
+    description: "Add a PM2 ecosystem file to manage your application compiled with tsc",
+    type: "pm2",
+    fileName: "processes.config",
+    ext: "cjs",
+    outputDir: ".",
+    preserveCase: true,
+    hidden: true,
+    render() {
+        return `'use strict'
+
+const path = require('path')
+const defaultLogFile = path.join(__dirname, '/logs/project-server.log')
+
+module.exports = {
+  'apps': [
+    {
+      name: 'api',
+      'script': \`\${process.env.WORKDIR}/dist/index.js\`,
+      'cwd': process.env.WORKDIR,
+      exec_mode: "cluster",
+      instances: process.env.NODE_ENV === 'test' ? 1 : process.env.NB_INSTANCES || 2,
+      autorestart: true,
+      max_memory_restart: process.env.MAX_MEMORY_RESTART || '750M',
+      'out_file': defaultLogFile,
+      'error_file': defaultLogFile,
+      'merge_logs': true,
+      'kill_timeout': 30000,
+    }
+  ]
+}`;
+    }
+});
+defineTemplate({
+    id: "pm2.bun",
+    label: "PM2 Ecosystem for Bun",
+    description: "Add a PM2 ecosystem file to manage your application running with Bun",
+    type: "pm2",
+    fileName: "processes.config",
+    ext: "cjs",
+    outputDir: ".",
+    preserveCase: true,
+    hidden: true,
+    render() {
+        return `'use strict'
+
+const path = require('path')
+const defaultLogFile = path.join(__dirname, '/logs/project-server.log')
+
+module.exports = {
+  'apps': [
+    {
+      name: 'api',
+      interpreter: '~/.bun/bin/bun',
+      'script': \`\${process.env.WORKDIR}/dist/index.js\`,
+      'cwd': process.env.WORKDIR,
+      exec_mode: 'cluster',
+      instances: process.env.NODE_ENV === 'test' ? 1 : process.env.NB_INSTANCES || 2,
+      autorestart: true,
+      max_memory_restart: process.env.MAX_MEMORY_RESTART || '750M',
+      'out_file': defaultLogFile,
+      'error_file': defaultLogFile,
+      'merge_logs': true,
+      'kill_timeout': 30000,
+    }
+  ]
+}`;
+    }
+});

package/lib/esm/templates/prisma.service.template.js

@@ -0,0 +1,23 @@
+import { defineTemplate } from "../utils/defineTemplate.js";
+export default defineTemplate({
+    id: "prisma.service",
+    label: "Prisma Service",
+    fileName: "prisma.service",
+    outputDir: "{{srcDir}}/services",
+    render(symbolName) {
+        return `import { Injectable, OnInit, OnDestroy } from "@tsed/di";
+import { PrismaClient } from "@prisma/client";
+
+@Injectable()
+export class ${symbolName} extends PrismaClient implements OnInit, OnDestroy {
+  async $onInit() {
+    await this.$connect();
+  }
+
+  async $onDestroy() {
+    await this.$disconnect();
+  }
+}
+`;
+    }
+});

package/{templates/init/README.md.hbs → lib/esm/templates/readme.template.js}

@@ -1,9 +1,21 @@
-<p style="text-align: center" align="center">
+import { defineTemplate } from "../utils/defineTemplate.js";
+import { PackageManager } from "@tsed/cli-core";
+export default defineTemplate({
+    id: "readme",
+    label: "Readme file",
+    fileName: "README",
+    outputDir: ".",
+    ext: "md",
+    preserveCase: true,
+    hidden: true,
+    render(_, data) {
+        const pkgCmd = data.packageManager === PackageManager.YARN_BERRY ? "yarn" : data.packageManager;
+        return `<p style="text-align: center" align="center">
   <a href="https://tsed.dev" target="_blank"><img src="https://tsed.dev/tsed-og.png" width="200" alt="Ts.ED logo"/></a>
 </p>
 
 <div align="center">
-  <h1>Ts.ED - {{projectName}}</h1>
+  <h1>Ts.ED - ${data.projectName}</h1>
   <br />
   <div align="center">
     <a href="https://cli.tsed.dev/">Website</a>
@@ -23,35 +35,35 @@
 
 > **Important!** Ts.ED requires Node >= 20.x or Bun.js and TypeScript >= 5.
 
-```batch
+\`\`\`batch
 # install dependencies
-$ {{#if yarn}}yarn{{/if}}{{#if npm}}npm{{/if}}{{#if pnpm}}pnpm{{/if}} install
+$ ${pkgCmd} install
 
 # serve
-$ {{#if yarn}}yarn{{/if}}{{#if npm}}npm run{{/if}}{{#if pnpm}}pnpm{{/if}} start
+$ ${pkgCmd} start
 
 # build for production
-$ {{#if yarn}}yarn{{/if}}{{#if npm}}npm run{{/if}}{{#if pnpm}}pnpm{{/if}} build
-$ {{#if yarn}}yarn{{/if}}{{#if npm}}npm run{{/if}}{{#if pnpm}}pnpm{{/if}} start:prod
-```
+$ ${pkgCmd} run build
+$ ${pkgCmd} run start:prod
+\`\`\`
 
 ## Docker
 
-```
+\`\`\`
 # build docker image
 docker compose build
 
 # start docker image
 docker compose up
-```
+\`\`\`
 
 ## Barrels
 
 This project uses [barrels](https://www.npmjs.com/package/@tsed/barrels) to generate index files to import the controllers.
 
-Edit `.barrels.json` to customize it:
+Edit \`.barrels.json\` to customize it:
 
-```json
+\`\`\`json
 {
   "directory": [
     "./src/controllers/rest",
@@ -64,4 +76,7 @@ Edit `.barrels.json` to customize it:
   ],
   "delete": true
 }
-```
+\`\`\`
+`;
+    }
+});

package/lib/esm/templates/repository.template.js

@@ -0,0 +1,16 @@
+import { defineTemplate } from "../utils/defineTemplate.js";
+export default defineTemplate({
+    id: "repository",
+    label: "Repository",
+    fileName: "{{symbolName}}.repository",
+    outputDir: "{{srcDir}}/services",
+    render(symbolName) {
+        return `import {Injectable} from "@tsed/di";
+
+@Injectable()
+export class ${symbolName} {
+
+}
+`;
+    }
+});

package/lib/esm/templates/response-filter.template.js

@@ -0,0 +1,19 @@
+import { defineTemplate } from "../utils/defineTemplate.js";
+export default defineTemplate({
+    id: "response-filter",
+    label: "Response Filter",
+    fileName: "{{symbolName}}.response-filter",
+    outputDir: "{{srcDir}}/filters",
+    render(symbolName) {
+        return `import {ResponseFilter, ResponseFilterMethods} from "@tsed/platform-response-filter";
+import {BaseContext} from "@tsed/di";
+
+@ResponseFilter("text/xml")
+export class ${symbolName} implements ResponseFilterMethods {
+  transform(data: any, ctx: BaseContext) {
+    return jsToXML(data);
+  }
+}
+`;
+    }
+});

package/lib/esm/templates/server.template.js

@@ -0,0 +1,37 @@
+import { defineTemplate } from "../utils/defineTemplate.js";
+export default defineTemplate({
+    id: "server",
+    label: "Server",
+    description: "Create a new server file",
+    outputDir: "{{srcDir}}",
+    fileName: "server",
+    hidden: true,
+    render() {
+        return `import "@tsed/platform-log-request";
+import "@tsed/ajv";
+
+import {join} from "node:path";
+import {Configuration} from "@tsed/di";
+import {application} from "@tsed/platform-http";
+
+import {config} from "@/config/config.js";
+
+@Configuration({
+  ...config,
+  acceptMimes: ["application/json"],
+  httpPort: process.env.PORT || 8083,
+  httpsPort: false, // CHANGE
+  mount: {},
+  views: {
+    root: join(process.cwd(), "../views"),
+    extensions: {
+      ejs: "ejs"
+    }
+  }
+})
+export class Server {
+  protected app = application();
+}
+`;
+    }
+});

package/lib/esm/templates/service.template.js

@@ -0,0 +1,16 @@
+import { defineTemplate } from "../utils/defineTemplate.js";
+export default defineTemplate({
+    id: "service",
+    label: "Service",
+    fileName: "{{symbolName}}.service",
+    outputDir: "{{srcDir}}/services",
+    render(symbolName) {
+        return `import {Injectable} from "@tsed/di";
+
+@Injectable()
+export class ${symbolName} {
+
+}
+`;
+    }
+});

package/lib/esm/templates/tsconfig.spec.template.js

@@ -0,0 +1,34 @@
+import { defineTemplate } from "../utils/defineTemplate.js";
+export default defineTemplate({
+    id: "tsconfig.spec.json",
+    label: "TSConfig",
+    description: "Create a tsconfig.json file.",
+    fileName: "tsconfig",
+    outputDir: ".",
+    ext: "json",
+    preserveCase: true,
+    render: function (_, data) {
+        const tsconfig = {
+            extends: "./tsconfig.base.json",
+            compilerOptions: {
+                baseUrl: ".",
+                rootDir: ".",
+                noEmit: true,
+                paths: {
+                    "@/*": ["src/*"]
+                },
+                types: ["node"]
+            },
+            include: ["src/**/*"],
+            exclude: ["dist", "coverage", "node_modules"]
+        };
+        if (data.jest) {
+            tsconfig.compilerOptions.types.push("jest");
+        }
+        if (data.vitest) {
+            tsconfig.compilerOptions.types.push("vitest/globals", "vitest/importMeta", "vite/client", "vitest");
+            tsconfig.include.push("vitest.config.mts");
+        }
+        return JSON.stringify(tsconfig, null, 2);
+    }
+});

package/lib/esm/templates/tsconfig.template.js

@@ -0,0 +1,31 @@
+import { defineTemplate } from "../utils/defineTemplate.js";
+export default defineTemplate({
+    id: "tsconfig.config.json",
+    label: "TSConfig",
+    description: "Create a tsconfig.json file.",
+    fileName: "tsconfig",
+    outputDir: ".",
+    ext: "json",
+    preserveCase: true,
+    render(_, data) {
+        const tsconfig = {
+            extends: "./tsconfig.base.json",
+            compilerOptions: {
+                baseUrl: ".",
+                noEmit: true
+            },
+            include: [],
+            references: [
+                {
+                    path: "./tsconfig.node.json"
+                }
+            ]
+        };
+        if (data.testing) {
+            tsconfig.references?.push({
+                path: "./tsconfig.test.json"
+            });
+        }
+        return JSON.stringify(tsconfig, null, 2);
+    }
+});

package/lib/esm/templates/value.template.js

@@ -0,0 +1,13 @@
+import { defineTemplate } from "../utils/defineTemplate.js";
+export default defineTemplate({
+    id: "value",
+    label: "Value",
+    fileName: "{{symbolName}}.value",
+    outputDir: "{{srcDir}}/services",
+    render(symbolName) {
+        return `import {injectable} from "@tsed/di";
+
+export const ${symbolName} = injectable(Symbol.for("${symbolName}")).value({}).token();
+`;
+    }
+});

package/lib/esm/utils/defineTemplate.js

@@ -0,0 +1,13 @@
+import { injectable } from "@tsed/di";
+export function defineTemplate(opts) {
+    const provider = injectable(Symbol.for(`TEMPLATE:${opts.id}`))
+        .type("CLI_TEMPLATES")
+        .factory(() => ({
+        ext: "ts",
+        ...opts
+    }));
+    if (opts.hooks) {
+        provider.hooks(opts.hooks);
+    }
+    return opts;
+}