@povio/openapi-codegen-cli 0.9.2 → 0.10.1

package/README.md

@@ -1,6 +1,6 @@
 # OpenAPI code generation CLI
 
-**NOTE:** This CLI tool is primarily designed for use within our organization. The generated code output aligns with our internal template. If you are using this tool without our internal template, make sure to use it in standalone mode.
+**NOTE:** This CLI tool is primarily designed for use within our organization. The generated code output aligns with our internal template. If you are using this tool without our internal template, make sure to use it in **standalone** mode.
 
 Use this tool to generate code (Zod schemas, TypeScript types, API definitions, and React queries) from an OpenAPI v3 specification. API definitions are generated to use a REST client wrapper that utilizes Axios. React queries are generated in alignment with our code standards, without the need for explicit types.
 
@@ -36,7 +36,10 @@ yarn openapi-codegen generate --input http://localhost:3001/docs-json --standalo
 
   --splitByTags                       Organize output into separate folders based on OpenAPI operation tags (default: true)
   --defaultTag                        (Requires `--splitByTags`) Default tag for shared code across multiple tags (default: 'Common')
-  --excludeTags                       (Requires `--splitByTags`) Comma-separated list of tags to exclude from generation
+
+  --excludeTags                       Comma-separated list of tags to exclude from generation
+  --excludePathRegex                  Exclude operations whose paths match the given regular expression
+  --excludeRedundantZodSchemas        Exclude any redundant Zod schemas (default: true)
 
   --tsNamespaces                      Wrap generated files in TypeScript namespaces (default: true)
   --importPath                        Module import style for generated files (default: 'ts'; options: 'ts' | 'relative' | 'absolute')
@@ -50,6 +53,9 @@ yarn openapi-codegen generate --input http://localhost:3001/docs-json --standalo
 
   --standalone                        Generate any missing supporting classes/types, e.g., REST client class, React Query type extensions, etc. (default: false)
   --baseUrl                           (Requires `--standalone`) Base URL for the REST client; falls back to the OpenAPI spec if not provided
+
+  # Command args designed specifically for use within our organization
+  --monorepo                         Configure output structure and imports adjusted for monorepo architecture
 ```
 
 #### Check command (checks if OpenAPI spec is compliant)
@@ -60,7 +66,10 @@ yarn openapi-codegen generate --input http://localhost:3001/docs-json --standalo
 
   --splitByTags                       Organize output into separate folders based on OpenAPI operation tags (default: true)
   --defaultTag                        (Requires `--splitByTags`) Default tag for shared code across multiple tags (default: 'Common')
-  --excludeTags                       (Requires `--splitByTags`) Comma-separated list of tags to exclude from generation
+
+  --excludeTags                       Comma-separated list of tags to exclude from generation
+  --excludePathRegex                  Exclude operations whose paths match the given regular expression
+  --excludeRedundantZodSchemas        Exclude any redundant Zod schemas (default: true)
 ```
 
 ## Development
@@ -86,3 +95,78 @@ yarn build
 yarn start --help
 yarn start:dist generate --input ./test/petstore.yaml --verbose
 ```
+
+## Common Issues
+
+### Enums
+
+If you're using Enums in your backend DTOs with `@Expose()` and `@IsEnum`, they may still not appear correctly in the OpenAPI schema unless you also provide both `enum` **and** `enumName` to `@ApiProperty`.
+
+```ts
+enum Status {
+  ACTIVE = "active",
+  INACTIVE = "inactive",
+}
+
+export class ExampleDto {
+  @ApiProperty({ enum: Status, enumName: "Status" })
+  @Expose()
+  @IsEnum(Status)
+  status: Status;
+}
+```
+
+```ts
+enum Status {
+  ACTIVE = "active",
+  INACTIVE = "inactive",
+}
+
+export class ExampleDto {
+  @ApiProperty({ enum: Status, enumName: "Status", isArray: true })
+  @Expose()
+  @IsEnum(Status, { each: true })
+  @IsArray()
+  status: Status[];
+}
+```
+
+---
+
+### Nested objects
+
+When using nested DTOs, ensure you explicitly specify the type using `@ApiProperty({ type: NestedDto })`:
+
+```ts
+export class NestedDto {
+  @ApiProperty()
+  @Expose()
+  name: string;
+}
+
+export class ParentDto {
+  @ApiProperty({ type: NestedDto })
+  @Expose()
+  @ValidateNested()
+  @Type(() => NestedDto)
+  @IsObject()
+  nested: NestedDto;
+}
+```
+
+```ts
+export class NestedDto {
+  @ApiProperty()
+  @Expose()
+  name: string;
+}
+
+export class ParentDto {
+  @ApiProperty({ type: NestedDto, isArray: true })
+  @Expose()
+  @ValidateNested({ each: true })
+  @Type(() => NestedDto)
+  @IsArray()
+  nestedList: NestedDto[];
+}
+```

package/dist/commands/generate.d.ts

@@ -1,7 +1,8 @@
 import { GenerateOptions } from "src/generators/types/options";
 export type GenerateParams = {
     excludeTags: string;
+    monorepo: boolean;
     prettier: boolean;
     verbose: boolean;
 } & Pick<GenerateOptions, "input" | "output" | "tsNamespaces" | "splitByTags" | "defaultTag" | "removeOperationPrefixEndingWith" | "importPath" | "extractEnums" | "standalone" | "baseUrl" | "replaceOptionalWithNullish" | "infiniteQueries" | "axiosRequestConfig" | "invalidateQueryOptions">;
-export declare function generate({ input, excludeTags, prettier, verbose, ...params }: GenerateParams): Promise<void>;
+export declare function generate({ input, excludeTags, monorepo, prettier, verbose, ...params }: GenerateParams): Promise<void>;

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

@@ -7,8 +7,10 @@ export declare const QUERY_OPTIONS_TYPES: {
 };
 export declare const TEMPLATE_DATA_FILE_PATH = "src/data";
 export declare const TEMPLATE_DATA_TS_PATH = "@/data";
-export declare const TEMPLATE_IMPORT_PATH_APP_REST_CLIENT = "@/util/rest/clients/app-rest-client";
-export declare const TEMPLATE_IMPORT_PATH_QUERY_TYPES = "@/types/react-query";
+export declare const TEMPLATE_IMPORTS: Record<string, {
+    template: string;
+    monorepoTemplate: string;
+}>;
 export declare enum StandaloneAssetEnum {
     ReactQueryTypes = "reactQueryTypes",
     RestClient = "restClient",

package/dist/generators/core/SchemaResolver.class.d.ts

@@ -4,6 +4,13 @@ import { GenerateOptions } from "../types/options";
 import { ValidationError } from "../types/validation";
 import { DependencyGraph } from "./openapi/getOpenAPISchemaDependencyGraph";
 import { ZodSchema } from "./zod/ZodSchema.class";
+interface SchemaData {
+    ref: string;
+    name: string;
+    zodSchemaName: string;
+    tags: string[];
+    deepRefOperations: OperationObject[];
+}
 export interface EnumZodSchemaData {
     code: string;
     zodSchemaName: string;
@@ -36,6 +43,7 @@ export declare class SchemaResolver {
     private get schemaRefs();
     constructor(openApiDoc: OpenAPIV3.Document, options: GenerateOptions);
     getSchemaByRef(ref: string): OpenAPIV3.SchemaObject;
+    getSchemaDataByName(name: string): SchemaData | undefined;
     getZodSchemaNameByRef(ref: string): string;
     getRefByZodSchemaName(zodSchemaName: string): string | undefined;
     getTagByZodSchemaName(zodSchemaName: string): string;
@@ -60,3 +68,4 @@ export declare class SchemaResolver {
     private initialize;
     private handleDuplicateEnumZodSchemas;
 }
+export {};

package/dist/generators/core/zod/enumExtraction/resolveExtractedEnumZodSchemaNames.d.ts

@@ -0,0 +1,2 @@
+import { SchemaResolver } from "../../SchemaResolver.class";
+export declare function resolveExtractedEnumZodSchemaNames(resolver: SchemaResolver): void;

package/dist/generators/core/zod/enumExtraction/resolveExtractedEnumZodSchemaTags.d.ts

@@ -0,0 +1,2 @@
+import { SchemaResolver } from "../../SchemaResolver.class";
+export declare function resolveExtractedEnumZodSchemaTags(resolver: SchemaResolver): void;

package/dist/generators/core/zod/{updateExtractedEnumZodSchemaData.d.ts → enumExtraction/updateExtractedEnumZodSchemaData.d.ts}

@@ -1,5 +1,5 @@
 import { OpenAPIV3 } from "openapi-types";
-import { SchemaResolver } from "../SchemaResolver.class";
+import { SchemaResolver } from "../../SchemaResolver.class";
 export declare function updateExtractedEnumZodSchemaData({ schema, nameSegments, includeSelf, ...params }: {
     resolver: SchemaResolver;
     schema: OpenAPIV3.ReferenceObject | OpenAPIV3.SchemaObject | undefined;
@@ -9,5 +9,3 @@ export declare function updateExtractedEnumZodSchemaData({ schema, nameSegments,
     nameSegments?: string[];
     includeSelf?: boolean;
 }): void;
-export declare function resolveExtractedEnumZodSchemaNames(resolver: SchemaResolver): void;
-export declare function resolveExtractedEnumZodSchemaTags(resolver: SchemaResolver): void;

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

@@ -1,7 +1,5 @@
-import { OpenAPIV3 } from "openapi-types";
 import { ALLOWED_PARAM_MEDIA_TYPES } from "../const/openapi.const";
-import { OperationObject, ParameterObject, PrimitiveType, SingleType, SortingParameterObject } from "../types/openapi";
-import { GenerateOptions } from "../types/options";
+import { ParameterObject, PrimitiveType, SingleType, SortingParameterObject } from "../types/openapi";
 export declare const getSchemaRef: (schemaName: string) => string;
 export declare const autocorrectRef: (ref: string) => string;
 export declare const getSchemaNameByRef: (ref: string) => string;
@@ -16,24 +14,10 @@ export declare function isParamMediaTypeAllowed(mediaType: string): mediaType is
 export declare function isMainResponseStatus(status: number): boolean;
 export declare function isErrorStatus(status: number): boolean;
 export declare function isMediaTypeAllowed(mediaType: string): boolean;
-export declare function getOperationName({ path, method, operation, options, tag, keepOperationTag, keepOperationPrefix, }: {
-    path: string;
-    method: string;
-    operation: OperationObject;
-    options: GenerateOptions;
-    tag: string;
-    keepOperationTag?: boolean;
-    keepOperationPrefix?: boolean;
-}): string;
-export declare function getUniqueOperationName({ operationsByTag, ...params }: {
-    path: string;
-    method: string;
-    operation: OperationObject;
-    operationsByTag: Record<string, OperationObject[]>;
-    options: GenerateOptions;
-}): string;
-export declare function getUniqueOperationNamesWithoutSplitByTags(openApiDoc: OpenAPIV3.Document, operationsByTag: Record<string, OperationObject[]>, options: GenerateOptions): string[];
 /** @example turns `/media-objects/{id}` into `MediaObjectsById` */
 export declare function pathToVariableName(path: string): string;
 export declare function replaceHyphenatedPath(path: string): string;
 export declare const isSortingParameterObject: (param: ParameterObject) => param is SortingParameterObject;
+export declare const isPathExcluded: (path: string, options: {
+    excludePathRegex: string;
+}) => boolean;

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

@@ -0,0 +1,22 @@
+import { OpenAPIV3 } from "openapi-types";
+import { OperationObject } from "../types/openapi";
+import { GenerateOptions } from "../types/options";
+export declare function isOperationExcluded(operation: OperationObject, options: GenerateOptions): boolean;
+export declare function getOperationName({ path, method, operation, options, tag, keepOperationTag, keepOperationPrefix, }: {
+    path: string;
+    method: string;
+    operation: OperationObject;
+    options: GenerateOptions;
+    tag: string;
+    keepOperationTag?: boolean;
+    keepOperationPrefix?: boolean;
+}): string;
+export declare function getUniqueOperationName({ operationsByTag, ...params }: {
+    path: string;
+    method: string;
+    operation: OperationObject;
+    operationsByTag: Record<string, OperationObject[]>;
+    options: GenerateOptions;
+}): string;
+export declare function getUniqueOperationNamesWithoutSplitByTags(openApiDoc: OpenAPIV3.Document, operationsByTag: Record<string, OperationObject[]>, options: GenerateOptions): string[];
+export declare function getOperationsByTag(openApiDoc: OpenAPIV3.Document, options: GenerateOptions): Record<string, OperationObject[]>;

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

@@ -1,6 +1,5 @@
-import { OpenAPIV3 } from "openapi-types";
 import { OperationObject } from "../types/openapi";
 import { GenerateOptions } from "../types/options";
 export declare function formatTag(tag: string): string;
 export declare function getOperationTag(operation: OperationObject, options: GenerateOptions): string;
-export declare function getOperationsByTag(openApiDoc: OpenAPIV3.Document, options: GenerateOptions): Record<string, OperationObject[]>;
+export declare function isTagExcluded(tag: string, options: GenerateOptions): boolean;