@tsed/cli 7.0.0-beta.1 → 7.0.0-beta.3

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

@@ -3,12 +3,13 @@ import { camelCase, pascalCase } from "change-case";
 export default defineTemplate({
     id: "async.factory",
     label: "Async Factory",
+    description: "Generate an async factory token for Ts.ED DI in src/services.",
     fileName: "{{symbolName}}.factory?",
     outputDir: "{{srcDir}}/services",
     render(symbolName) {
         const camelName = camelCase(symbolName);
         const optName = pascalCase(symbolName + "Options");
-        return `import {injectable} from "@tsed/di";
+        return `import {injectable, constant} from "@tsed/di";
 
 interface ${optName} {
   
@@ -17,7 +18,7 @@ interface ${optName} {
 declare global {
   namespace TsED {
     interface Configuration extends Record<string, any> {
-      ${camelName}: Options;
+      ${camelName}: ${optName};
     }
   }
 }    
@@ -33,6 +34,6 @@ export const ${symbolName} = injectable(Symbol.for("${symbolName}"))
   })
   .token();
   
-export type {{symbolName}} = typeof ${symbolName};`;
+export type ${symbolName} = typeof ${symbolName};`;
     }
 });

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

@@ -9,9 +9,6 @@ export default defineTemplate({
     outputDir: ".",
     hidden: true,
     preserveCase: true,
-    prompts() {
-        return [];
-    },
     render(_, context) {
         const barrels = $alter("$alterBarrels", {
             directory: [

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

@@ -3,6 +3,7 @@ import { kebabCase } from "change-case";
 export default defineTemplate({
     id: "command",
     label: "Command",
+    description: "Create a CLI command provider with prompts, context mapping and tasks in src/bin/commands.",
     fileName: "{{symbolName}}.command",
     outputDir: "{{srcDir}}/bin/commands",
     render(symbolName) {

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

@@ -1,9 +1,16 @@
 import { defineTemplate } from "../utils/defineTemplate.js";
+import { object, string } from "@tsed/schema";
 export default defineTemplate({
     id: "controller",
     label: "Controller",
+    description: "Create a new controller class with a sample GET endpoint in src/controllers.",
     fileName: "{{symbolName}}.controller",
     outputDir: "{{srcDir}}/controllers",
+    // Validation schema specific to this template (do not include global fields `type` and `name`)
+    schema: object({
+        route: string().pattern(/^\//).description("Route starting with '/' (e.g., '/users')"),
+        directory: string().description("Sub-directory under src/controllers")
+    }),
     prompts(context) {
         return [
             {

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

@@ -1,9 +1,30 @@
 import { defineTemplate } from "../utils/defineTemplate.js";
+import { s } from "@tsed/schema";
+const choices = [
+    { name: "Class Decorator", value: "class" },
+    { name: "Generic Decorator (class, property)", value: "generic" },
+    { name: "Method Decorator", value: "method" },
+    { name: "Parameter Decorator", value: "param" },
+    { name: "Property Decorator", value: "property" },
+    { name: "Property Decorator (with @Property)", value: "prop" },
+    { name: "Parameters Decorator", value: "parameters" },
+    { name: "Endpoint Decorator", value: "endpoint" },
+    { name: "Middleware Decorator", value: "middleware" }
+];
 export default defineTemplate({
     id: "decorator",
     label: "Decorator",
+    description: "Scaffold a custom decorator with variants (class, generic, method, parameter, property, endpoint, middleware) in src/decorators.",
     fileName: "{{symbolName}}",
     outputDir: "{{srcDir}}/decorators",
+    schema: s.object({
+        templateType: s
+            .string()
+            .enum("class", "generic", "method", "param", "property", "prop", "parameters", "endpoint", "middleware")
+            .customKey("x-choices", choices)
+            .default("class")
+            .description("sub-type of the template to generate the decorator")
+    }),
     prompts(context) {
         return [
             {
@@ -13,17 +34,7 @@ export default defineTemplate({
                 when(state) {
                     return !!(["decorator"].includes(state.type || context.type) || context.templateType);
                 },
-                choices: [
-                    { name: "Class Decorator", value: "class" },
-                    { name: "Generic Decorator (class, property)", value: "generic" },
-                    { name: "Method Decorator", value: "method" },
-                    { name: "Parameter Decorator", value: "param" },
-                    { name: "Property Decorator", value: "property" },
-                    { name: "Property Decorator (with @Property)", value: "prop" },
-                    { name: "Parameters Decorator", value: "parameters" },
-                    { name: "Endpoint Decorator", value: "endpoint" },
-                    { name: "Middleware Decorator", value: "middleware" }
-                ],
+                choices,
                 default: "class"
             }
         ];

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

@@ -33,6 +33,7 @@ ENV NODE_ENV production`;
 defineTemplate({
     id: "dockerfile.yarn",
     label: "Dockerfile (Yarn classic)",
+    description: "Generate a multi-stage Dockerfile for production builds using Yarn classic.",
     fileName: "Dockerfile",
     outputDir: ".",
     ext: null,
@@ -72,6 +73,7 @@ CMD ["pm2-runtime", "start", "processes.config.cjs", "--env", "production"]
 defineTemplate({
     id: "dockerfile.yarn_berry",
     label: "Dockerfile (Yarn Berry)",
+    description: "Generate a multi-stage Dockerfile for production builds using Yarn Berry (modern Yarn).",
     fileName: "Dockerfile",
     outputDir: ".",
     ext: null,
@@ -114,6 +116,7 @@ CMD ["pm2-runtime", "start", "processes.config.cjs", "--env", "production"]
 defineTemplate({
     id: "dockerfile.npm",
     label: "Dockerfile (NPM)",
+    description: "Generate a multi-stage Dockerfile for production builds using NPM.",
     fileName: "Dockerfile",
     outputDir: ".",
     ext: null,
@@ -152,6 +155,7 @@ CMD ["pm2-runtime", "start", "processes.config.cjs", "--env", "production"]`;
 defineTemplate({
     id: "dockerfile.pnpm",
     label: "Dockerfile (PNPM)",
+    description: "Generate a multi-stage Dockerfile for production builds using PNPM.",
     fileName: "Dockerfile",
     outputDir: ".",
     ext: null,
@@ -191,6 +195,7 @@ CMD ["pm2-runtime", "start", "processes.config.cjs", "--env", "production"]
 defineTemplate({
     id: "dockerfile.bun",
     label: "Dockerfile (Bun)",
+    description: "Generate a multi-stage Dockerfile for production builds using Bun.",
     fileName: "Dockerfile",
     outputDir: ".",
     ext: null,

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

@@ -2,6 +2,7 @@ import { defineTemplate } from "../utils/defineTemplate.js";
 export default defineTemplate({
     id: "exception-filter",
     label: "Exception Filter",
+    description: "Create an exception filter class annotated with @Catch to handle thrown errors in src/filters.",
     fileName: "{{symbolName}}.exception-filter",
     outputDir: "{{srcDir}}/filters",
     render(symbolName) {

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

@@ -3,12 +3,13 @@ import { camelCase, pascalCase } from "change-case";
 export default defineTemplate({
     id: "factory",
     label: "Factory",
+    description: "Generate a synchronous factory token for Ts.ED DI in src/services.",
     fileName: "{{symbolName}}.factory?",
     outputDir: "{{srcDir}}/services",
     render(symbolName) {
         const camelName = camelCase(symbolName);
         const optName = pascalCase(symbolName + "Options");
-        return `import {injectable} from "@tsed/di";
+        return `import {injectable, constant} from "@tsed/di";
 
 interface ${optName} {
   
@@ -17,7 +18,7 @@ interface ${optName} {
 declare global {
   namespace TsED {
     interface Configuration extends Record<string, any> {
-      ${camelName}: Options;
+      ${camelName}: ${optName};
     }
   }
 }    
@@ -32,6 +33,6 @@ export const ${symbolName} = injectable(Symbol.for("${symbolName}"))
   })
   .token();
   
-export type {{symbolName}} = typeof ${symbolName};`;
+export type ${symbolName} = typeof ${symbolName};`;
     }
 });

package/lib/esm/templates/index.logger.template.js

@@ -1,5 +1,4 @@
 import { defineTemplate } from "../utils/defineTemplate.js";
-import { ProjectConvention } from "../interfaces/index.js";
 export default defineTemplate({
     id: "index.logger",
     label: "Logger",

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

@@ -2,6 +2,7 @@ import { defineTemplate } from "../utils/defineTemplate.js";
 export default defineTemplate({
     id: "interceptor",
     label: "Interceptor",
+    description: "Create an interceptor class that can transform requests/responses in src/interceptors.",
     fileName: "{{symbolName}}.interceptor",
     outputDir: "{{srcDir}}/interceptors",
     render(symbolName) {

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

@@ -2,6 +2,7 @@ import { defineTemplate } from "../utils/defineTemplate.js";
 export default defineTemplate({
     id: "interface",
     label: "Interface",
+    description: "Create a TypeScript interface file in src/interfaces.",
     fileName: "{{symbolName}}.interface",
     outputDir: "{{srcDir}}/interfaces",
     render(symbolName) {

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

@@ -1,19 +1,29 @@
 import { defineTemplate } from "../utils/defineTemplate.js";
+import { s } from "@tsed/schema";
+const choices = [
+    { name: "Before the endpoint", value: "before" },
+    { name: "After the endpoint", value: "after" }
+];
 export default defineTemplate({
     id: "middleware",
     label: "Middleware",
+    description: "Create a middleware class implementing MiddlewareMethods in src/middlewares.",
     fileName: "{{symbolName}}.middleware",
     outputDir: "{{srcDir}}/middlewares",
+    schema: s.object({
+        middlewarePosition: s
+            .string()
+            .enum("before", "after")
+            .customKey("x-choices", choices)
+            .description("Middleware position (before, after).")
+    }),
     prompts(context) {
         return [
             {
                 type: "list",
                 name: "middlewarePosition",
                 message: () => `The middleware should be called:`,
-                choices: [
-                    { name: "Before the endpoint", value: "before" },
-                    { name: "After the endpoint", value: "after" }
-                ],
+                choices,
                 when(state) {
                     return !!((["decorator"].includes(state.type || context.type) && ["middleware"].includes(state.templateType)) ||
                         context.middlewarePosition);

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

@@ -2,6 +2,7 @@ import { defineTemplate } from "../utils/defineTemplate.js";
 export default defineTemplate({
     id: "model",
     label: "Model",
+    description: "Create a model class with a sample @Property in src/models.",
     fileName: "{{symbolName}}.model",
     outputDir: "{{srcDir}}/models",
     render(symbolName) {

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

@@ -2,6 +2,7 @@ import { defineTemplate } from "../utils/defineTemplate.js";
 export default defineTemplate({
     id: "module",
     label: "Module",
+    description: "Create a Ts.ED module class in src.",
     fileName: "{{symbolName}}.module",
     outputDir: "{{srcDir}}",
     render(symbolName) {

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

@@ -2,6 +2,7 @@ import { defineTemplate } from "../utils/defineTemplate.js";
 export default defineTemplate({
     id: "pipe",
     label: "Pipe",
+    description: "Create a custom pipe class implementing PipeMethods in src/pipes.",
     fileName: "{{symbolName}}.pipe",
     outputDir: "{{srcDir}}/pipes",
     render(symbolName) {

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

@@ -2,6 +2,7 @@ import { defineTemplate } from "../utils/defineTemplate.js";
 export default defineTemplate({
     id: "prisma.service",
     label: "Prisma Service",
+    description: "Generate a service based on PrismaClient with $onInit/$onDestroy hooks to manage the database connection.",
     fileName: "prisma.service",
     outputDir: "{{srcDir}}/services",
     render(symbolName) {

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

@@ -2,6 +2,7 @@ import { defineTemplate } from "../utils/defineTemplate.js";
 export default defineTemplate({
     id: "repository",
     label: "Repository",
+    description: "Create a repository class (service-like) for data access in src/services.",
     fileName: "{{symbolName}}.repository",
     outputDir: "{{srcDir}}/services",
     render(symbolName) {

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

@@ -2,6 +2,7 @@ import { defineTemplate } from "../utils/defineTemplate.js";
 export default defineTemplate({
     id: "response-filter",
     label: "Response Filter",
+    description: "Create a response filter that transforms output data (e.g., to XML) in src/filters.",
     fileName: "{{symbolName}}.response-filter",
     outputDir: "{{srcDir}}/filters",
     render(symbolName) {

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

@@ -2,6 +2,7 @@ import { defineTemplate } from "../utils/defineTemplate.js";
 export default defineTemplate({
     id: "service",
     label: "Service",
+    description: "Generate an injectable Ts.ED service (class decorated with @Injectable) in src/services.",
     fileName: "{{symbolName}}.service",
     outputDir: "{{srcDir}}/services",
     render(symbolName) {

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

@@ -2,6 +2,7 @@ import { defineTemplate } from "../utils/defineTemplate.js";
 export default defineTemplate({
     id: "value",
     label: "Value",
+    description: "Create a DI value token initialized with a constant object in src/services.",
     fileName: "{{symbolName}}.value",
     outputDir: "{{srcDir}}/services",
     render(symbolName) {

package/lib/esm/utils/resolveSchema.js

@@ -0,0 +1,17 @@
+import { JsonSchema } from "@tsed/schema";
+export async function resolveSchema(schema) {
+    if (!schema) {
+        return undefined;
+    }
+    const result = Object.entries(schema.get("properties")).map(async ([key, value]) => {
+        if (value instanceof JsonSchema && !value.get("x-choices")) {
+            const fn = value.get("x-remote-choices");
+            if (fn) {
+                value.customKey("x-choices", await fn());
+                value.customKey("x-remote-choices", undefined);
+            }
+        }
+    });
+    await Promise.all(result);
+    return schema.toJSON({ customKeys: true });
+}

package/lib/esm/utils/summarizeSchema.js

@@ -0,0 +1,24 @@
+export const summarizeSchema = (tpl) => {
+    if (!tpl.schema) {
+        return undefined;
+    }
+    const json = tpl.schema.toJSON();
+    if (!json.properties) {
+        return {};
+    }
+    const properties = {};
+    for (const [k, v] of Object.entries(json.properties)) {
+        const vv = v;
+        properties[k] = {
+            type: Array.isArray(vv.type) ? vv.type.join("|") : vv.type,
+            enum: vv.enum,
+            pattern: vv.pattern,
+            description: vv.description
+        };
+    }
+    const required = json.required || [];
+    return {
+        required: required.length ? required : undefined,
+        properties: Object.keys(properties).length ? properties : undefined
+    };
+};