spyne 0.20.0 → 0.20.2

package/lib/spyne.umd.js.LICENSE.txt

@@ -0,0 +1,16 @@
+/*!
+     * Spyne 0.20.1
+     * 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
+    */
+
+/*!
+ * spynejs 0.20.1
+ * https://spynejs.org
+ * (c) 2017-present Frank Batista
+ */

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "spyne",
-  "version": "0.20.0",
+  "version": "0.20.2",
   "description": "Reactive Real-DOM Framework for Advanced Javascript applications",
   "sideEffects": true,
-  "main": "./lib/spyne.umd.js",
+  "main": "./lib/spyne.esm.js",
   "module": "./lib/spyne.esm.js",
   "exports": {
     ".": {
       "import": "./lib/spyne.esm.js",
-      "require": "./lib/spyne.umd.js"
+      "require": "./lib/spyne.esm.js"
     },
     "./lib/*": "./lib/*.js"
   },
@@ -19,13 +19,15 @@
     "report-coverage": "nyc report --reporter=text-lcov > coverage.lcov && codecov",
     "commit": "git-cz",
     "start": "webpack-dev-server --hot",
+    "prepare": "husky",
     "build": "webpack --config webpack.config.js --mode production",
     "build:esm": "rollup --config rollup.config.js",
     "dev": "webpack --config webpack.config.js --mode development",
     "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",
-    "test": "karma start --browsers Chrome",
+    "test": "karma start karma.conf.js",
+    "test:single": "karma start karma.conf.js --single-run",
     "watch:test": "npm test -- --auto-watch --no-single-run",
     "test:mocha": "mocha tests",
     "lint": "eslint 'src/spyne/**' --fix"
@@ -43,7 +45,7 @@
     "Single-Page-Application Framework"
   ],
   "author": "Frank Batista",
-  "license": "UNLICENSED",
+  "license": "LGPL",
   "devDependencies": {
     "@rollup/plugin-commonjs": "^28.0.2",
     "@rollup/plugin-json": "^6.1.0",
@@ -59,6 +61,7 @@
     "eslint-plugin-node": "^11.1.0",
     "eslint-webpack-plugin": "^4.2.0",
     "file-loader": "^6.2.0",
+    "husky": "^9.1.7",
     "karma": "^6.4.4",
     "karma-chai": "^0.1.0",
     "karma-chrome-launcher": "^3.2.0",

package/src/spyne/spyne-app.js

@@ -5,7 +5,7 @@ import { SpyneAppProperties } from './utils/spyne-app-properties'
 import { sanitizeHTMLConfigure } from './utils/sanitize-html'
 
 const _channels = new ChannelsMap()
-const version = '0.20.0'
+const version = '0.20.2'
 
 class SpyneApplication {
   /**
@@ -42,7 +42,7 @@ class SpyneApplication {
   init(config = {}, testMode = false) {
     // this.channels = new ChannelsMap();
     /*!
-     * Spyne 0.20.0
+     * Spyne 0.20.2
      * https://spynejs.org
      *
      * @license Copyright 2017-2021, Frank Batista, Relevant Context, LLC. All rights reserved.
@@ -121,6 +121,7 @@ class SpyneApplication {
     this.pluginsFn = SpyneAppProperties.getPluginsMethodObj(config['pluginMethods']);
     this.getChannelActions = (str) => _channels.getChannelActions(str);
     this.registerChannel = (val) => _channels.registerStream(val);
+    this.registerPlugin = (pluginInstance) => SpyneAppProperties.registerPlugin(pluginInstance);
     this.registerDataChannel = (obs$) => _channels.registerStream(obs$);
     this.listChannels = () => Array.from(_channels.map.keys());
     let nullHolder = new ViewStream({ id:'spyne-null-views' });

package/src/spyne/spyne-plugins.js

@@ -1,6 +1,7 @@
 import { DomElement } from './views/dom-element'
 import { SpyneAppProperties } from './utils/spyne-app-properties'
 import { is, clone, pathSatisfies } from 'ramda'
+let _spyneAppProps = SpyneAppProperties
 export class SpynePlugin {
   constructor(props = {}) {
     let { name, config, parentEl } = props
@@ -14,27 +15,65 @@ export class SpynePlugin {
     this.props.name = name
     config = SpynePlugin.mergeDefaultConfig(config, this.defaultConfig())
     this.props.parentEl = parentEl || SpynePlugin.createParentEl()
-    SpynePlugin.getSpyneApp(name, config)
-
+    // SpynePlugin.getSpyneApp(name, config)
+    this.props.config = config
     if (this.props.traits !== undefined) {
       this.addTraits(this.props.traits)
     }
 
+    // this.onBeforeRegistered()
+    // this.onRegistered()
+    // this.onRender()
+  }
+
+  /**
+   * Now this method will be called when the app decides to register the plugin.
+   * This way, the plugin no longer has to import or rely on its own version
+   * of SpyneAppProperties. Instead, it is *passed* the authoritative instance.
+   */
+  register(spyneAppProps) {
+    // 1. Save a reference to the real SpyneAppProperties
+    _spyneAppProps = spyneAppProps
+    this.props.pluginName = this.props.name
+
+    // this.props.config = _spyneAppProps.getPluginConfigByPluginName(this.props.pluginName)
+
+    if (_spyneAppProps.initialized === false) {
+      console.warn(
+          `Spyne Warning: SpyneApp has not been initialized yet! Cannot register plugin "${this.name}".`
+      )
+      return
+    }
+
     this.onBeforeRegistered()
+
+    // 2. Add plugin config in the real SpyneAppProperties
+    this.props.config = clone(this.props.config)
+    _spyneAppProps.addPluginConfig(this.name, this.props.config)
+
+    // If you have plugin-level logic that depends on the real spyneApp,
+    // you can add it here, e.g.:
+    // spyneAppProps.addPluginMethods(this.props.config.pluginMethods)
+
+    // 3. If you have other plugin lifecycle methods
     this.onRegistered()
     this.onRender()
   }
 
+  get SpyneAppProperties() {
+    return _spyneAppProps
+  }
+
   static mergeDefaultConfig(config = {}, defaultConfig = this.defaultConfig()) {
     return Object.assign(defaultConfig, config)
   }
 
   static getSpyneApp(name, config) {
-    if (SpyneAppProperties.initialized === false) {
+    if (_spyneAppProps.initialized === false) {
       console.warn(`Spyne Warning: Unable to install plugin, ${name}! SpyneApp has not been initialized!`)
       // SpyneApp.init()
     } else {
-      SpyneAppProperties.addPluginConfig(name, config)
+      _spyneAppProps.addPluginConfig(name, config)
     }
   }
 
@@ -82,8 +121,8 @@ export class SpynePlugin {
   }
 
   onBeforeRegistered() {
-    this.props.pluginName = this.props.name
-    this.props.config = SpyneAppProperties.getPluginConfigByPluginName(this.props.pluginName)
+    // this.props.pluginName = this.props.name
+    // this.props.config = _spyneAppProps.getPluginConfigByPluginName(this.props.pluginName)
   }
 
   defaultConfig() {

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

@@ -61,6 +61,7 @@ class SpyneAppPropertiesClass {
     this.getChannelActions = _channels.getChannelActions.bind(_channels)
     this.listRegisteredChannels = _channels.listRegisteredChannels.bind(_channels)
     _initialized = true
+    this._initialized = _initialized
     this.setChannelsMap()
     if (config?.baseHref) {
       this.setHeadBaseHref(config.baseHref)
@@ -178,6 +179,16 @@ class SpyneAppPropertiesClass {
     // console.log("REGISTERD PROXY REVIVER",_proxiesMap, _proxiesMap.get(name));
   }
 
+  // This is the new method you add
+  registerPlugin(pluginInstance) {
+    if (!this._initialized) {
+      console.warn('SpyneApp is not initialized yet. Plugin will not be fully registered.')
+    }
+    // console.log("INSTANCE ",this, pluginInstance)
+
+    pluginInstance.register(this)
+  }
+
   getProxyReviver(proxyName) {
     return _proxiesMap.get(proxyName)
   }

package/src/tests/package-json.spec.test.js

@@ -4,6 +4,9 @@ import pkg from '../../package.json' // Import package.json
 describe('package.json export import statement', () => {
   it('should be set to "./lib/spyne.esm.js"', () => {
     const exports = pkg.exports['.']
+    expect(pkg.main).to.equal('./lib/spyne.esm.js')
+    expect(pkg.module).to.equal('./lib/spyne.esm.js')
     expect(exports.import).to.equal('./lib/spyne.esm.js')
+    expect(exports.require).to.equal('./lib/spyne.esm.js')
   })
 })