@moccona/apicodegen 0.0.1 → 0.0.2

package/README.md

@@ -0,0 +1,49 @@
+# @moccona/apicodegen
+
+`@moccona/apicodegen` is a command-line tool for generating TypeScript code from OpenAPI documentation. It provides a simple and efficient way to automate the process of creating API clients.
+
+## Installation
+
+To install `@moccona/apicodegen`, you can use npm or yarn:
+
+```sh
+npm install -g @moccona/apicodegen
+
+or
+
+```sh
+yarn global add @moccona/apicodegen
+```
+
+## Usage
+
+### Basic Command
+
+The basic command to generate TypeScript code from an OpenAPI documentation URL is as follows:
+
+```sh
+apicodegen <docURL> --output ./output.ts
+```
+
+- `<docURL>`: The URL of the OpenAPI documentation file.
+- `--output`: The path where the generated TypeScript code will be saved. Default is `./output.ts`.
+- `--adaptor`: The adaptor for API calls. Default is `fetch`.
+- `--baseURL`: The base path of the API endpoint.
+- `--verbose`: Enable verbose logging.
+- `--importClientSource`: The source from which the request tool will be imported.
+
+## Example
+
+To generate TypeScript code from an OpenAPI documentation file located at `https://api.example.com/openapi.json` and save it to `./src/api.ts`, you can run:
+
+```sh
+apicodegen https://api.example.com/openapi.json --output ./src/api.ts
+```
+
+## Contributing
+
+Contributions are welcome! Please read the [contributing guidelines](./CONTRIBUTING.md) before submitting a pull request.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.

package/npm/index.cjs

@@ -260,10 +260,10 @@ var Base = class _Base {
    * @param [operationId] - Unique identifier for the operation.
    * @returns - The generated function name.
    */
-  static pathToFnName(path, method, operationId) {
-    const name = this.camelCase(this.normalize(path));
+  static pathToFnName(path, method, _operationId = "") {
+    const name = this.normalize(this.camelCase(this.normalize(path)));
     const suffix = method ? this.capitalize(this.upperCamelCase(`using_${method}`)) : "";
-    return (operationId ? this.camelCase(this.normalize(operationId)) : name) + suffix;
+    return name + suffix;
   }
   /**
    * Normalizes a string by replacing special characters and avoiding TypeScript keywords.
@@ -274,7 +274,7 @@ var Base = class _Base {
     if (typescriptKeywords.has(text)) {
       text += "_";
     }
-    return text.replace(/[/\-_{}():\s`,*<>$]/gm, "_").replaceAll("...", "");
+    return text.replace(/[/\-_{}():\s`,*<>$#.]/gm, "_").replace(/^\d./gm, "").replaceAll("...", "");
   }
   /**
    * Capitalizes the first character of a string.
@@ -484,7 +484,7 @@ var Generator = class _Generator {
    * @param path - The base path string containing placeholders.
    * @param parameters - Array of parameter objects defining the parameters.
    * @param basePath - Optional base path to prepend (default: "").
-   * @returns A TypeScript template expression node.
+   * @returns A TypeScript template expressi
    */
   static toUrlTemplate(path, parameters, basePath = "") {
     const queryParameters = parameters.filter(
@@ -492,7 +492,7 @@ var Generator = class _Generator {
     );
     if (queryParameters.length > 0) {
       const queryString = queryParameters.map(
-        (qp, index) => `${index === 0 ? "?" : "&"}${encodeURIComponent(qp.name)}={${qp.name}}`
+        (qp, index) => `${index === 0 ? "?" : "&"}${encodeURIComponent(qp.name)}={${Base.camelCase(Base.normalize(qp.name))}}`
       ).join("");
       path += queryString;
     }
@@ -607,7 +607,7 @@ var Generator = class _Generator {
       case "boolean" /* boolean */:
         return import_typescript.factory.createToken(import_typescript.SyntaxKind.BooleanKeyword);
       case "file" /* file */:
-        return import_typescript.factory.createTypeReferenceNode(import_typescript.factory.createIdentifier("File"));
+        return import_typescript.factory.createTypeReferenceNode(import_typescript.factory.createIdentifier("Blob"));
       default:
         const {
           format: format2,
@@ -626,7 +626,7 @@ var Generator = class _Generator {
             return import_typescript.factory.createToken(import_typescript.SyntaxKind.BooleanKeyword);
           case "blob" /* blob */:
           case "binary" /* binary */:
-            return import_typescript.factory.createTypeReferenceNode(import_typescript.factory.createIdentifier("File"));
+            return import_typescript.factory.createTypeReferenceNode(import_typescript.factory.createIdentifier("Blob"));
           default:
         }
         if (enum_) {
@@ -650,13 +650,13 @@ var Generator = class _Generator {
           );
         }
         if (allOf) {
-          return import_typescript.factory.createUnionTypeNode(
+          return import_typescript.factory.createIntersectionTypeNode(
             allOf.map((schema2) => this.toTypeNode(schema2))
           );
         }
         if (type2 && typeof type2 === "string") {
           return import_typescript.factory.createTypeReferenceNode(
-            type2 !== "unknown" ? import_typescript.factory.createIdentifier(Base.upperCamelCase(type2)) : type2
+            type2 !== "unknown" && type2 !== "null" ? import_typescript.factory.createIdentifier(Base.upperCamelCase(type2)) : type2
           );
         }
     }
@@ -730,16 +730,11 @@ var Generator = class _Generator {
       )
     );
     statements.push(fdDeclaration);
-    parameters.filter(
-      (parameter) => parameter.ref !== void 0 && (parameter.in === "formData" /* formData */ || parameter.schema && this.isBinarySchema(parameter.schema))
-    ).forEach((parameter) => {
+    parameters.forEach((parameter) => {
       statements.push(
         import_typescript.factory.createExpressionStatement(
           import_typescript.factory.createBinaryExpression(
-            import_typescript.factory.createElementAccessExpression(
-              import_typescript.factory.createIdentifier("req"),
-              import_typescript.factory.createStringLiteral(parameter.name)
-            ),
+            import_typescript.factory.createIdentifier(parameter.name),
             import_typescript.factory.createToken(import_typescript.SyntaxKind.AmpersandAmpersandToken),
             import_typescript.factory.createCallExpression(
               import_typescript.factory.createPropertyAccessExpression(
@@ -783,7 +778,13 @@ var Generator = class _Generator {
                       import_typescript.factory.createStringLiteral(key),
                       import_typescript.factory.createIdentifier("file"),
                       import_typescript.factory.createPropertyAccessExpression(
-                        import_typescript.factory.createIdentifier("file"),
+                        import_typescript.factory.createAsExpression(
+                          import_typescript.factory.createIdentifier("file"),
+                          import_typescript.factory.createTypeReferenceNode(
+                            import_typescript.factory.createIdentifier("File"),
+                            void 0
+                          )
+                        ),
                         import_typescript.factory.createIdentifier("name")
                       )
                     ]
@@ -868,25 +869,28 @@ var Generator = class _Generator {
     );
     const shouldParseResponseToJSON = "application/json" === response?.type;
     const isRequestBodyBinary = requestBody?.schema && requestBody.schema.type === "array" /* array */ && this.isBinarySchema(requestBody.schema);
-    const inFormDataParameters = parameters.filter(
-      (p) => p.in === "formData" /* formData */
+    const parametersShouldPutInFormData = parameters.filter(
+      (p) => p.in === "formData" /* formData */ || p.schema && this.isBinarySchema(p.schema)
     );
-    const notInFormDataParameters = parameters.filter(
-      (p) => p.in !== "formData" /* formData */
+    const parametersShouldNotPutInFormData = parameters.filter(
+      (p) => !parametersShouldPutInFormData.includes(p)
     );
-    const isRequestBodyContainsBinary = requestBody?.schema && "properties" in requestBody.schema && Object.values(requestBody.schema.properties).some(
+    const isRequestBodyContainsBinary = requestBody?.schema && "properties" in requestBody.schema && Object.values(requestBody.schema?.properties ?? {}).some(
       (p) => this.isBinarySchema(p)
     );
     const hasBinaryInParameters = parameters.some(
       (p) => p?.schema && this.isBinarySchema(p.schema)
     );
-    const shouldPutParametersOrBodyInFormData = isFormDataRequest || isRequestBodyBinary || hasBinaryInParameters || isRequestBodyContainsBinary || inFormDataParameters.length > 0;
+    const shouldPutParametersOrBodyInFormData = isFormDataRequest || isRequestBodyBinary || hasBinaryInParameters || isRequestBodyContainsBinary || parametersShouldPutInFormData.length > 0;
     return import_typescript.factory.createBlock([
-      ...shouldPutParametersOrBodyInFormData ? this.toFormDataStatement(inFormDataParameters, requestBody?.schema) : [],
+      ...shouldPutParametersOrBodyInFormData ? this.toFormDataStatement(
+        parametersShouldPutInFormData,
+        requestBody?.schema
+      ) : [],
       ...adapter.client(
         uri,
         method,
-        notInFormDataParameters,
+        parametersShouldNotPutInFormData,
         requestBody,
         response,
         adapter,
@@ -1222,7 +1226,7 @@ var FetchAdapter = class extends Adapter {
                 ],
                 void 0,
                 import_typescript3.factory.createToken(import_typescript3.SyntaxKind.EqualsGreaterThanToken),
-                import_typescript3.factory.createAsExpression(
+                response?.schema ? import_typescript3.factory.createAsExpression(
                   import_typescript3.factory.createParenthesizedExpression(
                     import_typescript3.factory.createAwaitExpression(
                       import_typescript3.factory.createCallExpression(
@@ -1236,6 +1240,17 @@ var FetchAdapter = class extends Adapter {
                     )
                   ),
                   response?.schema ? Generator.toTypeNode(response.schema) : import_typescript3.factory.createToken(import_typescript3.SyntaxKind.UnknownKeyword)
+                ) : import_typescript3.factory.createParenthesizedExpression(
+                  import_typescript3.factory.createAwaitExpression(
+                    import_typescript3.factory.createCallExpression(
+                      import_typescript3.factory.createPropertyAccessExpression(
+                        import_typescript3.factory.createIdentifier("response"),
+                        import_typescript3.factory.createIdentifier("json")
+                      ),
+                      void 0,
+                      []
+                    )
+                  )
                 )
               )
             ]
@@ -1346,13 +1361,25 @@ var V2 = class {
         enum: enum_,
         format: format2,
         allOf: allOf?.map(
-          (s) => Base.isRef(s) ? { type: Base.upperCamelCase(Base.ref2name(s.$ref, this.doc)) } : this.toBaseSchema(s, enums)
+          (s) => Base.isRef(s) ? {
+            ...s,
+            ref: s.$ref,
+            type: Base.upperCamelCase(Base.ref2name(s.$ref, this.doc))
+          } : this.toBaseSchema(s, enums)
         ),
         anyOf: anyOf?.map(
-          (s) => Base.isRef(s) ? { type: Base.upperCamelCase(Base.ref2name(s.$ref, this.doc)) } : this.toBaseSchema(s, enums)
+          (s) => Base.isRef(s) ? {
+            ...s,
+            ref: s.$ref,
+            type: Base.upperCamelCase(Base.ref2name(s.$ref, this.doc))
+          } : this.toBaseSchema(s, enums)
         ),
         oneOf: oneOf?.map(
-          (s) => Base.isRef(s) ? { type: Base.upperCamelCase(Base.ref2name(s.$ref, this.doc)) } : this.toBaseSchema(s, enums)
+          (s) => Base.isRef(s) ? {
+            ...s,
+            ref: s.$ref,
+            type: Base.upperCamelCase(Base.ref2name(s.$ref, this.doc))
+          } : this.toBaseSchema(s, enums)
         ),
         properties: Object.keys(properties).reduce((acc, p) => {
           const propSchema = properties[p];
@@ -1382,7 +1409,8 @@ var V2 = class {
       type,
       items,
       enum: enum_,
-      properties
+      properties,
+      schema
     } = parameter;
     if (enum_) {
       const type2 = Base.upperCamelCase(upLevelSchemaKey) + Base.upperCamelCase(name);
@@ -1404,17 +1432,36 @@ var V2 = class {
         }
       };
     }
+    if (items) {
+      return {
+        name,
+        required,
+        description,
+        in: parameter.in,
+        schema: {
+          type,
+          items
+        }
+      };
+    }
+    if (schema && Base.isRef(schema)) {
+      return {
+        name,
+        required,
+        description,
+        in: parameter.in,
+        schema: {
+          type: Base.upperCamelCase(Base.ref2name(schema.$ref))
+        }
+      };
+    }
     return {
       name,
       required,
       description,
       in: parameter.in,
-      schema: items ? {
+      schema: {
         type,
-        items
-      } : {
-        type,
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
         properties
       }
     };
@@ -1493,6 +1540,7 @@ var V2 = class {
               if (code in responses2) {
                 const response = responses2[code];
                 const responseSchema = this.getResponseByRef(response);
+                const inBodyOnlyHasBody = inBody && inBody.length === 1 && inBody[0].in === "body" && inBody[0].name === "body";
                 methodApis.push({
                   method,
                   operationId,
@@ -1501,7 +1549,12 @@ var V2 = class {
                   description: description_,
                   parameters: uniqueParameterName.map((name) => notInBody.find((p) => p.name === name)).filter(Boolean),
                   responses: responseSchema,
-                  requestBody: inBody.length > 0 ? [
+                  requestBody: inBody.length > 0 ? inBodyOnlyHasBody ? [
+                    {
+                      type: "application/json" /* JSON */,
+                      schema: inBody[0].schema
+                    }
+                  ] : [
                     {
                       type: "application/json" /* JSON */,
                       schema: {
@@ -1709,13 +1762,25 @@ var V3 = class {
         enum: enum_,
         format: format2,
         allOf: allOf?.map(
-          (s) => Base.isRef(s) ? { type: Base.capitalize(Base.ref2name(s.$ref, this.doc)) } : this.toBaseSchema(s, enums)
+          (s) => Base.isRef(s) ? {
+            ...s,
+            ref: s.$ref,
+            type: Base.capitalize(Base.ref2name(s.$ref, this.doc))
+          } : this.toBaseSchema(s, enums)
         ),
         anyOf: anyOf?.map(
-          (s) => Base.isRef(s) ? { type: Base.capitalize(Base.ref2name(s.$ref, this.doc)) } : this.toBaseSchema(s, enums)
+          (s) => Base.isRef(s) ? {
+            ...s,
+            ref: s.$ref,
+            type: Base.capitalize(Base.ref2name(s.$ref, this.doc))
+          } : this.toBaseSchema(s, enums)
         ),
         oneOf: oneOf?.map(
-          (s) => Base.isRef(s) ? { type: Base.capitalize(Base.ref2name(s.$ref, this.doc)) } : this.toBaseSchema(s, enums)
+          (s) => Base.isRef(s) ? {
+            ...s,
+            ref: s.$ref,
+            type: Base.capitalize(Base.ref2name(s.$ref, this.doc))
+          } : this.toBaseSchema(s, enums)
         ),
         properties: Object.keys(properties).reduce((acc, p) => {
           const propSchema = properties[p];
@@ -2012,13 +2077,25 @@ var V3_1 = class {
         enum: enum_,
         format: format2,
         allOf: allOf?.map(
-          (s) => Base.isRef(s) ? { type: Base.upperCamelCase(Base.ref2name(s.$ref, this.doc)) } : this.toBaseSchema(s, enums)
+          (s) => Base.isRef(s) ? {
+            ...s,
+            ref: s.$ref,
+            type: Base.upperCamelCase(Base.ref2name(s.$ref, this.doc))
+          } : this.toBaseSchema(s, enums)
         ),
         anyOf: anyOf?.map(
-          (s) => Base.isRef(s) ? { type: Base.upperCamelCase(Base.ref2name(s.$ref, this.doc)) } : this.toBaseSchema(s, enums)
+          (s) => Base.isRef(s) ? {
+            ...s,
+            ref: s.$ref,
+            type: Base.upperCamelCase(Base.ref2name(s.$ref, this.doc))
+          } : this.toBaseSchema(s, enums)
         ),
         oneOf: oneOf?.map(
-          (s) => Base.isRef(s) ? { type: Base.upperCamelCase(Base.ref2name(s.$ref, this.doc)) } : this.toBaseSchema(s, enums)
+          (s) => Base.isRef(s) ? {
+            ...s,
+            ref: s.$ref,
+            type: Base.upperCamelCase(Base.ref2name(s.$ref, this.doc))
+          } : this.toBaseSchema(s, enums)
         ),
         properties: Object.keys(properties).reduce((acc, p) => {
           const propSchema = properties[p];
@@ -2275,13 +2352,12 @@ function apiCodeGenPlugin(options) {
         await tsc();
       } catch (error) {
         logger2.error(error);
-        process.exit(1);
       }
       return {
         ...config,
         server: {
           ...config.server ?? {},
-          proxy: proxies
+          proxy: Object.assign({}, config.server?.proxy ?? {}, proxies)
         }
       };
     }