Merge branch 'master' into create-slice-creators

Author: EskiMojo14

.github/workflows/test-codegen.yml

@@ -1,7 +1,7 @@
 # This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
 # For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
 
-name: RTK-Query OpenAPI Codegen Tests
+name: RTKQ OpenAPI Codegen
 defaults:
   run:
     working-directory: ./packages/rtk-query-codegen-openapi
@@ -23,24 +23,128 @@ jobs:
             codegen:
               - 'packages/rtk-query-codegen-openapi/**'
               - 'yarn.lock'
+              - '.github/workflows/test-codegen.yml'
 
   build:
-    needs: changes
+    needs: [changes]
     if: ${{ needs.changes.outputs.codegen == 'true' }}
 
-    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./packages/rtk-query-codegen-openapi
+
+    runs-on: ${{ matrix.os }}
+
+    name: 'Build artifact: ${{ matrix.os }} + Node ${{ matrix.node-version }}'
 
     strategy:
       matrix:
         node-version: ['20.x']
+        os: [ubuntu-latest]
 
     steps:
-      - uses: actions/checkout@v4
-      - name: Use Node.js ${{ matrix.node-version }}
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Node ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'yarn'
+
+      - name: Install dependencies
+        run: yarn install
+
+      - name: Pack
+        run: yarn pack
+
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        id: artifact-upload-step
+        with:
+          name: package
+          path: ./packages/rtk-query-codegen-openapi/package.tgz
+
+      - name: Did we fail?
+        if: failure()
+        run: ls -lR
+
+  test:
+    needs: build
+    defaults:
+      run:
+        working-directory: ./packages/rtk-query-codegen-openapi
+    name: 'Test build artifact: ${{ matrix.os }} + Node ${{ matrix.node-version }}'
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        node-version: [20.x]
+        os: [ubuntu-latest]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Node ${{ matrix.node-version }}
         uses: actions/setup-node@v4
         with:
-          node-version: ${{ matrix.node }}
+          node-version: ${{ matrix.node-version }}
           cache: 'yarn'
 
-      - run: yarn install
-      - run: yarn test
+      - name: Download artifact
+        id: download-artifact
+        uses: actions/download-artifact@v4
+        with:
+          path: ./packages/rtk-query-codegen-openapi
+          name: package
+
+      - name: Install dependencies
+        run: yarn install
+
+      - name: Install build artifact
+        run: yarn add ./package.tgz
+
+      - name: Remove path alias
+        run: sed -i -e /@remap-prod-remove-line/d ./tsconfig.json
+
+      - name: Run tests
+        run: yarn test
+        env:
+          TEST_DIST: true
+
+      - name: Did we fail?
+        if: failure()
+        run: ls -R
+
+  are-the-types-wrong:
+    name: Check package definition with are-the-types-wrong
+
+    needs: [build]
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        node-version: [20.x]
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+
+      - name: Use node ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'yarn'
+
+      - name: Install deps
+        run: yarn install
+
+      - name: Download artifact
+        id: download-artifact
+        uses: actions/download-artifact@v4
+        with:
+          path: ./packages/rtk-query-codegen-openapi
+          name: package
+
+      - name: Run are-the-types-wrong
+        run: yarn dlx @arethetypeswrong/cli@latest ./package.tgz --format table

.github/workflows/tests.yml

@@ -92,21 +92,26 @@ jobs:
       - name: Install build artifact
         run: yarn workspace @reduxjs/toolkit add $(pwd)/package.tgz
 
-      - run: sed -i -e /@remap-prod-remove-line/d ./tsconfig.base.json ./vitest.config.mts ./src/tests/*.* ./src/query/tests/*.*
+      - run: sed -i -e /@remap-prod-remove-line/d ./tsconfig.base.json
 
       - name: Run tests, against dist
+        env:
+          TEST_DIST: true
         run: yarn test
 
+      - 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-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
@@ -134,9 +139,11 @@ jobs:
       - name: Show installed RTK versions
         run: yarn info @reduxjs/toolkit
 
-      - run: sed -i -e /@remap-prod-remove-line/d ./tsconfig.base.json ./vitest.config.mts ./src/tests/*.* ./src/query/tests/*.*
+      - run: sed -i -e /@remap-prod-remove-line/d ./tsconfig.base.json
 
       - name: Test types
+        env:
+          TEST_DIST: true
         run: |
           yarn tsc --version
           yarn type-tests
@@ -243,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

.yarn/patches/console-testing-library-npm-0.6.1-4d9957d402.patch

@@ -1,11 +1,38 @@
+diff --git a/package.json b/package.json
+index b924e066ecfdb30917b9c1056b360834da357698..15e155bd84f9d16537ffe36f9a87debcb0ec3591 100644
+--- a/package.json
++++ b/package.json
+@@ -8,12 +8,15 @@
+   "type": "module",
+   "main": "dist/index.js",
+   "typings": "index.d.ts",
++  "types": "index.d.ts",
+   "exports": {
+     ".": {
++      "types": "./index.d.ts",
+       "require": "./dist/index.js",
+       "default": "./src/index.js"
+     },
+     "./pure": {
++      "types": "./pure.d.ts",
+       "require": "./dist/pure.js",
+       "default": "./src/pure.js"
+     }
+diff --git a/pure.d.ts b/pure.d.ts
+index b13bb4eb87d0b316bb51bd6094b2353c6fc8527d..ee01cc9bd3233f5e67b050d48e22202b495a4a0a 100644
+--- a/pure.d.ts
++++ b/pure.d.ts
+@@ -1 +1 @@
+-export * from './';
++export * from './index.js';
 diff --git a/src/index.js b/src/index.js
 index 90ff7fa3d7d4fa62dbbf638958ae4e28abd089a8..28434687b5163b7472e86bdb11bed69e0868e660 100644
 --- a/src/index.js
 +++ b/src/index.js
 @@ -1,4 +1,4 @@
 -import { mockConsole, createConsole } from './pure';
 +import { mockConsole, createConsole } from './pure.js';
- 
+
  // Keep an instance of the original console and export it
  const originalConsole = global.console;
 diff --git a/src/pure.js b/src/pure.js
@@ -15,7 +42,7 @@ index b00ea2abbaea833e336676aa46e7ced2d59d6d88..42b83ed83fa16cf2234571500fe09868
 @@ -228,10 +228,11 @@ export function restore() {
    global.console = global.originalConsole;
  }
- 
+
 +/*
  if (typeof expect === 'function' && typeof expect.extend === 'function') {
    expect.extend({
@@ -24,13 +51,13 @@ index b00ea2abbaea833e336676aa46e7ced2d59d6d88..42b83ed83fa16cf2234571500fe09868
 +      // Workaround for custom inline snapshot matchers
        const error = new Error();
        const stacks = error.stack.split('\n');
- 
+
 @@ -245,7 +246,6 @@ if (typeof expect === 'function' && typeof expect.extend === 'function') {
        error.stack = stacks.join('\n');
- 
+
        const context = Object.assign(this, { error });
 -      /* -------------------------------------------------------------- */
- 
+
        const testingConsoleInstance =
          (received && received.testingConsole) || received;
 @@ -270,3 +270,4 @@ if (typeof expect === 'function' && typeof expect.extend === 'function') {

.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/api/createListenerMiddleware.mdx

@@ -488,11 +488,14 @@ To fix this, the middleware provides types for defining "pre-typed" versions of
 import { createListenerMiddleware, addListener } from '@reduxjs/toolkit'
 import type { RootState, AppDispatch } from './store'
 
+declare type ExtraArgument = {foo: string};
+
 export const listenerMiddleware = createListenerMiddleware()
 
 export const startAppListening = listenerMiddleware.startListening.withTypes<
   RootState,
-  AppDispatch
+  AppDispatch,
+  ExtraArgument
 >()
 
 export const addAppListener = addListener.withTypes<RootState, AppDispatch>()

docs/api/createSlice.mdx

@@ -359,7 +359,7 @@ reducers: (create) => {
 
 ### `extraReducers`
 
-Conceptually, each slice reducer "owns" its slice of state. There's also a natural correspondance between the update logic defined inside `reducers`, and the action types that are generated based on those.
+Conceptually, each slice reducer "owns" its slice of state. There's also a natural correspondence between the update logic defined inside `reducers`, and the action types that are generated based on those.
 
 However, there are many times that a Redux slice may also need to update its own state in response to action types that were defined elsewhere in the application (such as clearing many different kinds of data when a "user logged out" action is dispatched). This can include action types defined by another `createSlice` call, actions generated by a `createAsyncThunk`, RTK Query endpoint matchers, or any other action. In addition, one of the key concepts of Redux is that many slice reducers can independently respond to the same action type.
 

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

@@ -370,7 +370,7 @@ selectFromResult: () => ({})
   - `trigger`: A function that triggers an update to the data based on the provided argument. The trigger function returns a promise with the properties shown above that may be used to handle the behavior of the promise
   - `mutationState`: A query status object containing the current loading state and metadata about the request, or the values returned by the `selectFromResult` option where applicable.
     Additionally, this object will contain
-    - a `reset` method to reset the hook back to it's original state and remove the current result from the cache
+    - a `reset` method to reset the hook back to its original state and remove the current result from the cache
     - an `originalArgs` property that contains the argument passed to the last call of the `trigger` function.
 
 #### Description
@@ -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/api/fetchBaseQuery.mdx

@@ -336,7 +336,7 @@ export const api = createApi({
       query: () => ({
         url: `users`,
         // Example: we know the users endpoint is _really fast_ because it's always cached.
-        // We can assume if its over > 1000ms, something is wrong and we should abort the request.
+        // We can assume if it's over > 1000ms, something is wrong and we should abort the request.
         timeout: 1000,
       }),
     }),