@webkrafters/react-observable-context 4.1.3 → 4.1.5

package/dist/main/index.d.ts

@@ -8,12 +8,13 @@ export function createContext<T extends import("../types").State>(): ObservableC
 /**
  * Actively monitors the store and triggers component re-render if any of the watched keys in the state objects changes
  *
- * @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 {Store<T>}
- * @template {State} T
- * @see {ObservableContext<T>}
- * @example
+ * @param {ObservableContext<STATE>} context Refers to the PublicObservableContext<T> type of the ObservableContext<T>
+ * @param {SELECTOR_MAP} [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 {Store<STATE>}
+ * @template {State} STATE
+ * @template {SelectorMap<STATE>} [SELECTOR_MAP=SelectorMap<STATE>]
+ * @see {ObservableContext<STATE>}
+ * @exampleS
  * a valid property path follows the `lodash` object property path convention.
  * for a state = { a: 1, b: 2, c: 3, d: { e: 5, f: [6, { x: 7, y: 8, z: 9 } ] } }
  * Any of the following is an applicable selector map.
@@ -30,7 +31,7 @@ export function createContext<T extends import("../types").State>(): ObservableC
  * {myX: 'd.e.f[1].x'} or {myX: 'd.e.f.1.x'} => {myX: 7} // same applies to {myY: 'd.e.f[1].y'} = {myY: 8}; {myZ: 'd.e.f[1].z'} = {myZ: 9}
  * {myData: '@@STATE'} => {myData: state}
  */
-export function useContext<T extends import("../types").State>(context: ObservableContext<T>, selectorMap?: SelectorMap<T>): Store<T>;
+export function useContext<STATE extends import("../types").State, SELECTOR_MAP extends BaseSelectorMap<STATE> = BaseSelectorMap<STATE>>(context: ObservableContext<STATE>, selectorMap?: SELECTOR_MAP): Store<STATE>;
 
 /**
  * Provides an HOC function for connecting its WrappedComponent argument to the context store.
@@ -38,15 +39,16 @@ export function useContext<T extends import("../types").State>(context: Observab
  * 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.
+ * @param {SELECTOR_MAP} [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 {SelectorMap<STATE>} [SELECTOR_MAP=SelectorMap<STATE>]
  * @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<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 function connect<STATE extends import("../types").State, OWNPROPS extends import("../types").State = {}, SELECTOR_MAP extends BaseSelectorMap<STATE> = BaseSelectorMap<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?: SELECTOR_MAP): (WrappedComponent: C) => ConnectedComponent<OWNPROPS, Store<STATE>>;
 export type CLEAR_TAG = typeof CLEAR_TAG;
 
 /** @example changes = { property: CLEAR_TAG } */
@@ -131,7 +133,8 @@ export type StoreRef<T extends import("../types").State> = {
 export type State = import("../types").State;
 export type PartialState<T extends import("../types").State> = import("../types").PartialState<T>;
 export type Prehooks<T extends import("../types").State> = import("../types").Prehooks<T>;
-export type SelectorMap<T extends import("../types").State> = {
+export type SelectorMap<T extends import("../types").State = import("../types").State, MAP extends BaseSelectorMap<T> = BaseSelectorMap<T>> = MAP;
+export type BaseSelectorMap<T extends import("../types").State> = {
     [dataPropKey: string]: string | keyof T;
 } & {
     [dataPropKey: string]: "@@STATE";

package/package.json

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