neo.mjs 4.0.6 → 4.0.9

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "neo.mjs",
-    "version": "4.0.6",
+    "version": "4.0.9",
     "description": "The webworkers driven UI framework",
     "type": "module",
     "repository": {
@@ -37,7 +37,7 @@
         "@fortawesome/fontawesome-free": "^6.1.1",
         "@material/mwc-button": "^0.25.3",
         "@material/mwc-textfield": "^0.25.3",
-        "autoprefixer": "^10.4.4",
+        "autoprefixer": "^10.4.5",
         "chalk": "^5.0.1",
         "clean-webpack-plugin": "^4.0.0",
         "commander": "^9.2.0",
@@ -49,7 +49,7 @@
         "neo-jsdoc": "^1.0.1",
         "neo-jsdoc-x": "^1.0.4",
         "postcss": "^8.4.12",
-        "sass": "^1.50.0",
+        "sass": "^1.50.1",
         "webpack": "^5.72.0",
         "webpack-cli": "^4.9.2",
         "webpack-dev-server": "4.8.1",

package/src/data/connection/{Socket.mjs → WebSocket.mjs}

@@ -15,6 +15,15 @@ class Socket extends Base {
      * @member {Number} maxReconnectAttempts=5
      */
     maxReconnectAttempts = 5
+    /**
+     * @member {Object} messageCallbacks={}
+     */
+    messageCallbacks = {}
+    /**
+     * @member {Number} messageId=1
+     * @protected
+     */
+    messageId = 1
     /**
      * @member {Number} reconnectAttempts=0
      * @protected
@@ -57,7 +66,7 @@ class Socket extends Base {
      */
     construct(config) {
         super.construct(config);
-        this.socket = new WebSocket(this.serverAddress);
+        this.createSocket();
     }
 
     /**
@@ -70,7 +79,7 @@ class Socket extends Base {
         me.reconnectAttempts++;
 
         if (me.reconnectAttempts < me.maxReconnectAttempts) {
-            me.socket = new WebSocket(me.serverAddress);
+            me.createSocket();
 
             callback && me.on('open', {
                 callback,
@@ -89,7 +98,7 @@ class Socket extends Base {
         let me      = this,
             channel = me.channel;
 
-        console.debug('WS: Sending message', (channel ? '\nChannel: ' + channel : ''), '\nData:', data);
+        console.log('WS: Sending message', (channel ? '\nChannel: ' + channel : ''), '\nData:', data);
 
         return JSON.stringify(channel ? {channel, data} : data);
     }
@@ -112,12 +121,35 @@ class Socket extends Base {
                 onopen   : me.onOpen   .bind(me)
             });
 
-            NeoFunction.intercept(value, 'send', me.beforeSend, me);
+            NeoFunction.createInterceptor(value, 'send', me.beforeSend, me);
         }
 
         return value;
     }
 
+    /**
+     * @param {Number} [code] defaults to 1000
+     * @param {String} [reason]
+     */
+    close(code, reason) {
+        this.socket.close(code, reason);
+    }
+
+    /**
+     *
+     */
+    createSocket() {
+        this.socket = new WebSocket(this.serverAddress);
+    }
+
+    /**
+     *
+     */
+    destroy(...args) {
+        this.close();
+        super.destroy(...args);
+    }
+
     /**
      * @param {CloseEvent} event The Websocket generated CloseEvent
      * @param {Number}     event.code The WebSocket connection close code provided by the server
@@ -151,10 +183,18 @@ class Socket extends Base {
     }
 
     /**
-     * @param {Object} event
+     * @param {MessageEvent} event
      */
     onMessage(event) {
-        console.log('onMessage', event);
+        let me   = this,
+            data = JSON.parse(event.data);
+
+        console.log('onMessage', data);
+
+        if (data.mId) {
+            me.messageCallbacks[data.mId].resolve(data.data);
+            delete me.messageCallbacks[data.mId];
+        }
     }
 
     /**
@@ -164,10 +204,25 @@ class Socket extends Base {
         this.fire('open', {scope: this});
     }
 
+    /**
+     * @param {Object} data
+     * @returns {Promise<any>}
+     */
+    promiseMessage(data) {
+        let me = this;
+
+        return new Promise((resolve, reject) => {
+            me.messageCallbacks[me.messageId] = {reject, resolve};
+
+            me.sendMessage({data, mId: me.messageId});
+            me.messageId++;
+        });
+    }
+
     /**
      * @param {Object} data
      */
-    send(data) {
+    sendMessage(data) {
         let me     = this,
             socket = me.socket,
             d      = data;

package/src/manager/{RpcApi.mjs → rpc/Api.mjs}

@@ -1,17 +1,17 @@
-import Base from './Base.mjs';
+import Base from '../Base.mjs';
 
 /**
- * @class Neo.manager.RpcApi
+ * @class Neo.manager.rpc.Api
  * @extends Neo.manager.Base
  * @singleton
  */
-class RpcApi extends Base {
+class Api extends Base {
     static getConfig() {return {
         /**
-         * @member {String} className='Neo.manager.RpcApi'
+         * @member {String} className='Neo.manager.rpc.Api'
          * @protected
          */
-        className: 'Neo.manager.RpcApi',
+        className: 'Neo.manager.rpc.Api',
         /**
          * @member {Boolean} singleton=true
          * @protected
@@ -27,19 +27,20 @@ class RpcApi extends Base {
         Object.entries(api.services).forEach(([service, serviceValue]) => {
             Object.entries(serviceValue.methods).forEach(([method, methodValue]) => {
                 this.register({
-                    id : `${service}.${method}`,
+                    id  : `${service}.${method}`,
                     method,
                     service,
-                    url: methodValue.url || serviceValue.url || api.url
+                    type: methodValue.type || serviceValue.type || api.type || 'ajax',
+                    url : methodValue.url  || serviceValue.url  || api.url
                 })
             })
         })
     }
 }
 
-Neo.applyClassConfig(RpcApi);
+Neo.applyClassConfig(Api);
 
-let instance = Neo.create(RpcApi);
+let instance = Neo.create(Api);
 
 Neo.applyToGlobalNs(instance);
 

package/src/manager/{RpcMessage.mjs → rpc/Message.mjs}

@@ -1,12 +1,12 @@
-import Base     from './Base.mjs';
-import NeoArray from '../util/Array.mjs';
+import Base     from '../Base.mjs';
+import NeoArray from '../../util/Array.mjs';
 
 /**
- * @class Neo.manager.RpcMessage
+ * @class Neo.manager.rpc.Message
  * @extends Neo.manager.Base
  * @singleton
  */
-class RpcMessage extends Base {
+class Message extends Base {
     /**
      * Stores the urls of endpoints for which a setTimeout() call is in progress
      * @member {String[]} endPointTimeouts=[]
@@ -23,6 +23,10 @@ class RpcMessage extends Base {
      * @member {Number} requestBuffer=20
      */
     requestBuffer = 20
+    /**
+     * @member {Object} socketConnections={}
+     */
+    socketConnections = {}
     /**
      * internal incrementing flag
      * @member {Number} transactionId=1
@@ -32,10 +36,10 @@ class RpcMessage extends Base {
 
     static getConfig() {return {
         /**
-         * @member {String} className='Neo.manager.RpcMessage'
+         * @member {String} className='Neo.manager.rpc.Message'
          * @protected
          */
-        className: 'Neo.manager.RpcMessage',
+        className: 'Neo.manager.rpc.Message',
         /**
          * @member {Boolean} singleton=true
          * @protected
@@ -56,10 +60,22 @@ class RpcMessage extends Base {
      * @returns {Promise<any>}
      */
     onMessage(msg) {
+        let api = Neo.manager.rpc.Api.get(`${msg.service}.${msg.method}`);
+
+        return this[`onMessage${Neo.capitalize(method.type)}`](msg, api);
+    }
+
+    /**
+     *
+     * @param {Object} msg
+     * @param {Object} api
+     * @protected
+     * @returns {Promise<any>}
+     */
+    onMessageAjax(msg, api) {
         return new Promise((resolve, reject) => {
-            let me     = this,
-                method = Neo.manager.RpcApi.get(`${msg.service}.${msg.method}`),
-                url    = method.url;
+            let me  = this,
+                url = api.url;
 
             me.register({
                 id           : me.messageId,
@@ -84,6 +100,33 @@ class RpcMessage extends Base {
         });
     }
 
+    /**
+     *
+     * @param {Object} msg
+     * @param {Object} api
+     * @protected
+     * @returns {Promise<any>}
+     */
+    async onMessageWebsocket(msg, api) {
+        console.log('onMessageWebsocket', msg, api);
+
+        let me         = this,
+            url        = api.url,
+            connection = me.socketConnections[url];
+
+        if (!connection) {
+            let module = await import('../../data/connection/WebSocket.mjs');
+
+            me.socketConnections[url] = connection = Neo.create(module.default, {serverAddress: url});
+        }
+
+        return await connection.promiseMessage({
+            data   : msg,
+            method : api.method,
+            service: api.service
+        })
+    }
+
     /**
      * @param {String} url
      */
@@ -126,9 +169,9 @@ class RpcMessage extends Base {
     }
 }
 
-Neo.applyClassConfig(RpcMessage);
+Neo.applyClassConfig(Message);
 
-let instance = Neo.create(RpcMessage);
+let instance = Neo.create(Message);
 
 Neo.applyToGlobalNs(instance);
 

package/src/util/Function.mjs

@@ -27,6 +27,22 @@ class NeoFunction extends Base {
         }
     }
 
+    /**
+     * Intended for functions with 1 param where the interceptor can change the value
+     * @param {Object} target
+     * @param {String} targetMethodName
+     * @param {Function} interceptFunction
+     * @param {Object} scope=target
+     * @returns {Function}
+     */
+    static createInterceptor(target, targetMethodName, interceptFunction, scope) {
+        let targetMethod = target[targetMethodName];
+
+        return (target[targetMethodName] = function(value) {
+            return targetMethod.call(target, interceptFunction.call(scope || target, value));
+        });
+    }
+
     /**
      * @param {Neo.core.Base} target
      * @param {String} methodName
@@ -44,6 +60,7 @@ class NeoFunction extends Base {
     }
 
     /**
+     * The interceptor can prevent the targetMethod from getting executed in case it returns false.
      * @param {Object} target
      * @param {String} targetMethodName
      * @param {Function} interceptFunction

package/src/worker/Data.mjs

@@ -70,7 +70,7 @@ class Data extends Base {
      * @param {Object} msg.data the API content
      */
     onRegisterApi(msg) {
-        import('../manager/RpcApi.mjs').then(module => {
+        import('../manager/rpc/Api.mjs').then(module => {
             module.default.registerApi(msg.data);
             this.rpcApiManagerLoaded = true
         })
@@ -82,7 +82,7 @@ class Data extends Base {
     onRegisterNeoConfig(msg) {
         super.onRegisterNeoConfig(msg);
 
-        Neo.config.remotesApiUrl && import('../manager/RpcMessage.mjs').then(module => {
+        Neo.config.remotesApiUrl && import('../manager/rpc/Message.mjs').then(module => {
             this.rpcMessageManagerLoaded = true
         })
     }
@@ -102,7 +102,7 @@ class Data extends Base {
 
             me.reject(msg);
         } else {
-            response = await Neo.manager.RpcMessage.onMessage(msg);
+            response = await Neo.manager.rpc.Message.onMessage(msg);
 
             me.resolve(msg, response);
         }