@fedeghe/pangjs 0.0.1

package/README.md

@@ -0,0 +1,142 @@
+# PANGjs (0.0.1)
+
+![alt text](./pangjs.png "Pang js")
+
+
+# Simple asynchronous state manager
+
+install it 
+``` sh
+> npm install @fedeghe/pangjs
+```
+
+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),
+            newstate = {
+                ...oldState,
+                // your updates
+            }
+        return newState
+    }
+    ```
+
+
+now it's time to get a store and use it:
+
+
+``` js
+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
+    ));
+
+// to push the changes to be effective we have to push
+store.push()
+    // here we get the pushed state
+    .then(console.log);
+```
+alternatively one single call just adding `true` as second parameter (semantically is 'autocommit'): 
+``` js
+store.commit({
+        type: 'ADD',
+        payload: { number: 4 }},
+        true // autoCommit changes
+    )
+    // here we get autopushed state
+    .then(console.log);
+```
+
+---
+
+# API
+
+### `PANGjs.getStore(reducer, initialState, config) -> store`
+
+**Parameters**: 
+- `reducer`:  
+    the `reducer` function expected to have the following signature:  
+
+    `(oldState, actionType, payload) => Promise`    
+
+     where the returning promise resolves with the updated state.
+
+- `initialState`:  
+    optional object representing the initial state needed; when not provided it will be just an empty object.
+
+- `config`:  this is an optional object allowing to change some default behaviors:
+    - maxElements (default 1): 
+        by default no history is available, but if here we pass a number bigger than one, for example 5 then we can navigate the state back up to 5 steps using the `move` function to the store.
+    - check (default no check):
+        here we can pass a synchrhonous function expected to have to following signature:
+        ```
+        (
+            state, 
+            currentAction,
+            previousAction,
+            payload
+        ) -> <Boolean>
+        ```
+        allowing to prevent a state change under some circumstances; that decision can be made based on the `state`, the ongoing `currentAction` which we might block, the `previousAction` and the current `payload`. Only if we return `true`, the reducer action will be run.
+
+**Returns**:  
+the `store` instance  
+
+**Throws**:  
+`[ERROR] Reducer should return something!` in case the passed reducer is not a function
+
+---
+
+### `PANGjs.combine([reducer, ...])`
+
+Synchronous function to combine 2 or more reducers.
+
+**Parameters**:
+- **[reducer, ...]**:
+    two or more reducers to be combined
+
+**Returns**:  
+the resulting combined reducer
+
+**Throws**:  
+`[ERROR] Reducer must be a function!` in case one of the parameters is not a function  
+
+---
+
+### `PANGjs.isStore(toBeChecked)`
+
+Parameters: 
+- **toBeChecked**:
+    what needs to be checked if it is a PANGjs store or not
+
+---
+
+# store API
+
+Every store obtained invoking successfully `PANGjs.getStore` exposes the following (more details will come):
+
+### `storeInstance.getState() -> state (last pushed)`
+
+### `storeInstance.commit(action, autoPush) -> Promise resolved with new state (pushed or not)`
+
+### `storeInstance.push() -> Promise resolved with new pushed state`
+- calls subscribers 
+
+### `storeInstance.suubscribe(fn) -> unsubscribing function`
+
+### `storeInstance.replaceReducer(fn) -> store instance`
+
+### `storeInstance.move(int) -> store instance`
+
+### `storeInstance.reset() -> store instance`

package/dist/index.js

@@ -0,0 +1,28 @@
+'use strict';
+/*
+PANGjs
+v. 0.0.1
+8:3:34
+Size: ~3.63KB
+*/
+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 n(t,e){this.states=[t||{}],this.unpushedStates=[t||{}],this.config=e||{},this.maxElements=this.config.maxElements||!1,
+this.maxElements=Math.max(0,parseInt(this.config.maxElements,0))||!1,this.index=0,this.unpushedIndex=0}function i(e,s,i){this.reducer=e||o,t(this.reducer,r.REDUCERS_FUNCTION),this.initState=s||{},
+this.config=i||{},this.config.check=this.config.check||function(){return!0},t(this.config.check,r.REDUCERS_FUNCTION),this.subscribers=[],this.previousAction="ORIGIN",
+this.HistoryManager=new n(this.initState,this.config)}var r={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"};n.prototype.top=function(t){
+return this[t?"unpushedStates":"states"][this[t?"unpushedIndex":"index"]]},n.prototype.commit=function(t,e){var s=this.unpushedStates.slice(0,this.unpushedIndex+1);return s.push(t),
+this.maxElements&&s.length>this.maxElements?s.shift():this.unpushedIndex++,this.unpushedStates=s,e&&this.push(),this},n.prototype.push=function(){this.states=this.unpushedStates,
+this.index=this.unpushedIndex},n.prototype.reset=function(){this.index=0,this.states=this.states.slice(0,1),this.unpushedIndex=0,this.unpushedStates=this.unpushedStates.slice(0,1)};var o=function(){
+return Promise.resolve({})};return i.prototype.getState=function(t){return this.HistoryManager.top(t)},i.prototype.uncommit=function(){this.HistoryManager.unpushedIndex=this.HistoryManager.index,
+this.HistoryManager.unpuhedStates=this.HistoryManager.states},i.prototype.commit=function(t,s){if(!("type"in t))return Promise.reject(r.ACTION_TYPE)
+;var n=this,i=t.type,o=t.payload||{},u=this.getState(!0);if(!n.config.check(u,n.previousAction,i,o))return Promise.reject(r.UNAUTHORIZED_STATECHANGE);var h=this.reducer(u,i,o)
+;return e(h,r.REDUCERS_RETURN),this.previousAction=i,h.then(function(t){return n.HistoryManager.commit(t,s),t})},i.prototype.push=function(){this.HistoryManager.push();var t=this.HistoryManager.top()
+;return this.subscribers.filter(function(t){return Boolean(t)}).forEach(function(e){e(t)}),Promise.resolve(t)},i.prototype.subscribe=function(e){t(e,r.SUBSCRIBERS_FUNCTION);var s,n=this
+;return this.subscribers.push(e),s=this.subscribers.length-1,function(){n.subscribers[s]=null}},i.prototype.move=function(t){if(s(t,r.MOVE_TO_NUMBER),
+this.HistoryManager.index!==this.HistoryManager.unpushedIndex||void 0===t||0===t)return this;var e=this.HistoryManager.index+t,n=e>-1&&e<this.HistoryManager.states.length,i=n?e:this.currentIndex
+;return this.HistoryManager.index=i,this.HistoryManager.unpushedIndex=i,this},i.prototype.replaceReducer=function(t){this.reducer=t||o},i.prototype.reset=function(){this.HistoryManager.reset(),
+this.subscribers=[]},{ERRORS:r,getStore:function(t,e,s){return new i(t,e,s)},isStore:function(t){return t instanceof i},combine:function(e){return e.forEach(function(e){t(e,r.REDUCERS_FUNCTION)}),
+function(t,s,n){t=t||initState;var i=Object.assign({},t),r=e.length;return new Promise(function(t){return e.reduce(function(e,i,o){return e.then(function(e){return r-1===o?t(i(e,s,n)):i(e,s,n)})
+},Promise.resolve(i))})}}}}();"object"==typeof exports&&(module.exports=PANGjs);

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@fedeghe/pangjs",
+  "version": "0.0.1",
+  "main": "dist/index.js",
+  "author": "fedeghe <fedeghe@gmail.com>",
+  "license": "MIT",
+  "scripts": {
+    "build": "malta source/build.json",
+    "dev": "malta source/buildev.json",
+    "test": "jest --coverage --rootDir=test",
+    "watch": "jest --watch --coverage --rootDir=test",
+    "cover": "jest --coverage --rootDir=test",
+    "coveralls": "jest --coverage --rootDir=test | coveralls"
+  },
+  "devDependencies": {
+    "coveralls": "^3.1.1",
+    "eslint": "^9.17.0",
+    "eslint-config-standard": "^17.1.0",
+    "eslint-plugin-import": "^2.31.0",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-promise": "^7.2.1",
+    "eslint-plugin-standard": "^5.0.0",
+    "jest": "^29.7.0",
+    "malta": "^4.1.41",
+    "malta-header-comment": "^1.0.12",
+    "malta-js-uglify": "^1.0.13",
+    "nyc": "^17.1.0"
+  }
+}