create-charcole 2.2.0 → 2.2.1

package/packages/swagger/package.json

@@ -1,44 +1,57 @@
-{
-  "name": "@charcoles/swagger",
-  "version": "1.0.0",
-  "description": "Auto-generated Swagger documentation for Charcole APIs",
-  "main": "src/index.js",
-  "types": "src/index.d.ts",
-  "type": "module",
-  "exports": {
-    ".": {
-      "types": "./src/index.d.ts",
-      "default": "./src/index.js"
-    }
-  },
-  "scripts": {
-    "test": "echo \"No tests yet\" && exit 0",
-    "prepare": "echo 'Ready for npm link'"
-  },
-  "dependencies": {
-    "swagger-ui-express": "^4.6.3",
-    "swagger-jsdoc": "^6.2.8",
-    "glob": "^10.3.10",
-    "zod-to-json-schema": "^3.22.4"
-  },
-  "peerDependencies": {
-    "zod": "^3.0.0"
-  },
-  "peerDependenciesMeta": {
-    "zod": {
-      "optional": true
-    }
-  },
-  "keywords": [
-    "charcole",
-    "swagger",
-    "openapi",
-    "documentation",
-    "express"
-  ],
-  "author": "Sheraz Manzoor",
-  "license": "ISC",
-  "publishConfig": {
-    "access": "public"
-  }
-}
+{
+  "name": "@charcoles/swagger",
+  "version": "1.0.0",
+  "description": "Auto-generated Swagger documentation for Charcole APIs",
+  "main": "src/index.js",
+  "types": "src/index.d.ts",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./src/index.d.ts",
+      "default": "./src/index.js"
+    }
+  },
+  "author": {
+    "name": "Sheraz Manzoor",
+    "email": "sheraz.dev121@gmail.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/sheraz4196/create-charcole.git",
+    "directory": "packages/swagger"
+  },
+  "bugs": {
+    "url": "https://github.com/sheraz4196/create-charcole/issues"
+  },
+  "homepage": "https://www.charcole.site/guides/swagger/introduction",
+  "scripts": {
+    "test": "echo \"No tests yet\" && exit 0",
+    "prepare": "echo 'Ready for npm link'"
+  },
+  "dependencies": {
+    "swagger-ui-express": "^4.6.3",
+    "swagger-jsdoc": "^6.2.8",
+    "glob": "^10.3.10",
+    "zod-to-json-schema": "^3.22.4"
+  },
+  "peerDependencies": {
+    "zod": "^3.0.0"
+  },
+  "peerDependenciesMeta": {
+    "zod": {
+      "optional": true
+    }
+  },
+  "keywords": [
+    "charcole",
+    "swagger",
+    "openapi",
+    "documentation",
+    "express",
+    "charcole swagger"
+  ],
+  "license": "ISC",
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/packages/swagger/src/index.d.ts

@@ -1,126 +1,126 @@
-import { Application } from "express";
-import { ZodType, ZodSchema } from "zod";
-
-export interface SwaggerServer {
-  url: string;
-  description: string;
-}
-
-export interface SwaggerOptions {
-  title?: string;
-  version?: string;
-  description?: string;
-  path?: string;
-  servers?: SwaggerServer[];
-  // NEW: Auto-register Zod schemas
-  schemas?: Record<string, ZodType<any>>;
-  // NEW: Include common response templates (default: true)
-  includeCommonResponses?: boolean;
-  // NEW: Custom response schemas
-  customResponses?: Record<string, any>;
-}
-
-export interface OpenAPISpec {
-  openapi: string;
-  info: {
-    title: string;
-    version: string;
-    description: string;
-  };
-  servers: SwaggerServer[];
-  components: {
-    securitySchemes: {
-      bearerAuth: {
-        type: string;
-        scheme: string;
-        bearerFormat: string;
-        description: string;
-      };
-    };
-    schemas?: Record<string, any>;
-    responses?: Record<string, any>;
-  };
-  paths?: Record<string, any>;
-}
-
-export function setupSwagger(
-  app: Application,
-  options?: SwaggerOptions,
-): OpenAPISpec;
-
-// Helper functions
-export interface EndpointParameter {
-  in: "path" | "query" | "header";
-  name: string;
-  required?: boolean;
-  type?: string;
-  description?: string;
-}
-
-export interface EndpointOptions {
-  summary: string;
-  description?: string;
-  tags?: string[];
-  schema?: string;
-  responseSchema?: string;
-  security?: boolean;
-  params?: EndpointParameter[];
-}
-
-export interface SwaggerDocOptions {
-  method: string;
-  path: string;
-  summary: string;
-  description?: string;
-  tags?: string[];
-  requestSchema?: string;
-  responseSchemaName?: string;
-  security?: boolean;
-  parameters?: EndpointParameter[];
-}
-
-/**
- * Convert Zod schema to OpenAPI JSON Schema
- */
-export function convertZodToOpenAPI(
-  zodSchema: ZodType<any>,
-  name: string,
-): object | null;
-
-/**
- * Extract body schema from a Zod schema that has a .body property
- */
-export function extractBodySchema(schema: ZodType<any>): ZodType<any> | null;
-
-/**
- * Get common response schemas (Success, ValidationError, Unauthorized, etc.)
- */
-export function getCommonResponses(): Record<string, any>;
-
-/**
- * Detect security requirements from middleware chain
- */
-export function detectSecurity(
-  middlewares: Function[],
-): Array<{ bearerAuth: [] }>;
-
-/**
- * Create a Swagger documentation comment block
- */
-export function createSwaggerDoc(options: SwaggerDocOptions): string;
-
-/**
- * Register Zod schemas for auto-documentation
- */
-export function registerSchemas(
-  schemas: Record<string, ZodType<any>>,
-): Record<string, any>;
-
-/**
- * Simplified API for quick endpoint documentation
- */
-export function endpoint(
-  method: string,
-  path: string,
-  options?: EndpointOptions,
-): Record<string, any>;
+import { Application } from "express";
+import { ZodType, ZodSchema } from "zod";
+
+export interface SwaggerServer {
+  url: string;
+  description: string;
+}
+
+export interface SwaggerOptions {
+  title?: string;
+  version?: string;
+  description?: string;
+  path?: string;
+  servers?: SwaggerServer[];
+  // NEW: Auto-register Zod schemas
+  schemas?: Record<string, ZodType<any>>;
+  // NEW: Include common response templates (default: true)
+  includeCommonResponses?: boolean;
+  // NEW: Custom response schemas
+  customResponses?: Record<string, any>;
+}
+
+export interface OpenAPISpec {
+  openapi: string;
+  info: {
+    title: string;
+    version: string;
+    description: string;
+  };
+  servers: SwaggerServer[];
+  components: {
+    securitySchemes: {
+      bearerAuth: {
+        type: string;
+        scheme: string;
+        bearerFormat: string;
+        description: string;
+      };
+    };
+    schemas?: Record<string, any>;
+    responses?: Record<string, any>;
+  };
+  paths?: Record<string, any>;
+}
+
+export function setupSwagger(
+  app: Application,
+  options?: SwaggerOptions,
+): OpenAPISpec;
+
+// Helper functions
+export interface EndpointParameter {
+  in: "path" | "query" | "header";
+  name: string;
+  required?: boolean;
+  type?: string;
+  description?: string;
+}
+
+export interface EndpointOptions {
+  summary: string;
+  description?: string;
+  tags?: string[];
+  schema?: string;
+  responseSchema?: string;
+  security?: boolean;
+  params?: EndpointParameter[];
+}
+
+export interface SwaggerDocOptions {
+  method: string;
+  path: string;
+  summary: string;
+  description?: string;
+  tags?: string[];
+  requestSchema?: string;
+  responseSchemaName?: string;
+  security?: boolean;
+  parameters?: EndpointParameter[];
+}
+
+/**
+ * Convert Zod schema to OpenAPI JSON Schema
+ */
+export function convertZodToOpenAPI(
+  zodSchema: ZodType<any>,
+  name: string,
+): object | null;
+
+/**
+ * Extract body schema from a Zod schema that has a .body property
+ */
+export function extractBodySchema(schema: ZodType<any>): ZodType<any> | null;
+
+/**
+ * Get common response schemas (Success, ValidationError, Unauthorized, etc.)
+ */
+export function getCommonResponses(): Record<string, any>;
+
+/**
+ * Detect security requirements from middleware chain
+ */
+export function detectSecurity(
+  middlewares: Function[],
+): Array<{ bearerAuth: [] }>;
+
+/**
+ * Create a Swagger documentation comment block
+ */
+export function createSwaggerDoc(options: SwaggerDocOptions): string;
+
+/**
+ * Register Zod schemas for auto-documentation
+ */
+export function registerSchemas(
+  schemas: Record<string, ZodType<any>>,
+): Record<string, any>;
+
+/**
+ * Simplified API for quick endpoint documentation
+ */
+export function endpoint(
+  method: string,
+  path: string,
+  options?: EndpointOptions,
+): Record<string, any>;

package/packages/swagger/src/index.js

@@ -1,12 +1,12 @@
-export { setupSwagger } from "./setup.js";
-
-// Export helper functions for advanced usage
-export {
-  convertZodToOpenAPI,
-  extractBodySchema,
-  getCommonResponses,
-  detectSecurity,
-  createSwaggerDoc,
-  registerSchemas,
-  endpoint,
-} from "./helpers.js";
+export { setupSwagger } from "./setup.js";
+
+// Export helper functions for advanced usage
+export {
+  convertZodToOpenAPI,
+  extractBodySchema,
+  getCommonResponses,
+  detectSecurity,
+  createSwaggerDoc,
+  registerSchemas,
+  endpoint,
+} from "./helpers.js";

package/packages/swagger/src/setup.js

@@ -1,100 +1,100 @@
-import swaggerUi from "swagger-ui-express";
-import swaggerJSDoc from "swagger-jsdoc";
-import fs from "fs";
-import path from "path";
-import { registerSchemas, getCommonResponses } from "./helpers.js";
-
-export function setupSwagger(app, options = {}) {
-  const defaultOptions = {
-    title: "Charcole API",
-    version: "1.0.0",
-    description: "Auto-generated API documentation",
-    path: "/api-docs",
-    servers: [{ url: "http://localhost:3000", description: "Local server" }],
-    // NEW: Auto-register Zod schemas
-    schemas: {},
-    // NEW: Include common response templates
-    includeCommonResponses: true,
-    // NEW: Custom response schemas
-    customResponses: {},
-  };
-
-  const config = { ...defaultOptions, ...options };
-
-  // Detect if running TypeScript or JavaScript by checking if src directory has .ts files
-  const srcPath = path.join(process.cwd(), "src");
-  const hasSrcDir = fs.existsSync(srcPath);
-
-  let isTypeScript = false;
-  if (hasSrcDir) {
-    // Check if there are any .ts files in src directory
-    const files = fs.readdirSync(srcPath);
-    isTypeScript = files.some((file) => file.endsWith(".ts"));
-  }
-
-  // Determine file extensions to scan
-  const fileExtension = isTypeScript ? "ts" : "js";
-
-  // Build API paths based on project structure
-  const apiPaths = [
-    `${process.cwd()}/src/modules/**/*.${fileExtension}`,
-    `${process.cwd()}/src/routes/**/*.${fileExtension}`,
-  ];
-
-  // NEW: Build components with auto-registered schemas
-  const components = {
-    securitySchemes: {
-      bearerAuth: {
-        type: "http",
-        scheme: "bearer",
-        bearerFormat: "JWT",
-        description: "Enter your JWT token in the format: your-token-here",
-      },
-    },
-    schemas: {},
-    responses: {},
-  };
-
-  // NEW: Register Zod schemas if provided
-  if (config.schemas && Object.keys(config.schemas).length > 0) {
-    try {
-      const registeredSchemas = registerSchemas(config.schemas);
-      components.schemas = { ...registeredSchemas };
-      console.log(
-        `✅ Auto-registered ${Object.keys(registeredSchemas).length} Zod schemas`,
-      );
-    } catch (error) {
-      console.warn("⚠️  Failed to register some Zod schemas:", error.message);
-    }
-  }
-
-  // NEW: Add common response templates
-  if (config.includeCommonResponses) {
-    components.responses = {
-      ...getCommonResponses(),
-      ...config.customResponses,
-    };
-  }
-
-  const openApiSpec = swaggerJSDoc({
-    definition: {
-      openapi: "3.0.0",
-      info: {
-        title: config.title,
-        version: config.version,
-        description: config.description,
-      },
-      servers: config.servers,
-      components,
-    },
-    apis: apiPaths,
-  });
-
-  app.use(config.path, swaggerUi.serve, swaggerUi.setup(openApiSpec));
-
-  console.log(
-    `✅ Swagger UI available at http://localhost:${process.env.PORT || 3000}${config.path}`,
-  );
-
-  return openApiSpec;
-}
+import swaggerUi from "swagger-ui-express";
+import swaggerJSDoc from "swagger-jsdoc";
+import fs from "fs";
+import path from "path";
+import { registerSchemas, getCommonResponses } from "./helpers.js";
+
+export function setupSwagger(app, options = {}) {
+  const defaultOptions = {
+    title: "Charcole API",
+    version: "1.0.0",
+    description: "Auto-generated API documentation",
+    path: "/api-docs",
+    servers: [{ url: "http://localhost:3000", description: "Local server" }],
+    // NEW: Auto-register Zod schemas
+    schemas: {},
+    // NEW: Include common response templates
+    includeCommonResponses: true,
+    // NEW: Custom response schemas
+    customResponses: {},
+  };
+
+  const config = { ...defaultOptions, ...options };
+
+  // Detect if running TypeScript or JavaScript by checking if src directory has .ts files
+  const srcPath = path.join(process.cwd(), "src");
+  const hasSrcDir = fs.existsSync(srcPath);
+
+  let isTypeScript = false;
+  if (hasSrcDir) {
+    // Check if there are any .ts files in src directory
+    const files = fs.readdirSync(srcPath);
+    isTypeScript = files.some((file) => file.endsWith(".ts"));
+  }
+
+  // Determine file extensions to scan
+  const fileExtension = isTypeScript ? "ts" : "js";
+
+  // Build API paths based on project structure
+  const apiPaths = [
+    `${process.cwd()}/src/modules/**/*.${fileExtension}`,
+    `${process.cwd()}/src/routes/**/*.${fileExtension}`,
+  ];
+
+  // NEW: Build components with auto-registered schemas
+  const components = {
+    securitySchemes: {
+      bearerAuth: {
+        type: "http",
+        scheme: "bearer",
+        bearerFormat: "JWT",
+        description: "Enter your JWT token in the format: your-token-here",
+      },
+    },
+    schemas: {},
+    responses: {},
+  };
+
+  // NEW: Register Zod schemas if provided
+  if (config.schemas && Object.keys(config.schemas).length > 0) {
+    try {
+      const registeredSchemas = registerSchemas(config.schemas);
+      components.schemas = { ...registeredSchemas };
+      console.log(
+        `✅ Auto-registered ${Object.keys(registeredSchemas).length} Zod schemas`,
+      );
+    } catch (error) {
+      console.warn("⚠️  Failed to register some Zod schemas:", error.message);
+    }
+  }
+
+  // NEW: Add common response templates
+  if (config.includeCommonResponses) {
+    components.responses = {
+      ...getCommonResponses(),
+      ...config.customResponses,
+    };
+  }
+
+  const openApiSpec = swaggerJSDoc({
+    definition: {
+      openapi: "3.0.0",
+      info: {
+        title: config.title,
+        version: config.version,
+        description: config.description,
+      },
+      servers: config.servers,
+      components,
+    },
+    apis: apiPaths,
+  });
+
+  app.use(config.path, swaggerUi.serve, swaggerUi.setup(openApiSpec));
+
+  console.log(
+    `✅ Swagger UI available at http://localhost:${process.env.PORT || 3000}${config.path}`,
+  );
+
+  return openApiSpec;
+}

package/template/js/.env.example

@@ -1,16 +1,16 @@
-# Server Configuration
-NODE_ENV=development
-PORT=3000
-
-# Logging
-LOG_LEVEL=info
-
-# CORS
-CORS_ORIGIN=*
-
-# Request
-REQUEST_TIMEOUT=30000
-
-
-# Authentication
+# Server Configuration
+NODE_ENV=development
+PORT=3000
+
+# Logging
+LOG_LEVEL=info
+
+# CORS
+CORS_ORIGIN=*
+
+# Request
+REQUEST_TIMEOUT=30000
+
+
+# Authentication
 JWT_SECRET=your-secret-key-here