enlace-openapi 0.0.1-beta.1 → 0.0.1-beta.3

package/dist/index.js

@@ -1,4 +1,3 @@
-#!/usr/bin/env node
 "use strict";
 var __create = Object.create;
 var __defProp = Object.defineProperty;
@@ -35,8 +34,6 @@ __export(src_exports, {
   parseSchema: () => parseSchema
 });
 module.exports = __toCommonJS(src_exports);
-var import_commander = require("commander");
-var import_fs = __toESM(require("fs"));
 
 // src/parser.ts
 var import_typescript2 = __toESM(require("typescript"));
@@ -223,9 +220,9 @@ function parseSchema(schemaFilePath, typeName) {
       compilerOptions = { ...compilerOptions, ...parsed.options };
     }
   }
-  const program2 = import_typescript2.default.createProgram([absolutePath], compilerOptions);
-  const checker = program2.getTypeChecker();
-  const sourceFile = program2.getSourceFile(absolutePath);
+  const program = import_typescript2.default.createProgram([absolutePath], compilerOptions);
+  const checker = program.getTypeChecker();
+  const sourceFile = program.getSourceFile(absolutePath);
   if (!sourceFile) {
     throw new Error(`Could not find source file: ${absolutePath}`);
   }
@@ -310,16 +307,20 @@ function isEndpointStructure(type) {
   propNames.delete("data");
   propNames.delete("body");
   propNames.delete("error");
+  propNames.delete("query");
+  propNames.delete("formData");
   const remainingProps = [...propNames].filter(
     (name) => !name.startsWith("__@") && !name.includes("Brand")
   );
   return remainingProps.length === 0;
 }
-function parseEndpointType(type, path2, method, pathParams, ctx) {
+function parseEndpointType(type, pathStr, method, pathParams, ctx) {
   const { checker } = ctx;
   let dataType;
   let bodyType;
   let errorType;
+  let queryType;
+  let formDataType;
   const typesToCheck = type.isIntersection() ? type.types : [type];
   for (const t of typesToCheck) {
     const props = t.getProperties();
@@ -331,32 +332,93 @@ function parseEndpointType(type, path2, method, pathParams, ctx) {
         bodyType = checker.getTypeOfSymbol(prop);
       } else if (name === "error") {
         errorType = checker.getTypeOfSymbol(prop);
+      } else if (name === "query") {
+        queryType = checker.getTypeOfSymbol(prop);
+      } else if (name === "formData") {
+        formDataType = checker.getTypeOfSymbol(prop);
       }
     }
   }
   const endpoint = {
-    path: path2,
+    path: pathStr,
     method,
     responseSchema: dataType ? typeToSchema(dataType, ctx) : {},
     pathParams
   };
-  if (bodyType && !(bodyType.flags & import_typescript2.default.TypeFlags.Never)) {
+  if (formDataType && !(formDataType.flags & import_typescript2.default.TypeFlags.Never)) {
+    endpoint.requestBodySchema = formDataTypeToSchema(formDataType, ctx);
+    endpoint.requestBodyContentType = "multipart/form-data";
+  } else if (bodyType && !(bodyType.flags & import_typescript2.default.TypeFlags.Never)) {
     endpoint.requestBodySchema = typeToSchema(bodyType, ctx);
+    endpoint.requestBodyContentType = "application/json";
+  }
+  if (queryType && !(queryType.flags & import_typescript2.default.TypeFlags.Never)) {
+    endpoint.queryParams = queryTypeToParams(queryType, ctx);
   }
   if (errorType && !(errorType.flags & import_typescript2.default.TypeFlags.Never) && !(errorType.flags & import_typescript2.default.TypeFlags.Unknown)) {
     endpoint.errorSchema = typeToSchema(errorType, ctx);
   }
   return endpoint;
 }
+function queryTypeToParams(queryType, ctx) {
+  const { checker } = ctx;
+  const params = [];
+  const props = queryType.getProperties();
+  for (const prop of props) {
+    const propName = prop.getName();
+    const propType = checker.getTypeOfSymbol(prop);
+    const isOptional = !!(prop.flags & import_typescript2.default.SymbolFlags.Optional);
+    params.push({
+      name: propName,
+      in: "query",
+      required: !isOptional,
+      schema: typeToSchema(propType, ctx)
+    });
+  }
+  return params;
+}
+function formDataTypeToSchema(formDataType, ctx) {
+  const { checker } = ctx;
+  const properties = {};
+  const required = [];
+  const props = formDataType.getProperties();
+  for (const prop of props) {
+    const propName = prop.getName();
+    const propType = checker.getTypeOfSymbol(prop);
+    const isOptional = !!(prop.flags & import_typescript2.default.SymbolFlags.Optional);
+    const typeName = checker.typeToString(propType);
+    if (typeName.includes("File") || typeName.includes("Blob")) {
+      properties[propName] = { type: "string", format: "binary" };
+    } else if (propType.isUnion()) {
+      const hasFile = propType.types.some((t) => {
+        const name = checker.typeToString(t);
+        return name.includes("File") || name.includes("Blob");
+      });
+      if (hasFile) {
+        properties[propName] = { type: "string", format: "binary" };
+      } else {
+        properties[propName] = typeToSchema(propType, ctx);
+      }
+    } else {
+      properties[propName] = typeToSchema(propType, ctx);
+    }
+    if (!isOptional) {
+      required.push(propName);
+    }
+  }
+  const schema = {
+    type: "object",
+    properties
+  };
+  if (required.length > 0) {
+    schema.required = required;
+  }
+  return schema;
+}
 
 // src/generator.ts
 function generateOpenAPISpec(endpoints, schemas, options = {}) {
-  const {
-    title = "API",
-    version = "1.0.0",
-    description,
-    baseUrl
-  } = options;
+  const { title = "API", version = "1.0.0", description, baseUrl } = options;
   const paths = {};
   for (const endpoint of endpoints) {
     if (!paths[endpoint.path]) {
@@ -410,11 +472,15 @@ function createOperation(endpoint) {
       }
     };
   }
+  if (endpoint.queryParams && endpoint.queryParams.length > 0) {
+    operation.parameters = endpoint.queryParams;
+  }
   if (endpoint.requestBodySchema && hasContent(endpoint.requestBodySchema)) {
+    const contentType = endpoint.requestBodyContentType || "application/json";
     operation.requestBody = {
       required: true,
       content: {
-        "application/json": {
+        [contentType]: {
           schema: endpoint.requestBodySchema
         }
       }
@@ -435,29 +501,6 @@ function createOperation(endpoint) {
 function hasContent(schema) {
   return Object.keys(schema).length > 0;
 }
-
-// src/index.ts
-import_commander.program.name("enlace-openapi").description("Generate OpenAPI spec from TypeScript API schema").requiredOption("-s, --schema <path>", "Path to TypeScript file containing the schema type").option("-t, --type <name>", "Name of the schema type to use", "ApiSchema").option("-o, --output <path>", "Output file path (default: stdout)").option("--title <title>", "API title for OpenAPI info").option("--version <version>", "API version for OpenAPI info", "1.0.0").option("--base-url <url>", "Base URL for servers array").action((options) => {
-  try {
-    const { endpoints, schemas } = parseSchema(options.schema, options.type);
-    const spec = generateOpenAPISpec(endpoints, schemas, {
-      title: options.title,
-      version: options.version,
-      baseUrl: options.baseUrl
-    });
-    const output = JSON.stringify(spec, null, 2);
-    if (options.output) {
-      import_fs.default.writeFileSync(options.output, output);
-      console.log(`OpenAPI spec written to ${options.output}`);
-    } else {
-      console.log(output);
-    }
-  } catch (error) {
-    console.error("Error:", error instanceof Error ? error.message : error);
-    process.exit(1);
-  }
-});
-import_commander.program.parse();
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   generateOpenAPISpec,

package/dist/index.mjs

@@ -1,9 +1,3 @@
-#!/usr/bin/env node
-
-// src/index.ts
-import { program } from "commander";
-import fs from "fs";
-
 // src/parser.ts
 import ts2 from "typescript";
 import path from "path";
@@ -189,9 +183,9 @@ function parseSchema(schemaFilePath, typeName) {
       compilerOptions = { ...compilerOptions, ...parsed.options };
     }
   }
-  const program2 = ts2.createProgram([absolutePath], compilerOptions);
-  const checker = program2.getTypeChecker();
-  const sourceFile = program2.getSourceFile(absolutePath);
+  const program = ts2.createProgram([absolutePath], compilerOptions);
+  const checker = program.getTypeChecker();
+  const sourceFile = program.getSourceFile(absolutePath);
   if (!sourceFile) {
     throw new Error(`Could not find source file: ${absolutePath}`);
   }
@@ -276,16 +270,20 @@ function isEndpointStructure(type) {
   propNames.delete("data");
   propNames.delete("body");
   propNames.delete("error");
+  propNames.delete("query");
+  propNames.delete("formData");
   const remainingProps = [...propNames].filter(
     (name) => !name.startsWith("__@") && !name.includes("Brand")
   );
   return remainingProps.length === 0;
 }
-function parseEndpointType(type, path2, method, pathParams, ctx) {
+function parseEndpointType(type, pathStr, method, pathParams, ctx) {
   const { checker } = ctx;
   let dataType;
   let bodyType;
   let errorType;
+  let queryType;
+  let formDataType;
   const typesToCheck = type.isIntersection() ? type.types : [type];
   for (const t of typesToCheck) {
     const props = t.getProperties();
@@ -297,32 +295,93 @@ function parseEndpointType(type, path2, method, pathParams, ctx) {
         bodyType = checker.getTypeOfSymbol(prop);
       } else if (name === "error") {
         errorType = checker.getTypeOfSymbol(prop);
+      } else if (name === "query") {
+        queryType = checker.getTypeOfSymbol(prop);
+      } else if (name === "formData") {
+        formDataType = checker.getTypeOfSymbol(prop);
       }
     }
   }
   const endpoint = {
-    path: path2,
+    path: pathStr,
     method,
     responseSchema: dataType ? typeToSchema(dataType, ctx) : {},
     pathParams
   };
-  if (bodyType && !(bodyType.flags & ts2.TypeFlags.Never)) {
+  if (formDataType && !(formDataType.flags & ts2.TypeFlags.Never)) {
+    endpoint.requestBodySchema = formDataTypeToSchema(formDataType, ctx);
+    endpoint.requestBodyContentType = "multipart/form-data";
+  } else if (bodyType && !(bodyType.flags & ts2.TypeFlags.Never)) {
     endpoint.requestBodySchema = typeToSchema(bodyType, ctx);
+    endpoint.requestBodyContentType = "application/json";
+  }
+  if (queryType && !(queryType.flags & ts2.TypeFlags.Never)) {
+    endpoint.queryParams = queryTypeToParams(queryType, ctx);
   }
   if (errorType && !(errorType.flags & ts2.TypeFlags.Never) && !(errorType.flags & ts2.TypeFlags.Unknown)) {
     endpoint.errorSchema = typeToSchema(errorType, ctx);
   }
   return endpoint;
 }
+function queryTypeToParams(queryType, ctx) {
+  const { checker } = ctx;
+  const params = [];
+  const props = queryType.getProperties();
+  for (const prop of props) {
+    const propName = prop.getName();
+    const propType = checker.getTypeOfSymbol(prop);
+    const isOptional = !!(prop.flags & ts2.SymbolFlags.Optional);
+    params.push({
+      name: propName,
+      in: "query",
+      required: !isOptional,
+      schema: typeToSchema(propType, ctx)
+    });
+  }
+  return params;
+}
+function formDataTypeToSchema(formDataType, ctx) {
+  const { checker } = ctx;
+  const properties = {};
+  const required = [];
+  const props = formDataType.getProperties();
+  for (const prop of props) {
+    const propName = prop.getName();
+    const propType = checker.getTypeOfSymbol(prop);
+    const isOptional = !!(prop.flags & ts2.SymbolFlags.Optional);
+    const typeName = checker.typeToString(propType);
+    if (typeName.includes("File") || typeName.includes("Blob")) {
+      properties[propName] = { type: "string", format: "binary" };
+    } else if (propType.isUnion()) {
+      const hasFile = propType.types.some((t) => {
+        const name = checker.typeToString(t);
+        return name.includes("File") || name.includes("Blob");
+      });
+      if (hasFile) {
+        properties[propName] = { type: "string", format: "binary" };
+      } else {
+        properties[propName] = typeToSchema(propType, ctx);
+      }
+    } else {
+      properties[propName] = typeToSchema(propType, ctx);
+    }
+    if (!isOptional) {
+      required.push(propName);
+    }
+  }
+  const schema = {
+    type: "object",
+    properties
+  };
+  if (required.length > 0) {
+    schema.required = required;
+  }
+  return schema;
+}
 
 // src/generator.ts
 function generateOpenAPISpec(endpoints, schemas, options = {}) {
-  const {
-    title = "API",
-    version = "1.0.0",
-    description,
-    baseUrl
-  } = options;
+  const { title = "API", version = "1.0.0", description, baseUrl } = options;
   const paths = {};
   for (const endpoint of endpoints) {
     if (!paths[endpoint.path]) {
@@ -376,11 +435,15 @@ function createOperation(endpoint) {
       }
     };
   }
+  if (endpoint.queryParams && endpoint.queryParams.length > 0) {
+    operation.parameters = endpoint.queryParams;
+  }
   if (endpoint.requestBodySchema && hasContent(endpoint.requestBodySchema)) {
+    const contentType = endpoint.requestBodyContentType || "application/json";
     operation.requestBody = {
       required: true,
       content: {
-        "application/json": {
+        [contentType]: {
           schema: endpoint.requestBodySchema
         }
       }
@@ -401,29 +464,6 @@ function createOperation(endpoint) {
 function hasContent(schema) {
   return Object.keys(schema).length > 0;
 }
-
-// src/index.ts
-program.name("enlace-openapi").description("Generate OpenAPI spec from TypeScript API schema").requiredOption("-s, --schema <path>", "Path to TypeScript file containing the schema type").option("-t, --type <name>", "Name of the schema type to use", "ApiSchema").option("-o, --output <path>", "Output file path (default: stdout)").option("--title <title>", "API title for OpenAPI info").option("--version <version>", "API version for OpenAPI info", "1.0.0").option("--base-url <url>", "Base URL for servers array").action((options) => {
-  try {
-    const { endpoints, schemas } = parseSchema(options.schema, options.type);
-    const spec = generateOpenAPISpec(endpoints, schemas, {
-      title: options.title,
-      version: options.version,
-      baseUrl: options.baseUrl
-    });
-    const output = JSON.stringify(spec, null, 2);
-    if (options.output) {
-      fs.writeFileSync(options.output, output);
-      console.log(`OpenAPI spec written to ${options.output}`);
-    } else {
-      console.log(output);
-    }
-  } catch (error) {
-    console.error("Error:", error instanceof Error ? error.message : error);
-    process.exit(1);
-  }
-});
-program.parse();
 export {
   generateOpenAPISpec,
   parseSchema

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "enlace-openapi",
-  "version": "0.0.1-beta.1",
+  "version": "0.0.1-beta.3",
   "license": "MIT",
   "bin": {
-    "enlace-openapi": "./dist/index.mjs"
+    "enlace-openapi": "./dist/cli.mjs"
   },
   "files": [
     "dist"
@@ -15,18 +15,17 @@
       "require": "./dist/index.js"
     }
   },
-  "scripts": {
-    "dev": "tsup --watch",
-    "build": "tsup",
-    "typecheck": "tsc --noEmit",
-    "lint": "eslint src --max-warnings 0",
-    "prepublishOnly": "npm run build && npm run typecheck && npm run lint"
-  },
   "dependencies": {
     "commander": "^12.1.0",
     "typescript": "^5.9.2"
   },
   "devDependencies": {
     "@types/node": "^22.19.2"
+  },
+  "scripts": {
+    "dev": "tsup --watch",
+    "build": "tsup",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint src --max-warnings 0"
   }
-}
+}