@adcops/autocore-react 3.0.8 → 3.0.12

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-23 14:54:08
  * Modified By: ADC
  * -----
  * 
@@ -10,7 +10,7 @@
 
 import { HubBase as Hub } from './HubBase';
 import { HubTauri } from './HubTauri';
-import { HubSocketIo } from "./HubSocketIo";
+import { HubWebSocket } from "./HubWebSocket";
 import {HubSimulate} from "./HubSimulate"
 
 /**
@@ -18,17 +18,31 @@ import {HubSimulate} from "./HubSimulate"
  * @returns Hub 
  */
 export function createHub(): Hub {
-    if (window.__TAURI__) {
+
+    console.log("HELLOW THERRE!!!");
+
+    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 +51,5 @@ export function createHub(): Hub {
 // application.
 export {HubBase as Hub} from './HubBase';
 export {HubTauri}
-export {HubSocketIo}
+export {HubWebSocket}
 export {HubSimulate}

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;