@adcops/autocore-react 3.0.10 → 3.0.13

package/dist/core/EventEmitterContext.d.ts

@@ -76,7 +76,7 @@ export interface EventEmitterContextType {
      * Invoke/send a message to the back end.
      * This does NOT get published to the front end.
      */
-    invoke(fname: string, payload?: object): Promise<object>;
+    invoke(domain: string, fname: string, payload?: object): Promise<object>;
     /**
      * Subscribe to events identified by the topic.
      * @param topic The subscription topic.

package/dist/core/EventEmitterContext.js

@@ -1 +1 @@
-import{jsx as _jsx}from"react/jsx-runtime";import{createContext,useState,useMemo}from"react";import{createHub,Hub}from"../hub";export{Hub};let globalSubscriptionId=1;export const EventEmitterContext=createContext({state:{subscriptions:{},nextSubscriptionId:1},dispatch:()=>{},subscribe:()=>0,invoke:async(t,s)=>Promise.resolve({}),unsubscribe:t=>{},hub:null,getSubscriptions:()=>[]});export const EventEmitterProvider=({children:t})=>{const[s,e]=useState({subscriptions:{},nextSubscriptionId:1}),i=useMemo((()=>createHub()),[]),r=t=>{const{topic:s,payload:i}=t;e((t=>(t.subscriptions[s]?.forEach((t=>t.callback(i))),{...t,eventData:i})))},o=(t,s)=>{globalSubscriptionId+=1;const i=globalSubscriptionId;return e((e=>({...e,subscriptions:{...e.subscriptions,[t]:[...e.subscriptions[t]||[],{id:i,callback:s}]},nextSubscriptionId:globalSubscriptionId+1}))),i},n=t=>{e((s=>{const e={...s.subscriptions};for(const s in e)e.hasOwnProperty(s)&&(e[s]=e[s].filter((s=>s.id!==t)),0===e[s].length&&delete e[s]);return{...s,subscriptions:e}}))},c=t=>t?s.subscriptions[t]||[]:s.subscriptions,u=useMemo((()=>({state:s,dispatch:r,subscribe:o,unsubscribe:n,invoke:i.invoke,hub:i,getSubscriptions:c})),[s,i]);return i.setContext(u),_jsx(EventEmitterContext.Provider,{value:u,children:t})};
+import{jsx as _jsx}from"react/jsx-runtime";import{createContext,useState,useMemo}from"react";import{createHub,Hub}from"../hub";export{Hub};let globalSubscriptionId=1;export const EventEmitterContext=createContext({state:{subscriptions:{},nextSubscriptionId:1},dispatch:()=>{},subscribe:()=>0,invoke:async(t,s,e)=>Promise.resolve({}),unsubscribe:t=>{},hub:null,getSubscriptions:()=>[]});export const EventEmitterProvider=({children:t})=>{const[s,e]=useState({subscriptions:{},nextSubscriptionId:1}),i=useMemo((()=>createHub()),[]),r=t=>{const{topic:s,payload:i}=t;e((t=>(t.subscriptions[s]?.forEach((t=>t.callback(i))),{...t,eventData:i})))},o=(t,s)=>{globalSubscriptionId+=1;const i=globalSubscriptionId;return e((e=>({...e,subscriptions:{...e.subscriptions,[t]:[...e.subscriptions[t]||[],{id:i,callback:s}]},nextSubscriptionId:globalSubscriptionId+1}))),i},n=t=>{e((s=>{const e={...s.subscriptions};for(const s in e)e.hasOwnProperty(s)&&(e[s]=e[s].filter((s=>s.id!==t)),0===e[s].length&&delete e[s]);return{...s,subscriptions:e}}))},c=t=>t?s.subscriptions[t]||[]:s.subscriptions,u=useMemo((()=>({state:s,dispatch:r,subscribe:o,unsubscribe:n,invoke:i.invoke,hub:i,getSubscriptions:c})),[s,i]);return i.setContext(u),_jsx(EventEmitterContext.Provider,{value:u,children:t})};

package/dist/hub/CommandMessage.d.ts

@@ -0,0 +1,12 @@
+export interface CommandMessageResult {
+    data: any;
+    success: boolean;
+    error_message: string;
+}
+export interface CommandMessage {
+    request_id: number;
+    domain: string;
+    fname: string;
+    args?: any;
+    result?: CommandMessageResult;
+}

package/dist/hub/CommandMessage.js

@@ -0,0 +1 @@
+export{};

package/dist/hub/HubBase.d.ts

@@ -1,4 +1,5 @@
 import { EventEmitterContextType } from '../core/EventEmitterContext';
+import { CommandMessageResult } from "./CommandMessage";
 /**
  * Base class for the interface for the IPC to the backend,
  * which may be websockets, MQTT, the Tauri API,
@@ -98,16 +99,17 @@ export declare abstract class HubBase {
      * Invoke/send a message to the back end.
      * This does NOT get published to the front end.
      */
-    abstract invoke(fname: string, payload?: object): Promise<object>;
+    abstract invoke(domain: string, fname: string, payload?: object): Promise<CommandMessageResult>;
     /**
      * Convenience function to invoke a command with an optional topic and optional value.
      * This will invoke the specified command in the backend. It does not broadcast the
      * value within the local frontend.
+     * @param domain string The domain of the command that will be invoked.
      * @param fname string Function name
      * @param topic string Topic
      * @param value any data payload
      */
-    invokeTopic(fname: string, topic: string | null, value?: any): Promise<object>;
+    invokeTopic(domain: string, fname: string, topic: string | null, value?: any): Promise<CommandMessageResult>;
     /**
      * Pubish a topic throughout the web app using the
      * Global EventEmitterContext. This will broadcast within the local frontend.

package/dist/hub/HubBase.js

@@ -1 +1 @@
-export class HubBase{constructor(){Object.defineProperty(this,"localTopicToBackendTopicMap",{enumerable:!0,configurable:!0,writable:!0,value:new Map}),Object.defineProperty(this,"backendTopicToLocalMap",{enumerable:!0,configurable:!0,writable:!0,value:new Map}),Object.defineProperty(this,"localFNameToBackendFNameMap",{enumerable:!0,configurable:!0,writable:!0,value:new Map}),Object.defineProperty(this,"backendFNameToLocalFNameMap",{enumerable:!0,configurable:!0,writable:!0,value:new Map}),Object.defineProperty(this,"context",{enumerable:!0,configurable:!0,writable:!0,value:null})}setContext(a){this.context=a}invokeTopic(a,e,o){const c={topic:e,data:o};return this.invoke(a,c)}publish(a,e){const o=this.toLocalTopic(a);this.context?.dispatch({topic:o,payload:e})}mapTopic(a,e){this.localTopicToBackendTopicMap.set(a,e),this.backendTopicToLocalMap.set(e,a)}unmapTopic(a){if(this.localTopicToBackendTopicMap.has(a)){const e=this.localTopicToBackendTopicMap.get(a);this.localTopicToBackendTopicMap.delete(a),null!=e&&this.backendTopicToLocalMap.has(e)&&this.backendTopicToLocalMap.delete(e)}}mapFName(a,e){this.localFNameToBackendFNameMap.set(a,e),this.backendFNameToLocalFNameMap.set(e,a)}unmapFName(a){if(this.localFNameToBackendFNameMap.has(a)){const e=this.localFNameToBackendFNameMap.get(a);this.localFNameToBackendFNameMap.delete(a),null!=e&&this.backendFNameToLocalFNameMap.has(e)&&this.backendFNameToLocalFNameMap.delete(e)}}toBackendTopic(a){if(this.localTopicToBackendTopicMap.has(a)){const e=this.localTopicToBackendTopicMap.get(a);return null!=e?e:a}return a}toBackendFName(a){if(this.localFNameToBackendFNameMap.has(a)){const e=this.localFNameToBackendFNameMap.get(a);return null!=e?e:a}return a}toLocalTopic(a){if(this.backendTopicToLocalMap.has(a)){const e=this.backendTopicToLocalMap.get(a);return null!=e?e:a}return a}toLocalFName(a){if(this.backendFNameToLocalFNameMap.has(a)){const e=this.backendFNameToLocalFNameMap.get(a);return null!=e?e:a}return a}}export default HubBase;
+export class HubBase{constructor(){Object.defineProperty(this,"localTopicToBackendTopicMap",{enumerable:!0,configurable:!0,writable:!0,value:new Map}),Object.defineProperty(this,"backendTopicToLocalMap",{enumerable:!0,configurable:!0,writable:!0,value:new Map}),Object.defineProperty(this,"localFNameToBackendFNameMap",{enumerable:!0,configurable:!0,writable:!0,value:new Map}),Object.defineProperty(this,"backendFNameToLocalFNameMap",{enumerable:!0,configurable:!0,writable:!0,value:new Map}),Object.defineProperty(this,"context",{enumerable:!0,configurable:!0,writable:!0,value:null})}setContext(a){this.context=a}invokeTopic(a,e,o,c){const t={topic:o,data:c};return this.invoke(a,e,t)}publish(a,e){const o=this.toLocalTopic(a);this.context?.dispatch({topic:o,payload:e})}mapTopic(a,e){this.localTopicToBackendTopicMap.set(a,e),this.backendTopicToLocalMap.set(e,a)}unmapTopic(a){if(this.localTopicToBackendTopicMap.has(a)){const e=this.localTopicToBackendTopicMap.get(a);this.localTopicToBackendTopicMap.delete(a),null!=e&&this.backendTopicToLocalMap.has(e)&&this.backendTopicToLocalMap.delete(e)}}mapFName(a,e){this.localFNameToBackendFNameMap.set(a,e),this.backendFNameToLocalFNameMap.set(e,a)}unmapFName(a){if(this.localFNameToBackendFNameMap.has(a)){const e=this.localFNameToBackendFNameMap.get(a);this.localFNameToBackendFNameMap.delete(a),null!=e&&this.backendFNameToLocalFNameMap.has(e)&&this.backendFNameToLocalFNameMap.delete(e)}}toBackendTopic(a){if(this.localTopicToBackendTopicMap.has(a)){const e=this.localTopicToBackendTopicMap.get(a);return null!=e?e:a}return a}toBackendFName(a){if(this.localFNameToBackendFNameMap.has(a)){const e=this.localFNameToBackendFNameMap.get(a);return null!=e?e:a}return a}toLocalTopic(a){if(this.backendTopicToLocalMap.has(a)){const e=this.backendTopicToLocalMap.get(a);return null!=e?e:a}return a}toLocalFName(a){if(this.backendFNameToLocalFNameMap.has(a)){const e=this.backendFNameToLocalFNameMap.get(a);return null!=e?e:a}return a}}export default HubBase;

package/dist/hub/HubSimulate.d.ts

@@ -1,4 +1,5 @@
 import { HubBase } from './HubBase';
+import { CommandMessageResult } from "./CommandMessage";
 /**
  * Hub for simulating functionality when no backend is present.
  */
@@ -15,6 +16,6 @@ export declare class HubSimulate extends HubBase {
      * @param timeout Timeout in milliseconds after which the promise is rejected if no response is received.
      * @returns A Promise that resolves to the response from the backend or rejects if a timeout occurs.
      */
-    invoke(fname: string, payload?: object, timeout?: number): Promise<object>;
+    invoke(domain: string, fname: string, payload?: object, timeout?: number): Promise<CommandMessageResult>;
 }
 export default HubSimulate;

package/dist/hub/HubSimulate.js

@@ -1 +1 @@
-import{HubBase}from"./HubBase";export class HubSimulate extends HubBase{constructor(){super()}invoke(e,t,u=20){return new Promise(((e,r)=>{setTimeout((()=>{e({data:t})}),u)}))}}export default HubSimulate;
+import{HubBase}from"./HubBase";export class HubSimulate extends HubBase{constructor(){super()}invoke(e,s,r,t=20){return new Promise(((e,s)=>{setTimeout((()=>{e({data:r,error_message:"",success:!0})}),t)}))}}export default HubSimulate;

package/dist/hub/HubTauri.d.ts

@@ -1,4 +1,5 @@
 import { HubBase } from './HubBase';
+import { CommandMessageResult } from "./CommandMessage";
 /**
  * Hub for integrating with the Tauri backend.
  *
@@ -82,5 +83,5 @@ export declare class HubTauri extends HubBase {
      * @param payload Optional data payload
      * @returns The return value of the backend method.
      */
-    invoke(fname: string, payload?: object | undefined): Promise<object>;
+    invoke(domain: string, fname: string, payload?: object | undefined): Promise<CommandMessageResult>;
 }

package/dist/hub/HubTauri.js

@@ -1 +1 @@
-import{HubBase}from"./HubBase";import{event,invoke}from"@tauri-apps/api";export class HubTauri extends HubBase{constructor(){super(),event.listen("autocore://broadcast_event",(o=>{let e=JSON.parse(o.payload);void 0!==e.topic&&null!==e.topic&&(void 0!==e.payload&&null!==e.payload?this.publish(e.topic,e.payload):this.publish(e.topic,void 0))}))}invoke(o,e){return null!=e?invoke(o,e):invoke(o)}}
+import{HubBase}from"./HubBase";import{event,invoke}from"@tauri-apps/api";export class HubTauri extends HubBase{constructor(){super(),event.listen("autocore://broadcast_event",(o=>{let e=JSON.parse(o.payload);void 0!==e.topic&&null!==e.topic&&(void 0!==e.payload&&null!==e.payload?this.publish(e.topic,e.payload):this.publish(e.topic,void 0))}))}invoke(o,e,i){if(null!=i){return invoke(`${o}_${e}`,i)}return invoke(e)}}

package/dist/hub/HubWebSocket.d.ts

@@ -0,0 +1,25 @@
+/** @file
+ *
+ * ## broadcast messages
+ * The result field of CommandMessages used for broadcast must have
+ * success set to true, and must contain the field "topic." The topic field, along
+ * with the domain field of the CommandMessage will be combined for the topic used
+ * by the websocket client.
+ *
+ * broadcast topic = `${CommandMessage.domain}/${CommandMessage.result["topic"]}
+ *
+ * So, to subscribe to a broadcast topic for GM.fReal that is served by the ADS client, the
+ * topic will be: "ADS/GM.fReal"
+ */
+import { HubBase } from './HubBase';
+import { CommandMessage, CommandMessageResult } from "./CommandMessage";
+export declare class HubWebSocket extends HubBase {
+    private socket;
+    private requestId;
+    private pendingRequests;
+    constructor();
+    invoke: (domain: string, fname: string, payload?: object) => Promise<CommandMessageResult>;
+    handleUnsolicitedMessage: (msg: CommandMessage) => void;
+    disconnect: () => void;
+    protected emit: (eventName: string, payload?: object) => void;
+}

package/dist/hub/HubWebSocket.js

@@ -0,0 +1 @@
+import{HubBase}from"./HubBase";export class HubWebSocket extends HubBase{constructor(){super(),Object.defineProperty(this,"socket",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"requestId",{enumerable:!0,configurable:!0,writable:!0,value:0}),Object.defineProperty(this,"pendingRequests",{enumerable:!0,configurable:!0,writable:!0,value:new Map}),Object.defineProperty(this,"invoke",{enumerable:!0,configurable:!0,writable:!0,value:(e,t,s)=>new Promise(((i,r)=>{const n=++this.requestId;this.pendingRequests.set(n,{resolve:i,reject:r});let o={request_id:n,domain:e,fname:t,args:s,result:void 0};this.socket.send(JSON.stringify(o))}))}),Object.defineProperty(this,"handleUnsolicitedMessage",{enumerable:!0,configurable:!0,writable:!0,value:e=>{if("BROADCAST"===e.fname&&e.domain.length>=1&&void 0!==e.result&&null!==e.result&&void 0!==e.result.data&&null!==e.result.data){let t=`${e.domain}/${e.result.data.topic}`;this.publish(t,e.result.data)}}}),Object.defineProperty(this,"disconnect",{enumerable:!0,configurable:!0,writable:!0,value:()=>{this.socket.close()}}),Object.defineProperty(this,"emit",{enumerable:!0,configurable:!0,writable:!0,value:(e,t)=>{this.socket.send(JSON.stringify({eventName:e,payload:t}))}});const e=window.location.hostname,t=window.location.port,s=`${"https:"===window.location.protocol?"wss://":"ws://"}${e}${t?":"+t:""}/ws/`;this.socket=new WebSocket(s);let i=this;this.socket.onopen=function(){i.publish("HUB/connected",!0)},this.socket.onmessage=e=>{const t=JSON.parse(e.data);if(t.request_id&&this.pendingRequests.has(t.request_id)){const{resolve:e,reject:s}=this.pendingRequests.get(t.request_id);t.result?.success?e(t.result):s(new Error(t.result?.error_message)),this.pendingRequests.delete(t.request_id)}else this.handleUnsolicitedMessage(t)},this.socket.onerror=e=>{},this.socket.onclose=()=>{}}}

package/dist/hub/index.d.ts

@@ -1,7 +1,8 @@
 import { HubBase as Hub } from './HubBase';
 import { HubTauri } from './HubTauri';
-import { HubSocketIo } from "./HubSocketIo";
+import { HubWebSocket } from "./HubWebSocket";
 import { HubSimulate } from "./HubSimulate";
+import { CommandMessage, CommandMessageResult } from './CommandMessage';
 /**
  * Creates a connection to the backend.
  * @returns Hub
@@ -9,5 +10,6 @@ import { HubSimulate } from "./HubSimulate";
 export declare function createHub(): Hub;
 export { HubBase as Hub } from './HubBase';
 export { HubTauri };
-export { HubSocketIo };
+export { HubWebSocket };
 export { HubSimulate };
+export type { CommandMessage, CommandMessageResult };

package/dist/hub/index.js

@@ -1 +1 @@
-import{HubTauri}from"./HubTauri";import{HubSocketIo}from"./HubSocketIo";import{HubSimulate}from"./HubSimulate";export function createHub(){return window.__TAURI__?new HubTauri:"80"!==window.location.port&&"443"!==window.location.port?new HubSimulate:new HubSocketIo}export{HubBase as Hub}from"./HubBase";export{HubTauri};export{HubSocketIo};export{HubSimulate};
+import{HubTauri}from"./HubTauri";import{HubWebSocket}from"./HubWebSocket";import{HubSimulate}from"./HubSimulate";export function createHub(){return void 0!==window.__TAURI__&&null!==window.__TAURI__?new HubTauri:void 0!==window.location.port&&window.location.port.length>0&&"80"!==window.location.port&&"8080"!==window.location.port&&"443"!==window.location.port?new HubSimulate:new HubWebSocket}export{HubBase as Hub}from"./HubBase";export{HubTauri};export{HubWebSocket};export{HubSimulate};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@adcops/autocore-react",
-    "version": "3.0.10",
+    "version": "3.0.13",
     "description": "A React component library for industrial user interfaces.",
     "private": false,
     "type": "module",

package/src/core/EventEmitterContext.tsx

@@ -2,7 +2,7 @@
  * Copyright (C) 2024 Automated Design Corp. All Rights Reserved.
  * Created Date: 2024-01-17 11:45:10
  * -----
- * Last Modified: 2024-03-22 14:25:08
+ * Last Modified: 2024-04-23 11:53:43
  * Modified By: ADC
  * -----
  * 
@@ -103,7 +103,7 @@ export interface EventEmitterContextType {
      * Invoke/send a message to the back end. 
      * This does NOT get published to the front end.
      */
-    invoke(fname: string, payload? : object) : Promise<object>;
+    invoke( domain: string, fname: string, payload? : object) : Promise<object>;
 
     /**
      * Subscribe to events identified by the topic.
@@ -264,7 +264,8 @@ export const EventEmitterContext = createContext<EventEmitterContextType>({
     state: { subscriptions: {}, nextSubscriptionId : 1 },
     dispatch: () => { },
     subscribe: () => { return 0; }, // Placeholder for subscription logic
-    invoke: async (fname: string, payload?: object) => { 
+    invoke: async (domain: string, fname: string, payload?: object) => { 
+        domain;
         fname;
         payload;
         // Placeholder for invoke logic

package/src/hub/CommandMessage.ts

@@ -0,0 +1,37 @@
+/*
+ * Copyright (C) 2024 Automated Design Corp.. All Rights Reserved.
+ * Created Date: 2024-04-24 11:47:13
+ * -----
+ * Last Modified: 2024-04-24 11:48:08
+ * -----
+ * 
+ */
+
+
+
+/// The result portion of a CommandMessage. The server will
+/// place the result of a command in this portion of the message.
+export interface CommandMessageResult {
+    /// The JSON object of the result.
+    data: any; 
+    /// If true, the command was processed successfully.
+    success : boolean,
+    /// If success is false, this should contain a corresponding error message.
+    error_message: string;
+}
+
+/// CommandMessage is the object passed between the client and server for making requests and
+/// responses. 
+export interface CommandMessage {
+    /// An id to identify the request. The request ID is managed by the client and will be reflected back.
+    /// The server will never change the request ID.
+    request_id: number; 
+    /// The command domain/servelet in which this command/function to invoke belongs.
+    domain: string;
+    /// The name of the function to invoke.
+    fname: string;
+    /// A JSON object of the arguments to the function.
+    args?: any; 
+    /// The result of the command, reflected back from the server
+    result?: CommandMessageResult;
+}

package/src/hub/HubBase.ts

@@ -3,14 +3,14 @@
  * Created Date: 2023-12-15 14:21:33
  * Author: Thomas C. Bitsky Jr.
  * -----
- * Last Modified: 2024-03-08 07:09:11
+ * Last Modified: 2024-04-24 11:56:16
  * Modified By: ADC
  * -----
  * 
  */
 
 import { EventEmitterContextType} from '../core/EventEmitterContext';
-
+import {CommandMessageResult} from "./CommandMessage";
 
 
 /**
@@ -122,23 +122,24 @@ export abstract class HubBase {
      * Invoke/send a message to the back end. 
      * This does NOT get published to the front end.
      */
-    abstract invoke(fname: string, payload? : object) : Promise<object>;
+    abstract invoke(domain: string, fname: string, payload? : object) : Promise<CommandMessageResult>;
 
 
     /**
      * Convenience function to invoke a command with an optional topic and optional value.
      * This will invoke the specified command in the backend. It does not broadcast the
      * value within the local frontend.
+     * @param domain string The domain of the command that will be invoked.
      * @param fname string Function name
      * @param topic string Topic 
      * @param value any data payload
      */
-    invokeTopic( fname : string, topic : string | null, value? : any ) : Promise<object> {
+    invokeTopic( domain: string, fname : string, topic : string | null, value? : any ) : Promise<CommandMessageResult> {
         const msg = {
             topic : topic,
             data : value
         };
-        return this.invoke(fname, msg);
+        return this.invoke(domain, fname, msg);
     }
 
     /** 

package/src/hub/HubSimulate.ts

@@ -2,7 +2,7 @@
  * Copyright (C) 2023 Automated Design Corp. All Rights Reserved.
  * Created Date: 2023-12-17 10:38:21
  * -----
- * Last Modified: 2024-03-08 09:35:51
+ * Last Modified: 2024-04-24 11:56:26
  * Modified By: ADC
  * -----
  * 
@@ -10,7 +10,7 @@
 
 
 import { HubBase } from './HubBase';
-
+import { CommandMessageResult } from "./CommandMessage";
 /**
  * Hub for simulating functionality when no backend is present.
  */
@@ -31,13 +31,21 @@ export class HubSimulate extends HubBase {
      * @param timeout Timeout in milliseconds after which the promise is rejected if no response is received.
      * @returns A Promise that resolves to the response from the backend or rejects if a timeout occurs.
      */
-    invoke(fname: string, payload?: object, timeout: number = 20): Promise<object> {
+    invoke(domain: string, fname: string, payload?: object, timeout: number = 20): Promise<CommandMessageResult> {
+        domain; // Not using for simulator
         fname; // Not using for simulator
         return new Promise((resolve, reject) => {
             reject; // not using for simulator
             // Set a timeout to echo a response
             setTimeout(() => {
-                resolve({data: payload});
+
+                let ret: CommandMessageResult = {
+                    data: payload,
+                    error_message: "",
+                    success: true
+                };
+
+                resolve(ret);
             }, timeout);
         });
     }

package/src/hub/HubTauri.ts

@@ -3,7 +3,7 @@
  * Created Date: 2023-12-17 09:50:23
  * Author: Thomas C. Bitsky Jr.
  * -----
- * Last Modified: 2024-03-07 13:20:46
+ * Last Modified: 2024-04-24 11:56:32
  * Modified By: ADC
  * -----
  * 
@@ -12,7 +12,7 @@
 import { InvokeArgs } from '@tauri-apps/api/tauri';
 import { HubBase } from './HubBase';
 import {event, invoke} from '@tauri-apps/api';
-
+import {CommandMessageResult} from "./CommandMessage";
 
 /**
  * Hub for integrating with the Tauri backend.
@@ -128,13 +128,17 @@ export class HubTauri extends HubBase {
      * @param payload Optional data payload
      * @returns The return value of the backend method.
      */
-    invoke(fname: string, payload?: object | undefined): Promise<object> {
+    invoke(domain : string, fname: string, payload?: object | undefined): Promise<CommandMessageResult> {
 
         console.log(JSON.stringify(event));
 
         if (payload !== undefined && payload !== null) {
             console.log(`Payload: ${JSON.stringify(payload)}`);
-            return invoke(fname, payload as InvokeArgs);
+
+            // todo! This should probably always been the same function, and then that function
+            // in the backend routes the command.
+            let topic = `${domain}_${fname}`;
+            return invoke(topic, payload as InvokeArgs);
         }            
         else {
             return invoke(fname);

package/src/hub/HubWebSocket.ts

@@ -0,0 +1,127 @@
+/*
+ * Copyright (C) 2024 Automated Design Corp.. All Rights Reserved.
+ * Created Date: 2024-04-17 09:13:07
+ * -----
+ * Last Modified: 2024-04-24 11:56:51
+ * -----
+ * 
+ */
+
+/** @file
+ * 
+ * ## broadcast messages
+ * The result field of CommandMessages used for broadcast must have
+ * success set to true, and must contain the field "topic." The topic field, along
+ * with the domain field of the CommandMessage will be combined for the topic used
+ * by the websocket client.
+ * 
+ * broadcast topic = `${CommandMessage.domain}/${CommandMessage.result["topic"]}
+ * 
+ * So, to subscribe to a broadcast topic for GM.fReal that is served by the ADS client, the
+ * topic will be: "ADS/GM.fReal"
+ */
+
+import { HubBase } from './HubBase';
+import {CommandMessage, CommandMessageResult} from "./CommandMessage";
+
+// Function to parse the JSON string received from the server into a CommandMessage object
+// function parseCommandMessage(jsonString: string): CommandMessage {
+//     const parsed: CommandMessage = JSON.parse(jsonString);
+//     // Assuming the JSON structure directly matches the TypeScript interfaces
+//     return parsed;
+// }
+
+
+interface RequestRecord {
+    resolve: (value?: any) => void;
+    reject: (reason?: any) => void;
+}
+
+
+export class HubWebSocket extends HubBase {
+    private socket: WebSocket;
+    private requestId = 0;
+    private pendingRequests = new Map<number, RequestRecord>();
+
+    constructor() {
+        super();
+        
+        const host = window.location.hostname; // Get the hostname from the address bar
+        const port = window.location.port; // Get the port from the address bar, if any
+        const proto = window.location.protocol === 'https:' ? 'wss://' : 'ws://'; // Determine the protocol
+        const wsUrl = `${proto}${host}${port ? ':' + port : ''}/ws/`; // Construct WebSocket URL
+
+        this.socket = new WebSocket(wsUrl);
+
+
+        let self = this;
+        this.socket.onopen = function() {
+            console.log("WebSocket connection established.");
+            self.publish("HUB/connected", true);
+            //ws.send("Hello, server!"); // Send a message to the server
+        };
+        
+        
+        this.socket.onmessage = (event) => {
+            const data: CommandMessage = JSON.parse(event.data);
+            if (data.request_id && this.pendingRequests.has(data.request_id)) {
+                const { resolve, reject } = this.pendingRequests.get(data.request_id)!;
+                if (!data.result?.success) {
+                    reject(new Error(data.result?.error_message));
+                } else {
+                    resolve(data.result);
+                }
+                this.pendingRequests.delete(data.request_id);
+            } else {
+                this.handleUnsolicitedMessage(data);
+            }
+        };
+
+        this.socket.onerror = (error: Event) => {
+            console.error('WebSocket error:', error);
+        };
+
+        this.socket.onclose = () => {
+            console.log('WebSocket connection closed.');
+        };
+    }
+
+    invoke = (domain : string, fname: string, payload?: object): Promise<CommandMessageResult> => {
+
+        return new Promise((resolve, reject) => {
+            const id = ++this.requestId; // Increment and use the request ID
+            this.pendingRequests.set(id, { resolve, reject });
+
+            let cm : CommandMessage = {
+                request_id: id,
+                domain: domain,
+                fname: fname,
+                args: payload,
+                result: undefined
+            };
+
+            this.socket.send(JSON.stringify(cm));
+        });
+    }
+
+    handleUnsolicitedMessage = (msg: CommandMessage) => {
+        // Handle messages that do not correspond to a pending request
+
+        if (msg.fname === "BROADCAST" 
+            && msg.domain.length >= 1
+            && msg.result !== undefined && msg.result !== null
+            && msg.result.data !== undefined && msg.result.data !== null            
+        ) {
+            let topic = `${msg.domain}/${msg.result.data["topic"]}`;
+            this.publish(topic, msg.result.data);
+        }
+    }
+
+    disconnect= (): void => {
+        this.socket.close();
+    }
+
+    protected emit = (eventName: string, payload?: object): void => {
+        this.socket.send(JSON.stringify({ eventName, payload }));
+    }
+}

package/src/hub/index.ts

@@ -2,7 +2,7 @@
  * Copyright (C) 2024 Automated Design Corp. All Rights Reserved.
  * Created Date: 2024-01-16 21:07:29
  * -----
- * Last Modified: 2024-03-08 10:20:06
+ * Last Modified: 2024-04-24 11:52:21
  * Modified By: ADC
  * -----
  * 
@@ -10,25 +10,38 @@
 
 import { HubBase as Hub } from './HubBase';
 import { HubTauri } from './HubTauri';
-import { HubSocketIo } from "./HubSocketIo";
+import { HubWebSocket } from "./HubWebSocket";
 import {HubSimulate} from "./HubSimulate"
+import { CommandMessage, CommandMessageResult } from './CommandMessage';
 
 /**
  * Creates a connection to the backend.
  * @returns Hub 
  */
 export function createHub(): Hub {
-    if (window.__TAURI__) {
+
+    if (window.__TAURI__ !== undefined && window.__TAURI__ !== null) {
+        // Standalone Tauri application
+        console.log("HUB: Starting link to Tauri backend.");
         return new HubTauri();
     }
-    else if (window.location.port !== '80' && window.location.port !== '443' ) {
+    else if (
+        window.location.port !== undefined
+        &&  window.location.port.length > 0
+        && window.location.port !== '80' 
+        && window.location.port !== '8080' 
+        && window.location.port !== '443' 
+    ) {
     
         // We're loaded in some development environment
+        console.log("HUB: Starting HUB SIMULATOR.");
         return new HubSimulate();
 
     } 
     else {
-        return new HubSocketIo();
+        // A web-app that must communicate with a backend in another process.
+        console.log("HUB: Starting websocket connection.");
+        return new HubWebSocket();
     }
 }
 
@@ -37,5 +50,6 @@ export function createHub(): Hub {
 // application.
 export {HubBase as Hub} from './HubBase';
 export {HubTauri}
-export {HubSocketIo}
+export {HubWebSocket}
 export {HubSimulate}
+export type {CommandMessage, CommandMessageResult}

package/dist/hub/HubSocketIo.d.ts

@@ -1,101 +0,0 @@
-import { HubBase } from './HubBase';
-/**
- * Hub for integrating with a webserver/backend using Socket.IO as the pipeline.
- *
- * The socket-io connection is expected to broadcast messages on the event
- * name: 'autocore://broadcast_event'
- *
- * This hub will capture those messages and dispatch them globally to any
- * listeners in the web app.
- *
- *
- * Example: Listen to an event 'xarm-position':
- * ```
- * const {subscribe, unsubscribe} = useContext(EventEmitterContext);
- * useEffect(() => {
- *         const unsubscripeMp = subscribe('xarm-position', (value) => {
- *            // The rust backend sent a JSON object of 3D position values.
- *            setX(value.x);
- *            setY(value.y);
- *            setZ(value.z);
- *            setA(value.roll);
- *            setB(value.yaw);
- *            setC(value.pitch);
- *        });
- *
- *    return () => {
- *        unsubscribe(unsubscripeMp);
- *    }
- *
- * }, [] );
- *
- * ```
- *
- * The hub should also be used for invoking events in the Tauri backend.
- * This example will call the function "update_count" in the rust backend, passing
- * the expected argument "count".
- * ```
- * const {invoke} = useContext(EventEmitterContext);
- * const incrementCount = () => {
- *    count += 1;
- *    invoke('update_count', {"count": count});
- * };
- * ```
- *
- * Of course, like any class derived from HubBase, the hub can be used to publish and subscribe to
- * topics in the front-end, without need of interacting with the Tauri backed.
- *
- * ```
- * const {dispatch, subscribe, unsubscribe} = useContext(EventEmitterContext);
- * const [controlPower, setControlPower] = useState(false);
- * useEffect(() => {
- *      const unsubscribeControlPower = subscribe('value-simulator-bBit1', (value) => {
- *          setControlPower(value);
- *      });
- *
- *
- *      return () => {
- *           unsubscribe(unsubscribeControlPower);
- *      }
- * }, [] );
- *
- * const onPbPressed = () => {
- *      let count = 1;
- *      dispatch({
- *          topic: "my-awesome-topic",
- *          payload: count
- *      });
- * }
- *
- * ```
- *
- */
-export declare class HubSocketIo extends HubBase {
-    private socket;
-    /**
-     * Constructor
-     */
-    constructor();
-    /**
-     * Invoke a method in the Socket.IO backend and wait for acknowledgment.
-     *
-     * @param fname method name
-     * @param payload Optional data payload
-     * @param timeout Timeout in milliseconds after which the promise is rejected if no response is received.
-     * @returns A Promise that resolves to the response from the backend or rejects if a timeout occurs.
-     */
-    invoke(fname: string, payload?: object, timeout?: number): Promise<object>;
-    /**
-     * Disconnects the Socket.IO client.
-     */
-    disconnect(): void;
-    /**
-     * Emit an event to the Socket.IO server.
-     * The intention is that the invoke method is used instead.
-     *
-     * @param eventName Name of the event to emit
-     * @param payload Optional data payload
-     */
-    protected emit(eventName: string, payload?: object): void;
-}
-export default HubSocketIo;

package/dist/hub/HubSocketIo.js

@@ -1 +0,0 @@
-import{HubBase}from"./HubBase";import io from"socket.io-client";export class HubSocketIo extends HubBase{constructor(){super(),Object.defineProperty(this,"socket",{enumerable:!0,configurable:!0,writable:!0,value:void 0});const e=window.location.origin;this.socket=io(e),this.socket.on("autocore://broadcast_event",(e=>{let o=JSON.parse(e.payload);void 0!==o.topic&&null!==o.topic&&(void 0!==o.payload&&null!==o.payload?this.publish(o.topic,o.payload):this.publish(o.topic,void 0))}))}invoke(e,o,t=5e3){return new Promise(((i,s)=>{let c=!1;this.socket.emit(e,o,(e=>{c=!0,i(e)})),setTimeout((()=>{c||s(new Error(`Timeout: No response received within ${t} ms`))}),t)}))}disconnect(){this.socket.disconnect()}emit(e,o){this.socket.emit(e,o)}}export default HubSocketIo;

package/src/hub/HubSocketIo.ts

@@ -1,166 +0,0 @@
-/*
- * Copyright (C) 2023 Automated Design Corp. All Rights Reserved.
- * Created Date: 2023-12-17 10:38:21
- * Author: Thomas C. Bitsky Jr.
- * -----
- * Last Modified: 2024-03-08 09:46:20
- * Modified By: ADC
- * -----
- * 
- */
-
-import { HubBase } from './HubBase';
-import io, { Socket } from 'socket.io-client';
-
-/**
- * Hub for integrating with a webserver/backend using Socket.IO as the pipeline.
- * 
- * The socket-io connection is expected to broadcast messages on the event
- * name: 'autocore://broadcast_event'
- * 
- * This hub will capture those messages and dispatch them globally to any 
- * listeners in the web app.
- * 
- * 
- * Example: Listen to an event 'xarm-position':
- * ```
- * const {subscribe, unsubscribe} = useContext(EventEmitterContext);
- * useEffect(() => {
- *         const unsubscripeMp = subscribe('xarm-position', (value) => {
- *            // The rust backend sent a JSON object of 3D position values. 
- *            setX(value.x);
- *            setY(value.y);
- *            setZ(value.z);
- *            setA(value.roll);
- *            setB(value.yaw);
- *            setC(value.pitch);
- *        });
- * 
- *    return () => {
- *        unsubscribe(unsubscripeMp);
- *    }
- * 
- * }, [] );
- *
- * ```
- * 
- * The hub should also be used for invoking events in the Tauri backend.
- * This example will call the function "update_count" in the rust backend, passing
- * the expected argument "count".
- * ```
- * const {invoke} = useContext(EventEmitterContext);
- * const incrementCount = () => {
- *    count += 1;
- *    invoke('update_count', {"count": count});        
- * };
- * ```
- * 
- * Of course, like any class derived from HubBase, the hub can be used to publish and subscribe to
- * topics in the front-end, without need of interacting with the Tauri backed.
- * 
- * ```
- * const {dispatch, subscribe, unsubscribe} = useContext(EventEmitterContext);
- * const [controlPower, setControlPower] = useState(false);
- * useEffect(() => {
- *      const unsubscribeControlPower = subscribe('value-simulator-bBit1', (value) => {
- *          setControlPower(value);
- *      });  
- *
- *
- *      return () => {
- *           unsubscribe(unsubscribeControlPower);
- *      }
- * }, [] );
- * 
- * const onPbPressed = () => {
- *      let count = 1;
- *      dispatch({
- *          topic: "my-awesome-topic",
- *          payload: count
- *      });
- * }
- * 
- * ```
- * 
- */
-export class HubSocketIo extends HubBase {
-    private socket: Socket;
-
-    /**
-     * Constructor
-     */
-    constructor() {
-        super();
-
-        // Initialize the Socket.IO client to connect to the same domain and protocol
-        const socketUrl = window.location.origin; 
-
-        this.socket = io(socketUrl);
-
-        // Listen for a custom event from the backend
-        this.socket.on('autocore://broadcast_event', (ev: any) => {
-            let objPayload = JSON.parse(ev.payload);
-
-            if (objPayload.topic !== undefined && objPayload.topic !== null ) {
-                
-                if ( objPayload.payload !== undefined && objPayload.payload !== null ) {
-                    this.publish(objPayload.topic, objPayload.payload);
-                }
-                else {
-                    this.publish(objPayload.topic, undefined);
-                }
-                                
-            }
-        });
-
-    }
-
-    /**
-     * Invoke a method in the Socket.IO backend and wait for acknowledgment.
-     * 
-     * @param fname method name
-     * @param payload Optional data payload
-     * @param timeout Timeout in milliseconds after which the promise is rejected if no response is received.
-     * @returns A Promise that resolves to the response from the backend or rejects if a timeout occurs.
-     */
-    invoke(fname: string, payload?: object, timeout: number = 5000): Promise<object> {
-        return new Promise((resolve, reject) => {
-            // Flag to track if the response was received
-            let responseReceived = false;
-
-            this.socket.emit(fname, payload, (response: object) => {
-                responseReceived = true;
-                resolve(response);
-            });
-
-            // Set a timeout to reject the promise if no response is received
-            setTimeout(() => {
-                if (!responseReceived) {
-                    reject(new Error(`Timeout: No response received within ${timeout} ms`));
-                }
-            }, timeout);
-        });
-    }
-
-    /**
-     * Disconnects the Socket.IO client.
-     */
-    disconnect(): void {
-        this.socket.disconnect();
-    }
-
-
-    /**
-     * Emit an event to the Socket.IO server.
-     * The intention is that the invoke method is used instead.
-     * 
-     * @param eventName Name of the event to emit
-     * @param payload Optional data payload
-     */
-    protected emit(eventName: string, payload?: object): void {
-        this.socket.emit(eventName, payload);
-    }
-
-}
-
-export default HubSocketIo;