react-global-state

Breaking Changes

• Adopts React 18.
  • This release does not change the actual library code, beside bumping React version in peer dependency declarations, and updating tests to ensure that the library works as expected with the new React's createRoot() / hydrateRoot() / renderToPipeableStream() APIs.
  • Getting Started documentation is updated to describe SSR setup with renderToPipeableStream() API.

Beware: Further library changes / updates for React 18 might be needed, and likely to follow in next releases, as the library is tested in real projects.

• Adds "main" entry into package.json to serve as a fallback for environments that do not recognize "exports" object. "main" points to the CommonJS build for Node LTS.

Breaking Change

• Reworked library entry point. Now it uses "exports" object in package.json to export CommonJS build for Node LTS, and ES module for browsers.

• Dependency updates.

• Added FAQ section to README and Docs.
• Update of dev dependencies.

• [#43] Revamped documentation.
• Dependency update.

• Patched entry point: if decides to load node build and fails - automatic fallback to web version.
• Dependency update.

• [#35] Adds TypeScript library definitions.
• [#38] Corrects setup instructions in README for NPM.
• Updates dependencies.

• [#37] Updates useAsyncData() hook to be compatible with SSR timeout feature; and updates SSR setup documentation to show how SSR timeout should be implemented.

• [#36] Fixes a group of related bugs:
  • useGlobalState() hook did not behave correctly when its path argument was changed while the host component was mounted.
  • useAsyncData() hook had a similar problem, due to internal dependency on useGlobalState().
  • useAsyncCollection() hook did not work correctly when its id or path arguments were changed while the host component was mounted.
• Updates dependencies.

• Internal package bundle optimization.
• Updates dependencies.

• Reworks library documentation, and moves it to https://dr.pogodin.studio/docs/react-global-state
• Updates dependencies

• [#34] Improves formatting of console logs in debug mode.
• Fixes client-side activation of debug mode by REACT_GLOBAL_STATE_DEBUG environment variable enjection by Webpack.
• Ensures that in production mode all debug logging code is stripped out by Webpack.
• Updates dependencies.

• [#33] Fixes a sync issue between GlobalState update notifications and unmounting of components watching the global state.

Breaking Changes

• [#30] Alters the data refresh logic in useAsyncData(..) hook (and, hence, in useAsyncCollection(..) hook as well). Now the data age is checked on every component re-render, and if stale the refresh is triggered.
• [#29] hardDeps option of useAsyncData(..) and useAsyncCollection(..) is deprecated and removed, as now deps option will play its exact role (forcing a refresh of non-stale data due to a change in dependencies, in useEffect(..) hook's sense).

Other Changes

• [#32] useAsyncData(..) and useAsyncCollection(..) now pass the previously loaded data, stored in the global state currently, into the loader calls when data (re-)load is initiated.

• [#29] Adds hardDeps option to useAsyncData() hook. This option allows to force-reload data when any dependency provided via this option (array) changes.
• [#31] Fix: zero maxage, refreshAge, garbageCollectionAge options of useAsyncData() hook are not treated as undefined anymore (do not result in the default 5 mins settings used).
• Updates dependencies.

• Updates dependencies.

Breaking

• Adopts New JSX Transform, thus from now it is only compabtible with latest React versions: >= 16.14.0, or 15.7.0, 0.14.10 (which also suppor the new JSX transform).

Fixes

• Patches the code to work in environments without global process variable (e.g. client-side code bundled by Webpack@5+, without explcit process polyfilling.
• Updates dependencies.

• Updates README and dependencies.

• Corrects README documentation on useAsyncData(..) and useAsyncCollection(..) hooks.
• Updates dependencies.