Merge branch 'master' into tsup-codegen

# Conflicts:
#	packages/rtk-query-codegen-openapi/package.json
#	yarn.lock

Author: markerikson

.github/workflows/test-codegen.yml

@@ -67,7 +67,7 @@ jobs:
 
       - name: Did we fail?
         if: failure()
-        run: ls -R
+        run: ls -lR
 
   test:
     needs: build

.github/workflows/tests.yml

@@ -102,67 +102,16 @@ jobs:
       - name: Run type tests with `moduleResolution Bundler`
         run: rm -rf dist && yarn tsc -p . --moduleResolution Bundler --module ESNext --noEmit false --declaration --emitDeclarationOnly --outDir dist --target ESNext && rm -rf dist
 
-  test-type-portability:
-    name: Test Type Portability with TypeScript ${{ matrix.ts }} and Node.js ${{ matrix.node }}
-    needs: [build]
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        node: ['20.x']
-        ts: ['5.0', '5.1', '5.2', '5.3', '5.4', '5.5', 'next']
-        example:
-          [
-            { name: 'bundler', moduleResolution: 'Bundler' },
-            { name: 'nodenext-cjs', moduleResolution: 'NodeNext' },
-            { name: 'nodenext-esm', moduleResolution: 'NodeNext' },
-          ]
-    steps:
-      - name: Checkout repo
-        uses: actions/checkout@v4
-
-      - name: Use node ${{ matrix.node }}
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{ matrix.node }}
-          cache: 'yarn'
-
-      - name: Install deps
-        run: yarn install
-
-      - uses: actions/download-artifact@v4
-        with:
-          name: package
-          path: packages/toolkit
-
-      - name: Install build artifact
-        run: yarn workspace @examples-type-portability/${{ matrix.example.name }} add $(pwd)/package.tgz
-
-      - name: Install TypeScript ${{ matrix.ts }}
-        run: yarn workspace @examples-type-portability/${{ matrix.example.name }} add -D typescript@${{ matrix.ts }}
-
-      - name: Test type portability with `moduleResolution ${{ matrix.example.moduleResolution }}`
-        run: yarn workspace @examples-type-portability/${{ matrix.example.name }} run test
-
-      - name: Test type portability with `moduleResolution Node10`
-        run: yarn workspace @examples-type-portability/${{ matrix.example.name }} run test --module CommonJS --moduleResolution Node10 --preserveSymLinks --verbatimModuleSyntax false
-
-      - name: Test type portability with `moduleResolution Node10` and `type module` in `package.json`
-        if: matrix.example.name == 'nodenext-esm' || matrix.example.name == 'bundler'
-        run: |
-          npm --workspace=@examples-type-portability/${{ matrix.example.name }} pkg set type=module
-          yarn workspace @examples-type-portability/${{ matrix.example.name }} run test --module ESNext --moduleResolution Node10 --preserveSymLinks --verbatimModuleSyntax false
-
   test-types:
-    name: Test Types with TypeScript ${{ matrix.ts }}
+    name: 'Test Types: TS ${{ matrix.ts }}'
 
     needs: [build]
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
         node: ['20.x']
-        ts: ['4.7', '4.8', '4.9', '5.0', '5.1', '5.2', '5.3', '5.4']
+        ts: ['4.7', '4.8', '4.9', '5.0', '5.1', '5.2', '5.3', '5.4', '5.5']
     steps:
       - name: Checkout repo
         uses: actions/checkout@v4
@@ -301,3 +250,54 @@ jobs:
 
       - name: Run are-the-types-wrong
         run: yarn attw ./package.tgz --format table --ignore-rules false-cjs
+
+  test-type-portability:
+    name: 'Test Type Portability: TS ${{ matrix.ts }} + Node ${{ matrix.node }}'
+    needs: [build]
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        node: ['20.x']
+        ts: ['5.3', '5.4', '5.5', 'next']
+        example:
+          [
+            { name: 'bundler', moduleResolution: 'Bundler' },
+            { name: 'nodenext-cjs', moduleResolution: 'NodeNext' },
+            { name: 'nodenext-esm', moduleResolution: 'NodeNext' },
+          ]
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+
+      - name: Use node ${{ matrix.node }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node }}
+          cache: 'yarn'
+
+      - name: Install deps
+        run: yarn install
+
+      - uses: actions/download-artifact@v4
+        with:
+          name: package
+          path: packages/toolkit
+
+      - name: Install build artifact
+        run: yarn workspace @examples-type-portability/${{ matrix.example.name }} add $(pwd)/package.tgz
+
+      - name: Install TypeScript ${{ matrix.ts }}
+        run: yarn workspace @examples-type-portability/${{ matrix.example.name }} add -D typescript@${{ matrix.ts }}
+
+      - name: Test type portability with `moduleResolution ${{ matrix.example.moduleResolution }}`
+        run: yarn workspace @examples-type-portability/${{ matrix.example.name }} run test
+
+      - name: Test type portability with `moduleResolution Node10`
+        run: yarn workspace @examples-type-portability/${{ matrix.example.name }} run test --module CommonJS --moduleResolution Node10 --preserveSymLinks --verbatimModuleSyntax false
+
+      - name: Test type portability with `moduleResolution Node10` and `type module` in `package.json`
+        if: matrix.example.name == 'nodenext-esm' || matrix.example.name == 'bundler'
+        run: |
+          npm --workspace=@examples-type-portability/${{ matrix.example.name }} pkg set type=module
+          yarn workspace @examples-type-portability/${{ matrix.example.name }} run test --module ESNext --moduleResolution Node10 --preserveSymLinks --verbatimModuleSyntax false

.yarnrc.yml

@@ -5,3 +5,5 @@ enableGlobalCache: false
 nodeLinker: node-modules
 
 yarnPath: .yarn/releases/yarn-4.1.0.cjs
+
+enableTransparentWorkspaces: false

docs/api/actionCreatorMiddleware.mdx

@@ -12,7 +12,7 @@ hide_title: true
 A custom middleware that detects if an action creator has been mistakenly dispatched, instead of being called before dispatching.
 
 A common mistake is to call `dispatch(actionCreator)` instead of `dispatch(actionCreator())`.
-This tends to "work" as the action creator has the static `type` property, but can lead to unexpected behaviour.
+This tends to "work" as the action creator has the static `type` property, but can lead to unexpected behavior.
 
 ## Options
 

docs/api/combineSlices.mdx

@@ -213,7 +213,7 @@ const reducerWithUser = rootReducer.inject(userSlice, {
 ```
 
 This may be useful for hot reload, or "removing" a reducer by replacing it with a function that always returns `null`.
-Note that for predictable behaviour, your types should account for all of the possible reducers you intend to occupy a path.
+Note that for predictable behavior, your types should account for all of the possible reducers you intend to occupy a path.
 
 ```ts no-transpile title="'Removing' a reducer, by replacing it with a no-op function"
 declare module '.' {

docs/rtk-query/api/created-api/hooks.mdx

@@ -460,7 +460,7 @@ type UseQuerySubscriptionResult = {
 
   - `arg`: The argument passed to the query defined in the endpoint.
     You can also pass in `skipToken` here as an alternative way of skipping the query, see [skipToken](#skiptoken)
-  - `options`: A set of options that control the fetching behaviour of the hook
+  - `options`: A set of options that control the fetching behavior of the hook
 
 - **Returns**
   - An object containing a function to `refetch` the data

docs/rtk-query/usage/automated-refetching.mdx

@@ -108,7 +108,7 @@ By declaring these tags as what can possibly be provided to the cache, it enable
 
 ### Providing cache data
 
-Each individual `query` endpoint can have its cached data _provide_ particular tags. Doing so enables a relationship between cached data from one or more query endpoints and the behaviour of one or more mutation endpoints.
+Each individual `query` endpoint can have its cached data _provide_ particular tags. Doing so enables a relationship between cached data from one or more query endpoints and the behavior of one or more mutation endpoints.
 
 The `providesTags` property on a `query` endpoint is used for this purpose.
 
@@ -237,7 +237,7 @@ In order to provide stronger control over invalidating the appropriate data, you
 
 ### Invalidating cache data
 
-Each individual mutation endpoint can `invalidate` particular tags for existing cached data. Doing so enables a relationship between cached data from one or more query endpoints and the behaviour of one or more mutation endpoints.
+Each individual mutation endpoint can `invalidate` particular tags for existing cached data. Doing so enables a relationship between cached data from one or more query endpoints and the behavior of one or more mutation endpoints.
 
 The `invalidatesTags` property on a mutation endpoint is used for this purpose.
 
@@ -621,7 +621,7 @@ A powerful use-case is to use an ID like `'LIST'` as a label for data provided b
 
 :::
 
-We can compare the scenarios below to see how using a `'LIST'` id can be leveraged to optimize behaviour.
+We can compare the scenarios below to see how using a `'LIST'` id can be leveraged to optimize behavior.
 
 #### Invalidating everything of a type
 
@@ -774,7 +774,7 @@ If you intend for the `addPost` mutation to refresh all posts including individu
 
 The information provided to the cache is not limited to successful data fetches. The concept can be used to inform RTK Query that when a particular failure has been encountered, to `provide` a specific `tag` for that failed cache data. A separate endpoint can then `invalidate` the data for that `tag`, telling RTK Query to re-attempt the previously failed endpoints if a component is still subscribed to the failed data.
 
-The example below demonstrates an example with the following behaviour:
+The example below demonstrates an example with the following behavior:
 
 - Provides an `UNAUTHORIZED` cache tag if a query fails with an error code of `401 UNAUTHORIZED`
 - Provides an `UNKNOWN_ERROR` cache tag if a query fails with a different error

docs/rtk-query/usage/cache-behavior.mdx

@@ -12,7 +12,7 @@ description: 'RTK Query > Usage > Cache Behavior: defaults, cache lifetimes, and
 
 A key feature of RTK Query is its management of cached data. When data is fetched from the server, RTK Query will store the data in the Redux store as a 'cache'. When an additional request is performed for the same data, RTK Query will provide the existing cached data rather than sending an additional request to the server.
 
-RTK Query provides a number of concepts and tools to manipulate the cache behaviour and adjust it to your needs.
+RTK Query provides a number of concepts and tools to manipulate the cache behavior and adjust it to your needs.
 
 ## Default Cache Behavior
 
@@ -73,7 +73,7 @@ If 'ComponentThree' is unmounted in the example above, regardless of how much ti
 
 ## Manipulating Cache Behavior
 
-On top of the default behaviour, RTK Query provides a number of methods to re-fetch data earlier in scenarios where it should be considered invalid, or is otherwise deemed suitable to be 'refreshed'.
+On top of the default behavior, RTK Query provides a number of methods to re-fetch data earlier in scenarios where it should be considered invalid, or is otherwise deemed suitable to be 'refreshed'.
 
 ### Reducing subscription time with `keepUnusedDataFor`
 

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

@@ -64,7 +64,7 @@ npx @rtk-query/codegen-openapi openapi-config.ts
 
 #### Generating tags
 
-If your OpenAPI specification uses [tags](https://swagger.io/docs/specification/grouping-operations-with-tags/), you can specify the `tag` option to the codegen.  
+If your OpenAPI specification uses [tags](https://swagger.io/docs/specification/grouping-operations-with-tags/), you can specify the `tag` option to the codegen.
 That will result in all generated endpoints having `providesTags`/`invalidatesTags` declarations for the `tags` of their respective operation definition.
 
 Note that this will only result in string tags with no ids, so it might lead to scenarios where too much is invalidated and unneccessary requests are made on mutation.
@@ -108,6 +108,8 @@ interface SimpleUsage {
     | Array<string | RegExp | EndpointMatcherFunction>
   endpointOverrides?: EndpointOverrides[]
   flattenArg?: boolean
+  useEnumType?: boolean
+  httpResolverOptions?: SwaggerParser.HTTPResolverOptions
 }
 
 export type EndpointMatcherFunction = (
@@ -119,7 +121,7 @@ export type EndpointMatcherFunction = (
 #### Filtering endpoints
 
 If you only want to include a few endpoints, you can use the `filterEndpoints` config option to filter your endpoints.
-Note that endpoints are transformed to camel case. For example, `login_user` will become `loginUser`. 
+Note that endpoints are transformed to camel case. For example, `login_user` will become `loginUser`.
 `filterEndpoints` will be checked against this camel case version of the endpoint.
 
 ```ts no-transpile title="openapi-config.ts"
@@ -146,6 +148,34 @@ const withOverride: ConfigFile = {
 }
 ```
 
+You can also filter the parameters that are included for an endpoint, as long as they aren't a path parameter. This filter is of type `ParameterMatcher`. For example, to only include parameters that begin with "x-" for the 'loginUser' endpoint, see the below example.
+
+```ts no-transpile title="openapi-config.ts"
+const withOverride: ConfigFile = {
+  // ...
+  endpointOverrides: [
+    {
+      pattern: 'loginUser',
+      parameterFilter: /^x-/,
+    },
+  ],
+}
+```
+
+For more complex requirements, consider the other possible matchers, such as a `ParameterMatcherFunction`. The below example filters out any parameters that are in the header of the request.
+
+```ts no-transpile title="openapi-config.ts"
+const withOverride: ConfigFile = {
+  // ...
+  endpointOverrides: [
+    {
+      pattern: /.*/,
+      parameterFilter: (_name, parameter) => parameter.in !== 'header',
+    },
+  ],
+}
+```
+
 #### Generating hooks
 
 Setting `hooks: true` will generate `useQuery` and `useMutation` hook exports. If you also want `useLazyQuery` hooks generated or more granular control, you can also pass an object in the shape of: `{ queries: boolean; lazyQueries: boolean; mutations: boolean }`.
@@ -169,3 +199,24 @@ const config: ConfigFile = {
   },
 }
 ```
+
+#### Custom HTTP resolver options
+
+If you need to customize the HTTP request issued to your server, you user the `httpResolverOptions` option. This object is passed directly to the `SwaggerParser` instance that fetches the OpenAPI schema.
+
+For example, you can pass custom headers or set a custom request timeout.
+
+```ts no-transpile title="openapi-config.ts"
+const config: ConfigFile = {
+  schemaFile: 'https://petstore3.swagger.io/api/v3/openapi.json',
+  apiFile: './src/store/emptyApi.ts',
+  outputFile: './src/store/petApi.ts',
+  httpResolverOptions: {
+    timeout: 30_000,
+    headers: {
+      Accept: 'application/json',
+      Authorization: 'Basic cmVkdXgtdG9vbGtpdDppcy1ncmVhdA==',
+    },
+  },
+}
+```

docs/rtk-query/usage/customizing-create-api.mdx

@@ -76,9 +76,9 @@ If you want to create your own module, you should review [the react-hooks module
 Here is a very stripped down version:
 
 ```ts no-transpile
-import { CoreModule } from '@internal/core/module'
 import {
   BaseQueryFn,
+  CoreModule,
   EndpointDefinitions,
   Api,
   Module,
@@ -89,7 +89,7 @@ import {
 export const customModuleName = Symbol()
 export type CustomModule = typeof customModuleName
 
-declare module '../apiTypes' {
+declare module '@reduxjs/toolkit/query' {
   export interface ApiModules<
     BaseQuery extends BaseQueryFn,
     Definitions extends EndpointDefinitions,