@o3r/store-sync 11.0.0-next.2 → 11.0.0-prerelease.2

package/README.md

@@ -12,32 +12,26 @@ This package is an [Otter Framework Module](https://github.com/AmadeusITGroup/ot
 [![Stable Version](https://img.shields.io/npm/v/@o3r/store-sync?style=for-the-badge)](https://www.npmjs.com/package/@o3r/store-sync)
 [![Bundle Size](https://img.shields.io/bundlephobia/min/@o3r/store-sync?color=green&style=for-the-badge)](https://www.npmjs.com/package/@o3r/store-sync)
 
-This module is exposing an NgRx store synchronization solution (synchronous and asynchronous) via the class `StorageSync`.
+This module exposes an NgRx store synchronization solution (synchronous and asynchronous) via the class `StorageSync`.
 
-To facilitate the synchronization, the `StorageSync` class is based on a fork of [ngrx-store-localstorage](https://github.com/btroncone/ngrx-store-localstorage) that is also exposed and includes the following changes on top of the original version:
+To facilitate the synchronization, the `StorageSync` class is based on a fork of [ngrx-store-localstorage](https://github.com/btroncone/ngrx-store-localstorage), an exposed package used to sync an NgRx store and the local or session storage. 
+Compared to the original version of the fork, the **@o3r/store-sync** module includes changes that improve overall synchronization performance.
 
-- Export properly the `dateReviver` function
-- Add missing comments
-- Explicit dependency to `@ngrx/store` for the action names
-- Change interface names to prefix with "sync"
-- Add logger support
-- Fix lint according to ESLint rules
-- Split code in several files
-- Migrate tests to Jest
-- Removal of deprecated `deepmerge` dependency.
-- Support of a `smartSync` setup to improve performances
+The features to highlight are:
+* The addition of `smartSync`: by default, **@o3r/store-sync** synchronizes a state only if its value changed and no longer matches that of the storage. This feature improves performance, but it can be disabled if wanted.
+* The possibility of **asynchronous synchronization**: in our asynchronous storage interface, we have overridden the return type of the `getItem` function to handle promises (the return type is `Promise<string | null>`).
 
-### Configuration
+You can read about the changes in the module's [documentation](https://github.com/AmadeusITGroup/otter/blob/main/docs/store-sync/STORE_SYNC.md).
 
-#### Smart sync
+## How to install
 
-The original ngrx-store-localstorage synchronize all of your states everytime a state is updated which can lead to a lot
-of accesses to the local and session storage and cause performance issue.
+```shell
+ng add @o3r/store-sync
+```
 
-To avoid this pitfall, by default the @o3r/store-sync only synchronizes a state if its value changed and no longer matches
-the storage.
-This behaviour can be disabled as follows:
+> [!WARNING]
+> This module requires [@o3r/core](https://www.npmjs.com/package/@o3r/core) to be installed.
 
-```typescript
-const storage = new StorageSync({keys: [...myStorekeys]}, {disableSmartSync: true});
-```
+## More details
+
+Find more information in the [documentation](https://github.com/AmadeusITGroup/otter/blob/main/docs/store-sync/STORE_SYNC.md).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@o3r/store-sync",
-  "version": "11.0.0-next.2",
+  "version": "11.0.0-prerelease.2",
   "publishConfig": {
     "access": "public"
   },
@@ -13,14 +13,14 @@
     "otter-module"
   ],
   "peerDependencies": {
-    "@ama-sdk/core": "^11.0.0-next.2",
+    "@ama-sdk/core": "^11.0.0-prerelease.2",
     "@angular-devkit/core": "~17.3.0",
     "@angular-devkit/schematics": "~17.3.0",
     "@ngrx/entity": "~17.2.0",
     "@ngrx/store": "~17.2.0",
-    "@o3r/core": "^11.0.0-next.2",
-    "@o3r/logger": "^11.0.0-next.2",
-    "@o3r/schematics": "^11.0.0-next.2",
+    "@o3r/core": "^11.0.0-prerelease.2",
+    "@o3r/logger": "^11.0.0-prerelease.2",
+    "@o3r/schematics": "^11.0.0-prerelease.2",
     "fast-deep-equal": "^3.1.3",
     "rxjs": "^7.8.1"
   },