Merge pull request #2854 from labmorales/feat/add_ts_enums_rtk

Author: markerikson

packages/rtk-query-codegen-openapi/package.json

@@ -21,6 +21,7 @@
     "prepare": "npm run build && chmod +x ./lib/bin/cli.js",
     "format": "prettier --write \"src/**/*.ts\"",
     "test:update": "lib/bin/cli.js test/fixtures/petstore.json --file test/fixtures/generated.ts -h",
+    "test:update:enum": "lib/bin/cli.js test/config.example.enum.ts",
     "test": "jest --runInBand",
     "cli": "esr src/bin/cli.ts"
   },
@@ -56,12 +57,12 @@
   },
   "dependencies": {
     "@apidevtools/swagger-parser": "^10.0.2",
-    "@rtk-query/oazapfts-patched": "^3.6.0-2",
     "commander": "^6.2.0",
+    "oazapfts": "^4.2.0",
     "prettier": "^2.2.1",
     "semver": "^7.3.5",
     "swagger2openapi": "^7.0.4",
-    "typescript": ">=4.1 <=4.5"
+    "typescript": "^4.9.3"
   },
   "husky": {
     "hooks": {

packages/rtk-query-codegen-openapi/src/bin/cli.ts

@@ -1,16 +1,9 @@
 #!/usr/bin/env node
 
-import program from 'commander';
 import { dirname, resolve } from 'path';
 import { generateEndpoints, parseConfig } from '../';
-import semver from 'semver';
-import { version as tsVersion } from 'typescript';
 
-if (!semver.satisfies(tsVersion, '>=4.1 <=4.5')) {
-  console.warn(
-    'Please note that `@rtk-query/codegen-openapi` only has been tested with TS versions 4.1 to 4.5 - other versions might cause problems.'
-  );
-}
+import program from 'commander';
 
 let ts = false;
 try {

packages/rtk-query-codegen-openapi/src/codegen.ts

@@ -1,5 +1,5 @@
-import ts from 'typescript';
 import { factory } from './utils/factory';
+import ts from 'typescript';
 
 const defaultEndpointBuilder = factory.createIdentifier('build');
 
@@ -12,7 +12,6 @@ export function generateObjectProperties(obj: ObjectPropertyDefinitions) {
 
 export function generateImportNode(pkg: string, namedImports: Record<string, string>, defaultImportName?: string) {
   return factory.createImportDeclaration(
-    undefined,
     undefined,
     factory.createImportClause(
       false,
@@ -44,17 +43,7 @@ export function generateCreateApiCall({
       endpoints: factory.createArrowFunction(
         undefined,
         undefined,
-        [
-          factory.createParameterDeclaration(
-            undefined,
-            undefined,
-            undefined,
-            endpointBuilder,
-            undefined,
-            undefined,
-            undefined
-          ),
-        ],
+        [factory.createParameterDeclaration(undefined, undefined, endpointBuilder, undefined, undefined, undefined)],
         undefined,
         factory.createToken(ts.SyntaxKind.EqualsGreaterThanToken),
         factory.createParenthesizedExpression(endpointDefinitions)
@@ -67,30 +56,32 @@ export function generateCreateApiCall({
     const enhanceEndpointsObjectLiteralExpression = factory.createObjectLiteralExpression(
       [factory.createShorthandPropertyAssignment(factory.createIdentifier('addTagTypes'), undefined)],
       true
-    )
+    );
     return factory.createVariableStatement(
       undefined,
       factory.createVariableDeclarationList(
-        [factory.createVariableDeclaration(
-          factory.createIdentifier("injectedRtkApi"),
-          undefined,
-          undefined,
-          factory.createCallExpression(
-            factory.createPropertyAccessExpression(
-              factory.createCallExpression(
-                factory.createPropertyAccessExpression(
-                  factory.createIdentifier("api"),
-                  factory.createIdentifier("enhanceEndpoints")
+        [
+          factory.createVariableDeclaration(
+            factory.createIdentifier('injectedRtkApi'),
+            undefined,
+            undefined,
+            factory.createCallExpression(
+              factory.createPropertyAccessExpression(
+                factory.createCallExpression(
+                  factory.createPropertyAccessExpression(
+                    factory.createIdentifier('api'),
+                    factory.createIdentifier('enhanceEndpoints')
+                  ),
+                  undefined,
+                  [enhanceEndpointsObjectLiteralExpression]
                 ),
-                undefined,
-                [enhanceEndpointsObjectLiteralExpression]
+                factory.createIdentifier('injectEndpoints')
               ),
-              factory.createIdentifier("injectEndpoints")
-            ),
-            undefined,
-            [injectEndpointsObjectLiteralExpression]
-          )
-        )],
+              undefined,
+              [injectEndpointsObjectLiteralExpression]
+            )
+          ),
+        ],
         ts.NodeFlags.Const
       )
     );
@@ -145,21 +136,16 @@ export function generateEndpointDefinition({
         factory.createIdentifier(type === 'query' ? 'providesTags' : 'invalidatesTags'),
         factory.createArrayLiteralExpression(tags.map((tag) => factory.createStringLiteral(tag), false))
       )
-    )
+    );
   }
   return factory.createPropertyAssignment(
     factory.createIdentifier(operationName),
 
     factory.createCallExpression(
       factory.createPropertyAccessExpression(endpointBuilder, factory.createIdentifier(type)),
       [Response, QueryArg],
-      [
-        factory.createObjectLiteralExpression(
-          objectProperties,
-          true
-        ),
-      ]
-    ),
+      [factory.createObjectLiteralExpression(objectProperties, true)]
+    )
   );
 }
 

packages/rtk-query-codegen-openapi/src/generate.ts

@@ -1,26 +1,27 @@
-import ts from 'typescript';
 import * as path from 'path';
-import { camelCase } from 'lodash';
+
 import ApiGenerator, {
   getOperationName as _getOperationName,
   getReferenceName,
   isReference,
   supportDeepObjects,
-} from '@rtk-query/oazapfts-patched/lib/codegen/generate';
+} from 'oazapfts/lib/codegen/generate';
+import type { EndpointMatcher, EndpointOverrides, GenerationOptions, OperationDefinition, TextMatcher } from './types';
+import { capitalize, getOperationDefinitions, getV3Doc, removeUndefined, isQuery as testIsQuery } from './utils';
 import {
-  createQuestionToken,
-  keywordType,
   createPropertyAssignment,
+  createQuestionToken,
   isValidIdentifier,
-} from '@rtk-query/oazapfts-patched/lib/codegen/tscodegen';
-import type { OpenAPIV3 } from 'openapi-types';
-import { generateReactHooks } from './generators/react-hooks';
-import type { EndpointMatcher, EndpointOverrides, GenerationOptions, OperationDefinition, TextMatcher } from './types';
-import { capitalize, getOperationDefinitions, getV3Doc, isQuery as testIsQuery, removeUndefined } from './utils';
-import { generateTagTypes } from './codegen';
+  keywordType,
+} from 'oazapfts/lib/codegen/tscodegen';
+import { generateCreateApiCall, generateEndpointDefinition, generateImportNode, generateTagTypes } from './codegen';
+
 import type { ObjectPropertyDefinitions } from './codegen';
-import { generateCreateApiCall, generateEndpointDefinition, generateImportNode } from './codegen';
+import type { OpenAPIV3 } from 'openapi-types';
+import { camelCase } from 'lodash';
 import { factory } from './utils/factory';
+import { generateReactHooks } from './generators/react-hooks';
+import ts from 'typescript';
 
 const generatedApiName = 'injectedRtkApi';
 
@@ -92,12 +93,14 @@ export async function generateApi(
     endpointOverrides,
     unionUndefined,
     flattenArg = false,
+    useEnumType = false,
   }: GenerationOptions
 ) {
   const v3Doc = await getV3Doc(spec);
 
   const apiGen = new ApiGenerator(v3Doc, {
     unionUndefined,
+    useEnumType,
   });
 
   const operationDefinitions = getOperationDefinitions(v3Doc).filter(operationMatches(filterEndpoints));
@@ -131,7 +134,7 @@ export async function generateApi(
   }
   apiFile = apiFile.replace(/\.[jt]sx?$/, '');
 
-  const sourceCode = printer.printNode(
+  return printer.printNode(
     ts.EmitHint.Unspecified,
     factory.createSourceFile(
       [
@@ -150,7 +153,6 @@ export async function generateApi(
           ),
         }),
         factory.createExportDeclaration(
-          undefined,
           undefined,
           false,
           factory.createNamedExports([
@@ -162,7 +164,8 @@ export async function generateApi(
           undefined
         ),
         ...Object.values(interfaces),
-        ...apiGen['aliases'],
+        ...apiGen.aliases,
+        ...apiGen.enumAliases,
         ...(hooks
           ? [
               generateReactHooks({
@@ -180,8 +183,6 @@ export async function generateApi(
     resultFile
   );
 
-  return sourceCode;
-
   function extractAllTagTypes({ operationDefinitions }: { operationDefinitions: OperationDefinition[] }) {
     let allTagTypes = new Set<string>();
 
@@ -242,7 +243,6 @@ export async function generateApi(
     const ResponseTypeName = factory.createTypeReferenceNode(
       registerInterface(
         factory.createTypeAliasDeclaration(
-          undefined,
           [factory.createModifier(ts.SyntaxKind.ExportKeyword)],
           capitalize(operationName + responseSuffix),
           undefined,
@@ -259,7 +259,7 @@ export async function generateApi(
     const allNames = parameters.map((p) => p.name);
     const queryArg: QueryArgDefinitions = {};
     for (const param of parameters) {
-      const isPureSnakeCase = /^[a-zA-Z][a-zA-Z0-9_]*$/.test(param.name);
+      const isPureSnakeCase = /^[a-zA-Z][\\w]*$/.test(param.name);
       const camelCaseName = camelCase(param.name);
 
       const name = isPureSnakeCase && !allNames.includes(camelCaseName) ? camelCaseName : param.name;
@@ -309,7 +309,6 @@ export async function generateApi(
     const QueryArg = factory.createTypeReferenceNode(
       registerInterface(
         factory.createTypeAliasDeclaration(
-          undefined,
           [factory.createModifier(ts.SyntaxKind.ExportKeyword)],
           capitalize(operationName + argSuffix),
           undefined,
@@ -391,17 +390,7 @@ export async function generateApi(
       undefined,
       undefined,
       Object.keys(queryArg).length
-        ? [
-            factory.createParameterDeclaration(
-              undefined,
-              undefined,
-              undefined,
-              rootObject,
-              undefined,
-              undefined,
-              undefined
-            ),
-          ]
+        ? [factory.createParameterDeclaration(undefined, undefined, rootObject, undefined, undefined, undefined)]
         : [],
       undefined,
       factory.createToken(ts.SyntaxKind.EqualsGreaterThanToken),
@@ -461,7 +450,7 @@ function generatePathExpression(
 ) {
   const expressions: Array<[string, string]> = [];
 
-  const head = path.replace(/\{(.*?)\}(.*?)(?=\{|$)/g, (_, expression, literal) => {
+  const head = path.replace(/\{(.*?)}(.*?)(?=\{|$)/g, (_, expression, literal) => {
     const param = pathParameters.find((p) => p.originalName === expression);
     if (!param) {
       throw new Error(`path parameter ${expression} does not seem to be defined in '${path}'!`);

packages/rtk-query-codegen-openapi/src/generators/react-hooks.ts

@@ -1,5 +1,5 @@
 import ts from 'typescript';
-import { getOperationName } from '@rtk-query/oazapfts-patched/lib/codegen/generate';
+import { getOperationName } from 'oazapfts/lib/codegen/generate';
 import { capitalize, isQuery } from '../utils';
 import type { OperationDefinition, EndpointOverrides, ConfigFile } from '../types';
 import { getOverrides } from '../generate';

packages/rtk-query-codegen-openapi/src/index.ts

@@ -42,11 +42,11 @@ export function parseConfig(fullConfig: ConfigFile) {
 }
 
 /**
- * Enforces `@rtk-query/oazapfts-patched` to use the same TypeScript version as this module itself uses.
+ * Enforces `oazapfts` to use the same TypeScript version as this module itself uses.
  * That should prevent enums from running out of sync if both libraries use different TS versions.
  */
 function enforceOazapftsTsVersion<T>(cb: () => T): T {
-  const ozTsPath = require.resolve('typescript', { paths: [require.resolve('@rtk-query/oazapfts-patched')] });
+  const ozTsPath = require.resolve('typescript', { paths: [require.resolve('oazapfts')] });
   const tsPath = require.resolve('typescript');
   const originalEntry = require.cache[ozTsPath];
   try {

packages/rtk-query-codegen-openapi/src/types.ts

@@ -79,6 +79,11 @@ export interface OutputFileOptions extends Partial<CommonOptions> {
   outputFile: string;
   filterEndpoints?: EndpointMatcher;
   endpointOverrides?: EndpointOverrides[];
+  /**
+   * defaults to false
+   * If passed as true it will generate TS enums instead of union of strings
+   */
+  useEnumType?: boolean;
 }
 
 export interface EndpointOverrides {

packages/rtk-query-codegen-openapi/test/config.example.enum.ts

@@ -0,0 +1,10 @@
+import type { ConfigFile } from '@rtk-query/codegen-openapi';
+
+const config: ConfigFile = {
+  schemaFile: './fixtures/petstore.yaml',
+  apiFile: './fixtures/emptyApi.ts',
+  outputFile: './tmp/example.ts',
+  useEnumType: true,
+};
+
+export default config;