fix: restore missing `exports` declarations #3892

DamianOsipiuk · 2022-07-21T08:09:23Z

Closes: #3882

codesandbox-ci · 2022-07-21T08:11:30Z

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 4d6e410:

Sandbox	Source
@tanstack/query-example-react-basic	Configuration
@tanstack/query-example-react-basic-typescript	Configuration

codecov-commenter · 2022-07-21T08:15:10Z

Codecov Report

Merging #3892 (e0d5394) into main (eab6e2c) will increase coverage by 0.41%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #3892      +/-   ##
==========================================
+ Coverage   96.36%   96.77%   +0.41%     
==========================================
  Files          45       57      +12     
  Lines        2281     2668     +387     
  Branches      640      784     +144     
==========================================
+ Hits         2198     2582     +384     
- Misses         80       84       +4     
+ Partials        3        2       -1

Impacted Files	Coverage Δ
src/react/useInfiniteQuery.ts
src/core/subscribable.ts
src/react/QueryClientProvider.tsx
src/core/queryCache.ts
src/react/logger.ts
...rc/createWebStoragePersistor-experimental/index.ts
src/react/setBatchUpdatesFn.ts
src/core/utils.ts
src/devtools/useLocalStorage.ts
src/core/onlineManager.ts
... and 92 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2c44e53...e0d5394. Read the comment docs.

TkDodo · 2022-07-21T08:17:47Z

Thanks. Are you sure that this is all we need? According to @sachinraja, there is more work to be done to be fully ESM compliant - e.g. to use the .mjs extension. That's why I've created this issue:

ESM support #3882

We've also had some problems with useSyncExternalStore and react-native, so I'd rather not rush this issue. Also not sure how we can properly test this with various bundlers before we release 🤔

I would also really like to get the feature back that allowed us to import the devtools in production via a separate entry point

DamianOsipiuk · 2022-07-21T08:21:50Z

@TkDodo Yup, marked as WIP for now as there are still more things to be moved/refactored.

DamianOsipiuk · 2022-07-21T09:37:20Z

@TkDodo @tannerlinsley So most of the things are covered by this PR to restore EMS compliant exports.

The only thing left is this (#3521):

Types are now emitted into lib instead of a separate types directory. This will help support TypeScript, which will add support for "exports" in the next release.

I'm not entirely sure why some packages are build to cjs with subdirectories, while others are not.
I assume that packages depending on other packages from monorepo have that behavior.
However it's kind of weird that react-query/build/cjs has also query-core build copy.
Is that something to be expected?

Can we remove preserveModules from cjs build?

TkDodo

somehow, codesandbox shows that types can't be picked up anymore:

see this preview sandbox: https://codesandbox.io/s/tanstack-query-example-react-basic-typescript-ssd0yy?file=/src/index.tsx

packages/react-query/package.json

TkDodo · 2022-07-26T05:16:41Z

packages/query-async-storage-persister/package.json

+      "default": "./build/lib/index.js"
+    },
+    "./package.json": "./package.json"
+  },
  "files": [
    "build/*",


the build directory contains things that we probably shouldn't ship, like stats.html etc

Picked more granular paths. But this could still change if i find a way to bundle types into lib properly

TkDodo · 2022-07-26T05:20:22Z

@sachinraja please have a look at this PR if you find the time :)

* fix: restore missing `exports` declarations (#3892) * fix: restore missing `exports` declarations * fix: restore package.json exports[C * fix: reexport types used by vue-query * fix: react-native uSES usage * fix: emit mjs for esm * fix: uSES build * fix: devtools exports to allow devtools in prod * fix: cjs and esm build bundled to lib dir * fix: sideEffect in react-query, better files paths * fix: generate declarations to lib * fix: lint and tests * fix: use the same ts build method for tests * fix: change force prod import * fix: subpackage dependencies (#4013) * fix: umd-build (#3924) * - Fix UMD build getting overwritten - Updating "browser" field for @tanstack/react-query-devtools * Updating the "browser" field to be the same as "main" * release: v4.0.11-beta.0 * release: v4.0.11-beta.1 * fix(react-query-devtools): cjs devtools fallback (#4048) * release: v4.0.11-beta.2 * fix: remove browser entry, fix umd size (#4044) * fix: remove browser entry, fix umd size * fix: bundle query-core with react-query for umd * fix: remove missed browser entry * chore: remove 'browser' field from package validation because it doesn't exist anymore * release: v4.0.11-beta.3 * release: v4.0.11-beta.4 * chore: react-query should be a peerDependency of the devtools * release: v4.0.11-beta.5 * release: v4.3.0-beta.0 * fix: webpack 4 fallback to cjs (#4069) * fix: publish script shouldn't check against module anymore * fix: publish script I don't think we can have single quotes in commit message when passing them to --notes * release: v4.3.0-beta.2 * release: v4.3.0-beta.3 * fix: umd build size, force prod devtools (#4074) * fix: umd build size * fix: devtools force production * release: v4.3.0-beta.4 * release: v4.3.0-beta.5 * fix: reintroduce production export (#4090) * release: v4.3.0-beta.6 * fix(react-query-devtools): always useEffect for the mounted check no effect runs on the server, and there is no real advantage to useLayoutEffect on the client; somehow, this dynamic check creates problems with the production build of the devtools * release: v4.3.0-beta.7 * docs: document devtools in production * docs: document devtools in production * docs: document devtools in production nodenext needs 4.7 * fix: support react-native (#4125) * fix: support react-native * chore: remove banner from build Co-authored-by: Damian Osipiuk <osipiukd+git@gmail.com> Co-authored-by: John Daly <john.daly2@gmail.com> Co-authored-by: Tanner Linsley <tannerlinsley@users.noreply.github.com>

DamianOsipiuk changed the title ~~fix: restore missing exports declarations~~ WIP: fix: restore missing exports declarations Jul 21, 2022

DamianOsipiuk force-pushed the restore-esm-exports branch from 07907c1 to cf76e2e Compare July 21, 2022 09:25

TkDodo reviewed Jul 26, 2022

View reviewed changes

DamianOsipiuk added 9 commits July 26, 2022 10:52

fix: restore missing exports declarations

db98c0d

fix: restore package.json exports[C

9248796

fix: reexport types used by vue-query

b80db4e

fix: react-native uSES usage

b12155d

fix: emit mjs for esm

b63ff1c

fix: uSES build

6b7437b

fix: devtools exports to allow devtools in prod

5d89f13

fix: cjs and esm build bundled to lib dir

b880218

fix: sideEffect in react-query, better files paths

c46a921

DamianOsipiuk force-pushed the restore-esm-exports branch from c35eb87 to c46a921 Compare July 26, 2022 08:55

fix: generate declarations to lib

050870c

DamianOsipiuk changed the title ~~WIP: fix: restore missing exports declarations~~ fix: restore missing exports declarations Jul 26, 2022

fix: lint and tests

891080c

DamianOsipiuk force-pushed the restore-esm-exports branch from c8f8b3b to 891080c Compare July 26, 2022 15:51

fix: use the same ts build method for tests

cce0188

DamianOsipiuk mentioned this pull request Jul 27, 2022

Typescript compilation fails with v2 beta.5 DamianOsipiuk/vue-query#220

Closed

DamianOsipiuk changed the base branch from main to beta July 28, 2022 08:20

TkDodo mentioned this pull request Jul 28, 2022

fix/umd-build #3924

Merged

fix: change force prod import

4d6e410

TkDodo merged commit 2af9174 into TanStack:beta Jul 28, 2022

DamianOsipiuk mentioned this pull request Aug 9, 2022

Add type:module property to package.json #3977

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: restore missing `exports` declarations #3892

fix: restore missing `exports` declarations #3892

DamianOsipiuk commented Jul 21, 2022

codesandbox-ci bot commented Jul 21, 2022 •

edited

Loading

codecov-commenter commented Jul 21, 2022 •

edited

Loading

TkDodo commented Jul 21, 2022

DamianOsipiuk commented Jul 21, 2022

DamianOsipiuk commented Jul 21, 2022 •

edited

Loading

TkDodo left a comment

TkDodo Jul 26, 2022

DamianOsipiuk Jul 26, 2022

TkDodo commented Jul 26, 2022

fix: restore missing exports declarations #3892

fix: restore missing exports declarations #3892

Conversation

DamianOsipiuk commented Jul 21, 2022

codesandbox-ci bot commented Jul 21, 2022 • edited Loading

codecov-commenter commented Jul 21, 2022 • edited Loading

Codecov Report

TkDodo commented Jul 21, 2022

DamianOsipiuk commented Jul 21, 2022

DamianOsipiuk commented Jul 21, 2022 • edited Loading

TkDodo left a comment

Choose a reason for hiding this comment

TkDodo Jul 26, 2022

Choose a reason for hiding this comment

DamianOsipiuk Jul 26, 2022

Choose a reason for hiding this comment

TkDodo commented Jul 26, 2022

fix: restore missing `exports` declarations #3892

fix: restore missing `exports` declarations #3892

codesandbox-ci bot commented Jul 21, 2022 •

edited

Loading

codecov-commenter commented Jul 21, 2022 •

edited

Loading

DamianOsipiuk commented Jul 21, 2022 •

edited

Loading