swaggie 0.7.2 → 0.7.4

package/dist/cli.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 "use strict";
-var _commander = require('commander');
 var _nanocolors = require('nanocolors');
+var _commander = require('commander');
 
 var _index = require('./index');
 
@@ -23,7 +23,7 @@ program
   )
   .option(
     '-o, --out <filePath>',
-    'The path to the file where the API would be generated',
+    'The path to the file where the API would be generated. Use stdout if left empty',
     process.env.OPEN_API_OUT
   )
   .option(
@@ -47,7 +47,14 @@ const options = program.opts() ;
 
 _index.runCodeGenerator.call(void 0, options).then(complete, error);
 
-function complete(spec) {
+function complete([code, opts]) {
+  if (opts.out) {
+    const from = typeof opts.src === 'string' ? `from ${_nanocolors.bold.call(void 0, opts.src)} ` : '';
+    console.info(_nanocolors.cyan.call(void 0, `Api ${from}code generated into ${_nanocolors.bold.call(void 0, opts.out)}`));
+  } else {
+    console.log(code);
+  }
+
   process.exit(0);
 }
 

package/dist/gen/js/index.js

@@ -11,8 +11,10 @@ var _util = require('../util');
   let [fileContents, queryDefinitions] = await _genOperations2.default.call(void 0, spec, operations, options);
   fileContents += _genTypes2.default.call(void 0, spec, queryDefinitions, options);
 
-  const destFile = _util.prepareOutputFilename.call(void 0, options.out);
-  await _util.saveFile.call(void 0, destFile, fileContents);
+  if (options.out) {
+    const destFile = _util.prepareOutputFilename.call(void 0, options.out);
+    await _util.saveFile.call(void 0, destFile, fileContents);
+  }
 
-  return spec;
+  return fileContents;
 } exports.default = genCode;

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+import { ApiSpec, ClientOptions, FullAppOptions } from './types';
+/** Runs whole code generation process. @returns generated code */
+export declare function runCodeGenerator(options: FullAppOptions): Promise<string>;
+/** Validates if the spec is correct and if is supported */
+export declare function verifySpec(spec: ApiSpec): Promise<ApiSpec>;
+export declare function applyConfigFile(options: FullAppOptions): Promise<ClientOptions>;

package/dist/index.js

@@ -1,39 +1,33 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }var _fs = require('fs'); var _fs2 = _interopRequireDefault(_fs);
-var _nanocolors = require('nanocolors');
 
 var _js = require('./gen/js'); var _js2 = _interopRequireDefault(_js);
-
 var _templateManager = require('./gen/templateManager');
 var _swagger = require('./swagger');
 
 
+/** Runs whole code generation process. @returns generated code */
  function runCodeGenerator(options) {
   return verifyOptions(options)
     .then(applyConfigFile)
-    .then((options) =>
-      _swagger.resolveSpec.call(void 0, options.src, { ignoreRefType: '#/definitions/' })
+    .then((opts) =>
+      _swagger.resolveSpec.call(void 0, opts.src, { ignoreRefType: '#/definitions/' })
         .then((spec) => verifySpec(spec))
-        .then((spec) => gen(spec, options))
-        .then(() => {
-          console.info(
-            _nanocolors.cyan.call(void 0, `Api from ${_nanocolors.bold.call(void 0, options.src)} code generated into ${_nanocolors.bold.call(void 0, options.out)}`)
-          );
-          return true;
-        })
+        .then((spec) => gen(spec, opts))
+        .then((code) => [code, opts] )
     );
 } exports.runCodeGenerator = runCodeGenerator;
 
 function verifyOptions(options) {
-  try {
-    if (!options.config && (!options.src || !options.out)) {
-      return Promise.reject('You need to provide --config or --src and --out parameters');
-    }
-    return Promise.resolve(options);
-  } catch (e) {
-    return Promise.reject(e);
+  if (!options) {
+    return Promise.reject('Options were not provided');
+  }
+  if (!!options.config === !!options.src) {
+    return Promise.reject('You need to provide either --config or --src parameters');
   }
+  return Promise.resolve(options);
 }
 
+/** Validates if the spec is correct and if is supported */
  function verifySpec(spec) {
   if (!spec || !spec.swagger)
     return Promise.reject('Spec does not look like Swagger / OpenAPI 2! Open API 3 support is WIP');
@@ -73,3 +67,5 @@ function readFile(filePath) {
     return _fs2.default.readFile(filePath, 'utf8', (err, contents) => (err ? rej(err) : res(contents)));
   });
 }
+
+

package/dist/types.d.ts

@@ -0,0 +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 {};

package/dist/types.js

@@ -115,6 +115,15 @@
 
 
 
+
+
+
+
+
+
+
+
+
 
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "swaggie",
-  "version": "0.7.2",
+  "version": "0.7.4",
   "description": "Generate ES6 or TypeScript service integration code from an OpenAPI spec",
   "author": {
     "name": "Piotr Dabrowski",
@@ -19,12 +19,14 @@
     "node": ">=12.0.0"
   },
   "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "bin": {
     "swaggie": "dist/cli.js"
   },
   "scripts": {
-    "build": "sucrase ./src -d ./dist --transforms typescript,imports && npm run rm-tests",
+    "build": "sucrase ./src -d ./dist --transforms typescript,imports && npm run rm-tests && npm run types",
     "rm-tests": "find dist/ -name '*.spec.js' -type f -delete",
+    "types": "tsc src/types.ts --outDir dist/ --declaration --emitDeclarationOnly && cp test/index.d.ts ./dist/",
     "test": "mocha 'src/**/*.spec.ts'"
   },
   "files": [
@@ -47,16 +49,16 @@
     "eta": "^1.12.3",
     "js-yaml": "^4.1.0",
     "nanocolors": "^0.2.0",
-    "node-fetch": "^2.6.3"
+    "node-fetch": "^2.6.7"
   },
   "devDependencies": {
     "@types/chai": "4.3.0",
     "@types/js-yaml": "4.0.5",
-    "@types/mocha": "9.0.0",
-    "@types/node-fetch": "2.5.3",
-    "chai": "4.3.4",
-    "mocha": "9.1.3",
+    "@types/mocha": "9.1.0",
+    "@types/node-fetch": "2.5.12",
+    "chai": "4.3.6",
+    "mocha": "9.2.0",
     "sucrase": "3.20.3",
-    "typescript": "4.5.4"
+    "typescript": "4.5.5"
   }
 }

package/templates/axios/baseClient.ejs

@@ -7,6 +7,7 @@
 // </auto-generated>
 //----------------------
 // ReSharper disable InconsistentNaming
+// deno-lint-ignore-file
 
 import Axios, { AxiosPromise, AxiosRequestConfig } from "axios";
 

package/templates/fetch/baseClient.ejs

@@ -7,6 +7,7 @@
 // </auto-generated>
 //----------------------
 // ReSharper disable InconsistentNaming
+// deno-lint-ignore-file
 
 export const defaults = {
   baseUrl: '<%= it.baseUrl || '' %>',

package/templates/ng1/baseClient.ejs

@@ -7,6 +7,7 @@
 // </auto-generated>
 //----------------------
 // ReSharper disable InconsistentNaming
+// deno-lint-ignore-file
 
 import { IHttpService, IRequestShortcutConfig, IPromise } from 'angular';
 

package/templates/ng2/baseClient.ejs

@@ -7,6 +7,7 @@
 // </auto-generated>
 //----------------------
 // ReSharper disable InconsistentNaming
+// deno-lint-ignore-file
 
 import { Observable, throwError as _observableThrow, of as _observableOf } from "rxjs";
 import { Injectable, Inject, Optional, InjectionToken } from "@angular/core";

package/templates/swr-axios/baseClient.ejs

@@ -7,6 +7,7 @@
 // </auto-generated>
 //----------------------
 // ReSharper disable InconsistentNaming
+// deno-lint-ignore-file
 
 import Axios, { AxiosPromise, AxiosRequestConfig } from "axios";
 import useSWR, { SWRConfiguration, Key } from 'swr';