create-charcole 2.2.0 → 2.2.2

package/template/ts/basePackage.json

@@ -1,36 +1,36 @@
-{
-  "name": "charcole",
-  "version": "2.2.0",
-  "description": "Production-grade Node.js Express API",
-  "main": "dist/server.js",
-  "type": "module",
-  "scripts": {
-    "start": "node dist/server.js",
-    "dev": "tsx watch src/server.ts",
-    "build": "node build.js",
-    "clean": "rimraf dist",
-    "prebuild": "npm run clean",
-    "lint": "echo \"Add linting here\"",
-    "test": "echo \"Add tests here\""
-  },
-  "engines": {
-    "node": ">=18.0.0"
-  },
-  "dependencies": {
-    "express": "^4.18.2",
-    "cors": "^2.8.5",
-    "dotenv": "^16.3.1",
-    "zod": "^3.25.76"
-  },
-  "devDependencies": {
-    "@types/cors": "^2.8.19",
-    "@types/express": "^4.17.21",
-    "@types/node": "^25.0.10",
-    "esbuild": "^0.24.2",
-    "rimraf": "^6.0.1",
-    "tsc-alias": "^1.8.8",
-    "tsx": "^4.19.2",
-    "typescript": "^5.9.3"
-  },
-  "license": "ISC"
-}
+{
+  "name": "charcole",
+  "version": "2.2.2",
+  "description": "Production-grade Node.js Express API",
+  "main": "dist/server.js",
+  "type": "module",
+  "scripts": {
+    "start": "node dist/server.js",
+    "dev": "tsx watch src/server.ts",
+    "build": "node build.js",
+    "clean": "rimraf dist",
+    "prebuild": "npm run clean",
+    "lint": "echo \"Add linting here\"",
+    "test": "echo \"Add tests here\""
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "dependencies": {
+    "express": "^4.18.2",
+    "cors": "^2.8.5",
+    "dotenv": "^16.3.1",
+    "zod": "^3.25.76"
+  },
+  "devDependencies": {
+    "@types/cors": "^2.8.19",
+    "@types/express": "^4.17.21",
+    "@types/node": "^25.0.10",
+    "esbuild": "^0.24.2",
+    "rimraf": "^6.0.1",
+    "tsc-alias": "^1.8.8",
+    "tsx": "^4.19.2",
+    "typescript": "^5.9.3"
+  },
+  "license": "ISC"
+}

package/template/ts/build.js

@@ -1,46 +1,46 @@
-import { build } from "esbuild";
-import { glob } from "glob";
-import fs from "fs";
-import path from "path";
-
-const entryPoints = await glob("src/**/*.ts");
-
-// Custom plugin to rewrite .ts imports to .js
-const rewriteImportsPlugin = {
-  name: "rewrite-imports",
-  setup(build) {
-    build.onLoad({ filter: /\.ts$/ }, async (args) => {
-      const contents = await fs.promises.readFile(args.path, "utf8");
-
-      // Replace .ts extensions with .js in imports
-      const modifiedContents = contents
-        .replace(/from\s+['"]([^'"]+)\.ts['"]/g, 'from "$1.js"')
-        .replace(/import\s+['"]([^'"]+)\.ts['"]/g, 'import "$1.js"');
-
-      return {
-        contents: modifiedContents,
-        loader: "ts",
-      };
-    });
-  },
-};
-
-await build({
-  entryPoints,
-  outdir: "dist",
-  bundle: false,
-  platform: "node",
-  format: "esm",
-  target: "es2020",
-  sourcemap: true,
-  outExtension: { ".js": ".js" },
-  packages: "external",
-  plugins: [rewriteImportsPlugin],
-})
-  .then(() => {
-    console.log("✅ Build completed successfully!");
-  })
-  .catch((error) => {
-    console.error("❌ Build failed:", error);
-    process.exit(1);
-  });
+import { build } from "esbuild";
+import { glob } from "glob";
+import fs from "fs";
+import path from "path";
+
+const entryPoints = await glob("src/**/*.ts");
+
+// Custom plugin to rewrite .ts imports to .js
+const rewriteImportsPlugin = {
+  name: "rewrite-imports",
+  setup(build) {
+    build.onLoad({ filter: /\.ts$/ }, async (args) => {
+      const contents = await fs.promises.readFile(args.path, "utf8");
+
+      // Replace .ts extensions with .js in imports
+      const modifiedContents = contents
+        .replace(/from\s+['"]([^'"]+)\.ts['"]/g, 'from "$1.js"')
+        .replace(/import\s+['"]([^'"]+)\.ts['"]/g, 'import "$1.js"');
+
+      return {
+        contents: modifiedContents,
+        loader: "ts",
+      };
+    });
+  },
+};
+
+await build({
+  entryPoints,
+  outdir: "dist",
+  bundle: false,
+  platform: "node",
+  format: "esm",
+  target: "es2020",
+  sourcemap: true,
+  outExtension: { ".js": ".js" },
+  packages: "external",
+  plugins: [rewriteImportsPlugin],
+})
+  .then(() => {
+    console.log("✅ Build completed successfully!");
+  })
+  .catch((error) => {
+    console.error("❌ Build failed:", error);
+    process.exit(1);
+  });

package/template/ts/src/app.ts

@@ -1,71 +1,71 @@
-import express, { Request, Response, NextFunction } from "express";
-import cors from "cors";
-import { userRepo } from "./repositories/user.repo.ts";
-import { env } from "./config/env.ts";
-import { requestLogger } from "./middlewares/requestLogger.ts";
-import {
-  errorHandler,
-  asyncHandler,
-  NotFoundError,
-} from "./middlewares/errorHandler.ts";
-import { sendSuccess } from "./utils/response.ts";
-import { logger } from "./utils/logger.ts";
-import routes from "./routes/index.ts";
-import swaggerOptions from "./config/swagger.config.ts";
-import { setupSwagger } from "@charcoles/swagger";
-
-export const app = express();
-
-app.set("trust proxy", 1);
-
-app.use(
-  cors({
-    origin: env.CORS_ORIGIN,
-    credentials: true,
-    methods: ["GET", "POST", "PUT", "DELETE", "PATCH", "OPTIONS"],
-    allowedHeaders: ["Content-Type", "Authorization"],
-  }),
-);
-
-app.use(express.json({ limit: "10mb" }));
-app.use(express.urlencoded({ extended: true, limit: "10mb" }));
-
-app.use((req: Request, res: Response, next: NextFunction) => {
-  req.setTimeout(env.REQUEST_TIMEOUT);
-  res.setTimeout(env.REQUEST_TIMEOUT);
-  next();
-});
-
-app.use(requestLogger);
-
-setupSwagger(app, swaggerOptions);
-
-app.use("/api", routes);
-
-app.get(
-  "/",
-  asyncHandler(async (_req: Request, res: Response) => {
-    sendSuccess(
-      res,
-      {
-        message: "Welcome to Charcole API",
-        version: "2.0.0",
-        environment: env.NODE_ENV,
-      },
-      200,
-      "API is online",
-    );
-  }),
-);
-
-app.use((req: Request) => {
-  throw new NotFoundError(`${req.method} ${req.path}`, {
-    method: req.method,
-    path: req.path,
-  });
-});
-
-app.use(errorHandler);
-
-logger.info("Express app configured successfully");
-app.locals.userRepo = userRepo;
+import express, { Request, Response, NextFunction } from "express";
+import cors from "cors";
+import { userRepo } from "./repositories/user.repo.ts";
+import { env } from "./config/env.ts";
+import { requestLogger } from "./middlewares/requestLogger.ts";
+import {
+  errorHandler,
+  asyncHandler,
+  NotFoundError,
+} from "./middlewares/errorHandler.ts";
+import { sendSuccess } from "./utils/response.ts";
+import { logger } from "./utils/logger.ts";
+import routes from "./routes/index.ts";
+import swaggerOptions from "./config/swagger.config.ts";
+import { setupSwagger } from "@charcoles/swagger";
+
+export const app = express();
+
+app.set("trust proxy", 1);
+
+app.use(
+  cors({
+    origin: env.CORS_ORIGIN,
+    credentials: true,
+    methods: ["GET", "POST", "PUT", "DELETE", "PATCH", "OPTIONS"],
+    allowedHeaders: ["Content-Type", "Authorization"],
+  }),
+);
+
+app.use(express.json({ limit: "10mb" }));
+app.use(express.urlencoded({ extended: true, limit: "10mb" }));
+
+app.use((req: Request, res: Response, next: NextFunction) => {
+  req.setTimeout(env.REQUEST_TIMEOUT);
+  res.setTimeout(env.REQUEST_TIMEOUT);
+  next();
+});
+
+app.use(requestLogger);
+
+setupSwagger(app, swaggerOptions);
+
+app.use("/api", routes);
+
+app.get(
+  "/",
+  asyncHandler(async (_req: Request, res: Response) => {
+    sendSuccess(
+      res,
+      {
+        message: "Welcome to Charcole API",
+        version: "2.0.0",
+        environment: env.NODE_ENV,
+      },
+      200,
+      "API is online",
+    );
+  }),
+);
+
+app.use((req: Request) => {
+  throw new NotFoundError(`${req.method} ${req.path}`, {
+    method: req.method,
+    path: req.path,
+  });
+});
+
+app.use(errorHandler);
+
+logger.info("Express app configured successfully");
+app.locals.userRepo = userRepo;

package/template/ts/src/config/constants.ts

@@ -1,27 +1,27 @@
-export const HTTP_STATUS = {
-  OK: 200,
-  CREATED: 201,
-  BAD_REQUEST: 400,
-  UNAUTHORIZED: 401,
-  FORBIDDEN: 403,
-  NOT_FOUND: 404,
-  CONFLICT: 409,
-  UNPROCESSABLE_ENTITY: 422,
-  INTERNAL_SERVER_ERROR: 500,
-  SERVICE_UNAVAILABLE: 503,
-} as const;
-
-export type HttpStatus = typeof HTTP_STATUS;
-
-export const ERROR_MESSAGES = {
-  VALIDATION_ERROR: "Validation failed",
-  NOT_FOUND: "Resource not found",
-  UNAUTHORIZED: "Unauthorized",
-  SERVER_ERROR: "Internal server error",
-  BAD_REQUEST: "Bad request",
-} as const;
-
-export type ErrorMessages = typeof ERROR_MESSAGES;
-
-export type HttpStatusCode = (typeof HTTP_STATUS)[keyof typeof HTTP_STATUS];
-export type ErrorMessage = (typeof ERROR_MESSAGES)[keyof typeof ERROR_MESSAGES];
+export const HTTP_STATUS = {
+  OK: 200,
+  CREATED: 201,
+  BAD_REQUEST: 400,
+  UNAUTHORIZED: 401,
+  FORBIDDEN: 403,
+  NOT_FOUND: 404,
+  CONFLICT: 409,
+  UNPROCESSABLE_ENTITY: 422,
+  INTERNAL_SERVER_ERROR: 500,
+  SERVICE_UNAVAILABLE: 503,
+} as const;
+
+export type HttpStatus = typeof HTTP_STATUS;
+
+export const ERROR_MESSAGES = {
+  VALIDATION_ERROR: "Validation failed",
+  NOT_FOUND: "Resource not found",
+  UNAUTHORIZED: "Unauthorized",
+  SERVER_ERROR: "Internal server error",
+  BAD_REQUEST: "Bad request",
+} as const;
+
+export type ErrorMessages = typeof ERROR_MESSAGES;
+
+export type HttpStatusCode = (typeof HTTP_STATUS)[keyof typeof HTTP_STATUS];
+export type ErrorMessage = (typeof ERROR_MESSAGES)[keyof typeof ERROR_MESSAGES];

package/template/ts/src/config/env.ts

@@ -1,40 +1,40 @@
-import { z } from "zod";
-
-const envSchema = z.object({
-  NODE_ENV: z
-    .enum(["development", "production", "test"])
-    .default("development"),
-  PORT: z.coerce.number().default(3000),
-  LOG_LEVEL: z.enum(["debug", "info", "warn", "error"]).default("info"),
-  CORS_ORIGIN: z.string().default("*"),
-  REQUEST_TIMEOUT: z.coerce.number().default(30000),
-});
-
-type EnvSchema = z.infer<typeof envSchema>;
-
-const parseEnv = (): EnvSchema => {
-  try {
-    return envSchema.parse(process.env);
-  } catch (error) {
-    if (error instanceof z.ZodError) {
-      console.error("❌ Invalid environment variables:");
-      error.errors.forEach((err) => {
-        console.error(`  - ${err.path.join(".")}: ${err.message}`);
-      });
-    } else {
-      console.error("❌ Failed to parse environment variables:", error);
-    }
-    process.exit(1);
-  }
-};
-
-const parsedEnv = parseEnv();
-
-export const env = {
-  ...parsedEnv,
-  isDevelopment: parsedEnv.NODE_ENV === "development",
-  isProduction: parsedEnv.NODE_ENV === "production",
-  isTest: parsedEnv.NODE_ENV === "test",
-} as const;
-
-export type Env = typeof env;
+import { z } from "zod";
+
+const envSchema = z.object({
+  NODE_ENV: z
+    .enum(["development", "production", "test"])
+    .default("development"),
+  PORT: z.coerce.number().default(3000),
+  LOG_LEVEL: z.enum(["debug", "info", "warn", "error"]).default("info"),
+  CORS_ORIGIN: z.string().default("*"),
+  REQUEST_TIMEOUT: z.coerce.number().default(30000),
+});
+
+type EnvSchema = z.infer<typeof envSchema>;
+
+const parseEnv = (): EnvSchema => {
+  try {
+    return envSchema.parse(process.env);
+  } catch (error) {
+    if (error instanceof z.ZodError) {
+      console.error("❌ Invalid environment variables:");
+      error.errors.forEach((err) => {
+        console.error(`  - ${err.path.join(".")}: ${err.message}`);
+      });
+    } else {
+      console.error("❌ Failed to parse environment variables:", error);
+    }
+    process.exit(1);
+  }
+};
+
+const parsedEnv = parseEnv();
+
+export const env = {
+  ...parsedEnv,
+  isDevelopment: parsedEnv.NODE_ENV === "development",
+  isProduction: parsedEnv.NODE_ENV === "production",
+  isTest: parsedEnv.NODE_ENV === "test",
+} as const;
+
+export type Env = typeof env;

package/template/ts/src/config/swagger.config.ts

@@ -1,30 +1,30 @@
-import { registerSchema, loginSchema } from "../modules/auth/auth.schemas.ts";
-import { createItemSchema } from "../modules/health/controller.ts";
-
-const swaggerConfig = {
-  title: process.env.APP_NAME || "Charcole API",
-  version: process.env.APP_VERSION || "1.0.0",
-  description: "Production-ready Node.js Express API",
-  path: "/api-docs",
-  servers: [
-    {
-      url: process.env.APP_URL || "http://localhost:3000",
-      description:
-        process.env.NODE_ENV === "production"
-          ? "Production server"
-          : "Development server",
-    },
-  ],
-  // NEW: Auto-register Zod schemas - no more manual duplication!
-  schemas: {
-    registerSchema,
-    loginSchema,
-    createItemSchema,
-  },
-  // Common response templates are included by default
-  includeCommonResponses: true,
-};
-
-export type SwaggerConfig = typeof swaggerConfig;
-
-export default swaggerConfig;
+import { registerSchema, loginSchema } from "../modules/auth/auth.schemas.ts";
+import { createItemSchema } from "../modules/health/controller.ts";
+
+const swaggerConfig = {
+  title: process.env.APP_NAME || "Charcole API",
+  version: process.env.APP_VERSION || "1.0.1",
+  description: "Production-ready Node.js Express API",
+  path: "/api-docs",
+  servers: [
+    {
+      url: process.env.APP_URL || "http://localhost:3000",
+      description:
+        process.env.NODE_ENV === "production"
+          ? "Production server"
+          : "Development server",
+    },
+  ],
+  // NEW: Auto-register Zod schemas - no more manual duplication!
+  schemas: {
+    registerSchema,
+    loginSchema,
+    createItemSchema,
+  },
+  // Common response templates are included by default
+  includeCommonResponses: true,
+};
+
+export type SwaggerConfig = typeof swaggerConfig;
+
+export default swaggerConfig;

package/template/ts/src/lib/swagger/SWAGGER_GUIDE.md

@@ -18,7 +18,7 @@ import { createItemSchema } from "../modules/health/controller.ts";
 
 const swaggerConfig = {
   title: "My API",
-  version: "1.0.0",
+  version: "1.0.1",
   // Auto-register schemas - they'll be converted to OpenAPI automatically!
   schemas: {
     registerSchema,
@@ -472,7 +472,7 @@ const app = express();
 
 setupSwagger(app, {
   title: "My API",
-  version: "1.0.0",
+  version: "1.0.1",
   schemas: {
     mySchema, // Your Zod schemas
   },