Changelog
All notable changes to this project will be documented in this file.
[0.1.11] - 2026-03-10
Changed
- MMKV adapter (v4 API) — Switched from
new MMKV()tocreateMMKV()for react-native-mmkv v4 compatibility. The v3 API (MMKVclass) was removed in v4. Requiresreact-native-mmkv@^4.
[0.1.9] - 2025-03-02
Added
- Example App video — thumbnail + link in README, docs homepage, nav, and sidebar
- Examples section overhaul — Minimal → Basic → React Query → Realm → Background (simple to advanced)
Changed
- Docs header version now reads from
package.json(auto-sync) - External links open in new tab (README, docs nav, sidebar, edit links)
- Examples sidebar: "Example App (Video)" as first item
Fixed
- License copyright year (2024-2025)
[0.1.8] - 2025-03-02
Added
- Minimal example — 5-minute getting started
- GitHub Pages deploy workflow for documentation
@rollup/rollup-linux-x64-gnuoptional dependency for docs build on CI
Changed
- package.json
homepageanddocumentationpoint to docs URL - Examples ordered from simple to advanced with step-by-step explanations
[0.1.7] - 2025-03-02
Changed
- README and documentation updates
[0.1.6] - 2025-03-02
Added
- GitHub Actions workflow for deploying docs to GitHub Pages
- Docs link and badge in README
Fixed
- VitePress build on Linux CI (rollup optional deps)
[0.1.5] - 2025-03-02
Added
- VitePress documentation site
- Getting Started, API Reference, Examples, Changelog pages
Fixed
npm cion CI —search-insightsadded to package-lock.json- package-lock.json synced with package.json
[0.1.4] - 2025-03-02
Added
- Per-action handler registry — define API calls per mutation instead of a central switch-case
- Mutation state tracking —
status,isLoading,isQueued,isSuccess,isError,error,reset() onSuccesscallback — fires only after a successful direct API call (online)- React Query integration — use
mutateAsyncfromuseMutationinside handlers - Network status via
useSyncExternalStore— zero cascading re-renders - 38 unit tests with Jest
- GitHub Actions CI (Node 18 + 20)
- Technology badges, MIT license, and CHANGELOG
Changed
OfflineProviderno longer uses React Context — reads from singleton storeuseNetworkStatusmigrated fromuseContexttouseSyncExternalStore- Improved docs with React Query examples and state flow tables
Fixed
- Handler persistence — per-action handlers survive component unmount
[0.1.0] - 2025-02-28
Added
- Initial release
OfflineProvidercomponent with NetInfo integrationuseOfflineMutationhook for queue-aware mutationsuseOfflineQueuehook withuseSyncExternalStoreuseSyncProgresshook for live sync trackinguseNetworkStatushook for connectivity statusOfflineManagersingleton for direct API access- Storage adapters: MMKV, AsyncStorage, Memory
- Realm adapter (record-based)
- Custom storage adapter interface
- Auto and manual sync modes
onOnlineRestorecallback with Alert, Toast, BottomSheet examples- Background sync support