prisma-swagger-autogen 1.0.0

package/dist/index.cjs

@@ -0,0 +1,368 @@
+"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 __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+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
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  run: () => run
+});
+module.exports = __toCommonJS(index_exports);
+var import_node_fs = __toESM(require("fs"), 1);
+var import_node_path = __toESM(require("path"), 1);
+var import_glob = require("glob");
+var import_node_child_process = require("child_process");
+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(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 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", example: 3 },
+      hasPreviousPage: { type: "boolean", example: false },
+      hasNextPage: { type: "boolean", example: true },
+      pageNumber: { type: "number", example: 1 },
+      pageSize: { type: "number", example: 10 },
+      totalPages: { type: "number", example: 1 },
+      items: { type: "array", items: { $ref: itemRef } }
+    },
+    required: ["count", "hasPreviousPage", "hasNextPage", "pageNumber", "pageSize", "totalPages", "items"]
+  };
+}
+function exampleForScalarType(type, format) {
+  if (type === "string" && format === "date-time") return (/* @__PURE__ */ new Date(0)).toISOString();
+  switch (type) {
+    case "string":
+      return "string";
+    case "integer":
+      return 0;
+    case "number":
+      return 0;
+    case "boolean":
+      return true;
+    case "object":
+      return {};
+    default:
+      return null;
+  }
+}
+function buildExampleFromSchema(schema, components, depth = 0) {
+  if (depth > 2) return void 0;
+  if (schema.$ref) {
+    const name = String(schema.$ref).split("/").pop() || "";
+    const target = components[name];
+    if (!target) return void 0;
+    return buildExampleFromSchema(target, components, depth + 1);
+  }
+  if (Array.isArray(schema.allOf) && schema.allOf.length) {
+    const merged = {};
+    for (const part of schema.allOf) {
+      const ex = buildExampleFromSchema(part, components, depth + 1);
+      if (ex && typeof ex === "object" && !Array.isArray(ex)) Object.assign(merged, ex);
+    }
+    return Object.keys(merged).length ? merged : void 0;
+  }
+  if (schema.type === "array" && schema.items) {
+    const item = buildExampleFromSchema(schema.items, components, depth + 1);
+    return item === void 0 ? [] : [item];
+  }
+  if (schema.type === "object" && schema.properties) {
+    const obj = {};
+    for (const [k, v] of Object.entries(schema.properties)) {
+      const ex = buildExampleFromSchema(v, components, depth + 1);
+      if (ex !== void 0) obj[k] = ex;
+    }
+    return obj;
+  }
+  if (Array.isArray(schema.enum) && schema.enum.length) return schema.enum[0];
+  if (typeof schema.type === "string") return exampleForScalarType(schema.type, schema.format);
+  return void 0;
+}
+function attachExample(schema, components) {
+  const s = JSON.parse(JSON.stringify(schema));
+  if (s.example === void 0) {
+    const ex = buildExampleFromSchema(s, components);
+    if (ex !== void 0) s.example = ex;
+  }
+  return s;
+}
+async function loadDmmfFromProject() {
+  const schemaPath = import_node_path.default.resolve(process.cwd(), "prisma/schema.prisma");
+  if (!import_node_fs.default.existsSync(schemaPath)) {
+    throw new Error(`Prisma schema not found at: ${schemaPath}`);
+  }
+  const cmd = `npx prisma generate --schema "${schemaPath}" --print`;
+  const stdout = (0, import_node_child_process.execSync)(cmd, { encoding: "utf8", stdio: ["ignore", "pipe", "pipe"] });
+  const firstBrace = stdout.indexOf("{");
+  const lastBrace = stdout.lastIndexOf("}");
+  if (firstBrace === -1 || lastBrace === -1) {
+    throw new Error(`Failed to parse Prisma DMMF from: ${cmd}`);
+  }
+  const jsonText = stdout.slice(firstBrace, lastBrace + 1);
+  const parsed = JSON.parse(jsonText);
+  const dmmf = parsed?.dmmf ?? parsed;
+  if (!dmmf?.datamodel?.models) {
+    throw new Error(`Prisma DMMF not found in prisma output. Got keys: ${Object.keys(parsed || {})}`);
+  }
+  return dmmf;
+}
+function buildSchemasFromDmmf(dmmf) {
+  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}`);
+  }
+  schemas["ExceptionResponse"] = {
+    type: "object",
+    properties: {
+      detail: { type: "string" },
+      errors: { type: "array", items: { type: "string" } },
+      status: { type: "number" },
+      title: { type: "string" },
+      type: { type: "string" }
+    },
+    required: ["status", "title", "type"]
+  };
+  schemas["BadRequestResponse"] = {
+    allOf: [{ $ref: "#/components/schemas/ExceptionResponse" }],
+    example: {
+      status: 400,
+      title: "The request was invalid",
+      type: "https://tools.ietf.org/html/rfc7231#section-6.5.1"
+    }
+  };
+  schemas["NotFoundResponse"] = {
+    allOf: [{ $ref: "#/components/schemas/ExceptionResponse" }],
+    example: {
+      status: 404,
+      title: "The specified resource was not found",
+      type: "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.4"
+    }
+  };
+  schemas["InternalErrorResponse"] = {
+    allOf: [{ $ref: "#/components/schemas/ExceptionResponse" }],
+    example: {
+      status: 500,
+      title: "An error occurred while processing your request",
+      type: "https://tools.ietf.org/html/rfc7231#section-6.6.1"
+    }
+  };
+  for (const name of Object.keys(schemas)) {
+    if (name.startsWith("Post") && name.endsWith("Request")) schemas[name] = attachExample(schemas[name], schemas);
+    if (name.startsWith("Put") && name.endsWith("Request")) schemas[name] = attachExample(schemas[name], schemas);
+  }
+  return schemas;
+}
+function generateSwaggerConfigJs(schemas) {
+  const routes = (0, import_glob.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 fs = require('fs');
+const path = require('node:path');
+
+function isPlainObject(v){return v!==null && typeof v==='object' && !Array.isArray(v);}
+
+function normalizeSchema(schema){
+	if(!isPlainObject(schema)) return schema;
+	if(schema.$ref) return schema;
+
+	if(isPlainObject(schema.type) && typeof schema.type.example === 'string') schema.type = schema.type.example;
+	if(isPlainObject(schema.format) && typeof schema.format.example === 'string') schema.format = schema.format.example;
+	if(isPlainObject(schema.required) && Array.isArray(schema.required.example)) schema.required = schema.required.example;
+	if(isPlainObject(schema.enum) && Array.isArray(schema.enum.example)) schema.enum = schema.enum.example;
+
+	if(Array.isArray(schema.allOf)) schema.allOf = schema.allOf.map(normalizeSchema);
+	if(isPlainObject(schema.items)) schema.items = normalizeSchema(schema.items);
+	if(isPlainObject(schema.additionalProperties)) schema.additionalProperties = normalizeSchema(schema.additionalProperties);
+
+	if(isPlainObject(schema.properties)){
+		for(const k of Object.keys(schema.properties)){
+			schema.properties[k] = normalizeSchema(schema.properties[k]);
+		}
+	}
+
+	return schema;
+}
+
+function fixOpenApiFile(openapiPath){
+	const abs = path.resolve(process.cwd(), openapiPath);
+	if(!fs.existsSync(abs)) return;
+	const doc = JSON.parse(fs.readFileSync(abs,'utf8'));
+
+	if(doc && doc.components && isPlainObject(doc.components.schemas)){
+		for(const name of Object.keys(doc.components.schemas)){
+			doc.components.schemas[name] = normalizeSchema(doc.components.schemas[name]);
+		}
+	}
+
+	fs.writeFileSync(abs, JSON.stringify(doc,null,2),'utf8');
+}
+
+const docs = ${JSON.stringify(docs, null, 2)};
+const routes = ${JSON.stringify(routes, null, 2)};
+
+swaggerAutogen('${ensurePosix(CONFIG.openapiOut)}', routes, docs)
+	.then(() => fixOpenApiFile('${ensurePosix(CONFIG.openapiOut)}'))
+	.catch((e) => { console.error(e); process.exitCode = 1; });
+`;
+  const outPath = import_node_path.default.resolve(CONFIG.projectRoot, CONFIG.outFile);
+  import_node_fs.default.writeFileSync(outPath, fileContent, "utf8");
+}
+async function run(_args) {
+  const dmmf = await loadDmmfFromProject();
+  const schemas = buildSchemasFromDmmf(dmmf);
+  generateSwaggerConfigJs(schemas);
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  run
+});

package/dist/index.d.cts

@@ -0,0 +1,3 @@
+declare function run(_args: string[]): Promise<void>;
+
+export { run };

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+declare function run(_args: string[]): Promise<void>;
+
+export { run };

package/dist/index.js

@@ -0,0 +1,6 @@
+import {
+  run
+} from "./chunk-SNNQZQLO.js";
+export {
+  run
+};

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "prisma-swagger-autogen",
+  "version": "1.0.0",
+  "description": "Generate swagger-autogen config + Prisma DMMF schemas and fix swagger-autogen output.",
+  "license": "MIT",
+  "author": "Joyce Marvin Rafflenbeul",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/quikk-software/prisma-swagger-autogen.git"
+  },
+  "bugs": {
+    "url": "https://github.com/quikk-software/prisma-swagger-autogen/issues"
+  },
+  "homepage": "https://github.com/quikk-software/prisma-swagger-autogen#readme",
+  "keywords": [
+    "prisma",
+    "openapi",
+    "swagger",
+    "swagger-autogen",
+    "typescript"
+  ],
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "bin": {
+    "prisma-swagger-autogen": "./dist/cli.js"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsup src/index.ts src/cli.ts --format esm,cjs --dts --out-dir dist --tsconfig tsconfig.json",
+    "prepublishOnly": "npm run build"
+  },
+  "peerDependencies": {
+    "@prisma/client": ">=4",
+    "prisma": ">=4",
+    "glob": ">=10",
+    "swagger-autogen": ">=2"
+  },
+  "devDependencies": {
+    "@types/node": "^25.1.0",
+    "tsup": "^8.0.0",
+    "typescript": "^5.0.0"
+  }
+}