@povio/openapi-codegen-cli 0.6.6 → 0.7.0

package/README.md

@@ -29,26 +29,27 @@ yarn openapi-codegen generate --input http://localhost:3001/docs-json --standalo
 #### Generate command (generates Zod schemas, API definitions and React queries)
 
 ```sh
-  --input                             Path/URL to OpenAPI/Swagger document as JSON/YAML
-  --output                            Output path (default: 'output')
-  --prettier                          Run the Prettier command on the output after code generation (default: true)
-  --verbose                           Show log messages during execution
-
-  --splitByTags                       Split output into directories based on tags in OpenAPI operations (default: true)
-  --defaultTag                        (Requires `splitByTags`) Default tag name for code shared across multiple tags (default: 'Common')
-  --excludeTags                       (Requires `splitByTags`) Comma-separated list of tags to exclude from the output
-
-  --tsNamespaces                      Include Typescript namespaces inside generated files (default: true)
-  --importPath                        Import path (default: 'ts', possible values: 'ts' | 'relative' | 'absolute')
-  --removeOperationPrefixEndingWith   Remove prefixes that end with the specified value from operation names (default: 'Controller_')
-  --extractEnums                      Extract enums as separate Zod schemas (default: true)
-  --replaceOptionalWithNullish        Replace all `.optional()` zod chains wtih `.nullish()`
-
-  --axiosRequestConfig                       Adds Axios request config parameter to queries (default: false)
-  --infiniteQueries                   Generates infinite queries for API definitions that support pagination (default: false)
-
-  --standalone                        Add any missing classes or 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 one defined in the OpenAPI spec
+  --input                             Path/URL to OpenAPI JSON/YAML document
+  --output                            Output directory path (default: 'output')
+  --prettier                          Format the generated code using Prettier (default: true)
+  --verbose                           Display detailed log messages during execution (default: false)
+
+  --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
+
+  --tsNamespaces                      Wrap generated files in TypeScript namespaces (default: true)
+  --importPath                        Module import style for generated files (default: 'ts'; options: 'ts' | 'relative' | 'absolute')
+  --removeOperationPrefixEndingWith   Remove operation name prefixes that end with the specified string (Default: 'Controller_')
+  --extractEnums                      Extract enums into separate Zod schemas (default: true)
+  --replaceOptionalWithNullish        Replace `.optional()` chains with `.nullish()` in generated Zod schemas (default: false)
+
+  --axiosRequestConfig                Include Axios request config parameters in query hooks (default: false)
+  --infiniteQueries                   Generate infinite queries for paginated API endpoints (default: false)
+  --invalidateQueryOptions            Add query invalidation options to mutation hooks (default: true)
+
+  --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
 ```
 
 #### Check command (checks if OpenAPI spec is compliant)
@@ -57,9 +58,9 @@ yarn openapi-codegen generate --input http://localhost:3001/docs-json --standalo
   --input                             Path/URL to OpenAPI/Swagger document as JSON/YAML
   --verbose                           Show log messages during execution
 
-  --splitByTags                       Split output into directories based on tags in OpenAPI operations (default: true)
-  --defaultTag                        Default tag name for code shared across multiple tags (default: 'Common')
-  --excludeTags                       Comma-separated list of tags to exclude from the output
+  --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
 ```
 
 ## Development

package/dist/commands/generate.d.ts

@@ -3,5 +3,5 @@ export type GenerateParams = {
     excludeTags: string;
     prettier: boolean;
     verbose: boolean;
-} & Pick<GenerateOptions, "input" | "output" | "tsNamespaces" | "splitByTags" | "defaultTag" | "removeOperationPrefixEndingWith" | "importPath" | "extractEnums" | "standalone" | "baseUrl" | "replaceOptionalWithNullish" | "infiniteQueries" | "axiosRequestConfig">;
+} & 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>;

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

@@ -16,3 +16,9 @@ export declare enum StandaloneAssetEnum {
 }
 export declare const STANDALONE_ASSETS: Record<StandaloneAssetEnum, GenerateFile>;
 export declare const STANDALONE_APP_REST_CLIENT_FILE: GenerateFile;
+export declare const INVALIDATE_QUERIES: {
+    optionsType: string;
+    functionName: string;
+};
+export declare const INVALIDATE_QUERY_OPTIONS_FILE: GenerateFile;
+export declare const QUERY_MODULES_FILE: GenerateFile;

package/dist/generators/const/{query.const.d.ts → queries.const.d.ts}

@@ -14,3 +14,4 @@ export declare const INFINITE_QUERY_RESPONSE_PARAMS: {
     totalItemsName: string;
     limitParamName: string;
 };
+export declare const QUERIES_MODULE_NAME = "moduleName";

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

@@ -0,0 +1,2 @@
+import { GenerateTypeParams } from "../types/generate";
+export declare function generateQueryModules({ resolver, data }: Omit<GenerateTypeParams, "tag">): string;

package/dist/generators/utils/generate/generate.imports.utils.d.ts

@@ -1,6 +1,6 @@
 import { SchemaResolver } from "src/generators/core/SchemaResolver.class";
 import { Endpoint } from "../../types/endpoint";
-import { Import } from "../../types/generate";
+import { GenerateType, Import } from "../../types/generate";
 import { GenerateOptions } from "../../types/options";
 export declare function getModelsImports({ resolver, tag, zodSchemas, zodSchemasAsTypes, }: {
     resolver: SchemaResolver;
@@ -13,10 +13,13 @@ export declare function getEndpointsImports({ tag, endpoints, options, }: {
     endpoints: Endpoint[];
     options: GenerateOptions;
 }): Import[];
-export declare function getAclImports({ tags, entityName, getAliasEntityName, options, }: {
+export declare function getEntityImports({ tags, entityName, getAliasEntityName, type, sameDir, options, }: {
     tags: string[];
     entityName: string;
     getAliasEntityName?: (tag: string) => string;
+    type: GenerateType;
+    sameDir?: boolean;
     options: GenerateOptions;
 }): Import[];
-export declare function getImportPath(options: Pick<GenerateOptions, "output" | "importPath">): string;
+export declare function getImportPath(options: Pick<GenerateOptions, "output" | "importPath">, sameDir?: boolean): string;
+export declare function mergeImports(options: GenerateOptions, ...importArrs: Import[][]): Import[];

package/dist/generators/utils/generate/generate.query.utils.d.ts

@@ -1,3 +1,5 @@
 import { Endpoint } from "../../types/endpoint";
 export declare const getQueryName: (endpoint: Endpoint) => string;
 export declare const getInfiniteQueryName: (endpoint: Endpoint) => string;
+export declare const getTagModuleName: (tag: string) => string;
+export declare const getTagKeys: (tag: string) => string;

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

@@ -16,4 +16,5 @@ export declare const getNamespaceName: ({ type, tag, options, }: {
 }) => string;
 export declare function getAppRestClientImportPath(options: GenerateOptions): string;
 export declare function getQueryTypesImportPath(options: GenerateOptions): string;
+export declare function getInvalidateQueriesImportPath(options: GenerateOptions): string;
 export {};