@povio/openapi-codegen-cli 1.1.1 → 1.2.0

package/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,6 +98,8 @@ 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
 ```
@@ -104,6 +107,7 @@ yarn openapi-codegen generate --config my-config.ts
 #### 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/dist/commands/generate.d.ts

@@ -4,5 +4,5 @@ export type GenerateParams = {
     excludeTags?: string;
     prettier?: boolean;
     verbose?: boolean;
-} & Partial<Pick<GenerateOptions, "input" | "output" | "tsNamespaces" | "tsPath" | "splitByTags" | "defaultTag" | "removeOperationPrefixEndingWith" | "importPath" | "extractEnums" | "acl" | "checkAcl" | "standalone" | "baseUrl" | "replaceOptionalWithNullish" | "infiniteQueries" | "axiosRequestConfig" | "mutationEffects" | "parseRequestParams">>;
+} & Partial<Pick<GenerateOptions, "input" | "output" | "tsNamespaces" | "tsPath" | "splitByTags" | "defaultTag" | "removeOperationPrefixEndingWith" | "importPath" | "extractEnums" | "acl" | "checkAcl" | "standalone" | "baseUrl" | "replaceOptionalWithNullish" | "infiniteQueries" | "axiosRequestConfig" | "mutationEffects" | "parseRequestParams" | "builderConfigs">>;
 export declare function generate({ prettier, verbose, config: configParam, ...params }: GenerateParams): Promise<void>;

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

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

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

@@ -6,20 +6,17 @@ export declare const QUERY_OPTIONS_TYPES: {
     mutation: string;
 };
 export declare const TEMPLATE_DATA_FILE_PATH = "src/data";
-export declare const TEMPLATE_DATA_TS_PATH = "@/data";
-export declare const TEMPLATE_IMPORTS: {
-    appRestClient: string;
-    queryTypes: string;
-    errorHandling: string;
-    abilityContext: string;
-};
 export declare const ERROR_HANDLERS: {
     ErrorHandler: string;
     SharedErrorHandler: string;
 };
-export declare const ERROR_HANDLING_IMPORT: Import;
+export declare const ERROR_HANDLING_IMPORT: Omit<Import, "from">;
 export declare const ABILITY_CONTEXT = "AbilityContext";
-export declare const ABILITY_CONTEXT_IMPORT: Import;
+export declare const ABILITY_CONTEXT_IMPORT: Omit<Import, "from">;
+export declare const BUILDERS_UTILS: {
+    dynamicInputs: string;
+    dynamicColumns: string;
+};
 export declare enum StandaloneAssetEnum {
     ReactQueryTypes = "reactQueryTypes",
     RestClient = "restClient",

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

@@ -1,4 +1,5 @@
 import { Import } from "src/generators/types/generate";
+export declare const JSON_APPLICATION_FORMAT = "application/json";
 export declare const DEFAULT_HEADERS: {
     "Content-Type": string;
     Accept: string;

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

@@ -4,4 +4,4 @@ export declare const ALLOWED_PARAM_MEDIA_TYPES: string[];
 export declare const ALLOWED_PATH_IN: string[];
 export declare const ALLOWED_METHODS: OpenAPIV3.HttpMethods[];
 export declare const PRIMITIVE_TYPE_LIST: string[];
-export declare const COMPOSITE_KEYWORDS: ("required" | "type" | "default" | "title" | "pattern" | "description" | "externalDocs" | "deprecated" | "enum" | "nullable" | "format" | "multipleOf" | "maximum" | "exclusiveMaximum" | "minimum" | "exclusiveMinimum" | "maxLength" | "minLength" | "additionalProperties" | "maxItems" | "minItems" | "uniqueItems" | "maxProperties" | "minProperties" | "properties" | "allOf" | "oneOf" | "anyOf" | "not" | "discriminator" | "readOnly" | "writeOnly" | "xml" | "example")[];
+export declare const COMPOSITE_KEYWORDS: ("type" | "title" | "description" | "format" | "default" | "multipleOf" | "maximum" | "exclusiveMaximum" | "minimum" | "exclusiveMinimum" | "maxLength" | "minLength" | "pattern" | "additionalProperties" | "maxItems" | "minItems" | "uniqueItems" | "maxProperties" | "minProperties" | "required" | "enum" | "properties" | "allOf" | "oneOf" | "anyOf" | "not" | "nullable" | "discriminator" | "readOnly" | "writeOnly" | "xml" | "externalDocs" | "example" | "deprecated")[];

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

@@ -5,12 +5,4 @@ export declare const QUERY_HOOKS: {
     mutation: string;
 };
 export declare const QUERY_IMPORT: Import;
-export declare const INFINITE_QUERY_PARAMS: {
-    pageParamName: string;
-};
-export declare const INFINITE_QUERY_RESPONSE_PARAMS: {
-    pageParamName: string;
-    totalItemsName: string;
-    limitParamName: string;
-};
 export declare const QUERIES_MODULE_NAME = "moduleName";

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

@@ -6,6 +6,7 @@ export declare const PARAM_SCHEMA_SUFFIX = "Param";
 export declare const RESPONSE_SCHEMA_SUFFIX = "Response";
 export declare const ERROR_RESPONSE_SCHEMA_SUFFIX = "ErrorResponse";
 export declare const VOID_SCHEMA = "z.void()";
+export declare const ANY_SCHEMA = "z.any()";
 export declare const BLOB_SCHEMA = "z.instanceof(Blob)";
 export declare const ENUM_SCHEMA = "z.enum";
 export declare const INT_SCHEMA = "z.int()";

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

@@ -62,7 +62,7 @@ export declare class SchemaResolver {
     isSchemaCircular(ref: string): boolean;
     getCircularSchemaChain(ref: string, currentRef?: string, chain?: never[], visited?: string[]): string[];
     getBaseUrl(): string;
-    getZodSchemaObj(zodSchemaName: string): OpenAPIV3.ReferenceObject | OpenAPIV3.SchemaObject | undefined;
+    getZodSchemaObj(zodSchemaName: string): OpenAPIV3.SchemaObject | OpenAPIV3.ReferenceObject | undefined;
     private getSchemaDataByRef;
     private getExtractedEnumZodSchemaDataByName;
     private initialize;

package/dist/generators/core/endpoints/getEndpointsFromOpenAPIDoc.d.ts

@@ -1,3 +1,3 @@
-import { Endpoint } from "src/generators/types/endpoint";
 import { SchemaResolver } from "src/generators/core/SchemaResolver.class";
+import { Endpoint } from "src/generators/types/endpoint";
 export declare function getEndpointsFromOpenAPIDoc(resolver: SchemaResolver): Endpoint[];

package/dist/generators/core/endpoints/getEndpointsFromOpenAPIDoc.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/generators/core/getMetadataFromOpenAPIDoc.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/generators/core/openapi/getOpenAPISchemaComplexity.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/generators/core/openapi/getOpenAPISchemaDependencyGraph.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/generators/core/zod/getZodSchema.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,2 @@
+import { GenerateTypeParams } from "src/generators/types/generate";
+export declare function generateConfigs(generateTypeParams: GenerateTypeParams): string | undefined;

package/dist/generators/types/builder-config.d.ts

@@ -0,0 +1,49 @@
+export interface DynamicInputsConfig {
+    schema: string;
+    options: {
+        inputs: Record<string, boolean>;
+    };
+}
+export interface DynamicColumnsConfig {
+    schema: string;
+    options: {
+        columns: Record<string, boolean>;
+        sortable?: string;
+    };
+}
+export interface BuilderConfig {
+    name: string;
+    title: string;
+    readAll: {
+        acl?: string;
+        schema: string;
+        paginated: string;
+        infinite: string;
+        filters?: DynamicInputsConfig;
+        columns?: DynamicColumnsConfig;
+    };
+    read?: {
+        acl?: string;
+        schema: string;
+        query: string;
+    };
+    create?: {
+        acl?: string;
+        mutation: string;
+        inputDefs?: DynamicInputsConfig;
+    };
+    update?: {
+        acl?: string;
+        mutation: string;
+        inputDefs?: DynamicInputsConfig;
+    };
+    delete?: {
+        acl?: string;
+        mutation: string;
+    };
+    bulkDelete?: {
+        acl?: string;
+        mutation: string;
+        inputDefs?: DynamicInputsConfig;
+    };
+}

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

@@ -44,4 +44,7 @@ export interface Endpoint {
     mediaUpload?: boolean;
     mediaDownload?: boolean;
 }
+export interface ExtendedEndpoint extends Endpoint {
+    pathSegments: string[];
+}
 export {};

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

@@ -20,7 +20,8 @@ export declare enum GenerateType {
     Models = "models",
     Endpoints = "endpoints",
     Queries = "queries",
-    Acl = "acl"
+    Acl = "acl",
+    Configs = "configs"
 }
 export type GenerateData = Map<string, {
     endpoints: Endpoint[];
@@ -29,7 +30,7 @@ export type GenerateData = Map<string, {
 export interface GenerateTypeParams {
     resolver: SchemaResolver;
     data: GenerateData;
-    tag?: string;
+    tag: string;
 }
 export interface GenerateFileData {
     fileName: string;

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

@@ -19,15 +19,32 @@ interface EndpointsGenerateOptions {
 interface QueriesGenerateOptions {
     queryTypesImportPath: string;
     axiosRequestConfig?: boolean;
-    infiniteQueries?: boolean;
     mutationEffects?: boolean;
 }
-interface ACLOptions {
+interface InfiniteQueriesGenerateOptions {
+    infiniteQueries?: boolean;
+    infiniteQueryParamNames: {
+        page: string;
+    };
+    infiniteQueryResponseParamNames: {
+        page: string;
+        totalItems: string;
+        limit: string;
+    };
+}
+interface ACLGenerateOptions {
     acl: boolean;
     checkAcl?: boolean;
     abilityContextImportPath: string;
     abilityContextGenericAppAbilities: boolean;
 }
+interface BuilderConfigsGenerateOptions {
+    builderConfigs?: boolean;
+    filterParamName: string;
+    dataResponseParamNames: string[];
+    dynamicInputsImportPath: string;
+    dynamicColumnsImportPath: string;
+}
 interface GenerateConfig {
     outputFileNameSuffix: string;
     namespaceSuffix: string;
@@ -47,5 +64,6 @@ interface BaseGenerateOptions {
     standalone: boolean;
     baseUrl: string;
 }
-export type GenerateOptions = BaseGenerateOptions & ZodGenerateOptions & EndpointsGenerateOptions & QueriesGenerateOptions & ACLOptions;
+export interface GenerateOptions extends BaseGenerateOptions, ZodGenerateOptions, EndpointsGenerateOptions, QueriesGenerateOptions, InfiniteQueriesGenerateOptions, ACLGenerateOptions, BuilderConfigsGenerateOptions {
+}
 export {};

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

@@ -0,0 +1,12 @@
+import { Endpoint, ExtendedEndpoint } from "src/generators/types/endpoint";
+import { GenerateOptions } from "src/generators/types/options";
+export declare const isGetEndpoint: (endpoint: Endpoint) => boolean;
+export declare const isPaginatedGetEndpoint: (endpoint: Endpoint, options: GenerateOptions) => boolean;
+export declare const isReadAllEndpoint: (endpoint: ExtendedEndpoint, options: GenerateOptions) => boolean;
+export declare const isReadEndpoint: (endpoint: ExtendedEndpoint, readAllEndpoint: ExtendedEndpoint) => boolean | undefined;
+export declare const isCreateEndpoint: (endpoint: ExtendedEndpoint, readAllEndpoint: ExtendedEndpoint) => boolean;
+export declare const isUpdateEndpoint: (endpoint: ExtendedEndpoint, readAllEndpoint: ExtendedEndpoint) => boolean | undefined;
+export declare const isDeleteEndpoint: (endpoint: ExtendedEndpoint, readAllEndpoint: ExtendedEndpoint) => boolean | undefined;
+export declare const isBulkDeleteEndpoint: (endpoint: ExtendedEndpoint, readAllEndpoint: ExtendedEndpoint) => boolean;
+export declare const getPathSegments: (path: string) => string[];
+export declare const isPathSegmentParam: (pathSegment?: string) => boolean | undefined;

package/dist/generators/utils/endpoint.utils.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,15 @@
+import { BuilderConfig } from "src/generators/types/builder-config";
+import { GenerateTypeParams } from "src/generators/types/generate";
+export declare function getBuilderConfigs({ data, tag, resolver }: GenerateTypeParams): {
+    configs: never[];
+    hasZodImport?: undefined;
+    modelsImports?: undefined;
+    queriesImports?: undefined;
+    aclImports?: undefined;
+} | {
+    configs: BuilderConfig[];
+    hasZodImport: boolean;
+    modelsImports: import("src/generators/types/generate").Import[];
+    queriesImports: import("src/generators/types/generate").Import[];
+    aclImports: import("src/generators/types/generate").Import[];
+};

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

@@ -1,14 +1,13 @@
 import { OpenAPIV3 } from "openapi-types";
 import { SchemaResolver } from "src/generators/core/SchemaResolver.class";
-import { GenerateOptions } from "src/generators/types/options";
 import { Endpoint } from "src/generators/types/endpoint";
+import { GenerateOptions } from "src/generators/types/options";
 export declare const getEndpointName: (endpoint: Endpoint) => string;
 export declare function getImportedEndpointName(endpoint: Endpoint, options: GenerateOptions): string;
 export declare const requiresBody: (endpoint: Endpoint) => boolean;
 export declare const getEndpointBody: (endpoint: Endpoint) => import("src/generators/types/endpoint").EndpointParameter | undefined;
 export declare const hasEndpointConfig: (endpoint: Endpoint, resolver: SchemaResolver) => boolean | undefined;
 export declare const getEndpointPath: (endpoint: Endpoint) => string;
-export declare function getEndpointTag(endpoint: Endpoint, options: GenerateOptions): string;
 export declare function mapEndpointParamsToFunctionParams(resolver: SchemaResolver, endpoint: Endpoint, options?: {
     excludeBodyParam?: boolean;
     excludePageParam?: boolean;
@@ -20,7 +19,7 @@ export declare function mapEndpointParamsToFunctionParams(resolver: SchemaResolv
     name: string;
     required: boolean;
     type: string;
-    paramType: "Body" | "Query" | "Header" | "Path";
+    paramType: "Query" | "Body" | "Header" | "Path";
     parameterObject: import("../../types/openapi").ParameterObject | undefined;
     bodyObject: OpenAPIV3.RequestBodyObject | undefined;
 }[];
@@ -30,7 +29,7 @@ export declare function getEndpointConfig(endpoint: Endpoint): {
         name: string;
         value: string;
         description?: string | undefined;
-        type: "Body" | "Query" | "Header" | "Path";
+        type: "Query" | "Body" | "Header" | "Path";
         zodSchema: string;
         parameterObject?: import("../../types/openapi").ParameterObject | undefined;
         parameterSortingEnumSchemaName?: string | undefined;

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

@@ -13,6 +13,16 @@ export declare function getEndpointsImports({ tag, endpoints, options, }: {
     endpoints: Endpoint[];
     options: GenerateOptions;
 }): Import[];
+export declare function getQueriesImports({ tag, endpoints, options, }: {
+    tag: string;
+    endpoints: Endpoint[];
+    options: GenerateOptions;
+}): Import[];
+export declare function getInfiniteQueriesImports({ tag, endpoints, options, }: {
+    tag: string;
+    endpoints: Endpoint[];
+    options: GenerateOptions;
+}): Import[];
 export declare function getAclImports({ tag, endpoints, options, }: {
     tag: string;
     endpoints: Endpoint[];

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

@@ -0,0 +1 @@
+export {};

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

@@ -1,3 +1,6 @@
 import { Endpoint } from "src/generators/types/endpoint";
+import { GenerateOptions } from "src/generators/types/options";
 export declare const getQueryName: (endpoint: Endpoint, mutation?: boolean) => string;
 export declare const getInfiniteQueryName: (endpoint: Endpoint) => string;
+export declare const getImportedQueryName: (endpoint: Endpoint, options: GenerateOptions) => string;
+export declare const getImportedInfiniteQueryName: (endpoint: Endpoint, options: GenerateOptions) => string;

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

@@ -9,11 +9,6 @@ declare function getTagFileNameWithoutExtension({ type, tag, options, includeTag
 }): 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 declare function getAppRestClientImportPath(options: GenerateOptions): string;
 export declare function getQueryTypesImportPath(options: GenerateOptions): string;
 export declare function getQueryModulesImportPath(options: GenerateOptions): string;

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

@@ -5,7 +5,7 @@ import { GenerateOptions } from "src/generators/types/options";
 export declare const getZodSchemaInferedTypeName: (zodSchemaName: string, options: GenerateOptions) => string;
 export declare const getImportedZodSchemaName: (resolver: SchemaResolver, zodSchemaName: string) => string;
 export declare const getImportedZodSchemaInferedTypeName: (resolver: SchemaResolver, zodSchemaName: string, currentTag?: string) => string;
-export declare function getZodSchemaType(data: GenerateZodSchemaData): OpenAPIV3.NonArraySchemaObjectType | "array" | "enum";
+export declare function getZodSchemaType(data: GenerateZodSchemaData): "enum" | "array" | OpenAPIV3.NonArraySchemaObjectType;
 export declare function getZodSchemaDescription(data: GenerateZodSchemaData): string | undefined;
 export declare function getZodSchemaPropertyDescriptions(resolver: SchemaResolver, data: GenerateZodSchemaData, tag: string): never[] | Record<string, {
     type: string;

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

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

package/dist/generators/utils/js.utils.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,7 @@
+import { GenerateType } from "src/generators/types/generate";
+import { GenerateOptions } from "src/generators/types/options";
+export declare const getNamespaceName: ({ type, tag, options, }: {
+    type: GenerateType;
+    tag: string;
+    options: GenerateOptions;
+}) => string;

package/dist/generators/utils/object.utils.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -3,10 +3,10 @@ export declare function isReferenceObject(obj: unknown): obj is OpenAPIV3.Refere
 export declare function isSchemaObject(schema: OpenAPIV3.SchemaObject | OpenAPIV3.ReferenceObject): schema is OpenAPIV3.SchemaObject;
 export declare function isArraySchemaObject(schema: OpenAPIV3.SchemaObject): schema is OpenAPIV3.ArraySchemaObject;
 export declare function inferRequiredSchema(schema: OpenAPIV3.SchemaObject): {
-    noRequiredOnlyAllof: (OpenAPIV3.ReferenceObject | OpenAPIV3.SchemaObject)[];
+    noRequiredOnlyAllof: (OpenAPIV3.SchemaObject | OpenAPIV3.ReferenceObject)[];
     composedRequiredSchema: {
         properties: {
-            [propertyName: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.SchemaObject;
+            [propertyName: string]: OpenAPIV3.SchemaObject | OpenAPIV3.ReferenceObject;
         };
         type: "object";
         required: string[];

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1 @@
+export {};

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

@@ -1,6 +1,7 @@
 import { SchemaResolver } from "src/generators/core/SchemaResolver.class";
 import { Endpoint } from "src/generators/types/endpoint";
+import { GenerateOptions } from "src/generators/types/options";
 export declare const isQuery: (endpoint: Endpoint) => boolean;
 export declare const isMutation: (endpoint: Endpoint) => boolean;
-export declare const isInfiniteQuery: (endpoint: Endpoint, infiniteQueryParams?: string[]) => boolean;
+export declare const isInfiniteQuery: (endpoint: Endpoint, options: GenerateOptions) => boolean;
 export declare const getDestructuredVariables: (resolver: SchemaResolver, endpoint: Endpoint, updateQueryEndpoints: Endpoint[]) => string[];

package/dist/generators/utils/string.utils.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -1,5 +1,7 @@
+import { Endpoint } from "src/generators/types/endpoint";
 import { OperationObject } from "src/generators/types/openapi";
 import { GenerateOptions } from "src/generators/types/options";
 export declare function formatTag(tag: string): string;
 export declare function getOperationTag(operation: OperationObject, options: GenerateOptions): string;
+export declare function getEndpointTag(endpoint: Endpoint, options: GenerateOptions): string;
 export declare function isTagExcluded(tag: string, options: GenerateOptions): boolean;