@adcops/autocore-react 3.3.9 → 3.3.14

package/src/hooks/useAutoCoreTag.ts

@@ -1,103 +1,103 @@
-/*
- * Copyright (C) 2025 Automated Design Corp.. All Rights Reserved.
- * Created Date: 2025-09-05 08:03:32
- * -----
- * Last Modified: 2026-03-05 06:27:56
- * -----
- *
- */
-
-/**
- * @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.tagName === 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;
-}
+/*
+ * Copyright (C) 2025 Automated Design Corp.. All Rights Reserved.
+ * Created Date: 2025-09-05 08:03:32
+ * -----
+ * Last Modified: 2026-03-05 06:27:56
+ * -----
+ *
+ */
+
+/**
+ * @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.tagName === 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

@@ -1,100 +1,100 @@
-/*
- * Copyright (C) 2024 Automated Design Corp.. All Rights Reserved.
- * Created Date: 2024-04-30 11:41:59
- * -----
- * Last Modified: 2026-01-29 09:33:46
- * -----
- * 
- */
-
-
-
-import { useCallback, useState, useEffect } from 'react';
-
-/**
- * Multiple millimeters by this constant for inches.
- */
-export const kMillimeters2Inches: number = 1 / 25.4;
-
-/**
- * Multiply netwons by this constant for pounds.
- */
-export const kNewtons2Pounds : number = 1 / 4.4482216153;
-
-
-type UseScaledValueReturn = [number, (newValue: number) => void];
-
-/**
- * A custom React hook for converting values between different scales,
- * with support for dynamically updating the scale and offset. This hook manages values
- * in a base unit and allows for easy conversion to a display unit, updating
- * reactively to changes in the conversion factors.
- *
- * @param initialValue - The initial value in the base unit.
- * @param scale - The dynamic scale factor used for conversion to the display unit.
- * @param offset - An optional offset applied after scaling (default is 0).
- * @returns A tuple containing the display value and a setter function for updating
- * the value in the display unit.
- *
- * @example
- * Here's how to use `useScaledValue` in a component that fetches a scale factor from a backend
- * and allows the user to input values in a converted scale, which are then handled in a base unit:
- *
- * ```tsx
- * import React, { useState, useEffect } from 'react';
- * import { useScaledValue } from './hooks/useScaledValue';
- *
- * const MeasurementInput: React.FC = () => {
- *   const [units, setUnits] = useState<number>(1); // Start with a default scale of 1
- *   const [xPosition, setXPosition] = useScaledValue(0, units);
- *
- *   useEffect(() => {
- *     async function fetchScale() {
- *       try {
- *         // Simulate fetching scale factor from a backend
- *         const res = await invoke("GNV", "read_value", { group: "ux", key: "kSelectedUnits" });
- *         setUnits(res.data); // Update scale based on backend response
- *       } catch (error) {
- *         console.error('Failed to fetch units', error);
- *       }
- *     }
- *     fetchScale();
- *   }, []);
- *
- *   return (
- *     <input
- *       type="number"
- *       value={xPosition.toFixed(2)} // Display the value formatted to 2 decimal places
- *       onChange={(e) => setXPosition(parseFloat(e.target.value))}
- *     />
- *   );
- * };
- *
- * export default MeasurementInput;
- * ```
- *
- * In this example, `useScaledValue` is used to manage a measurement input in a dynamic unit system.
- * The component fetches the conversion scale from the backend upon component mounting and updates the
- * input display accordingly. The user's input is converted back to the base unit before being processed.
- */
-export function useScaledValue(initialValue: number, scale: number, offset: number = 0): UseScaledValueReturn {
-    const [baseValue, setBaseValue] = useState<number>(initialValue);
-    const [displayValue, setDisplayValue] = useState<number>(() => (initialValue * scale) + offset);
-
-    // Update display value whenever baseValue, scale, or offset changes
-    useEffect(() => {
-
-        // In autocore-react, we multiple to scale incoming values,
-        // divide to scale outgoing values.
-        // This is an INCOMING value, so we multiply.
-
-        setDisplayValue((baseValue * scale) + offset);
-    }, [baseValue, scale, offset]);
-
-    // Function to update baseValue when displayValue changes
-    const handleSetDisplayValue = useCallback((newValue: number) => {
-        setBaseValue(newValue);
-    }, [scale, offset]);
-
-    return [displayValue, handleSetDisplayValue];
+/*
+ * Copyright (C) 2024 Automated Design Corp.. All Rights Reserved.
+ * Created Date: 2024-04-30 11:41:59
+ * -----
+ * Last Modified: 2026-01-29 09:33:46
+ * -----
+ * 
+ */
+
+
+
+import { useCallback, useState, useEffect } from 'react';
+
+/**
+ * Multiple millimeters by this constant for inches.
+ */
+export const kMillimeters2Inches: number = 1 / 25.4;
+
+/**
+ * Multiply netwons by this constant for pounds.
+ */
+export const kNewtons2Pounds : number = 1 / 4.4482216153;
+
+
+type UseScaledValueReturn = [number, (newValue: number) => void];
+
+/**
+ * A custom React hook for converting values between different scales,
+ * with support for dynamically updating the scale and offset. This hook manages values
+ * in a base unit and allows for easy conversion to a display unit, updating
+ * reactively to changes in the conversion factors.
+ *
+ * @param initialValue - The initial value in the base unit.
+ * @param scale - The dynamic scale factor used for conversion to the display unit.
+ * @param offset - An optional offset applied after scaling (default is 0).
+ * @returns A tuple containing the display value and a setter function for updating
+ * the value in the display unit.
+ *
+ * @example
+ * Here's how to use `useScaledValue` in a component that fetches a scale factor from a backend
+ * and allows the user to input values in a converted scale, which are then handled in a base unit:
+ *
+ * ```tsx
+ * import React, { useState, useEffect } from 'react';
+ * import { useScaledValue } from './hooks/useScaledValue';
+ *
+ * const MeasurementInput: React.FC = () => {
+ *   const [units, setUnits] = useState<number>(1); // Start with a default scale of 1
+ *   const [xPosition, setXPosition] = useScaledValue(0, units);
+ *
+ *   useEffect(() => {
+ *     async function fetchScale() {
+ *       try {
+ *         // Simulate fetching scale factor from a backend
+ *         const res = await invoke("GNV", "read_value", { group: "ux", key: "kSelectedUnits" });
+ *         setUnits(res.data); // Update scale based on backend response
+ *       } catch (error) {
+ *         console.error('Failed to fetch units', error);
+ *       }
+ *     }
+ *     fetchScale();
+ *   }, []);
+ *
+ *   return (
+ *     <input
+ *       type="number"
+ *       value={xPosition.toFixed(2)} // Display the value formatted to 2 decimal places
+ *       onChange={(e) => setXPosition(parseFloat(e.target.value))}
+ *     />
+ *   );
+ * };
+ *
+ * export default MeasurementInput;
+ * ```
+ *
+ * In this example, `useScaledValue` is used to manage a measurement input in a dynamic unit system.
+ * The component fetches the conversion scale from the backend upon component mounting and updates the
+ * input display accordingly. The user's input is converted back to the base unit before being processed.
+ */
+export function useScaledValue(initialValue: number, scale: number, offset: number = 0): UseScaledValueReturn {
+    const [baseValue, setBaseValue] = useState<number>(initialValue);
+    const [displayValue, setDisplayValue] = useState<number>(() => (initialValue * scale) + offset);
+
+    // Update display value whenever baseValue, scale, or offset changes
+    useEffect(() => {
+
+        // In autocore-react, we multiple to scale incoming values,
+        // divide to scale outgoing values.
+        // This is an INCOMING value, so we multiply.
+
+        setDisplayValue((baseValue * scale) + offset);
+    }, [baseValue, scale, offset]);
+
+    // Function to update baseValue when displayValue changes
+    const handleSetDisplayValue = useCallback((newValue: number) => {
+        setBaseValue(newValue);
+    }, [scale, offset]);
+
+    return [displayValue, handleSetDisplayValue];
 }

package/src/hub/CommandMessage.ts

@@ -1,89 +1,89 @@
-/*
- * Copyright (C) 2024 Automated Design Corp.. All Rights Reserved.
- * Created Date: 2024-04-24 11:47:13
- * -----
- * 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;
-// }
-
-
-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.
-    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,
-
-}
+/*
+ * Copyright (C) 2024 Automated Design Corp.. All Rights Reserved.
+ * Created Date: 2024-04-24 11:47:13
+ * -----
+ * 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;
+// }
+
+
+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.
+    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,
+
+}