@oimdb/react 1.1.0 → 1.1.1

package/README.md

@@ -108,8 +108,7 @@ For applications with multiple collections, use the React Context pattern for ce
 ```typescript
 import { 
   OIMRICollectionsProvider, 
-  useOIMCollectionsContext,
-  StrictCollectionsDictionary 
+  useOIMCollectionsContext
 } from '@oimdb/react';
 
 interface User {
@@ -140,9 +139,148 @@ function createCollections() {
   return { users: usersCollection, teams: teamsCollection } as const;
 }
 
-type AppCollections = StrictCollectionsDictionary<ReturnType<typeof createCollections>>;
+type AppCollections = ReturnType<typeof createCollections>;
 ```
 
+## TypeScript Typing Strategies
+
+For maximum type safety, you should properly type your collections dictionary. There are two main approaches, similar to how Redux handles state typing:
+
+### Approach 1: Using `typeof` (Recommended for Simple Cases)
+
+The simplest approach is to use TypeScript's `typeof` operator to infer types from your collection instances:
+
+```typescript
+import { OIMEventQueue, OIMRICollection, OIMReactiveIndexManual } from '@oimdb/core';
+
+interface User {
+  id: string;
+  name: string;
+  teamId: string;
+}
+
+interface Team {
+  id: string;
+  name: string;
+}
+
+// Create collections
+const queue = new OIMEventQueue();
+const userTeamIndex = new OIMReactiveIndexManual<string, string>(queue);
+const usersCollection = new OIMRICollection(queue, {
+  collectionOpts: { selectPk: (user: User) => user.id },
+  indexes: { byTeam: userTeamIndex },
+});
+
+const teamsCollection = new OIMRICollection(queue, {
+  collectionOpts: { selectPk: (team: Team) => team.id },
+  indexes: {},
+});
+
+// Infer types using typeof
+const collections = {
+  users: usersCollection,
+  teams: teamsCollection,
+} as const;
+
+// Extract the type
+type AppCollections = typeof collections;
+```
+
+**Usage:**
+```typescript
+function MyComponent() {
+  const { users, teams } = useOIMCollectionsContext<AppCollections>();
+  // users and teams are fully typed with all their generics preserved
+}
+```
+
+### Approach 2: Creating Explicit Types (Recommended for Complex Projects)
+
+For larger applications or when you need more control, create explicit type definitions similar to Redux's approach:
+
+```typescript
+import { OIMEventQueue, OIMRICollection, OIMReactiveIndexManual } from '@oimdb/core';
+import type { TOIMPk, OIMIndex, OIMReactiveIndex } from '@oimdb/core';
+
+interface User {
+  id: string;
+  name: string;
+  teamId: string;
+}
+
+interface Team {
+  id: string;
+  name: string;
+}
+
+// Define your collection types explicitly
+type UserCollection = OIMRICollection<
+  User,
+  string,
+  'byTeam',
+  string,
+  OIMIndex<string, string>,
+  OIMReactiveIndex<string, string, OIMIndex<string, string>>
+>;
+
+type TeamCollection = OIMRICollection<
+  Team,
+  string,
+  never,
+  never,
+  OIMIndex<never, never>,
+  OIMReactiveIndex<never, never, OIMIndex<never, never>>
+>;
+
+// Define your collections dictionary type
+interface AppCollections {
+  users: UserCollection;
+  teams: TeamCollection;
+}
+
+// Factory function that returns properly typed collections
+function createCollections(): AppCollections {
+  const queue = new OIMEventQueue();
+  const userTeamIndex = new OIMReactiveIndexManual<string, string>(queue);
+  
+  return {
+    users: new OIMRICollection(queue, {
+      collectionOpts: { selectPk: (user: User) => user.id },
+      indexes: { byTeam: userTeamIndex },
+    }) as UserCollection,
+    
+    teams: new OIMRICollection(queue, {
+      collectionOpts: { selectPk: (team: Team) => team.id },
+      indexes: {},
+    }) as TeamCollection,
+  };
+}
+```
+
+**Usage:**
+```typescript
+function MyComponent() {
+  const { users, teams } = useOIMCollectionsContext<AppCollections>();
+  // Full type safety with explicit types
+}
+```
+
+### When to Use Each Approach
+
+- **Use `typeof`** when:
+  - You have simple collection setups
+  - You want TypeScript to infer everything automatically
+  - You prefer less boilerplate
+  - Your collections are created in one place
+
+- **Use explicit types** when:
+  - You need to share types across multiple files
+  - You want to document your data structure explicitly
+  - You're building a library or shared module
+  - You need to ensure type consistency across your application
+  - You prefer Redux-style explicit typing patterns
+
 ### Provider Setup
 
 ```typescript
@@ -306,17 +444,9 @@ Creates a custom collections context with specific typing.
 
 ### Type Utilities
 
-#### `StrictCollectionsDictionary<T>`
-
-Ensures collections dictionary maintains exact types.
-
 #### `CollectionsDictionary`
 
-Base type for any collections dictionary.
-
-#### `ExtractEntityType<T>`, `ExtractPkType<T>`, etc.
-
-Type utilities for extracting specific types from collections.
+Base type for any collections dictionary. Use `typeof` to extract types from your collection instances, or define explicit types using `OIMRICollection` generics.
 
 ## Architecture
 

package/dist/index.d.cts

@@ -10,9 +10,7 @@ declare const useSelectEntitiesByPks: <TEntity extends object, TPk extends TOIMP
 declare const useSelectEntitiesByIndexKey: <TEntity extends object, TPk extends TOIMPk, TKey extends TOIMPk, TIndex extends OIMIndex<TKey, TPk>>(reactiveCollection: OIMReactiveCollection<TEntity, TPk>, reactiveIndex: OIMReactiveIndex<TKey, TPk, TIndex>, key: TKey) => readonly TEntity[] | null;
 declare const useSelectEntitiesByIndexKeys: <TEntity extends object, TPk extends TOIMPk, TKey extends TOIMPk, TIndex extends OIMIndex<TKey, TPk>>(reactiveCollection: OIMReactiveCollection<TEntity, TPk>, reactiveIndex: OIMReactiveIndex<TKey, TPk, TIndex>, keys: readonly TKey[]) => readonly TEntity[] | null;
 
-type AnyOIMRICollection = OIMRICollection<object, TOIMPk, string, TOIMPk, any, any>;
-type CollectionsDictionary = Record<string, AnyOIMRICollection>;
-type TypedCollectionsDictionary<T extends CollectionsDictionary> = T;
+type CollectionsDictionary = Record<string, OIMRICollection<object, string, string, string, never, never>>;
 type OIMContextValue<T extends CollectionsDictionary = CollectionsDictionary> = T | null;
 declare const OIMRICollectionsContext: React.Context<OIMContextValue<CollectionsDictionary>>;
 declare function createOIMCollectionsContext<T extends CollectionsDictionary>(): React.Context<OIMContextValue<T>>;
@@ -23,23 +21,5 @@ interface OIMRICollectionsProviderProps<T extends CollectionsDictionary> {
 }
 declare function OIMRICollectionsProvider<T extends CollectionsDictionary>({ collections, children, context, }: OIMRICollectionsProviderProps<T>): react_jsx_runtime.JSX.Element;
 declare function useOIMCollectionsContext<T extends CollectionsDictionary = CollectionsDictionary>(context?: React.Context<OIMContextValue<T>>): T;
-type ExtractEntityType<T> = T extends OIMRICollection<infer E, TOIMPk, string, TOIMPk, any, any> ? E : never;
-type ExtractPkType<T> = T extends OIMRICollection<object, infer P, string, TOIMPk, any, any> ? P : never;
-type ExtractIndexNameType<T> = T extends OIMRICollection<object, TOIMPk, infer IN, TOIMPk, any, any> ? IN : never;
-type ExtractIndexKeyType<T> = T extends OIMRICollection<object, TOIMPk, string, infer IK, any, any> ? IK : never;
-type CreateCollectionsDictionary<T extends Record<string, AnyOIMRICollection>> = {
-    [K in keyof T]: T[K];
-};
-type ExtractCollectionSignature<T> = T extends OIMRICollection<infer E, infer P, infer IN, infer IK, infer I, infer RI> ? {
-    entity: E;
-    pk: P;
-    indexName: IN;
-    indexKey: IK;
-    index: I;
-    reactiveIndex: RI;
-} : never;
-type StrictCollectionsDictionary<T> = {
-    [K in keyof T]: T[K] extends OIMRICollection<infer E, infer P, infer IN, infer IK, infer I, infer RI> ? OIMRICollection<E, P, IN, IK, I, RI> : never;
-};
 
-export { type AnyOIMRICollection, type CollectionsDictionary, type CreateCollectionsDictionary, type ExtractCollectionSignature, type ExtractEntityType, type ExtractIndexKeyType, type ExtractIndexNameType, type ExtractPkType, type OIMContextValue, OIMRICollectionsContext, OIMRICollectionsProvider, type OIMRICollectionsProviderProps, type StrictCollectionsDictionary, type TypedCollectionsDictionary, createOIMCollectionsContext, useOIMCollectionsContext, useSelectEntitiesByIndexKey, useSelectEntitiesByIndexKeys, useSelectEntitiesByPks, useSelectEntityByPk, useSelectPksByIndexKey, useSelectPksByIndexKeys };
+export { type CollectionsDictionary, type OIMContextValue, OIMRICollectionsContext, OIMRICollectionsProvider, type OIMRICollectionsProviderProps, createOIMCollectionsContext, useOIMCollectionsContext, useSelectEntitiesByIndexKey, useSelectEntitiesByIndexKeys, useSelectEntitiesByPks, useSelectEntityByPk, useSelectPksByIndexKey, useSelectPksByIndexKeys };

package/dist/index.d.ts

@@ -10,9 +10,7 @@ declare const useSelectEntitiesByPks: <TEntity extends object, TPk extends TOIMP
 declare const useSelectEntitiesByIndexKey: <TEntity extends object, TPk extends TOIMPk, TKey extends TOIMPk, TIndex extends OIMIndex<TKey, TPk>>(reactiveCollection: OIMReactiveCollection<TEntity, TPk>, reactiveIndex: OIMReactiveIndex<TKey, TPk, TIndex>, key: TKey) => readonly TEntity[] | null;
 declare const useSelectEntitiesByIndexKeys: <TEntity extends object, TPk extends TOIMPk, TKey extends TOIMPk, TIndex extends OIMIndex<TKey, TPk>>(reactiveCollection: OIMReactiveCollection<TEntity, TPk>, reactiveIndex: OIMReactiveIndex<TKey, TPk, TIndex>, keys: readonly TKey[]) => readonly TEntity[] | null;
 
-type AnyOIMRICollection = OIMRICollection<object, TOIMPk, string, TOIMPk, any, any>;
-type CollectionsDictionary = Record<string, AnyOIMRICollection>;
-type TypedCollectionsDictionary<T extends CollectionsDictionary> = T;
+type CollectionsDictionary = Record<string, OIMRICollection<object, string, string, string, never, never>>;
 type OIMContextValue<T extends CollectionsDictionary = CollectionsDictionary> = T | null;
 declare const OIMRICollectionsContext: React.Context<OIMContextValue<CollectionsDictionary>>;
 declare function createOIMCollectionsContext<T extends CollectionsDictionary>(): React.Context<OIMContextValue<T>>;
@@ -23,23 +21,5 @@ interface OIMRICollectionsProviderProps<T extends CollectionsDictionary> {
 }
 declare function OIMRICollectionsProvider<T extends CollectionsDictionary>({ collections, children, context, }: OIMRICollectionsProviderProps<T>): react_jsx_runtime.JSX.Element;
 declare function useOIMCollectionsContext<T extends CollectionsDictionary = CollectionsDictionary>(context?: React.Context<OIMContextValue<T>>): T;
-type ExtractEntityType<T> = T extends OIMRICollection<infer E, TOIMPk, string, TOIMPk, any, any> ? E : never;
-type ExtractPkType<T> = T extends OIMRICollection<object, infer P, string, TOIMPk, any, any> ? P : never;
-type ExtractIndexNameType<T> = T extends OIMRICollection<object, TOIMPk, infer IN, TOIMPk, any, any> ? IN : never;
-type ExtractIndexKeyType<T> = T extends OIMRICollection<object, TOIMPk, string, infer IK, any, any> ? IK : never;
-type CreateCollectionsDictionary<T extends Record<string, AnyOIMRICollection>> = {
-    [K in keyof T]: T[K];
-};
-type ExtractCollectionSignature<T> = T extends OIMRICollection<infer E, infer P, infer IN, infer IK, infer I, infer RI> ? {
-    entity: E;
-    pk: P;
-    indexName: IN;
-    indexKey: IK;
-    index: I;
-    reactiveIndex: RI;
-} : never;
-type StrictCollectionsDictionary<T> = {
-    [K in keyof T]: T[K] extends OIMRICollection<infer E, infer P, infer IN, infer IK, infer I, infer RI> ? OIMRICollection<E, P, IN, IK, I, RI> : never;
-};
 
-export { type AnyOIMRICollection, type CollectionsDictionary, type CreateCollectionsDictionary, type ExtractCollectionSignature, type ExtractEntityType, type ExtractIndexKeyType, type ExtractIndexNameType, type ExtractPkType, type OIMContextValue, OIMRICollectionsContext, OIMRICollectionsProvider, type OIMRICollectionsProviderProps, type StrictCollectionsDictionary, type TypedCollectionsDictionary, createOIMCollectionsContext, useOIMCollectionsContext, useSelectEntitiesByIndexKey, useSelectEntitiesByIndexKeys, useSelectEntitiesByPks, useSelectEntityByPk, useSelectPksByIndexKey, useSelectPksByIndexKeys };
+export { type CollectionsDictionary, type OIMContextValue, OIMRICollectionsContext, OIMRICollectionsProvider, type OIMRICollectionsProviderProps, createOIMCollectionsContext, useOIMCollectionsContext, useSelectEntitiesByIndexKey, useSelectEntitiesByIndexKeys, useSelectEntitiesByPks, useSelectEntityByPk, useSelectPksByIndexKey, useSelectPksByIndexKeys };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oimdb/react",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "React integration for OIMDB - Hooks for selection and subscription with external storage",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -24,22 +24,28 @@
   },
   "scripts": {
     "build": "tsup src/index.ts --dts --format esm,cjs",
+    "test": "jest",
+    "type-check": "tsc --noEmit",
     "clean": "rimraf dist",
-    "prepublishOnly": "npm run build"
+    "prepublishOnly": "npm run type-check && npm test && npm run build"
   },
   "files": [
     "dist"
   ],
   "peerDependencies": {
-    "@oimdb/core": "^1.0.6",
+    "@oimdb/core": "^1.1.0",
     "react": "^18.0.0"
   },
   "devDependencies": {
-    "tsup": "^8.5.0",
-    "typescript": "^5.2.2",
-    "rimraf": "^5.0.5",
+    "@types/jest": "^29.5.8",
+    "@types/react": "^18.0.0",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
     "react": "^18.0.0",
-    "@types/react": "^18.0.0"
+    "rimraf": "^5.0.5",
+    "ts-jest": "^29.1.1",
+    "tsup": "^8.5.0",
+    "typescript": "^5.2.2"
   },
   "author": "Andrei Baikov",
   "license": "MIT"