@adcops/autocore-react 3.3.9 → 3.3.10

package/src/core/IndicatorButtonState.ts

@@ -1,34 +1,34 @@
-/*
- * Copyright (C) 2024 Automated Design Corp.. All Rights Reserved.
- * Created Date: 2024-03-12 11:08:29
- * -----
- * Last Modified: 2026-01-29 09:32:28
- * -----
- * 
- */
-
-
-/**
- * Common state for the indicator buttons, toggles or similar components.
- */
-export interface IndicatorButtonState {
-    /**
-     * Current value/state of the button based on the subscribed topic.
-     */
-    currentValue?: boolean | number | string;
-
-    /**
-     * Indicates whether the button is disabled.
-     */
-    isDisabled?: boolean;
-
-    /**
-     * Indicates whether the button is invisible.
-     */
-    isInvisible?: boolean;
-
-    /**
-     * The button is in the "down" state.
-     */
-    isPressed : boolean;
-}
+/*
+ * Copyright (C) 2024 Automated Design Corp.. All Rights Reserved.
+ * Created Date: 2024-03-12 11:08:29
+ * -----
+ * Last Modified: 2026-01-29 09:32:28
+ * -----
+ * 
+ */
+
+
+/**
+ * Common state for the indicator buttons, toggles or similar components.
+ */
+export interface IndicatorButtonState {
+    /**
+     * Current value/state of the button based on the subscribed topic.
+     */
+    currentValue?: boolean | number | string;
+
+    /**
+     * Indicates whether the button is disabled.
+     */
+    isDisabled?: boolean;
+
+    /**
+     * Indicates whether the button is invisible.
+     */
+    isInvisible?: boolean;
+
+    /**
+     * The button is in the "down" state.
+     */
+    isPressed : boolean;
+}

package/src/core/IndicatorColor.ts

@@ -1,36 +1,36 @@
-/*
- * Copyright (C) 2024 Automated Design Corp. All Rights Reserved.
- * Created Date: 2024-01-21 11:45:09
- * -----
- * Last Modified: 2024-03-08 07:16:47
- * Modified By: ADC
- * -----
- * 
- */
-
-/**
- * Standardized indicator colors and their meanings. It's probably
- * best to use their meaning and not the actual color name.
- */
-export enum IndicatorColor {
-    /** Green: On, Ok, Ready, Home, General Use */
-    IndicatorGreen = "green",
-    /** Alias for the ON condition to make meaning clear. Preferred for ON case. */
-    IndicatorOn = IndicatorGreen,
-    /** Off. ONLY USE THIS FOR OFF. */
-    IndicatorOff = "gray",
-    /** Red: Error, Fault, Stop, Stopped. Use sparingly. */
-    IndicatorRed = "red",
-    /** Orange: Warning, Out of position, moving, out of range. */
-    IndicatorOrange = "orange",
-    /** Alias for Red to make meaning clear. Preferred. */
-    IndicatorError  = IndicatorRed,
-    /** Alias for Orange to make meaning clear. Preferred. */
-    IndicatorWarning = IndicatorOrange,
-    /** Invalid. If an indicator is black, the interface does not know the current value. */
-    IndicatorInvalid = "black",
-    /** Use for navigation buttons. No other meaning allowed. */
-    IndicatorNavigation = "cyan",
-    /** Use for informational buttons. No other meaning allowed. */
-    IndicatorInfo = "blue"
+/*
+ * Copyright (C) 2024 Automated Design Corp. All Rights Reserved.
+ * Created Date: 2024-01-21 11:45:09
+ * -----
+ * Last Modified: 2024-03-08 07:16:47
+ * Modified By: ADC
+ * -----
+ * 
+ */
+
+/**
+ * Standardized indicator colors and their meanings. It's probably
+ * best to use their meaning and not the actual color name.
+ */
+export enum IndicatorColor {
+    /** Green: On, Ok, Ready, Home, General Use */
+    IndicatorGreen = "green",
+    /** Alias for the ON condition to make meaning clear. Preferred for ON case. */
+    IndicatorOn = IndicatorGreen,
+    /** Off. ONLY USE THIS FOR OFF. */
+    IndicatorOff = "gray",
+    /** Red: Error, Fault, Stop, Stopped. Use sparingly. */
+    IndicatorRed = "red",
+    /** Orange: Warning, Out of position, moving, out of range. */
+    IndicatorOrange = "orange",
+    /** Alias for Red to make meaning clear. Preferred. */
+    IndicatorError  = IndicatorRed,
+    /** Alias for Orange to make meaning clear. Preferred. */
+    IndicatorWarning = IndicatorOrange,
+    /** Invalid. If an indicator is black, the interface does not know the current value. */
+    IndicatorInvalid = "black",
+    /** Use for navigation buttons. No other meaning allowed. */
+    IndicatorNavigation = "cyan",
+    /** Use for informational buttons. No other meaning allowed. */
+    IndicatorInfo = "blue"
 }

package/src/core/MaskPatterns.ts

@@ -1,88 +1,88 @@
-/*
- * (C) Copyright 2021 Automated Design Corp. All Rights Reserved.
- * File Created: Thursday, 1st April 2021 12:30:41 pm
- * Author: Thomas C. Bitsky Jr. Automated Design Corp.
- */
-
-/**
- * @fileoverview
- * Provides a collection of pre-defined patterns for masking/validating different types of user input or data string. 
- * These patterns come up so regularly in our work that it seemed best to standardize and centralize their definition.
- * 
- * These patterns can be used to ensure that user inputs conform to expected formats, such as real numbers (with or without
- * decimal points), positive real numbers, integers, and positive integers. Utilizing these patterns simplifies the process
- * of validating and filtering input in forms or any other user input scenarios.
- *
- * The patterns are defined as regular expressions and are encapsulated within the `InputPatterns` constant for easy access.
- * They can be used directly with input validation functions or in conjunction with form validation libraries to enforce
- * input constraints.
- */
-
-/**
- * Regular expressions Common input patterns for matching different input or expected data types.
- */
-export const RegExMaskPatterns = {
-    /**
-     * Regular expression pattern for matching real numbers.
-     * This pattern matches any real number, including negative and positive numbers with or without a decimal point.
-     * Examples of valid inputs: "123", "-123", "123.456", "-123.456", ".456", "-.456"
-     */    
-    RealNumber: /^-?\d*(\.)?(\d+)?$/,
-    /**
-     * Regular expression pattern for matching positive real numbers.
-     * This pattern matches any positive real number with or without a decimal point, excluding negative numbers.
-     * Examples of valid inputs: "123", "123.456", ".456"
-     */    
-    RealNumberPositive: /^\d*(\.)?(\d+)?$/,
-    /**
-     * Regular expression pattern for matching integers.
-     * This pattern matches any integer, including negative and positive integers without a decimal point.
-     * Examples of valid inputs: "123", "-123"
-     */    
-    Integer: /^-?\d*$/,
-    /**
-     * Regular expression pattern for matching positive integers.
-     * This pattern matches any positive integer without a decimal point, excluding negative numbers.
-     * Examples of valid inputs: "123"
-     */    
-    IntegerPositive: /^\d+$/,
-
-
-    /**
-     * Regular expression for matching IPV4 address.
-     */
-    Ipv4: /^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$/,
-} as const;
-
-
-
-/**
- * Patterns for use with PrimeReact.InputMask components
- */
-export const PrimeReactMaskPatterns = {
-    /** USA Social Security Number */
-    SocialSecurityNumber: "999-99-9999",
-    /** USA phone number with optional extension */
-    PhoneNumberUS: "(999) 999-9999? x99999",
-    /** International phone number with optional extension */
-    PhoneNumberInternational: "+999 999 999 9999? x99999",
-    /** International phone number with optional extension */
-    PhoneNumberJapan: "+81 9999 999 9999? x99999",
-    /** International phone number with optional extension */
-    PhoneNumberChina: "+86 999 999 9999? x99999",
-    /** International phone number with optional extension */
-    PhoneNumberVietnam: "+84 999 999 9999? x99999",
-    /** International phone number with optional extension */
-    PhoneNumberSouthKorea: "+82 99 9999 9999 x99999",
-    /** International phone number with optional extension */
-    PhoneNumberCanada: "+1 (999) 999-9999 x99999",
-    /** International phone number with optional extension */
-    PhoneNumberMexico: "+52 999 999 9999 x99999",    
-    /** International phone number with optional extension */
-    PhoneNumberScotland: "+44 9999 999999 x99999",        
-    /** International phone number with optional extension */
-    PhoneNumberEngland: "+44 9999 999999 x99999",        
-    /** International phone number with optional extension */
-    PhoneNumberIreland: "+353 99 999 9999 x99999",        
-
+/*
+ * (C) Copyright 2021 Automated Design Corp. All Rights Reserved.
+ * File Created: Thursday, 1st April 2021 12:30:41 pm
+ * Author: Thomas C. Bitsky Jr. Automated Design Corp.
+ */
+
+/**
+ * @fileoverview
+ * Provides a collection of pre-defined patterns for masking/validating different types of user input or data string. 
+ * These patterns come up so regularly in our work that it seemed best to standardize and centralize their definition.
+ * 
+ * These patterns can be used to ensure that user inputs conform to expected formats, such as real numbers (with or without
+ * decimal points), positive real numbers, integers, and positive integers. Utilizing these patterns simplifies the process
+ * of validating and filtering input in forms or any other user input scenarios.
+ *
+ * The patterns are defined as regular expressions and are encapsulated within the `InputPatterns` constant for easy access.
+ * They can be used directly with input validation functions or in conjunction with form validation libraries to enforce
+ * input constraints.
+ */
+
+/**
+ * Regular expressions Common input patterns for matching different input or expected data types.
+ */
+export const RegExMaskPatterns = {
+    /**
+     * Regular expression pattern for matching real numbers.
+     * This pattern matches any real number, including negative and positive numbers with or without a decimal point.
+     * Examples of valid inputs: "123", "-123", "123.456", "-123.456", ".456", "-.456"
+     */    
+    RealNumber: /^-?\d*(\.)?(\d+)?$/,
+    /**
+     * Regular expression pattern for matching positive real numbers.
+     * This pattern matches any positive real number with or without a decimal point, excluding negative numbers.
+     * Examples of valid inputs: "123", "123.456", ".456"
+     */    
+    RealNumberPositive: /^\d*(\.)?(\d+)?$/,
+    /**
+     * Regular expression pattern for matching integers.
+     * This pattern matches any integer, including negative and positive integers without a decimal point.
+     * Examples of valid inputs: "123", "-123"
+     */    
+    Integer: /^-?\d*$/,
+    /**
+     * Regular expression pattern for matching positive integers.
+     * This pattern matches any positive integer without a decimal point, excluding negative numbers.
+     * Examples of valid inputs: "123"
+     */    
+    IntegerPositive: /^\d+$/,
+
+
+    /**
+     * Regular expression for matching IPV4 address.
+     */
+    Ipv4: /^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$/,
+} as const;
+
+
+
+/**
+ * Patterns for use with PrimeReact.InputMask components
+ */
+export const PrimeReactMaskPatterns = {
+    /** USA Social Security Number */
+    SocialSecurityNumber: "999-99-9999",
+    /** USA phone number with optional extension */
+    PhoneNumberUS: "(999) 999-9999? x99999",
+    /** International phone number with optional extension */
+    PhoneNumberInternational: "+999 999 999 9999? x99999",
+    /** International phone number with optional extension */
+    PhoneNumberJapan: "+81 9999 999 9999? x99999",
+    /** International phone number with optional extension */
+    PhoneNumberChina: "+86 999 999 9999? x99999",
+    /** International phone number with optional extension */
+    PhoneNumberVietnam: "+84 999 999 9999? x99999",
+    /** International phone number with optional extension */
+    PhoneNumberSouthKorea: "+82 99 9999 9999 x99999",
+    /** International phone number with optional extension */
+    PhoneNumberCanada: "+1 (999) 999-9999 x99999",
+    /** International phone number with optional extension */
+    PhoneNumberMexico: "+52 999 999 9999 x99999",    
+    /** International phone number with optional extension */
+    PhoneNumberScotland: "+44 9999 999999 x99999",        
+    /** International phone number with optional extension */
+    PhoneNumberEngland: "+44 9999 999999 x99999",        
+    /** International phone number with optional extension */
+    PhoneNumberIreland: "+353 99 999 9999 x99999",        
+
 } as const;

package/src/core/NumerableTypes.ts

@@ -1,81 +1,81 @@
-/*
- * Copyright (C) 2024 Automated Design Corp. All Rights Reserved.
- * Created Date: 2024-01-16 14:19:17
- * -----
- * Last Modified: 2024-03-08 07:55:25
- * Modified By: ADC
- * -----
- * 
- */
-
-/**
- * @fileoverview
- * 
- * These types enhance TypeScript support for the `numerable` library, which does not directly
- * export the `NumerableFormatNumberOptions` type. By extracting and refining the type definitions
- * for the `format` function's parameters, including handling its overloaded signatures, this file
- * makes it easier to use `numerable` in TypeScript and React projects.
- * 
- * The process involves creating a type that captures the overloads of the `format` function and
- * then mapping over these overloads to extract their parameters. This technique enables the
- * extraction of the specific options type `NumerableFormatNumberOptions` used by the `format`
- * function, thereby providing type safety and IntelliSense support in TypeScript environments.
- * 
- * The approach used here is based on a solution for handling function overloads in TypeScript,
- * as discussed in a StackOverflow answer: https://stackoverflow.com/a/59538756/10049787.
- */
-
-import { format } from 'numerable';
-
-/**
- * Type helper to capture the overload signatures of a function.
- * This utility type takes a function with multiple overloads and maps them to a tuple of
- * functions, each representing one of the overloads.
- */
-type NumerableFormatOverloads<T> = T extends {
-  (...args: infer A1): infer R1;
-  (...args: infer A2): infer R2;
-  (...args: infer A3): infer R3;
-}
-  ? [(...args: A1) => R1, (...args: A2) => R2, (...args: A3) => R3]
-  : T extends {
-      (...args: infer A1): infer R1;
-      (...args: infer A2): infer R2;
-    }
-  ? [(...args: A1) => R1, (...args: A2) => R2]
-  : T extends {
-      (...args: infer A1): infer R1;
-    }
-  ? [(...args: A1) => R1]
-  : any; // eslint-disable-line @typescript-eslint/no-explicit-any
-
-/**
- * Extracts parameters from a tuple of function types.
- * This utility type maps over a tuple of functions (representing overloads) to produce a tuple
- * of their respective parameter types.
- */
-type OverloadedParameters<T> = NumerableFormatOverloads<T> extends infer O
-  ? // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    { [K in keyof O]: Parameters<Extract<O[K], (...args: any) => any>> }
-  : never;
-
-/**
- * Type representing the parameters of the `numerable.format` function, taking into account its
- * overloaded signatures.
- */  
-type NumerableFormatParams = OverloadedParameters<typeof format>;
-
-
-/**
- * Type specifically for the options parameter of the `numerable.format` function.
- * This extracts the type of the third parameter (options) from the first overload of `format`,
- * as this is where the formatting options are specified.
- */
-type NumerableFormatNumberOptions = NumerableFormatParams[0][2];
-
-/**
- * Exported type for external use, providing a non-nullable version of the formatting options.
- * This type is intended for use wherever `numerable.format` options are needed, enhancing
- * code readability and type safety.
- */
+/*
+ * Copyright (C) 2024 Automated Design Corp. All Rights Reserved.
+ * Created Date: 2024-01-16 14:19:17
+ * -----
+ * Last Modified: 2024-03-08 07:55:25
+ * Modified By: ADC
+ * -----
+ * 
+ */
+
+/**
+ * @fileoverview
+ * 
+ * These types enhance TypeScript support for the `numerable` library, which does not directly
+ * export the `NumerableFormatNumberOptions` type. By extracting and refining the type definitions
+ * for the `format` function's parameters, including handling its overloaded signatures, this file
+ * makes it easier to use `numerable` in TypeScript and React projects.
+ * 
+ * The process involves creating a type that captures the overloads of the `format` function and
+ * then mapping over these overloads to extract their parameters. This technique enables the
+ * extraction of the specific options type `NumerableFormatNumberOptions` used by the `format`
+ * function, thereby providing type safety and IntelliSense support in TypeScript environments.
+ * 
+ * The approach used here is based on a solution for handling function overloads in TypeScript,
+ * as discussed in a StackOverflow answer: https://stackoverflow.com/a/59538756/10049787.
+ */
+
+import { format } from 'numerable';
+
+/**
+ * Type helper to capture the overload signatures of a function.
+ * This utility type takes a function with multiple overloads and maps them to a tuple of
+ * functions, each representing one of the overloads.
+ */
+type NumerableFormatOverloads<T> = T extends {
+  (...args: infer A1): infer R1;
+  (...args: infer A2): infer R2;
+  (...args: infer A3): infer R3;
+}
+  ? [(...args: A1) => R1, (...args: A2) => R2, (...args: A3) => R3]
+  : T extends {
+      (...args: infer A1): infer R1;
+      (...args: infer A2): infer R2;
+    }
+  ? [(...args: A1) => R1, (...args: A2) => R2]
+  : T extends {
+      (...args: infer A1): infer R1;
+    }
+  ? [(...args: A1) => R1]
+  : any; // eslint-disable-line @typescript-eslint/no-explicit-any
+
+/**
+ * Extracts parameters from a tuple of function types.
+ * This utility type maps over a tuple of functions (representing overloads) to produce a tuple
+ * of their respective parameter types.
+ */
+type OverloadedParameters<T> = NumerableFormatOverloads<T> extends infer O
+  ? // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    { [K in keyof O]: Parameters<Extract<O[K], (...args: any) => any>> }
+  : never;
+
+/**
+ * Type representing the parameters of the `numerable.format` function, taking into account its
+ * overloaded signatures.
+ */  
+type NumerableFormatParams = OverloadedParameters<typeof format>;
+
+
+/**
+ * Type specifically for the options parameter of the `numerable.format` function.
+ * This extracts the type of the third parameter (options) from the first overload of `format`,
+ * as this is where the formatting options are specified.
+ */
+type NumerableFormatNumberOptions = NumerableFormatParams[0][2];
+
+/**
+ * Exported type for external use, providing a non-nullable version of the formatting options.
+ * This type is intended for use wherever `numerable.format` options are needed, enhancing
+ * code readability and type safety.
+ */
 export type NumerableFormatOptions = NonNullable<NumerableFormatNumberOptions>;

package/src/core/PositionContext.ts

@@ -1,60 +1,60 @@
-/*
- * Copyright (C) 2024 Automated Design Corp. All Rights Reserved.
- * Created Date: 2024-01-16 14:19:52
-  * -----
- * Last Modified: 2024-03-08 07:48:18
- * Modified By: ADC
- * -----
- * 
- */
-
-
-
-import { createContext } from 'react';
-
-
-/**
- * Interface representing the position and scale context of a component within its parent container.
- * 
- * This context is designed to provide components with necessary scaling and positioning
- * information, such as for rendering elements correctly in absolute positioning or for
- * adjusting layout based on dynamic offsets.
- */
-export interface IPositionContext {
-
-  /**
-   * Represents the scale factor applied to the dimensions of elements.
-   * A scale of 1 indicates no scaling, while values greater or less than 1
-   * indicate zoomed-in or zoomed-out states respectively.
-   */    
-  scale: number;
-  /**
-   * Represents the horizontal offset that should be applied to the position
-   * of elements. This can be used to adjust element positioning in response to
-   * dynamic layout changes or to align elements within a scaled environment.
-   */  
-  xOffset: number;
-  /**
-   * Represents the vertical offset that should be applied to the position
-   * of elements. Similar to `xOffset`, this is used for vertical alignment and
-   * positioning adjustments in a dynamic or scaled layout.
-   */  
-  yOffset: number;
-}
-
-
-/**
- * Creates a React context for position and scaling information of a component using absolute positioning.
- * This context provides a standardized way to access and react to changes in scale and positioning offsets,
- * enabling components to adjust their layout and rendering behavior dynamically.
- *
- * The default context values are set to assume no scaling (`scale: 1`) and no offsets (`xOffset: 0, yOffset: 0`),
- * which corresponds to the initial state in many applications before any dynamic adjustments are made.
- */
-export const DimensionsContext = createContext<IPositionContext>({
-  scale: 1, /** Default scaling factor indicating no scaling. */
-  xOffset: 0, /** Default horizontal offset indicating no shift. */
-  yOffset: 0, /** Default vertical offset indicating no shift. */
-});
-
+/*
+ * Copyright (C) 2024 Automated Design Corp. All Rights Reserved.
+ * Created Date: 2024-01-16 14:19:52
+  * -----
+ * Last Modified: 2024-03-08 07:48:18
+ * Modified By: ADC
+ * -----
+ * 
+ */
+
+
+
+import { createContext } from 'react';
+
+
+/**
+ * Interface representing the position and scale context of a component within its parent container.
+ * 
+ * This context is designed to provide components with necessary scaling and positioning
+ * information, such as for rendering elements correctly in absolute positioning or for
+ * adjusting layout based on dynamic offsets.
+ */
+export interface IPositionContext {
+
+  /**
+   * Represents the scale factor applied to the dimensions of elements.
+   * A scale of 1 indicates no scaling, while values greater or less than 1
+   * indicate zoomed-in or zoomed-out states respectively.
+   */    
+  scale: number;
+  /**
+   * Represents the horizontal offset that should be applied to the position
+   * of elements. This can be used to adjust element positioning in response to
+   * dynamic layout changes or to align elements within a scaled environment.
+   */  
+  xOffset: number;
+  /**
+   * Represents the vertical offset that should be applied to the position
+   * of elements. Similar to `xOffset`, this is used for vertical alignment and
+   * positioning adjustments in a dynamic or scaled layout.
+   */  
+  yOffset: number;
+}
+
+
+/**
+ * Creates a React context for position and scaling information of a component using absolute positioning.
+ * This context provides a standardized way to access and react to changes in scale and positioning offsets,
+ * enabling components to adjust their layout and rendering behavior dynamically.
+ *
+ * The default context values are set to assume no scaling (`scale: 1`) and no offsets (`xOffset: 0, yOffset: 0`),
+ * which corresponds to the initial state in many applications before any dynamic adjustments are made.
+ */
+export const DimensionsContext = createContext<IPositionContext>({
+  scale: 1, /** Default scaling factor indicating no scaling. */
+  xOffset: 0, /** Default horizontal offset indicating no shift. */
+  yOffset: 0, /** Default vertical offset indicating no shift. */
+});
+
 export default DimensionsContext;