Merge pull request #55 from StefanBRas/adjustable-createApi-import-path

Adjustable create api import path

Author: msutkowski

README.md

@@ -45,6 +45,7 @@ npx @rtk-incubator/rtk-query-codegen-openapi --file generated.api.ts --baseQuery
 - `--argSuffix <name>` - change the suffix of the arg type (default: `ApiArg` - ex: `AddPetApiArg`)
 - `--responseSuffix <name>` - change the suffix of the response type (default: `ApiResponse` - ex: `AddPetApiResponse`)
 - `--baseUrl <url>` - set the `baseUrl` when using `fetchBaseQuery` (will be ignored if you pass `--baseQuery`)
+- `--createApiImportPath <path>` - set the entry point to import `createApi` from. Currently only `react` is available. Defaults to `react` if `--hooks` is passed.
 - `--hooks` - include React Hooks in the output (ex: `export const { useGetModelQuery, useUpdateModelMutation } = api`)
 - `--file <filename>` - specify a filename to output to (ex: `./generated.api.ts`)
 

src/bin/cli.ts

@@ -20,6 +20,7 @@ program
   .option('--argSuffix <name>', 'pass arg suffix')
   .option('--responseSuffix <name>', 'pass response suffix')
   .option('--baseUrl <url>', 'pass baseUrl')
+  .option('--createApiImportPath <path>', 'entry point for createApi import. options: [react]')
   .option('-h, --hooks', 'generate React Hooks')
   .option('-c, --config <path>', 'pass tsconfig path for resolve path alias')
   .option('-f, --file <filename>', 'output file name (ex: generated.api.ts)')
@@ -39,6 +40,7 @@ if (program.args.length === 0) {
     'argSuffix',
     'responseSuffix',
     'baseUrl',
+    'createApiImportPath',
     'hooks',
     'file',
     'config',

src/codegen.ts

@@ -1,5 +1,6 @@
 import * as ts from 'typescript';
 const { factory } = ts;
+import { GenerationOptions } from './types';
 
 const defaultEndpointBuilder = factory.createIdentifier('build');
 
@@ -127,3 +128,39 @@ export function generateEndpointDefinition({
     )
   );
 }
+
+export function generatePackageImports({
+  createApiImportPath,
+  hooks,
+  isUsingFetchBaseQuery,
+}: {
+  createApiImportPath?: GenerationOptions['createApiImportPath'];
+  isUsingFetchBaseQuery: boolean;
+  hooks?: boolean;
+}) {
+  const DEFAULT_IMPORT_PATH = '@reduxjs/toolkit/query';
+
+  const entryPoint = hooks ? 'react' : createApiImportPath;
+
+  function getBasePackageImportsFromOptions() {
+    return {
+      ...(entryPoint === 'base' ? { createApi: 'createApi' } : {}),
+      ...(isUsingFetchBaseQuery ? { fetchBaseQuery: 'fetchBaseQuery' } : {}),
+    };
+  }
+
+  const basePackageImports = getBasePackageImportsFromOptions();
+
+  const hasBasePackageImports = Object.keys(basePackageImports).length > 0;
+
+  const basePackageImportNode = hasBasePackageImports
+    ? [generateImportNode(DEFAULT_IMPORT_PATH, getBasePackageImportsFromOptions())]
+    : [];
+
+  const subPackageImportNode =
+    entryPoint !== 'base'
+      ? [generateImportNode(`${DEFAULT_IMPORT_PATH}/${entryPoint}`, { createApi: 'createApi' })]
+      : [];
+
+  return [...subPackageImportNode, ...basePackageImportNode];
+}

src/generate.ts

@@ -21,10 +21,10 @@ import {
   generateCreateApiCall,
   generateEndpointDefinition,
   generateStringLiteralArray,
+  generatePackageImports,
   ObjectPropertyDefinitions,
 } from './codegen';
 import { generateSmartImportNode } from './generators/smart-import-node';
-import { generateImportNode } from './generators/import-node';
 
 const { factory } = ts;
 
@@ -44,6 +44,7 @@ export async function generateApi(
     baseQuery = 'fetchBaseQuery',
     argSuffix = 'ApiArg',
     responseSuffix = 'ApiResponse',
+    createApiImportPath = 'base',
     baseUrl,
     hooks,
     outputFile,
@@ -127,34 +128,11 @@ export async function generateApi(
 
   const isUsingFetchBaseQuery = baseQuery === 'fetchBaseQuery';
 
-  function getBasePackageImportsFromOptions() {
-    return hooks
-      ? {
-          ...(isUsingFetchBaseQuery ? { fetchBaseQuery: 'fetchBaseQuery' } : {}),
-        }
-      : {
-          createApi: 'createApi',
-          ...(isUsingFetchBaseQuery ? { fetchBaseQuery: 'fetchBaseQuery' } : {}),
-        };
-  }
-
-  const hasBasePackageImports = Object.keys(getBasePackageImportsFromOptions()).length > 0;
-
   const sourceCode = printer.printNode(
     ts.EmitHint.Unspecified,
     factory.createSourceFile(
       [
-        // If hooks are specified, we need to import them from the react entry point
-        ...(hooks
-          ? [
-              generateImportNode('@reduxjs/toolkit/query/react', {
-                createApi: 'createApi',
-              }),
-            ]
-          : []),
-        ...(hasBasePackageImports
-          ? [generateImportNode('@reduxjs/toolkit/query', getBasePackageImportsFromOptions())]
-          : []),
+        ...generatePackageImports({ hooks, isUsingFetchBaseQuery, createApiImportPath }),
         ...(customBaseQueryNode ? [customBaseQueryNode] : []),
         generateCreateApiCall({
           exportName,

src/types.ts

@@ -17,6 +17,7 @@ export type GenerationOptions = {
   argSuffix?: string;
   responseSuffix?: string;
   baseUrl?: string;
+  createApiImportPath?: 'base' | 'react';
   hooks?: boolean;
   outputFile?: string;
   compilerOptions?: ts.CompilerOptions;

test/cli.test.ts

@@ -88,6 +88,12 @@ describe('CLI options testing', () => {
     expect(numberOfHooks).toEqual(expectedHooks.length);
   });
 
+  it('should contain the right imports when using custom import path', async () => {
+    const result = await cli(['--createApiImportPath', 'react', `./test/fixtures/petstore.json`], '.');
+    expect(result.stdout).toContain(`import { createApi } from \"@reduxjs/toolkit/query/react\";`);
+    expect(result.stdout).not.toContain('useGetHealthcheckQuery'); // hooks not exported
+  });
+
   it('should contain the right imports when using hooks and a custom base query', async () => {
     const result = await cli(
       ['-h', `--baseQuery`, `test/fixtures/customBaseQuery.ts:anotherNamedBaseQuery`, `./test/fixtures/petstore.json`],