@adcops/autocore-react 3.0.40 → 3.3.2

package/src/core/IndicatorButtonState.ts

@@ -2,7 +2,7 @@
  * Copyright (C) 2024 Automated Design Corp.. All Rights Reserved.
  * Created Date: 2024-03-12 11:08:29
  * -----
- * Last Modified: 2024-03-12 11:08:41
+ * Last Modified: 2026-01-29 09:32:28
  * -----
  * 
  */

package/src/core/ValueSimulator.ts

@@ -3,13 +3,13 @@
  * Created Date: 2024-01-18 12:49:58
  * Author: Thomas C. Bitsky Jr.
  * -----
- * Last Modified: 2024-03-08 09:33:45
+ * Last Modified: 2025-09-05 14:50:12
  * Modified By: ADC
  * -----
  * 
  */
 
-import { EmitterDispatchFunction } from "./EventEmitterContext";
+import type { EmitterDispatchFunction } from "./EventEmitterContext";
 
 
 /**

package/src/core/hoc.tsx

@@ -2,7 +2,7 @@
  * Copyright (C) 2024 Automated Design Corp. All Rights Reserved.
  * Created Date: 2024-01-18 16:14:20
   * -----
- * Last Modified: 2024-03-08 09:27:12
+ * Last Modified: 2026-01-29 09:32:17
  * Modified By: ADC
  * -----
  */

package/src/hooks/adsHooks.tsx

@@ -2,7 +2,7 @@
  * Copyright (C) 2024 Automated Design Corp.. All Rights Reserved.
  * Created Date: 2024-04-26 09:04:40
  * -----
- * Last Modified: 2024-05-17 10:47:22
+ * Last Modified: 2026-01-29 09:33:22
  * -----
  * 
  */
@@ -11,6 +11,7 @@
 
 import { useContext, useRef, useEffect, useCallback } from 'react';
 import { EventEmitterContext } from '../core/EventEmitterContext';
+import { MessageType } from '../hub/CommandMessage';
 
 
 /**
@@ -70,8 +71,8 @@ export const useAdsRegisterSymbols = (
         const registerAndSubscribe = async () => {
             for (const [key, symbolName] of Object.entries(symbols)) {
                 try {
-                    const invokeOptions = options[key] ? { symbol_name: symbolName, options : options[key] } : { symbol_name: symbolName };
-                    await invoke("ADS", "register_symbol", invokeOptions);
+                    const invokeOptions = options[key] ? { symbol_name: symbolName, options: options[key] } : { symbol_name: symbolName };
+                    await invoke("ADS.register_symbol", MessageType.Request, invokeOptions);
 
                     //console.log(`Subscribe... ADS/${symbolName}`);
                     const subscriptionId = subscribe(`ADS/${symbolName}`, (data) => {
@@ -87,7 +88,7 @@ export const useAdsRegisterSymbols = (
                     console.error(`Failed to register symbol ${symbolName}: ${err}`);
                 }
             }
-            await invoke("ADS", "refresh", {});
+            await invoke("ADS.refresh", MessageType.Request, {});
         };
         
         if (!isConnected() ) {
@@ -152,14 +153,13 @@ export const useAdsRegisterSymbols = (
  * };
  */
 export function useAdsWriteValue(symbolName: string) {
-    const { invoke } = useContext(EventEmitterContext);
-    const domain = "ADS";
-    const fname = "write_value";
+    const { write } = useContext(EventEmitterContext);
 
     // Return a function that takes a value and sends it to the backend
-    return async (value: object | boolean | number | string ) => {
+    return async (value: object | boolean | number | string) => {
         try {
-            await invoke(domain, fname, { symbol_name: symbolName, value });
+            // Use FQDN topic: ADS.symbolName
+            await write(`ADS.${symbolName}`, value);
         } catch (err) {
             console.error(`Error writing tag ${symbolName}: ${err}`);
         }
@@ -220,23 +220,22 @@ export function useAdsWriteValue(symbolName: string) {
  * dynamically if needed, for instance, based on user selection or other external configurations.
  */
 export function useAdsWriteScaledValue(symbolName: string, scale: number, offset: number) {
-    const { invoke } = useContext(EventEmitterContext);
-    const domain = "ADS";
-    const fname = "write_value";
-    
+    const { write } = useContext(EventEmitterContext);
+
     return useCallback(async (value: number) => {
 
-        // In autocore-react, we multiple to scale incoming values,
+        // In autocore-react, we multiply to scale incoming values,
         // divide to scale outgoing values.
         // This is an OUTGOING value, so we divide.
 
-        const scaledValue = (value - offset) / scale; 
+        const scaledValue = (value - offset) / scale;
         try {
-            await invoke(domain, fname, { symbol_name: symbolName, value: scaledValue });
+            // Use FQDN topic: ADS.symbolName
+            await write(`ADS.${symbolName}`, scaledValue);
         } catch (err) {
             console.error(`Error writing scaled value to tag ${symbolName}: ${err}`);
         }
-    }, [symbolName, scale, offset, invoke]);
+    }, [symbolName, scale, offset, write]);
 }
 
 
@@ -271,15 +270,15 @@ export function useAdsWriteScaledValue(symbolName: string, scale: number, offset
  * ```
  */
 export function useAdsTapValue(symbolName: string): () => Promise<void> {
-    const { invoke } = useContext(EventEmitterContext);
-    const domain = "ADS";
-    const fname = "write_value";
+    const { write } = useContext(EventEmitterContext);
 
     return async () => {
         try {
-            await invoke(domain, fname, { symbol_name: symbolName, value: true });
+            // Use FQDN topic: ADS.symbolName
+            const topic = `ADS.${symbolName}`;
+            await write(topic, true);
             await sleep(300); // Sleep for 300ms before writing false
-            await invoke(domain, fname, { symbol_name: symbolName, value: false });
+            await write(topic, false);
         } catch (err) {
             console.error(`Error handling tap action for ${symbolName}: ${err}`);
         }

package/src/hooks/commandHooks.tsx

@@ -2,7 +2,7 @@
  * Copyright (C) 2025 Automated Design Corp. All Rights Reserved.
  * Created Date: 2025-03-31 06:38:50
  * -----
- * Last Modified: 2025-04-28 10:37:20
+ * Last Modified: 2026-01-29 09:33:28
  * -----
  * 
  */
@@ -14,6 +14,7 @@
 
 import { useContext, useRef, useEffect, useCallback } from 'react';
 import { EventEmitterContext } from '../core/EventEmitterContext';
+import { MessageType } from '../hub/CommandMessage';
 
 
 /**
@@ -90,9 +91,8 @@ export const useRegisterSymbols = (
                     subscriptions.current.push(subscriptionId);
 
                     // Refresh on a topic is the same as a read_value, except the response is broadcasted.
-                    // Because there currently isn't a centralized tag system, the topic name should not
-                    // contain the domain name.
-                    await invoke(domain, "refresh", {'topic' : `${symbolName}`});
+                    // Use FQDN topic: domain.symbolName
+                    await invoke(`${domain}.${symbolName}`, MessageType.Request, { action: "refresh" });
 
                 } catch (err) {
                     console.error(`Failed to register symbol ${symbolName}: ${err}`);
@@ -165,13 +165,14 @@ export const useRegisterSymbols = (
  *   );
  * };
  */
-export function useWriteValue(domain : string, symbolName: string, fname : string = "write_value") {
-    const { invoke } = useContext(EventEmitterContext);
+export function useWriteValue(domain: string, symbolName: string) {
+    const { write } = useContext(EventEmitterContext);
 
     // Return a function that takes a value and sends it to the backend
-    return async (value: object | boolean | number | string ) => {
+    return async (value: object | boolean | number | string) => {
         try {
-            await invoke(domain, fname, { "topic" : symbolName, "value" : value });
+            // Use FQDN topic: domain.symbolName
+            await write(`${domain}.${symbolName}`, value);
         } catch (err) {
             console.error(`Error writing tag ${symbolName}: ${err}`);
         }
@@ -231,22 +232,23 @@ export function useWriteValue(domain : string, symbolName: string, fname : strin
  * converts it to millimeters using the current `scale`, and writes the result to a backend symbol. The `scale` and `offset` can be adjusted
  * dynamically if needed, for instance, based on user selection or other external configurations.
  */
-export function useWriteScaledValue(domain : string, symbolName: string, scale: number, offset: number, fname : string = "write_value") {
-    const { invoke } = useContext(EventEmitterContext);
-    
+export function useWriteScaledValue(domain: string, symbolName: string, scale: number, offset: number) {
+    const { write } = useContext(EventEmitterContext);
+
     return useCallback(async (value: number) => {
 
-        // In autocore-react, we multiple to scale incoming values,
+        // In autocore-react, we multiply to scale incoming values,
         // divide to scale outgoing values.
         // This is an OUTGOING value, so we divide.
 
-        const scaledValue = (value - offset) / scale; 
+        const scaledValue = (value - offset) / scale;
         try {
-            await invoke(domain, fname, { symbol_name: symbolName, value: scaledValue });
+            // Use FQDN topic: domain.symbolName
+            await write(`${domain}.${symbolName}`, scaledValue);
         } catch (err) {
             console.error(`Error writing scaled value to tag ${symbolName}: ${err}`);
         }
-    }, [symbolName, scale, offset, invoke]);
+    }, [domain, symbolName, scale, offset, write]);
 }
 
 
@@ -280,14 +282,16 @@ export function useWriteScaledValue(domain : string, symbolName: string, scale:
  * };
  * ```
  */
-export function useTapValue(domain : string, symbolName: string, fname : string = "write_value"): () => Promise<void> {
-    const { invoke } = useContext(EventEmitterContext);
+export function useTapValue(domain: string, symbolName: string): () => Promise<void> {
+    const { write } = useContext(EventEmitterContext);
 
     return async () => {
         try {
-            await invoke(domain, fname, { symbol_name: symbolName, value: true });
+            // Use FQDN topic: domain.symbolName
+            const topic = `${domain}.${symbolName}`;
+            await write(topic, true);
             await sleep(300); // Sleep for 300ms before writing false
-            await invoke(domain, fname, { symbol_name: symbolName, value: false });
+            await write(topic, false);
         } catch (err) {
             console.error(`Error handling tap action for ${symbolName}: ${err}`);
         }

package/src/hooks/index.ts

@@ -2,7 +2,7 @@
  * Copyright (C) 2024 Automated Design Corp.. All Rights Reserved.
  * Created Date: 2024-04-30 12:14:43
  * -----
- * Last Modified: 2024-04-30 12:15:46
+ * Last Modified: 2026-01-29 09:33:34
  * -----
  * 
  */

package/src/hooks/useAutoCoreTag.ts

@@ -0,0 +1,103 @@
+/*
+ * Copyright (C) 2025 Automated Design Corp.. All Rights Reserved.
+ * Created Date: 2025-09-05 08:03:32
+ * -----
+ * Last Modified: 2026-01-29 09:33:40
+ * -----
+ *
+ */
+
+/**
+ * @module hooks/useAutoCoreTag.ts
+ *
+ * Factory for generating strongly-typed React hooks to consume AutoCoreTagContext.
+ */
+
+import { useCallback, useContext, useMemo } from "react";
+import type { BaseContextValue, TagConfig, TagValueMap } from "../core/AutoCoreTagTypes";
+
+export function makeAutoCoreTagHooks<Spec extends readonly TagConfig[]>(
+  Context: React.Context<BaseContextValue<TagValueMap<Spec>>>,
+  tags: Spec
+) {
+  type VMap = TagValueMap<Spec>;
+  type TagNames = keyof VMap & string;
+
+  const findCfg = (tagName: string) =>
+    tags.find(t => t.fqdn === tagName) as (Spec[number] | undefined);
+
+  /**
+   * Access a single tag by name.
+   * Returns current value, raw value, direct server writer, and tap helper.
+   */
+  const useAutoCoreTag = <K extends TagNames>(tagName: K) => {
+    const { values, rawValues, isLoading, write: ctxWrite, tap: ctxTap } = useContext(Context);
+
+    const cfg = findCfg(tagName as string);
+    if (!cfg) throw new Error(`useAutoCoreTag: unknown tagName '${String(tagName)}'`);
+
+    const write = useCallback(
+      (displayValue: VMap[K]) => ctxWrite(tagName, displayValue),
+      [ctxWrite, tagName]
+    );
+
+    const tap = useCallback(() => ctxTap?.(tagName), [ctxTap, tagName]);
+
+    return {
+      value: values[tagName] as VMap[K],
+      rawValue: rawValues[tagName as string],
+      write,
+      tap,
+      isLoading,
+    } as const;
+  };
+
+  /**
+   * Access multiple tags at once with a bulk writer.
+   */
+  const useAutoCoreTags = <K extends TagNames>(tagNames: readonly K[]) => {
+    const { values, rawValues, isLoading, write: ctxWrite } = useContext(Context);
+
+    const subset = useMemo(
+      () =>
+        Object.fromEntries(
+          tagNames.map(k => [k, values[k] as VMap[K]])
+        ) as { [P in K]: VMap[P] },
+      [values, tagNames]
+    );
+
+    const rawSubset = useMemo(
+      () =>
+        Object.fromEntries(
+          tagNames.map(k => [k, rawValues[k as string]])
+        ) as { [P in K]: unknown },
+      [rawValues, tagNames]
+    );
+
+    const write = useCallback(async (tagName: K, value: VMap[K]) => {
+      await ctxWrite(tagName, value);
+    }, [ctxWrite]);
+
+    return { values: subset, rawValues: rawSubset, write, isLoading } as const;
+  };
+
+  /**
+   * Compute a derived value from the full tag state.
+   */
+  const useAutoCoreSelect = <R>(selector: (all: Readonly<Partial<VMap>>) => R, deps: any[] = []) => {
+    const { values, isLoading } = useContext(Context);
+    const selected = useMemo(() => selector(values), [values, ...deps]);
+    return { selected, isLoading } as const;
+  };
+
+  /**
+   * Access scale configurations and update functions.
+   */
+  const useScales = () => {
+    const { scales, updateScale } = useContext(Context);
+    const getScale = useCallback((scaleName: string) => scales[scaleName], [scales]);
+    return { scales, updateScale, getScale } as const;
+  };
+
+  return { useAutoCoreTag, useAutoCoreTags, useAutoCoreSelect, useScales } as const;
+}

package/src/hooks/useScaledValue.tsx

@@ -2,7 +2,7 @@
  * Copyright (C) 2024 Automated Design Corp.. All Rights Reserved.
  * Created Date: 2024-04-30 11:41:59
  * -----
- * Last Modified: 2024-05-21 19:58:23
+ * Last Modified: 2026-01-29 09:33:46
  * -----
  * 
  */

package/src/hub/CommandMessage.ts

@@ -2,36 +2,88 @@
  * 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
+ * Last Modified: 2026-01-29 09:33:54
  * -----
  * 
  */
 
 
+// Replaced by a flattened CommandMessage
+// /// 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;
+// }
 
-/// 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;
+
+export enum MessageType {
+    /// Invalid or no operation. Used for keepalive/ping.
+    NoOp = 0,
+
+    /// Response to a previous request.
+    Response = 1,
+
+    /// Read request - module should return data for the specified topic.
+    Read = 2,
+
+    /// Write request - module should store the provided data.
+    Write = 3,
+
+    /// Subscribe to updates on a topic.
+    Subscribe = 4,
+
+    /// Unsubscribe from a topic.
+    Unsubscribe = 5,
+
+    /// Broadcast message (unsolicited push from module to server or vice versa).
+    Broadcast = 6,
+
+    /// Heartbeat/keepalive message.
+    Heartbeat = 7,
+
+    /// Control message (initialize, finalize, configuration).
+    Control = 8,
+
+    /// Generic request - module parses topic to determine action.
+    Request = 10,
 }
 
+
+
 /// 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;
+    transaction_id: number; 
+
+    /// Timestamp in milliseconds since UNIX epoch.
+    /// Set automatically on message creation.
+    timecode: number,
+
+
+    /// Fully-qualified topic name (FQDN).
+    /// Format: "domain.subtopic.path" e.g., "ads.plc1.GM.stData"
+    topic: string;
+
+    /// The type/purpose of this message.
+    message_type: MessageType,
+
+    /// The payload data.
+    /// - For requests: arguments/parameters
+    /// - For responses: result data
+    data?: any; 
+
+
+    /// Whether the operation was successful (for responses).    
+    success: boolean,
+
+    /// Error message if the operation failed (for responses).
+    error_message: string,
+
 }