swaggie 0.7.4 → 0.7.6

package/README.md

@@ -6,7 +6,6 @@
 
 ![npm latest version](https://img.shields.io/npm/v/swaggie)
 ![NodeCI](https://github.com/yhnavein/swaggie/workflows/NodeCI/badge.svg)
-[![CircleCI](https://circleci.com/gh/yhnavein/swaggie.svg?style=svg)](https://circleci.com/gh/yhnavein/swaggie)
 ![Snyk Vulnerabilities for GitHub Repo](https://img.shields.io/snyk/vulnerabilities/github/yhnavein/swaggie.svg)
 ![npm downloads](https://img.shields.io/npm/dw/swaggie.svg)
 ![npm bundle size](https://img.shields.io/bundlephobia/minzip/swaggie.svg)

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/gen/js/createBarrel.d.ts

@@ -0,0 +1,2 @@
+import { ClientOptions } from '../../types';
+export declare function generateBarrelFile(clients: any[], clientOptions: ClientOptions): Promise<string | void>;

package/dist/gen/js/genOperations.d.ts

@@ -0,0 +1,15 @@
+import { IApiOperation, IQueryDefinitions } from './models';
+import { ApiSpec, ApiOperation, ClientOptions } from '../../types';
+export default function genOperations(spec: ApiSpec, operations: ApiOperation[], options: ClientOptions): Promise<[string, IQueryDefinitions]>;
+export declare function prepareOperations(operations: ApiOperation[], options: ClientOptions): [IApiOperation[], IQueryDefinitions];
+/**
+ * We will add numbers to the duplicated operation names to avoid breaking code
+ * @param operations
+ */
+export declare function fixDuplicateOperations(operations: ApiOperation[]): ApiOperation[];
+export declare function getOperationName(opId: string, group?: string): string;
+export declare function renderOperationGroup(group: any[], func: any, spec: ApiSpec, options: ClientOptions): string[];
+/**
+ * Escapes param names to more safe form
+ */
+export declare function getParamName(name: string): string;

package/dist/gen/js/genTypes.d.ts

@@ -0,0 +1,17 @@
+import { IQueryDefinitions } from './models';
+import { ApiSpec, ClientOptions } from '../../types';
+export default function genTypes(spec: ApiSpec, queryDefinitions: IQueryDefinitions, options: ClientOptions): string;
+/**
+ * Types coming from query models are different and they need to support nesting. Examples:
+ * @example
+ * 'parameters.filter.name': string, 'parameters.filter.query': string
+ * Will need to become:
+ * @example
+ * {
+ *  parameters: {
+ *    filter: { name: string, query: string }
+ *  }
+ * }
+ */
+export declare function renderQueryStringParameters(def: any, options: ClientOptions): string[];
+export declare function renderComment(comment: string): string;

package/dist/gen/js/index.d.ts

@@ -0,0 +1,2 @@
+import { ApiOperation, ApiSpec, ClientOptions } from '../../types';
+export default function genCode(spec: ApiSpec, operations: ApiOperation[], options: ClientOptions): Promise<string>;

package/dist/gen/js/models.d.ts

@@ -0,0 +1,40 @@
+import { ApiOperationParam } from '../../types';
+export interface IApiOperation {
+    returnType: string;
+    method: string;
+    name: string;
+    url: string;
+    body: object | null | undefined;
+    parameters: IOperationParam[];
+    headers: IOperationParam[];
+}
+export interface IOperationParam {
+    name: string;
+    originalName: string;
+    type: string;
+    optional: boolean;
+    value?: string;
+    original: ApiOperationParam;
+}
+export interface IServiceClient {
+    clientName: string;
+    camelCaseName: string;
+    baseUrl?: string;
+    operations: IApiOperation[];
+}
+export interface IQueryPropDefinition {
+    type: string;
+    format?: string;
+    required?: string[];
+    properties?: {
+        [key: string]: ApiOperationParam;
+    };
+    enum?: any;
+    fullEnum?: any;
+    description?: string;
+    'x-enumNames'?: string[];
+    queryParam?: boolean;
+}
+export interface IQueryDefinitions {
+    [key: string]: IQueryPropDefinition;
+}

package/dist/gen/js/support.d.ts

@@ -0,0 +1,2 @@
+import { ClientOptions } from '../../types';
+export declare function getTSParamType(param: any, options: ClientOptions): string;

package/dist/gen/templateManager.d.ts

@@ -0,0 +1,2 @@
+export declare function loadAllTemplateFiles(templateName: string): void;
+export declare function renderFile(templateFile: string, data?: object): string | void | Promise<string>;

package/dist/gen/util.d.ts

@@ -0,0 +1,14 @@
+/// <reference types="node" />
+import { Stats } from 'fs';
+import { ApiOperation, ApiOperationResponse } from '../types';
+export declare function exists(filePath: string): Stats;
+export declare function saveFile(filePath: string, contents: string): Promise<unknown>;
+export declare function groupOperationsByGroupName(operations: any): any;
+export declare function join(parent: string[], child: string[]): string[];
+export declare function getBestResponse(op: ApiOperation): ApiOperationResponse;
+export declare function escapeReservedWords(name: string): string;
+/** This method tries to fix potentially wrong out parameter given from commandline */
+export declare function prepareOutputFilename(out: string): string;
+export declare function uniq<T>(arr?: T[]): T[];
+export declare function orderBy<T>(arr: T[] | null | undefined, key: string): T[];
+export declare function upperFirst(str?: string | null): string;

package/dist/swagger/index.d.ts

@@ -0,0 +1,3 @@
+import { resolveSpec } from './swagger';
+import { getOperations } from './operations';
+export { resolveSpec, getOperations };

package/dist/swagger/operations.d.ts

@@ -0,0 +1,20 @@
+import { ApiOperation, ApiSpec } from '../types';
+/**
+ * This method converts dictionary-alike operation definition to operation array.
+ * Additionally some data inheritance from the specification is done as well
+ * @example
+ * {
+ *  "paths": {
+ *    "/api/heartbeat": {
+ *      "get": { ... },
+ *      "post": { ... }
+ *    }
+ *  }
+ * }
+ * @returns
+ *  [
+ *    { "method": "GET", "path": "/api/heartbeat", ... },
+ *    { "method": "POST", "path": "/api/heartbeat", ... },
+ *  ]
+ */
+export declare function getOperations(spec: ApiSpec): ApiOperation[];

package/dist/swagger/swagger.d.ts

@@ -0,0 +1,17 @@
+import { ApiSpec } from '../types';
+export interface SpecOptions {
+    /**
+     * A base ref string to ignore when expanding ref dependencies e.g. '#/definitions/'
+     */
+    ignoreRefType?: string;
+}
+export declare function resolveSpec(src: string | object, options?: SpecOptions): Promise<ApiSpec>;
+/**
+ * Recursively expand internal references in the form `#/path/to/object`.
+ *
+ * @param {object} data the object to search for and update refs
+ * @param {object} lookup the object to clone refs from
+ * @param {regexp=} refMatch an optional regex to match specific refs to resolve
+ * @returns {object} the resolved data object
+ */
+export declare function expandRefs(data: any, lookup: object, options: SpecOptions): any;

package/dist/types.d.ts

@@ -1,117 +1,117 @@
-export interface ClientOptions {
-    /**
-     * Path or URL to the Swagger specification file (JSON or YAML).
-     * Alternatively you can provide parsed object here instead
-     **/
-    src: string | object;
-    /** Path to the file which will contain generated TypeScript code */
-    out?: string;
-    /** Template to be used for generation */
-    template: Template;
-    baseUrl?: string;
-    preferAny?: boolean;
-    servicePrefix?: string;
-    /** Generate models for query string instead list of parameters */
-    queryModels?: boolean;
-    /** How date should be handled. It does not do any special serialization */
-    dateFormat?: DateSupport;
-}
-export interface FullAppOptions extends ClientOptions {
-    /** Path to the configuration file that contains actual config tp be used */
-    config?: string;
-}
-export interface ApiRequestData {
-    method: HttpMethod;
-    url: string;
-    headers: {
-        [index: string]: string;
-    };
-    body: any;
-}
-export interface ApiInfo {
-    version: string;
-    title: string;
-}
-export interface ApiSpec {
-    swagger: string;
-    info: ApiInfo;
-    host?: string;
-    basePath?: string;
-    schemes?: string[];
-    securityDefinitions?: any;
-    paths: any;
-    definitions: any;
-    accepts: string[];
-    contentTypes: string[];
-}
-export declare type Template = 'axios' | 'fetch' | 'ng1' | 'ng2' | 'swr-axios';
-export declare type HttpMethod = 'get' | 'put' | 'post' | 'delete' | 'options' | 'head' | 'patch';
-export declare type DateSupport = 'string' | 'Date';
-export interface ApiOperation {
-    id: string;
-    summary: string;
-    description: string;
-    method: HttpMethod;
-    group: string;
-    path: string;
-    parameters: ApiOperationParam[];
-    responses: ApiOperationResponse[];
-    security?: ApiOperationSecurity[];
-    accepts: string[];
-    contentTypes: string[];
-    tags?: string[];
-}
-export interface ApiOperationParam extends ApiOperationParamBase {
-    name: string;
-    in: 'header' | 'path' | 'query' | 'body' | 'formData';
-    description: string;
-    required: boolean;
-    readonly?: boolean;
-    allowEmptyValue: boolean;
-    schema: object;
-    'x-nullable'?: boolean;
-    'x-schema'?: object;
-}
-declare type CollectionFormat = 'csv' | 'ssv' | 'tsv' | 'pipes' | 'multi';
-export interface ApiOperationParamBase {
-    type: 'string' | 'number' | 'integer' | 'boolean' | 'array' | 'file';
-    format: 'int32' | 'int64' | 'float' | 'double' | 'byte' | 'binary' | 'date' | 'date-time' | 'password';
-    items: ApiOperationParamBase;
-    collectionFormat: CollectionFormat;
-    default: any;
-    maximum: number;
-    exclusiveMaximum: boolean;
-    minimum: number;
-    exclusiveMinimum: boolean;
-    maxLength: number;
-    minLength: number;
-    pattern: string;
-    maxItems: number;
-    minItems: number;
-    uniqueItems: boolean;
-    enum: any[];
-    multipleOf: number;
-}
-export interface ApiOperationParamGroups {
-    header?: any;
-    path?: any;
-    query?: any;
-    formData?: any;
-    body?: any;
-}
-export interface ApiOperationResponse {
-    code: string;
-    description: string;
-    schema: object;
-    headers: object;
-    examples: object;
-}
-export interface ApiOperationSecurity {
-    id: string;
-    scopes?: string[];
-}
-export interface ApiRights {
-    query?: any;
-    headers?: any;
-}
-export {};
+export interface ClientOptions {
+    /**
+     * Path or URL to the Swagger specification file (JSON or YAML).
+     * Alternatively you can provide parsed object here instead
+     **/
+    src: string | object;
+    /** Path to the file which will contain generated TypeScript code */
+    out?: string;
+    /** Template to be used for generation */
+    template: Template;
+    baseUrl?: string;
+    preferAny?: boolean;
+    servicePrefix?: string;
+    /** Generate models for query string instead list of parameters */
+    queryModels?: boolean;
+    /** How date should be handled. It does not do any special serialization */
+    dateFormat?: DateSupport;
+}
+export interface FullAppOptions extends ClientOptions {
+    /** Path to the configuration file that contains actual config tp be used */
+    config?: string;
+}
+export interface ApiRequestData {
+    method: HttpMethod;
+    url: string;
+    headers: {
+        [index: string]: string;
+    };
+    body: any;
+}
+export interface ApiInfo {
+    version: string;
+    title: string;
+}
+export interface ApiSpec {
+    swagger: string;
+    info: ApiInfo;
+    host?: string;
+    basePath?: string;
+    schemes?: string[];
+    securityDefinitions?: any;
+    paths: any;
+    definitions: any;
+    accepts: string[];
+    contentTypes: string[];
+}
+export declare type Template = 'axios' | 'fetch' | 'ng1' | 'ng2' | 'swr-axios';
+export declare type HttpMethod = 'get' | 'put' | 'post' | 'delete' | 'options' | 'head' | 'patch';
+export declare type DateSupport = 'string' | 'Date';
+export interface ApiOperation {
+    id: string;
+    summary: string;
+    description: string;
+    method: HttpMethod;
+    group: string;
+    path: string;
+    parameters: ApiOperationParam[];
+    responses: ApiOperationResponse[];
+    security?: ApiOperationSecurity[];
+    accepts: string[];
+    contentTypes: string[];
+    tags?: string[];
+}
+export interface ApiOperationParam extends ApiOperationParamBase {
+    name: string;
+    in: 'header' | 'path' | 'query' | 'body' | 'formData';
+    description: string;
+    required: boolean;
+    readonly?: boolean;
+    allowEmptyValue: boolean;
+    schema: object;
+    'x-nullable'?: boolean;
+    'x-schema'?: object;
+}
+declare type CollectionFormat = 'csv' | 'ssv' | 'tsv' | 'pipes' | 'multi';
+export interface ApiOperationParamBase {
+    type: 'string' | 'number' | 'integer' | 'boolean' | 'array' | 'file';
+    format: 'int32' | 'int64' | 'float' | 'double' | 'byte' | 'binary' | 'date' | 'date-time' | 'password';
+    items: ApiOperationParamBase;
+    collectionFormat: CollectionFormat;
+    default: any;
+    maximum: number;
+    exclusiveMaximum: boolean;
+    minimum: number;
+    exclusiveMinimum: boolean;
+    maxLength: number;
+    minLength: number;
+    pattern: string;
+    maxItems: number;
+    minItems: number;
+    uniqueItems: boolean;
+    enum: any[];
+    multipleOf: number;
+}
+export interface ApiOperationParamGroups {
+    header?: any;
+    path?: any;
+    query?: any;
+    formData?: any;
+    body?: any;
+}
+export interface ApiOperationResponse {
+    code: string;
+    description: string;
+    schema: object;
+    headers: object;
+    examples: object;
+}
+export interface ApiOperationSecurity {
+    id: string;
+    scopes?: string[];
+}
+export interface ApiRights {
+    query?: any;
+    headers?: any;
+}
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "swaggie",
-  "version": "0.7.4",
+  "version": "0.7.6",
   "description": "Generate ES6 or TypeScript service integration code from an OpenAPI spec",
   "author": {
     "name": "Piotr Dabrowski",
@@ -45,20 +45,22 @@
   "dependencies": {
     "case": "^1.6.3",
     "commander": "^8.3.0",
-    "dset": "^3.1.1",
+    "dset": "^3.1.2",
     "eta": "^1.12.3",
     "js-yaml": "^4.1.0",
     "nanocolors": "^0.2.0",
     "node-fetch": "^2.6.7"
   },
   "devDependencies": {
-    "@types/chai": "4.3.0",
+    "@types/chai": "4.3.3",
     "@types/js-yaml": "4.0.5",
-    "@types/mocha": "9.1.0",
+    "@types/mocha": "10.0.0",
     "@types/node-fetch": "2.5.12",
+    "@types/sinon": "^10.0.13",
     "chai": "4.3.6",
-    "mocha": "9.2.0",
-    "sucrase": "3.20.3",
-    "typescript": "4.5.5"
+    "mocha": "10.1.0",
+    "sinon": "^14.0.1",
+    "sucrase": "3.28.0",
+    "typescript": "4.8.4"
   }
 }

package/templates/ng1/operation.ejs

@@ -8,7 +8,11 @@
   <%= it.name %>(<% it.parameters.forEach((parameter) => { %>
 <%= parameter.name %>: <%~ parameter.type %> <%= parameter.optional ? ' | null | undefined' : '' %>,
     <% }); %>
-config?: IRequestShortcutConfig
+<% if(it.formData && it.formData.length > 0) { %>
+    config: IRequestShortcutConfig = {headers: {'Content-Type': undefined}}
+<% } else { %>
+    config?: IRequestShortcutConfig
+<% } %>
   ): IPromise<<%~ it.returnType %>> {
     let url = '<%= it.url %>?';
 <% if(it.pathParams && it.pathParams.length > 0) {
@@ -16,6 +20,18 @@ config?: IRequestShortcutConfig
     url = url.replace('{<%= parameter.name %>}', encodeURIComponent("" + <%= parameter.name %>));
 <% });
 } %>
+<% if(it.formData && it.formData.length > 0) { %>
+    const formDataBody = new FormData();
+  <% it.formData.forEach((parameter) => { %>
+    if (!!<%= parameter.name %>) {
+    <% if(parameter.original && parameter.original.type === 'array') { %>
+      <%= parameter.name %>.forEach((f: any) => formDataBody.append(`<%= parameter.originalName %>`, f));
+    <% } else { %>
+      formDataBody.append("<%= parameter.originalName %>", <%= parameter.name %><%= parameter.type === 'Date' ? '.toISOString()' : (parameter.type !== 'string' && parameter.type !== 'File' && parameter.type !== 'Blob' ? '.toString()' : '') %>);
+    <% } %>
+    }
+<% });
+} %>
 <% if(it.query && it.query.length > 0) { %>
   <% it.query.forEach((parameter) => { %>
   if (<%= parameter.name %> !== undefined) {
@@ -31,7 +47,11 @@ config?: IRequestShortcutConfig
     return this.$<%= it.method.toLowerCase() %>(
       url,
 <% if(['POST', 'PUT', 'PATCH'].includes(it.method)) { %>
+  <% if(it.formData && it.formData.length > 0) { %>
+        formDataBody,
+  <% } else { %>
       <%= it.body ? it.body.name : 'null' %>,
+  <% } %>
 <% } %>
       config
     );