@oimdb/core 1.0.6 → 1.2.0

package/README.md

@@ -65,9 +65,7 @@ const queue = new OIMEventQueue({
 
 // Create reactive collection
 const users = new OIMReactiveCollection<User, string>(queue, {
-    collectionOpts: {
-        selectPk: (user) => user.id
-    }
+    selectPk: (user) => user.id
 });
 
 // Subscribe to key-specific updates
@@ -249,10 +247,8 @@ const deepMergeUpdater: TOIMEntityUpdater<User> = (newEntity, oldEntity) => {
 // Use custom updater with reactive collection
 const queue = new OIMEventQueue();
 const users = new OIMReactiveCollection<User, string>(queue, {
-    collectionOpts: {
-        selectPk: (user) => user.id,
-        updateEntity: deepMergeUpdater
-    }
+    selectPk: (user) => user.id,
+    updateEntity: deepMergeUpdater
 });
 
 // Now updates will use deep merge logic
@@ -370,6 +366,38 @@ const user = selectEntityByPk(users, 'user1');
 const teamUsers = useSelectEntitiesByPks(users, userIds);
 ```
 
+### With Redux (@oimdb/redux-adapter)
+
+Migrate from Redux to OIMDB gradually or use both systems side-by-side with automatic two-way synchronization:
+
+```typescript
+import { OIMDBReducerFactory } from '@oimdb/redux-adapter';
+import { createStore, combineReducers } from 'redux';
+
+// Create Redux reducer from OIMDB collection
+const factory = new OIMDBReducerFactory(queue);
+const usersReducer = factory.createCollectionReducer(users);
+
+// Use in existing Redux store
+const store = createStore(
+    combineReducers({
+        users: usersReducer, // OIMDB-backed reducer
+        ui: uiReducer,       // Existing Redux reducer
+    })
+);
+
+// OIMDB changes automatically sync to Redux
+// Redux actions can sync back to OIMDB with child reducers
+```
+
+**Key Benefits:**
+- **🔄 Gradual Migration**: Migrate one collection at a time without breaking changes
+- **🔄 Two-Way Sync**: Automatic synchronization between OIMDB and Redux
+- **📦 Production Ready**: Battle-tested adapter optimized for large datasets
+- **🎯 Flexible**: Works with any Redux state structure via custom mappers
+
+[📖 See @oimdb/redux-adapter documentation](../redux-adapter/README.md) for complete migration guide and examples.
+
 ### Standalone Usage
 
 Use core classes directly for maximum control:
@@ -393,9 +421,7 @@ Reactive collection with automatic change notifications and event coalescing.
 
 **Constructor:**
 ```typescript
-new OIMReactiveCollection(queue: OIMEventQueue, opts?: {
-    collectionOpts?: TOIMCollectionOptions<TEntity, TPk>
-})
+new OIMReactiveCollection(queue: OIMEventQueue, opts?: TOIMCollectionOptions<TEntity, TPk>)
 ```
 
 **Properties:**
@@ -411,19 +437,19 @@ new OIMReactiveCollection(queue: OIMEventQueue, opts?: {
 - `getOneByPk(pk: TPk): TEntity | undefined` - Get entity by primary key
 - `getManyByPks(pks: readonly TPk[]): Map<TPk, TEntity | undefined>` - Get multiple entities
 
-#### `OIMRICollection<TEntity, TPk, TIndexName, TIndexKey, TIndex, TReactiveIndex>`
+#### `OIMRICollection<TEntity, TPk, TIndexName, TIndexKey, TIndex, TReactiveIndex, TReactiveIndexMap>`
 Reactive collection with integrated indexing capabilities.
 
 **Constructor:**
 ```typescript
 new OIMRICollection(queue: OIMEventQueue, opts: {
     collectionOpts?: TOIMCollectionOptions<TEntity, TPk>;
-    indexes: Record<TIndexName, TReactiveIndex>;
+    indexes: TReactiveIndexMap;
 })
 ```
 
 **Properties:**
-- `indexes: Record<TIndexName, TReactiveIndex>` - Named reactive indexes
+- `indexes: TReactiveIndexMap` - Named reactive indexes preserving index-to-name mapping
 - *(inherits all OIMReactiveCollection properties)*
 
 #### `OIMReactiveIndexManual<TKey, TPk>`
@@ -529,9 +555,7 @@ describe('OIMReactiveCollection', () => {
         });
         
         users = new OIMReactiveCollection(queue, {
-            collectionOpts: {
-                selectPk: (user) => user.id
-            }
+            selectPk: (user) => user.id
         });
     });