- Updated PR with master branch

Author: ferdikoomen

.editorconfig

@@ -7,3 +7,6 @@ trim_trailing_whitespace = true
 insert_final_newline = true
 indent_style = space
 indent_size = 4
+
+[*.hbs]
+indent_style = tab

.eslintignore

@@ -1,4 +1,5 @@
 dist
+samples
 test/generated
 test/e2e/generated
 node_modules

CHANGELOG.md

@@ -0,0 +1,21 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+## [0.16.0] - 2021-01-25
+### Added
+- Added option to set the indentation (spaces and tabs)
+- Added option to export separate client file that allows usage for multiple backends
+### Fixed
+- Decoupled OpenAPI object from requests
+- Updated dependencies
+
+## [0.15.0] - 2021-01-24
+### Added
+- Added change log and releases on GitHub
+
+## [0.14.0] - 2021-01-24
+### Fixed
+- Added missing `postfix` options to typedef
+- Updated escaping of comments and descriptions
+- Better handling of services without tags
+- Updated dependencies

README.md

@@ -41,13 +41,15 @@ $ openapi --help
     -i, --input <value>       OpenAPI specification, can be a path, url or string content (required)
     -o, --output <value>      Output directory (required)
     -c, --client <value>      HTTP client to generate [fetch, xhr, axios, node] (default: "fetch")
+    --name <value>            Custom client class name
     --useOptions              Use options instead of arguments
     --useUnionTypes           Use union types instead of enums
     --exportCore <value>      Write core files to disk (default: true)
     --exportServices <value>  Write services to disk (default: true)
     --exportModels <value>    Write models to disk (default: true)
     --exportSchemas <value>   Write schemas to disk (default: false)
-    --postfix <value>         Service name postfix (default: "Service")
+    --indent <value>         Service name postfix (default: "Service")
+    --postfix <value>         Indentation options [4, 2, tab] (default: "5")
     --request <value>         Path to custom request file
     -h, --help                display help for command
 
@@ -95,6 +97,33 @@ OpenAPI.generate({
 
 ## Features
 
+
+### Generate client instance with `--name` option
+The OpenAPI generator allows creation of client instances to support the multiple backend services use case.
+The generated client uses an instance of the server configuration and not the global `OpenAPI` constant.
+To generate a client instance, set a custom name to the client class, use `--name` option.
+
+```
+openapi --input ./spec.json --output ./dist ---name AppClient
+```
+
+The generated client will be exported from the `index` file and can be used as shown below:
+
+```typescript
+// Create the client instance with server and authentication details
+const appClient = new AppClient({
+    BASE: 'http://server-host.com',
+    TOKEN: '1234'
+});
+
+// Use the client instance to make the API call
+const res = await appClient.organizations.createOrganization({
+  name: 'OrgName',
+  description: 'OrgDescription',
+});
+```
+
+
 ### Argument style vs. Object style `--useOptions`
 There's no [named parameter](https://en.wikipedia.org/wiki/Named_parameter) in JavaScript or TypeScript, because of
 that, we offer the flag `--useOptions` to generate code in two different styles.

bin/index.js

@@ -13,12 +13,14 @@ const params = program
     .requiredOption('-i, --input <value>', 'OpenAPI specification, can be a path, url or string content (required)')
     .requiredOption('-o, --output <value>', 'Output directory (required)')
     .option('-c, --client <value>', 'HTTP client to generate [fetch, xhr, node, axios, angular]', 'fetch')
+    .option('--name <value>', 'Custom client class name')
     .option('--useOptions', 'Use options instead of arguments')
     .option('--useUnionTypes', 'Use union types instead of enums')
     .option('--exportCore <value>', 'Write core files to disk', true)
     .option('--exportServices <value>', 'Write services to disk', true)
     .option('--exportModels <value>', 'Write models to disk', true)
     .option('--exportSchemas <value>', 'Write schemas to disk', false)
+    .option('--indent <value>', 'Indentation options [4, 2, tabs]', '4')
     .option('--postfix <value>', 'Service name postfix', 'Service')
     .option('--request <value>', 'Path to custom request file')
     .parse(process.argv)
@@ -31,12 +33,14 @@ if (OpenAPI) {
         input: params.input,
         output: params.output,
         httpClient: params.client,
+        clientName: params.name,
         useOptions: params.useOptions,
         useUnionTypes: params.useUnionTypes,
         exportCore: JSON.parse(params.exportCore) === true,
         exportServices: JSON.parse(params.exportServices) === true,
         exportModels: JSON.parse(params.exportModels) === true,
         exportSchemas: JSON.parse(params.exportSchemas) === true,
+        indent: params.indent,
         postfix: params.postfix,
         request: params.request,
     })

jest.config.ts

@@ -25,6 +25,11 @@ const config: Config.InitialOptions = {
                 '<rootDir>/test/e2e/v3.node.spec.ts',
                 '<rootDir>/test/e2e/v3.axios.spec.ts',
                 '<rootDir>/test/e2e/v3.babel.spec.ts',
+                '<rootDir>/test/e2e/client.fetch.spec.ts',
+                '<rootDir>/test/e2e/client.xhr.spec.ts',
+                '<rootDir>/test/e2e/client.node.spec.ts',
+                '<rootDir>/test/e2e/client.axios.spec.ts',
+                '<rootDir>/test/e2e/client.babel.spec.ts',
             ],
         },
     ],

package.json

@@ -1,6 +1,6 @@
 {
     "name": "openapi-typescript-codegen",
-    "version": "0.13.0",
+    "version": "0.16.0",
     "description": "Library that generates Typescript clients based on the OpenAPI specification.",
     "author": "Ferdi Koomen",
     "homepage": "https://github.com/ferdikoomen/openapi-typescript-codegen",
@@ -77,7 +77,7 @@
         "@types/express": "4.17.13",
         "@types/glob": "7.2.0",
         "@types/jest": "27.4.0",
-        "@types/node": "17.0.10",
+        "@types/node": "17.0.12",
         "@types/node-fetch": "^2.5.12",
         "@types/qs": "6.9.7",
         "@typescript-eslint/eslint-plugin": "5.10.1",
@@ -96,10 +96,10 @@
         "jest-cli": "27.4.7",
         "node-fetch": "^2.6.6",
         "prettier": "2.5.1",
-        "puppeteer": "13.1.1",
+        "puppeteer": "13.1.2",
         "qs": "6.10.3",
         "rimraf": "^3.0.2",
-        "rollup": "2.66.0",
+        "rollup": "2.66.1",
         "rollup-plugin-node-externals": "3.1.2",
         "rollup-plugin-terser": "7.0.2",
         "rxjs": "7.5.2",

rollup.config.js

@@ -36,6 +36,7 @@ const handlebarsPlugin = () => ({
                     enumerator: true,
                     escapeComment: true,
                     escapeDescription: true,
+                    camelCase: true,
                 },
             });
             return `export default ${templateSpec};`;

src/Indent.ts

@@ -0,0 +1,5 @@
+export enum Indent {
+    SPACE_4 = '4',
+    SPACE_2 = '2',
+    TAB = 'tab',
+}

src/index.ts

@@ -1,4 +1,5 @@
 import { HttpClient } from './HttpClient';
+import { Indent } from './Indent';
 import { parse as parseV2 } from './openApi/v2';
 import { parse as parseV3 } from './openApi/v3';
 import { getOpenApiSpec } from './utils/getOpenApiSpec';
@@ -9,17 +10,20 @@ import { registerHandlebarTemplates } from './utils/registerHandlebarTemplates';
 import { writeClient } from './utils/writeClient';
 
 export { HttpClient } from './HttpClient';
+export { Indent } from './Indent';
 
 export type Options = {
     input: string | Record<string, any>;
     output: string;
     httpClient?: HttpClient;
+    clientName?: string;
     useOptions?: boolean;
     useUnionTypes?: boolean;
     exportCore?: boolean;
     exportServices?: boolean;
     exportModels?: boolean;
     exportSchemas?: boolean;
+    indent?: Indent;
     postfix?: string;
     request?: string;
     write?: boolean;
@@ -32,30 +36,34 @@ export type Options = {
  * @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 clientName Custom client class name
  * @param useOptions Use options or arguments functions
  * @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 exportCore Generate core client classes
+ * @param exportServices Generate services
+ * @param exportModels Generate models
+ * @param exportSchemas Generate schemas
+ * @param indent Indentation options (4, 2 or tab)
+ * @param postfix Service name postfix
+ * @param request Path to custom request file
  * @param write Write the files to disk (true or false)
  */
-export async function generate({
+export const generate = async ({
     input,
     output,
     httpClient = HttpClient.FETCH,
+    clientName,
     useOptions = false,
     useUnionTypes = false,
     exportCore = true,
     exportServices = true,
     exportModels = true,
     exportSchemas = false,
+    indent = Indent.SPACE_4,
     postfix = 'Service',
     request,
     write = true,
-}: Options): Promise<void> {
+}: Options): Promise<void> => {
     const openApi = isString(input) ? await getOpenApiSpec(input) : input;
     const openApiVersion = getOpenApiVersion(openApi);
     const templates = registerHandlebarTemplates({
@@ -80,7 +88,9 @@ export async function generate({
                 exportServices,
                 exportModels,
                 exportSchemas,
+                indent,
                 postfix,
+                clientName,
                 request
             );
             break;
@@ -101,13 +111,15 @@ export async function generate({
                 exportServices,
                 exportModels,
                 exportSchemas,
+                indent,
                 postfix,
+                clientName,
                 request
             );
             break;
         }
     }
-}
+};
 
 export default {
     HttpClient,

src/openApi/v2/index.ts

@@ -10,11 +10,11 @@ import { getServiceVersion } from './parser/getServiceVersion';
  * all the models, services and schema's we should output.
  * @param openApi The OpenAPI spec  that we have loaded from disk.
  */
-export function parse(openApi: OpenApi): Client {
+export const parse = (openApi: OpenApi): Client => {
     const version = getServiceVersion(openApi.info.version);
     const server = getServer(openApi);
     const models = getModels(openApi);
     const services = getServices(openApi);
 
     return { version, server, models, services };
-}
+};

src/openApi/v2/parser/escapeName.ts

@@ -1,9 +1,9 @@
-export function escapeName(value: string): string {
+export const escapeName = (value: string): string => {
     if (value) {
         const validName = /^[a-zA-Z_$][\w$]+$/g.test(value);
         if (!validName) {
             return `'${value}'`;
         }
     }
     return value;
-}
+};

src/openApi/v2/parser/extendEnum.ts

@@ -7,7 +7,7 @@ import type { WithEnumExtension } from '../interfaces/Extensions/WithEnumExtensi
  * @param enumerators
  * @param definition
  */
-export function extendEnum(enumerators: Enum[], definition: WithEnumExtension): Enum[] {
+export const extendEnum = (enumerators: Enum[], definition: WithEnumExtension): Enum[] => {
     const names = definition['x-enum-varnames'];
     const descriptions = definition['x-enum-descriptions'];
 
@@ -17,4 +17,4 @@ export function extendEnum(enumerators: Enum[], definition: WithEnumExtension):
         value: enumerator.value,
         type: enumerator.type,
     }));
-}
+};

src/openApi/v2/parser/getEnum.ts

@@ -1,7 +1,7 @@
 import type { Enum } from '../../../client/interfaces/Enum';
 import { isDefined } from '../../../utils/isDefined';
 
-export function getEnum(values?: (string | number)[]): Enum[] {
+export const getEnum = (values?: (string | number)[]): Enum[] => {
     if (Array.isArray(values)) {
         return values
             .filter((value, index, arr) => {
@@ -30,4 +30,4 @@ export function getEnum(values?: (string | number)[]): Enum[] {
             });
     }
     return [];
-}
+};

src/openApi/v2/parser/getEnumFromDescription.ts

@@ -3,7 +3,7 @@ import type { Enum } from '../../../client/interfaces/Enum';
 /**
  * @deprecated
  */
-export function getEnumFromDescription(description: string): Enum[] {
+export const getEnumFromDescription = (description: string): Enum[] => {
     // Check if we can find this special format string:
     // None=0,Something=1,AnotherThing=2
     if (/^(\w+=[0-9]+)/g.test(description)) {
@@ -36,4 +36,4 @@ export function getEnumFromDescription(description: string): Enum[] {
     }
 
     return [];
-}
+};

src/openApi/v2/parser/getMappedType.ts

@@ -24,9 +24,9 @@ const TYPE_MAPPINGS = new Map<string, string>([
 /**
  * Get mapped type for given type to any basic Typescript/Javascript type.
  */
-export function getMappedType(type: string, format?: string): string | undefined {
+export const getMappedType = (type: string, format?: string): string | undefined => {
     if (format === 'binary') {
         return 'binary';
     }
     return TYPE_MAPPINGS.get(type);
-}
+};

src/openApi/v2/parser/getModel.ts

@@ -9,12 +9,12 @@ import { getModelComposition } from './getModelComposition';
 import { getModelProperties } from './getModelProperties';
 import { getType } from './getType';
 
-export function getModel(
+export const getModel = (
     openApi: OpenApi,
     definition: OpenApiSchema,
     isDefinition: boolean = false,
     name: string = ''
-): Model {
+): Model => {
     const model: Model = {
         name,
         export: 'interface',
@@ -162,4 +162,4 @@ export function getModel(
     }
 
     return model;
-}
+};

src/openApi/v2/parser/getModelComposition.ts

@@ -9,13 +9,13 @@ import { getRequiredPropertiesFromComposition } from './getRequiredPropertiesFro
 // Fix for circular dependency
 export type GetModelFn = typeof getModel;
 
-export function getModelComposition(
+export const getModelComposition = (
     openApi: OpenApi,
     definition: OpenApiSchema,
     definitions: OpenApiSchema[],
     type: 'one-of' | 'any-of' | 'all-of',
     getModel: GetModelFn
-): ModelComposition {
+): ModelComposition => {
     const composition: ModelComposition = {
         type,
         imports: [],
@@ -87,4 +87,4 @@ export function getModelComposition(
     }
 
     return composition;
-}
+};