@fedeghe/pangjs 0.0.4 → 0.0.6

package/README.md

@@ -1,4 +1,4 @@
-# PANGjs (0.0.4)
+# PANGjs (0.0.6)
 
 ![alt text](https://github.com/fedeghe/pangjs/blob/main/pangjs.png?raw=true "Pang js")
 
@@ -10,52 +10,48 @@ install it
 ``` sh
 > npm install @fedeghe/pangjs
 ```
+define an asynchronous reducer as:  
 
-All we need to do now is to:  
-- define an asynchronous reducer as:
-    ``` js
-    const reducer = async (oldState, action, payload) => {
-        const res = await fetch(targetUrl);
-        //
-        // your updates 
-        // 
-        return newState
-    }
-    ```
-
-
-now it's time to get a store and use it:
-
+``` js
+const reducer = async (oldState, action, payload) => {
+    const res = await fetch(targetUrl);
+    //
+    // your updates 
+    // 
+    return newState
+}
+```
+get a store and use it:
 
 ``` js  
+const PANGjs = require('@fedeghe/pangjs')
 const store = PANGjs.getStore( reducer, initState );
 
-// commit, change it only internally
-store.commit({
-    type: 'ADD',
-    payload: { number: 4 }
-})
-.then(s => console.log(
-    'here we get the unpushed state:', s
-));
-
-// for the changes to be effective we have to push
-store.push()
-    // here we get the pushed state
+// stage the results only internally
+store.stage({
+        type: 'ADD',
+        payload: { number: 4 }
+    })
+    // here we get staged state
+    .then(console.log);
+
+// make all staged changes effective
+store.dispatch()
+    // here we get the state
     .then(console.log);
 ```
-alternatively one single call just adding `true` as second parameter (semantically is 'autocommit'): 
+alternatively one single call just adding `true` as second parameter also dispatch: 
 ``` js
-store.commit({
+store.stage({
     type: 'ADD',
     payload: { number: 4 }
-}, true /* autocommit */) 
-.then(console.log); // here we get autopushed state
+}, true /* autoDispatch */) 
+.then(console.log); // here we get the  state
 ```
 
-alternatively it is possible to directly push the action:
+alternatively it is possible to directly dispatch the action:
 ``` js
-store.push({
+store.dispatch({
     type: 'ADD',
     payload: { number: 4 }},
 )
@@ -132,11 +128,11 @@ Every store obtained invoking successfully `PANGjs.getStore` exposes the followi
 
 ### `storeInstance.getState() -> state`
 
-returns the last pushed state
+returns the state
 
-### `storeInstance.commit(action, autoPush) -> Promise`
+### `storeInstance.stage(action, autoDispatch) -> Promise`
 
-commit or commit&push returning a promise resolving with new state (pushed or not); 
+stage or stage&dispatch returning a promise resolving with new state (staged or not); 
 
 **Parameters**: 
 - **action**:
@@ -146,25 +142,25 @@ commit or commit&push returning a promise resolving with new state (pushed or no
         payload: <Object>
     }
     ```
-- autoPush `<Boolean>` default `false`
+- autoDispatch `<Boolean>` default `false`
 
 
 
-### `storeInstance.push() -> Promise`
-push all the committed but unpushed changes.  
+### `storeInstance.dispatch() -> Promise`
+dispatch all the staged changes.  
 Only this operations calls subscribers.  
 
-Optionally it can recieve an action and that will be equivalent to commit and push:  
-`s.commit(action).then(() => s.push())`  
+Optionally it can recieve an action and that will be equivalent to stage and dispatch:  
+`s.stage(action).then(() => s.dispatch())`  
 act as
-`s.commit(action, true)`  
+`s.stage(action, true)`  
 and as
-`s.push(action))`
+`s.dispatch(action))`
 
 
 ### `storeInstance.subscribe(fn) -> unsubscribing function`
 
-allows to register a subscribing function that will be invoked everytime the state changes (pushed)  
+allows to register a subscribing function that will be invoked everytime the state changes (dispatched)  
 
 **returns**:  the unsubscribing function
 

package/dist/index.js

@@ -1,29 +1,29 @@
 'use strict';
 /*
 PANGjs
-v. 0.0.4
+v. 0.0.6
 
-Size: ~3.82KB
+Size: ~3.79KB
 */
-var PANGjs=function(){"use strict";function t(t,e){if("function"!=typeof t)throw new Error(e)}function e(t,e){if("Promise"!==t.constructor.name)throw new Error(e)}function n(t,e){
-if("number"!=typeof t)throw new Error(e)}function i(t,e){this.initState=t,this.states=[t],this.unpushedStates=[t],this.config=e,this.maxElements=Math.max(1,parseInt(this.config.maxElements,10))||1,
-this.index=0,this.unpushedIndex=0}function s(e,n,s){this.reducer=e||o,t(this.reducer,r.REDUCERS_FUNCTION),this.initState=n||{},this.config=s||{},this.config.check=this.config.check||function(){
-return!0},t(this.config.check,r.REDUCERS_FUNCTION),this.subscribers=[],this.previousAction="ORIGIN",this.HistoryManager=new i(this.initState,this.config)}var r={
+var PANGjs=function(){"use strict";function t(t,e){if("function"!=typeof t)throw new Error(e)}function e(t,e){if("Promise"!==t.constructor.name)throw new Error(e)}function s(t,e){
+if("number"!=typeof t)throw new Error(e)}function i(t,e){this.initState=t,this.states=[t],this.stagedStates=[t],this.config=e,this.maxElements=Math.max(1,parseInt(this.config.maxElements,10))||1,
+this.index=0,this.stagedIndex=0}function r(e,s,r){this.reducer=e||o,t(this.reducer,n.REDUCERS_FUNCTION),this.initState=s||{},this.config=r||{},this.config.check=this.config.check||function(){return!0
+},t(this.config.check,n.REDUCERS_FUNCTION),this.subscribers=[],this.previousAction="ORIGIN",this.HistoryManager=new i(this.initState,this.config)}var n={
 REDUCERS_FUNCTION:"[ERROR] Reducer must be a function!",REDUCERS_RETURN:"[ERROR] Reducer should return a promise!",REDUCERS_ASYNC:"[ERROR] Reducer should be asynchronous!",
 SUBSCRIBERS_FUNCTION:"[ERROR] Subscribers must be a functions!",ACTION_TYPE:"[ERROR] Actions needs a type!",UNAUTHORIZED_STATECHANGE:"[ERROR] State transition not allowed!",
-MOVE_TO_NUMBER:"[ERROR] Move requires a number!"};i.prototype.top=function(t){return this[t?"unpushedStates":"states"][this[t?"unpushedIndex":"index"]]},i.prototype.commit=function(t,e){
-var n=this.unpushedStates.slice(0,this.unpushedIndex+1);return n.push(t),this.maxElements&&n.length>this.maxElements?n.shift():this.unpushedIndex++,this.unpushedStates=n,e&&this.push(),this},
-i.prototype.push=function(){this.states=this.unpushedStates,this.index=this.unpushedIndex},i.prototype.reset=function(){this.index=0,this.states=[this.initState],this.unpushedIndex=0,
-this.unpushedStates=this.unpushedStates.slice(0,1)};var o=function(){return Promise.resolve({})};return s.prototype.getState=function(t){return this.HistoryManager.top(t)},
-s.prototype.uncommit=function(){if(1===this.HistoryManager.maxElements)return this;this.HistoryManager.unpushedIndex=this.HistoryManager.index,
-this.HistoryManager.unpuhedStates=this.HistoryManager.states},s.prototype.commit=function(t,n){if(!("type"in t))return Promise.reject(new Error(r.ACTION_TYPE))
-;var i=this,s=t.type,o=t.payload||{},u=this.getState(!0);if(!i.config.check(u,i.previousAction,s,o))return Promise.reject(new Error(r.UNAUTHORIZED_STATECHANGE));var h=this.reducer(u,s,o)
-;return e(h,r.REDUCERS_RETURN),this.previousAction=s,h.then(function(t){return i.HistoryManager.commit(t,n),n&&i.emit(t),t})},s.prototype.emit=function(t){this.subscribers.filter(function(t){
-return Boolean(t)}).forEach(function(e){e(t)})},s.prototype.push=function(t){if(t)return this.commit(t,!0);this.HistoryManager.push();var e=this.HistoryManager.top();return this.emit(e),
-Promise.resolve(e)},s.prototype.subscribe=function(e){t(e,r.SUBSCRIBERS_FUNCTION);var n,i=this;return this.subscribers.push(e),n=this.subscribers.length-1,function(){i.subscribers[n]=null}},
-s.prototype.move=function(t){if(n(t,r.MOVE_TO_NUMBER),1===this.HistoryManager.maxElements||this.HistoryManager.index!==this.HistoryManager.unpushedIndex||void 0===t||0===t)return this
-;var e=this.HistoryManager.index+t,i=e>-1&&e<this.HistoryManager.states.length,s=i?e:this.HistoryManager.index;return this.HistoryManager.index=s,this.HistoryManager.unpushedIndex=s,this},
-s.prototype.replaceReducer=function(e){return t(e,r.SUBSCRIBERS_FUNCTION),this.reducer=e,this},s.prototype.reset=function(){return this.HistoryManager.reset(),this.subscribers=[],this},{ERRORS:r,
-getStore:function(t,e,n){return new s(t,e,n)},isStore:function(t){return t instanceof s},combine:function(e){return e.forEach(function(e){t(e,r.REDUCERS_FUNCTION)}),function(t,n,i){
-var s=Object.assign({},t),r=e.length;return new Promise(function(t){return e.reduce(function(e,s,o){return e.then(function(e){return r-1===o?t(s(e,n,i)):s(e,n,i)})},Promise.resolve(s))})}}}}()
+MOVE_TO_NUMBER:"[ERROR] Move requires a number!"};i.prototype.top=function(t){return this[t?"stagedStates":"states"][this[t?"stagedIndex":"index"]]},i.prototype.stage=function(t,e){
+var s=this.stagedStates.slice(0,this.stagedIndex+1);return s.push(t),this.maxElements&&s.length>this.maxElements?s.shift():this.stagedIndex++,this.stagedStates=s,e&&this.sync(),this},
+i.prototype.sync=function(){this.states=this.stagedStates,this.index=this.stagedIndex},i.prototype.reset=function(){this.index=0,this.states=[this.initState],this.stagedIndex=0,
+this.stagedStates=this.stagedStates.slice(0,1)};var o=function(){return Promise.resolve({})};return r.prototype.getState=function(t){return this.HistoryManager.top(t)},r.prototype.unstage=function(){
+if(1===this.HistoryManager.maxElements)return this;this.HistoryManager.stagedIndex=this.HistoryManager.index,this.HistoryManager.stagedStates=this.HistoryManager.states},
+r.prototype.stage=function(t,s){if(!("type"in t))return Promise.reject(new Error(n.ACTION_TYPE));var i=this,r=t.type,o=t.payload||{},a=this.getState(!0)
+;if(!i.config.check(a,i.previousAction,r,o))return Promise.reject(new Error(n.UNAUTHORIZED_STATECHANGE));var u=this.reducer(a,r,o);return e(u,n.REDUCERS_RETURN),this.previousAction=r,
+u.then(function(t){return i.HistoryManager.stage(t,s),s&&i.emit(t),t})},r.prototype.emit=function(t){this.subscribers.filter(function(t){return Boolean(t)}).forEach(function(e){e(t)})},
+r.prototype.dispatch=function(t){if(t)return this.stage(t,!0);this.HistoryManager.sync();var e=this.HistoryManager.top();return this.emit(e),Promise.resolve(e)},r.prototype.subscribe=function(e){
+t(e,n.SUBSCRIBERS_FUNCTION);var s,i=this;return this.subscribers.push(e),s=this.subscribers.length-1,function(){i.subscribers[s]=null}},r.prototype.move=function(t){if(s(t,n.MOVE_TO_NUMBER),
+1===this.HistoryManager.maxElements||this.HistoryManager.index!==this.HistoryManager.stagedIndex||void 0===t||0===t)return this
+;var e=this.HistoryManager.index+t,i=e>-1&&e<this.HistoryManager.states.length,r=i?e:this.HistoryManager.index;return this.HistoryManager.index=r,this.HistoryManager.stagedIndex=r,this},
+r.prototype.replaceReducer=function(e){return t(e,n.SUBSCRIBERS_FUNCTION),this.reducer=e,this},r.prototype.reset=function(){return this.HistoryManager.reset(),this.subscribers=[],this},{ERRORS:n,
+getStore:function(t,e,s){return new r(t,e,s)},isStore:function(t){return t instanceof r},combine:function(e){return e.forEach(function(e){t(e,n.REDUCERS_FUNCTION)}),function(t,s,i){
+var r=Object.assign({},t),n=e.length;return new Promise(function(t){return e.reduce(function(e,r,o){return e.then(function(e){return n-1===o?t(r(e,s,i)):r(e,s,i)})},Promise.resolve(r))})}}}}()
 ;"object"==typeof exports&&(module.exports=PANGjs);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedeghe/pangjs",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "main": "dist/index.js",
   "author": "fedeghe <fedeghe@gmail.com>",
   "description": "Lightweight asynchronous state manager",