spyne 0.14.8 → 0.17.3

package/src/spyne/spyne-app.js

@@ -0,0 +1,181 @@
+import {ChannelsMap} from './channels/channels-map';
+import {ViewStream} from './views/view-stream';
+import {SpyneUtilsChannelRoute} from './utils/spyne-utils-channel-route';
+import {SpyneAppProperties} from './utils/spyne-app-properties';
+import {deepMerge} from './utils/deep-merge';
+const _channels = new ChannelsMap();
+const version = '0.17.3';
+
+class SpyneApplication {
+  /**
+   *
+   * SpyneApp creates the global Spyne object, and creates the following items
+   * <ul>
+   *
+   * <li>LINK['ChannelsMap', 'channels-controller'] that directs the flow of data to all Channels</li>
+   * <li>LINK['SpyneChannelUI', 'spyne-channel-u-i'], that broadcast all user interaction events</li>
+   * <li>LINK['SpyneChannelRoute', 'spyne-channel-route'], that broadcast window location changes and is the only other channel that can be bound to user events</li>
+   * <li>LINK['SpyneChannelWindow', 'spyne-channel-window'], that broadcast all requested window and document events, such as scrolling, resizing and media queries</li>
+   * <li>LINK['SpyneChannelLifecycle', 'spyne-channel-lifecycle'], that broadcasts rendering and removing of ViewStream elements that have been directed to broadcast their lifecycle events</li>
+   * </ul>
+   *
+   *
+   * @module SpyneApp
+   * @type core
+   *
+   * @constructor
+   * @param {Object} config
+   * @property {Object} config - = {}; This global config object is mainly used to provide configuration details for two SpyneChannels, CHANNEL_ROUTE and CHANNEL_WINDOW.
+   */
+
+  constructor() {
+    this.version = version
+
+    //console.log('spyne app created')
+
+
+  }
+  get channels(){
+    return _channels;
+  }
+
+  init(config = {}, testMode=false) {
+    //this.channels = new ChannelsMap();
+    /*!
+     * Spyne 0.17.3
+     * https://spynejs.org
+     *
+     * @license Copyright 2017-2021, Frank Batista, Relevant Context, LLC. All rights reserved.
+     * Spyne is licensed under the GNU Lesser General Public License v3.0
+     *
+     * @author: Frank Batista,
+     * @email:  frbatista.nyc@gmail.com
+    */
+    /* eslint-disable */
+   /* this.ViewStream = ViewStream;
+    this.BasicView = ViewStreamElement;
+    this.DomEl = DomElement;
+    this.ViewStreamBroadcaster = ViewStreamBroadcaster;
+    this.ChannelsPayload = ViewStreamPayload;
+    this.ChannelsController = ChannelsMap;
+    this.ChannelsBase = Channel;
+    this.ChannelPayloadItem = ChannelPayload;*/
+
+    //console.log('spyne app ',{config,testMode}, SpyneAppProperties.initialized);
+    if(SpyneAppProperties.initialized === true){
+
+      if (testMode){
+        return 'The Spyne Application has already been initialized!';
+      } else {
+        console.warn('The Spyne Application has already been initialized!');
+      }
+      return
+    }
+
+
+    let defaultConfig = {
+      scrollLock: false,
+      scrollLockX: 31,
+      scrollLockY: 0,
+      debug: true,
+      plugins:{
+
+      },
+      tmp: {},
+      channels: {
+        WINDOW: {
+          mediqQueries: {
+
+          },
+          events: [],
+          listenForResize: true,
+          listenForOrientation: true,
+          listenForScroll: false,
+          listenForMouseWheel: false,
+          debounceMSTimeForResize: 200,
+          debounceMSTimeForScroll: 150
+        },
+
+        ROUTE: {
+          type: 'slash',
+          isHash: false,
+          isHidden: false,
+          add404s: false,
+          routes: {
+            'routePath' : {
+              'routeName' : 'change'
+            }
+          }
+
+        }
+      }
+    };
+    if (config !== undefined) {
+       config = SpyneAppProperties.initialize(defaultConfig, config, _channels);
+      //window.Spyne = this;
+      //window.Spyne['config'] = "SDFSD";// {};
+      //config = SpyneUtilsChannelRoute.conformRouteObject(config);
+      //window.Spyne['config'] = deepMerge(defaultConfig, config)
+    }
+
+
+    //const ranNum = Math.random();
+    //console.log('ranNum is ',{ranNum})
+    this.pluginsFn = SpyneAppProperties.getPluginsMethodObj(config['pluginMethods']);
+    this.getChannelActions = (str) => _channels.getChannelActions(str);
+    this.registerChannel = (val) => _channels.registerStream(val);
+    this.registerDataChannel = (obs$) => _channels.registerStream(obs$);
+    this.listChannels = () => Array.from(_channels.map.keys());
+    let nullHolder = new ViewStream({ id:'spyne-null-views' });
+    nullHolder.appendToDom(document.body);
+    nullHolder.props.el.style.cssText = 'display:none; opacity:0; pointer-events:none;';
+    _channels.init();
+    //console.log('spyne app initialized ',SpyneAppProperties.config.debug);
+
+    if (SpyneAppProperties.config.debug===true){
+      window.Spyne = {version};
+    }
+
+
+  }
+
+  /**
+   * This is mostly used for debugging purposes
+   *
+   * @example
+   * TITLE['<h4>Listing the registereed Channels in the browser console</h4>']
+   * SpyneApp.listChannels();
+   *
+   * @returns A list of all registered channels
+   */
+  static listChannels() {
+    return Array.from(_channels.map.keys());
+  }
+
+  /**
+   * This method is useful to check in the console or in the code what actions are available to be listened to.
+   * @param {String} str
+   * @returns {Array} An array of Actions that can be listened to
+   */
+  static getChannelActions(str) {
+    return _channels.getChannelActions(str);
+  }
+
+  /**
+   *
+   * This method will add the channel to the registered list so that it can subscribed by all ViewStream and Channel instances.
+   * @param {Channel} c
+   *
+   *
+   */
+  static registerChannel(c) {
+    if (SpyneAppProperties.initialized === false) {
+      console.warn('Spyne has not been initialized');
+    } else {
+      return _channels.registerStream(c);
+    }
+  }
+}
+
+
+export let SpyneApp = new SpyneApplication();

package/src/spyne/spyne-plugins.js

@@ -0,0 +1,146 @@
+import {SpyneApp, ViewStream, DomElement, SpyneAppProperties} from './spyne';
+import {prop, path, is, clone, mergeRight, pathSatisfies} from 'ramda';
+export class SpynePlugin {
+
+  constructor(props={}) {
+    let {name, config, parentEl} = props;
+    this.props = props;
+
+
+    if (config===undefined){
+      config = clone(props);
+    }
+
+
+     //console.log("CONFIG AND PROPS ",{config, props});
+
+    this.name = name || 'empty';
+    this.props.name = name;
+    config = SpynePlugin.mergeDefaultConfig(config, this.defaultConfig());
+    this.props.parentEl = parentEl || SpynePlugin.createParentEl();
+    SpynePlugin.getSpyneApp(name, config);
+    //console.log("SPYNE APP ",{name},this.name,this.props.spyneApp);
+   // if (this.props.spyneApp===false){
+      //console.warn(`Spyne Warning: Spyne Plugin, ${this.name} already exists!`)
+     // return false;
+   // }
+
+
+    if (this.props.traits!==undefined){
+      this.addTraits(this.props.traits);
+    }
+
+    this.onBeforeRegistered();
+    this.onRegistered();
+    this.onRender();
+  }
+
+
+  addTraits(traits){
+    if (traits.constructor.name!=='Array'){
+      traits = [traits];
+    }
+    const addTrait=(TraitClass)=>{
+      new TraitClass(this);
+    };
+
+    traits.forEach(addTrait);
+
+
+  }
+
+
+  onBeforeRegistered(){
+    this.props.pluginName = this.props.name;
+    //this.props.config = path(['Spyne', 'config', 'plugins', this.props.name], window);
+    this.props.config = SpyneAppProperties.getPluginConfigByPluginName(this.props.pluginName);
+  }
+
+  static mergeDefaultConfig(config={}, defaultConfig=this.defaultConfig()){
+    return Object.assign(defaultConfig, config);z
+  }
+
+
+  defaultConfig(){
+
+    return {
+
+
+    }
+
+  }
+
+
+
+  static getSpyneApp(name, config){
+   // const win = window || {};
+   // let spyneApp = prop('Spyne', win) ;
+   // const spyneInitialized = typeof(spyneApp) === 'object';
+    //console.log('spyne app is ',{spyneApp, spyneInitialized}, typeof(spyneApp));
+
+   // spyneApp = spyneInitialized === true ? spyneApp : new spyneApp();
+    if(SpyneAppProperties.initialized===false){
+      SpyneApp.init()
+    }
+
+
+    SpyneAppProperties.addPluginConfig(name, config);
+
+   /*  const updateConfig = SpynePlugin.updateSpyneConfig(spyneApp, name, config);
+
+     if(updateConfig===false){
+       return false;
+     }*/
+
+   // spyneApp.config.plugins[name] = config;
+    //return spyneApp;
+  }
+
+  static updateSpyneConfig(spyneApp, pluginName, pluginConfig){
+    const pathExists = pathSatisfies(is(Object), ['config', 'plugins', pluginName])(spyneApp);
+   // console.log('path exists ',{pathExists}, spyneApp.config.plugins[pluginName])
+
+    if (pathExists===true){
+      if (spyneApp.config.debug===true) {
+        console.warn(`Spyne Warning: The plugin, ${pluginName}, already exists`)
+      }
+       return false;
+    }
+    spyneApp.config.plugins[pluginName] = pluginConfig;
+    return spyneApp.config.plugins[pluginName];
+  }
+
+  static createParentEl(el){
+
+    const createPluginParentEl = ()=>{
+      const pluginEl = document.getElementById('spyne-plugins')
+
+      const createPluginEl = ()=>{
+        const pluginEl = new DomElement({
+          id: 'spyne-plugins'
+        });
+        document.body.appendChild(pluginEl.render());
+        const el = document.getElementById('spyne-plugins')
+        el.style.cssText="position:absolute; top:0;left:0;width:100%;height:100%;min-height:100vh;z-index:1000000; pointer-events:none";
+        return el;
+      }
+      return pluginEl || createPluginEl();
+    }
+
+    return el || createPluginParentEl();
+  }
+
+  onRegistered(){
+
+
+  }
+
+  onRender(){
+
+
+  }
+
+
+
+}
+

package/src/spyne/spyne.js

@@ -1,5 +1,6 @@
-import { ChannelsDelegator } from './channels/channels-delegator';
-import { DomElement, DomEl } from './views/dom-element';
+import { ChannelsMap } from './channels/channels-map';
+import { DomElement } from './views/dom-element';
+import {DomElementTemplate} from './views/dom-element-template';
 import { ViewStreamElement } from './views/view-stream-element';
 import { ViewStreamSelector} from './views/view-stream-selector';
 import { ViewStream } from './views/view-stream';
@@ -11,158 +12,29 @@ import { ChannelFetch } from './channels/channel-fetch-class';
 import {ChannelFetchUtil} from './utils/channel-fetch-util';
 import { ChannelPayload } from './channels/channel-payload-class';
 import {ChannelPayloadFilter} from './utils/channel-payload-filter';
-import {SpyneUtilsChannelRoute} from './utils/spyne-utils-channel-route';
+import {SpynePlugin} from './spyne-plugins';
 import { deepMerge } from './utils/deep-merge';
+import {SpyneAppProperties} from './utils/spyne-app-properties';
+import {SpyneApp} from './spyne-app';
 
-class SpyneApp {
-  /**
-   *
-   * SpyneApp creates the global Spyne object, and creates the following items
-   * <ul>
-   *
-   * <li>LINK['ChannelsDelegator', 'channels-controller'] that directs the flow of data to all Channels</li>
-   * <li>LINK['SpyneChannelUI', 'spyne-channel-u-i'], that broadcast all user interaction events</li>
-   * <li>LINK['SpyneChannelRoute', 'spyne-channel-route'], that broadcast window location changes and is the only other channel that can be bound to user events</li>
-   * <li>LINK['SpyneChannelWindow', 'spyne-channel-window'], that broadcast all requested window and document events, such as scrolling, resizing and media queries</li>
-   * <li>LINK['SpyneChannelLifecycle', 'spyne-channel-lifecycle'], that broadcasts rendering and removing of ViewStream elements that have been directed to broadcast their lifecycle events</li>
-   * </ul>
-   *
-   *
-   * @module SpyneApp
-   * @type core
-   *
-   * @constructor
-   * @param {Object} config
-   * @property {Object} config - = {}; This global config object is mainly used to provide configuration details for two SpyneChannels, CHANNEL_ROUTE and CHANNEL_WINDOW.
-   */
-  constructor(config = {}) {
-    this.channels = new ChannelsDelegator();
-    this.VERSION = '0.14.8';
-/*!
- * Spyne 0.14.8
- * https://spynejs.org
- *
- * @license Copyright 2017-2020, Frank Batista, Relevant Context, LLC. All rights reserved.
- * Spyne is licensed under the GNU Lesser General Public License v3.0
- *
- * @author: Frank Batista,
- * @email:  frbatista.nyc@gmail.com
-*/
-/* eslint-disable */
-    this.ViewStream = ViewStream;
-    this.BasicView = ViewStreamElement;
-    this.DomEl = DomElement;
-    this.ViewStreamBroadcaster = ViewStreamBroadcaster;
-    this.ChannelsPayload = ViewStreamPayload;
-    this.ChannelsController = ChannelsDelegator;
-    this.ChannelsBase = Channel;
-    this.ChannelPayloadItem = ChannelPayload;
-    window.Spyne = this;
-    let defaultConfig = {
-      scrollLock: false,
-      scrollLockX: 0,
-      scrollLockY: 0,
-      debug: false,
-
-      channels: {
-        WINDOW: {
-          mediqQueries: {
-
-          },
-          events: [],
-          listenForResize: true,
-          listenForOrientation: true,
-          listenForScroll: false,
-          listenForMouseWheel: false,
-          debounceMSTimeForResize: 200,
-          debounceMSTimeForScroll: 150
-        },
-
-        ROUTE: {
-          type: 'slash',
-          isHash: false,
-          isHidden: false,
-          add404s: false,
-          routes: {
-            'routePath' : {
-              'routeName' : 'change'
-            }
-          }
-
-        }
-      }
-    };
-    if (config !== undefined) {
-      config = SpyneUtilsChannelRoute.conformRouteObject(config);
-      window.Spyne['config'] = deepMerge(defaultConfig, config)
-    }
-
-
-
-    this.getChannelActions = (str) => window.Spyne.channels.getChannelActions(str);
-    this.registerChannel = (val) => this.channels.registerStream(val);
-    this.registerDataChannel = (obs$) => this.channels.registerStream(obs$);
-    this.listChannels = () => Array.from(window.Spyne.channels.map.keys());
-    let nullHolder = new ViewStream({ id:'spyne-null-views' });
-    nullHolder.appendToDom(document.body);
-    nullHolder.props.el.style.cssText = 'display:none; opacity:0; pointer-events:none;';
-    this.channels.init();
-  }
-
-  /**
-   * This is mostly used for debugging purposes
-   *
-   * @example
-   * TITLE['<h4>Listing the registereed Channels in the browser console</h4>']
-   * SpyneApp.listChannels();
-   *
-   * @returns A list of all registered channels
-   */
-  static listChannels() {
-    return Array.from(window.Spyne.channels.map.keys());
-  }
-
-  /**
-   * This method is useful to check in the console or in the code what actions are available to be listened to.
-   * @param {String} str
-   * @returns {Array} An array of Actions that can be listened to
-   */
-  static getChannelActions(str) {
-    return window.Spyne.channels.getChannelActions(str);
-  }
-
-  /**
-   *
-   * This method will add the channel to the registered list so that it can subscribed by all ViewStream and Channel instances.
-   * @param {Channel} c
-   *
-   *
-   */
-  static registerChannel(c) {
-    if (window.Spyne === undefined) {
-      console.warn('Spyne has not been initialized');
-    } else {
-      return window.Spyne.channels.registerStream(c);
-    }
-  }
-}
-
-window['Spyne'] = SpyneApp;
+//window['Spyne'] = SpyneApp;
 export {
   ViewStreamElement,
   Channel,
   ChannelFetch,
     ChannelFetchUtil,
-  ChannelsDelegator,
+  ChannelsMap,
   ViewStreamPayload,
   ChannelPayload,
     ChannelPayloadFilter,
   DomElement,
-    DomEl,
+  DomElementTemplate,
   ViewStream,
     ViewStreamSelector,
   ViewStreamBroadcaster,
   SpyneTrait,
   SpyneApp,
+  SpyneAppProperties,
+  SpynePlugin,
   deepMerge
 };

package/src/spyne/utils/channel-fetch-util.js

@@ -77,7 +77,7 @@ export class ChannelFetchUtil {
     const tapLog = debug === true ? tapLogDebug : () => {};
 
     let response$ = from(window.fetch(url, serverOptions))
-      .pipe(tap(tapLog), flatMap(r => from(r[responseType]())),
+    .pipe(tap(tapLog), flatMap(r => from(r[responseType]())),
         map(mapFn),
         publish());