prisma-swagger-autogen 1.0.8 → 1.0.11

package/dist/bin.cjs

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+require("./cli.cjs");

package/dist/cli.cjs

@@ -0,0 +1,332 @@
+#!/usr/bin/env node
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+
+// src/index.ts
+var import_node_fs = __toESM(require("fs"), 1);
+var import_node_path = __toESM(require("path"), 1);
+var import_node_module = require("module");
+var import_glob = require("glob");
+var DEFAULT_CONFIG = {
+  projectRoot: process.cwd(),
+  controllersGlob: "./**/controllers/**/*.ts",
+  outFile: "./swagger.config.js",
+  openapiOut: "./**/openapi.json",
+  serviceTitle: "Microservice Swagger Docs",
+  serverUrl: "http://localhost:3000",
+  securitySchemeName: "keycloakOAuth",
+  oauth: {
+    tokenUrl: "http://localhost:8080/realms/master/protocol/openid-connect/token",
+    refreshUrl: "http://localhost:8080/realms/master/protocol/openid-connect/refresh",
+    scopes: { openid: "openid" }
+  },
+  omitFieldsInWriteDtos: /* @__PURE__ */ new Set(["id", "createdAt", "updatedAt", "v"])
+};
+function ensurePosix(p) {
+  return p.split(import_node_path.default.sep).join(import_node_path.default.posix.sep);
+}
+function pluralize(name) {
+  if (name.endsWith("s")) return `${name}es`;
+  return `${name}s`;
+}
+function getRequire() {
+  return (0, import_node_module.createRequire)(typeof __filename !== "undefined" ? __filename : process.cwd() + "/");
+}
+function parseJsonObject(value, flagName) {
+  try {
+    const parsed = JSON.parse(value);
+    if (parsed === null || typeof parsed !== "object" || Array.isArray(parsed)) {
+      throw new Error("must be a JSON object");
+    }
+    return parsed;
+  } catch (e) {
+    throw new Error(`Invalid JSON for ${flagName}: ${e?.message ?? String(e)}`);
+  }
+}
+function parseCsv(value) {
+  return value.split(",").map((s) => s.trim()).filter(Boolean);
+}
+function readFlagValue(args, flag) {
+  const i = args.findIndex((a) => a === flag);
+  if (i < 0) return void 0;
+  const v = args[i + 1];
+  if (!v || v.startsWith("--")) return void 0;
+  return v;
+}
+function hasFlag(args, flag) {
+  return args.includes(flag);
+}
+function parseArgs(args) {
+  if (hasFlag(args, "--help") || hasFlag(args, "-h")) {
+    const help = `
+prisma-swagger-autogen
+
+Usage:
+  prisma-swagger-autogen [options]
+
+Options:
+  --schema <path>                 Prisma schema path (default: ./prisma/schema.prisma)
+
+  --projectRoot <path>            Project root for resolving outFile/openapiOut (default: cwd)
+  --controllersGlob <glob>        Glob for controller files (default: ./**/controllers/**/*.ts)
+  --outFile <path>                Path to write swagger.config.js (default: ./swagger.config.js)
+  --openapiOut <path>             Path swagger-autogen writes OpenAPI JSON (default: ./openapi.json)
+
+  --serviceTitle <string>         OpenAPI title
+  --serverUrl <url>               OpenAPI server url
+  --securitySchemeName <string>   Security scheme name
+
+  --oauthTokenUrl <url>           OAuth2 tokenUrl
+  --oauthRefreshUrl <url>         OAuth2 refreshUrl
+  --oauthScopes <json>            OAuth2 scopes as JSON object, e.g. {"openid":"openid scope"}
+
+  --omitFields <csv>              Comma-separated fields to omit in write DTOs (default: id,createdAt,updatedAt,v)
+
+Examples:
+  prisma-swagger-autogen
+  prisma-swagger-autogen --schema ./prisma/schema.prisma
+  prisma-swagger-autogen --controllersGlob "./src/api/**/*.ts" --outFile ./swagger.config.js
+  prisma-swagger-autogen --oauthScopes '{"openid":"openid scope","profile":"profile"}'
+`.trim();
+    process.stdout.write(help + "\n");
+    process.exit(0);
+  }
+  const schemaPath = readFlagValue(args, "--schema");
+  const projectRoot = readFlagValue(args, "--projectRoot");
+  const controllersGlob = readFlagValue(args, "--controllersGlob");
+  const outFile = readFlagValue(args, "--outFile");
+  const openapiOut = readFlagValue(args, "--openapiOut");
+  const serviceTitle = readFlagValue(args, "--serviceTitle");
+  const serverUrl = readFlagValue(args, "--serverUrl");
+  const securitySchemeName = readFlagValue(args, "--securitySchemeName");
+  const oauthTokenUrl = readFlagValue(args, "--oauthTokenUrl");
+  const oauthRefreshUrl = readFlagValue(args, "--oauthRefreshUrl");
+  const oauthScopesRaw = readFlagValue(args, "--oauthScopes");
+  const omitFieldsRaw = readFlagValue(args, "--omitFields");
+  const oauthScopes = oauthScopesRaw ? parseJsonObject(oauthScopesRaw, "--oauthScopes") : void 0;
+  const omitFieldsInWriteDtos = omitFieldsRaw ? parseCsv(omitFieldsRaw) : void 0;
+  return {
+    schemaPath,
+    projectRoot,
+    controllersGlob,
+    outFile,
+    openapiOut,
+    serviceTitle,
+    serverUrl,
+    securitySchemeName,
+    oauthTokenUrl,
+    oauthRefreshUrl,
+    oauthScopes,
+    omitFieldsInWriteDtos
+  };
+}
+function mergeConfig(base, parsed) {
+  const cfg = {
+    ...base,
+    projectRoot: parsed.projectRoot ? import_node_path.default.resolve(process.cwd(), parsed.projectRoot) : base.projectRoot,
+    controllersGlob: parsed.controllersGlob ?? base.controllersGlob,
+    outFile: parsed.outFile ?? base.outFile,
+    openapiOut: parsed.openapiOut ?? base.openapiOut,
+    serviceTitle: parsed.serviceTitle ?? base.serviceTitle,
+    serverUrl: parsed.serverUrl ?? base.serverUrl,
+    securitySchemeName: parsed.securitySchemeName ?? base.securitySchemeName,
+    oauth: {
+      tokenUrl: parsed.oauthTokenUrl ?? base.oauth.tokenUrl,
+      refreshUrl: parsed.oauthRefreshUrl ?? base.oauth.refreshUrl,
+      scopes: parsed.oauthScopes ?? base.oauth.scopes
+    },
+    omitFieldsInWriteDtos: parsed.omitFieldsInWriteDtos ? new Set(parsed.omitFieldsInWriteDtos) : base.omitFieldsInWriteDtos
+  };
+  cfg.controllersGlob = ensurePosix(cfg.controllersGlob);
+  cfg.outFile = ensurePosix(cfg.outFile);
+  cfg.openapiOut = ensurePosix(cfg.openapiOut);
+  return cfg;
+}
+async function loadDmmfFromProject(schemaPath) {
+  const resolvedSchemaPath = schemaPath ? import_node_path.default.resolve(process.cwd(), schemaPath) : import_node_path.default.resolve(process.cwd(), "prisma/schema.prisma");
+  if (!import_node_fs.default.existsSync(resolvedSchemaPath)) {
+    throw new Error(`Prisma schema not found at ${resolvedSchemaPath}`);
+  }
+  const datamodel = import_node_fs.default.readFileSync(resolvedSchemaPath, "utf8");
+  const require2 = getRequire();
+  const internals = require2("@prisma/internals");
+  if (typeof internals.getDMMF !== "function") {
+    throw new Error(`@prisma/internals.getDMMF not available`);
+  }
+  const dmmf = await internals.getDMMF({ datamodel });
+  if (!dmmf || !dmmf.datamodel || !Array.isArray(dmmf.datamodel.models) || !Array.isArray(dmmf.datamodel.enums)) {
+    throw new Error(`Unexpected DMMF shape returned by @prisma/internals.getDMMF`);
+  }
+  return dmmf;
+}
+function scalarToSchema(scalar) {
+  switch (scalar) {
+    case "String":
+      return { type: "string" };
+    case "Boolean":
+      return { type: "boolean" };
+    case "Int":
+      return { type: "integer" };
+    case "BigInt":
+      return { type: "integer", format: "int64" };
+    case "Float":
+      return { type: "number" };
+    case "Decimal":
+      return { type: "number" };
+    case "DateTime":
+      return { type: "string", format: "date-time" };
+    case "Json":
+      return { type: "object" };
+    case "Bytes":
+      return { type: "string", format: "byte" };
+    default:
+      return { type: "string" };
+  }
+}
+function fieldSchema(field, getRefName) {
+  if (field.kind === "scalar") {
+    const base = scalarToSchema(field.type);
+    if (field.isList) return { type: "array", items: base };
+    return base;
+  }
+  if (field.kind === "enum") {
+    const base = { $ref: `#/components/schemas/${field.type}` };
+    if (field.isList) return { type: "array", items: base };
+    return base;
+  }
+  if (field.kind === "object") {
+    const ref = { $ref: `#/components/schemas/${getRefName(String(field.type))}` };
+    if (field.isList) return { type: "array", items: ref };
+    return ref;
+  }
+  return { type: "object" };
+}
+function modelToGetSchema(model, getRefName) {
+  const properties = {};
+  const required = [];
+  for (const f of model.fields) {
+    properties[f.name] = fieldSchema(f, getRefName);
+    if (f.isRequired) required.push(f.name);
+  }
+  const schema = { type: "object", properties };
+  if (required.length) schema.required = required;
+  return schema;
+}
+function stripWriteFields(model, getSchema, omit) {
+  const schema = JSON.parse(JSON.stringify(getSchema));
+  if (!schema.properties) return schema;
+  const relationFieldNames = new Set(model.fields.filter((f) => f.kind === "object").map((f) => f.name));
+  for (const key of Object.keys(schema.properties)) {
+    if (omit.has(key) || relationFieldNames.has(key)) delete schema.properties[key];
+  }
+  if (Array.isArray(schema.required)) {
+    schema.required = schema.required.filter((k) => !omit.has(k) && !relationFieldNames.has(k));
+    if (schema.required.length === 0) delete schema.required;
+  }
+  return schema;
+}
+function makeAllOptional(schema) {
+  const s = JSON.parse(JSON.stringify(schema));
+  delete s.required;
+  return s;
+}
+function listResponseSchema(itemRef) {
+  return {
+    type: "object",
+    properties: {
+      count: { type: "number" },
+      hasPreviousPage: { type: "boolean" },
+      hasNextPage: { type: "boolean" },
+      pageNumber: { type: "number" },
+      pageSize: { type: "number" },
+      totalPages: { type: "number" },
+      items: { type: "array", items: { $ref: itemRef } }
+    },
+    required: ["count", "hasPreviousPage", "hasNextPage", "pageNumber", "pageSize", "totalPages", "items"]
+  };
+}
+async function buildSchemasFromPrismaDmmf(cfg, schemaPath) {
+  const dmmf = await loadDmmfFromProject(schemaPath);
+  const schemas = {};
+  const getRefName = (modelName) => `Get${modelName}Response`;
+  for (const e of dmmf.datamodel.enums) {
+    schemas[e.name] = { type: "string", enum: e.values.map((v) => v.name) };
+  }
+  for (const model of dmmf.datamodel.models) {
+    const getName = `Get${model.name}Response`;
+    const postName = `Post${model.name}Request`;
+    const putName = `Put${model.name}Request`;
+    const listName = `List${pluralize(model.name)}Response`;
+    const getSchema = modelToGetSchema(model, getRefName);
+    const postSchema = stripWriteFields(model, getSchema, cfg.omitFieldsInWriteDtos);
+    const putSchema = makeAllOptional(postSchema);
+    schemas[getName] = getSchema;
+    schemas[postName] = postSchema;
+    schemas[putName] = putSchema;
+    schemas[listName] = listResponseSchema(`#/components/schemas/${getName}`);
+  }
+  return schemas;
+}
+function generateSwaggerConfigJs(cfg, schemas) {
+  const routes = (0, import_glob.globSync)(cfg.controllersGlob, { nodir: true }).map((p) => ensurePosix(p));
+  const docs = {
+    info: { title: cfg.serviceTitle },
+    servers: [{ url: cfg.serverUrl }],
+    components: {
+      schemas,
+      securitySchemes: {
+        [cfg.securitySchemeName]: {
+          type: "oauth2",
+          description: "This API uses OAuth2 with the password flow.",
+          flows: {
+            password: {
+              tokenUrl: cfg.oauth.tokenUrl,
+              refreshUrl: cfg.oauth.refreshUrl,
+              scopes: cfg.oauth.scopes
+            }
+          }
+        }
+      }
+    },
+    security: [{ [cfg.securitySchemeName]: ["openid"] }]
+  };
+  const fileContent = `const swaggerAutogen = require('swagger-autogen')();
+const docs = ${JSON.stringify(docs, null, 2)};
+const routes = ${JSON.stringify(routes, null, 2)};
+swaggerAutogen('${ensurePosix(cfg.openapiOut)}', routes, docs);`;
+  const outPath = import_node_path.default.resolve(cfg.projectRoot, cfg.outFile);
+  import_node_fs.default.writeFileSync(outPath, fileContent, "utf8");
+}
+async function run(args = []) {
+  const parsed = parseArgs(args);
+  const cfg = mergeConfig(DEFAULT_CONFIG, parsed);
+  const schemas = await buildSchemasFromPrismaDmmf(cfg, parsed.schemaPath);
+  generateSwaggerConfigJs(cfg, schemas);
+}
+
+// src/cli.ts
+void run(process.argv.slice(2)).catch((e) => {
+  console.error(e);
+  process.exitCode = 1;
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prisma-swagger-autogen",
-  "version": "1.0.8",
+  "version": "1.0.11",
   "description": "Generate swagger-autogen config + Prisma DMMF schemas and fix swagger-autogen output.",
   "license": "MIT",
   "author": "Joyce Marvin Rafflenbeul",
@@ -35,11 +35,12 @@
   },
   "files": [
     "dist",
+    "scripts/make-bin.cjs",
     "README.md",
     "LICENSE"
   ],
   "scripts": {
-    "build": "tsup src/index.ts --format esm,cjs --dts --out-dir dist && tsup src/cli.ts --format esm --out-dir dist --no-dts",
+    "build": "tsup src/index.ts --format esm,cjs --dts --out-dir dist --tsconfig tsconfig.json && tsup src/cli.ts --format cjs --out-dir dist --no-dts --tsconfig tsconfig.json && node scripts/make-bin.cjs",
     "prepublishOnly": "npm run build"
   },
   "dependencies": {

package/scripts/make-bin.cjs

@@ -0,0 +1,14 @@
+const fs = require("fs");
+const path = require("path");
+
+const distDir = path.resolve(__dirname, "../dist");
+fs.mkdirSync(distDir, { recursive: true });
+
+const out = path.join(distDir, "bin.cjs");
+
+const content = `#!/usr/bin/env node
+require("./cli.cjs");
+`;
+
+fs.writeFileSync(out, content, "utf8");
+try { fs.chmodSync(out, 0o755); } catch {}

package/dist/cli.js

@@ -1,198 +0,0 @@
-// src/index.ts
-import fs from "fs";
-import path from "path";
-import { createRequire } from "module";
-import { globSync } from "glob";
-var CONFIG = {
-  projectRoot: process.cwd(),
-  controllersGlob: "./src/web/api/controllers/**/*.ts",
-  outFile: "./swagger.config.js",
-  openapiOut: "./src/web/api/openapi.json",
-  serviceTitle: "Prescription Service",
-  serverUrl: "http://localhost:3008",
-  securitySchemeName: "keycloakOAuth",
-  oauth: {
-    tokenUrl: "http://auth.localhost/realms/haemo/protocol/openid-connect/token",
-    refreshUrl: "http://auth.localhost/realms/haemo/protocol/openid-connect/refresh",
-    scopes: { openid: "openid scope" }
-  },
-  omitFieldsInWriteDtos: /* @__PURE__ */ new Set(["id", "createdAt", "updatedAt", "v"])
-};
-function ensurePosix(p) {
-  return p.split(path.sep).join(path.posix.sep);
-}
-function pluralize(name) {
-  if (name.endsWith("s")) return `${name}es`;
-  return `${name}s`;
-}
-function getRequire() {
-  return createRequire(typeof __filename !== "undefined" ? __filename : process.cwd() + "/");
-}
-async function loadDmmfFromProject(schemaPath) {
-  const resolvedSchemaPath = schemaPath ? path.resolve(process.cwd(), schemaPath) : path.resolve(process.cwd(), "prisma/schema.prisma");
-  if (!fs.existsSync(resolvedSchemaPath)) {
-    throw new Error(`Prisma schema not found at ${resolvedSchemaPath}`);
-  }
-  const datamodel = fs.readFileSync(resolvedSchemaPath, "utf8");
-  const require2 = getRequire();
-  const internals = require2("@prisma/internals");
-  if (typeof internals.getDMMF !== "function") {
-    throw new Error(`@prisma/internals.getDMMF not available`);
-  }
-  const dmmf = await internals.getDMMF({ datamodel });
-  if (!dmmf || !dmmf.datamodel || !Array.isArray(dmmf.datamodel.models) || !Array.isArray(dmmf.datamodel.enums)) {
-    throw new Error(`Unexpected DMMF shape returned by @prisma/internals.getDMMF`);
-  }
-  return dmmf;
-}
-function scalarToSchema(scalar) {
-  switch (scalar) {
-    case "String":
-      return { type: "string" };
-    case "Boolean":
-      return { type: "boolean" };
-    case "Int":
-      return { type: "integer" };
-    case "BigInt":
-      return { type: "integer", format: "int64" };
-    case "Float":
-      return { type: "number" };
-    case "Decimal":
-      return { type: "number" };
-    case "DateTime":
-      return { type: "string", format: "date-time" };
-    case "Json":
-      return { type: "object" };
-    case "Bytes":
-      return { type: "string", format: "byte" };
-    default:
-      return { type: "string" };
-  }
-}
-function fieldSchema(field, getRefName) {
-  if (field.kind === "scalar") {
-    const base = scalarToSchema(field.type);
-    if (field.isList) return { type: "array", items: base };
-    return base;
-  }
-  if (field.kind === "enum") {
-    const base = { $ref: `#/components/schemas/${field.type}` };
-    if (field.isList) return { type: "array", items: base };
-    return base;
-  }
-  if (field.kind === "object") {
-    const ref = { $ref: `#/components/schemas/${getRefName(String(field.type))}` };
-    if (field.isList) return { type: "array", items: ref };
-    return ref;
-  }
-  return { type: "object" };
-}
-function modelToGetSchema(model, getRefName) {
-  const properties = {};
-  const required = [];
-  for (const f of model.fields) {
-    properties[f.name] = fieldSchema(f, getRefName);
-    if (f.isRequired) required.push(f.name);
-  }
-  const schema = { type: "object", properties };
-  if (required.length) schema.required = required;
-  return schema;
-}
-function stripWriteFields(model, getSchema, omit) {
-  const schema = JSON.parse(JSON.stringify(getSchema));
-  if (!schema.properties) return schema;
-  const relationFieldNames = new Set(model.fields.filter((f) => f.kind === "object").map((f) => f.name));
-  for (const key of Object.keys(schema.properties)) {
-    if (omit.has(key) || relationFieldNames.has(key)) delete schema.properties[key];
-  }
-  if (Array.isArray(schema.required)) {
-    schema.required = schema.required.filter((k) => !omit.has(k) && !relationFieldNames.has(k));
-    if (schema.required.length === 0) delete schema.required;
-  }
-  return schema;
-}
-function makeAllOptional(schema) {
-  const s = JSON.parse(JSON.stringify(schema));
-  delete s.required;
-  return s;
-}
-function listResponseSchema(itemRef) {
-  return {
-    type: "object",
-    properties: {
-      count: { type: "number" },
-      hasPreviousPage: { type: "boolean" },
-      hasNextPage: { type: "boolean" },
-      pageNumber: { type: "number" },
-      pageSize: { type: "number" },
-      totalPages: { type: "number" },
-      items: { type: "array", items: { $ref: itemRef } }
-    },
-    required: ["count", "hasPreviousPage", "hasNextPage", "pageNumber", "pageSize", "totalPages", "items"]
-  };
-}
-async function buildSchemasFromPrismaDmmf(schemaPath) {
-  const dmmf = await loadDmmfFromProject(schemaPath);
-  const schemas = {};
-  const getRefName = (modelName) => `Get${modelName}Response`;
-  for (const e of dmmf.datamodel.enums) {
-    schemas[e.name] = { type: "string", enum: e.values.map((v) => v.name) };
-  }
-  for (const model of dmmf.datamodel.models) {
-    const getName = `Get${model.name}Response`;
-    const postName = `Post${model.name}Request`;
-    const putName = `Put${model.name}Request`;
-    const listName = `List${pluralize(model.name)}Response`;
-    const getSchema = modelToGetSchema(model, getRefName);
-    const postSchema = stripWriteFields(model, getSchema, CONFIG.omitFieldsInWriteDtos);
-    const putSchema = makeAllOptional(postSchema);
-    schemas[getName] = getSchema;
-    schemas[postName] = postSchema;
-    schemas[putName] = putSchema;
-    schemas[listName] = listResponseSchema(`#/components/schemas/${getName}`);
-  }
-  return schemas;
-}
-function generateSwaggerConfigJs(schemas) {
-  const routes = globSync(CONFIG.controllersGlob, { nodir: true }).map((p) => ensurePosix(p));
-  const docs = {
-    info: { title: CONFIG.serviceTitle },
-    servers: [{ url: CONFIG.serverUrl }],
-    components: {
-      schemas,
-      securitySchemes: {
-        [CONFIG.securitySchemeName]: {
-          type: "oauth2",
-          description: "This API uses OAuth2 with the password flow.",
-          flows: {
-            password: {
-              tokenUrl: CONFIG.oauth.tokenUrl,
-              refreshUrl: CONFIG.oauth.refreshUrl,
-              scopes: CONFIG.oauth.scopes
-            }
-          }
-        }
-      }
-    },
-    security: [{ [CONFIG.securitySchemeName]: ["openid"] }]
-  };
-  const fileContent = `const swaggerAutogen = require('swagger-autogen')();
-const docs = ${JSON.stringify(docs, null, 2)};
-const routes = ${JSON.stringify(routes, null, 2)};
-swaggerAutogen('${ensurePosix(CONFIG.openapiOut)}', routes, docs);`;
-  fs.writeFileSync(path.resolve(CONFIG.projectRoot, CONFIG.outFile), fileContent, "utf8");
-}
-async function run(args = []) {
-  const schemaFlagIndex = args.findIndex((a) => a === "--schema");
-  const schemaPath = schemaFlagIndex >= 0 ? args[schemaFlagIndex + 1] : void 0;
-  const schemas = await buildSchemasFromPrismaDmmf(schemaPath);
-  generateSwaggerConfigJs(schemas);
-}
-
-// src/cli.ts
-void run(process.argv.slice(2)).catch((e) => {
-  console.error(e);
-  process.exitCode = 1;
-});
-ss.exitCode = 1;
-});