@acrool/rtk-query-codegen-openapi 0.0.7 → 0.0.9

package/README.md

@@ -15,6 +15,39 @@ Code Generator
 
 This is a utility library meant to be used with [RTK Query](https://redux-toolkit.js.org/rtk-query/overview) that will generate a typed API client from an OpenAPI schema.
 
+### Features
+
+- **Local Schema File Support**: Direct processing of local schema files via `schemaFile`
+- **Remote Schema Download**: Download remote schemas to local files via `remoteFile` and `schemaFile`
+- **Type Generation**: Generates TypeScript types from OpenAPI schemas
+- **RTK Query Integration**: Seamless integration with RTK Query
+
+### Configuration Options
+
+- `schemaFile`: The local OpenAPI schema file path (required)
+- `remoteFile`: (Optional) Remote schema URL to download to `schemaFile` path
+- `outputFile`: The output file path for generated code
+- `apiFile`: The base API file path
+
+### Example Configuration
+
+```typescript
+// For remote schemas with download
+{
+  schemaFile: './schemas/api-schema.json',
+  remoteFile: 'https://api.example.com/openapi.json',
+  apiFile: './baseApi',
+  outputFile: './generated-api.ts'
+}
+
+// For local schema files
+{
+  schemaFile: './schemas/api-schema.json',
+  apiFile: './baseApi',
+  outputFile: './generated-api.ts'
+}
+```
+
 ### Documentation
 
 [View the RTK Query Code Generation docs](https://redux-toolkit.js.org/rtk-query/usage/code-generation)

package/lib/index.d.mts

@@ -27,9 +27,13 @@ type GenerationOptions = Id<CommonOptions & Optional<OutputFileOptions, 'outputF
 interface CommonOptions {
     apiFile: string;
     /**
-     * filename or url
+     * local schema file path (only supports local files)
      */
     schemaFile: string;
+    /**
+     * remote schema file URL (when provided, will download to schemaFile path)
+     */
+    remoteFile?: string;
     /**
      * defaults to "api"
      */
@@ -107,6 +111,11 @@ interface CommonOptions {
      * resolution mechanism will be used.
      */
     prettierConfigFile?: string;
+    /**
+     * defaults to "@acrool/react-fetcher"
+     * File path for importing IRestFulEndpointsQueryReturn type
+     */
+    endpointsQueryReturnTypeFile?: string;
 }
 type TextMatcher = string | RegExp | (string | RegExp)[];
 type EndpointMatcherFunction = (operationName: string, operationDefinition: OperationDefinition) => boolean;
@@ -117,6 +126,7 @@ 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
@@ -131,10 +141,10 @@ type EndpointOverrides = {
     parameterFilter: ParameterMatcher;
 }>;
 type OutputFilesConfig = {
-    [outputFile: string]: {
-        groupMatch: RegExp;
-        filterEndpoint?: (groupName: string) => RegExp;
-    };
+    groupKeyMatch: (path: string) => string;
+    outputDir: string;
+    queryMatch?: (method: string, path: string) => boolean;
+    filterEndpoint?: (groupName: string) => RegExp;
 };
 type ConfigFile = Id<Require<CommonOptions & OutputFileOptions, 'outputFile'>> | Id<Omit<CommonOptions, 'outputFile'> & {
     outputFiles: OutputFilesConfig;

package/lib/index.d.ts

@@ -27,9 +27,13 @@ type GenerationOptions = Id<CommonOptions & Optional<OutputFileOptions, 'outputF
 interface CommonOptions {
     apiFile: string;
     /**
-     * filename or url
+     * local schema file path (only supports local files)
      */
     schemaFile: string;
+    /**
+     * remote schema file URL (when provided, will download to schemaFile path)
+     */
+    remoteFile?: string;
     /**
      * defaults to "api"
      */
@@ -107,6 +111,11 @@ interface CommonOptions {
      * resolution mechanism will be used.
      */
     prettierConfigFile?: string;
+    /**
+     * defaults to "@acrool/react-fetcher"
+     * File path for importing IRestFulEndpointsQueryReturn type
+     */
+    endpointsQueryReturnTypeFile?: string;
 }
 type TextMatcher = string | RegExp | (string | RegExp)[];
 type EndpointMatcherFunction = (operationName: string, operationDefinition: OperationDefinition) => boolean;
@@ -117,6 +126,7 @@ 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
@@ -131,10 +141,10 @@ type EndpointOverrides = {
     parameterFilter: ParameterMatcher;
 }>;
 type OutputFilesConfig = {
-    [outputFile: string]: {
-        groupMatch: RegExp;
-        filterEndpoint?: (groupName: string) => RegExp;
-    };
+    groupKeyMatch: (path: string) => string;
+    outputDir: string;
+    queryMatch?: (method: string, path: string) => boolean;
+    filterEndpoint?: (groupName: string) => RegExp;
 };
 type ConfigFile = Id<Require<CommonOptions & OutputFileOptions, 'outputFile'>> | Id<Omit<CommonOptions, 'outputFile'> & {
     outputFiles: OutputFilesConfig;