2.0.0

[shuding]

Announcing SWR 2.0

We are excited to announce the release of SWR 2.0! The new version comes with a lot of improvements:

• New useSWRMutation hook
• Enhanced mutation and optimistic UI capabilities
• SWR DevTools
• Preload resource
• Improved React 18 support

And more!

Read our blog post and migration guide: https://swr.vercel.app/blog/swr-v2

What's Changed

• bugfix: make suspense and revalidateIfStale work together by @simowe in bugfix: make suspense and revalidateIfStale work together #1851
• feat: support functional optimisticData by @huozhi in feat: support functional optimisticData #1861
• test: fix an act warning by @koba04 in test: fix an act warning #1888
• breaking: Change the fetcher argument to be consistent with the passed key by @shuding in breaking: Change the fetcher argument to be consistent with the passed key #1864
• Keep all fields with one single key by @shuding in Keep all fields with one single key #1863
• fix: wrong spell by @baojie223 in fix: wrong spell #1902
• Update React 18 dependencies by @shuding in Update React 18 dependencies #1824
• build(deps): bump minimist from 1.2.5 to 1.2.6 by @dependabot in build(deps): bump minimist from 1.2.5 to 1.2.6 #1903
• type: make type inference simpler by @promer94 in type: make type inference simpler #1908
• type: fix type error on SWRConfig by @himself65 in type: fix type error on SWRConfig #1913
• feat: Hook for remote mutations by @shuding in feat: Hook for remote mutations #1450
• Add isFallback state by @shuding in Add isFallback state #1925
• build: output mutation cjs bundle with named exports by @huozhi in build: output mutation cjs bundle with named exports #1926
• Add isLoading state and refactor the core by @shuding in Add isLoading state and refactor the core #1928
• Add keepPreviousData option by @shuding in Add keepPreviousData option #1929
• types: drop legacy types by @huozhi in types: drop legacy types #1930
• breaking: Throw error when using suspense on the server side without fallback in React 18 by @shuding in breaking: Throw error when using suspense on the server side without fallback in React 18 #1931
• type: extends useConfig cache interface by @promer94 in type: extends useConfig cache interface #1938
• remove mount check for react18 by @promer94 in remove mount check for react18 #1927
• lint: dont check unused vars with underscore prefix by @huozhi in lint: dont check unused vars with underscore prefix #1939
• test: upgrade to jest 28 by @huozhi in test: upgrade to jest 28 #1942
• Fix cache types by @chibicode in Fix cache types #1961
• Improved React 18 support by @promer94 in Improved React 18 support #1962
• types: fix type regressions by @promer94 in types: fix type regressions #1966
• fix: mutate args for useSWRInfinite hook by @sanjeev29 in fix: mutate args for useSWRInfinite hook #1947
• build: import with-selector with extension from useESE by @huozhi in build: import with-selector with extension from useESE #1967
• Bug fixes by @shuding in Bug fixes #1968
• chore: Faster type checking by @shuding in chore: Faster type checking #1969
• fix: try fix codesanbox ci import error by @promer94 in fix: try fix codesanbox ci import error #1971
• Fix race conditions related to optimistic UI by @shuding in Fix race conditions related to optimistic UI #1970
• chore: Add test cases for mutate by @shuding in chore: Add test cases for mutate #1976
• fix: Should always reset to the original data after mutating with optimistic data by @shuding in fix: Should always reset to the original data after mutating with optimistic data #1982
• refactor: remove useless ref copy by @promer94 in refactor: remove useless ref copy #1981
• chore: switch to pnpm and turborepo by @promer94 in chore: switch to pnpm and turborepo #1983
• fix: should only update cache when actually start new request by @promer94 in fix: should only update cache when actually start new request #1986
• chore: save some bytes by @promer94 in chore: save some bytes #1991
• fix: useSWRMutation - clear error after successful trigger (Misbehavior of the error state from useSWRMutation #1973) by @anirudh1713 in fix: useSWRMutation - clear error after successful trigger (#1973) #1995
• Fix typo: getSWRCacahe -> getSWRCache by @sdornan in Fix typo: getSWRCacahe -> getSWRCache #2000
• build: do not abort on watch mode when ts erroring by @huozhi in build: do not abort on watch mode when ts erroring #1992
• chore: add engine field to limit pnpm version by @huozhi in chore: add engine field to limit pnpm version #1990
• test: add test case for Beta feedback issue: isLoading and isValidating are changing indefinitely like in a loop in 2.0.0-beta.3 #1974 by @promer94 in test: add test case for #1974 #2005
• fix: Adding debounce for autocomplete-suggestions example by @Walkeryr in fix: Adding debounce for autocomplete-suggestions example #2017
• BREAKING: rename SWRConfig.default to SWRConfig.defaultValue by @huozhi in BREAKING: rename SWRConfig.default to SWRConfig.defaultValue #2023
• feat: support functional swr context config by @huozhi in feat: support functional swr context config #2024
• test: fix all act warnings by @koba04 in test: fix all act warnings #2031
• feat: add preload function by @koba04 in feat: add preload function #2026
• fix: Avoid preloading the resource multiple times by @shuding in fix: Avoid preloading the resource multiple times #2036
• fix: isLoading and isValidating should always respect cache value by @promer94 in fix: isLoading and isValidating should always respect cache value #2048
• Fix ts type generation by @huozhi in Fix ts type generation #2038
• feat: mutate filter by @huozhi in feat: mutate filter #1989
• Fix typos by @hiro0218 in Fix typos #2052
• feat: add DevTools hook by @koba04 in feat: add DevTools hook #2016
• Use consistent typing imports by @huozhi in Use consistent typing imports #2061
• Upgrading use-sync-external-store lib by @sanjaiyan-dev in Upgrading use-sync-external-store lib #2063
• Revert swr config generic by @huozhi in Revert swr config generic #2065
• Fix: raf return type by @huozhi in Fix: raf return type #2074
• Remove unused info from dummy package.json by @huozhi in Remove unused info from dummy package.json #2083
• Use pnpm workspace by @huozhi in Use pnpm workspace #2085
• bump typescript and apply nodenext module resolution by @huozhi in bump typescript and apply nodenext module resolution #2084
• Chore: Typos and grammar by @AllanOliveiraM in Chore: Typos and grammar #2094
• chore: add basic tsdoc by @promer94 in chore: add basic tsdoc #2089
• types: add generic for SWRInfiniteKeyLoader by @jason89521 in types: add generic for SWRInfiniteKeyLoader #2104
• fix: add swr/_internal to paths by @jason89521 in fix: add swr/_internal to paths #2105
• type: make tsconfig simpler and fix type error by @promer94 in type: make tsconfig simpler and fix type error #2115
• chore: exclude .tsbuildinfo from files, reduce install size by @promer94 in chore: exclude .tsbuildinfo from files, reduce install size #2119
• Reorder exports conditions by @huozhi in Reorder exports conditions #2130
• Upgrade bunchee by @huozhi in Upgrade bunchee #2132
• Bump typescript and assemble pnpm scripts by @huozhi in Bump typescript and assemble pnpm scripts #2133
• chore: add github actions reporter by @promer94 in chore: add github actions reporter #2131
• Dedupe installed swc by @huozhi in Dedupe installed swc #2136
• test: add a test for preload API in effects by @koba04 in test: add a test for preload API in effects #2138
• test: add more isLoading tests for the case a key is null or an error by @koba04 in test: add more isLoading tests for the case a key is null or an error #2141
• ci: use action/setup-node built-in pnpm cache and bump to node16 by @promer94 in ci: use action/setup-node built-in pnpm cache and bump to node16 #2142
• test: add tests for dependency collection by @koba04 in test: add tests for dependency collection #2140
• chore: bump dev deps by @huozhi in chore: bump dev deps #2143
• memoize config values to avoid frequent context propagation by @gnoff in memoize config values to avoid frequent context propagation #2149
• Bundle types into one file by @huozhi in Bundle types into one file #2150
• Revert target option by @huozhi in Revert target option #2151
• chore: fix missing husky warning by @huozhi in chore: fix missing husky warning #2160
• Remove downlevelIteration and traverse iterator manually by @huozhi in Remove downlevelIteration and traverse iterator manually #2181
• fix: re-render when returned data and fallbackData is the same and keepPreviousData is enabled by @koba04 in fix: re-render when returned data and fallbackData is the same and keepPreviousData is enabled #2169
• breaking: Change the error broadcasting behavior in mutations and add throwOnError option by @shuding in breaking: Change the error broadcasting behavior in mutations and add throwOnError option #2182
• docs: Add JSDoc comments to useSWRMutation by @shuding in docs: Add JSDoc comments to useSWRMutation #2183
• type: export MutationFetcher by @ssssota in type: export MutationFetcher #2184
• Bump bundler by @huozhi in Bump bundler #2187
• resolve swr internal imports as external by @huozhi in resolve swr internal imports as external #2225
• test: update tests alias to swr subpath exports by @huozhi in test: update tests alias to swr subpath exports #2243
• feat: support functional rollbackOnError by @huozhi in feat: support functional rollbackOnError #2242
• Update build target to es2018 by @shuding in Update build target to es2018 #2249
• Fix missing esmodule mark in cjs build by @huozhi in Fix missing esmodule mark in cjs build #2251
• fix: pass null fetcher to middleware by @koba04 in fix: pass null fetcher to middleware #2240

New Contributors

• @simowe made their first contribution in bugfix: make suspense and revalidateIfStale work together #1851
• @baojie223 made their first contribution in fix: wrong spell #1902
• @himself65 made their first contribution in type: fix type error on SWRConfig #1913
• @chibicode made their first contribution in Fix cache types #1961
• @sanjeev29 made their first contribution in fix: mutate args for useSWRInfinite hook #1947
• @sdornan made their first contribution in Fix typo: getSWRCacahe -> getSWRCache #2000
• @Walkeryr made their first contribution in fix: Adding debounce for autocomplete-suggestions example #2017
• @hiro0218 made their first contribution in Fix typos #2052
• @sanjaiyan-dev made their first contribution in Upgrading use-sync-external-store lib #2063
• @AllanOliveiraM made their first contribution in Chore: Typos and grammar #2094
• @jason89521 made their first contribution in types: add generic for SWRInfiniteKeyLoader #2104
• @gnoff made their first contribution in memoize config values to avoid frequent context propagation #2149
• @ssssota made their first contribution in type: export MutationFetcher #2184

Full Changelog: 1.2.2...2.0.0

---

This discussion was created from the release 2.0.0.