feat: move operationId config option to services object

hey-api · Apr 19, 2024 · 279da8e · 279da8e
1 parent 9eadc04
commit 279da8e
Show file tree

Hide file tree

Showing 18 changed files with 37 additions and 36 deletions.
diff --git a/.changeset/proud-worms-exercise.md b/.changeset/proud-worms-exercise.md
@@ -0,0 +1,5 @@
+---
+"@hey-api/openapi-ts": minor
+---
+
+feat: move operationId config option to services object
diff --git a/docs/openapi-ts/migrating.md b/docs/openapi-ts/migrating.md
@@ -48,6 +48,22 @@ This config option is deprecated and will be removed.
 
 This config option is deprecated and will be removed.
 
+## v0.42.0
+
+### Moved `operationId`
+
+This config option has been moved. You can now configure it using the `services.operationId` option.
+
+```js{5}
+export default {
+  input: 'path/to/openapi.json',
+  output: 'src/client',
+  services: {
+    operationId: true,
+  },
+}
+```
+
 ## v0.41.0
 
 ### Removed `postfixServices`

diff --git a/packages/openapi-ts/bin/index.cjs b/packages/openapi-ts/bin/index.cjs
@@ -32,7 +32,6 @@ const params = program
   .option('--format [value]', 'Process output folder with formatter?')
   .option('--lint [value]', 'Process output folder with linter?')
   .option('--name <value>', 'Custom client class name')
-  .option('--operationId [value]', 'Use operationd ID?')
   .option('--request <value>', 'Path to custom request file')
   .option('--schemas [value]', 'Write schemas to disk')
   .option('--services [value]', 'Write services to disk')
@@ -74,7 +73,6 @@ async function start() {
       'exportCore',
       'format',
       'lint',
-      'operationId',
       'schemas',
       'services',
       'types',

diff --git a/packages/openapi-ts/src/index.ts b/packages/openapi-ts/src/index.ts
@@ -108,6 +108,7 @@ const getServices = (userConfig: UserConfig): Config['services'] => {
   let services: Config['services'] = {
     export: true,
     name: '{{name}}Service',
+    operationId: true,
     response: 'body',
   };
   if (typeof userConfig.services === 'boolean') {
@@ -168,7 +169,6 @@ const initConfig = async (
     input,
     lint = false,
     name,
-    operationId = true,
     request,
     useOptions = true,
   } = userConfig;
@@ -212,7 +212,6 @@ const initConfig = async (
     input,
     lint,
     name,
-    operationId,
     output,
     request,
     schemas,

diff --git a/packages/openapi-ts/src/openApi/common/parser/__tests__/operation.spec.ts b/packages/openapi-ts/src/openApi/common/parser/__tests__/operation.spec.ts
@@ -17,13 +17,13 @@ describe('getOperationName', () => {
     format: false,
     input: '',
     lint: false,
-    operationId: true,
     output: '',
     schemas: {
       export: false,
     },
     services: {
       export: false,
+      operationId: true,
       response: 'body',
     },
     types: {
@@ -41,13 +41,13 @@ describe('getOperationName', () => {
     format: false,
     input: '',
     lint: false,
-    operationId: false,
     output: '',
     schemas: {
       export: false,
     },
     services: {
       export: false,
+      operationId: false,
       response: 'body',
     },
     types: {

diff --git a/packages/openapi-ts/src/openApi/common/parser/operation.ts b/packages/openapi-ts/src/openApi/common/parser/operation.ts
@@ -20,7 +20,7 @@ export const getOperationName = (
 ): string => {
   const config = getConfig();
 
-  if (config.operationId && operationId) {
+  if (config.services.operationId && operationId) {
     return camelCase(sanitizeNamespaceIdentifier(operationId).trim());
   }
 

diff --git a/packages/openapi-ts/src/openApi/v2/parser/__tests__/getServices.spec.ts b/packages/openapi-ts/src/openApi/v2/parser/__tests__/getServices.spec.ts
@@ -14,10 +14,11 @@ describe('getServices', () => {
       format: false,
       input: '',
       lint: false,
-      operationId: false,
       output: '',
       schemas: {},
-      services: {},
+      services: {
+        operationId: false,
+      },
       types: {},
       useOptions: true,
     });

diff --git a/packages/openapi-ts/src/openApi/v3/parser/__tests__/getServices.spec.ts b/packages/openapi-ts/src/openApi/v3/parser/__tests__/getServices.spec.ts
@@ -14,10 +14,11 @@ describe('getServices', () => {
       format: false,
       input: '',
       lint: false,
-      operationId: true,
       output: '',
       schemas: {},
-      services: {},
+      services: {
+        operationId: true,
+      },
       types: {},
       useOptions: true,
     });

diff --git a/packages/openapi-ts/src/types/config.ts b/packages/openapi-ts/src/types/config.ts
@@ -19,7 +19,7 @@ export interface UserConfig {
    */
   dryRun?: boolean;
   /**
-   * Export enum definitions?
+   * Generate enum definitions?
    * @default false
    */
   enums?: 'javascript' | 'typescript' | false;
@@ -46,11 +46,6 @@ export interface UserConfig {
    * Custom client class name
    */
   name?: string;
-  /**
-   * Use operation ID to generate operation names?
-   * @default true
-   */
-  operationId?: boolean;
   /**
    * The relative location of the output directory
    */
@@ -101,6 +96,11 @@ export interface UserConfig {
          * @default '{{name}}Service'
          */
         name?: string;
+        /**
+         * Use operation ID to generate operation names?
+         * @default true
+         */
+        operationId?: boolean;
         /**
          * Define shape of returned value from service calls
          * @default 'body'

diff --git a/packages/openapi-ts/src/utils/__tests__/handlebars.spec.ts b/packages/openapi-ts/src/utils/__tests__/handlebars.spec.ts
@@ -18,7 +18,6 @@ describe('registerHandlebarHelpers', () => {
       format: true,
       input: '',
       lint: false,
-      operationId: true,
       output: '',
       schemas: {},
       services: {},
@@ -46,7 +45,6 @@ describe('registerHandlebarTemplates', () => {
       format: true,
       input: '',
       lint: false,
-      operationId: true,
       output: '',
       schemas: {},
       services: {},

diff --git a/packages/openapi-ts/src/utils/write/__tests__/class.spec.ts b/packages/openapi-ts/src/utils/write/__tests__/class.spec.ts
@@ -21,7 +21,6 @@ describe('writeClientClass', () => {
       input: '',
       lint: false,
       name: 'AppClient',
-      operationId: true,
       output: '',
       schemas: {},
       services: {},

diff --git a/packages/openapi-ts/src/utils/write/__tests__/client.spec.ts b/packages/openapi-ts/src/utils/write/__tests__/client.spec.ts
@@ -20,7 +20,6 @@ describe('writeClient', () => {
       format: true,
       input: '',
       lint: false,
-      operationId: true,
       output: './dist',
       schemas: {},
       services: {},

diff --git a/packages/openapi-ts/src/utils/write/__tests__/core.spec.ts b/packages/openapi-ts/src/utils/write/__tests__/core.spec.ts
@@ -35,7 +35,6 @@ describe('writeCore', () => {
       input: '',
       lint: false,
       name: 'AppClient',
-      operationId: true,
       output: '',
       schemas: {},
       services: {},
@@ -90,7 +89,6 @@ describe('writeCore', () => {
       input: '',
       lint: false,
       name: 'AppClient',
-      operationId: true,
       output: '',
       schemas: {},
       services: {},
@@ -128,7 +126,6 @@ describe('writeCore', () => {
       input: '',
       lint: false,
       name: 'AppClient',
-      operationId: true,
       output: '',
       schemas: {},
       services: {},

diff --git a/packages/openapi-ts/src/utils/write/__tests__/index.spec.ts b/packages/openapi-ts/src/utils/write/__tests__/index.spec.ts
@@ -20,7 +20,6 @@ describe('processIndex', () => {
       format: false,
       input: '',
       lint: false,
-      operationId: true,
       output: '',
       schemas: {},
       services: {},

diff --git a/packages/openapi-ts/src/utils/write/__tests__/models.spec.ts b/packages/openapi-ts/src/utils/write/__tests__/models.spec.ts
@@ -21,7 +21,6 @@ describe('processTypesAndEnums', () => {
       input: '',
       lint: false,
       name: 'AppClient',
-      operationId: true,
       output: '',
       schemas: {},
       services: {},

diff --git a/packages/openapi-ts/src/utils/write/__tests__/schemas.spec.ts b/packages/openapi-ts/src/utils/write/__tests__/schemas.spec.ts
@@ -22,7 +22,6 @@ describe('processSchemas', () => {
       input: '',
       lint: false,
       name: 'AppClient',
-      operationId: true,
       output: '',
       schemas: {},
       services: {},

diff --git a/packages/openapi-ts/src/utils/write/__tests__/services.spec.ts b/packages/openapi-ts/src/utils/write/__tests__/services.spec.ts
@@ -20,7 +20,6 @@ describe('processServices', () => {
       format: false,
       input: '',
       lint: false,
-      operationId: true,
       output: '',
       schemas: {},
       services: {},

diff --git a/packages/openapi-ts/test/bin.spec.ts b/packages/openapi-ts/test/bin.spec.ts
@@ -223,8 +223,6 @@ describe('cli', () => {
       'false',
       '--lint',
       'false',
-      '--operationId',
-      'false',
       '--useOptions',
       'false',
       '--dry-run',
@@ -237,7 +235,6 @@ describe('cli', () => {
     expect(result.stderr.toString()).toContain('services: false');
     expect(result.stderr.toString()).toContain('format: false');
     expect(result.stderr.toString()).toContain('lint: false');
-    expect(result.stderr.toString()).toContain('operationId: false');
     expect(result.stderr.toString()).toContain('schemas: false');
     expect(result.stderr.toString()).toContain('useOptions: false');
   });
@@ -262,8 +259,6 @@ describe('cli', () => {
       'true',
       '--lint',
       'true',
-      '--operationId',
-      'true',
       '--useOptions',
       'true',
       '--dry-run',
@@ -276,7 +271,6 @@ describe('cli', () => {
     expect(result.stderr.toString()).toContain('services: true');
     expect(result.stderr.toString()).toContain('format: true');
     expect(result.stderr.toString()).toContain('lint: true');
-    expect(result.stderr.toString()).toContain('operationId: true');
     expect(result.stderr.toString()).toContain('schemas: true');
     expect(result.stderr.toString()).toContain('useOptions: true');
   });
@@ -297,7 +291,6 @@ describe('cli', () => {
       'bar',
       '--format',
       '--lint',
-      '--operationId',
       '--useOptions',
       '--dry-run',
       'true',
@@ -307,7 +300,6 @@ describe('cli', () => {
     expect(result.stderr.toString()).toContain('exportCore: true');
     expect(result.stderr.toString()).toContain('format: true');
     expect(result.stderr.toString()).toContain('lint: true');
-    expect(result.stderr.toString()).toContain('operationId: true');
     expect(result.stderr.toString()).toContain('schemas: true');
     expect(result.stderr.toString()).toContain('useOptions: true');
     expect(result.stderr.toString()).toContain("types: 'foo");