@webkrafters/react-observable-context 4.2.0 → 4.4.0

package/README.md

@@ -648,6 +648,14 @@ store.setState({
 <h1 id="changes">What's Changed?</h1>
 
 <table>
+	<thead><tr><th>v4.4.0</th></tr></thead>
+	<tbody>
+		<tr><td><b>1.</b></td><td>Returns <code>undefined</code> for selector map pointing at a non-existent state slice. <i>(Previously returned <code>null</code>)</i></td></tr>
+	</tbody>
+	<thead><tr><th>v4.3.0</th></tr></thead>
+	<tbody>
+		<tr><td><b>1.</b></td><td>Added <code>React.Ref</code> forwarding to <code>connect</code>ed hoc client components.</td></tr>
+	</tbody>
 	<thead><tr><th>v4.1.0</th></tr></thead>
 	<tbody>
 		<tr><td><b>1.</b></td><td>Added new setState <a href="#setstate-tags">tags</a> to facilitate state update operations.</td></tr>

package/dist/main/index.d.ts

@@ -42,13 +42,15 @@ export function useContext<STATE extends import("../types").State, SELECTOR_MAP
  * @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, SELECTOR_MAP>>} - Connector HOC function
  * @template {State} STATE
- * @template {State} [OWNPROPS = {}]
+ * @template {OwnProps<State>} [OWNPROPS=OwnProps]
  * @template {SelectorMap<STATE>} [SELECTOR_MAP=SelectorMap<STATE>]
- * @template {ComponentType<ConnectedComponentProps<OWNPROPS, PartialStore<STATE, SELECTOR_MAP>>|ExoticComponent<ConnectedComponentProps<OWNPROPS, PartialStore<STATE, SELECTOR_MAP>>} [C = ComponentType<ConnectedComponentProps<OWNPROPS, PartialStore<STATE, SELECTOR_MAP>>]
+ * @template {ComponentType<ConnectedComponentProps<OWNPROPS, PartialStore<STATE, SELECTOR_MAP>>>|ExoticComponent<ConnectedComponentProps<OWNPROPS, PartialStore<STATE, SELECTOR_MAP>>>} [C = ComponentType<ConnectedComponentProps<OWNPROPS, PartialStore<STATE, SELECTOR_MAP>>>]
  * @see {ObservableContext<STATE,SELECTOR_MAP>}
  * @see {useContext} for selectorMap sample
  */
-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, SELECTOR_MAP>> | import("react").ExoticComponent<ComponentType<ConnectedComponentProps<OWNPROPS, PartialStore<STATE, SELECTOR_MAP>>>>> = ComponentType<ConnectedComponentProps<OWNPROPS, PartialStore<STATE, SELECTOR_MAP>>>>(context: ObservableContext<STATE, SELECTOR_MAP>, selectorMap?: SELECTOR_MAP): (WrappedComponent: C) => ConnectedComponent<OWNPROPS, Store<STATE, SELECTOR_MAP>>;
+export function connect<STATE extends import("../types").State, OWNPROPS extends Pick<import("../types").State, keyof import("../types").State> & {
+    ref?: unknown;
+} = {}, SELECTOR_MAP extends BaseSelectorMap<STATE> = BaseSelectorMap<STATE>, C extends ComponentType<ConnectedComponentProps<OWNPROPS, PartialStore<STATE, SELECTOR_MAP>>> | import("react").ExoticComponent<ComponentType<ConnectedComponentProps<OWNPROPS, PartialStore<STATE, SELECTOR_MAP>>>> = ComponentType<ConnectedComponentProps<OWNPROPS, PartialStore<STATE, SELECTOR_MAP>>>>(context: ObservableContext<STATE, SELECTOR_MAP>, selectorMap?: SELECTOR_MAP): (WrappedComponent: C) => ConnectedComponent<OWNPROPS, Store<STATE, SELECTOR_MAP>>;
 export type CLEAR_TAG = typeof CLEAR_TAG;
 
 /** @example changes = { property: CLEAR_TAG } */
@@ -144,8 +146,13 @@ export type PartialStore<T extends import("../types").State, SELECTOR_MAP extend
 export type Store<T extends import("../types").State, SELECTOR_MAP extends BaseSelectorMap<T> = BaseSelectorMap<T>> = import("../types").Store<T, SELECTOR_MAP>;
 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, BaseSelectorMap<import("../types").State>> = Store<import("../types").State, BaseSelectorMap<import("../types").State>>> = MemoExoticComponent<ConnectedComponentProps<OWNPROPS, STORE>>;
-export type ConnectedComponentProps<OWNPROPS extends import("../types").State = {}, STORE extends Store<import("../types").State, BaseSelectorMap<import("../types").State>> = Store<import("../types").State, BaseSelectorMap<import("../types").State>>> = STORE & OWNPROPS;
+export type ConnectedComponent<OWNPROPS extends Pick<import("../types").State, keyof import("../types").State> & {
+    ref?: unknown;
+} = {}, STORE extends Store<import("../types").State, BaseSelectorMap<import("../types").State>> = Store<import("../types").State, BaseSelectorMap<import("../types").State>>> = MemoExoticComponent<ConnectedComponentProps<OWNPROPS, STORE>>;
+export type ConnectedComponentProps<OWNPROPS extends Pick<import("../types").State, keyof import("../types").State> & {
+    ref?: unknown;
+} = {}, STORE extends Store<import("../types").State, BaseSelectorMap<import("../types").State>> = Store<import("../types").State, BaseSelectorMap<import("../types").State>>> = STORE & OWNPROPS;
+export type OwnProps<P extends import("../types").State = {}> = import("react").PropsWithRef<P>;
 export type NonReactUsageReport = import("../types").NonReactUsageReport;
 export type Data<SELECTOR_MAP extends BaseSelectorMap<import("../types").State> = BaseSelectorMap<import("../types").State>> = import("../types").Data<SELECTOR_MAP>;
 export type ReactNode = import("react").ReactNode;

package/dist/main/index.js

@@ -163,10 +163,12 @@ var connect = function connect(context, selectorMap) {
     if (!((0, _lodash3["default"])(WrappedComponent) && 'compare' in WrappedComponent)) {
       WrappedComponent = (0, _react.memo)(WrappedComponent);
     }
-    var ConnectedComponent = (0, _react.memo)(function (ownProps) {
+    var ConnectedComponent = (0, _react.memo)( (0, _react.forwardRef)(function (ownProps, ref) {
       var store = useContext(context, selectorMap);
-      return _react["default"].createElement(WrappedComponent, _extends({}, store, ownProps));
-    });
+      return _react["default"].createElement(WrappedComponent, _extends({}, store, ownProps, {
+        ref: ref
+      }));
+    }));
     ConnectedComponent.displayName = 'ObservableContext.Connected';
     return ConnectedComponent;
   };

package/dist/model/atom/index.d.ts

@@ -1,6 +1,6 @@
 export default Atom;
 declare class Atom<T> {
-    constructor(value?: any);
+    constructor(value?: T | Readonly<T>);
     get value(): Readonly<T>;
     connect(accessorId: number): number;
     disconnect(accessorId: number): number;

package/dist/model/atom/index.js

@@ -21,7 +21,7 @@ var _connections = new WeakMap();
 var _value = new WeakMap();
 var Atom = function () {
   function Atom() {
-    var value = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : null;
+    var value = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : undefined;
     _classCallCheck(this, Atom);
     _classPrivateFieldInitSpec(this, _connections, {
       writable: true,

package/package.json

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