@adcops/autocore-react 3.0.34 → 3.0.36

package/dist/hub/HubBase.js

@@ -1,310 +1 @@
-/*
- * Copyright (C) 2023 Automated Design Corp. All Rights Reserved.
- * Created Date: 2023-12-15 14:21:33
- * Author: Thomas C. Bitsky Jr.
- * -----
- * Last Modified: 2025-03-31 08:35:09
- * Modified By: ADC
- * -----
- *
- */
-/**
- * Base class for the interface for the IPC to the backend,
- * which may be websockets, MQTT, the Tauri API,
- * or something else.
- *
- * The EventEmitterContext should generate the hub automatically.
- *
- * # Usage
- * The hub can be used to publish and subscribe to
- * topics in the front-end, regardless of being connected to any backend.
- *
- * ```
- * 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
- *      });
- * }
- *
- * ```
- * The hub should also be used for invoking events in the backend.
- * This example will call the function "update_count" in the backend, passing
- * the expected argument "count". Details of the interaction between the Hub and
- * the backend will be handled by the appropriate HubBase sub-class, and should
- * be transparent to the front end.
- *
- * ```
- * const {invoke} = useContext(EventEmitterContext);
- * const incrementCount = () => {
- *    count += 1;
- *    invoke('update_count', {"count": count});
- * };
- *
- * Subscribing to a topic is simple. The type of value received is specific
- * to the topic.
- *
- * Example: Listen to an event 'xarm-position':
- * ```
- * const {subscribe, unsubscribe} = useContext(EventEmitterContext);
- * useEffect(() => {
- *         const unsubscripeMp = subscribe('xarm-position', (value) => {
- *            // The publisher 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);
- *    }
- *
- * }, [] );
- *
- * ```
- *
- */
-export class HubBase {
-    /**
-     * Constructor
-     */
-    constructor() {
-        Object.defineProperty(this, "localTopicToBackendTopicMap", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: new Map()
-        });
-        Object.defineProperty(this, "backendTopicToLocalMap", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: new Map()
-        });
-        Object.defineProperty(this, "localFNameToBackendFNameMap", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: new Map()
-        });
-        Object.defineProperty(this, "backendFNameToLocalFNameMap", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: new Map()
-        });
-        Object.defineProperty(this, "context", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: null
-        });
-        Object.defineProperty(this, "isConnected_", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: false
-        });
-        /**
-         * Allos the derived class to set whether the hub is connected to its source.
-         * @param s boolean
-         */
-        Object.defineProperty(this, "setIsConnected", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: (s) => {
-                this.isConnected_ = s;
-            }
-        });
-        /**
-         * Returns true if the Hub is connected to its source.
-         */
-        Object.defineProperty(this, "isConnected", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: () => {
-                return this.isConnected_;
-            }
-        });
-    }
-    /**
-     * Set the EventEmitterContext for this instance of the Hub. The EventEmitterContext
-     * should handle this as part of the initialization sequence. Because React can
-     * sometimes make (and destroy) multiple copies of the EventEmitterContext, it's important
-     * that the context be stored in the instance this way so that the HubBase can properly target
-     * right context.
-     *
-     * If this context is not sent, no events will be emitted from the backend to the front end,
-     * and global events in the interface may not work.
-     *
-     */
-    setContext(context) {
-        this.context = context;
-    }
-    /**
-     * 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(domain, fname, topic, value) {
-        const msg = {
-            topic: topic,
-            data: value
-        };
-        return this.invoke(domain, fname, msg);
-    }
-    /**
-     * Pubish a topic throughout the web app using the
-     * Global EventEmitterContext. This will broadcast within the local frontend.
-     * This does NOT get relayed to the backend.
-     */
-    publish(topic, data) {
-        const convertedTopic = this.toLocalTopic(topic);
-        console.log(`HUB Dispatch topic ${convertedTopic} payload ${JSON.stringify(data)}`);
-        this.context?.dispatch({
-            topic: convertedTopic,
-            payload: data
-        });
-    }
-    /**
-     * Map a local topic to a topic in the backend.
-     * @param localTopic string
-     * @param backendTopic string
-     */
-    mapTopic(localTopic, backendTopic) {
-        this.localTopicToBackendTopicMap.set(localTopic, backendTopic);
-        this.backendTopicToLocalMap.set(backendTopic, localTopic);
-    }
-    /**
-     * Unmap a local topic.
-     * @param localTopic string
-     */
-    unmapTopic(localTopic) {
-        if (this.localTopicToBackendTopicMap.has(localTopic)) {
-            const be = this.localTopicToBackendTopicMap.get(localTopic);
-            this.localTopicToBackendTopicMap.delete(localTopic);
-            if (be !== null && be !== undefined && this.backendTopicToLocalMap.has(be)) {
-                this.backendTopicToLocalMap.delete(be);
-            }
-        }
-    }
-    /**
-     * Map a local function name, as would be sent to the invoke method, to a
-     * function name in the backend.
-     * @param localFName string
-     * @param backendFName string
-     */
-    mapFName(localFName, backendFName) {
-        this.localFNameToBackendFNameMap.set(localFName, backendFName);
-        this.backendFNameToLocalFNameMap.set(backendFName, localFName);
-    }
-    /**
-     * Unmap a local function name.
-     * @param localFName string
-     */
-    unmapFName(localFName) {
-        if (this.localFNameToBackendFNameMap.has(localFName)) {
-            const be = this.localFNameToBackendFNameMap.get(localFName);
-            this.localFNameToBackendFNameMap.delete(localFName);
-            if (be !== null && be !== undefined && this.backendFNameToLocalFNameMap.has(be)) {
-                this.backendFNameToLocalFNameMap.delete(be);
-            }
-        }
-    }
-    /**
-     * Convert a local topic to a backend topic. If a mapping isn't
-     * registered, the local topic is returned.
-     * @param localTopic local topic name
-     * @returns string
-     */
-    toBackendTopic(localTopic) {
-        if (this.localTopicToBackendTopicMap.has(localTopic)) {
-            const ret = this.localTopicToBackendTopicMap.get(localTopic);
-            if (ret !== null && ret !== undefined)
-                return ret;
-            else
-                return localTopic;
-        }
-        else {
-            return localTopic;
-        }
-    }
-    /**
-     * Convert a local function name to a backend function name. If a mapping isn't
-     * registered, the local FName is returned.
-     * @param localTopic local function name
-     * @returns string
-     */
-    toBackendFName(localFName) {
-        if (this.localFNameToBackendFNameMap.has(localFName)) {
-            const ret = this.localFNameToBackendFNameMap.get(localFName);
-            if (ret !== null && ret !== undefined)
-                return ret;
-            else
-                return localFName;
-        }
-        else {
-            return localFName;
-        }
-    }
-    /**
-     * Convert a backend topic to a local topic. If a mapping isn't
-     * registered, the backend topic is returned.
-     * @param backendTopic backend topic name
-     * @returns string
-     */
-    toLocalTopic(backendTopic) {
-        if (this.backendTopicToLocalMap.has(backendTopic)) {
-            const ret = this.backendTopicToLocalMap.get(backendTopic);
-            if (ret !== null && ret !== undefined)
-                return ret;
-            else
-                return backendTopic;
-        }
-        else {
-            return backendTopic;
-        }
-    }
-    /**
-     * Convert a backend function name to a local function name. If a mapping isn't
-     * registered, the backend function name is returned.
-     * @param backendTopic backend function name
-     * @returns string
-     */
-    toLocalFName(backendTopic) {
-        if (this.backendFNameToLocalFNameMap.has(backendTopic)) {
-            const ret = this.backendFNameToLocalFNameMap.get(backendTopic);
-            if (ret !== null && ret !== undefined)
-                return ret;
-            else
-                return backendTopic;
-        }
-        else {
-            return backendTopic;
-        }
-    }
-}
-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}),Object.defineProperty(this,"isConnected_",{enumerable:!0,configurable:!0,writable:!0,value:!1}),Object.defineProperty(this,"setIsConnected",{enumerable:!0,configurable:!0,writable:!0,value:e=>{this.isConnected_=e}}),Object.defineProperty(this,"isConnected",{enumerable:!0,configurable:!0,writable:!0,value:()=>this.isConnected_})}setContext(e){this.context=e}invokeTopic(e,a,o,c){const t={topic:o,data:c};return this.invoke(e,a,t)}publish(e,a){const o=this.toLocalTopic(e);this.context?.dispatch({topic:o,payload:a})}mapTopic(e,a){this.localTopicToBackendTopicMap.set(e,a),this.backendTopicToLocalMap.set(a,e)}unmapTopic(e){if(this.localTopicToBackendTopicMap.has(e)){const a=this.localTopicToBackendTopicMap.get(e);this.localTopicToBackendTopicMap.delete(e),null!=a&&this.backendTopicToLocalMap.has(a)&&this.backendTopicToLocalMap.delete(a)}}mapFName(e,a){this.localFNameToBackendFNameMap.set(e,a),this.backendFNameToLocalFNameMap.set(a,e)}unmapFName(e){if(this.localFNameToBackendFNameMap.has(e)){const a=this.localFNameToBackendFNameMap.get(e);this.localFNameToBackendFNameMap.delete(e),null!=a&&this.backendFNameToLocalFNameMap.has(a)&&this.backendFNameToLocalFNameMap.delete(a)}}toBackendTopic(e){if(this.localTopicToBackendTopicMap.has(e)){const a=this.localTopicToBackendTopicMap.get(e);return null!=a?a:e}return e}toBackendFName(e){if(this.localFNameToBackendFNameMap.has(e)){const a=this.localFNameToBackendFNameMap.get(e);return null!=a?a:e}return e}toLocalTopic(e){if(this.backendTopicToLocalMap.has(e)){const a=this.backendTopicToLocalMap.get(e);return null!=a?a:e}return e}toLocalFName(e){if(this.backendFNameToLocalFNameMap.has(e)){const a=this.backendFNameToLocalFNameMap.get(e);return null!=a?a:e}return e}}export default HubBase;

package/dist/hub/HubSimulate.js

@@ -1,46 +1 @@
-/*
- * Copyright (C) 2023 Automated Design Corp. All Rights Reserved.
- * Created Date: 2023-12-17 10:38:21
- * -----
- * Last Modified: 2024-04-24 11:56:26
- * Modified By: ADC
- * -----
- *
- */
-import { HubBase } from './HubBase';
-/**
- * Hub for simulating functionality when no backend is present.
- */
-export class HubSimulate extends HubBase {
-    /**
-     * Constructor
-     */
-    constructor() {
-        super();
-    }
-    /**
-     * 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(domain, fname, payload, timeout = 20) {
-        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(() => {
-                let ret = {
-                    data: payload,
-                    error_message: "",
-                    success: true
-                };
-                resolve(ret);
-            }, timeout);
-        });
-    }
-}
-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.js

@@ -1,130 +1 @@
-/*
- * Copyright (C) 2023 Automated Design Corp. All Rights Reserved.
- * Created Date: 2023-12-17 09:50:23
- * Author: Thomas C. Bitsky Jr.
- * -----
- * Last Modified: 2024-04-24 11:56:32
- * Modified By: ADC
- * -----
- *
- */
-import { HubBase } from './HubBase';
-import { event, invoke } from '@tauri-apps/api';
-/**
- * Hub for integrating with the Tauri backend.
- *
- * The tauri backend 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 HubTauri extends HubBase {
-    /**
-     * Constructor
-     */
-    constructor() {
-        super();
-        /**
-         * Receive broadcasts from the Tauri backend. Data is received as a payload object,
-         * {topic: string, payload: any | null}
-         * From here, we extract into a form HubBase can use, then pass on to the
-         * dispatcher.
-         *
-         * Events without a topic are ignored.
-         */
-        event.listen('autocore://broadcast_event', (ev) => {
-            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 rust backend.
-     *
-     * @param fname method name
-     * @param payload Optional data payload
-     * @returns The return value of the backend method.
-     */
-    invoke(domain, fname, payload) {
-        console.log(JSON.stringify(event));
-        if (payload !== undefined && payload !== null) {
-            console.log(`Payload: ${JSON.stringify(payload)}`);
-            // 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);
-        }
-        else {
-            return invoke(fname);
-        }
-    }
-}
+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)}}