spyne 0.20.4 → 0.20.7

package/src/spyne/utils/spyne-app-properties.js

@@ -1,17 +1,25 @@
-// import { SpyneUtilsChannelRoute } from './spyne-utils-channel-route'
-import { SpynePluginsMethods } from './spyne-plugins-methods'
-import { deepMerge } from './deep-merge'
-import { path } from 'ramda'
+import { SpyneUtilsChannelRoute } from './spyne-utils-channel-route.js'
+import { SpynePluginsMethods } from './spyne-plugins-methods.js'
+import { deepMerge } from './deep-merge.js'
 
 let _config
 let _channels
 let _channelsMap
 let _initialized
 let _debug = true
+const _excludeChannelsFromConsole = []
+/* eslint-disable */
+let _linksData
+let _navLinks
 let _IMG_PATH
 const _doNotTrackChannelsArr = []
 const _proxiesMap = new Map()
 
+function random6Chars() {
+  // For simplicity: slice(2, 8) gets 6 random chars from the substring
+  return Math.random().toString(36).slice(2, 8);
+}
+
 const _spynePluginMethods = new SpynePluginsMethods()
 
 class SpyneAppPropertiesClass {
@@ -95,14 +103,32 @@ class SpyneAppPropertiesClass {
     _channelsMap = { getStream, testStream, getProxySubject }
   }
 
-  setProp(key, val) {
-    _config.tmp[key] = val
+  setProp(key, val, isTemp = false) {
+    if (isTemp) {
+      _config.ephemeralProps[key] = val;
+      return val;
+    } else {
+      _config.tmpProps[key] = val;
+    }
+    return  key;
   }
 
   getProp(key) {
-    return path(['tmp', key], _config)
+    if (_config.ephemeralProps.hasOwnProperty(key)) {
+      const tempVal = _config.ephemeralProps[key];
+      delete _config.ephemeralProps[key];
+      return tempVal;
+    }
+    return _config?.tmpProps?.[key];
+  }
+
+  createTempProp(value) {
+    const key = random6Chars();
+    this.setProp(key, value, true); // isTemp = true
+    return key;
   }
 
+
   setChannelConfig(channelName, config) {
     _config.channels[channelName] = config
     return _config.channels[channelName]
@@ -201,6 +227,46 @@ class SpyneAppPropertiesClass {
     return _IMG_PATH
   }
 
+  get excludeChannelsFromConsole() {
+    return _excludeChannelsFromConsole
+  }
+
+  // Setter for _excludeChannelsFromConsole
+  set excludeChannelsFromConsole(value) {
+    if (typeof value === 'string') {
+      // Push a single string into the array if not already present
+      if (!_excludeChannelsFromConsole.includes(value)) {
+        _excludeChannelsFromConsole.push(value)
+      }
+    } else if (Array.isArray(value)) {
+      // Merge an array into the existing array, avoiding duplicates
+      value.forEach(item => {
+        if (typeof item === 'string' && !_excludeChannelsFromConsole.includes(item)) {
+          _excludeChannelsFromConsole.push(item)
+        }
+      })
+    } else {
+      console.warn('Invalid value provided to excludeChannelsFromConsole. Only strings or arrays are allowed.')
+    }
+  }
+
+  get linksData() {
+    console.warn('get links data in SpyneAppProperties is deprecated, use navLinks')
+    return _navLinks
+  }
+
+  set linksData(arr) {
+    console.warn('set links data in SpyneAppProperties is deprecated, use navLinks')
+  }
+
+  get navLinks() {
+    return _navLinks
+  }
+
+  set navLinks(arr) {
+    _navLinks = arr
+  }
+
   tempGetChannelsInstance() {
 
   }

package/src/spyne/utils/spyne-trait.js

@@ -1,4 +1,4 @@
-import { getAllMethodNames } from './frp-tools'
+import { getAllMethodNames } from './frp-tools.js'
 import { reject, curryN, __, map } from 'ramda'
 
 export class SpyneTrait {

package/src/spyne/utils/spyne-utils-channel-route-url.js

@@ -1,5 +1,5 @@
 import { isEmpty, head, values, compose, prop, complement, isNil, allPass, reduce, filter, equals, toPairs, replace, either, propEq, __, invert, path, zipObj, reject, keys, find, assoc, is, has, when, split, always, concat, join, flatten, map, ifElse, test, findLastIndex, last, defaultTo, fromPairs } from 'ramda'
-import { SpyneAppProperties } from './spyne-app-properties'
+import { SpyneAppProperties } from './spyne-app-properties.js'
 
 export class SpyneUtilsChannelRouteUrl {
   constructor() {
@@ -254,9 +254,23 @@ export class SpyneUtilsChannelRouteUrl {
   }
 
   static findIndexOfMatchedStringOrRegex(mainStr, paramsArr) {
+    const is404 = paramsArr.includes('.+')
+
+    const reFn = (s) => {
+      if (is404) {
+        if (!s.startsWith('^')) {
+          s = '^' + s
+        }
+        if (!s.endsWith('$')) {
+          s = s + '$'
+        }
+      }
+
+      return new RegExp(s)
+    }
+
     const checkForEmpty =  replace(/^$/, '^$')
     const createStrRegexTest = (str) => {
-      const reFn = s => new RegExp(s)
       return {
         str,
         re: reFn(str)

package/src/spyne/utils/spyne-utils-channel-route.js

@@ -1,6 +1,6 @@
 import { fromEventPattern } from 'rxjs'
 import { last, flatten, clone, pick, prop, pickAll, path, equals, compose, keys, filter, propEq, uniq, map, __, chain, is, includes, fromPairs, reject, mergeDeepRight, mergeRight, test, toPairs, values } from 'ramda'
-import { SpyneUtilsChannelRouteUrl } from './spyne-utils-channel-route-url'
+import { SpyneUtilsChannelRouteUrl } from './spyne-utils-channel-route-url.js'
 
 export class SpyneUtilsChannelRoute {
   constructor() {

package/src/spyne/views/dom-element-template.js

@@ -1,6 +1,6 @@
 import { includes, __, ifElse, path, prop, reject, is, isNil, isEmpty } from 'ramda'
-import sanitizeHTML from '../utils/sanitize-html'
-import { SpyneAppProperties } from '../utils/spyne-app-properties'
+import sanitizeHTML from '../utils/sanitize-html.js'
+import { SpyneAppProperties } from '../utils/spyne-app-properties.js'
 
 /**
  * @module DomElTemplate
@@ -349,6 +349,9 @@ export class DomElementTemplate {
       elData = [elData]
     }
 
+    // convert to array if is string
+    elData = Array.isArray(elData) ? elData : [elData]
+
     return elData.map(mapStringData).join('')
   }
 }

package/src/spyne/views/dom-element.js

@@ -1,6 +1,6 @@
-import { baseCoreMixins } from '../utils/mixins/base-core-mixins'
-import { DomElementTemplate } from './dom-element-template'
-import { deepMerge } from '../utils/deep-merge'
+import { baseCoreMixins } from '../utils/mixins/base-core-mixins.js'
+import { DomElementTemplate } from './dom-element-template.js'
+import { deepMerge } from '../utils/deep-merge.js'
 import { is, defaultTo, pick, mapObjIndexed, forEachObjIndexed, pipe } from 'ramda'
 
 class DomElement {

package/src/spyne/views/view-stream-broadcaster.js

@@ -1,6 +1,6 @@
-import { baseStreamsMixins } from '../utils/mixins/base-streams-mixins'
-import { convertDomStringMapToObj } from '../utils/frp-tools'
-import { SpyneAppProperties } from '../utils/spyne-app-properties'
+import { baseStreamsMixins } from '../utils/mixins/base-streams-mixins.js'
+import { convertDomStringMapToObj } from '../utils/frp-tools.js'
+import { SpyneAppProperties } from '../utils/spyne-app-properties.js'
 import { fromEvent } from 'rxjs'
 import { map } from 'rxjs/operators'
 import { clone, omit } from 'ramda'
@@ -96,7 +96,18 @@ export class ViewStreamBroadcaster {
       data.srcElement.srcEvent = event
       data.srcElement.el = q
       // select the correct payload
-      const channelPayload = channel !== undefined ? channelPayloads[channel] : channelPayloads.UI
+
+      function getValidChannel(ch) {
+        if (ch === 'ROUTE' || ch === 'CHANNEL_ROUTE') {
+          return 'ROUTE'
+        }
+        if (ch !== 'UI' && ch !== 'CHANNEL_UI' && ch !== undefined) {
+          console.warn(`SpyneJS warning: The channel, ${ch}, is not allowed here, only "UI" or "ROUTE" are valid channels, defaulting to CHANNEL_UI`)
+        }
+        return 'UI'
+      }
+
+      const channelPayload = channelPayloads[getValidChannel(channel)]
       // run payload
       channelPayload(observable, data)
     }

package/src/spyne/views/view-stream-element.js

@@ -1,7 +1,7 @@
-import { DomElement } from './dom-element'
-import { fadein, fadeout } from '../utils/viewstream-animations'
-import { ViewStreamObservable } from '../utils/viewstream-observables'
-import { deepMerge } from '../utils/deep-merge'
+import { DomElement } from './dom-element.js'
+import { fadein, fadeout } from '../utils/viewstream-animations.js'
+import { ViewStreamObservable } from '../utils/viewstream-observables.js'
+import { deepMerge } from '../utils/deep-merge.js'
 import { Subject, bindCallback } from 'rxjs'
 import { filter, isNil, pick, props, defaultTo } from 'ramda'
 
@@ -23,6 +23,7 @@ export class ViewStreamElement {
     this.addMixins()
     this._state = 'INIT'
     this.vsid = vsid
+    this.el = viewProps.el
     this.vsName = vsName
     this.defaults = {
       debug:false,
@@ -152,6 +153,10 @@ export class ViewStreamElement {
   }
 
   combineDomItems(d) {
+    if (this.el !== undefined) {
+      return
+    }
+
     const container =  isNil(d.query) ? d.node : d.query
     const prepend = (node, item) => node.insertBefore(item, node.firstChild)
     const append = (node, item) => node.appendChild(item)
@@ -195,7 +200,7 @@ export class ViewStreamElement {
     this.combineDomItems(d)
     return {
       action: 'VS_SPAWNED_AND_ATTACHED_TO_PARENT',
-      el: this.domItem.el,
+      el: this.el || this.domItem.el,
       $dir: this.$dirs.PI
     }
   }
@@ -208,7 +213,7 @@ export class ViewStreamElement {
 
   onRender(d) {
     const getEl = (data) => this.renderDomItem(data)
-    const el =  getEl(props(['tagName', 'domAttributes', 'data', 'template'], d))
+    const el = this.el || getEl(props(['tagName', 'domAttributes', 'data', 'template'], d))
     return {
       action: 'VS_SPAWNED',
       el,
@@ -231,7 +236,7 @@ export class ViewStreamElement {
     this.combineDomItems(d.attachData)
     return {
       action: 'VS_SPAWNED_AND_ATTACHED_TO_DOM',
-      el:     d.attachData.el.el,
+      el:   this.el || d.attachData.el.el,
       $dir: this.$dirs.CI
     }
   }

package/src/spyne/views/view-stream-payload.js

@@ -1,6 +1,6 @@
-import { SpyneAppProperties } from '../utils/spyne-app-properties'
-import { safeClone } from '../utils/safe-clone'
-import { gc } from '../utils/gc'
+import { SpyneAppProperties } from '../utils/spyne-app-properties.js'
+import { safeClone } from '../utils/safe-clone.js'
+import { gc } from '../utils/gc.js'
 import {
   compose,
   clone,

package/src/spyne/views/view-stream-selector.js

@@ -1,5 +1,5 @@
 import { head, compose, reject, split, isEmpty, lte, defaultTo, prop } from 'ramda'
-import { SpyneAppProperties } from '../utils/spyne-app-properties'
+import { SpyneAppProperties } from '../utils/spyne-app-properties.js'
 
 function generateSpyneSelectorId(el) {
   const num = () => Math.random().toString(36).replace(/\d/gm, '').substring(1, 8)

package/src/spyne/views/view-stream.js

@@ -1,18 +1,18 @@
-import { baseCoreMixins } from '../utils/mixins/base-core-mixins'
-import { SpyneAppProperties } from '../utils/spyne-app-properties'
-import { deepMerge } from '../utils/deep-merge'
-import { safeClone } from '../utils/safe-clone'
+import { baseCoreMixins } from '../utils/mixins/base-core-mixins.js'
+import { SpyneAppProperties } from '../utils/spyne-app-properties.js'
+import { deepMerge } from '../utils/deep-merge.js'
+import { safeClone } from '../utils/safe-clone.js'
 import {
   findStrOrRegexMatchStr,
   getConstructorName
-} from '../utils/frp-tools'
-import { ViewStreamElement } from './view-stream-element'
-import { registeredStreamNames } from '../channels/channels-config'
-import { ViewStreamBroadcaster } from './view-stream-broadcaster'
-import { ViewStreamPayload } from './view-stream-payload'
-import { ChannelPayloadFilter } from '../utils/channel-payload-filter'
-import { ViewStreamObservable } from '../utils/viewstream-observables'
-import { ViewStreamSelector } from './view-stream-selector'
+} from '../utils/frp-tools.js'
+import { ViewStreamElement } from './view-stream-element.js'
+import { registeredStreamNames } from '../channels/channels-config.js'
+import { ViewStreamBroadcaster } from './view-stream-broadcaster.js'
+import { ViewStreamPayload } from './view-stream-payload.js'
+import { ChannelPayloadFilter } from '../utils/channel-payload-filter.js'
+import { ViewStreamObservable } from '../utils/viewstream-observables.js'
+import { ViewStreamSelector } from './view-stream-selector.js'
 import { Subject, of } from 'rxjs'
 import { mergeMap, map, takeWhile, filter, tap, skip, finalize } from 'rxjs/operators'
 import {
@@ -99,9 +99,9 @@ export class ViewStream {
     this.loadAllMethods()
     this.props.action = 'LOADED'
     this.sink$ = new Subject()
+    this.props.elIsAlreadyRenderedBool = this.elAlreadyExistsFn(this.props)
     const ViewClass = this.props.viewClass
-    this.view = new ViewClass(this.sink$, {}, this.props.vsid,
-      this.props.id)// new this.props.viewClass(this.sink$);
+    this.view = new ViewClass(this.sink$, { el:this.props.el }, this.props.vsid, this.props.id)// new this.props.viewClass(this.sink$);
     this.sourceStreams = this.view.sourceStreams
     this._rawSource$ = this.view.getSourceStream()
     this._rawSource$.viewName = this.props.name
@@ -216,12 +216,14 @@ export class ViewStream {
 
   //  =====================================================================
 
-  checkIfElementAlreadyExists() {
+  elAlreadyExistsFn(props) {
     const elIsDomElement = compose(lte(0), defaultTo(-1), prop('nodeType'))
     const elIsRendered = el => document.body.contains(el)
-    const elIsReadyBool = propSatisfies(
-      allPass([elIsRendered, elIsDomElement]), 'el')
-    if (elIsReadyBool(this.props)) {
+    return propSatisfies(allPass([elIsRendered, elIsDomElement]), 'el')(props)
+  }
+
+  checkIfElementAlreadyExists() {
+    if (this.props.elIsAlreadyRenderedBool === true) {
       this.updatePropsToMatchEl()
       this.postRender()
     } else if (this.props.el === null) {
@@ -972,6 +974,8 @@ export class ViewStream {
     }
     if (Array.isArray(this?.props?.channels)) {
       this?.props?.channels?.forEach(addChannel)
+    } else if (Array.isArray(this?.props?.channel)) {
+      console.warn('props.channel is not a ViewStream property. Do you mean props.channels?')
     }
   }
 

package/src/tests/utils/channel-data-packet-generator.unused.js

@@ -1,4 +1,4 @@
-import { ChannelPayloadToTestFilters } from '../mocks/channel-payload-data'
+import { ChannelPayloadToTestFilters } from '../mocks/channel-payload-data.js'
 import { ChannelDataPacketGenerator } from '../../spyne/utils/channel-data-packet-generator'
 import { ChannelDataPacket } from '../../spyne/utils/channel-data-packet'
 const { expect, assert } = require('chai')

package/src/spyne/utils/channel-config-validator.js

@@ -1,14 +0,0 @@
-import Validation from 'data.validation'
-import { curry, curryN, length, always, reduce } from 'ramda'
-const success = Validation.Success
-const failure = Validation.Failure
-let validate = () => {}
-if (curry !== undefined) {
-  validate = curry((validations, thing) => {
-    const initial = success(curryN(length(validations), always(thing)))
-    const run = (acc, v) =>
-      acc.ap(v.predicate(thing) ? success(thing) : failure([v.error]))
-    return reduce(run, initial, validations)
-  })
-}
-export { validate }