Merge pull request #38 from povio/feature/builder-configs

Builder configs generation

Author: monikaboz

README.md

@@ -70,6 +70,7 @@ yarn openapi-codegen generate --config my-config.ts
 #### Generate command (generates Zod schemas, API definitions and React queries)
 
 ```sh
+  --config                            Path to TS config file (default: 'openapi-codegen.config.ts')
   --input                             Path/URL to OpenAPI JSON/YAML document
   --output                            Output directory path (default: 'output')
   --prettier                          Format the generated code using Prettier (default: true)
@@ -97,13 +98,16 @@ yarn openapi-codegen generate --config my-config.ts
   --acl                               Generate ACL related files (default: true)
   --checkAcl                          Add ACL check to queries (default: true)
 
+  --builderConfigs                    Generate configs for builders (default: false)
+
   --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)
 
 ```sh
+  --config                            Path to TS config file (default: 'openapi-codegen.config.ts')
   --input                             Path/URL to OpenAPI/Swagger document as JSON/YAML
   --verbose                           Show log messages during execution
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@povio/openapi-codegen-cli",
-  "version": "1.1.2",
+  "version": "1.2.0",
   "main": "./dist/index.js",
   "bin": {
     "openapi-codegen": "./dist/sh.js"

src/commands/generate.command.ts

@@ -71,6 +71,9 @@ class GenerateOptions implements GenerateParams {
   @YargOption({ envAlias: "axiosRequestConfig", type: "boolean" })
   axiosRequestConfig?: boolean;
 
+  @YargOption({ envAlias: "builderConfigs", type: "boolean" })
+  builderConfigs?: boolean;
+
   @YargOption({ envAlias: "prettier", default: true, type: "boolean" })
   prettier?: boolean;
 

src/commands/generate.ts

@@ -34,6 +34,7 @@ export type GenerateParams = {
     | "axiosRequestConfig"
     | "mutationEffects"
     | "parseRequestParams"
+    | "builderConfigs"
   >
 >;
 

src/generators/const/buildConfigs.const.ts

@@ -0,0 +1 @@
+export const BUILD_CONFIG_SUFFIX = "config";

src/generators/const/deps.const.ts

@@ -10,27 +10,20 @@ export const QUERY_OPTIONS_TYPES = {
 
 // Template
 export const TEMPLATE_DATA_FILE_PATH = "src/data";
-export const TEMPLATE_DATA_TS_PATH = "@/data";
-
-export const TEMPLATE_IMPORTS = {
-  appRestClient: "@/util/rest/clients/app-rest-client",
-  queryTypes: "@/types/react-query",
-  errorHandling: "@/util/vendor/error-handling",
-  abilityContext: "@/data/acl/ability.context",
-};
-
 export const ERROR_HANDLERS = {
   ErrorHandler: "ErrorHandler",
   SharedErrorHandler: "SharedErrorHandler",
 };
-export const ERROR_HANDLING_IMPORT: Import = {
+export const ERROR_HANDLING_IMPORT: Omit<Import, "from"> = {
   bindings: [ERROR_HANDLERS.ErrorHandler, ERROR_HANDLERS.SharedErrorHandler],
-  from: TEMPLATE_IMPORTS.errorHandling,
 };
 export const ABILITY_CONTEXT = "AbilityContext";
-export const ABILITY_CONTEXT_IMPORT: Import = {
+export const ABILITY_CONTEXT_IMPORT: Omit<Import, "from"> = {
   bindings: [ABILITY_CONTEXT],
-  from: TEMPLATE_IMPORTS.abilityContext,
+};
+export const BUILDERS_UTILS = {
+  dynamicInputs: "dynamicInputs",
+  dynamicColumns: "dynamicColumns",
 };
 
 // Standalone

src/generators/const/endpoints.const.ts

@@ -1,8 +1,9 @@
 import { Import } from "src/generators/types/generate";
 
+export const JSON_APPLICATION_FORMAT = "application/json";
 export const DEFAULT_HEADERS = {
-  "Content-Type": "application/json",
-  Accept: "application/json",
+  "Content-Type": JSON_APPLICATION_FORMAT,
+  Accept: JSON_APPLICATION_FORMAT,
 };
 
 export const BODY_PARAMETER_NAME = "data";

src/generators/const/openapi.const.ts

@@ -9,14 +9,14 @@ export const ALLOWED_PARAM_MEDIA_TYPES = [
 ];
 export const ALLOWED_PATH_IN = ["query", "header", "path"] as Array<OpenAPIV3.ParameterObject["in"]>;
 export const ALLOWED_METHODS = [
-  "get",
-  "put",
-  "post",
-  "delete",
-  "options",
-  "head",
-  "patch",
-  "trace",
+  OpenAPIV3.HttpMethods.GET,
+  OpenAPIV3.HttpMethods.PUT,
+  OpenAPIV3.HttpMethods.POST,
+  OpenAPIV3.HttpMethods.DELETE,
+  OpenAPIV3.HttpMethods.OPTIONS,
+  OpenAPIV3.HttpMethods.HEAD,
+  OpenAPIV3.HttpMethods.PATCH,
+  OpenAPIV3.HttpMethods.TRACE,
 ] as Array<OpenAPIV3.HttpMethods>;
 export const PRIMITIVE_TYPE_LIST = ["string", "number", "integer", "boolean"];
 export const COMPOSITE_KEYWORDS = ["allOf", "anyOf", "oneOf"] as (keyof OpenAPIV3.SchemaObject)[];

src/generators/const/options.const.ts

@@ -1,6 +1,5 @@
 import { GenerateType } from "src/generators/types/generate";
 import { GenerateOptions } from "src/generators/types/options";
-import { TEMPLATE_DATA_TS_PATH, TEMPLATE_IMPORTS } from "./deps.const";
 import { ENUM_SUFFIX, SCHEMA_SUFFIX } from "./zod.const";
 
 export const DEFAULT_GENERATE_OPTIONS: GenerateOptions = {
@@ -13,7 +12,7 @@ export const DEFAULT_GENERATE_OPTIONS: GenerateOptions = {
   excludePathRegex: "",
   excludeRedundantZodSchemas: true,
   tsNamespaces: true,
-  tsPath: TEMPLATE_DATA_TS_PATH,
+  tsPath: "@/data",
   importPath: "ts",
   configs: {
     [GenerateType.Models]: {
@@ -32,6 +31,10 @@ export const DEFAULT_GENERATE_OPTIONS: GenerateOptions = {
       outputFileNameSuffix: "acl",
       namespaceSuffix: "Acl",
     },
+    [GenerateType.Configs]: {
+      outputFileNameSuffix: "configs",
+      namespaceSuffix: "Configs",
+    },
   },
   standalone: false,
   baseUrl: "",
@@ -42,18 +45,33 @@ export const DEFAULT_GENERATE_OPTIONS: GenerateOptions = {
   extractEnums: true,
   replaceOptionalWithNullish: false,
   // Endpoints options
-  restClientImportPath: TEMPLATE_IMPORTS.appRestClient,
-  errorHandlingImportPath: TEMPLATE_IMPORTS.errorHandling,
+  restClientImportPath: "@/util/rest/clients/app-rest-client",
+  errorHandlingImportPath: "@/util/vendor/error-handling",
   removeOperationPrefixEndingWith: "Controller_",
   parseRequestParams: true,
   // Queries options
-  queryTypesImportPath: TEMPLATE_IMPORTS.queryTypes,
+  queryTypesImportPath: "@/types/react-query",
   axiosRequestConfig: false,
-  infiniteQueries: false,
   mutationEffects: true,
+  // Infinite queries options
+  infiniteQueries: false,
+  infiniteQueryParamNames: {
+    page: "page",
+  },
+  infiniteQueryResponseParamNames: {
+    page: "page",
+    totalItems: "totalItems",
+    limit: "limit",
+  },
   // ACL options
   acl: true,
   checkAcl: true,
-  abilityContextImportPath: TEMPLATE_IMPORTS.abilityContext,
+  abilityContextImportPath: "@/data/acl/ability.context",
   abilityContextGenericAppAbilities: false,
+  // Builder Configs options
+  builderConfigs: false,
+  filterParamName: "filter",
+  dataResponseParamNames: ["data", "items"],
+  dynamicInputsImportPath: "@povio/ui",
+  dynamicColumnsImportPath: "@povio/ui",
 };

src/generators/const/queries.const.ts

@@ -10,13 +10,4 @@ export const QUERY_IMPORT: Import = {
   from: "@tanstack/react-query",
 };
 
-export const INFINITE_QUERY_PARAMS = {
-  pageParamName: "page",
-};
-export const INFINITE_QUERY_RESPONSE_PARAMS = {
-  pageParamName: "page",
-  totalItemsName: "totalItems",
-  limitParamName: "limit",
-};
-
 export const QUERIES_MODULE_NAME = "moduleName";