@penkov/swagger-code-gen 1.3.2 → 1.3.3

package/dist/method.js

@@ -9,7 +9,9 @@ export class Method {
         this.method = method;
         this.tags = option(def.tags).getOrElseValue([]);
         this.summary = def.summary;
-        const parameters = Collection.from(def.parameters)
+        this.description = def.description;
+        this.operationId = option(def.operationId);
+        const parameters = Collection.from(option(def.parameters).getOrElseValue([]))
             .map(p => Parameter.fromDefinition(p, schemasTypes, options))
             .sort((a, b) => {
             const r1 = a.required ? 1 : 0;
@@ -41,12 +43,15 @@ export class Method {
                 .orElseValue(mimeTypes.headOption)
                 .map(mt => SchemaFactory.build('body', body[mt].schema, schemasTypes, options));
         });
+        this.bodyDescription = option(def.requestBody).flatMap(body => option(body.description));
         const statusCodes = Collection.from(Object.keys(def.responses))
             .map(x => parseInt(x));
         const successCode = statusCodes
             .filter(code => code / 100 === 2)
             .minByOption(identity);
-        const respDef = successCode.map(_ => def.responses[_]).getOrElseValue(def.responses[statusCodes.head]);
+        const respDef = successCode.map(_ => def.responses[_])
+            .orElse(() => option(def.responses['default']))
+            .getOrElseValue(def.responses[statusCodes.head]);
         const mimeTypes = option(respDef.content)
             .map(content => Collection.from(Object.keys(content)).toMap(mimeType => [mimeType, content[mimeType]])).getOrElseValue(HashMap.empty);
         this.response = mimeTypes.get('application/json')
@@ -63,12 +68,13 @@ export class Method {
             asProperty: Property.fromDefinition('UNKNOWN', { type: 'any' }, schemasTypes, options),
             responseType: 'any'
         }));
+        this.wrapParamsInObject = this.parameters.size > 2 || (this.body.isDefined) && this.parameters.nonEmpty;
     }
     get endpointName() {
-        return `${this.method}${Method.pathToName(this.path)}`;
+        return this.operationId.getOrElse(() => `${this.method}${Method.pathToName(this.path)}`);
     }
     get pathWithSubstitutions() {
-        const paramPrefix = `${this.parameters.size > 2 ? 'params.' : ''}`;
+        const paramPrefix = `${this.wrapParamsInObject ? 'params.' : ''}`;
         return this.path.replace(/\{(\w+?)\}/g, (matched, group) => {
             const remappedName = this.parameters.find(p => p.name === group && p.in === 'path')
                 .map(_ => _.uniqueName)

package/dist/parameter.js

@@ -1,13 +1,14 @@
 import { SchemaEnum, SchemaFactory, SchemaObject } from './schemas.js';
-import { Collection, identity, option } from 'scats';
+import { Collection, identity, none, option } from 'scats';
 import { Method } from './method.js';
 import { Property } from './property.js';
 export class Parameter {
-    constructor(name, uniqueName, inValue, jsType, required, description) {
+    constructor(name, uniqueName, inValue, jsType, required, defaultValue, description) {
         this.name = name;
         this.uniqueName = uniqueName;
         this.jsType = jsType;
         this.required = required;
+        this.defaultValue = defaultValue;
         this.description = description;
         this.in = inValue;
     }
@@ -15,14 +16,33 @@ export class Parameter {
         const name = Parameter.toJSName(def.name);
         const inValue = def.in;
         const desc = option(def.description);
-        const required = option(def.required).exists(identity);
+        let defaultValue = none;
         const schema = SchemaFactory.build(def.name, def.schema, schemas, options);
         let jsType;
         if (schema instanceof SchemaObject) {
             jsType = schema.type;
         }
         else if (schema instanceof SchemaEnum) {
-            jsType = schema.name;
+            if (schemas.containsKey(schema.name)) {
+                jsType = schema.name;
+            }
+            else if (schema.type === 'string') {
+                jsType = `${schema.values.map(x => `'${x}'`).mkString(' | ')}`;
+            }
+            else if (schema.type === 'integer') {
+                jsType = `${schema.values.map(x => `${x}`).mkString(' | ')}`;
+            }
+            else {
+                jsType = schema.type;
+            }
+            defaultValue = schema.defaultValue.map(x => {
+                if (schema.type === 'string') {
+                    return `'${x}'`;
+                }
+                else {
+                    return x;
+                }
+            });
         }
         else if (schema instanceof Property) {
             jsType = schema.jsType;
@@ -30,7 +50,8 @@ export class Parameter {
         else {
             throw new Error('Unknown schema type');
         }
-        return new Parameter(name, name, inValue, jsType, required, desc);
+        const required = option(def.required).exists(identity) || defaultValue.nonEmpty;
+        return new Parameter(name, name, inValue, jsType, required, defaultValue, desc);
     }
     static toJSName(path) {
         const tokens = Collection.from(path.split(/\W/)).filter(t => t.length > 0);
@@ -39,6 +60,6 @@ export class Parameter {
         }).mkString();
     }
     copy(p) {
-        return new Parameter(option(p.name).getOrElseValue(this.name), option(p.uniqueName).getOrElseValue(this.uniqueName), option(p.in).getOrElseValue(this.in), option(p.jsType).getOrElseValue(this.jsType), option(p.required).getOrElseValue(this.required), option(p.description).getOrElseValue(this.description));
+        return new Parameter(option(p.name).getOrElseValue(this.name), option(p.uniqueName).getOrElseValue(this.uniqueName), option(p.in).getOrElseValue(this.in), option(p.jsType).getOrElseValue(this.jsType), option(p.required).getOrElseValue(this.required), option(p.defaultValue).getOrElseValue(this.defaultValue), option(p.description).getOrElseValue(this.description));
     }
 }

package/dist/schemas.js

@@ -37,15 +37,16 @@ export class SchemaFactory {
     }
 }
 export class SchemaEnum {
-    constructor(name, title, type, values) {
+    constructor(name, title, type, defaultValue, values) {
         this.name = name;
         this.title = title;
         this.type = type;
+        this.defaultValue = defaultValue;
         this.values = values;
         this.schemaType = 'enum';
     }
     static fromDefinition(name, def) {
-        return new SchemaEnum(name, def.title, def.type, option(def.enum).map(Collection.from).getOrElseValue(Nil));
+        return new SchemaEnum(name, def.title, def.type, option(def.default), option(def.enum).map(Collection.from).getOrElseValue(Nil));
     }
 }
 export class SchemaObject {

package/dist/templates/index.ejs

@@ -11,8 +11,9 @@
  *********************************************************
  *********************************************************/
 import fetch, {Request, Response} from 'node-fetch';
+import {option, Option} from 'scats';
 <% if (scats) {%>
-import {option, Option, Collection, Try, TryLike, none} from 'scats';
+import {Collection, Try, TryLike, none} from 'scats';
 <% } %>
 
 export interface RequestOptions {

package/dist/templates/method.ejs

@@ -1,22 +1,27 @@
 /**
  * <%= method.method.toUpperCase() %> <%= method.path %>
-<% if (method.parameters.size > 2) { -%>
+<% if (method.summary) { -%>
+ * @summary <%= method.summary %>
+<% } -%>
+<% if (method.description) { -%>
+ * @description <%= method.description %>
+<% } -%>
+<% if (method.wrapParamsInObject) { -%>
  * @param {Object} params
 <% } -%>
 <% method.parameters.foreach(p => { -%>
- * @param {<%= p.jsType %>} <%= method.parameters.size > 2 ? 'params.' : '' %><%= p.uniqueName %> <%= p.description.getOrElseValue('')%>
+ * @param {<%= p.jsType %>} <%= method.wrapParamsInObject ? 'params.' : '' %><%= p.uniqueName %> <%= p.description.getOrElseValue('')%>
 <% }); -%>
 <%_ if (method.body.nonEmpty) { -%>
- * @param {<%= method.body.get.type %>} body
+ * @param {<%= method.body.get.jsType %>} body <%= method.bodyDescription.getOrElseValue('') %>
 <%_ } -%>
  * @param {RequestOptions} requestOptions Additional request params
- * @summary <%= method.summary %>
  * @return {<%= method.response.responseType %>} <%= method.response.description %>
  */
 export async function <%= method.endpointName %>(
-    <%_ if (method.parameters.size <= 2) { -%>
+    <%_ if (!method.wrapParamsInObject) { -%>
     <%_ method.parameters.foreach(p => { -%>
-    <%= p.uniqueName %><%= p.required ? '' : '?'%>: <%- p.jsType %>,
+    <%= p.uniqueName %><%= p.required ? '' : '?'%>: <%- p.jsType %><%- p.defaultValue.map(x => ` = ${x}`).getOrElseValue('') %>,
     <%_ }) -%>
     <%_ } else { -%>
     params: {
@@ -26,7 +31,7 @@ export async function <%= method.endpointName %>(
     },
     <%_ } -%>
     <%_ if (method.body.nonEmpty) { -%>
-    body: <%= method.body.get.type %>,
+    body: <%- method.body.get.jsType %>,
     <%_ } -%>
     requestOptions: RequestOptions = defaultRequestOptions()
 ): Promise<<%- method.response.responseType %>> {
@@ -35,17 +40,17 @@ export async function <%= method.endpointName %>(
     const queryParams = [];
     <%_ method.parameters.filter(x => x.in === 'query' && x.required).foreach(p => { -%>
     <%_ if (p.jsType === 'string') { -%>
-    queryParams.push(`<%= p.name %>=${encodeURIComponent(<%= method.parameters.size > 2 ? 'params.' : '' %><%= p.uniqueName %>)}`);
+    queryParams.push(`<%= p.name %>=${encodeURIComponent(<%= method.wrapParamsInObject ? 'params.' : '' %><%= p.uniqueName %>)}`);
     <%_ } else { -%>
-    queryParams.push(`<%= p.name %>=${<%= method.parameters.size > 2 ? 'params.' : '' %><%= p.uniqueName %>}`);
+    queryParams.push(`<%= p.name %>=${<%= method.wrapParamsInObject ? 'params.' : '' %><%= p.uniqueName %>}`);
     <%_ }  -%>
     <%_ }) -%>
     <%_ method.parameters.filter(x => x.in === 'query' && !x.required).foreach(p => { -%>
-    if (!!<%= method.parameters.size > 2 ? 'params.' : '' %><%= p.uniqueName %>) {
+    if (!!<%= method.wrapParamsInObject ? 'params.' : '' %><%= p.uniqueName %>) {
         <%_ if (p.jsType === 'string') { -%>
-        queryParams.push(`<%= p.name %>=${encodeURIComponent(<%= method.parameters.size > 2 ? 'params.' : '' %><%= p.uniqueName %>)}`);
+        queryParams.push(`<%= p.name %>=${encodeURIComponent(<%= method.wrapParamsInObject ? 'params.' : '' %><%= p.uniqueName %>)}`);
         <%_ } else { -%>
-        queryParams.push(`<%= p.name %>=${<%= method.parameters.size > 2 ? 'params.' : '' %><%= p.uniqueName %>}`);
+        queryParams.push(`<%= p.name %>=${<%= method.wrapParamsInObject ? 'params.' : '' %><%= p.uniqueName %>}`);
         <%_ }  -%>
     }
     <%_ }) -%>
@@ -60,20 +65,20 @@ export async function <%= method.endpointName %>(
             ...option(requestOptions.headers).getOrElseValue({}),
             <%_ if (method.parameters.filter(x => x.in === 'header').nonEmpty) { -%>
             <%_ method.parameters.filter(x => x.in === 'header').foreach(p => { -%>
-            <%= p.name %>: <%= method.parameters.size > 2 ? 'params.' : '' %><%= p.uniqueName %>
+            <%= p.name %>: <%= method.wrapParamsInObject ? 'params.' : '' %><%= p.uniqueName %>
             <%_ }) -%>
             <%_ }  -%>
         }
     });
-    const preprocessed = option(requestOptions.preProcessRequest).map(cb => cb(request)).getOrElseValue(request);
-    const resp = await fetch(preprocessed);
+    const preProcessed = option(requestOptions.preProcessRequest).map(cb => cb(request)).getOrElseValue(request);
+    const resp = await fetch(preProcessed);
     if (resp.ok) {
-        const postprocessed = option(requestOptions.postProcessResponse)
-            .map(cb => cb(preprocessed, resp))
+        const postProcessed = option(requestOptions.postProcessResponse)
+            .map(cb => cb(preProcessed, resp))
             .getOrElseValue(resp);
         const json = option(resp.headers.get('content-length'))
             .map(x => parseInt(x))
-            .getOrElseValue(0) > 0 ? await postprocessed.json() : null;
+            .getOrElseValue(0) > 0 ? await postProcessed.json() : null;
         return json as <%- method.response.responseType %>;
     } else {
         throw resp;

package/dist/templates/scats-method.ejs

@@ -6,7 +6,7 @@ export class ApiClient {
 
     <% methods.foreach(method => { %>
     async <%= method.endpointName %>(
-        <%_ if (method.parameters.size <= 2) { -%>
+        <%_ if (!method.wrapParamsInObject) { -%>
         <%_ method.parameters.foreach(p => { -%>
         <%= p.uniqueName %>: <%- p.required && !p.nullable ? p.jsType : `Option<${p.jsType}> = none` %>,
         <%_ }) -%>
@@ -18,13 +18,13 @@ export class ApiClient {
         },
         <%_ } -%>
         <%_ method.body.foreach(body => { -%>
-        body: <%= body.type %>,
+        body: <%- body.jsType %>,
         <%_ }); -%>
         requestOptions: RequestOptions = this.requestOptions
     ): Promise<TryLike<<%- method.response.asProperty.scatsWrapperType %>>> {
         return (await Try.promise(() =>
                 <%= method.endpointName %>(
-                    <%_ if (method.parameters.size <= 2) { -%>
+                    <%_ if (!method.wrapParamsInObject) { -%>
                     <%_ method.parameters.foreach(p => { -%>
                     <%= p.uniqueName %><%- p.required && !p.nullable ? '' : `.orUndefined` %>,
                     <%_ }) -%>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@penkov/swagger-code-gen",
-  "version": "1.3.2",
+  "version": "1.3.3",
   "type": "module",
   "bin": {
     "generate-client": "./dist/cli.mjs"
@@ -22,6 +22,7 @@
   },
   "homepage": "https://github.com/papirosko/swagger-code-gen#readme",
   "scripts": {
+    "test:petstore": "mkdir -p tmp && ts-node-esm ./src/cli.mjs --enableScats --url https://petstore3.swagger.io/api/v3/openapi.json tmp/petstore.ts",
     "clean": "rimraf dist",
     "lint": "eslint \"{src,test}/**/*.ts\" --fix",
     "prebuild": "npm run lint && npm run clean",