@webkrafters/eagleeye 1.0.0-beta.4 → 1.0.0

package/README.md

@@ -11,11 +11,11 @@
 	<a href="https://coveralls.io/github/webKrafters/eagleeye.js">
 		<img alt="coverage" src="https://img.shields.io/coveralls/github/webKrafters/eagleeye.js">
 	</a>
-	<img alt="NPM" src="https://img.shields.io/npm/l/@webkrafters/eagleeye.js">
+	<img alt="NPM" src="https://img.shields.io/npm/l/@webkrafters/eagleeye">
 	<img alt="Maintenance" src="https://img.shields.io/maintenance/yes/2032">
-	<img alt="build size" src="https://img.shields.io/bundlephobia/minzip/@webkrafters/eagleeye.js?label=bundle%20size">
-	<a href="https://www.npmjs.com/package/@webKrafters/eagleeye.js">
-		<img alt="Downloads" src="https://img.shields.io/npm/dt/@webkrafters/eagleeye.js.svg">
+	<img alt="build size" src="https://img.shields.io/bundlephobia/minzip/@webkrafters/eagleeye?label=bundle%20size">
+	<a href="https://www.npmjs.com/package/@webKrafters/eagleeye">
+		<img alt="Downloads" src="https://img.shields.io/npm/dt/@webkrafters/eagleeye.svg">
 	</a>
 	<img alt="GitHub package.json version" src="https://img.shields.io/github/package-json/v/webKrafters/eagleeye.js">
 </p>
@@ -28,126 +28,15 @@
 
 <br />
 <p><b>Name:</b> Eagle Eye.</p>
-<p>
-<b>Install:</b>
-npm install --save @webkrafters/eagleeye
-</p>
+
 <br />
 
 ## Usage:
-### Create (the FP way).
-```tsx
-import { createEagleEye } from '@webkrafters/eagleeye';
-const context = createEagleEye({
-	prehooks?: Prehooks<T>,
-	storage?: Storage<T>,
-	value?: T|AutoImmutable<T>
-});
-```
-### Create (the OOP way).
-```tsx
-import { EagleEyeContext } from '@webkrafters/eagleeye';
-const context = new EagleEyeContext<T>(
-	T?|AutoImmutable<T>?,
-	Prehooks<T>?,
-	Storage<T>?
-);
-```
-
-### Releasing context resources.
-```tsx
-context.dispose();
-```
-Deactivates this context by:
-<ol>
-	<li>unsubscribing all observers to it</li>
-	<li>severing connections to data stores</li>
-	<li>unsetting all resources</li>
-</ol>
-
-### Accessing external store reference.
-```tsx
-const store = context.store;
-// https://eagleeye.js.org/concepts/store/resetstate/
-store.resetState( Array<string>? );
-// https://eagleeye.js.org/concepts/store/setstate/
-store.setState( Changes<T> );
-// https://eagleeye.js.org/concepts/store/getstate/
-const state = store.getState( Array<string> );
-// https://eagleeye.js.org/concepts/store/subscribe/
-const unsubscribeFn = store.subscribe( eventType, listener );
-```
-
-### 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 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/
-channel1.resetState( Array<string>? ); // changes are context-wide
-// https://eagleeye.js.org/concepts/store/setstate/
-channel1.setState( Changes<T> ); // changes are context-wide
-// exit channel from stream
-channel1.endStream();
-```
-
-### Accessing underlying cache.
-```tsx
-const cache = context.cache;
-```
-
-### Accessing `close` status.
-```tsx
-const closed = context.closed;
-```
-
-### Accessing current state update `prehooks`.
-```tsx
-const prehooks = context.prehooks;
-```
-
-### Updating state update `prehooks`.
-```tsx
-context.prehooks = Prehooks<T>?;
-```
 
-### Accessing context `storage`.
-```tsx
-const storage = context.storage;
-```
+Please consult the [Getting Started](https://eagleeye.js.org/gettiing-started) page to quick information regarding usage.
 
-### Updating context `storage`.
-```tsx
-context.storage = storage<T>?;
-```
+There are also framework specific Eagle-Eye installations such as the [React Observable Context](https://www.npmjs.com/package/@webkrafters/react-observable-context).
 
-## Notable Mentions:
-<ul>
-	<li>Facilitates sharing of underlying immutable data structure among multiple applications</li>
-	<li>Update-friendly Auto-immutable bearing context. See <a href="https://eagleeye.js.org/concepts/store/setstate"><code>store.setState</code></a>.</li>
-	<li> Recognizes <b>negative array indexing</b>. Please see <a href="https://eagleeye.js.org/concepts/property-path">Property Path</a> and <code>store.setState</code> <a href="https://eagleeye.js.org/concepts/store/setstate#indexing">Indexing</a>.</li>
-	<li> Only automatically notifying subscribing or stream (<a href="https://eagleeye.js.org/concepts/client">clients</a>) on context state changes.</li>
-	<li> Subscribers decide which exact context state properties' changes to monitor.</li>
-</ul>
 
 ## Please see more documentation here:
 **[eagleeye.js.org](https://eagleeye.js.org)**

package/package.json

@@ -1,5 +1,5 @@
 {
-  "alias": "Eagle eye context",
+  "alias": "Eagle Eye JS",
   "author": "Stephen Isienyi <stephen.isienyi@webkrafters.tech>",
   "bugs": {
     "url": "https://github.com/webKrafters/eagleeye.js/issues"
@@ -69,7 +69,7 @@
     "state management",
     "state manager"
   ],
-  "license": "MIT",
+  "license": "GPL-3.0-only",
   "main": "dist/index.js",
   "name": "@webkrafters/eagleeye",
   "peerDependencies": {
@@ -97,7 +97,7 @@
     "test:watch": "eslint --fix && jest --updateSnapshot --watchAll"
   },
   "types": "dist/index.d.ts",
-  "version": "1.0.0-beta.4",
+  "version": "1.0.0",
   "dependencies": {
     "@webkrafters/auto-immutable": "^2.0.5"
   }