@povio/openapi-codegen-cli 0.5.0 → 0.5.1

package/README.md

@@ -1,8 +1,8 @@
 # OpenAPI code generation CLI
 
-**NOTE:** This CLI tool is specifically designed for custom usage within our organization. The generated code output is in alignment with our internal templates.
+**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, API definitions and React queries) from OpenAPI v3 specification. API definitions are customized to fit the REST client wrapper used in our Next.js template. React queries are generated in alignment with our code standards, without the need for explicit types.
+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.
 
 The tool partially leverages code from [openapi-zod-client](https://github.com/astahmer/openapi-zod-client) repository.
 
@@ -18,37 +18,45 @@ yarn add @povio/openapi-codegen-cli
 yarn openapi-codegen generate --input http://localhost:3001/docs-json
 ```
 
+#### Standalone mode
+
+```bash
+yarn openapi-codegen generate --input http://localhost:3001/docs-json --standalone
+```
+
 ## Options
 
-### Generate command (generates Zod schemas, API definitions and React queries)
+#### Generate command (generates Zod schemas, API definitions and React queries)
 
 ```sh
-  --input                             Path/url to OpenAPI/Swagger document as json/yaml
+  --input                             Path/URL to OpenAPI/Swagger document as JSON/YAML
   --output                            Output path (default: 'output')
   --includeNamespaces                 Include namespaces inside generated files (default: true)
   --splitByTags                       Split output into directories based on tags in OpenAPI operations (default: true)
-  --defaultTag                        Default tag name for code shared accross multiple tags (default: 'Common')
-  --excludeTags                       Comma separated list of tags excluded from the output
-  --extractEnums                      Enums are extracted as seperate Zod schemas (default: true)
-  --removeOperationPrefixEndingWith   Removes prefix that ends with value from operation names (default: 'Controller_')
-  --importPath                        Import path (default: 'ts', possible: 'ts' | 'relative' | 'absolute')
-  --prettier                          Run prettier command on output after code generation (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
+  --extractEnums                      Extract enums as separate Zod schemas (default: true)
+  --removeOperationPrefixEndingWith   Remove prefixes that end with the specified value from operation names (default: 'Controller_')
+  --importPath                        Import path (default: 'ts', possible values: 'ts' | 'relative' | 'absolute')
+  --prettier                          Run the Prettier command on the output after code generation (default: true)
   --verbose                           Show log messages during execution
+  --standalone                        Add any missing classes or types—e.g., REST client class, React Query type extensions, etc. (default: false)
+  --baseUrl                           (Standalone mode only) Base URL for the REST client; falls back to the one defined in the OpenAPI spec
 ```
 
-### Check command (checks if OpenAPI spec is compliant)
+#### Check command (checks if OpenAPI spec is compliant)
 
 ```sh
-  --input                             Path/url to OpenAPI/Swagger document as json/yaml
+  --input                             Path/URL to OpenAPI/Swagger document as JSON/YAML
   --splitByTags                       Split output into directories based on tags in OpenAPI operations (default: true)
-  --defaultTag                        Default tag name for code shared accross multiple tags (default: 'Common')
-  --excludeTags                       Comma separated list of tags excluded from the output
+  --defaultTag                        Default tag name for code shared across multiple tags (default: 'Common')
+  --excludeTags                       Comma-separated list of tags to exclude from the output
   --verbose                           Show log messages during execution
 ```
 
 ## Development
 
-### Test locally
+#### Test locally
 
 ```bash
 # prerequisites

package/dist/commands/generate.d.ts

@@ -3,5 +3,5 @@ export type GenerateParams = {
     excludeTags: string;
     prettier: boolean;
     verbose: boolean;
-} & Pick<GenerateOptions, "input" | "output" | "includeNamespaces" | "splitByTags" | "defaultTag" | "removeOperationPrefixEndingWith" | "importPath" | "extractEnums">;
+} & Pick<GenerateOptions, "input" | "output" | "includeNamespaces" | "splitByTags" | "defaultTag" | "removeOperationPrefixEndingWith" | "importPath" | "extractEnums" | "standalone" | "baseUrl">;
 export declare function generate({ input, excludeTags, prettier, verbose, ...params }: GenerateParams): Promise<void>;

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

@@ -1,5 +1,5 @@
-import { Import } from "../types/generate";
-export declare const ACL_APP_ABILITY_FILENAME = "acl/app.ability";
+import { GenerateFile, Import } from "../types/generate";
+export declare const ACL_APP_ABILITY_FILE: GenerateFile;
 export declare const ACL_ALL_ABILITIES = "AllAbilities";
 export declare const CASL_ABILITY_BINDING: {
     abilityTuple: string;

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

@@ -0,0 +1,17 @@
+import { GenerateFile } from "../types/generate";
+export declare const APP_REST_CLIENT_NAME = "AppRestClient";
+export declare const QUERY_OPTIONS_TYPES: {
+    query: string;
+    mutation: string;
+};
+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 enum StandaloneAssetEnum {
+    ReactQueryTypes = "reactQueryTypes",
+    RestClient = "restClient",
+    RestInterceptor = "restInterceptor"
+}
+export declare const STANDALONE_ASSETS: Record<StandaloneAssetEnum, GenerateFile>;
+export declare const STANDALONE_APP_REST_CLIENT_FILE: GenerateFile;

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

@@ -52,6 +52,7 @@ export declare class SchemaResolver {
     resolveObject<T>(obj: OpenAPIV3.ReferenceObject | T): T;
     isSchemaCircular(ref: string): boolean;
     getCircularSchemaChain(ref: string, currentRef?: string, chain?: never[]): string[];
+    getBaseUrl(): string;
     private initialize;
 }
 export {};

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

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

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

@@ -4,6 +4,10 @@ export interface Import {
     bindings: string[];
     from: string;
 }
+export interface GenerateFile {
+    fileName: string;
+    extension: string;
+}
 export declare enum GenerateType {
     Models = "models",
     Endpoints = "endpoints",

package/dist/generators/types/metadata.d.ts

@@ -7,7 +7,7 @@ export interface GenerateParams {
 export interface TsTypeBase {
     type: string;
     namespace?: string;
-    filePath?: string;
+    importPath?: string;
 }
 export type TsType = TsTypeBase & TsMetaType;
 export type TsPropertyBase = {
@@ -37,7 +37,7 @@ export type TsMetaType = TsPrimitiveMetaType | TsObjectMetaType | TsArrayMetaTyp
 export type ModelMetadata = TsType;
 export type QueryMetadata = {
     name: string;
-    filePath: string;
+    importPath: string;
     namespace?: string;
     isQuery: boolean;
     isMutation: boolean;

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

@@ -0,0 +1,3 @@
+import { GenerateOptions } from "src/generators/types/options";
+export declare function getAppRestClientImportPath(options: GenerateOptions): string;
+export declare function getQueryTypesImportPath(options: GenerateOptions): string;

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

@@ -1,8 +1,8 @@
 import { GenerateFileData } from "../types/generate";
 export declare function readHbsTemplateSync(fileName: string): string;
+export declare function readAssetSync(fileName: string): string;
 export declare function getOutputFileName({ output, fileName }: {
     output: string;
     fileName: string;
 }): string;
-export declare function writeTsFileSync({ fileName, content }: GenerateFileData): void;
-export declare function writeGeneratesFileData(filesData: GenerateFileData[]): void;
+export declare function writeGenerateFileData(filesData: GenerateFileData[]): void;

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

@@ -1,13 +1,17 @@
-import { GenerateType } from "../../types/generate";
+import { GenerateFile, GenerateType } from "../../types/generate";
 import { GenerateOptions } from "../../types/options";
-export declare function getTagFileName({ type, tag, options, includeTagDir, }: {
+export declare function getFileNameWithExtension({ fileName, extension }: GenerateFile): string;
+declare function getTagFileNameWithoutExtension({ type, tag, options, includeTagDir, }: {
     type: GenerateType;
     tag: string;
     includeTagDir?: boolean;
     options: GenerateOptions;
 }): string;
+export declare function getTagImportPath(...args: Parameters<typeof getTagFileNameWithoutExtension>): string;
+export declare function getTagFileName(...args: Parameters<typeof getTagFileNameWithoutExtension>): string;
 export declare const getNamespaceName: ({ type, tag, options, }: {
     type: GenerateType;
     tag: string;
     options: GenerateOptions;
 }) => string;
+export {};