@bitstack/ng-query-codegen-openapi 0.0.30

package/lib/index.d.mts

@@ -0,0 +1,191 @@
+import SwaggerParser from '@apidevtools/swagger-parser';
+import { OpenAPIV3 } from 'openapi-types';
+
+/**
+ * 群組配置介面
+ */
+interface GroupConfig {
+    outputDir: string;
+    groupKeyMatch: (path: string) => string | null;
+    filterEndpoint?: (operationName: string, path: string, groupKey: string) => boolean;
+    queryMatch?: (operationName: string) => boolean;
+}
+
+type OperationDefinition = {
+    path: string;
+    verb: (typeof operationKeys)[number];
+    pathItem: OpenAPIV3.PathItemObject;
+    operation: OpenAPIV3.OperationObject;
+};
+type ParameterDefinition = OpenAPIV3.ParameterObject;
+type Require<T, K extends keyof T> = {
+    [k in K]-?: NonNullable<T[k]>;
+} & Omit<T, K>;
+type Id<T> = {
+    [K in keyof T]: T[K];
+} & {};
+type AtLeastOneKey<T> = {
+    [K in keyof T]-?: Pick<T, K> & Partial<T>;
+}[keyof T];
+declare const operationKeys: readonly ["get", "put", "post", "delete", "options", "head", "patch", "trace"];
+interface CommonOptions {
+    /**
+     * local schema file path (only supports local files)
+     */
+    schemaFile: string;
+    /**
+     * remote schema file URL (when provided, will download to schemaFile path)
+     */
+    remoteFile?: string;
+    /**
+     * Configuration for WebApiConfiguration import
+     * defaults to { file: "@core/api/web-api-configuration", importName: "WebApiConfiguration" }
+     */
+    apiConfiguration?: {
+        file: string;
+        importName: string;
+    };
+    /**
+     * HttpClient for WebApiConfiguration import
+     * defaults to { file: "@core/httpClient/webapi/webapi-http-client.providers", importName: "WEBAPI_HTTP_CLIENT" }
+     */
+    httpClient?: {
+        file: string;
+        importName: string;
+    };
+    /**
+     * defaults to "enhancedApi"
+     */
+    exportName?: string;
+    /**
+     * defaults to "Req"
+     */
+    argSuffix?: string;
+    /**
+     * defaults to "Res"
+     */
+    responseSuffix?: string;
+    /**
+     * defaults to empty
+     */
+    operationNameSuffix?: string;
+    /**
+     * defaults to `false`
+     * `true` will generate hooks for queries and mutations, but no lazyQueries
+     */
+    hooks?: boolean | {
+        queries: boolean;
+        lazyQueries: boolean;
+        mutations: boolean;
+    };
+    /**
+     * defaults to false
+     * `true` will generate a union type for `undefined` properties like: `{ id?: string | undefined }` instead of `{ id?: string }`
+     */
+    unionUndefined?: boolean;
+    /**
+     * defaults to false
+     * `true` will result in all generated endpoints having `providesTags`/`invalidatesTags` declarations for the `tags` of their respective operation definition
+     * @see https://redux-toolkit.js.org/rtk-query/usage/code-generation for more information
+     */
+    tag?: boolean;
+    /**
+     * defaults to false
+     * `true` will add `encodeURIComponent` to the generated path parameters
+     */
+    encodePathParams?: boolean;
+    /**
+     * defaults to false
+     * `true` will add `encodeURIComponent` to the generated query parameters
+     */
+    encodeQueryParams?: boolean;
+    /**
+     * defaults to false
+     * `true` will "flatten" the arg so that you can do things like `useGetEntityById(1)` instead of `useGetEntityById({ entityId: 1 })`
+     */
+    flattenArg?: boolean;
+    /**
+     * default to false
+     * If set to `true`, the default response type will be included in the generated code for all endpoints.
+     * @see https://swagger.io/docs/specification/describing-responses/#default
+     */
+    includeDefault?: boolean;
+    /**
+     * default to false
+     * `true` will not generate separate types for read-only and write-only properties.
+     */
+    mergeReadWriteOnly?: boolean;
+    /**
+     *
+     * HTTPResolverOptions object that is passed to the SwaggerParser bundle function.
+     */
+    httpResolverOptions?: SwaggerParser.HTTPResolverOptions;
+    /**
+     * defaults to undefined
+     * If present the given file will be used as prettier config when formatting the generated code. If undefined the default prettier config
+     * resolution mechanism will be used.
+     */
+    prettierConfigFile?: string;
+    /**
+     * defaults to "@acrool/react-fetcher"
+     * File path for importing IRestFulEndpointsQueryReturn type
+     */
+    endpointsQueryReturnTypeFile?: string;
+    /**
+     * defaults to 60 (seconds)
+     * Number of seconds to wait before refetching data when component mounts or args change
+     */
+    refetchOnMountOrArgChange?: number;
+}
+type TextMatcher = string | RegExp | (string | RegExp)[];
+type EndpointMatcherFunction = (operationName: string, operationDefinition: OperationDefinition) => boolean;
+type EndpointMatcher = TextMatcher | EndpointMatcherFunction;
+type ParameterMatcherFunction = (parameterName: string, parameterDefinition: ParameterDefinition) => boolean;
+type ParameterMatcher = TextMatcher | ParameterMatcherFunction;
+interface OutputFileOptions extends Partial<CommonOptions> {
+    outputFile: string;
+    filterEndpoints?: EndpointMatcher;
+    endpointOverrides?: EndpointOverrides[];
+    queryMatch?: (method: string, path: string) => boolean;
+    /**
+     * defaults to false
+     * If passed as true it will generate TS enums instead of union of strings
+     */
+    useEnumType?: boolean;
+    sharedTypesFile?: string;
+    /**
+     * groupKey for service class naming, e.g., "room" -> "RoomService"
+     */
+    groupKey?: string;
+}
+type EndpointOverrides = {
+    pattern: EndpointMatcher;
+} & AtLeastOneKey<{
+    type: 'mutation' | 'query';
+    parameterFilter: ParameterMatcher;
+}>;
+type OutputFilesConfig = {
+    groupKeyMatch: (path: string) => string;
+    outputDir: string;
+    queryMatch?: (method: string, path: string) => boolean;
+    filterEndpoint?: (operationName: string, path: string, groupKey: string) => boolean;
+};
+type ConfigFile = Id<Require<CommonOptions & OutputFileOptions, 'outputFile'>> | Id<Omit<CommonOptions, 'outputFile'> & {
+    outputFiles: OutputFilesConfig;
+}>;
+
+/**
+ * 統一代碼生成器選項
+ */
+interface UnifiedGenerationOptions extends CommonOptions {
+    outputFiles: GroupConfig;
+    remoteFile?: string;
+}
+
+/**
+ * 產生 Endpoints - 直接使用統一代碼生成器
+ * @param options - 端點生成選項
+ */
+declare function generateEndpoints(options: UnifiedGenerationOptions): Promise<string | void>;
+
+export { type ConfigFile, type OutputFilesConfig, generateEndpoints };

package/lib/index.d.ts

@@ -0,0 +1,191 @@
+import SwaggerParser from '@apidevtools/swagger-parser';
+import { OpenAPIV3 } from 'openapi-types';
+
+/**
+ * 群組配置介面
+ */
+interface GroupConfig {
+    outputDir: string;
+    groupKeyMatch: (path: string) => string | null;
+    filterEndpoint?: (operationName: string, path: string, groupKey: string) => boolean;
+    queryMatch?: (operationName: string) => boolean;
+}
+
+type OperationDefinition = {
+    path: string;
+    verb: (typeof operationKeys)[number];
+    pathItem: OpenAPIV3.PathItemObject;
+    operation: OpenAPIV3.OperationObject;
+};
+type ParameterDefinition = OpenAPIV3.ParameterObject;
+type Require<T, K extends keyof T> = {
+    [k in K]-?: NonNullable<T[k]>;
+} & Omit<T, K>;
+type Id<T> = {
+    [K in keyof T]: T[K];
+} & {};
+type AtLeastOneKey<T> = {
+    [K in keyof T]-?: Pick<T, K> & Partial<T>;
+}[keyof T];
+declare const operationKeys: readonly ["get", "put", "post", "delete", "options", "head", "patch", "trace"];
+interface CommonOptions {
+    /**
+     * local schema file path (only supports local files)
+     */
+    schemaFile: string;
+    /**
+     * remote schema file URL (when provided, will download to schemaFile path)
+     */
+    remoteFile?: string;
+    /**
+     * Configuration for WebApiConfiguration import
+     * defaults to { file: "@core/api/web-api-configuration", importName: "WebApiConfiguration" }
+     */
+    apiConfiguration?: {
+        file: string;
+        importName: string;
+    };
+    /**
+     * HttpClient for WebApiConfiguration import
+     * defaults to { file: "@core/httpClient/webapi/webapi-http-client.providers", importName: "WEBAPI_HTTP_CLIENT" }
+     */
+    httpClient?: {
+        file: string;
+        importName: string;
+    };
+    /**
+     * defaults to "enhancedApi"
+     */
+    exportName?: string;
+    /**
+     * defaults to "Req"
+     */
+    argSuffix?: string;
+    /**
+     * defaults to "Res"
+     */
+    responseSuffix?: string;
+    /**
+     * defaults to empty
+     */
+    operationNameSuffix?: string;
+    /**
+     * defaults to `false`
+     * `true` will generate hooks for queries and mutations, but no lazyQueries
+     */
+    hooks?: boolean | {
+        queries: boolean;
+        lazyQueries: boolean;
+        mutations: boolean;
+    };
+    /**
+     * defaults to false
+     * `true` will generate a union type for `undefined` properties like: `{ id?: string | undefined }` instead of `{ id?: string }`
+     */
+    unionUndefined?: boolean;
+    /**
+     * defaults to false
+     * `true` will result in all generated endpoints having `providesTags`/`invalidatesTags` declarations for the `tags` of their respective operation definition
+     * @see https://redux-toolkit.js.org/rtk-query/usage/code-generation for more information
+     */
+    tag?: boolean;
+    /**
+     * defaults to false
+     * `true` will add `encodeURIComponent` to the generated path parameters
+     */
+    encodePathParams?: boolean;
+    /**
+     * defaults to false
+     * `true` will add `encodeURIComponent` to the generated query parameters
+     */
+    encodeQueryParams?: boolean;
+    /**
+     * defaults to false
+     * `true` will "flatten" the arg so that you can do things like `useGetEntityById(1)` instead of `useGetEntityById({ entityId: 1 })`
+     */
+    flattenArg?: boolean;
+    /**
+     * default to false
+     * If set to `true`, the default response type will be included in the generated code for all endpoints.
+     * @see https://swagger.io/docs/specification/describing-responses/#default
+     */
+    includeDefault?: boolean;
+    /**
+     * default to false
+     * `true` will not generate separate types for read-only and write-only properties.
+     */
+    mergeReadWriteOnly?: boolean;
+    /**
+     *
+     * HTTPResolverOptions object that is passed to the SwaggerParser bundle function.
+     */
+    httpResolverOptions?: SwaggerParser.HTTPResolverOptions;
+    /**
+     * defaults to undefined
+     * If present the given file will be used as prettier config when formatting the generated code. If undefined the default prettier config
+     * resolution mechanism will be used.
+     */
+    prettierConfigFile?: string;
+    /**
+     * defaults to "@acrool/react-fetcher"
+     * File path for importing IRestFulEndpointsQueryReturn type
+     */
+    endpointsQueryReturnTypeFile?: string;
+    /**
+     * defaults to 60 (seconds)
+     * Number of seconds to wait before refetching data when component mounts or args change
+     */
+    refetchOnMountOrArgChange?: number;
+}
+type TextMatcher = string | RegExp | (string | RegExp)[];
+type EndpointMatcherFunction = (operationName: string, operationDefinition: OperationDefinition) => boolean;
+type EndpointMatcher = TextMatcher | EndpointMatcherFunction;
+type ParameterMatcherFunction = (parameterName: string, parameterDefinition: ParameterDefinition) => boolean;
+type ParameterMatcher = TextMatcher | ParameterMatcherFunction;
+interface OutputFileOptions extends Partial<CommonOptions> {
+    outputFile: string;
+    filterEndpoints?: EndpointMatcher;
+    endpointOverrides?: EndpointOverrides[];
+    queryMatch?: (method: string, path: string) => boolean;
+    /**
+     * defaults to false
+     * If passed as true it will generate TS enums instead of union of strings
+     */
+    useEnumType?: boolean;
+    sharedTypesFile?: string;
+    /**
+     * groupKey for service class naming, e.g., "room" -> "RoomService"
+     */
+    groupKey?: string;
+}
+type EndpointOverrides = {
+    pattern: EndpointMatcher;
+} & AtLeastOneKey<{
+    type: 'mutation' | 'query';
+    parameterFilter: ParameterMatcher;
+}>;
+type OutputFilesConfig = {
+    groupKeyMatch: (path: string) => string;
+    outputDir: string;
+    queryMatch?: (method: string, path: string) => boolean;
+    filterEndpoint?: (operationName: string, path: string, groupKey: string) => boolean;
+};
+type ConfigFile = Id<Require<CommonOptions & OutputFileOptions, 'outputFile'>> | Id<Omit<CommonOptions, 'outputFile'> & {
+    outputFiles: OutputFilesConfig;
+}>;
+
+/**
+ * 統一代碼生成器選項
+ */
+interface UnifiedGenerationOptions extends CommonOptions {
+    outputFiles: GroupConfig;
+    remoteFile?: string;
+}
+
+/**
+ * 產生 Endpoints - 直接使用統一代碼生成器
+ * @param options - 端點生成選項
+ */
+declare function generateEndpoints(options: UnifiedGenerationOptions): Promise<string | void>;
+
+export { type ConfigFile, type OutputFilesConfig, generateEndpoints };