Merge pull request #70 from webKrafters/upgrade-cache

Upgrade cache

Author: steveswork

jest.config.js

@@ -1,28 +1,28 @@
 module.exports = {
-    collectCoverageFrom: [
-        'src/**/*.ts'
-    ],
-    coveragePathIgnorePatterns: [
-        'src/constants',
-        'src/test-artifacts',
-        'src/main/test-apps',
-        'src/index.ts'
-    ],
-    globals: {
-        'ts-jest': {
-            tsConfig: 'tsconfig.json',
-            diagnostics: false,
-        },
-    },
-    setupFiles: [
-        '<rootDir>/setupTests.js'
-    ],
-    testEnvironment: 'jsdom',
-    testEnvironmentOptions: {
-        url: 'http://localhost/'
-    },
-    transform: {
-        '\\.[jt]sx?$': 'ts-jest'
-    }
+	collectCoverageFrom: [
+		'src/**/*.ts',
+		'src/**/*.tsx'
+	],
+	coveragePathIgnorePatterns: [
+		'src/constants',
+		'src/test-artifacts',
+		'src/main/test-apps',
+		'src/index.ts'
+	],
+	globals: {
+		'ts-jest': {
+			tsConfig: 'tsconfig.json',
+			diagnostics: false
+		}
+	},
+	setupFiles: [
+		'<rootDir>/setupTests.js'
+	],
+	testEnvironment: 'jsdom',
+	testEnvironmentOptions: {
+		url: 'http://localhost/'
+	},
+	transform: {
+		'\\.[jt]sx?$': 'ts-jest'
+	}
 };
-

package-lock.json

@@ -21,10 +21,11 @@
     "@testing-library/user-event": "^14.4.3",
     "@types/jest": "^29.5.12",
     "@types/jest-cli": "^24.3.0",
+    "@types/lodash.isempty": "^4.4.9",
     "@types/node": "^20.11.28",
-    "@webkrafters/auto-immutable": "^1.0.3",
     "@webkrafters/clone-total": "^1.0.1",
     "@webkrafters/data-distillery": "^0.1.1",
+    "@webkrafters/get-property": "^2.0.0",
     "@webkrafters/path-dotize": "0.0.2",
     "babel-loader": "^9.1.3",
     "eslint": "^8.57.0",
@@ -54,20 +55,20 @@
   },
   "files": [
     "logo.png",
-    "dist/main/hooks/use-store/index.js",
-    "dist/main/hooks/use-store/index.d.ts",
-    "dist/main/hooks/use-render-key-provider/index.js",
-    "dist/main/hooks/use-render-key-provider/index.d.ts",
-    "dist/main/hooks/use-prehooks-ref/index.js",
-    "dist/main/hooks/use-prehooks-ref/index.d.ts",
-    "dist/model/storage/index.js",
-    "dist/model/storage/index.d.ts",
-    "dist/main/index.js",
-    "dist/main/index.d.ts",
-    "dist/index.js",
-    "dist/index.d.ts",
-    "dist/constants.js",
-    "dist/constants.d.ts"
+    "dist\\main\\hooks\\use-store\\index.js",
+    "dist\\main\\hooks\\use-store\\index.d.ts",
+    "dist\\main\\hooks\\use-render-key-provider\\index.js",
+    "dist\\main\\hooks\\use-render-key-provider\\index.d.ts",
+    "dist\\main\\hooks\\use-prehooks-ref\\index.js",
+    "dist\\main\\hooks\\use-prehooks-ref\\index.d.ts",
+    "dist\\model\\storage\\index.js",
+    "dist\\model\\storage\\index.d.ts",
+    "dist\\main\\index.js",
+    "dist\\main\\index.d.ts",
+    "dist\\index.js",
+    "dist\\index.d.ts",
+    "dist\\constants.js",
+    "dist\\constants.d.ts"
   ],
   "homepage": "https://eagleeye.js.org",
   "keywords": [
@@ -93,7 +94,6 @@
   "name": "@webkrafters/react-observable-context",
   "peerDependencies": {
     "@types/react": ">= 16.8.0",
-    "@webkrafters/auto-immutable": "^1.0.2",
     "@webkrafters/clone-total": "^1.0.1",
     "@webkrafters/data-distillery": "^0.0.3",
     "@webkrafters/path-dotize": "^0.0.2",
@@ -120,5 +120,8 @@
     "test:watch": "eslint --fix && jest --updateSnapshot --watchAll"
   },
   "types": "dist/index.d.ts",
-  "version": "5.0.4"
-}
+  "version": "6.0.0-rc.0",
+  "dependencies": {
+    "@webkrafters/auto-immutable": "^2.0.0-rc.9"
+  }
+}

package.json

@@ -1 +1 @@
-import 'setimmediate';
+import 'setimmediate';

setupTests.js

@@ -12,4 +12,3 @@ export {
 } from '@webkrafters/auto-immutable';
 
 export const FULL_STATE_SELECTOR = '@@STATE';
-

src/constants.ts

@@ -1,6 +1,5 @@
 import type {
     ComponentType,
-    Context,
     ForwardRefExoticComponent, 
     MemoExoticComponent,
     NamedExoticComponent,
@@ -13,7 +12,8 @@ import type {
     Changes as BaseChanges,
     Connection,
     Immutable,
-    Value,
+    KeyType,
+    Value
 } from '@webkrafters/auto-immutable';
 
 import { FULL_STATE_SELECTOR } from './constants';
@@ -36,16 +36,12 @@ export type {
 
 export type State = Value;
 
-export type ObservableContext<T extends State> = IObservableContext<T> | PublicObservableContext<T>;
-
-export type PublicObservableContext<T extends State> = WithObservableProvider<Context<Store<T>>, T>;
-
-export type IObservableContext<T extends State> = WithObservableProvider<Context<IStore>, T>;
-
-export type WithObservableProvider<
-    LOCAL_DATA extends Record<any, any> = {},
-    T extends State = State
-> = LOCAL_DATA & { Provider: ObservableProvider<T> };
+export type Listener<T extends State = {}> = (
+    changes : Readonly<T>,
+    hasChangedPath : (
+        pathTokens : Array<string>
+    ) => boolean
+) => void;
 
 export type ObservableProvider<T extends State> = ForwardRefExoticComponent<
     ProviderProps<T> &
@@ -81,7 +77,12 @@ export type PropsExtract<C, STATE extends State, SELECTOR_MAP extends SelectorMa
 			? U extends OwnProps ? U : IProps
 			: IProps;
 
-export type InjectedProps<P extends IProps = IProps> = {[K in keyof P]: P[K]};
+export type ExtractInjectedProps<
+    STATE extends State = State,
+    SELECTOR_MAP extends SelectorMap = SelectorMap,
+    ALL_PROPS extends OwnProps = OwnProps
+> = Omit<ALL_PROPS, keyof Store<STATE>|keyof SELECTOR_MAP>
+
 
 export interface IProps { ref?: unknown }
 
@@ -97,12 +98,51 @@ export type ArraySelector = Array<Text | FullStateSelector>;
 
 export type SelectorMap = ObjectSelector | ArraySelector | void;
 
-export type Data<SELECTOR_MAP extends SelectorMap> = (
+type ReplacePathSeps<
+    P extends Text,
+    T extends string,
+> = P extends `${infer U}${T}${infer V}`
+    ? ReplacePathSeps<`${U}.${V}`, T>
+    : P;
+
+type TrimPathSep<P extends Text> = P extends `${infer U}]${never}` ? U : P;
+
+type NormalizePath<P extends Text> = TrimPathSep<
+    ReplacePathSeps<
+        ReplacePathSeps<
+            ReplacePathSeps<
+                P,
+                ']['
+            >,
+            '].'
+        >,
+        '['
+    >
+>;
+
+type Datum<
+    P extends Text,
+    S extends Record<Text, any> = State
+> = P extends `${infer K}.${infer P_1}`
+    ? Datum<P_1, S[K]>
+    : P extends ''
+    ? S
+    : any;
+
+type DataPoint<
+    P extends Text,
+    S extends State
+> = P extends FullStateSelector ? S : Datum<NormalizePath<P>, S>;
+
+export type Data<
+    SELECTOR_MAP extends SelectorMap,
+    STATE extends State = State
+> = (
     SELECTOR_MAP extends ObjectSelector
-    ? { [selectorKey in keyof SELECTOR_MAP]: Readonly<any> }
+    ? {[ S_KEY in keyof SELECTOR_MAP ] : DataPoint<SELECTOR_MAP[S_KEY], STATE> }
     : SELECTOR_MAP extends ArraySelector
-    ? { [selectorKey: number]: Readonly<any> }
-    : never
+    ? {[ S_NUM : number ] : DataPoint<SELECTOR_MAP[number], STATE>}
+    : Array<any>
 );
 
 export type Changes<T extends State = State> = BaseChanges<T>;
@@ -116,9 +156,7 @@ export interface IStorage<T extends State = State> {
 
 export type NonReactUsageReport = (...args: Array<unknown>) => void;
 
-export type Listener = <T extends State>(changes: Changes<T>) => void;
-
-export type PartialState<T extends State> = Partial<T>;
+export type PartialState<T extends State> = T extends Partial<infer U> ? T : Partial<T>;
 
 export interface Prehooks<T extends State = State> {
     resetState?: (
@@ -131,6 +169,8 @@ export interface Prehooks<T extends State = State> {
     setState?: (newChanges: Changes<T>) => boolean;
 };
 
+export type Subscribe = <T extends State>( listener : Listener<T> ) => Unsubscribe;
+
 export type Unsubscribe = (...args: Array<unknown>) => void;
 
 export interface IStore {
@@ -152,10 +192,10 @@ export interface Store<
 };
 
 export interface StoreInternal<T extends State> extends IStoreInternal {
-    cache: Immutable<T>,
+    cache: Immutable<Partial<T>>,
     resetState: (connection: Connection<T>, propertyPaths?: Array<string>) => void;
     setState: (connection: Connection<T>, changes: Changes<T>) => void;
-    subscribe: (listener: Listener) => Unsubscribe;
+    subscribe: Subscribe;
 };
 
 export interface StorePlaceholder extends IStoreInternal {
@@ -169,7 +209,7 @@ export interface StoreRef<T extends State = State> extends StorePlaceholder {
     getState: () => T,
     resetState: (propertyPaths?: string[]) => void;
     setState: (changes: Changes<T>) => void;
-    subscribe: (listener: Listener) => Unsubscribe;
+    subscribe: Subscribe;
 }
 
 export {
@@ -188,6 +228,7 @@ export {
 export {
     connect,
     createContext,
+    ObservableContext,
     UsageError,
     useContext
-} from './main';
+} from './main';

src/index.ts

@@ -1,13 +1,15 @@
 import clonedeep from '@webkrafters/clone-total';
 
+import { SelectorMap } from '../../..';
+
 import useRenderKeyProvider from '.';
 
 import { renderHook } from '@testing-library/react';
 
 import '../../../test-artifacts/suppress-render-compat';
 
 describe( 'useRenderKeyProvider', () => {
-	let selectorMap;
+	let selectorMap : SelectorMap;
 	beforeAll(() => { selectorMap = { _a: 'a', _b: 'b', _c: 'c' } });
 	test( 'calculates new selectors for new selectorMap', () => {
 		const initialProps = clonedeep( selectorMap );
@@ -20,14 +22,17 @@ describe( 'useRenderKeyProvider', () => {
 		expect( result.current ).not.toBe( selectors );
 	} );
 	test( 'ensures no abrupt updates to selectors for new list with same selectorMap', () => {
-		const { result, rerender } = renderHook( useRenderKeyProvider, { initialProps: selectorMap } );
+		const { result, rerender } = renderHook(
+			useRenderKeyProvider, {
+				initialProps: selectorMap
+			}
+		);
 		const selectors = result.current;
 		rerender( clonedeep( selectorMap ) );
 		expect( result.current ).toBe( selectors );
 	} );
 	describe( 'productive call', () => {
-		let expected;
-		beforeAll(() => { expected = [ 'a', 'b', 'c' ] } );
+		let expected = [ 'a', 'b', 'c' ];
 		test.each([
 			[ 'object', { _a: 'a', _b: 'b', _c: 'c' } ],
 			[ 'array', [ 'a', 'b', 'c' ] ]
@@ -43,6 +48,7 @@ describe( 'useRenderKeyProvider', () => {
 		[ '{}', {} ]
 	])( 'empty selectoMap = %s', ( label, value ) => {
 		test( 'returns empty renderKeys list', () => {
+			// @ts-expect-error
 			const { result } = renderHook( useRenderKeyProvider, { initialProps: value } );
 			expect( result.current ).toEqual([]);
 		} );
@@ -59,9 +65,9 @@ describe( 'useRenderKeyProvider', () => {
 		test( 'throws Type error', () => {
 			try {
 				renderHook( useRenderKeyProvider, {
-					initialProps: value as unknown
+					initialProps: value as unknown as SelectorMap
 				} );
-			} catch( e ) {
+			} catch( e : any ) {
 				expect( e.constructor.name ).toEqual( 'TypeError' );
 				expect( e.message ).toEqual( 'Incompatible Selector Map type provided.' );
 			}

src/main/hooks/use-render-key-provider/index.test.tsx

@@ -5,7 +5,7 @@ import type {
 	Text
 } from '../../..';
 
-import { useRef } from 'react';
+import { useMemo, useRef } from 'react';
 
 import isPlainObject from 'lodash.isplainobject';
 
@@ -26,13 +26,15 @@ function useRenderKeyProvider( selectorMap : ObjectSelector ) : Array<Text>;
 function useRenderKeyProvider( selectorMap : SelectorMap ) : Array<Text>;
 function useRenderKeyProvider( selectorMap ) : Array<Text> {
 	const renderKeys = useRef<Array<Text>>([]);
-	const currKeys = getCurrKeys( selectorMap );
-	if( ( renderKeys.current.length !== currKeys.length ||
-		renderKeys.current.some(( k, i ) => k !== currKeys[ i ])
-	) ) {
-		renderKeys.current = currKeys;
-	}
-	return renderKeys.current;
+	return useMemo(() => {	
+		const currKeys = getCurrKeys( selectorMap );
+		if( ( renderKeys.current.length !== currKeys.length ||
+			renderKeys.current.some(( k, i ) => k !== currKeys[ i ])
+		) ) {
+			renderKeys.current = currKeys;
+		}
+		return renderKeys.current;
+	}, [ selectorMap ]);
 };
 
 export default useRenderKeyProvider;