feat(cli): add basepath var and extra imports

Author: ddadaal

.changeset/friendly-radios-own.md

@@ -0,0 +1,5 @@
+---
+"@ddadaal/next-typed-api-routes-cli": minor
+---
+
+add option to customize basepath and extra imports

README.md

@@ -159,6 +159,26 @@ module.exports = {
 }
 ```
 
+You can also use `--basePathVar` option of `ntar` cli to customize the value of base path. 
+
+For example, when running `npx ntar client --basePathVar publicConfig.BASE_PATH`, the client file will look like:
+
+```tsx
+import { fromApi } from "@ddadaal/next-typed-api-routes-runtime/lib/client";
+import { join } from "path";
+
+import type { LoginSchema } from "src/pages/api/login/[username]";
+
+// the value of basePath is the same as the basePathVar option
+const basePath = publicConfig.BASE_PATH; 
+
+export const api = {
+  login: fromApi<LoginSchema>("GET", join(basePath, "/api/login/[username]")),
+};
+```
+
+If your `basePath` declaration needs imports, you can also use `extraImports` cli option to add extra imports into the client file. Multiple `extraImports` options can be specified.
+
 # Tips
 
 - All schemas and used models must have globally unique name

example/src/apis/api.ts

@@ -2,11 +2,16 @@
 
 import { fromApi } from "@ddadaal/next-typed-api-routes-runtime/lib/client";
 import { join } from "path";
+
+
 import type { LoginSchema } from "src/pages/api/login/[username]";
 import type { RegisterSchema } from "src/pages/api/register/index";
 
+const basePath = process.env.NEXT_PUBLIC_BASE_PATH || "";
+
 
 export const api = {
-  login: fromApi<LoginSchema>("GET", join(process.env.NEXT_PUBLIC_BASE_PATH || "", "/api/login/[username]")),
-  register: fromApi<RegisterSchema>("POST", join(process.env.NEXT_PUBLIC_BASE_PATH || "", "/api/register")),
+  login: fromApi<LoginSchema>("GET", join(basePath, "/api/login/[username]")),
+  register: fromApi<RegisterSchema>("POST", join(basePath, "/api/register")),
 };
+  

packages/cli/src/generateClients.ts

@@ -107,13 +107,17 @@ export interface GenerateApiClientsArgs {
   apiRoutesPath?: string;
   fetchImport?: string;
   apiObjectName?: string;
+  basePathVar?: string;
+  extraImports?: string[],
 }
 
 export async function generateClients({
   apiFilePath = "src/apis/api.ts",
   apiRoutesPath = "src/pages/api",
   fetchImport = "@ddadaal/next-typed-api-routes-runtime/lib/client",
   apiObjectName = "api",
+  basePathVar = "process.env.NEXT_PUBLIC_BASE_PATH || \"\"",
+  extraImports = [],
 }: GenerateApiClientsArgs) {
 
   if (!apiRoutesPath.endsWith("/")) {
@@ -128,12 +132,14 @@ export async function generateClients({
 
   await getApiObject(apiRoutesPath, "", endpoints, imports);
 
+  const basePathVarDeclaration = `const basePath = ${basePathVar};`;
+
   // use string instead of ts factories to easily style the code and reduce complexity
   const apiObjDeclaration = `
 export const ${apiObjectName} = {
 ${endpoints.map((e) =>
     // eslint-disable-next-line max-len
-    `  ${e.schemaName}: fromApi<${e.interfaceName}>("${e.method}", join(process.env.NEXT_PUBLIC_BASE_PATH || "", "${e.url}")),`,
+    `  ${e.schemaName}: fromApi<${e.interfaceName}>("${e.method}", join(basePath, "${e.url}")),`,
   ).join(EOL)}
 };
   `;
@@ -152,6 +158,10 @@ import { join } from "path";
     fetchApiImportDeclaration +
     EOL + EOL +
     importDeclarations +
+    EOL + EOL
+    extraImports.join(EOL) +
+    EOL + EOL +
+    basePathVarDeclaration +
     EOL + EOL +
     apiObjDeclaration;
 

packages/cli/src/index.ts

@@ -27,6 +27,8 @@ yargs(hideBin(process.argv))
         default: "@ddadaal/next-typed-api-routes-runtime/lib/client",
       },
       apiObjectName: { type: "string", default: "api" },
+      basePathVar: { type: "string", default: "process.env.NEXT_PUBLIC_BASE_PATH || \"\"" },
+      extraImports: { type: "array", default: []},
     });
   }, (argv) => {
     generateClients(argv);