@adcops/autocore-react 3.0.12 → 3.0.14

package/dist/core/EventEmitterContext.d.ts

@@ -1,5 +1,6 @@
 import React, { ReactNode } from 'react';
 import { Hub } from "../hub";
+import { CommandMessageResult } from "../hub/CommandMessage";
 export { Hub };
 /**
  * Represents an event subsription.
@@ -76,7 +77,7 @@ export interface EventEmitterContextType {
      * Invoke/send a message to the back end.
      * This does NOT get published to the front end.
      */
-    invoke(domain: string, fname: string, payload?: object): Promise<object>;
+    invoke(domain: string, fname: string, payload?: object): Promise<CommandMessageResult>;
     /**
      * 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,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})};
+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({data:{},success:!1,error_message:""}),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,7 +99,7 @@ export declare abstract class HubBase {
      * Invoke/send a message to the back end.
      * This does NOT get published to the front end.
      */
-    abstract invoke(domain: string, 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
@@ -108,7 +109,7 @@ export declare abstract class HubBase {
      * @param topic string Topic
      * @param value any data payload
      */
-    invokeTopic(domain: string, 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/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(domain: string, 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,r=20){return new Promise(((e,t)=>{setTimeout((()=>{e({data:u})}),r)}))}}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(domain: string, fname: string, payload?: object | undefined): Promise<object>;
+    invoke(domain: string, fname: string, payload?: object | undefined): Promise<CommandMessageResult>;
 }

package/dist/hub/HubWebSocket.d.ts

@@ -12,26 +12,14 @@
  * topic will be: "ADS/GM.fReal"
  */
 import { HubBase } from './HubBase';
-interface CommandMessageResult {
-    data: any;
-    success: boolean;
-    error_message: string;
-}
-interface CommandMessage {
-    request_id: number;
-    domain: string;
-    fname: string;
-    args?: any;
-    result?: CommandMessageResult;
-}
+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<object>;
+    invoke: (domain: string, fname: string, payload?: object) => Promise<CommandMessageResult>;
     handleUnsolicitedMessage: (msg: CommandMessage) => void;
     disconnect: () => void;
     protected emit: (eventName: string, payload?: object) => void;
 }
-export {};

package/dist/hub/HubWebSocket.js

@@ -1 +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,n)=>{const r=++this.requestId;this.pendingRequests.set(r,{resolve:i,reject:n});let o={request_id:r,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):s(new Error(t.result?.error_message)),this.pendingRequests.delete(t.request_id)}else this.handleUnsolicitedMessage(t)},this.socket.onerror=e=>{},this.socket.onclose=()=>{}}}
+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

@@ -2,6 +2,7 @@ import { HubBase as Hub } from './HubBase';
 import { HubTauri } from './HubTauri';
 import { HubWebSocket } from "./HubWebSocket";
 import { HubSimulate } from "./HubSimulate";
+import { CommandMessage, CommandMessageResult } from './CommandMessage';
 /**
  * Creates a connection to the backend.
  * @returns Hub
@@ -11,3 +12,4 @@ export { HubBase as Hub } from './HubBase';
 export { HubTauri };
 export { HubWebSocket };
 export { HubSimulate };
+export type { CommandMessage, CommandMessageResult };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@adcops/autocore-react",
-    "version": "3.0.12",
+    "version": "3.0.14",
     "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-04-23 11:53:43
+ * Last Modified: 2024-04-24 12:11:16
  * Modified By: ADC
  * -----
  * 
@@ -11,6 +11,7 @@
 
 import React, { createContext, ReactNode, useState, useMemo } from 'react';
 import {createHub, Hub} from "../hub";
+import {CommandMessageResult} from "../hub/CommandMessage";
 
 export {Hub};
 
@@ -103,7 +104,7 @@ export interface EventEmitterContextType {
      * Invoke/send a message to the back end. 
      * This does NOT get published to the front end.
      */
-    invoke( domain: string, fname: string, payload? : object) : Promise<object>;
+    invoke( domain: string, fname: string, payload? : object) : Promise<CommandMessageResult>;
 
     /**
      * Subscribe to events identified by the topic.
@@ -268,9 +269,14 @@ export const EventEmitterContext = createContext<EventEmitterContextType>({
         domain;
         fname;
         payload;
+        let ret :CommandMessageResult = {
+            data: {},
+            success: false,
+            error_message : ""            
+        };
         // Placeholder for invoke logic
         // Implement the logic to send a message to the backend and return a promise
-        return Promise.resolve({}); // Example placeholder, replace with actual implementation
+        return Promise.resolve(ret); // Example placeholder, replace with actual implementation
     },
     unsubscribe: (subscriptionId: number) => { subscriptionId;}, // Placeholder for unsubscription logic    
     hub: null,

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-04-23 11:19:03
+ * Last Modified: 2024-04-24 11:56:16
  * Modified By: ADC
  * -----
  * 
  */
 
 import { EventEmitterContextType} from '../core/EventEmitterContext';
-
+import {CommandMessageResult} from "./CommandMessage";
 
 
 /**
@@ -122,7 +122,7 @@ export abstract class HubBase {
      * Invoke/send a message to the back end. 
      * This does NOT get published to the front end.
      */
-    abstract invoke(domain: string, fname: string, payload? : object) : Promise<object>;
+    abstract invoke(domain: string, fname: string, payload? : object) : Promise<CommandMessageResult>;
 
 
     /**
@@ -134,7 +134,7 @@ export abstract class HubBase {
      * @param topic string Topic 
      * @param value any data payload
      */
-    invokeTopic( domain: string, 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

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-04-23 11:23:27
+ * 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,14 +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(domain : string, 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-04-23 11:21:45
+ * 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,7 +128,7 @@ export class HubTauri extends HubBase {
      * @param payload Optional data payload
      * @returns The return value of the backend method.
      */
-    invoke(domain : string, fname: string, payload?: object | undefined): Promise<object> {
+    invoke(domain : string, fname: string, payload?: object | undefined): Promise<CommandMessageResult> {
 
         console.log(JSON.stringify(event));
 

package/src/hub/HubWebSocket.ts

@@ -2,7 +2,7 @@
  * Copyright (C) 2024 Automated Design Corp.. All Rights Reserved.
  * Created Date: 2024-04-17 09:13:07
  * -----
- * Last Modified: 2024-04-23 18:48:23
+ * Last Modified: 2024-04-24 11:56:51
  * -----
  * 
  */
@@ -22,33 +22,7 @@
  */
 
 import { HubBase } from './HubBase';
-
-/// The result portion of a CommandMessage. The server will
-/// place the result of a command in this portion of the message.
-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. 
-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;
-}
+import {CommandMessage, CommandMessageResult} from "./CommandMessage";
 
 // Function to parse the JSON string received from the server into a CommandMessage object
 // function parseCommandMessage(jsonString: string): CommandMessage {
@@ -95,7 +69,7 @@ export class HubWebSocket extends HubBase {
                 if (!data.result?.success) {
                     reject(new Error(data.result?.error_message));
                 } else {
-                    resolve(data);
+                    resolve(data.result);
                 }
                 this.pendingRequests.delete(data.request_id);
             } else {
@@ -112,7 +86,7 @@ export class HubWebSocket extends HubBase {
         };
     }
 
-    invoke = (domain : string, fname: string, payload?: object): Promise<object> => {
+    invoke = (domain : string, fname: string, payload?: object): Promise<CommandMessageResult> => {
 
         return new Promise((resolve, reject) => {
             const id = ++this.requestId; // Increment and use the request ID

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-04-23 14:54:08
+ * Last Modified: 2024-04-24 11:52:21
  * Modified By: ADC
  * -----
  * 
@@ -12,6 +12,7 @@ import { HubBase as Hub } from './HubBase';
 import { HubTauri } from './HubTauri';
 import { HubWebSocket } from "./HubWebSocket";
 import {HubSimulate} from "./HubSimulate"
+import { CommandMessage, CommandMessageResult } from './CommandMessage';
 
 /**
  * Creates a connection to the backend.
@@ -19,8 +20,6 @@ import {HubSimulate} from "./HubSimulate"
  */
 export function createHub(): Hub {
 
-    console.log("HELLOW THERRE!!!");
-
     if (window.__TAURI__ !== undefined && window.__TAURI__ !== null) {
         // Standalone Tauri application
         console.log("HUB: Starting link to Tauri backend.");
@@ -53,3 +52,4 @@ export {HubBase as Hub} from './HubBase';
 export {HubTauri}
 export {HubWebSocket}
 export {HubSimulate}
+export type {CommandMessage, CommandMessageResult}