codegen-openapi-ts 0.6.0 → 0.7.0

package/bin/index.js

@@ -1,49 +1,49 @@
-#!/usr/bin/env node
-
-'use strict';
-
-const path = require('path');
-const program = require('commander');
-const esmConfig = require('esm-config');
-const pkg = require('../package.json');
-const OpenAPI = require(path.resolve(__dirname, '../dist/index.js'));
-
-const appRoot = process.cwd().split('/node_modules')[0]
-
-const params = program
-    .name('codegen-openapi-ts')
-    .usage('[options]')
-    .version(pkg.version)
-    .option('--config <value>', 'Path to config file', 'codegen.config.js')
-    .parse(process.argv)
-    .opts();
-
-async function generateOnConfig () {
-  try {
-    const configFile = await esmConfig(path.join(appRoot, params.config))
-
-    for (let i = 0; i < configFile.length; i++) {
-      console.log('Generating ' + configFile[i].source)
-      await OpenAPI.convertAndGenerate(
-        {
-          from: configFile[i].from,
-          to: 'openapi_3',
-          source: configFile[i].source
-        },
-        {
-          input: 'api-schema.json',
-          output: configFile[i].output || 'output',
-          useOptions: true,
-          useUnionTypes: true
-        },
-        configFile[i].urlMethodMapping || [],
-        configFile[i].selectedOnly || false,
-        configFile[i].modelNameMapping || []
-      )
-    }
-  } catch (err) {
-    console.log(err)
-  }
-}
-
-generateOnConfig()
+#!/usr/bin/env node
+
+'use strict';
+
+const path = require('path');
+const program = require('commander');
+const esmConfig = require('esm-config');
+const pkg = require('../package.json');
+const OpenAPI = require(path.resolve(__dirname, '../dist/index.js'));
+
+const appRoot = process.cwd().split('/node_modules')[0]
+
+const params = program
+    .name('codegen-openapi-ts')
+    .usage('[options]')
+    .version(pkg.version)
+    .option('--config <value>', 'Path to config file', 'codegen.config.js')
+    .parse(process.argv)
+    .opts();
+
+async function generateOnConfig () {
+  try {
+    const configFile = await esmConfig(path.join(appRoot, params.config))
+
+    for (let i = 0; i < configFile.length; i++) {
+      console.log('Generating ' + configFile[i].source)
+      await OpenAPI.convertAndGenerate(
+        {
+          from: configFile[i].from,
+          to: 'openapi_3',
+          source: configFile[i].source
+        },
+        {
+          input: 'api-schema.json',
+          output: configFile[i].output || 'output',
+          useOptions: true,
+          useUnionTypes: true
+        },
+        configFile[i].urlMethodMapping || [],
+        configFile[i].selectedOnly || false,
+        configFile[i].modelNameMapping || []
+      )
+    }
+  } catch (err) {
+    console.log(err)
+  }
+}
+
+generateOnConfig()

package/dist/index.d.ts

@@ -0,0 +1,72 @@
+import { ConverterInput } from 'api-spec-converter';
+import { HttpClient } from './HttpClient';
+export { HttpClient } from './HttpClient';
+export declare type Options = {
+    input: string | Record<string, any>;
+    output: string;
+    httpClient?: HttpClient;
+    useOptions?: boolean;
+    useUnionTypes?: boolean;
+    exportCore?: boolean;
+    exportServices?: boolean;
+    exportModels?: boolean;
+    exportSchemas?: boolean;
+    postfix?: string;
+    request?: string;
+    write?: boolean;
+    selectedOnly?: boolean;
+};
+/**
+ * Generate the OpenAPI client. This method will read the OpenAPI specification and based on the
+ * given language it will generate the client, including the typed models, validation schemas,
+ * service layer, etc.
+ * @param input The relative location of the OpenAPI spec
+ * @param output The relative location of the output directory
+ * @param httpClient The selected httpClient (fetch, xhr, node or axios)
+ * @param useUnionTypes Use union types instead of enums
+ * @param exportCore: Generate core client classes
+ * @param exportServices: Generate services
+ * @param exportModels: Generate models
+ * @param exportSchemas: Generate schemas
+ * @param postfix: Service name postfix
+ * @param request: Path to custom request file
+ * @param write Write the files to disk (true or false)
+ */
+export declare function generate({ input, output, httpClient, useOptions, useUnionTypes, exportCore, exportServices, exportModels, exportSchemas, postfix, request, write, selectedOnly }: Options): Promise<void>;
+/**
+ * Generate the OpenAPI client with options to convert swagger to openapi etc.
+ * @param converterInput.from The schema specification for the response (swagger_1, swagger_2, openapi_3)
+ * @param converterInput.to The schema specification for the output (openapi_3)
+ * @param converterInput.source The relative location of the OpenAPI spec
+ * @param options.httpClient The selected httpClient (fetch, xhr, node or axios)
+ * @param options.useUnionTypes Use union types instead of enums
+ * @param options.exportCore: Generate core client classes
+ * @param options.exportServices: Generate services
+ * @param options.exportModels: Generate models
+ * @param options.exportSchemas: Generate schemas
+ * @param options.postfix: Service name postfix
+ * @param options.request: Path to custom request file
+ * @param options.write Write the files to disk (true or false)
+ */
+export declare function convertAndGenerate({ from, to, source }: ConverterInput, { input, output, useOptions, useUnionTypes }: Options, urlMethodMapping?: BaseConfigWithMappings['urlMethodMapping'], selectedOnly?: BaseConfigWithMappings['selectedOnly'], modelNameMapping?: BaseConfig['modelNameMapping']): Promise<void>;
+export declare type BaseConfig = {
+    source: string;
+    from: 'swagger_1' | 'swagger_2' | 'openapi_3' | 'api_blueprint' | 'io_docs' | 'google' | 'raml' | 'wadl';
+    output: string;
+    modelNameMapping?: [string, string][];
+};
+export declare type BaseConfigDefault = BaseConfig & {
+    urlMethodMapping: undefined;
+    selectedOnly: undefined;
+};
+export declare type BaseConfigWithMappings = BaseConfig & {
+    urlMethodMapping: [
+        string,
+        string,
+        'get' | 'post' | 'put' | 'delete',
+        string,
+        string?
+    ][];
+    selectedOnly: boolean;
+};
+export declare function defineConfig(config: (BaseConfigDefault | BaseConfigWithMappings)[]): (BaseConfigWithMappings | BaseConfigDefault)[];