npm - @trinacria/cli - Versions diffs - 0.1.1-alpha.1 - Mend

@trinacria/cli 0.1.1-alpha.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.

This version of @trinacria/cli might be problematic. Click here for more details.

Files changed (129) hide show

package/dist/templates/api-prisma-postgresql/src/global/config.service.ts ADDED Viewed

@@ -0,0 +1,92 @@
+import fs from "node:fs";
+import path from "node:path";
+import { createToken } from "@trinacria/core";
+import {
+  formatValidationError,
+  Infer,
+  s,
+  ValidationError,
+} from "@trinacria/schema";
+export const configSchema = s.object({
+  ENV: s.enum(["development", "staging", "production"]).default("development"),
+  PORT: s.number({ coerce: true, int: true, min: 1, max: 65535 }).default(4001),
+  HOST: s.string().default("127.0.0.1"),
+  DATABASE_URL: s.string(),
+  OPENAPI_ENABLED: s.boolean({ coerce: true }).default(true),
+  CORS_ALLOWED_ORIGINS: s.array(s.string(), { coerce: true }).default([]),
+});
+export type ConfigModel = Infer<typeof configSchema>;
+export const CONFIG_SERVICE = createToken<ConfigService>("CONFIG_SERVICE");
+export class ConfigService {
+  private readonly config: ConfigModel;
+  constructor() {
+    this.loadEnvFile();
+    try {
+      this.config = configSchema.parse(process.env);
+    } catch (error) {
+      if (error instanceof ValidationError) {
+        throw new Error(
+          formatValidationError(error, {
+            prefix: "Invalid environment configuration:",
+          }),
+        );
+      }
+      throw error;
+    }
+  }
+  private loadEnvFile() {
+    const currentEnv = process.env.ENV || "development";
+    const fileNames = [".env", `.env.${currentEnv}`];
+    const roots = [
+      process.cwd(),
+      path.join(process.cwd(), "apps/api-prisma-postgresql"),
+    ];
+    fileNames.forEach((fileName) => {
+      roots.forEach((root) => {
+        const filePath = path.join(root, fileName);
+        if (!fs.existsSync(filePath)) {
+          return;
+        }
+        const data = fs.readFileSync(filePath, "utf8");
+        data.split("\n").forEach((line) => {
+          const trimmed = line.trim();
+          if (!trimmed || trimmed.startsWith("#")) {
+            return;
+          }
+          const separatorIndex = trimmed.indexOf("=");
+          if (separatorIndex === -1) {
+            return;
+          }
+          const key = trimmed.slice(0, separatorIndex).trim();
+          const rawValue = trimmed.slice(separatorIndex + 1).trim();
+          const value =
+            (rawValue.startsWith('"') && rawValue.endsWith('"')) ||
+            (rawValue.startsWith("'") && rawValue.endsWith("'"))
+              ? rawValue.slice(1, -1)
+              : rawValue;
+          process.env[key] = value;
+        });
+      });
+    });
+  }
+  get<K extends keyof ConfigModel>(key: K): ConfigModel[K] {
+    return this.config[key];
+  }
+  getAll(): ConfigModel {
+    return this.config;
+  }
+}

package/dist/templates/api-prisma-postgresql/src/global/controllers/swagger/docs.html ADDED Viewed

@@ -0,0 +1,28 @@
+<!doctype html>
+<html>
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <title>API Prisma PostgreSQL Docs</title>
+    <link
+      rel="stylesheet"
+      href="https://unpkg.com/swagger-ui-dist@5/swagger-ui.css"
+    />
+  </head>
+  <body>
+    <div id="swagger-ui"></div>
+    <script src="https://unpkg.com/swagger-ui-dist@5/swagger-ui-bundle.js"></script>
+    <script src="https://unpkg.com/swagger-ui-dist@5/swagger-ui-standalone-preset.js"></script>
+    <script>
+      window.ui = SwaggerUIBundle({
+        url: "/openapi.json",
+        dom_id: "#swagger-ui",
+        deepLinking: true,
+        tryItOutEnabled: true,
+        persistAuthorization: true,
+        presets: [SwaggerUIBundle.presets.apis, SwaggerUIStandalonePreset],
+        layout: "StandaloneLayout",
+      });
+    </script>
+  </body>
+</html>

package/dist/templates/api-prisma-postgresql/src/global/controllers/swagger/swagger-docs.controller.ts ADDED Viewed

@@ -0,0 +1,79 @@
+import { createToken } from "@trinacria/core";
+import { HttpController, response } from "@trinacria/http";
+import fs from "node:fs/promises";
+import path from "node:path";
+import type { ConfigService } from "../../config.service";
+export const SWAGGER_DOCS_CONTROLLER = createToken<SwaggerDocsController>(
+  "SWAGGER_DOCS_CONTROLLER",
+);
+export class SwaggerDocsController extends HttpController {
+  constructor(private readonly config: ConfigService) {
+    super();
+  }
+  routes() {
+    return this.router()
+      .get("/docs", this.renderDocs, {
+        docs: {
+          excludeFromOpenApi: true,
+        },
+      })
+      .build();
+  }
+  async renderDocs() {
+    if (!this.config.get("OPENAPI_ENABLED")) {
+      return response({ message: "OpenAPI is disabled" }, { status: 404 });
+    }
+    return response(await readSwaggerHtml(), {
+      headers: {
+        "content-type": "text/html; charset=utf-8",
+        "content-security-policy": docsContentSecurityPolicy(),
+      },
+    });
+  }
+}
+let cachedSwaggerHtml: string | undefined;
+async function readSwaggerHtml(): Promise<string> {
+  if (cachedSwaggerHtml) {
+    return cachedSwaggerHtml;
+  }
+  const candidates = [
+    path.resolve(process.cwd(), "src/global/controllers/swagger/docs.html"),
+    path.resolve(
+      process.cwd(),
+      "apps/api-prisma-postgresql/src/global/controllers/swagger/docs.html",
+    ),
+  ];
+  for (const filePath of candidates) {
+    try {
+      cachedSwaggerHtml = await fs.readFile(filePath, "utf8");
+      return cachedSwaggerHtml;
+    } catch {
+      // keep trying next candidate
+    }
+  }
+  throw new Error("Swagger docs HTML template not found.");
+}
+function docsContentSecurityPolicy(): string {
+  return [
+    "default-src 'self'",
+    "base-uri 'self'",
+    "object-src 'none'",
+    "frame-ancestors 'none'",
+    "script-src 'self' 'unsafe-inline' https://unpkg.com",
+    "style-src 'self' 'unsafe-inline' https://unpkg.com",
+    "img-src 'self' data: blob:",
+    "font-src 'self' data: https://unpkg.com",
+    "connect-src 'self'",
+  ].join("; ");
+}

package/dist/templates/api-prisma-postgresql/src/global/prisma.service.ts ADDED Viewed

@@ -0,0 +1,20 @@
+import { PrismaPg } from "@prisma/adapter-pg";
+import { PrismaClient } from "@prisma/client";
+import { createToken } from "@trinacria/core";
+import type { ConfigService } from "./config.service";
+export const PRISMA_SERVICE = createToken<PrismaService>("PRISMA_SERVICE");
+export class PrismaService extends PrismaClient {
+  constructor(private readonly configService: ConfigService) {
+    super({
+      adapter: new PrismaPg({
+        connectionString: configService.get("DATABASE_URL"),
+      }),
+    });
+  }
+  async onDestroy(): Promise<void> {
+    await this.$disconnect();
+  }
+}

package/dist/templates/api-prisma-postgresql/src/global/register-global-controllers.ts ADDED Viewed

@@ -0,0 +1,20 @@
+import { TrinacriaApp } from "@trinacria/core";
+import { httpProvider } from "@trinacria/http";
+import { ConfigService, CONFIG_SERVICE } from "./config.service";
+import {
+  SWAGGER_DOCS_CONTROLLER,
+  SwaggerDocsController,
+} from "./controllers/swagger/swagger-docs.controller";
+export function registerGlobalControllers(
+  app: TrinacriaApp,
+  config: ConfigService,
+): void {
+  if (config.get("OPENAPI_ENABLED")) {
+    app.registerGlobalProvider(
+      httpProvider(SWAGGER_DOCS_CONTROLLER, SwaggerDocsController, [
+        CONFIG_SERVICE,
+      ]),
+    );
+  }
+}

package/dist/templates/api-prisma-postgresql/src/main.ts ADDED Viewed

@@ -0,0 +1,70 @@
+import { TrinacriaApp, classProvider, valueProvider } from "@trinacria/core";
+import {
+  cors,
+  createHttpPlugin,
+  createSecurityHeadersBuilder,
+  rateLimit,
+  requestId,
+  requestLogger,
+  requestTimeout,
+} from "@trinacria/http";
+import { CONFIG_SERVICE, ConfigService } from "./global/config.service";
+import { PrismaService, PRISMA_SERVICE } from "./global/prisma.service";
+import { registerGlobalControllers } from "./global/register-global-controllers";
+import { UsersModule } from "./modules/users/users.module";
+async function bootstrap() {
+  const app = new TrinacriaApp();
+  const configService = new ConfigService();
+  const config = configService.getAll();
+  const isProduction = config.ENV === "production";
+  const corsOrigins = config.CORS_ALLOWED_ORIGINS;
+  const securityHeadersMiddleware = createSecurityHeadersBuilder()
+    .preset(config.ENV)
+    .trustProxy(false)
+    .build();
+  app.registerGlobalProvider(valueProvider(CONFIG_SERVICE, configService));
+  app.registerGlobalProvider(
+    classProvider(PRISMA_SERVICE, PrismaService, [CONFIG_SERVICE]),
+  );
+  registerGlobalControllers(app, configService);
+  app.use(
+    createHttpPlugin({
+      host: config.HOST,
+      port: config.PORT,
+      middlewares: [
+        requestId(),
+        requestLogger({ includeUserAgent: !isProduction }),
+        cors({
+          origin: corsOrigins.length > 0 ? corsOrigins : "*",
+          credentials: true,
+          methods: ["GET", "POST", "PUT", "PATCH", "DELETE", "OPTIONS", "HEAD"],
+        }),
+        rateLimit({
+          windowMs: 60_000,
+          max: isProduction ? 240 : 2_000,
+          trustProxy: false,
+        }),
+        requestTimeout({ timeoutMs: 15_000 }),
+        securityHeadersMiddleware,
+      ],
+      openApi: config.OPENAPI_ENABLED
+        ? {
+            enabled: true,
+            title: "API Prisma PostgreSQL Example",
+            version: "1.0.0",
+          }
+        : undefined,
+    }),
+  );
+  await app.registerModule(UsersModule);
+  await app.start();
+}
+bootstrap().catch((error) => {
+  console.error(error);
+  process.exit(1);
+});

package/dist/templates/api-prisma-postgresql/src/modules/users/dto/create-user.dto.ts ADDED Viewed

@@ -0,0 +1,14 @@
+import { s } from "@trinacria/schema";
+export interface CreateUserDto {
+  name: string;
+  email: string;
+}
+export const CreateUserDtoSchema = s.objectOf<CreateUserDto>()(
+  {
+    name: s.string({ trim: true, minLength: 1 }),
+    email: s.string({ trim: true, toLowerCase: true, email: true }),
+  },
+  { strict: true },
+);

package/dist/templates/api-prisma-postgresql/src/modules/users/dto/index.ts ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ export * from "./create-user.dto";
2	+ export * from "./public-user.dto";

package/dist/templates/api-prisma-postgresql/src/modules/users/dto/public-user.dto.ts ADDED Viewed

@@ -0,0 +1,22 @@
+import { s } from "@trinacria/schema";
+export interface PublicUserDto {
+  id: string;
+  name: string;
+  email: string;
+  createdAt: Date;
+  updatedAt: Date;
+}
+export const PublicUserDtoSchema = s.objectOf<PublicUserDto>()(
+  {
+    id: s.string({ trim: true, minLength: 1 }),
+    name: s.string({ trim: true, minLength: 1 }),
+    email: s.string({ trim: true, toLowerCase: true, email: true }),
+    createdAt: s.date(),
+    updatedAt: s.date(),
+  },
+  { strict: true },
+);
+export const PublicUserListDtoSchema = s.array(PublicUserDtoSchema);

package/dist/templates/api-prisma-postgresql/src/modules/users/users.controller.ts ADDED Viewed

@@ -0,0 +1,89 @@
+import {
+  ConflictException,
+  HttpController,
+  HttpContext,
+  response,
+} from "@trinacria/http";
+import { UsersService } from "./users.service";
+import {
+  CreateUserDtoSchema,
+  PublicUserDtoSchema,
+  PublicUserListDtoSchema,
+} from "./dto";
+export class UsersController extends HttpController {
+  constructor(private readonly users: UsersService) {
+    super();
+  }
+  routes() {
+    return this.router()
+      .get("/health", () => ({ status: "ok" }), {
+        docs: {
+          tags: ["Health"],
+          summary: "Health check",
+        },
+      })
+      .get("/users", this.listUsers, {
+        docs: {
+          tags: ["Users"],
+          summary: "List users",
+          responses: {
+            200: {
+              description: "Users list",
+              schema: PublicUserListDtoSchema.toOpenApi(),
+            },
+          },
+        },
+      })
+      .post("/users", this.createUser, {
+        docs: {
+          tags: ["Users"],
+          summary: "Create user",
+          requestBody: {
+            required: true,
+            schema: CreateUserDtoSchema.toOpenApi(),
+          },
+          responses: {
+            201: {
+              description: "Created user",
+              schema: PublicUserDtoSchema.toOpenApi(),
+            },
+            409: {
+              description: "Email already exists",
+            },
+          },
+        },
+      })
+      .build();
+  }
+  async listUsers() {
+    return this.users.list();
+  }
+  async createUser(ctx: HttpContext) {
+    const payload = CreateUserDtoSchema.parse(ctx.body);
+    try {
+      const created = await this.users.create(payload);
+      return response(created, {
+        status: 201,
+        headers: {
+          location: `/users/${created.id}`,
+        },
+      });
+    } catch (error) {
+      if (
+        error &&
+        typeof error === "object" &&
+        "code" in error &&
+        error.code === "P2002"
+      ) {
+        throw new ConflictException("Email already exists");
+      }
+      throw error;
+    }
+  }
+}

package/dist/templates/api-prisma-postgresql/src/modules/users/users.module.ts ADDED Viewed

@@ -0,0 +1,15 @@
+import { classProvider, defineModule } from "@trinacria/core";
+import { httpProvider } from "@trinacria/http";
+import { PRISMA_SERVICE } from "../../global/prisma.service";
+import { USERS_CONTROLLER, USERS_SERVICE } from "./users.tokens";
+import { UsersController } from "./users.controller";
+import { UsersService } from "./users.service";
+export const UsersModule = defineModule({
+  name: "UsersModule",
+  providers: [
+    classProvider(USERS_SERVICE, UsersService, [PRISMA_SERVICE]),
+    httpProvider(USERS_CONTROLLER, UsersController, [USERS_SERVICE]),
+  ],
+  exports: [USERS_SERVICE, USERS_CONTROLLER],
+});

package/dist/templates/api-prisma-postgresql/src/modules/users/users.service.ts ADDED Viewed

@@ -0,0 +1,36 @@
+import type { Prisma } from "@prisma/client";
+import { PrismaService } from "../../global/prisma.service";
+import type { CreateUserDto } from "./dto";
+const userSelect = {
+  id: true,
+  name: true,
+  email: true,
+  createdAt: true,
+  updatedAt: true,
+} satisfies Prisma.UserSelect;
+type UserRecord = Prisma.UserGetPayload<{
+  select: typeof userSelect;
+}>;
+export class UsersService {
+  constructor(private readonly prisma: PrismaService) {}
+  async list(): Promise<UserRecord[]> {
+    return this.prisma.user.findMany({
+      select: userSelect,
+      orderBy: { createdAt: "desc" },
+    });
+  }
+  async create(input: CreateUserDto): Promise<UserRecord> {
+    return this.prisma.user.create({
+      select: userSelect,
+      data: {
+        name: input.name,
+        email: input.email.toLowerCase(),
+      },
+    });
+  }
+}

package/dist/templates/api-prisma-postgresql/src/modules/users/users.tokens.ts ADDED Viewed

@@ -0,0 +1,7 @@
+import { createToken } from "@trinacria/core";
+import { UsersController } from "./users.controller";
+import { UsersService } from "./users.service";
+export const USERS_SERVICE = createToken<UsersService>("USERS_SERVICE");
+export const USERS_CONTROLLER =
+  createToken<UsersController>("USERS_CONTROLLER");

package/dist/templates/api-prisma-postgresql/trinacria.config.mjs ADDED Viewed

@@ -0,0 +1,12 @@
+/** @type {import('@trinacria/cli').TrinacriaConfig} */
+const config = {
+  entry: "src/main.ts",
+  outDir: "dist",
+  watchDir: "src",
+  env: "development",
+  crashLoopWindowMs: 15_000,
+  maxConsecutiveCrashRestarts: 3,
+};
+export default config;

package/dist/templates/api-prisma-postgresql/tsconfig.json ADDED Viewed

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "types": ["node"],
+    "target": "ES2022",
+    "module": "CommonJS",
+    "strict": true,
+    "declaration": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "rootDir": "src",
+    "outDir": "dist"
+  },
+  "include": ["src"]
+}

package/dist/templates/app-starter/.env.example ADDED Viewed

	@@ -0,0 +1 @@
1	+ # No environment variables required for this app.

package/dist/templates/app-starter/Dockerfile ADDED Viewed

@@ -0,0 +1,13 @@
+FROM node:24-bookworm-slim
+WORKDIR /app
+COPY package.json package-lock.json tsconfig.base.json ./
+COPY packages ./packages
+COPY apps/app-starter ./apps/app-starter
+RUN npm ci
+RUN npm run build:packages
+RUN npm run build -w app-starter
+CMD ["npm", "run", "start", "-w", "app-starter"]

package/dist/templates/app-starter/README.md ADDED Viewed

@@ -0,0 +1,32 @@
+# App Starter
+A minimal Trinacria app with only `TrinacriaApp` bootstrap and a `Hello World` log.
+This template does not include:
+- plugins
+- modules
+- database
+- HTTP API
+## Start
+```bash
+npm run dev
+```
+## Docker quick start
+```bash
+docker compose \
+  -f docker-compose.yml \
+  up --build -d
+```
+To stop:
+```bash
+docker compose \
+  -f docker-compose.yml \
+  down
+```

package/dist/templates/app-starter/docker-compose.yml ADDED Viewed

@@ -0,0 +1,8 @@
+services:
+  app:
+    build:
+      context: ../..
+      dockerfile: apps/app-starter/Dockerfile
+    environment:
+      ENV: production
+    restart: unless-stopped

package/dist/templates/app-starter/package.json ADDED Viewed

@@ -0,0 +1,14 @@
+{
+  "name": "app-starter",
+  "private": true,
+  "type": "commonjs",
+  "scripts": {
+    "start": "node ../../packages/cli/dist/index.js start",
+    "build": "node ../../packages/cli/dist/index.js build",
+    "dev": "node ../../packages/cli/dist/index.js dev"
+  },
+  "dependencies": {
+    "@trinacria/cli": "*",
+    "@trinacria/core": "*"
+  }
+}

package/dist/templates/app-starter/src/main.ts ADDED Viewed

@@ -0,0 +1,14 @@
+import { ConsoleLogger, TrinacriaApp } from "@trinacria/core";
+async function bootstrap() {
+  const app = new TrinacriaApp();
+  const logger = new ConsoleLogger("app-starter");
+  logger.info("Hello World");
+  await app.start();
+}
+bootstrap().catch((error) => {
+  console.error(error);
+  process.exit(1);
+});

package/dist/templates/app-starter/trinacria.config.mjs ADDED Viewed

@@ -0,0 +1,12 @@
+/** @type {import('@trinacria/cli').TrinacriaConfig} */
+const config = {
+  entry: "src/main.ts",
+  outDir: "dist",
+  watchDir: "src",
+  env: "development",
+  crashLoopWindowMs: 15_000,
+  maxConsecutiveCrashRestarts: 3,
+};
+export default config;

package/dist/templates/app-starter/tsconfig.json ADDED Viewed

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "types": ["node"],
+    "target": "ES2022",
+    "module": "CommonJS",
+    "strict": true,
+    "declaration": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "rootDir": "src",
+    "outDir": "dist"
+  },
+  "include": ["src"]
+}

package/dist/templates/cron-example/.env.example ADDED Viewed

@@ -0,0 +1,11 @@
+# Cron example environment template
+# Copy to .env.development (or .env) and tweak values.
+CRON_ENABLED=true
+CRON_TICK_MS=1000
+HEARTBEAT_INTERVAL_MS=10000
+# Docker overrides used by docker-compose.yml
+DOCKER_CRON_ENABLED=true
+DOCKER_CRON_TICK_MS=1000
+DOCKER_HEARTBEAT_INTERVAL_MS=10000

package/dist/templates/cron-example/Dockerfile ADDED Viewed

@@ -0,0 +1,13 @@
+FROM node:24-bookworm-slim
+WORKDIR /app
+COPY package.json package-lock.json tsconfig.base.json ./
+COPY packages ./packages
+COPY apps/cron-example ./apps/cron-example
+RUN npm ci
+RUN npm run build:packages
+RUN npm run build -w cron-example
+CMD ["npm", "run", "start", "-w", "cron-example"]