@webkrafters/eagleeye 1.0.0-beta.1 → 1.0.0-beta.3

package/README.md

@@ -78,36 +78,36 @@ const state = store.getState( Array<string> );
 const unsubscribeFn = store.subscribe( eventType, listener );
 ```
 
-### Connecting to context stream.
-A context stream allows for a client to set up automatic update to to be automatically pushed to it whenever its slice of state changes.
+### Joining the context stream.
+A context stream allows a client to set up a dedicated channel through which it receives automatic updates whenever its selected slices of state change. It can also update the context through this channel.
 ```tsx
 const useStream = context.stream;
 // joining the stream twice
 // for more on selectorMap - https://eagleeye.js.org/concepts/selector-map/
-const streamer1 = useStream(SelectorMap?);
-const streamer2 = useStream(SelectorMap?);
-// check whether a streamer still defunct or still active
-if( streamer1.closed ) { ... };
-// access the current data value monitored by this streamer
-console.log( 'data', streamer1.data );
-// access the streamer current lifecycle
-console.log( 'life cycle', streamer1.phase );
-// check if the streamer is streaming
-if( streamer1.streaming ) { ... };
-// change a streamer's selector map 
-streamer1.seletorMap = SelectorMap<T>?;
-// add listener to a streamer to react to live updates to selected data.
-streamer1.addListener( 'data-changed', listener );
-// be notified of a streamer's exist from streaming.
-streamer1.addListener( 'stream-ending', listener );
-// remove listener from a streamer activities
-streamer1.removeListener( 'data-changed'|'stream-ending', listener );
+const channel1 = useStream(SelectorMap?);
+const channel2 = useStream(SelectorMap?);
+// check whether a channel is still active or defunt
+if( channel1.closed ) { ... };
+// access the current data value monitored by this channel
+console.log( 'data', channel1.data );
+// access the channel current lifecycle
+console.log( 'life cycle', channel1.phase );
+// check if the channel is streaming
+if( channel1.streaming ) { ... };
+// change a channel's selector map 
+channel1.seletorMap = SelectorMap<T>?;
+// add listener to a channel to react to live updates to selected data.
+channel1.addListener( 'data-changed', listener );
+// be notified of a channel's exit from stream.
+channel1.addListener( 'stream-ending', listener );
+// remove listener from a channel activities
+channel1.removeListener( 'data-changed'|'stream-ending', listener );
 // https://eagleeye.js.org/concepts/store/resetstate/
-streamer1.resetState( Array<string>? ); // changes are context-wide
+channel1.resetState( Array<string>? ); // changes are context-wide
 // https://eagleeye.js.org/concepts/store/setstate/
-streamer1.setState( Changes<T> ); // changes are context-wide
-// exit streamer from streaming
-streamer1.endStream();
+channel1.setState( Changes<T> ); // changes are context-wide
+// exit channel from stream
+channel1.endStream();
 ```
 
 ### Accessing underlying cache.

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import type { Changes as BaseChanges, Immutable as AutoImmutable, Value } from '@webkrafters/auto-immutable';
 import { FULL_STATE_SELECTOR } from './constants';
-import { createEagleEye, Streamer } from './main';
-export type { BaseType, ClearCommand, KeyType, MoveCommand, PushCommand, ReplaceCommand, SetCommand, SpliceCommand, TagCommand, TagType, UpdateStats, UpdatePayload, UpdatePayloadArray } from '@webkrafters/auto-immutable';
+import { createEagleEye, Channel } from './main';
+export type { BaseType, ClearCommand, Immutable as AutoImmutable, KeyType, MoveCommand, PushCommand, ReplaceCommand, SetCommand, SpliceCommand, TagCommand, TagType, UpdateStats, UpdatePayload, UpdatePayloadArray } from '@webkrafters/auto-immutable';
 export type State = Value;
 export type ShutdownMonitor = (reason: ShutdownReason) => void;
 export type Listener = <T extends State>(changes: Changes<T>, changedPathsTokens: Readonly<Array<Array<string>>>, netChanges: Readonly<T>, mayHaveChangesAt: (pathTokens: Array<string>) => boolean) => void;
@@ -90,11 +90,11 @@ export interface StoreInternal<T extends State = State> extends StoreRef<T> {
     closed: boolean;
 }
 export interface BaseStream<T extends State = State> {
-    <S extends SelectorMap>(selectorMap?: S): Streamer<T, S>;
+    <S extends SelectorMap>(selectorMap?: S): Channel<T, S>;
 }
 export interface Stream<T extends State = State> extends BaseStream<T> {
     <S extends SelectorMap>(selectorMap?: S): Store<T, S>;
 }
 export { CLEAR_TAG, DELETE_TAG, FULL_STATE_SELECTOR, MOVE_TAG, NULL_SELECTOR, PUSH_TAG, REPLACE_TAG, SET_TAG, SPLICE_TAG, Tag, } from './constants';
-export { createEagleEye, EagleEyeContext, Streamer } from './main';
+export { Channel, createEagleEye, EagleEyeContext } from './main';
 export default createEagleEye;

package/dist/index.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.Streamer = exports.EagleEyeContext = exports.createEagleEye = exports.Tag = exports.SPLICE_TAG = exports.SET_TAG = exports.REPLACE_TAG = exports.PUSH_TAG = exports.NULL_SELECTOR = exports.MOVE_TAG = exports.FULL_STATE_SELECTOR = exports.DELETE_TAG = exports.CLEAR_TAG = exports.ShutdownReason = exports.Phase = void 0;
+exports.EagleEyeContext = exports.createEagleEye = exports.Channel = exports.Tag = exports.SPLICE_TAG = exports.SET_TAG = exports.REPLACE_TAG = exports.PUSH_TAG = exports.NULL_SELECTOR = exports.MOVE_TAG = exports.FULL_STATE_SELECTOR = exports.DELETE_TAG = exports.CLEAR_TAG = exports.ShutdownReason = exports.Phase = void 0;
 var main_1 = require("./main");
 ;
 ;
@@ -87,22 +87,22 @@ Object.defineProperty(exports, "Tag", {
   }
 });
 var main_2 = require("./main");
-Object.defineProperty(exports, "createEagleEye", {
+Object.defineProperty(exports, "Channel", {
   enumerable: true,
   get: function get() {
-    return main_2.createEagleEye;
+    return main_2.Channel;
   }
 });
-Object.defineProperty(exports, "EagleEyeContext", {
+Object.defineProperty(exports, "createEagleEye", {
   enumerable: true,
   get: function get() {
-    return main_2.EagleEyeContext;
+    return main_2.createEagleEye;
   }
 });
-Object.defineProperty(exports, "Streamer", {
+Object.defineProperty(exports, "EagleEyeContext", {
   enumerable: true,
   get: function get() {
-    return main_2.Streamer;
+    return main_2.EagleEyeContext;
   }
 });
 exports["default"] = main_1.createEagleEye;

package/dist/main/index.d.ts

@@ -6,7 +6,7 @@ export declare const deps: {
     createStorageKey: () => string;
 };
 export declare const ACCESS_SYM: unique symbol;
-export declare class Streamer<T extends State = State, S extends SelectorMap = SelectorMap> implements Store<T, S> {
+export declare class Channel<T extends State = State, S extends SelectorMap = SelectorMap> implements Store<T, S> {
     private _context;
     private _internalStore;
     private _data;

package/dist/main/index.js

@@ -118,7 +118,7 @@ var __importDefault = void 0 && (void 0).__importDefault || function (mod) {
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.EagleEyeContext = exports.Streamer = exports.ACCESS_SYM = exports.deps = void 0;
+exports.EagleEyeContext = exports.Channel = exports.ACCESS_SYM = exports.deps = void 0;
 exports.createEagleEye = createEagleEye;
 exports.mkReadonly = mkReadonly;
 var lodash_isboolean_1 = __importDefault(require("lodash.isboolean"));
@@ -169,7 +169,7 @@ var Event = /*#__PURE__*/function () {
     }
   }]);
 }();
-var Streamer = function () {
+var Channel = function () {
   var _a;
   var _instanceExtraInitializers = [];
   var _set_selectorMap_decorators;
@@ -181,9 +181,9 @@ var Streamer = function () {
   var _subscribe_decorators;
   var _unsubscribe_decorators;
   return _a = /*#__PURE__*/function () {
-    function Streamer(context, selectorMap) {
+    function Channel(context, selectorMap) {
       var _this = this;
-      _classCallCheck(this, Streamer);
+      _classCallCheck(this, Channel);
       this._context = (__runInitializers(this, _instanceExtraInitializers), null);
       this._internalStore = null;
       this._data = {};
@@ -243,7 +243,7 @@ var Streamer = function () {
       this._integrateSelectors(selectorMap);
       this._phase = __1.Phase.OPENED;
     }
-    return _createClass(Streamer, [{
+    return _createClass(Channel, [{
       key: "closed",
       get: function get() {
         return !this._internalStore || this._internalStore.closed;
@@ -517,7 +517,7 @@ var Streamer = function () {
     });
   }(), _a;
 }();
-exports.Streamer = Streamer;
+exports.Channel = Channel;
 var EagleEyeContext = function () {
   var _a;
   var _instanceExtraInitializers = [];
@@ -546,7 +546,7 @@ var EagleEyeContext = function () {
       };
       this.storageKey = null;
       this._stream = function (selectorMap) {
-        return new Streamer(_this3, selectorMap);
+        return new Channel(_this3, selectorMap);
       };
       if (!(value instanceof auto_immutable_1["default"])) {
         this.inchoateValue = value;

package/package.json

@@ -97,7 +97,7 @@
     "test:watch": "eslint --fix && jest --updateSnapshot --watchAll"
   },
   "types": "dist/index.d.ts",
-  "version": "1.0.0-beta.1",
+  "version": "1.0.0-beta.3",
   "dependencies": {
     "@webkrafters/auto-immutable": "^2.0.5"
   }