@povio/openapi-codegen-cli 0.10.0 → 0.10.2

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.
 
@@ -53,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)
@@ -92,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/zod/enumExtraction/updateExtractedEnumZodSchemaData.d.ts

@@ -1,11 +1,17 @@
 import { OpenAPIV3 } from "openapi-types";
 import { SchemaResolver } from "../../SchemaResolver.class";
+type SchemaInfo = {
+    schemaRef: string;
+    schemaInfo?: string;
+} | {
+    schemaRef?: string;
+    schemaInfo: string;
+};
 export declare function updateExtractedEnumZodSchemaData({ schema, nameSegments, includeSelf, ...params }: {
     resolver: SchemaResolver;
     schema: OpenAPIV3.ReferenceObject | OpenAPIV3.SchemaObject | undefined;
-    schemaRef?: string;
-    schemaInfo?: string;
     tags: string[];
     nameSegments?: string[];
     includeSelf?: boolean;
-}): void;
+} & SchemaInfo): void;
+export {};

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

@@ -5,7 +5,7 @@ import { ValidationError, ValidationErrorType } from "../types/validation";
 export declare function getInvalidSchemaError(message: string): ValidationError;
 export declare function getInvalidOperationIdError(operationId: string): ValidationError;
 export declare function getMissingPathParameterError(params: EndpointParameter[], path: string): ValidationError;
-export declare function getNotAllowedInlineEnumError(message: string): ValidationError;
+export declare function getNotAllowedInlineEnumError(enumProperty: string): ValidationError;
 export declare function getNotAllowedCircularSchemaError(message: string): ValidationError;
 export declare function getMissingAclConditionPropertyError(propertyName: string, operation: OperationObject, endpoint: Endpoint): ValidationError;
 export declare function getMissingStatusCodeError(statusCode: HttpStatusCode, operation: OperationObject, endpoint: Endpoint): ValidationError;