@tsed/cli 7.0.0-alpha.9 → 7.0.0-beta.10

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.command.template.js

@@ -11,7 +11,7 @@ export default defineTemplate({
         return `#!/usr/bin/env node
 import {CliCore} from "@tsed/cli-core";
 import {config} from "@/config/config.js";
-import * commands from "@/bin/commands/index.js";
+import * as commands from "@/bin/commands/index.js";
 
 CliCore.bootstrap({
   ...config,

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

@@ -6,33 +6,37 @@ export default defineTemplate({
     outputDir: "{{srcDir}}/controllers/pages",
     fileName: "index.controller",
     hidden: true,
-    render() {
+    render(_, ctx) {
         return `import {Constant, Controller} from "@tsed/di";
 import {HeaderParams} from "@tsed/platform-params";
-import {View} from "@tsed/platform-views";
-import {SwaggerSettings} from "@tsed/swagger";
+import {View} from "@tsed/schema";
+${ctx.swagger ? 'import type {SwaggerSettings} from "@tsed/swagger";' : ""}
 import {Hidden, Get, Returns} from "@tsed/schema";
 
 @Hidden()
 @Controller("/")
 export class IndexController {
-  @Constant("swagger", [])
-  private swagger: SwaggerSettings[];
+  ${ctx.swagger
+            ? `@Constant("swagger", [])
+  private swagger: SwaggerSettings[];`
+            : ""}
 
   @Get("/")
-  @View("swagger.ejs")
+  @View("home.ejs")
   @(Returns(200, String).ContentType("text/html"))
   get(@HeaderParams("x-forwarded-proto") protocol: string, @HeaderParams("host") host: string) {
     const hostUrl = \`\${protocol || "http"}://\${host}\`;
 
     return {
       BASE_URL: hostUrl,
-      docs: this.swagger.map((conf) => {
+      docs: ${ctx.swagger
+            ? `this.swagger.map((conf) => {
         return {
           url: hostUrl + conf.path,
           ...conf
         };
-      })
+      })`
+            : "[]"}
     };
   }
 }`;

package/lib/esm/templates/index.js

@@ -1,5 +1,6 @@
 // Import all templates to register them with the DI container
 import "./asyncFactory.template.js";
+import "./agents.template.js";
 import "./command.template.js";
 import "./controller.template.js";
 import "./decorator.template.js";

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
+    };
+};