feat: add option to customize API client constructor name

feat: add apiClientConstructorName to default option values

Author: CSantosM

.changeset/eight-yaks-wait.md

@@ -0,0 +1,5 @@
+---
+"openapi-zod-client": minor
+---
+
+Parametrized custom name for default api client constructor

README.md

@@ -64,14 +64,15 @@ Options:
   --no-with-alias                   With alias as api client methods (default: true)
   -a, --with-alias                  With alias as api client methods (default: true)
   --api-client-name <name>          when using the default `template.hbs`, allow customizing the `export const {apiClientName}`
+  --api-client-constructor-name <name>          when using the default `template.hbs`, allow customizing the `export const {apiClientName}`
   --error-expr <expr>               Pass an expression to determine if a response status is an error
   --success-expr <expr>             Pass an expression to determine which response status is the main success status
   --media-type-expr <expr>          Pass an expression to determine which response content should be allowed
   --export-schemas                  When true, will export all `#/components/schemas`
   --implicit-required               When true, will make all properties of an object required by default (rather than the current opposite), unless an explicitly `required` array is set
   --with-deprecated                 when true, will keep deprecated endpoints in the api output
   --with-description                when true, will add z.describe(xxx)
-  --with-docs                       when true, will add jsdoc comments to generated types 
+  --with-docs                       when true, will add jsdoc comments to generated types
   --group-strategy                  groups endpoints by a given strategy, possible values are: 'none' | 'tag' | 'method' | 'tag-file' | 'method-file'
   --complexity-threshold            schema complexity threshold to determine which one (using less than `<` operator) should be assigned to a variable
   --default-status                  when defined as `auto-correct`, will automatically use `default` as fallback for `response` when no status code was declared

lib/src/cli.ts

@@ -27,6 +27,10 @@ cli.command("<input>", "path/url to OpenAPI/Swagger document as json/yaml")
         "--api-client-name <name>",
         "when using the default `template.hbs`, allow customizing the `export const {apiClientName}`"
     )
+    .option(
+        "--api-client-constructor-name <name>",
+        "when using the default `template.hbs`, allow customizing the `export const {apiClientConstructorName}`"
+    )
     .option("--error-expr <expr>", "Pass an expression to determine if a response status is an error")
     .option("--success-expr <expr>", "Pass an expression to determine which response status is the main success status")
     .option("--media-type-expr <expr>", "Pass an expression to determine which response content should be allowed")
@@ -79,6 +83,7 @@ cli.command("<input>", "path/url to OpenAPI/Swagger document as json/yaml")
                 withAlias,
                 baseUrl: options.baseUrl,
                 apiClientName: options.apiClientName,
+                apiClientConstructorName: options.apiClientConstructorName,
                 isErrorStatus: options.errorExpr,
                 isMainResponseStatus: options.successExpr,
                 shouldExportAllSchemas: options.exportSchemas,

lib/src/template-context.ts

@@ -272,6 +272,13 @@ export type TemplateContextOptions = {
      * @default "api"
      */
     apiClientName?: string;
+
+    /**
+     * when using the default `template.hbs`, allow customizing the `export const {apiClientConstructorName}`
+     *
+     * @default "createApiClient"
+     */
+    apiClientConstructorName?: string;
     /**
      * when defined, will be used to pick which endpoint to use as the main one and set to `ZodiosEndpointDefinition["response"]`
      * will use `default` status code as fallback

lib/src/templates/default.hbs

@@ -82,6 +82,8 @@ const endpoints = makeApi([
 
 export const {{options.apiClientName}} = new Zodios({{#if options.baseUrl}}"{{options.baseUrl}}", {{/if}}endpoints);
 
-export function createApiClient(baseUrl: string, options?: ZodiosOptions) {
+function createApiClient(baseUrl: string, options?: ZodiosOptions) {
     return new Zodios(baseUrl, endpoints, options);
 }
+
+export { createApiClient as {{#if options.apiClientConstructorName}}{{options.apiClientConstructorName}}{{else}}createApiClient{{/if}} };

playground/src/Playground/Playground.tsx

@@ -613,6 +613,7 @@ const optionNameToCliOptionName = {
     noWithAlias: "--no-with-alias",
     baseUrl: "--base-url",
     apiClientName: "--api-client-name",
+    apiClientConstructorName: "--api-client-constructor-name",
     isErrorStatus: "--error-expr",
     isMainResponseStatus: "--success-expr",
     shouldExportAllSchemas: "--export-schemas",

playground/src/components/OptionsForm.tsx

@@ -6,6 +6,7 @@ const schema = z.object({
     baseUrl: z.string(),
     noWithAlias: z.boolean(),
     apiClientName: z.string().default("api"),
+    apiClientConstructorName: z.string().default("createApiClient"),
     isMainResponseStatus: z.string(),
     isErrorStatus: z.string(),
     isMediaTypeAllowed: z.string(),
@@ -24,6 +25,7 @@ export const defaultOptionValues = {
     baseUrl: "",
     noWithAlias: false,
     apiClientName: "api",
+    apiClientConstructorName: "createApiClient",
     isMainResponseStatus: "status >= 200 && status < 300",
     isErrorStatus: "!(status >= 200 && status < 300)",
     isMediaTypeAllowed: "mediaType === 'application/json'",