@acrool/rtk-query-codegen-openapi 0.0.1

package/README.md

@@ -0,0 +1,20 @@
+<p align="center">
+  <img src="https://raw.githubusercontent.com/rtk-incubator/rtk-query/main/logo.png" width="400" />
+</p>
+<h2 align="center">
+Code Generator
+</h2>
+
+<p align="center">
+   <a href="https://discord.gg/0ZcbPKXt5bZ6au5t" target="_blank">
+    <img src="https://img.shields.io/badge/chat-online-green" alt="Discord server" />
+  </a>
+</p>
+
+### Introduction
+
+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.
+
+### Documentation
+
+[View the RTK Query Code Generation docs](https://redux-toolkit.js.org/rtk-query/usage/code-generation)

package/lib/bin/cli.mjs

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+import{fileURLToPath as l}from"node:url";var p=()=>l(import.meta.url);var c=p();import{generateEndpoints as m,parseConfig as f}from"@acrool/rtk-query-codegen-openapi";import r from"commander";import{createRequire as u}from"node:module";import{dirname as g,resolve as d}from"node:path";var e=u(c),o=!1;try{e.resolve("esbuild")&&e.resolve("esbuild-runner")&&e("esbuild-runner/register"),o=!0}catch{}try{o||(e.resolve("typescript")&&e.resolve("ts-node")&&e("ts-node").register({transpileOnly:!0,compilerOptions:{target:"es6",module:"commonjs"}}),o=!0)}catch{}var h=e("../../package.json");r.version(h.version).usage("</path/to/config.js>").parse(process.argv);var t=r.args[0];r.args.length===0||!/\.([mc]?(jsx?|tsx?)|jsonc?)?$/.test(t)?r.help():(/\.[mc]?tsx?$/.test(t)&&!o&&(console.error("Encountered a TypeScript configfile, but neither esbuild-runner nor ts-node are installed."),process.exit(1)),v(d(process.cwd(),t)));async function v(s){process.chdir(g(s));let n=e(s);for(let i of f(n.default??n))try{console.log(`Generating ${i.outputFile}`),await m(i),console.log("Done")}catch(a){console.error(a),process.exit(1)}}
+//# sourceMappingURL=cli.mjs.map

package/lib/bin/cli.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../node_modules/tsup/assets/esm_shims.js","../../src/bin/cli.ts"],"sourcesContent":["// Shim globals in esm bundle\nimport path from 'node:path'\nimport { fileURLToPath } from 'node:url'\n\nconst getFilename = () => fileURLToPath(import.meta.url)\nconst getDirname = () => path.dirname(getFilename())\n\nexport const __dirname = /* @__PURE__ */ getDirname()\nexport const __filename = /* @__PURE__ */ getFilename()\n","#!/usr/bin/env node\n\nimport { generateEndpoints, parseConfig } from '@acrool/rtk-query-codegen-openapi';\nimport program from 'commander';\nimport { createRequire } from 'node:module';\nimport { dirname, resolve } from 'node:path';\n\nconst require = createRequire(__filename);\n\nlet ts = false;\ntry {\n  if (require.resolve('esbuild') && require.resolve('esbuild-runner')) {\n    require('esbuild-runner/register');\n  }\n  ts = true;\n} catch {}\n\ntry {\n  if (!ts) {\n    if (require.resolve('typescript') && require.resolve('ts-node')) {\n      (require('ts-node') as typeof import('ts-node')).register({\n        transpileOnly: true,\n        compilerOptions: {\n          target: 'es6',\n          module: 'commonjs',\n        },\n      });\n    }\n\n    ts = true;\n  }\n} catch {}\n\n// tslint:disable-next-line\nconst meta = require('../../package.json');\n\nprogram.version(meta.version).usage('</path/to/config.js>').parse(process.argv);\n\nconst configFile = program.args[0];\n\nif (program.args.length === 0 || !/\\.([mc]?(jsx?|tsx?)|jsonc?)?$/.test(configFile)) {\n  program.help();\n} else {\n  if (/\\.[mc]?tsx?$/.test(configFile) && !ts) {\n    console.error('Encountered a TypeScript configfile, but neither esbuild-runner nor ts-node are installed.');\n    process.exit(1);\n  }\n  run(resolve(process.cwd(), configFile));\n}\n\nasync function run(configFile: string) {\n  process.chdir(dirname(configFile));\n\n  const unparsedConfig = require(configFile);\n\n  for (const config of parseConfig(unparsedConfig.default ?? unparsedConfig)) {\n    try {\n      console.log(`Generating ${config.outputFile}`);\n      await generateEndpoints(config);\n      console.log(`Done`);\n    } catch (err) {\n      console.error(err);\n      process.exit(1);\n    }\n  }\n}\n"],"mappings":";AAEA,OAAS,iBAAAA,MAAqB,WAE9B,IAAMC,EAAc,IAAMD,EAAc,YAAY,GAAG,EAIhD,IAAME,EAA6BC,EAAY,ECNtD,OAAS,qBAAAC,EAAmB,eAAAC,MAAmB,oCAC/C,OAAOC,MAAa,YACpB,OAAS,iBAAAC,MAAqB,cAC9B,OAAS,WAAAC,EAAS,WAAAC,MAAe,YAEjC,IAAMC,EAAUH,EAAcI,CAAU,EAEpCC,EAAK,GACT,GAAI,CACEF,EAAQ,QAAQ,SAAS,GAAKA,EAAQ,QAAQ,gBAAgB,GAChEA,EAAQ,yBAAyB,EAEnCE,EAAK,EACP,MAAQ,CAAC,CAET,GAAI,CACGA,IACCF,EAAQ,QAAQ,YAAY,GAAKA,EAAQ,QAAQ,SAAS,GAC3DA,EAAQ,SAAS,EAA+B,SAAS,CACxD,cAAe,GACf,gBAAiB,CACf,OAAQ,MACR,OAAQ,UACV,CACF,CAAC,EAGHE,EAAK,GAET,MAAQ,CAAC,CAGT,IAAMC,EAAOH,EAAQ,oBAAoB,EAEzCJ,EAAQ,QAAQO,EAAK,OAAO,EAAE,MAAM,sBAAsB,EAAE,MAAM,QAAQ,IAAI,EAE9E,IAAMC,EAAaR,EAAQ,KAAK,CAAC,EAE7BA,EAAQ,KAAK,SAAW,GAAK,CAAC,gCAAgC,KAAKQ,CAAU,EAC/ER,EAAQ,KAAK,GAET,eAAe,KAAKQ,CAAU,GAAK,CAACF,IACtC,QAAQ,MAAM,4FAA4F,EAC1G,QAAQ,KAAK,CAAC,GAEhBG,EAAIN,EAAQ,QAAQ,IAAI,EAAGK,CAAU,CAAC,GAGxC,eAAeC,EAAID,EAAoB,CACrC,QAAQ,MAAMN,EAAQM,CAAU,CAAC,EAEjC,IAAME,EAAiBN,EAAQI,CAAU,EAEzC,QAAWG,KAAUZ,EAAYW,EAAe,SAAWA,CAAc,EACvE,GAAI,CACF,QAAQ,IAAI,cAAcC,EAAO,UAAU,EAAE,EAC7C,MAAMb,EAAkBa,CAAM,EAC9B,QAAQ,IAAI,MAAM,CACpB,OAASC,EAAK,CACZ,QAAQ,MAAMA,CAAG,EACjB,QAAQ,KAAK,CAAC,CAChB,CAEJ","names":["fileURLToPath","getFilename","__filename","getFilename","generateEndpoints","parseConfig","program","createRequire","dirname","resolve","require","__filename","ts","meta","configFile","run","unparsedConfig","config","err"]}

package/lib/index.d.mts

@@ -0,0 +1,141 @@
+import SwaggerParser from '@apidevtools/swagger-parser';
+import { OpenAPIV3 } from 'openapi-types';
+
+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 Optional<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"];
+type GenerationOptions = Id<CommonOptions & Optional<OutputFileOptions, 'outputFile'> & {
+    isDataResponse?(code: string, includeDefault: boolean, response: OpenAPIV3.ResponseObject, allResponses: OpenAPIV3.ResponsesObject): boolean;
+}>;
+interface CommonOptions {
+    apiFile: string;
+    /**
+     * filename or url
+     */
+    schemaFile: string;
+    /**
+     * defaults to "api"
+     */
+    apiImport?: string;
+    /**
+     * defaults to "enhancedApi"
+     */
+    exportName?: string;
+    /**
+     * defaults to "ApiArg"
+     */
+    argSuffix?: string;
+    /**
+     * defaults to "ApiResponse"
+     */
+    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;
+}
+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[];
+    /**
+     * defaults to false
+     * If passed as true it will generate TS enums instead of union of strings
+     */
+    useEnumType?: boolean;
+}
+type EndpointOverrides = {
+    pattern: EndpointMatcher;
+} & AtLeastOneKey<{
+    type: 'mutation' | 'query';
+    parameterFilter: ParameterMatcher;
+}>;
+type ConfigFile = Id<Require<CommonOptions & OutputFileOptions, 'outputFile'>> | Id<Omit<CommonOptions, 'outputFile'> & {
+    outputFiles: {
+        [outputFile: string]: Omit<OutputFileOptions, 'outputFile'>;
+    };
+}>;
+
+declare function generateEndpoints(options: GenerationOptions): Promise<string | void>;
+declare function parseConfig(fullConfig: ConfigFile): (CommonOptions & OutputFileOptions)[];
+
+export { type ConfigFile, generateEndpoints, parseConfig };

package/lib/index.d.ts

@@ -0,0 +1,141 @@
+import SwaggerParser from '@apidevtools/swagger-parser';
+import { OpenAPIV3 } from 'openapi-types';
+
+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 Optional<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"];
+type GenerationOptions = Id<CommonOptions & Optional<OutputFileOptions, 'outputFile'> & {
+    isDataResponse?(code: string, includeDefault: boolean, response: OpenAPIV3.ResponseObject, allResponses: OpenAPIV3.ResponsesObject): boolean;
+}>;
+interface CommonOptions {
+    apiFile: string;
+    /**
+     * filename or url
+     */
+    schemaFile: string;
+    /**
+     * defaults to "api"
+     */
+    apiImport?: string;
+    /**
+     * defaults to "enhancedApi"
+     */
+    exportName?: string;
+    /**
+     * defaults to "ApiArg"
+     */
+    argSuffix?: string;
+    /**
+     * defaults to "ApiResponse"
+     */
+    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;
+}
+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[];
+    /**
+     * defaults to false
+     * If passed as true it will generate TS enums instead of union of strings
+     */
+    useEnumType?: boolean;
+}
+type EndpointOverrides = {
+    pattern: EndpointMatcher;
+} & AtLeastOneKey<{
+    type: 'mutation' | 'query';
+    parameterFilter: ParameterMatcher;
+}>;
+type ConfigFile = Id<Require<CommonOptions & OutputFileOptions, 'outputFile'>> | Id<Omit<CommonOptions, 'outputFile'> & {
+    outputFiles: {
+        [outputFile: string]: Omit<OutputFileOptions, 'outputFile'>;
+    };
+}>;
+
+declare function generateEndpoints(options: GenerationOptions): Promise<string | void>;
+declare function parseConfig(fullConfig: ConfigFile): (CommonOptions & OutputFileOptions)[];
+
+export { type ConfigFile, generateEndpoints, parseConfig };