@penkov/swagger-code-gen 1.6.8 → 1.6.9

package/dist/method.js

@@ -1,8 +1,9 @@
-import { Collection, HashMap, HashSet, identity, option } from 'scats';
+import { Collection, HashMap, HashSet, identity, Nil, option } from 'scats';
 import { Property } from './property.js';
 import { Parameter } from './parameter.js';
 import { SchemaFactory } from './schemas.js';
 const sortByIn = HashMap.of(['path', 0], ['query', 1], ['header', 2], ['cookie', 3], ['body', 4]);
+const supportedBodyMimeTypes = HashMap.of(['application/json', 'Json'], ['application/x-www-form-urlencoded', 'Form'], ['multipart/form-data', 'File'], ['application/octet-stream', 'Binary']);
 export class Method {
     constructor(path, method, def, schemasTypes, options) {
         this.path = path;
@@ -35,28 +36,30 @@ export class Method {
                 return p;
             }
         });
-        this.body = option(def.requestBody).flatMap(body => option(body.content))
-            .flatMap(body => {
+        this.body = option(def.requestBody)
+            .flatMap(body => option(body.content))
+            .map(body => {
             const bodyRequired = option(def.requestBody.required).contains(true);
             const mimeTypes = Collection.from(Object.keys(body));
-            return mimeTypes
-                .find(_ => _ === 'application/json')
-                .orElseValue(mimeTypes.headOption)
-                .map(mt => {
+            const supportedMimeTypes = mimeTypes.filter(_ => supportedBodyMimeTypes.containsKey(_));
+            return supportedMimeTypes.map(mt => {
                 const bodySchemaDef = body[mt].schema;
-                const res = SchemaFactory.build('body', bodySchemaDef, schemasTypes, options);
+                let res = SchemaFactory.build('body', bodySchemaDef, schemasTypes, options);
                 if (res.schemaType === 'property') {
                     const bProperty = res;
-                    return bProperty.copy({
+                    res = bProperty.copy({
                         nullable: bProperty.referencesObject ? option(bodySchemaDef['nullable']).contains(true) : bProperty.nullable,
                         required: bodyRequired
                     });
                 }
-                else {
-                    return res;
-                }
+                return {
+                    body: res,
+                    mimeType: mt,
+                    suffix: supportedMimeTypes.size > 1 ? supportedBodyMimeTypes.get(mt).getOrElseValue(mt) : ''
+                };
             });
-        });
+        })
+            .getOrElseValue(Nil);
         this.bodyDescription = option(def.requestBody).flatMap(body => option(body.description));
         const statusCodes = Collection.from(Object.keys(def.responses))
             .map(x => parseInt(x));
@@ -83,7 +86,7 @@ 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;
+        this.wrapParamsInObject = this.parameters.size > 2 || (this.body.nonEmpty) && this.parameters.nonEmpty;
     }
     get endpointName() {
         return this.operationId.getOrElse(() => `${this.method}${Method.pathToName(this.path)}`);

package/dist/parameter.js

@@ -3,11 +3,13 @@ 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, defaultValue, description) {
+    constructor(name, uniqueName, inValue, jsType, required, isArray, defaultValue, description) {
         this.name = name;
         this.uniqueName = uniqueName;
+        this.inValue = inValue;
         this.jsType = jsType;
         this.required = required;
+        this.isArray = isArray;
         this.defaultValue = defaultValue;
         this.description = description;
         this.in = inValue;
@@ -51,7 +53,8 @@ export class Parameter {
             throw new Error('Unknown schema type');
         }
         const required = option(def.required).exists(identity) || defaultValue.nonEmpty;
-        return new Parameter(name, name, inValue, jsType, required, defaultValue, desc);
+        const isArray = def.schema.type === 'array';
+        return new Parameter(name, name, inValue, jsType, required, isArray, defaultValue, desc);
     }
     static toJSName(path) {
         const tokens = Collection.from(path.split(/\W/)).filter(t => t.length > 0);
@@ -60,6 +63,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.defaultValue).getOrElseValue(this.defaultValue), 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.isArray).getOrElseValue(this.isArray), option(p.defaultValue).getOrElseValue(this.defaultValue), option(p.description).getOrElseValue(this.description));
     }
 }

package/dist/property.js

@@ -1,9 +1,10 @@
-import { Collection, option } from 'scats';
+import { Collection, none, option } from 'scats';
 const SCHEMA_PREFIX = '#/components/schemas/';
 export class Property {
-    constructor(name, type, description, defaultValue, nullable, required, items, referencesObject, itemReferencesObject) {
+    constructor(name, type, format, description, defaultValue, nullable, required, items, referencesObject, itemReferencesObject, enumValues) {
         this.name = name;
         this.type = type;
+        this.format = format;
         this.description = description;
         this.defaultValue = defaultValue;
         this.nullable = nullable;
@@ -11,10 +12,11 @@ export class Property {
         this.items = items;
         this.referencesObject = referencesObject;
         this.itemReferencesObject = itemReferencesObject;
+        this.enumValues = enumValues;
         this.schemaType = 'property';
     }
     copy(p) {
-        return new Property(option(p.name).getOrElseValue(this.name), option(p.type).getOrElseValue(this.type), option(p.description).getOrElseValue(this.description), option(p.defaultValue).getOrElseValue(this.defaultValue), option(p.nullable).getOrElseValue(this.nullable), option(p.required).getOrElseValue(this.required), option(p.items).getOrElseValue(this.items), option(p.referencesObject).getOrElseValue(this.referencesObject), option(p.itemReferencesObject).getOrElseValue(this.itemReferencesObject));
+        return new Property(option(p.name).getOrElseValue(this.name), option(p.type).getOrElseValue(this.type), option(p.format).getOrElseValue(this.format), option(p.description).getOrElseValue(this.description), option(p.defaultValue).getOrElseValue(this.defaultValue), option(p.nullable).getOrElseValue(this.nullable), option(p.required).getOrElseValue(this.required), option(p.items).getOrElseValue(this.items), option(p.referencesObject).getOrElseValue(this.referencesObject), option(p.itemReferencesObject).getOrElseValue(this.itemReferencesObject), option(p.enumValues).getOrElseValue(this.enumValues));
     }
     static fromDefinition(name, definition, schemas, options) {
         const referencesObject = option(definition.$ref)
@@ -59,21 +61,41 @@ export class Property {
             .map(ref => ref.substring(SCHEMA_PREFIX.length))
             .orElseValue(option(oneOfItem.type))).mkString(' | ')))
             .getOrElseValue('any');
-        return new Property(name, type, description, null, nullable, required, items, referencesObject, itemReferencesObject);
+        const enumValues = option(definition.enum).map(x => Collection.from(x));
+        return new Property(name, type, option(definition.format), description, null, nullable, required, items, referencesObject, itemReferencesObject, enumValues);
     }
     get jsType() {
-        let res = Property.toJsType(this.type, this.items);
+        let res = Property.toJsType(this.type, this.items, this.format);
         if (this.nullable) {
             res = res + ' | null';
         }
+        else if (this.enumValues.exists(x => x.nonEmpty)) {
+            res = this.enumValues.get
+                .map(enumValue => {
+                if (this.type === 'string') {
+                    return `'${enumValue}'`;
+                }
+                else {
+                    return enumValue;
+                }
+            })
+                .mkString(' | ');
+        }
         return res;
     }
     get isArray() {
         return this.type === 'array';
     }
-    static toJsType(tpe, itemTpe = 'any') {
+    static toJsType(tpe, itemTpe = 'any', format = none) {
         switch (tpe) {
             case 'integer': return 'number';
+            case 'string':
+                if (format.contains('binary')) {
+                    return 'Blob | Buffer';
+                }
+                else {
+                    return 'string';
+                }
             case 'array': return `ReadonlyArray<${Property.toJsType(itemTpe)}>`;
             default: return tpe;
         }
@@ -104,7 +126,19 @@ export class Property {
             }
         }
         else {
-            const jsType = Property.toJsType(this.type, this.items);
+            let jsType = Property.toJsType(this.type, this.items, this.format);
+            if (this.enumValues.exists(x => x.nonEmpty)) {
+                jsType = this.enumValues.get
+                    .map(enumValue => {
+                    if (this.type === 'string') {
+                        return `'${enumValue}'`;
+                    }
+                    else {
+                        return enumValue;
+                    }
+                })
+                    .mkString(' | ');
+            }
             return !this.nullable && this.required ? this.jsType : `Option<${jsType}>`;
         }
     }

package/dist/renderer.js

@@ -2,11 +2,13 @@ import * as ejs from 'ejs';
 import * as fs from 'fs';
 import path, { dirname } from 'path';
 import { fileURLToPath } from 'url';
+import * as scatsLib from 'scats';
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
 export class Renderer {
     async renderToFile(schemas, methods, enableScats, targetNode, file) {
         const view = await ejs.renderFile(path.resolve(__dirname, 'templates/index.ejs'), {
+            scatsLib: scatsLib,
             schemas: schemas,
             methods: methods,
             scats: enableScats,

package/dist/templates/index.ejs

@@ -1,3 +1,4 @@
+/* eslint-disable */
 /*********************************************************
  *********************************************************
  *********************************************************
@@ -11,7 +12,7 @@
  *********************************************************
  *********************************************************/
 <% if (targetNode) {%>
-import fetch, {Request, Response} from 'node-fetch';
+import fetch, {Request, Response, BodyInit} from 'node-fetch';
 <% } %>
 <% if (scats) {%>
 import {option, Option, Collection, Try, TryLike, none} from 'scats';
@@ -35,6 +36,38 @@ export const defaultRequestOptions: RequestOptions = {
 
 const defReqOpts = () => defaultRequestOptions;
 
+
+function valueToString(value: any): string {
+    if (typeof value === 'string' || typeof value === 'boolean' || typeof value === 'number') {
+        return value.toString();
+    } else {
+        return JSON.stringify(value);
+    }
+}
+
+/**
+ * Helper to serialize data for 'multipart/form-data'
+ */
+function objectToForm(o: object): FormData {
+    const res = new FormData();
+    Object.keys(o)
+        .filter(k => o[k] !== undefined && o[k] !== null)
+        .forEach(k => {
+            res.append(k, valueToString(o[k]));
+        });
+    return res;
+}
+
+/**
+ * Helper to serialize data for 'application/x-www-form-urlencoded'
+ */
+function objectToFormWwwEncoded(o: object): string {
+    return Object.keys(o)
+        .filter(k => o[k] !== undefined && o[k] !== null)
+        .map(k => `${k}=${encodeURIComponent(valueToString(o[k]))}`)
+        .join('&');
+}
+
 async function requestImpl<T>(request: Request, requestOptions: RequestOptions): Promise<T> {
     const preProcessed = requestOptions.preProcessRequest ? await requestOptions.preProcessRequest(request) : request;
     const resp = await fetch(preProcessed);
@@ -61,9 +94,22 @@ async function requestImpl<T>(request: Request, requestOptions: RequestOptions):
 
 
 
-<% methods.foreach(method => { %>
-<%- include('method.ejs', {method: method}); %>
-<% }); %>
+<%
+methods.foreach(method => {
+    if (method.body.nonEmpty) {
+        method.body.foreach(body => {
+%>
+<%- include('method.ejs', {method: method, body: scatsLib.some(body)}); %>
+<%
+        });
+    } else {
+%>
+<%- include('method.ejs', {method: method, body: scatsLib.none }); %>
+<%
+    }
+});
+%>
+
 
 
 <% if (scats) {%>
@@ -71,7 +117,7 @@ async function requestImpl<T>(request: Request, requestOptions: RequestOptions):
 <%- include('scats-schema.ejs', {schema: schema}); %>
 <% }); %>
 
-<%- include('scats-method.ejs'); %>
+<%- include('scats-api-client.ejs'); %>
 
 <% } %>
 

package/dist/templates/method.ejs

@@ -12,13 +12,13 @@
 <% method.parameters.foreach(p => { -%>
  * @param {<%= p.jsType %>} <%= method.wrapParamsInObject ? 'params.' : '' %><%= p.uniqueName %> <%= p.description.getOrElseValue('')%>
 <% }); -%>
-<%_ if (method.body.nonEmpty) { -%>
- * @param {<%= method.body.get.jsType %>} body <%= method.bodyDescription.getOrElseValue('') %>
+<%_ if (body.nonEmpty) { -%>
+ * @param {<%= body.get.body.jsType %>} body <%= method.bodyDescription.getOrElseValue('') %>
 <%_ } -%>
  * @param {RequestOptions} requestOptions Additional request params
  * @return {<%= method.response.responseType %>} <%= method.response.description %>
  */
-export async function <%= method.endpointName %>(
+export async function <%= method.endpointName %><%= body.map(b => b.suffix).getOrElseValue('') %>(
     <%_ if (!method.wrapParamsInObject) { -%>
     <%_ method.parameters.foreach(p => { -%>
     <%= p.uniqueName %><%= p.required ? '' : '?'%>: <%- p.jsType %><%- p.defaultValue.map(x => ` = ${x}`).getOrElseValue('') %>,
@@ -30,8 +30,8 @@ export async function <%= method.endpointName %>(
         <%_ }) -%>
     },
     <%_ } -%>
-    <%_ if (method.body.nonEmpty) { -%>
-    body<%= method.body.get.required ? '' : '?'%>: <%- method.body.get.jsType %>,
+    <%_ if (body.nonEmpty) { -%>
+    body<%= body.get.body.required ? '' : '?'%>: <%- body.get.body.jsType %>,
     <%_ } -%>
     requestOptions: RequestOptions = defReqOpts()
 ): Promise<<%- method.response.responseType %>> {
@@ -47,7 +47,11 @@ export async function <%= method.endpointName %>(
     <%_ }) -%>
     <%_ method.parameters.filter(x => x.in === 'query' && !x.required).foreach(p => { -%>
     if (!!<%= method.wrapParamsInObject ? 'params.' : '' %><%= p.uniqueName %>) {
-        <%_ if (p.jsType === 'string') { -%>
+        <%_ if (p.isArray) { -%>
+        <%= method.wrapParamsInObject ? 'params.' : '' %><%= p.uniqueName %>.forEach(p => {
+            queryParams.push(`<%= p.name %>=${p}`);
+        });
+        <%_ } else if (p.jsType === 'string') { -%>
         queryParams.push(`<%= p.name %>=${encodeURIComponent(<%= method.wrapParamsInObject ? 'params.' : '' %><%= p.uniqueName %>)}`);
         <%_ } else { -%>
         queryParams.push(`<%= p.name %>=${<%= method.wrapParamsInObject ? 'params.' : '' %><%= p.uniqueName %>}`);
@@ -58,9 +62,19 @@ export async function <%= method.endpointName %>(
         query = '?' + queryParams.join('&');
     }
     <%_ }  -%>
+    let bodySerialised: BodyInit | null = null;
+    <%_ if (body.nonEmpty && body.get.mimeType === 'application/json') {%>
+    bodySerialised = JSON.stringify(body);
+    <%_ } else if (body.nonEmpty && body.get.mimeType === 'application/x-www-form-urlencoded') { -%>
+    bodySerialised = objectToFormWwwEncoded(body);
+    <%_ } else if (body.nonEmpty && body.get.mimeType === 'multipart/form-data') { -%>
+    bodySerialised = objectToForm(body);
+    <%_ } else if (body.nonEmpty && body.get.mimeType === 'application/octet-stream') { -%>
+    bodySerialised = body;
+    <%_ }  -%>
     const request = new Request(`${requestOptions.apiPrefix}<%- method.pathWithSubstitutions %>${query}`, {
         method: '<%= method.method %>',
-        body: <%= method.body.map(() => 'JSON.stringify(body)').getOrElseValue('undefined') %>,
+        body: bodySerialised,
         headers: {
             ...requestOptions.headers || {},
             <%_ if (method.parameters.filter(x => x.in === 'header').nonEmpty) { -%>

package/dist/templates/scats-api-client.ejs

@@ -0,0 +1,23 @@
+export class ApiClient {
+
+    constructor(private readonly requestOptions: RequestOptions = defReqOpts()) {
+    }
+
+
+    <%
+    methods.foreach(method => {
+        if (method.body.nonEmpty) {
+            method.body.foreach(body => {
+    %>
+    <%- include('scats-method.ejs', {method: method, body: scatsLib.some(body)}); %>
+    <%
+            });
+        } else {
+    %>
+    <%- include('scats-method.ejs', {method: method, body: scatsLib.none }); %>
+    <%
+        }
+    });
+    %>
+
+}

package/dist/templates/scats-method.ejs

@@ -1,11 +1,5 @@
-export class ApiClient {
 
-    constructor(private readonly requestOptions: RequestOptions = defReqOpts()) {
-    }
-
-
-    <% methods.foreach(method => { %>
-    async <%= method.endpointName %>(
+    async <%= method.endpointName %><%= body.map(b => b.suffix).getOrElseValue('') %>(
         <%_ if (!method.wrapParamsInObject) { -%>
         <%_ method.parameters.foreach(p => { -%>
         <%= p.uniqueName %>: <%- p.required && !p.nullable ? p.jsType : `Option<${p.jsType}> = none` %>,
@@ -17,13 +11,13 @@ export class ApiClient {
             <%_ }) -%>
         },
         <%_ } -%>
-        <%_ method.body.foreach(body => { -%>
-        body: <%- body.scatsWrapperType %>,
+        <%_ body.foreach(body => { -%>
+        body: <%- body.body.scatsWrapperType %>,
         <%_ }); -%>
         requestOptions: RequestOptions = this.requestOptions
     ): Promise<TryLike<<%- method.response.asProperty.scatsWrapperType %>>> {
         return (await Try.promise(() =>
-                <%= method.endpointName %>(
+                <%= method.endpointName %><%= body.map(b => b.suffix).getOrElseValue('') %>(
                     <%_ if (!method.wrapParamsInObject) { -%>
                     <%_ method.parameters.foreach(p => { -%>
                     <%= p.uniqueName %><%- p.required && !p.nullable ? '' : `.orUndefined` %>,
@@ -31,7 +25,7 @@ export class ApiClient {
                     <%_ } else { -%>
                     params,
                     <%_ } -%>
-                    <%_ method.body.foreach(body => { -%>
+                    <%_ body.map(x => x.body).foreach(body => { -%>
                     <%_ if (body.schemaType === 'object') { _%>
                     body.toJson,
                     <%_ } else if (body.schemaType === 'property') { _%>
@@ -64,7 +58,4 @@ export class ApiClient {
             <%_ } _%>
             <%_ } _%>;
     }
-    <% }); %>
-
 
-}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@penkov/swagger-code-gen",
-  "version": "1.6.8",
+  "version": "1.6.9",
   "type": "module",
   "bin": {
     "generate-client": "./dist/cli.mjs"