@povio/openapi-codegen-cli 0.16.1 → 1.0.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@povio/openapi-codegen-cli",
-  "version": "0.16.1",
+  "version": "1.0.2",
   "main": "./dist/index.js",
   "bin": {
     "openapi-codegen": "./dist/sh.js"
@@ -49,8 +49,8 @@
     "@types/prettier": "^3.0.0",
     "@types/prompt-sync": "^4.2.3",
     "@types/yargs": "^17.0.32",
-    "@typescript-eslint/eslint-plugin": "^6.21.0",
-    "@typescript-eslint/parser": "^6.21.0",
+    "@typescript-eslint/eslint-plugin": "^8.40.0",
+    "@typescript-eslint/parser": "^8.40.0",
     "chalk": "^5.3.0",
     "esbuild": "^0.21.3",
     "eslint": "^8.57.0",

package/src/assets/rest-client.ts

@@ -2,14 +2,16 @@ import axios, { AxiosInstance, AxiosRequestConfig, AxiosResponse, CreateAxiosDef
 import { z } from "zod";
 import { RestInterceptor } from "./rest-interceptor";
 
-interface RequestInfo<ZResDto extends z.ZodRawShape, ResDto, Res> {
-  resSchema: z.ZodEffects<z.ZodObject<ZResDto, "strip", z.ZodTypeAny, ResDto>, Res> | z.ZodSchema<Res>;
+interface RequestInfo<ZOutput> {
+  resSchema: z.ZodType<ZOutput>;
 }
 
-interface RequestConfig<RawRes extends boolean = false> {
-  rawResponse?: RawRes;
+interface RequestConfig<IsRawRes extends boolean = false> {
+  rawResponse?: IsRawRes;
 }
 
+type Response<ZOutput, IsRawRes extends boolean = false> = IsRawRes extends true ? AxiosResponse<ZOutput> : ZOutput;
+
 export class RestClient {
   private client: AxiosInstance;
 
@@ -38,60 +40,60 @@ export class RestClient {
     interceptor.removeInterceptor(this.client);
   }
 
-  public async get<ZResDto extends z.ZodRawShape, ResDto, Res, RawRes extends boolean = false>(
-    requestInfo: RequestInfo<ZResDto, ResDto, Res>,
+  public async get<ZOutput, IsRawRes extends boolean = false>(
+    requestInfo: RequestInfo<ZOutput>,
     url: string,
-    requestConfig?: AxiosRequestConfig & RequestConfig<RawRes>,
-  ): Promise<RawRes extends true ? AxiosResponse<Res> : Res> {
+    requestConfig?: AxiosRequestConfig & RequestConfig<IsRawRes>,
+  ): Promise<Response<ZOutput, IsRawRes>> {
     return this.makeRequest(requestInfo, { ...requestConfig, method: "get", url });
   }
 
-  public async post<ZResDto extends z.ZodRawShape, ResDto, Res, RawRes extends boolean = false>(
-    requestInfo: RequestInfo<ZResDto, ResDto, Res>,
+  public async post<ZOutput, IsRawRes extends boolean = false>(
+    requestInfo: RequestInfo<ZOutput>,
     url: string,
     data?: any,
-    requestConfig?: AxiosRequestConfig & RequestConfig<RawRes>,
-  ): Promise<RawRes extends true ? AxiosResponse<Res> : Res> {
+    requestConfig?: AxiosRequestConfig & RequestConfig<IsRawRes>,
+  ): Promise<Response<ZOutput, IsRawRes>> {
     return this.makeRequest(requestInfo, { ...requestConfig, method: "post", url, data });
   }
 
-  public async patch<ZResDto extends z.ZodRawShape, ResDto, Res, RawRes extends boolean = false>(
-    requestInfo: RequestInfo<ZResDto, ResDto, Res>,
+  public async patch<ZOutput, IsRawRes extends boolean = false>(
+    requestInfo: RequestInfo<ZOutput>,
     url: string,
     data?: any,
-    requestConfig?: AxiosRequestConfig & RequestConfig<RawRes>,
-  ): Promise<RawRes extends true ? AxiosResponse<Res> : Res> {
+    requestConfig?: AxiosRequestConfig & RequestConfig<IsRawRes>,
+  ): Promise<Response<ZOutput, IsRawRes>> {
     return this.makeRequest(requestInfo, { ...requestConfig, method: "patch", url, data });
   }
 
-  public async put<ZResDto extends z.ZodRawShape, ResDto, Res, RawRes extends boolean = false>(
-    requestInfo: RequestInfo<ZResDto, ResDto, Res>,
+  public async put<ZOutput, IsRawRes extends boolean = false>(
+    requestInfo: RequestInfo<ZOutput>,
     url: string,
     data?: any,
-    requestConfig?: AxiosRequestConfig & RequestConfig<RawRes>,
-  ): Promise<RawRes extends true ? AxiosResponse<Res> : Res> {
+    requestConfig?: AxiosRequestConfig & RequestConfig<IsRawRes>,
+  ): Promise<Response<ZOutput, IsRawRes>> {
     return this.makeRequest(requestInfo, { ...requestConfig, method: "put", url, data });
   }
 
-  public async delete<ZResDto extends z.ZodRawShape, ResDto, Res, RawRes extends boolean = false>(
-    requestInfo: RequestInfo<ZResDto, ResDto, Res>,
+  public async delete<ZOutput, IsRawRes extends boolean = false>(
+    requestInfo: RequestInfo<ZOutput>,
     url: string,
     data?: any,
-    requestConfig?: AxiosRequestConfig & RequestConfig<RawRes>,
-  ): Promise<RawRes extends true ? AxiosResponse<Res> : Res> {
+    requestConfig?: AxiosRequestConfig & RequestConfig<IsRawRes>,
+  ): Promise<Response<ZOutput, IsRawRes>> {
     return this.makeRequest(requestInfo, { ...requestConfig, method: "delete", url, data });
   }
 
-  private async makeRequest<ZResDto extends z.ZodRawShape, ResDto, Res, RawRes extends boolean = false>(
-    requestInfo: RequestInfo<ZResDto, ResDto, Res>,
-    requestConfig: AxiosRequestConfig & RequestConfig<RawRes>,
-  ): Promise<RawRes extends true ? AxiosResponse<Res> : Res> {
+  private async makeRequest<ZOutput, IsRawRes extends boolean = false>(
+    requestInfo: RequestInfo<ZOutput>,
+    requestConfig: AxiosRequestConfig & RequestConfig<IsRawRes>,
+  ): Promise<Response<ZOutput, IsRawRes>> {
     const { rawResponse, ...config } = requestConfig;
 
     const res = await this.client(config);
 
     const resData = requestInfo.resSchema.parse(res.data);
 
-    return (rawResponse ? { ...res, data: resData } : resData) as RawRes extends true ? AxiosResponse<Res> : Res;
+    return (rawResponse ? { ...res, data: resData } : resData) as Response<ZOutput, IsRawRes>;
   }
 }

package/src/generators/templates/endpoints.hbs

@@ -8,9 +8,9 @@
 {{#if hasZodImport}}
 {{{genImport zodImport}}}
 {{/if}}
-{{! Zod utils import }}
-{{#if hasZodUtilsImport}}
-{{{genImport zodUtilsImport}}}
+{{! Zod extended import }}
+{{#if hasZodExtendedImport}}
+{{{genImport zodExtendedImport}}}
 {{/if}}
 {{! Models import }}
 {{#each modelsImports as | modelsImport |}}
@@ -41,4 +41,4 @@ export const {{endpointName endpoint}} = ({{{genEndpointParams endpoint}}}{{#if
 {{/each}}
 {{#if includeNamespace}}
 }
-{{/if}}
+{{/if}}

package/src/generators/templates/models.hbs

@@ -1,9 +1,5 @@
 {{! Zod import}}
 {{{genImport zodImport}}}
-{{! Zod utils import }}
-{{#if hasZodUtilsImport}}
-{{{genImport zodUtilsImport}}}
-{{/if}}
 {{! Models import }}
 {{#each modelsImports as | modelsImport |}}
 {{{genImport modelsImport}}}
@@ -25,4 +21,4 @@ export type {{zodInferedType @key}} = z.infer<typeof {{@key}}>;
 {{/each}}
 {{#if includeNamespace}}
 }
-{{/if}}
+{{/if}}

package/src/generators/templates/partials/endpoint-param-parse.hbs

@@ -1 +1 @@
-{{zodUtilsNamespace}}.{{parse}}({{#if param.parameterSortingEnumSchemaName}}{{zodUtilsNamespace}}.{{sortExp}}({{{importedZodSchemaName param.parameterSortingEnumSchemaName}}}){{#if addOptional}}.optional(){{/if}}{{else}}{{{importedZodSchemaName param.zodSchema}}}{{#if addOptional}}.optional(){{/if}}{{/if}}, {{paramName}}{{#if isQuery}}, { type: "query", name: "{{paramName}}" }{{/if}})
+{{zodExtendedNamespace}}.{{parse}}({{#if param.parameterSortingEnumSchemaName}}{{zodExtendedNamespace}}.{{sortExp}}({{{importedZodSchemaName param.parameterSortingEnumSchemaName}}}){{#if addOptional}}.optional(){{/if}}{{else}}{{{importedZodSchemaName param.zodSchema}}}{{#if addOptional}}.optional(){{/if}}{{/if}}, {{paramName}}{{#if isQuery}}, { type: "query", name: "{{paramName}}" }{{/if}})

package/src/generators/templates/queries.hbs

@@ -15,6 +15,9 @@
 {{! Acl check import }}
 {{#if hasAclCheck}}
 {{{genImport aclCheckImport}}}
+{{#each aclImports as | aclImport |}}
+{{{genImport aclImport}}}
+{{/each}}
 {{/if}}
 {{! React query types import }}
 {{{genImport queryTypesImport}}}
@@ -26,10 +29,6 @@
 {{#each endpointsImports as | endpointsImport |}}
 {{{genImport endpointsImport}}}
 {{/each}}
-{{! Acl import }}
-{{#each aclImports as | aclImport |}}
-{{{genImport aclImport}}}
-{{/each}}
 
 {{#if includeNamespace}}
 export namespace {{namespace}} {
@@ -52,4 +51,4 @@ export const {{queriesModuleName}} = {{#if hasMutationEffects}}{{queryModuleEnum
 
 {{#if includeNamespace}}
 }
-{{/if}}
+{{/if}}

package/src/generators/templates/zod-extended.hbs

@@ -0,0 +1,49 @@
+{{! Zod import }}
+{{{genImport zodImport}}}
+{{! Error handling import }}
+{{{genImport errorHandlingImport}}}
+
+export namespace ZodExtended {
+  interface ParseOptions {
+    type: "body" | "query";
+    name?: string;
+    errorHandler?: ErrorHandler<never>;
+  }
+
+  export function {{parse}}<ZOutput, ZInput>(
+    schema: z.ZodType<ZOutput, ZInput>,
+    data: unknown,
+    { type, name, errorHandler }: ParseOptions = { type: "body" },
+  ) {
+    try {
+      return schema.parse(data);
+    } catch (e) {
+      if (e instanceof z.ZodError) {
+        e.name = `FE Request ${type === "body" ? "body" : "query param"}${name ? ` ("${name}")` : ""} schema mismatch - ZodError`;
+      }
+      (errorHandler ?? {{sharedErrorHandler}}).rethrowError(e);
+      throw e;
+    }
+  }
+
+  function is{{capitalize sortExp}}Valid(enumSchema: z.ZodEnum, data?: string) {
+    if (data === undefined || data === "" || enumSchema.options.length === 0) {
+      return true;
+    }
+
+    const prefixedEnumOptions = `([+-]?(${enumSchema.options.join("|")}))`;
+    const commaSeparatedOptions = `(${prefixedEnumOptions})(\s*,\s*${prefixedEnumOptions})*`;
+    return new RegExp(`^${commaSeparatedOptions}$`).test(data);
+  }
+
+  export const {{sortExp}} = (enumSchema: z.ZodEnum) =>
+    z.string().superRefine((arg, ctx) => {
+      if (!is{{capitalize sortExp}}Valid(enumSchema, arg)) {
+        ctx.addIssue({
+          code: "invalid_value",
+          message: "Invalid sorting string.",
+          values: [],
+        });
+      }
+    });
+}

package/dist/generators/const/brands.const.d.ts

@@ -1,8 +0,0 @@
-import { OpenAPIV3 } from "openapi-types";
-export declare enum BrandEnum {
-    datetime = "datetime",
-    email = "email",
-    dateRange = "dateRange",
-    textEditor = "textEditor"
-}
-export declare const BRANDS: Record<BrandEnum, OpenAPIV3.SchemaObject>;

package/dist/generators/generate/generateZodUtils.d.ts

@@ -1,2 +0,0 @@
-import { SchemaResolver } from "src/generators/core/SchemaResolver.class";
-export declare function generateZodUtils(resolver: SchemaResolver): string;

package/dist/generators/utils/brand.utils.d.ts

@@ -1,7 +0,0 @@
-import { OpenAPIV3 } from "openapi-types";
-import { BrandEnum } from "src/generators/const/brands.const";
-import { GenerateOptions } from "src/generators/types/options";
-export declare function getPrimitiveBrands(): BrandEnum[];
-export declare function getOtherBrands(): BrandEnum[];
-export declare function matchesBrand(schema: OpenAPIV3.SchemaObject, brand: BrandEnum): boolean;
-export declare function wrapWithBrand(schema: string, brand: BrandEnum, options: GenerateOptions): string;

package/src/generators/templates/zod-utils.hbs

@@ -1,70 +0,0 @@
-{{! Zod import }}
-{{{genImport zodImport}}}
-{{! Error handling import }}
-{{{genImport errorHandlingImport}}}
-
-interface ParseOptions {
-  type: "body" | "query";
-  name?: string;
-  errorHandler?: ErrorHandler<never>;
-}
-
-function is{{capitalize sortExp}}Valid(enumSchema: z.ZodEnum<[string, ...string[]]>, data?: string) {
-  if (data === undefined || data === "" || enumSchema.options.length === 0) {
-    return true;
-  }
-
-  const prefixedEnumOptions = `([+-]?(${enumSchema.options.join("|")}))`;
-  const commaSeparatedOptions = `(${prefixedEnumOptions})(\s*,\s*${prefixedEnumOptions})*`;
-  return new RegExp(`^${commaSeparatedOptions}$`).test(data);
-}
-
-export namespace {{zodUtilsNamespace}} {
-  export function {{parse}}<T>(schema: z.ZodSchema<T>, data: unknown, { type, name, errorHandler }: ParseOptions = { type: "body" }) {
-    try {
-      return schema.parse(data);
-    } catch (e) {
-      if (e instanceof z.ZodError) {
-        e.name = `FE Request ${type === "body" ? "body" : "query param"}${name ? ` ("${name}")` : ""} schema mismatch - ZodError`;
-      }
-      (errorHandler ?? {{sharedErrorHandler}}).rethrowError(e);
-      throw e;
-    }
-  }
-
-  export const {{sortExp}} = (enumSchema: z.ZodEnum<[string, ...string[]]>) =>
-    z.string().superRefine((arg, ctx) => {
-      if (!is{{capitalize sortExp}}Valid(enumSchema, arg)) {
-        ctx.addIssue({
-          code: z.ZodIssueCode.custom,
-          message: "Invalid sorting string.",
-        });
-      }
-    });
-
-  {{#if branded}}
-  export class ZodBranded<T extends z.ZodTypeAny, B extends string> extends z.ZodType<T["_output"], z.ZodTypeDef, T["_input"]> {
-    readonly _schema: T;
-
-    readonly _brand: B;
-
-    constructor(_schema: T, _brand: B) {
-      super(_schema._def);
-      this._schema = _schema;
-      this._brand = _brand;
-    }
-
-    _parse(input: z.ParseInput) {
-      return this._schema._parse(input);
-    }
-
-    unwrap() {
-      return this._schema;
-    }
-  }
-
-  export function {{brand}}<T extends z.ZodTypeAny, B extends string>(schema: T, _brand: B): ZodBranded<T, B> {
-    return new ZodBranded(schema, _brand);
-  }
-  {{/if}}
-}