export operation's options as type

README.md

@@ -46,6 +46,7 @@ $ openapi --help
     --exportServices <value>  Write services to disk (default: true)
     --exportModels <value>    Write models to disk (default: true)
     --exportSchemas <value>   Write schemas to disk (default: false)
+    --exportOptions <value>   Write function's options to disk (default: false)
     --indent <value>          Indentation options [4, 2, tab] (default: "4")
     --postfixServices         Service name postfix (default: "Service")
     --postfixModels           Model name postfix

bin/index.js

@@ -20,6 +20,7 @@ const params = program
     .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('--exportOptions <value>', `Write function's options to disk`, false)
     .option('--indent <value>', 'Indentation options [4, 2, tabs]', '4')
     .option('--postfixServices <value>', 'Service name postfix', 'Service')
     .option('--postfixModels <value>', 'Model name postfix')
@@ -41,6 +42,7 @@ if (OpenAPI) {
         exportServices: JSON.parse(params.exportServices) === true,
         exportModels: JSON.parse(params.exportModels) === true,
         exportSchemas: JSON.parse(params.exportSchemas) === true,
+        exportOptions: JSON.parse(params.exportOptions) === true,
         indent: params.indent,
         postfixServices: params.postfixServices,
         postfixModels: params.postfixModels,

bin/index.spec.js

@@ -32,6 +32,8 @@ describe('bin', () => {
             'true',
             '--exportSchemas',
             'true',
+            '--exportOptions',
+            'true',
             '--indent',
             '4',
             '--postfixServices',

src/client/interfaces/Operation.d.ts

@@ -5,6 +5,7 @@ import type { OperationResponse } from './OperationResponse';
 export interface Operation extends OperationParameters {
     service: string;
     name: string;
+    optionsTypeName: string;
     summary: string | null;
     description: string | null;
     deprecated: boolean;

src/index.ts

@@ -23,6 +23,7 @@ export type Options = {
     exportServices?: boolean;
     exportModels?: boolean;
     exportSchemas?: boolean;
+    exportOptions?: boolean;
     indent?: Indent;
     postfixServices?: string;
     postfixModels?: string;
@@ -44,6 +45,7 @@ export type Options = {
  * @param exportServices Generate services
  * @param exportModels Generate models
  * @param exportSchemas Generate schemas
+ * @param exportOptions Generate function's options
  * @param indent Indentation options (4, 2 or tab)
  * @param postfixServices Service name postfix
  * @param postfixModels Model name postfix
@@ -61,6 +63,7 @@ export const generate = async ({
     exportServices = true,
     exportModels = true,
     exportSchemas = false,
+    exportOptions = false,
     indent = Indent.SPACE_4,
     postfixServices = 'Service',
     postfixModels = '',
@@ -91,6 +94,7 @@ export const generate = async ({
                 exportServices,
                 exportModels,
                 exportSchemas,
+                exportOptions,
                 indent,
                 postfixServices,
                 postfixModels,
@@ -115,6 +119,7 @@ export const generate = async ({
                 exportServices,
                 exportModels,
                 exportSchemas,
+                exportOptions,
                 indent,
                 postfixServices,
                 postfixModels,

src/openApi/v2/parser/getOperation.ts

@@ -1,3 +1,5 @@
+import camelCase from 'camelcase';
+
 import type { Operation } from '../../../client/interfaces/Operation';
 import type { OperationParameters } from '../../../client/interfaces/OperationParameters';
 import type { OpenApi } from '../interfaces/OpenApi';
@@ -26,6 +28,7 @@ export const getOperation = (
     const operation: Operation = {
         service: serviceName,
         name: operationName,
+        optionsTypeName: camelCase([operationName, 'Options'], { pascalCase: true }),
         summary: op.summary || null,
         description: op.description || null,
         deprecated: op.deprecated === true,

src/openApi/v3/parser/getOperation.ts

@@ -1,3 +1,5 @@
+import camelCase from 'camelcase';
+
 import type { Operation } from '../../../client/interfaces/Operation';
 import type { OperationParameters } from '../../../client/interfaces/OperationParameters';
 import type { OpenApi } from '../interfaces/OpenApi';
@@ -29,6 +31,7 @@ export const getOperation = (
     const operation: Operation = {
         service: serviceName,
         name: operationName,
+        optionsTypeName: camelCase([operationName, 'Options'], { pascalCase: true }),
         summary: op.summary || null,
         description: op.description || null,
         deprecated: op.deprecated === true,

src/templates/exportService.hbs

@@ -31,6 +31,30 @@ import { OpenAPI } from '../core/OpenAPI';
 import { request as __request } from '../core/request';
 {{/if}}
 
+{{#if @root.useOptions }}
+{{#if @root.exportOptions }}
+{{#each operations}}
+{{#if parameters}}
+export type {{{optionsTypeName}}} = {
+{{#each parameters}}
+{{#ifdef description deprecated}}
+  /**
+{{#if description}}
+   * {{{escapeComment description}}}
+{{/if}}
+{{#if deprecated}}
+   * @deprecated
+{{/if}}
+   */
+{{/ifdef}}
+   {{{name}}}{{>isRequired}}: {{>type}},
+{{/each}}
+};
+{{/if}}
+{{/each}}
+{{/if}}
+{{/if}}
+
 {{#equals @root.httpClient 'angular'}}
 @Injectable({
   providedIn: 'root',

src/templates/index.hbs

@@ -41,7 +41,7 @@ export { ${{{name}}} } from './schemas/${{{name}}}';
 {{#if services}}
 
 {{#each services}}
-export { {{{name}}}{{{@root.postfixServices}}} } from './services/{{{name}}}{{{@root.postfixServices}}}';
+export { {{{name}}}{{{@root.postfixServices}}}{{#if @root.useOptions}}{{#if @root.exportOptions}}{{#each operations}}{{#if parameters}}, {{{ optionsTypeName }}}{{/if}}{{/each}}{{/if}}{{/if}} } from './services/{{{name}}}{{{@root.postfixServices}}}';
 {{/each}}
 {{/if}}
 {{/if}}

src/templates/partials/parameters.hbs

@@ -4,7 +4,7 @@
 {{#each parameters}}
 {{{name}}}{{#if default}} = {{{default}}}{{/if}},
 {{/each}}
-}: {
+}: {{#if @root.exportOptions~}}{{{ optionsTypeName }}}{{~else}}{
 {{#each parameters}}
 {{#ifdef description deprecated}}
 /**
@@ -19,6 +19,7 @@
 {{{name}}}{{>isRequired}}: {{>type}},
 {{/each}}
 }
+{{/if}}
 {{~else}}
 
 {{#each parameters}}

src/utils/writeClient.spec.ts

@@ -47,6 +47,7 @@ describe('writeClient', () => {
             true,
             true,
             true,
+            false,
             Indent.SPACE_4,
             'Service',
             'AppClient'

src/utils/writeClient.ts

@@ -26,7 +26,7 @@ import { writeClientServices } from './writeClientServices';
  * @param exportServices Generate services
  * @param exportModels Generate models
  * @param exportSchemas Generate schemas
- * @param exportSchemas Generate schemas
+ * @param exportOptions Generate function's options
  * @param indent Indentation options (4, 2 or tab)
  * @param postfixServices Service name postfix
  * @param postfixModels Model name postfix
@@ -44,6 +44,7 @@ export const writeClient = async (
     exportServices: boolean,
     exportModels: boolean,
     exportSchemas: boolean,
+    exportOptions: boolean,
     indent: Indent,
     postfixServices: string,
     postfixModels: string,
@@ -76,6 +77,7 @@ export const writeClient = async (
             httpClient,
             useUnionTypes,
             useOptions,
+            exportOptions,
             indent,
             postfixServices,
             clientName
@@ -106,10 +108,12 @@ export const writeClient = async (
             templates,
             outputPath,
             useUnionTypes,
+            useOptions,
             exportCore,
             exportServices,
             exportModels,
             exportSchemas,
+            exportOptions,
             postfixServices,
             postfixModels,
             clientName

src/utils/writeClientIndex.spec.ts

@@ -36,7 +36,7 @@ describe('writeClientIndex', () => {
             },
         };
 
-        await writeClientIndex(client, templates, '/', true, true, true, true, true, 'Service', '');
+        await writeClientIndex(client, templates, '/', true, true, true, true, true, true, true, 'Service', '');
 
         expect(writeFile).toBeCalledWith(resolve('/', '/index.ts'), 'index');
     });

src/utils/writeClientIndex.ts

@@ -15,10 +15,12 @@ import { sortServicesByName } from './sortServicesByName';
  * @param templates The loaded handlebar templates
  * @param outputPath Directory to write the generated files to
  * @param useUnionTypes Use union types instead of enums
+ * @param useOptions Use options or arguments functions
  * @param exportCore Generate core
  * @param exportServices Generate services
  * @param exportModels Generate models
  * @param exportSchemas Generate schemas
+ * @param exportOptions Generate function's options
  * @param postfixServices Service name postfix
  * @param postfixModels Model name postfix
  * @param clientName Custom client class name
@@ -28,10 +30,12 @@ export const writeClientIndex = async (
     templates: Templates,
     outputPath: string,
     useUnionTypes: boolean,
+    useOptions: boolean,
     exportCore: boolean,
     exportServices: boolean,
     exportModels: boolean,
     exportSchemas: boolean,
+    exportOptions: boolean,
     postfixServices: string,
     postfixModels: string,
     clientName?: string
@@ -41,6 +45,8 @@ export const writeClientIndex = async (
         exportServices,
         exportModels,
         exportSchemas,
+        exportOptions,
+        useOptions,
         useUnionTypes,
         postfixServices,
         postfixModels,

src/utils/writeClientServices.spec.ts

@@ -40,7 +40,17 @@ describe('writeClientServices', () => {
             },
         };
 
-        await writeClientServices(services, templates, '/', HttpClient.FETCH, false, false, Indent.SPACE_4, 'Service');
+        await writeClientServices(
+            services,
+            templates,
+            '/',
+            HttpClient.FETCH,
+            false,
+            false,
+            false,
+            Indent.SPACE_4,
+            'Service'
+        );
 
         expect(writeFile).toBeCalledWith(resolve('/', '/UserService.ts'), `service${EOL}`);
     });

src/utils/writeClientServices.ts

@@ -17,6 +17,7 @@ import type { Templates } from './registerHandlebarTemplates';
  * @param httpClient The selected httpClient (fetch, xhr, node or axios)
  * @param useUnionTypes Use union types instead of enums
  * @param useOptions Use options or arguments functions
+ * @param exportOptions Generate function's options
  * @param indent Indentation options (4, 2 or tab)
  * @param postfix Service name postfix
  * @param clientName Custom client class name
@@ -28,6 +29,7 @@ export const writeClientServices = async (
     httpClient: HttpClient,
     useUnionTypes: boolean,
     useOptions: boolean,
+    exportOptions: boolean,
     indent: Indent,
     postfix: string,
     clientName?: string
@@ -39,6 +41,7 @@ export const writeClientServices = async (
             httpClient,
             useUnionTypes,
             useOptions,
+            exportOptions,
             postfix,
             exportClient: isDefined(clientName),
         });