@oimdb/core 3.8.0 → 3.10.0

package/README.md

@@ -185,6 +185,25 @@ const multipleUsers = users.getManyByPks(['user1', 'user2']);
 const userSlot = users.getSlotByPk('user1');
 ```
 
+#### Composite primary key
+
+Instead of a primitive PK, a collection can be keyed by a **composite key path** — an arbitrary-length tuple of primitive segments. Pass a trie-backed store:
+
+```typescript
+import { OIMReactiveCollection, OIMCollectionStoreTrieDriven, TOIMKeyPath } from '@oimdb/core';
+
+const memberships = new OIMReactiveCollection<Membership, TOIMKeyPath>(queue, {
+    selectPk: (m) => [m.userId, m.projectId],
+    store: new OIMCollectionStoreTrieDriven<Membership>(),
+});
+
+memberships.getOneByPk([1, 10]);        // matched by content — a fresh array works
+memberships.subscribeOnKey([1, 10], render);
+memberships.removeOneByPk([1, 10]);
+```
+
+Key paths match **by content** (the store interns each logical PK to one canonical `slot.pk`). Indexes work over such a collection too (`indexFactory.setBasedIndex()` indexes composite PKs). Primitive-PK collections keep the native-`Map` store untouched. At serialization boundaries a composite PK needs an `IOIMPkCodec` (`OIMPkCodecKeyPath`) — `@oimdb/persist`/`@oimdb/snapshot-manager` need none; `@oimdb/redux-adapter` takes it.
+
 ### Creating a Reactive Index
 
 OIMDB provides two types of indexes optimized for different use cases:
@@ -1424,7 +1443,7 @@ new OIMReactiveCollectionIndexManualSetBased(queue: OIMEventQueue, opts: {
         store?: OIMIndexStoreSetBased<TKey, TPk>;
     };
 } | {
-    resolveSlot: TOIMEntitySlotResolver<TPk>;
+    getSlot: TOIMEntitySlotGetter<TPk>;
     indexOptions?: {
         comparePks?: TOIMIndexComparator<TPk>;
         store?: OIMIndexStoreSetBased<TKey, TPk>;
@@ -1432,7 +1451,7 @@ new OIMReactiveCollectionIndexManualSetBased(queue: OIMEventQueue, opts: {
 })
 ```
 
-Pass exactly one binding: `collection` for normal collection-bound indexes, or `resolveSlot` for custom slot resolution.
+Pass exactly one binding: `collection` for normal collection-bound indexes, or `getSlot` for custom slot lookup.
 
 **Methods:**
 - `setPks(key: TKey, pks: readonly TPk[]): void` - Set primary keys for index key
@@ -1522,7 +1541,7 @@ new OIMReactiveCollectionIndexManualArrayBased(queue: OIMEventQueue, opts: {
         store?: OIMIndexStoreArrayBased<TKey, TPk>;
     };
 } | {
-    resolveSlot: TOIMEntitySlotResolver<TPk>;
+    getSlot: TOIMEntitySlotGetter<TPk>;
     indexOptions?: {
         comparePks?: TOIMIndexComparator<TPk>;
         store?: OIMIndexStoreArrayBased<TKey, TPk>;
@@ -1530,7 +1549,7 @@ new OIMReactiveCollectionIndexManualArrayBased(queue: OIMEventQueue, opts: {
 })
 ```
 
-Pass exactly one binding: `collection` for normal collection-bound indexes, or `resolveSlot` for custom slot resolution.
+Pass exactly one binding: `collection` for normal collection-bound indexes, or `getSlot` for custom slot lookup.
 
 **Methods:**
 - `setPks(key: TKey, pks: readonly TPk[]): void` - Set primary keys for index key