@webkrafters/react-observable-context 4.1.1 → 4.1.3

package/dist/main/hooks/use-store/index.d.ts

@@ -16,7 +16,7 @@ declare function useStore<T extends import("../../../types").State>(prehooks: Pr
         [propertyPaths: string]: Readonly<any>;
     };
     resetState: (propertyPaths?: string[]) => void;
-    setState: (changes: import("../../../types").UpdatePayload<import("../../../types").PartialState<T>>) => void;
+    setState: (changes: import("../../../types").Changes<T>) => void;
     state: T;
     subscribe: (listener: import("../../../types").Listener<T>) => VoidFunction;
     unlinkCache: (clientId: string) => void;

package/dist/main/index.d.ts

@@ -33,18 +33,20 @@ export function createContext<T extends import("../types").State>(): ObservableC
 export function useContext<T extends import("../types").State>(context: ObservableContext<T>, selectorMap?: SelectorMap<T>): Store<T>;
 
 /**
- * @param {ObservableContext<T>} context Refers to the PublicObservableContext<T> type of the ObservableContext<T>
- * @param {SelectorMap<T>} [selectorMap] Key:value pairs where `key` => arbitrary key given to a Store.data property holding a state slice and `value` => property path to a state slice used by this component: see examples below. May add a mapping for a certain arbitrary key='state' and value='@@STATE' to indicate a desire to obtain the entire state object and assign to a `state` property of Store.data. A change in any of the referenced properties results in this component render. When using '@@STATE', note that any change within the state object will result in this component render.
- * @returns {(WrappedComponent: C) => MemoExoticComponent<P>}
- * @template {State} T
- * @template {PartialStore<T> & {[x:string]:*}} [P=PartialStore<T>]
- * @template {ComponentType<P>|ExoticComponent<P>} C
- * @see {ObservableContext<T>}
+ * Provides an HOC function for connecting its WrappedComponent argument to the context store.
+ *
+ * The HOC function automatically memoizes any un-memoized WrappedComponent argument.
+ *
+ * @param {ObservableContext<STATE>} context - Refers to the PublicObservableContext<T> type of the ObservableContext<T>
+ * @param {SelectorMap<STATE>} [selectorMap] - Key:value pairs where `key` => arbitrary key given to a Store.data property holding a state slice and `value` => property path to a state slice used by this component: see examples below. May add a mapping for a certain arbitrary key='state' and value='@@STATE' to indicate a desire to obtain the entire state object and assign to a `state` property of Store.data. A change in any of the referenced properties results in this component render. When using '@@STATE', note that any change within the state object will result in this component render.
+ * @returns {(WrappedComponent: C) => ConnectedComponent<OWNPROPS, Store<STATE>>} - Connector HOC function
+ * @template {State} STATE
+ * @template {State} [OWNPROPS = {}]
+ * @template {ComponentType<ConnectedComponentProps<OWNPROPS, PartialStore<STATE>>|ExoticComponent<ConnectedComponentProps<OWNPROPS, PartialStore<STATE>>} [C = ComponentType<ConnectedComponentProps<OWNPROPS, PartialStore<STATE>>]
+ * @see {ObservableContext<STATE>}
  * @see {useContext} for selectorMap sample
  */
-export function connect<T extends import("../types").State, P extends PartialStore<T> & {
-    [x: string]: any;
-} = PartialStore<T>, C extends ComponentType<P> | import("react").ExoticComponent<ComponentType<P>>>(context: ObservableContext<T>, selectorMap?: SelectorMap<T>): (WrappedComponent: C) => MemoExoticComponent<P>;
+export function connect<STATE extends import("../types").State, OWNPROPS extends import("../types").State = {}, C extends ComponentType<ConnectedComponentProps<OWNPROPS, PartialStore<STATE>> | import("react").ExoticComponent<ComponentType<ConnectedComponentProps<OWNPROPS, PartialStore<STATE>>>>> = ComponentType<ConnectedComponentProps<OWNPROPS, PartialStore<STATE>>>>(context: ObservableContext<STATE>, selectorMap?: SelectorMap<STATE>): (WrappedComponent: C) => ConnectedComponent<OWNPROPS, Store<STATE>>;
 export type CLEAR_TAG = typeof CLEAR_TAG;
 
 /** @example changes = { property: CLEAR_TAG } */
@@ -123,7 +125,7 @@ export type StoreRef<T extends import("../types").State> = {
     getState: () => T;
 } & {
     resetState: (propertyPaths?: string[]) => void;
-    setState: (changes: import("../types").UpdatePayload<import("../types").PartialState<T>>) => void;
+    setState: (changes: import("../types").Changes<T>) => void;
     subscribe: (listener: import("../types").Listener<T>) => VoidFunction;
 };
 export type State = import("../types").State;
@@ -138,11 +140,13 @@ export type StoreInternal<T extends import("../types").State> = import("../types
 export type PartialStore<T extends import("../types").State> = {
     data?: import("../types").Data;
     resetState?: (propertyPaths?: string[]) => void;
-    setState?: (changes: import("../types").UpdatePayload<import("../types").PartialState<T>>) => void;
+    setState?: (changes: import("../types").Changes<T>) => void;
 };
 export type Store<T extends import("../types").State> = import("../types").Store<T>;
 export type IStore = import("../types").IStore;
 export type IStorage<T extends import("../types").State> = import("../types").IStorage<T>;
+export type ConnectedComponent<OWNPROPS extends import("../types").State = {}, STORE extends Store<import("../types").State> = Store<import("../types").State>> = MemoExoticComponent<ConnectedComponentProps<OWNPROPS, STORE>>;
+export type ConnectedComponentProps<OWNPROPS extends import("../types").State = {}, STORE extends Store<import("../types").State> = Store<import("../types").State>> = STORE & OWNPROPS;
 export type NonReactUsageReport = import("../types").NonReactUsageReport;
 export type Data = import("../types").Data;
 export type ReactNode = import("react").ReactNode;

package/dist/model/accessor-cache/index.d.ts

@@ -7,6 +7,6 @@ declare class AccessorCache<T extends import("../../types").State> {
         [propertyPaths: string]: Readonly<any>;
     };
     unlinkClient(clientId: string): void;
-    watchSource(changes: import("../../types").UpdatePayload<import("../../types").PartialState<T>>): void;
+    watchSource(changes: import("../../types").Changes<T>): void;
     #private;
 }

package/dist/types.d.ts

@@ -19,7 +19,7 @@ export type IStore = {
     subscribe: NonReactUsageReport;
 };
 export type KeyType = number | string | symbol;
-export type Listener<T extends State> = (changes: UpdatePayload<PartialState<T>>) => void;
+export type Listener<T extends State> = (changes: Changes<T>) => void;
 export type NonReactUsageReport = () => never;
 export type PartialState<T extends State> = { [K in keyof T]?: T[K]; };
 export type Prehooks<T extends State> = {
@@ -27,7 +27,7 @@ export type Prehooks<T extends State> = {
         current: T;
         original: T;
     }) => boolean;
-    setState?: (newChanges: PartialState<T>) => boolean;
+    setState?: (newChanges: Changes<T>) => boolean;
 };
 export type State = {
     [x: string]: any;
@@ -36,7 +36,7 @@ export type State = {
 };
 export type StoreInternal<T extends State> = {
     resetState: (propertyPaths?: string[]) => void;
-    setState: (changes: UpdatePayload<PartialState<T>>) => void;
+    setState: (changes: Changes<T>) => void;
 } & {
     getState: (clientId: string, ...propertyPaths?: string[]) => {
         [propertyPaths: string]: Readonly<any>;
@@ -47,8 +47,9 @@ export type StoreInternal<T extends State> = {
 export type Store<T extends State> = {
     data: Data;
     resetState: (propertyPaths?: string[]) => void;
-    setState: (changes: UpdatePayload<PartialState<T>>) => void;
+    setState: (changes: Changes<T>) => void;
 };
+export type Changes<T extends State> = UpdatePayload<PartialState<T>>;
 export type UpdateStats = {
     hasChanges: boolean;
 };

package/package.json

@@ -133,5 +133,5 @@
     "test:watch": "eslint --fix && jest --updateSnapshot --watchAll"
   },
   "types": "dist/main/index.d.ts",
-  "version": "4.1.1"
+  "version": "4.1.3"
 }