Skip to content

fix: React-Native package exports #4887

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -114,14 +114,21 @@ jobs:
- name: Erase path aliases
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

- name: Ensure there's no dist folder
run: rm -rf dist

- name: Change RTK package name to ensure node_modules is used
run: sed -i -e 's|@reduxjs/toolkit|@reduxjs/toolkit-test|' ./package.json

- name: Run tests, against installed artifact
env:
TEST_DIST: true
working-directory: ./packages/toolkit
run: ../../node_modules/.bin/vitest --run --typecheck

test-types:
name: 'Test Types: TS ${{ matrix.ts }} and React ${{ matrix.react.version }}'

Expand Down
2 changes: 1 addition & 1 deletion examples/publish-ci/node-esm/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"type": "module",
"scripts": {
"build": "echo Done",
"test": "node test-cjs.cjs && node test-esm.mjs"
"test": "node --no-experimental-require-module test-cjs.cjs && node test-esm.mjs"
},
"dependencies": {
"@reduxjs/toolkit": "^2.0.0-rc.3",
Expand Down
2 changes: 1 addition & 1 deletion examples/publish-ci/node-standard/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"license": "MIT",
"scripts": {
"build": "echo Done",
"test": "node test-cjs.js && node test-esm.mjs"
"test": "node --no-experimental-require-module test-cjs.js && node test-esm.mjs"
},
"dependencies": {
"@reduxjs/toolkit": "^2.0.0-rc.3",
Expand Down
2 changes: 1 addition & 1 deletion packages/rtk-query-codegen-openapi/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@
"pretty-quick": "^4.0.0",
"rimraf": "^5.0.5",
"ts-node": "^10.9.2",
"tsup": "^8.2.4",
"tsup": "^8.4.0",
"vite-tsconfig-paths": "^5.0.1",
"vitest": "^2.0.5",
"yalc": "^1.0.0-pre.47"
Expand Down
138 changes: 124 additions & 14 deletions packages/toolkit/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,27 +25,137 @@
"module": "dist/redux-toolkit.legacy-esm.js",
"main": "dist/cjs/index.js",
"types": "dist/index.d.ts",
"react-native": "dist/redux-toolkit.legacy-esm.js",
"unpkg": "dist/redux-toolkit.browser.mjs",
"exports": {
"./package.json": "./package.json",
".": {
"types": "./dist/index.d.ts",
"import": "./dist/redux-toolkit.modern.mjs",
"default": "./dist/cjs/index.js"
"module-sync": {
"types": "./dist/index.d.mts",
"default": "./dist/redux-toolkit.modern.mjs"
},
"module": {
"types": "./dist/index.d.mts",
"default": "./dist/redux-toolkit.modern.mjs"
},
"react-native": {
"import": {
"types": "./dist/index.d.mts",
"default": "./dist/redux-toolkit.modern.mjs"
},
"default": {
"types": "./dist/index.d.ts",
"default": "./dist/cjs/index.js"
}
},
"browser": {
"types": "./dist/index.d.mts",
"default": "./dist/redux-toolkit.browser.mjs"
},
"import": {
"types": "./dist/index.d.mts",
"default": "./dist/redux-toolkit.modern.mjs"
},
"default": {
"types": "./dist/index.d.ts",
"default": "./dist/cjs/index.js"
}
},
"./react": {
"types": "./dist/react/index.d.ts",
"import": "./dist/react/redux-toolkit-react.modern.mjs",
"default": "./dist/react/cjs/index.js"
"module-sync": {
"types": "./dist/react/index.d.mts",
"default": "./dist/react/redux-toolkit-react.modern.mjs"
},
"module": {
"types": "./dist/react/index.d.mts",
"default": "./dist/react/redux-toolkit-react.modern.mjs"
},
"react-native": {
"import": {
"types": "./dist/react/index.d.mts",
"default": "./dist/react/redux-toolkit-react.modern.mjs"
},
"default": {
"types": "./dist/react/index.d.ts",
"default": "./dist/react/cjs/index.js"
}
},
"browser": {
"types": "./dist/react/index.d.mts",
"default": "./dist/react/redux-toolkit-react.browser.mjs"
},
"import": {
"types": "./dist/react/index.d.mts",
"default": "./dist/react/redux-toolkit-react.modern.mjs"
},
"default": {
"types": "./dist/react/index.d.ts",
"default": "./dist/react/cjs/index.js"
}
},
"./query": {
"types": "./dist/query/index.d.ts",
"import": "./dist/query/rtk-query.modern.mjs",
"default": "./dist/query/cjs/index.js"
"module-sync": {
"types": "./dist/query/index.d.mts",
"default": "./dist/query/rtk-query.modern.mjs"
},
"module": {
"types": "./dist/query/index.d.mts",
"default": "./dist/query/rtk-query.modern.mjs"
},
"react-native": {
"import": {
"types": "./dist/query/index.d.mts",
"default": "./dist/query/rtk-query.modern.mjs"
},
"default": {
"types": "./dist/query/index.d.ts",
"default": "./dist/query/cjs/index.js"
}
},
"browser": {
"types": "./dist/query/index.d.mts",
"default": "./dist/query/rtk-query.browser.mjs"
},
"import": {
"types": "./dist/query/index.d.mts",
"default": "./dist/query/rtk-query.modern.mjs"
},
"default": {
"types": "./dist/query/index.d.ts",
"default": "./dist/query/cjs/index.js"
}
},
"./query/react": {
"types": "./dist/query/react/index.d.ts",
"import": "./dist/query/react/rtk-query-react.modern.mjs",
"default": "./dist/query/react/cjs/index.js"
"module-sync": {
"types": "./dist/query/react/index.d.mts",
"default": "./dist/query/react/rtk-query-react.modern.mjs"
},
"module": {
"types": "./dist/query/react/index.d.mts",
"default": "./dist/query/react/rtk-query-react.modern.mjs"
},
"react-native": {
"import": {
"types": "./dist/query/react/index.d.mts",
"default": "./dist/query/react/rtk-query-react.modern.mjs"
},
"default": {
"types": "./dist/query/react/index.d.ts",
"default": "./dist/query/react/cjs/index.js"
}
},
"browser": {
"types": "./dist/query/react/index.d.mts",
"default": "./dist/query/react/rtk-query-react.browser.mjs"
},
"import": {
"types": "./dist/query/react/index.d.mts",
"default": "./dist/query/react/rtk-query-react.modern.mjs"
},
"default": {
"types": "./dist/query/react/index.d.ts",
"default": "./dist/query/react/cjs/index.js"
}
}
},
"devDependencies": {
Expand Down Expand Up @@ -96,7 +206,7 @@
"rimraf": "^3.0.2",
"size-limit": "^11.0.1",
"tslib": "^1.10.0",
"tsup": "^8.2.3",
"tsup": "^8.4.0",
"tsx": "^4.19.0",
"typescript": "^5.8.2",
"valibot": "^1.0.0",
Expand All @@ -106,7 +216,7 @@
},
"scripts": {
"clean": "rimraf dist",
"run-build": "tsup",
"run-build": "tsup --config=$INIT_CWD/tsup.config.mts",
"build": "yarn clean && yarn run-build && tsx scripts/fixUniqueSymbolExports.mts",
"build-only": "yarn clean && yarn run-build",
"format": "prettier --write \"(src|examples)/**/*.{ts,tsx}\" \"**/*.md\"",
Expand Down
9 changes: 1 addition & 8 deletions packages/toolkit/query/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,7 @@
"module": "../dist/query/rtk-query.legacy-esm.js",
"main": "../dist/query/cjs/index.js",
"types": "./../dist/query/index.d.ts",
"exports": {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Dropping the exports field should be okay - a bundler that supports exports should look at the root-level package.json.

"./package.json": "./package.json",
".": {
"types": "./../dist/query/index.d.ts",
"import": "./../dist/query/rtk-query.modern.mjs",
"default": "./../dist/query/cjs/index.js"
}
},
"react-native": "./../dist/query/rtk-query.legacy-esm.js",
"author": "Mark Erikson <[email protected]>",
"license": "MIT",
"sideEffects": false
Expand Down
9 changes: 1 addition & 8 deletions packages/toolkit/query/react/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,7 @@
"module": "../../dist/query/react/rtk-query-react.legacy-esm.js",
"main": "../../dist/query/react/cjs/index.js",
"types": "./../../dist/query/react/index.d.ts",
"exports": {
"./package.json": "./package.json",
".": {
"types": "./../../dist/query/react/index.d.ts",
"import": "./../../dist/query/react/rtk-query-react.modern.mjs",
"default": "./../../dist/query/react/cjs/index.js"
}
},
"react-native": "./../../dist/query/react/rtk-query-react.legacy-esm.js",
"author": "Mark Erikson <[email protected]>",
"license": "MIT",
"sideEffects": false
Expand Down
11 changes: 2 additions & 9 deletions packages/toolkit/react/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,9 @@
"description": "",
"type": "module",
"module": "../dist/react/redux-toolkit-react.legacy-esm.js",
"main": "../dist/react/cjs/index.js",
"main": "./../dist/react/redux-toolkit-react.modern.mjs",
"types": "./../dist/react/index.d.ts",
"exports": {
"./package.json": "./package.json",
".": {
"types": "./../dist/react/index.d.ts",
"import": "./../dist/react/redux-toolkit-react.modern.mjs",
"default": "./../dist/react/cjs/index.js"
}
},
"react-native": "./../dist/react/redux-toolkit-react.modern.mjs",
"author": "Mark Erikson <[email protected]>",
"license": "MIT",
"sideEffects": false
Expand Down
25 changes: 13 additions & 12 deletions packages/toolkit/scripts/fixUniqueSymbolExports.mts
Original file line number Diff line number Diff line change
@@ -1,22 +1,23 @@
#!/usr/bin/env node --import=tsx

import fs from 'node:fs/promises'
import path from 'node:path'
import { fileURLToPath } from 'node:url'

const __dirname = fileURLToPath(new URL('.', import.meta.url))
import * as fs from 'node:fs/promises'
import * as path from 'node:path'

const entryPointDirectories = ['', 'react', 'query', 'query/react']

const typeDefinitionEntryFiles = entryPointDirectories.map((filePath) =>
path.resolve(__dirname, '..', 'dist', filePath, 'index.d.ts'),
const typeDefinitionEntryFiles = entryPointDirectories.flatMap(
(filePath) =>
[
path.join(import.meta.dirname, '..', 'dist', filePath, 'index.d.ts'),
path.join(import.meta.dirname, '..', 'dist', filePath, 'index.d.mts'),
] as const,
)

const filePathsToContentMap = new Map<string, string>(
await Promise.all(
typeDefinitionEntryFiles.map(
async (filePath) =>
[filePath, await fs.readFile(filePath, 'utf-8')] as const,
[filePath, await fs.readFile(filePath, { encoding: 'utf-8' })] as const,
),
),
)
Expand All @@ -30,8 +31,8 @@ const main = async () => {
const lines = content.split('\n')

const allUniqueSymbols = lines
.filter((line) => /declare const (\w+)\: unique symbol;/.test(line))
.map((line) => line.match(/declare const (\w+)\: unique symbol;/)?.[1])
.filter((line) => /declare const (\w+): unique symbol;/.test(line))
.map((line) => line.match(/declare const (\w+): unique symbol;/)?.[1])

if (allUniqueSymbols.length === 0) {
console.log(`${filePath} does not have any unique symbols.`)
Expand Down Expand Up @@ -69,8 +70,8 @@ const main = async () => {
)
})

await fs.writeFile(filePath, newContent)
await fs.writeFile(filePath, newContent, { encoding: 'utf-8' })
})
}

main()
void main()
Loading
Loading