spyne 0.14.8 → 0.17.3

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "spyne",
   "sideEffects": false,
-  "version": "0.14.8",
+  "version": "0.17.3",
   "description": "Reactive Real-DOM Framework for Advanced Javascript applications",
   "main": "lib/spyne.min.js",
   "module": "src/spyne/spyne.js",
@@ -11,9 +11,9 @@
     "eslint-fix-tests": "eslint --fix  'src/tests/**'",
     "report-coverage": "nyc report --reporter=text-lcov > coverage.lcov && codecov",
     "commit": "git-cz",
-    "build": "webpack --mode production   --env build --display-modules  ",
+    "build": "webpack --mode production   --env build ",
     "start": "webpack-dev-server --hot ",
-    "dev": "webpack --mode development --progress --colors --watch --env dev ",
+    "dev": "webpack --mode development --progress  --watch --env dev ",
     "stats": "webpack --profile --json --optimize-minimize  --mode production --env build  > stats.json",
     "docs": "jsdoc --readme README.md -d docs  -c docs/jsdoc.config.json -r",
     "esdocs": "esdoc -d esdocs  -c esdocs/esdoc.config.json -r",
@@ -30,68 +30,42 @@
   "author": "Frank Batista",
   "license": "LGPL",
   "devDependencies": {
-    "@babel/core": "^7.5.5",
-    "@babel/preset-env": "^7.5.5",
-    "babel-loader": "^8.0.6",
-    "chai": "^4.2.0",
-    "chai-dom": "^1.8.1",
-    "classlist-polyfill": "^1.2.0",
+    "@babel/core": "^7.15.0",
+    "@babel/plugin-transform-runtime": "^7.15.0",
+    "@babel/preset-env": "^7.15.0",
+    "babel-loader": "^8.2.2",
+    "chai": "^4.3.4",
+    "chai-dom": "^1.9.0",
     "clean-webpack-plugin": "^3.0.0",
-    "commitizen": "^4.2.3",
-    "css-loader": "^3.2.0",
-    "cz-conventional-changelog": "^3.0.2",
-    "es6-promise": "^4.2.8",
-    "eslint": "^6.1.0",
-    "eslint-config-semistandard": "^14.0.0",
-    "eslint-config-standard": "^13.0.1",
-    "eslint-loader": "^2.2.1",
-    "eslint-plugin-import": "^2.18.2",
-    "eslint-plugin-node": "^9.1.0",
-    "eslint-plugin-promise": "^4.2.1",
-    "eslint-plugin-standard": "^4.0.0",
-    "expect": "^24.9.0",
-    "file-loader": "^4.2.0",
-    "fstream": "^1.0.12",
+    "commitizen": "^4.2.4",
+    "css-loader": "^6.2.0",
+    "cz-conventional-changelog": "^3.3.0",
+    "eslint": "^7.32.0",
+    "eslint-config-semistandard": "^16.0.0",
+    "eslint-config-standard": "^16.0.3",
+    "eslint-loader": "^4.0.2",
+    "eslint-plugin-import": "^2.24.2",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-promise": "^5.1.0",
+    "eslint-plugin-standard": "^5.0.0",
+    "file-loader": "^6.2.0",
     "ghooks": "^2.0.4",
-    "history": "^4.9.0",
-    "immutable": "^3.8.2",
-    "istanbul": "^0.4.5",
-    "jsdoc": "^3.6.3",
-    "json-loader": "^0.5.7",
-    "karma": "^4.2.0",
+    "karma": "^6.3.4",
     "karma-chai": "^0.1.0",
     "karma-chrome-launcher": "^3.1.0",
-    "karma-coverage": "^1.1.2",
-    "karma-ie-launcher": "^1.0.0",
-    "karma-jasmine-es6": "0.0.3",
-    "karma-mocha": "^1.3.0",
-    "karma-virtualbox-ie11-launcher": "^1.2.2",
-    "karma-webpack": "^4.0.2",
-    "marked": "^0.7.0",
-    "mocha": "^6.2.0",
-    "mocha-loader": "^3.0.0",
-    "mocha-webpack": "^1.1.0",
-    "npm-run-all": "^4.1.5",
-    "nyc": "^14.1.1",
-    "opt-cli": "^1.6.0",
-    "predicado": "0.0.6",
-    "preload-image-loader": "^1.0.0",
-    "resolve-url-loader": "^3.1.2",
-    "rimraf": "^3.0.0",
-    "selenium-webdriver": "^4.0.0-alpha.1",
-    "semistandard": "^13.0.1",
-    "tar": "^4.4.10",
-    "url-loader": "^2.1.0",
-    "webpack": "^4.39.2",
-    "webpack-bundle-analyzer": "^3.4.1",
-    "webpack-cli": "^3.3.6",
-    "webpack-dev-middleware": "^3.7.0",
-    "webpack-dev-server": "^3.11.2",
-    "webpack-merge": "^4.2.1",
-    "webpack-node-externals": "^1.7.2",
-    "webpack-rxjs-externals": "^2.0.0",
-    "webpack-shell-plugin": "^0.5.0",
-    "yargs": "13.3.0"
+    "karma-coverage": "^2.0.3",
+    "karma-mocha": "^2.0.1",
+    "karma-webpack": "^5.0.0",
+    "mocha": "^9.1.1",
+    "mocha-loader": "^5.1.5",
+    "selenium-webdriver": "^4.0.0-beta.4",
+    "tslib": "^2.3.1",
+    "webpack": "^5.51.1",
+    "webpack-cli": "^4.8.0",
+    "webpack-dev-middleware": "^5.0.0",
+    "webpack-dev-server": "^4.0.0",
+    "webpack-node-externals": "^3.0.0",
+    "webpack-rxjs-externals": "^2.0.0"
   },
   "config": {
     "ghooks": {
@@ -102,9 +76,7 @@
     }
   },
   "dependencies": {
-    "data.validation": "^1.3.1",
-    "ramda": "^0.27.0",
-    "rxjs": "^6.5.2",
-    "spynejs-polyfill": "0.0.4"
+    "ramda": "^0.27.1",
+    "rxjs": "^7.3.0"
   }
 }

package/src/spyne/channels/channel-fetch-class.js

@@ -1,6 +1,6 @@
 import { Channel } from './channel';
 import { ChannelFetchUtil } from '../utils/channel-fetch-util';
-import {path, pick, mergeDeepRight, defaultTo, reject, compose, isNil} from 'ramda';
+import {path, pick, mergeDeepRight, all, allPass, either, values, defaultTo, reject, compose, isNil} from 'ramda';
 
 export class ChannelFetch extends Channel {
   /**
@@ -50,7 +50,11 @@ export class ChannelFetch extends Channel {
   constructor(name, props = {}) {
 
     // ALLOW FOR GENERIC MAP PROPERTY
+
+    ChannelFetch.validateMapMethod(props, name);
+
     if (props.map!==undefined){
+
       props.mapFn = props.map;
     }
     props.extendedActionsArr = [
@@ -61,6 +65,25 @@ export class ChannelFetch extends Channel {
     super(name, props);
   }
 
+  static validateMapMethod(props, name, testMode=false){
+    const isNotEmpty = arr=>arr.length>=1
+    const isNotFunction = val => typeof(val)!=='function';
+    const isUndefinedOrWrongType = either(isNil, isNotFunction)
+    const isUndefined = all(isUndefinedOrWrongType);
+    const isNotUndefinedAndIsNotEmpty = allPass([isUndefined, isNotEmpty])
+    const mapMethodIsInvalid = compose(isNotUndefinedAndIsNotEmpty,values, pick(['map', 'mapFn']))(props)
+
+    if (mapMethodIsInvalid){
+      if(testMode===false) {
+        console.warn(`Spyne Warning: The map method for ChannelFetch, ${name}, appears to be invalid`);
+      }
+      return false;
+    }
+
+    return true;
+
+  }
+
   onRegistered() {
     this.startFetch();
   }

package/src/spyne/channels/channel-payload-class.js

@@ -1,4 +1,18 @@
-import {mergeAll,clone, compose, mergeDeepRight, mergeRight, pathEq, includes, pickAll, __} from 'ramda';
+import {
+  mergeAll,
+  clone,
+  fromPairs,
+  toPairs,
+  compose,
+  mergeDeepRight,
+  mergeRight,
+  pathEq,
+  includes,
+  pickAll,
+  __,
+  lte, defaultTo, prop, is, mapObjIndexed,
+} from 'ramda';
+import {SpyneAppProperties} from '../utils/spyne-app-properties';
 
 export class ChannelPayload {
   /**
@@ -21,12 +35,18 @@ export class ChannelPayload {
    * @property {UIEvent} event - = undefined; The UIEvent, if any.
    * @returns Validated ChannelPayload json object
    */
-  constructor(channelName, action, payload, srcElement, event) {
+  constructor(channelName, action, payload, srcElement, event, timeLabel) {
     let channel = channelName;
+    //payload = ChannelPayload.deepFreeze(payload);
 
-    let channelPayloadItemObj = { channelName, action, payload, srcElement, event };
-    Object.defineProperty(channelPayloadItemObj, 'payload', {get: () => clone(payload)});
+    if(timeLabel){
+      console.time(timeLabel);
+    }
 
+    let channelPayloadItemObj = { channelName, action, srcElement, event };
+   // Object.defineProperty(channelPayloadItemObj, 'payload', {get: () => clone(payload)});
+    const frozenPayload = ChannelPayload.deepFreeze(payload);
+    channelPayloadItemObj['payload'] = frozenPayload;
     /**
      * This is a convenience method that helps with destructuring by merging all properties.
      *
@@ -40,34 +60,68 @@ export class ChannelPayload {
      *
      */
 
-    const isDebugMode =  pathEq(['Spyne','config', 'debug'], true)(window);
 
-    if (isDebugMode === true){
+
+    if (SpyneAppProperties.debug === true){
       if (payload.hasOwnProperty('payload')){
         let payloadStr = JSON.stringify(payload);
         console.warn(`Spyne Warning: the following payload contains a nested payload property which may create conflicts: Action: ${action}, ${payloadStr}`);
       }
+
+      const channelActionsArr = SpyneAppProperties.getChannelActions(channel);
+
+      ChannelPayload.validateAction(action, channel, channelActionsArr);
+
+
     }
 
 
 
-    channelPayloadItemObj.props = () => mergeAll([{payload:channelPayloadItemObj.payload},channelPayloadItemObj.payload, { channel }, { event: event }, channelPayloadItemObj.srcElement, { action: channelPayloadItemObj.action }]);
+   /* channelPayloadItemObj.props = () => clone(mergeAll([
+        {payload:ChannelPayload.deepClone(channelPayloadItemObj.payload)},
+      channelPayloadItemObj.payload,
+        { channel },
+        { event: event },
+        {srcElement: srcElement},
+                channelPayloadItemObj.srcElement, {
+        action: channelPayloadItemObj.action }
+         ]));
+*/
 
 
-    const channelActionsArr = window.Spyne.getChannelActions(channel);
+    const channelPayloadItemObjProps = {
+      $dir: {
+        get: () => channelPayloadItemObj._dir,
+        set: (val) => channelPayloadItemObj._dir=val
+      }
+    }
+
 
-    ChannelPayload.validateAction(action, channel, channelActionsArr);
 
     if (channel === 'CHANNEL_ROUTE') {
-      channelPayloadItemObj['location'] = ChannelPayload.getLocationData();
+      //channelPayloadItemObj['location'] = ChannelPayload.getLocationData();
+      channelPayloadItemObjProps['location'] = {
+        get: ()=>ChannelPayload.getLocationData()
+      }
+     /* channelPayloadItemObjProps['routeData'] = {
+        get: ()=>prop('routeData', frozenPayload)
+      }
+*/
     }
 
+    channelPayloadItemObj._dir = undefined;
+
+    Object.defineProperties(channelPayloadItemObj, channelPayloadItemObjProps)
+
+    if(timeLabel){
+      console.timeEnd(timeLabel);
+    }
     return channelPayloadItemObj;
   }
 
   static validateAction(action, channel, arr) {
     let isInArr = includes(action, arr);
-    if (isInArr === false && window.Spyne !== undefined) {
+    if (isInArr === false && SpyneAppProperties.initialized === true) {
       console.warn(`warning: Action: '${action}' is not registered within the ${channel} channel!`);
     }
     return isInArr;
@@ -91,6 +145,43 @@ export class ChannelPayload {
 
   }
 
+  static deepClone(o) {
+    const isArr = is(Array);
+    const isObj = is(Object);
+    const isIter = ob => isArr(ob)===false && isObj(ob)===true;
+    const isIterable = isIter(o);
+    return isIterable ? compose(fromPairs, toPairs, clone)(o) : clone(o);
+
+  }
+
+
+
+  static deepFreeze(o) {
+    //return o;
+    //return Object.freeze(o);
+    const elIsDomElement = compose(lte(0), defaultTo(-1), prop('nodeType'));
+
+    try {
+      Object.freeze(o);
+      Object.getOwnPropertyNames(o).forEach(function(prop) {
+        if (o.hasOwnProperty(prop)
+            && elIsDomElement(o[prop]) === false
+            && o[prop] !== null
+            && (typeof o[prop] === "object" || typeof o[prop] === "function")
+            && !Object.isFrozen(o[prop])) {
+          ChannelPayload.deepFreeze(o[prop]);
+        }
+      });
+
+    } catch(e){
+       //console.log("FREEZE ERR ",{o,e});
+      return o;
+
+    }
+
+    return o;
+  }
+
   static getMouseEventKeys() {
     return ['altKey', 'bubbles', 'cancelBubble', 'cancelable', 'clientX', 'clientY', 'composed', 'ctrlKey', 'currentTarget', 'defaultPrevented', 'detail', 'eventPhase', 'fromElement', 'isTrusted', 'layerX', 'layerY', 'metaKey', 'movementX', 'movementY', 'offsetX', 'offsetY', 'pageX', 'pageY', 'path', 'relatedTarget', 'returnValue', 'screenX', 'screenY', 'shiftKey', 'sourceCapabilities', 'srcElement', 'target', 'timeStamp', 'toElement', 'type', 'view', 'which', 'x', 'y'];
   }

package/src/spyne/channels/channel-proxy.js

@@ -1,6 +1,8 @@
 import { Channel } from './channel';
+import {SpyneAppProperties} from '../utils/spyne-app-properties';
 import { Subject, ReplaySubject, merge } from 'rxjs';
 import {includes, path} from 'ramda';
+import {delayCall} from '../utils/frp-tools';
 
 export class ChannelProxy extends Channel {
   /**
@@ -22,7 +24,7 @@ export class ChannelProxy extends Channel {
     this.subject$ = new Subject();
     this.replaySub$ = new ReplaySubject(1);
     this.observer$ = merge(this.subject$, this.replaySub$);
-	const isDevMode = path(['Spyne', 'config', 'debug'], window) === true;
+	const isDevMode = SpyneAppProperties.debug;
     if (isDevMode === true){
       this.checkIfChannelIsStillProxy(name);
     }
@@ -36,14 +38,14 @@ export class ChannelProxy extends Channel {
     let name = channelName;
 
     const checkIfProxy=()=>{
-      //console.log("CHANNELS ",window.Spyne.channels.listRegisteredChannels());
-      let bool = includes(name, window.Spyne.channels.listRegisteredChannels());
+      let bool = includes(name, SpyneAppProperties.listRegisteredChannels());
       if (bool!==true){
         console.warn(`Spyne Warning: The channel, ${name} does not appear to be registered!`);
       }
     };
 
-    window.setTimeout(checkIfProxy, 1000);
+    delayCall(checkIfProxy, 1000);
+
   }
 
   get replaySubject() {

package/src/spyne/channels/channel.js

@@ -1,6 +1,7 @@
 import { registeredStreamNames } from './channels-config';
 import { ChannelPayload } from './channel-payload-class';
 import { ChannelPayloadFilter} from '../utils/channel-payload-filter';
+import {SpyneAppProperties} from '../utils/spyne-app-properties';
 import {RouteChannelUpdater} from '../utils/route-channel-updater';
 import { ReplaySubject, Subject } from 'rxjs';
 import {filter} from 'rxjs/operators';
@@ -18,8 +19,11 @@ import {
   always,
   fromPairs,
   path,
+ assocPath,
+    isEmpty,
   equals,
   prop,
+    propEq,
   apply,
 } from 'ramda';
 const rMap = require('ramda').map;
@@ -70,20 +74,28 @@ export class Channel {
     this.addRegisteredActions.bind(this);
     this.createChannelActionsObj(CHANNEL_NAME, props.extendedActionsArr);
     props.name = CHANNEL_NAME;
+    props.defaultActions = props.data!==undefined ? [`${props.name}_EVENT`] : [];
     this.props = props;
+    this.props.isRegistered = false;
     this.props.isProxy = this.props.isProxy === undefined ? false : this.props.isProxy;
-    this.props.sendCachedPayload = this.props.sendCachedPayload === undefined ? false : this.props.sendCachedPayload;
+    const defaultCachedPayloadBool = this.props['data']!==undefined;
+    this.props.sendCachedPayload = this.props.sendCachedPayload === undefined ? defaultCachedPayloadBool : this.props.sendCachedPayload;
     this.sendPayloadToRouteChannel = new RouteChannelUpdater(this);
     this.createChannelActionMethods();
-    this.streamsController = window.Spyne.channels;// getGlobalParam('streamsController');
+    this.streamsController = SpyneAppProperties.channelsMap;
     let observer$ = this.getMainObserver();
-
+    this.checkForPersistentDataMode = Channel.checkForPersistentDataMode.bind(this);
     this.observer$ = this.props['observer'] = observer$;
     let dispatcherStream$ = this.streamsController.getStream('DISPATCHER');
-    dispatcherStream$.subscribe((val) => this.onReceivedObservable(val));
+    const payloadPredByChannelName = propEq('name', props.name)
+    dispatcherStream$.pipe(filter(payloadPredByChannelName)).subscribe((val) => this.onReceivedObservable(val));
   }
 
   getMainObserver() {
+    if (this.streamsController === undefined){
+      console.warn(`Spyne Warning: The following channel, ${this.props.name}, appears to be registered before Spyne has been initialized.`)
+    }
+
     let proxyExists = this.streamsController.testStream(this.props.name);
 
     if (proxyExists === true) {
@@ -107,7 +119,13 @@ export class Channel {
    * <p>This method is empty and is called as soon as the Channel has been registered.</p>
    * <p>Tasks such as subscribing to other channels, and sending initial payloads can be added here.</p>
    */
-  onRegistered(){
+  onRegistered(props=this.props){
+      if(props.data!==undefined){
+        const action = Object.keys(this.channelActions)[0];
+          //console.log("CHANNELS ACTIONS IS ",this.channelActions);
+        //Object(this.channelActions).keys[0];
+        this.sendChannelPayload(action, props.data);
+      }
 
   }
 
@@ -149,7 +167,37 @@ export class Channel {
   initializeStream() {
     this.checkForTraits();
     this.onChannelInitialized();
+    this.checkForPersistentDataMode();
     this.onRegistered();
+    this.props.isRegistered = true;
+
+
+  }
+
+  static checkForPersistentDataMode(props=this.props, actionsObj=this.channelActions){
+    const actionsObjIsEmpty = isEmpty(actionsObj);
+    const dataIsAdded = prop('data', props) !== undefined;
+    const autoSetToCachedPayload = actionsObjIsEmpty === true && dataIsAdded === true;
+    const setDefaultActionsObj = ()=>{
+      const {name} = props;
+      const actionStr = `${name}_EVENT`;
+      return {
+        [actionStr] : actionStr
+      }
+    }
+
+    if (autoSetToCachedPayload){
+      props.sendCachedPayload = true;
+      actionsObj = setDefaultActionsObj();
+
+      if (this.channelActions!==undefined){
+        this.channelActions = actionsObj;
+      }
+    }
+
+
+    //console.log("PROPS IS ",{actionsObjIsEmpty, dataIsAdded, props, actionsObj}, this.channelActions)
+    return {props, actionsObj};
   }
 
   setTrace(bool) {
@@ -214,7 +262,11 @@ export class Channel {
    *
    */
   addRegisteredActions() {
-    return [];
+    let arr = []
+    if (path(['props','data'], this)){
+      arr = [`${this.props.name}_EVENT`];
+    }
+    return arr;
   }
 
   onReceivedObservable(obj) {
@@ -222,6 +274,7 @@ export class Channel {
   }
 
   getActionMethodForObservable(obj) {
+    obj.unpacked=true;
     const defaultFn = this.onViewStreamInfo.bind(this);
 
     let methodStr = path(['data', 'action'], obj);
@@ -306,9 +359,14 @@ export class Channel {
    */
   sendChannelPayload(action, payload, srcElement = {}, event = {}, obs$ = this.observer$) {
     // MAKES ALL CHANNEL BASE AND DATA STREAMS CONSISTENT
+
+
     let channelPayloadItem = new ChannelPayload(this.props.name, action, payload, srcElement, event);
     // console.log("CHANNEL STREEM ITEM ",channelPayloadItem);
 
+   // const onNextFrame = ()=>obs$.next(channelPayloadItem);
+    //requestAnimationFrame(onNextFrame)
+
     obs$.next(channelPayloadItem);
   }
 
@@ -354,6 +412,7 @@ export class Channel {
    *
    */
 
+/*
   setTimeout(fn, ms=0, bind=false){
     const timeoutMethod = (...args)=>{
       if (this!==undefined && this.props!==undefined){
@@ -363,6 +422,7 @@ export class Channel {
     }
     window.setTimeout(timeoutMethod, ms);
   }
+*/
 
 
 

package/src/spyne/channels/channels-config.js

@@ -1,13 +1,13 @@
 // import Spyne from '../spyne';
 import { arrFromMapKeys } from '../utils/frp-tools';
-
+import {SpyneAppProperties} from '../utils/spyne-app-properties';
 import {compose, path, is} from 'ramda';
 const Observable = require('rxjs');
 const Subject = require('rxjs');
 
 // console.log('channels config loaded ',R,Rx);
 let registeredStreamNames = () => ({
-  includes:  () => window.Spyne !== undefined ? arrFromMapKeys(window.Spyne.channels.map) : ['CHANNEL_ROUTE', 'CHANNEL_UI', 'CHANNEL_WINDOW', 'DISPATCHER']
+  includes:  () => SpyneAppProperties.initialized === true ? SpyneAppProperties.listRegisteredChannels() : ['CHANNEL_ROUTE', 'CHANNEL_UI', 'CHANNEL_WINDOW', 'DISPATCHER']
 
 });