fix(footer): warn about params change if footer function call fail

Use it to avoid a breaking change
anymaniax · Mar 9, 2022 · e9f073a · e9f073a
1 parent d27df09
commit e9f073a
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 16 deletions.
diff --git a/src/core/generators/axios.ts b/src/core/generators/axios.ts
@@ -1,4 +1,5 @@
 import {
+  ClientFooterBuilder,
   GeneratorClient,
   GeneratorDependency,
   GeneratorOptions,
@@ -174,20 +175,16 @@ export const generateAxiosHeader = ({
 }
   ${!noFunction ? `export const ${title} = () => {\n` : ''}`;
 
-export const generateAxiosFooter = ({
-  operationNames = [],
-  noFunction,
+export const generateAxiosFooter: ClientFooterBuilder = ({
+  operationNames,
   title,
-}: {
-  operationNames?: string[];
-  noFunction?: boolean;
-  title: string;
+  noFunction,
 }) => {
   const functionFooter = `return {${operationNames.join(',')}}};\n`;
   const returnTypesArr = operationNames
     .map((n) => {
       return returnTypesToWrite.has(n)
-        ? returnTypesToWrite.get(n)?.(noFunction ? undefined : title)
+        ? returnTypesToWrite.get(n)?.(noFunction || !title ? undefined : title)
         : '';
     })
     .filter(Boolean);

diff --git a/src/core/generators/client.ts b/src/core/generators/client.ts
@@ -69,8 +69,7 @@ export const GENERATOR_CLIENT: GeneratorClients = {
       isRequestOptions: boolean;
     }) => generateAxiosHeader({ ...options, noFunction: true }),
     dependencies: getAxiosDependencies,
-    footer: ({operationNames, title }) =>
-      generateAxiosFooter({ operationNames, title, noFunction: true }),
+    footer: (options) => generateAxiosFooter({ ...options, noFunction: true }),
     title: generateAxiosTitle,
   },
   angular: {
@@ -191,8 +190,23 @@ export const generateClientFooter = ({
 }): GeneratorClientExtra => {
   const titles = generateClientTitle(outputClient, title, customTitleFunc);
   const { footer } = getGeneratorClient(outputClient);
+  let implementation: string;
+  try {
+    if (isFunction(outputClient)) {
+      implementation = (footer as (operationNames: any) => string)(operationNames);
+      // being here means that the previous call worked
+      console.warn(
+        '[WARN] Passing an array of strings for operations names to the footer function is deprecated and will be removed in a future major release. Please pass them in an object instead: { operationNames: string[] }.',
+      );
+    } else {
+      implementation = footer({ operationNames, title: titles.implementation });
+    }
+  } catch (e) {
+    implementation = footer({ operationNames, title: titles.implementation });
+  }
+
   return {
-    implementation: footer({ operationNames, title: titles.implementation }),
+    implementation,
     implementationMSW: `]\n`,
   };
 };

diff --git a/src/types/generator.ts b/src/types/generator.ts
@@ -147,11 +147,13 @@ export type ClientHeaderBuilder = (params: {
   provideIn: boolean | 'root' | 'any';
 }) => string;
 
-export type ClientFooterBuilder = (options: {
-  operationNames?: string[];
-  noFunction?: boolean;
-  title: string;
-}) => string;
+export type ClientFooterBuilder = (
+  params: {
+    noFunction?: boolean | undefined;
+    operationNames: string[];
+    title?: string;
+  },
+) => string;
 
 export type ClientTitleBuilder = (title: string) => string;