create-charcole 2.2.0 → 2.2.2

package/template/js/basePackage.json

@@ -1,26 +1,26 @@
-{
-  "name": "charcole",
-  "version": "2.2.0",
-  "description": "Production-grade Node.js Express API",
-  "main": "src/server.js",
-  "type": "module",
-  "engines": {
-    "node": ">=18.0.0"
-  },
-  "scripts": {
-    "start": "node src/server.js",
-    "dev": "nodemon src/server.js",
-    "lint": "echo \"Add linting here\"",
-    "test": "echo \"Add tests here\""
-  },
-  "dependencies": {
-    "express": "^4.18.2",
-    "cors": "^2.8.5",
-    "dotenv": "^16.3.1",
-    "zod": "^3.25.76"
-  },
-  "devDependencies": {
-    "nodemon": "^3.0.2"
-  },
-  "license": "ISC"
-}
+{
+  "name": "charcole",
+  "version": "2.2.2",
+  "description": "Production-grade Node.js Express API",
+  "main": "src/server.js",
+  "type": "module",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "scripts": {
+    "start": "node src/server.js",
+    "dev": "nodemon src/server.js",
+    "lint": "echo \"Add linting here\"",
+    "test": "echo \"Add tests here\""
+  },
+  "dependencies": {
+    "express": "^4.18.2",
+    "cors": "^2.8.5",
+    "dotenv": "^16.3.1",
+    "zod": "^3.25.76"
+  },
+  "devDependencies": {
+    "nodemon": "^3.0.2"
+  },
+  "license": "ISC"
+}

package/template/js/src/app.js

@@ -1,81 +1,81 @@
-import express from "express";
-import { userRepo } from "./repositories/user.repo.js";
-import cors from "cors";
-import { env } from "./config/env.js";
-import { HTTP_STATUS, ERROR_MESSAGES } from "./config/constants.js";
-import { requestLogger } from "./middlewares/requestLogger.js";
-import {
-  errorHandler,
-  asyncHandler,
-  NotFoundError,
-} from "./middlewares/errorHandler.js";
-import { sendSuccess } from "./utils/response.js";
-import { logger } from "./utils/logger.js";
-import routes from "./routes/index.js";
-import swaggerOptions from "./config/swagger.config.js";
-import { setupSwagger } from "@charcoles/swagger";
-export const app = express();
-
-// Trust proxy
-app.set("trust proxy", 1);
-
-// CORS Configuration
-app.use(
-  cors({
-    origin: env.CORS_ORIGIN,
-    credentials: true,
-    methods: ["GET", "POST", "PUT", "DELETE", "PATCH", "OPTIONS"],
-    allowedHeaders: ["Content-Type", "Authorization"],
-  }),
-);
-
-// Body parsing middleware
-app.use(express.json({ limit: "10mb" }));
-app.use(express.urlencoded({ extended: true, limit: "10mb" }));
-
-// Request timeout
-app.use((req, res, next) => {
-  req.setTimeout(env.REQUEST_TIMEOUT);
-  res.setTimeout(env.REQUEST_TIMEOUT);
-  next();
-});
-
-// Request logging
-app.use(requestLogger);
-
-setupSwagger(app, swaggerOptions);
-
-// API Routes
-app.use("/api", routes);
-
-// Root health endpoint
-app.get(
-  "/",
-  asyncHandler(async (req, res) => {
-    sendSuccess(
-      res,
-      {
-        message: "Welcome to Charcole API",
-        version: "1.0.0",
-        environment: env.NODE_ENV,
-      },
-      200,
-      "API is online",
-    );
-  }),
-);
-
-// 404 handler
-app.use((req, res, next) => {
-  throw new NotFoundError(`${req.method} ${req.path}`, {
-    method: req.method,
-    path: req.path,
-  });
-});
-
-// Global error handler (MUST be last)
-app.use(errorHandler);
-
-logger.info("Express app configured successfully");
-
-app.locals.userRepo = userRepo;
+import express from "express";
+import { userRepo } from "./repositories/user.repo.js";
+import cors from "cors";
+import { env } from "./config/env.js";
+import { HTTP_STATUS, ERROR_MESSAGES } from "./config/constants.js";
+import { requestLogger } from "./middlewares/requestLogger.js";
+import {
+  errorHandler,
+  asyncHandler,
+  NotFoundError,
+} from "./middlewares/errorHandler.js";
+import { sendSuccess } from "./utils/response.js";
+import { logger } from "./utils/logger.js";
+import routes from "./routes/index.js";
+import swaggerOptions from "./config/swagger.config.js";
+import { setupSwagger } from "@charcoles/swagger";
+export const app = express();
+
+// Trust proxy
+app.set("trust proxy", 1);
+
+// CORS Configuration
+app.use(
+  cors({
+    origin: env.CORS_ORIGIN,
+    credentials: true,
+    methods: ["GET", "POST", "PUT", "DELETE", "PATCH", "OPTIONS"],
+    allowedHeaders: ["Content-Type", "Authorization"],
+  }),
+);
+
+// Body parsing middleware
+app.use(express.json({ limit: "10mb" }));
+app.use(express.urlencoded({ extended: true, limit: "10mb" }));
+
+// Request timeout
+app.use((req, res, next) => {
+  req.setTimeout(env.REQUEST_TIMEOUT);
+  res.setTimeout(env.REQUEST_TIMEOUT);
+  next();
+});
+
+// Request logging
+app.use(requestLogger);
+
+setupSwagger(app, swaggerOptions);
+
+// API Routes
+app.use("/api", routes);
+
+// Root health endpoint
+app.get(
+  "/",
+  asyncHandler(async (req, res) => {
+    sendSuccess(
+      res,
+      {
+        message: "Welcome to Charcole API",
+        version: "1.0.1",
+        environment: env.NODE_ENV,
+      },
+      200,
+      "API is online",
+    );
+  }),
+);
+
+// 404 handler
+app.use((req, res, next) => {
+  throw new NotFoundError(`${req.method} ${req.path}`, {
+    method: req.method,
+    path: req.path,
+  });
+});
+
+// Global error handler (MUST be last)
+app.use(errorHandler);
+
+logger.info("Express app configured successfully");
+
+app.locals.userRepo = userRepo;

package/template/js/src/config/constants.js

@@ -1,20 +1,20 @@
-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,
-};
-
-export const ERROR_MESSAGES = {
-  VALIDATION_ERROR: "Validation failed",
-  NOT_FOUND: "Resource not found",
-  UNAUTHORIZED: "Unauthorized",
-  SERVER_ERROR: "Internal server error",
-  BAD_REQUEST: "Bad request",
-};
+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,
+};
+
+export const ERROR_MESSAGES = {
+  VALIDATION_ERROR: "Validation failed",
+  NOT_FOUND: "Resource not found",
+  UNAUTHORIZED: "Unauthorized",
+  SERVER_ERROR: "Internal server error",
+  BAD_REQUEST: "Bad request",
+};

package/template/js/src/config/env.js

@@ -1,26 +1,26 @@
-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),
-});
-
-const parseEnv = () => {
-  try {
-    return envSchema.parse(process.env);
-  } catch (error) {
-    console.error("❌ Invalid environment variables:", error.errors);
-    process.exit(1);
-  }
-};
-
-export const env = parseEnv();
-
-export const isDevelopment = env.NODE_ENV === "development";
-export const isProduction = env.NODE_ENV === "production";
-export const isTest = env.NODE_ENV === "test";
+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),
+});
+
+const parseEnv = () => {
+  try {
+    return envSchema.parse(process.env);
+  } catch (error) {
+    console.error("❌ Invalid environment variables:", error.errors);
+    process.exit(1);
+  }
+};
+
+export const env = parseEnv();
+
+export const isDevelopment = env.NODE_ENV === "development";
+export const isProduction = env.NODE_ENV === "production";
+export const isTest = env.NODE_ENV === "test";

package/template/js/src/config/swagger.config.js

@@ -1,15 +1,15 @@
-export default {
-  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.API_URL || "http://localhost:3000",
-      description:
-        process.env.NODE_ENV === "production"
-          ? "Production server"
-          : "Development server",
-    },
-  ],
-};
+export default {
+  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.API_URL || "http://localhost:3000",
+      description:
+        process.env.NODE_ENV === "production"
+          ? "Production server"
+          : "Development server",
+    },
+  ],
+};

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

@@ -18,8 +18,8 @@ import { createItemSchema } from "../modules/health/controller.ts";
 
 const swaggerConfig = {
   title: "My API",
-  version: "1.0.0",
-  // Auto-register schemas - they'll be converted to OpenAPI automatically!
+  version: "1.0.1",
+  // Auto-register schemas - they'll be  converted to OpenAPI automatically!
   schemas: {
     registerSchema,
     loginSchema,
@@ -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
   },