Merge branch 'reduxjs:master' into chore/upgrade-graphql-request

Author: eyesfocus

.github/workflows/test-codegen.yml

@@ -147,4 +147,4 @@ jobs:
           name: package
 
       - name: Run are-the-types-wrong
-        run: yarn dlx @arethetypeswrong/cli@latest ./package.tgz --format table
+        run: yarn dlx @arethetypeswrong/cli@latest ./package.tgz --format table --exclude-entrypoints cli

.gitignore

@@ -31,4 +31,8 @@ typesversions
 .pnp.*
 *.tgz
 
-tsconfig.vitest-temp.json
+tsconfig.vitest-temp.json
+
+# node version manager files
+.node-version
+.nvmrc

docs/rtk-query/usage/code-generation.mdx

@@ -84,6 +84,17 @@ const api = await generateEndpoints({
 })
 ```
 
+#### With Node.js Child process
+
+```ts no-transpile title="bin/openapi-codegen.ts"
+import { exec } from 'node:child_process'
+
+const cliPath = require.resolve('@rtk-query/codegen-openapi/cli')
+
+// you can also use esbuild-runner (esr) or ts-node instead of tsx
+exec(`tsx ${cliPath} config.ts`)
+```
+
 ### Config file options
 
 #### Simple usage

packages/rtk-query-codegen-openapi/package.json

@@ -18,7 +18,8 @@
         "types": "./lib/index.d.ts",
         "default": "./lib/index.js"
       }
-    }
+    },
+    "./cli": "./lib/bin/cli.mjs"
   },
   "repository": {
     "type": "git",
@@ -77,7 +78,7 @@
     "@apidevtools/swagger-parser": "^10.1.1",
     "commander": "^6.2.0",
     "lodash.camelcase": "^4.3.0",
-    "oazapfts": "^6.1.0",
+    "oazapfts": "^6.3.0",
     "prettier": "^3.2.5",
     "semver": "^7.3.5",
     "swagger2openapi": "^7.0.4",

packages/rtk-query-codegen-openapi/src/generate.ts

@@ -117,6 +117,7 @@ export async function generateApi(
     useEnumType = false,
     mergeReadWriteOnly = false,
     httpResolverOptions,
+    useUnknown = false,
   }: GenerationOptions
 ) {
   const v3Doc = (v3DocCache[spec] ??= await getV3Doc(spec, httpResolverOptions));
@@ -125,6 +126,7 @@ export async function generateApi(
     unionUndefined,
     useEnumType,
     mergeReadWriteOnly,
+    useUnknown,
   });
 
   // temporary workaround for https://github.com/oazapfts/oazapfts/issues/491
@@ -448,7 +450,11 @@ export async function generateApi(
         const encodedValue =
           encodeQueryParams && param.param?.in === 'query'
             ? factory.createConditionalExpression(
-                value,
+                factory.createBinaryExpression(
+                  value,
+                  ts.SyntaxKind.ExclamationEqualsToken,
+                  factory.createNull()
+                ),
                 undefined,
                 factory.createCallExpression(factory.createIdentifier('encodeURIComponent'), undefined, [
                   factory.createCallExpression(factory.createIdentifier('String'), undefined, [value]),

packages/rtk-query-codegen-openapi/src/types.ts

@@ -38,79 +38,89 @@ export interface CommonOptions {
    */
   schemaFile: string;
   /**
-   * defaults to "api"
+   * @default "api"
    */
   apiImport?: string;
   /**
-   * defaults to "enhancedApi"
+   * @default "enhancedApi"
    */
   exportName?: string;
   /**
-   * defaults to "ApiArg"
+   * @default "ApiArg"
    */
   argSuffix?: string;
   /**
-   * defaults to "ApiResponse"
+   * @default "ApiResponse"
    */
   responseSuffix?: string;
   /**
-   * defaults to empty
+   * @default ""
    */
   operationNameSuffix?: string;
   /**
-   * defaults to `false`
    * `true` will generate hooks for queries and mutations, but no lazyQueries
+   * @default false
    */
   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 }`
+   * @default false
    */
   unionUndefined?: boolean;
   /**
-   * defaults to false
    * `true` will result in all generated endpoints having `providesTags`/`invalidatesTags` declarations for the `tags` of their respective operation definition
+   * @default false
    * @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
+   * @default false
    */
   encodePathParams?: boolean;
   /**
-   * defaults to false
    * `true` will add `encodeURIComponent` to the generated query parameters
+   * @default false
    */
   encodeQueryParams?: boolean;
   /**
-   * defaults to false
    * `true` will "flatten" the arg so that you can do things like `useGetEntityById(1)` instead of `useGetEntityById({ entityId: 1 })`
+   * @default false
    */
   flattenArg?: boolean;
   /**
-   * default to false
    * If set to `true`, the default response type will be included in the generated code for all endpoints.
+   * @default false
    * @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.
+   * @default false
    */
   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.
+   * @default undefined
    */
   prettierConfigFile?: string;
+
+  /**
+   * Determines the fallback type for empty schemas.
+   *
+   * If set to **`true`**, **`unknown`** will be used
+   * instead of **`any`** when a schema is empty.
+   *
+   * @default false
+   * @since 2.1.0
+   */
+  useUnknown?: boolean;
 }
 
 export type TextMatcher = string | RegExp | (string | RegExp)[];
@@ -128,8 +138,8 @@ export interface OutputFileOptions extends Partial<CommonOptions> {
   filterEndpoints?: EndpointMatcher;
   endpointOverrides?: EndpointOverrides[];
   /**
-   * defaults to false
    * If passed as true it will generate TS enums instead of union of strings
+   * @default false
    */
   useEnumType?: boolean;
 }

packages/rtk-query-codegen-openapi/test/generateEndpoints.test.ts

@@ -242,7 +242,7 @@ describe('option encodeQueryParams', () => {
     });
 
     expect(api).toMatch(
-      /params:\s*{\s*\n\s*status:\s*queryArg\.status\s*\?\s*encodeURIComponent\(\s*String\(queryArg\.status\)\s*\)\s*:\s*undefined\s*,?\s*\n\s*}/s
+      /params:\s*{\s*\n\s*status:\s*queryArg\.status\s*!=\s*null\s*\?\s*encodeURIComponent\(\s*String\(queryArg\.status\)\s*\)\s*:\s*undefined\s*,?\s*\n\s*}/s
     );
   });
 

packages/toolkit/src/createSlice.ts

@@ -23,7 +23,11 @@ import type {
   ReducerWithInitialState,
 } from './createReducer'
 import { createReducer } from './createReducer'
-import type { ActionReducerMapBuilder, TypedActionCreator } from './mapBuilders'
+import type {
+  ActionReducerMapBuilder,
+  AsyncThunkReducers,
+  TypedActionCreator,
+} from './mapBuilders'
 import { executeReducerBuilderCallback } from './mapBuilders'
 import type { Id, TypeGuard } from './tsHelpers'
 import { getOrInsertComputed } from './utils'
@@ -300,25 +304,7 @@ type AsyncThunkSliceReducerConfig<
   ThunkArg extends any,
   Returned = unknown,
   ThunkApiConfig extends AsyncThunkConfig = {},
-> = {
-  pending?: CaseReducer<
-    State,
-    ReturnType<AsyncThunk<Returned, ThunkArg, ThunkApiConfig>['pending']>
-  >
-  rejected?: CaseReducer<
-    State,
-    ReturnType<AsyncThunk<Returned, ThunkArg, ThunkApiConfig>['rejected']>
-  >
-  fulfilled?: CaseReducer<
-    State,
-    ReturnType<AsyncThunk<Returned, ThunkArg, ThunkApiConfig>['fulfilled']>
-  >
-  settled?: CaseReducer<
-    State,
-    ReturnType<
-      AsyncThunk<Returned, ThunkArg, ThunkApiConfig>['rejected' | 'fulfilled']
-    >
-  >
+> = AsyncThunkReducers<State, ThunkArg, Returned, ThunkApiConfig> & {
   options?: AsyncThunkOptions<ThunkArg, ThunkApiConfig>
 }
 

packages/toolkit/src/index.ts

@@ -10,7 +10,7 @@ export {
   original,
   isDraft,
 } from 'immer'
-export type { Draft } from 'immer'
+export type { Draft, WritableDraft } from 'immer'
 export {
   createSelector,
   createSelectorCreator,

packages/toolkit/src/mapBuilders.ts

@@ -5,6 +5,33 @@ import type {
   ActionMatcherDescriptionCollection,
 } from './createReducer'
 import type { TypeGuard } from './tsHelpers'
+import type { AsyncThunk, AsyncThunkConfig } from './createAsyncThunk'
+
+export type AsyncThunkReducers<
+  State,
+  ThunkArg extends any,
+  Returned = unknown,
+  ThunkApiConfig extends AsyncThunkConfig = {},
+> = {
+  pending?: CaseReducer<
+    State,
+    ReturnType<AsyncThunk<Returned, ThunkArg, ThunkApiConfig>['pending']>
+  >
+  rejected?: CaseReducer<
+    State,
+    ReturnType<AsyncThunk<Returned, ThunkArg, ThunkApiConfig>['rejected']>
+  >
+  fulfilled?: CaseReducer<
+    State,
+    ReturnType<AsyncThunk<Returned, ThunkArg, ThunkApiConfig>['fulfilled']>
+  >
+  settled?: CaseReducer<
+    State,
+    ReturnType<
+      AsyncThunk<Returned, ThunkArg, ThunkApiConfig>['rejected' | 'fulfilled']
+    >
+  >
+}
 
 export type TypedActionCreator<Type extends string> = {
   (...args: any[]): Action<Type>
@@ -31,7 +58,7 @@ export interface ActionReducerMapBuilder<State> {
   /**
    * Adds a case reducer to handle a single exact action type.
    * @remarks
-   * All calls to `builder.addCase` must come before any calls to `builder.addMatcher` or `builder.addDefaultCase`.
+   * All calls to `builder.addCase` must come before any calls to `builder.addAsyncThunk`, `builder.addMatcher` or `builder.addDefaultCase`.
    * @param actionCreator - Either a plain action type string, or an action creator generated by [`createAction`](./createAction) that can be used to determine the action type.
    * @param reducer - The actual case reducer function.
    */
@@ -40,12 +67,28 @@ export interface ActionReducerMapBuilder<State> {
     reducer: CaseReducer<State, A>,
   ): ActionReducerMapBuilder<State>
 
+  /**
+   * Adds case reducers to handle actions based on a `AsyncThunk` action creator.
+   * @remarks
+   * All calls to `builder.addAsyncThunk` must come before after any calls to `builder.addCase` and before any calls to `builder.addMatcher` or `builder.addDefaultCase`.
+   * @param asyncThunk - The async thunk action creator itself.
+   * @param reducers - A mapping from each of the `AsyncThunk` action types to the case reducer that should handle those actions.
+   */
+  addAsyncThunk<
+    Returned,
+    ThunkArg,
+    ThunkApiConfig extends AsyncThunkConfig = {},
+  >(
+    asyncThunk: AsyncThunk<Returned, ThunkArg, ThunkApiConfig>,
+    reducers: AsyncThunkReducers<State, ThunkArg, Returned, ThunkApiConfig>,
+  ): Omit<ActionReducerMapBuilder<State>, 'addCase'>
+
   /**
    * Allows you to match your incoming actions against your own filter function instead of only the `action.type` property.
    * @remarks
    * If multiple matcher reducers match, all of them will be executed in the order
    * they were defined in - even if a case reducer already matched.
-   * All calls to `builder.addMatcher` must come after any calls to `builder.addCase` and before any calls to `builder.addDefaultCase`.
+   * All calls to `builder.addMatcher` must come after any calls to `builder.addCase` and `builder.addAsyncThunk` and before any calls to `builder.addDefaultCase`.
    * @param matcher - A matcher function. In TypeScript, this should be a [type predicate](https://www.typescriptlang.org/docs/handbook/2/narrowing.html#using-type-predicates)
    *   function
    * @param reducer - The actual case reducer function.
@@ -99,7 +142,7 @@ const reducer = createReducer(initialState, (builder) => {
   addMatcher<A>(
     matcher: TypeGuard<A> | ((action: any) => boolean),
     reducer: CaseReducer<State, A extends Action ? A : A & Action>,
-  ): Omit<ActionReducerMapBuilder<State>, 'addCase'>
+  ): Omit<ActionReducerMapBuilder<State>, 'addCase' | 'addAsyncThunk'>
 
   /**
    * Adds a "default case" reducer that is executed if no case reducer and no matcher
@@ -173,6 +216,35 @@ export function executeReducerBuilderCallback<S>(
       actionsMap[type] = reducer
       return builder
     },
+    addAsyncThunk<
+      Returned,
+      ThunkArg,
+      ThunkApiConfig extends AsyncThunkConfig = {},
+    >(
+      asyncThunk: AsyncThunk<Returned, ThunkArg, ThunkApiConfig>,
+      reducers: AsyncThunkReducers<S, ThunkArg, Returned, ThunkApiConfig>,
+    ) {
+      if (process.env.NODE_ENV !== 'production') {
+        // since this uses both action cases and matchers, we can't enforce the order in runtime other than checking for default case
+        if (defaultCaseReducer) {
+          throw new Error(
+            '`builder.addAsyncThunk` should only be called before calling `builder.addDefaultCase`',
+          )
+        }
+      }
+      if (reducers.pending)
+        actionsMap[asyncThunk.pending.type] = reducers.pending
+      if (reducers.rejected)
+        actionsMap[asyncThunk.rejected.type] = reducers.rejected
+      if (reducers.fulfilled)
+        actionsMap[asyncThunk.fulfilled.type] = reducers.fulfilled
+      if (reducers.settled)
+        actionMatchers.push({
+          matcher: asyncThunk.settled,
+          reducer: reducers.settled,
+        })
+      return builder
+    },
     addMatcher<A>(
       matcher: TypeGuard<A>,
       reducer: CaseReducer<S, A extends Action ? A : A & Action>,