powerpagestoolkit 2.8.2 → 2.8.105

package/dist/src/core/API.d.ts

@@ -1,6 +1,7 @@
 /// <reference path="../globals.d.ts" />
-interface ODataJSON extends object {
-    [key: `${string}@odata.bind` | string]: any;
+interface ODataJSON {
+    [key: `${string}@odata.bind`]: string;
+    [key: string]: string;
 }
 /**
  * Provides abstract class `API` that allows basic create, read, and update operations in DataVerse via the PowerPages API

package/dist/src/core/DOMNodeReference.d.ts

@@ -4,12 +4,11 @@ export default class DOMNodeReference {
     target: Element | string;
     logicalName?: string;
     root: Element;
-    protected timeoutMs: number;
+    protected [s.debounceTime]: number;
     protected isLoaded: boolean;
     protected defaultDisplay: string;
     protected [s.observers]: Array<MutationObserver | ResizeObserver>;
     protected [s.boundEventListeners]: Array<BoundEventListener>;
-    protected dependents: Dependants;
     protected isRadio: boolean;
     protected radioType: RadioType | null;
     /**
@@ -44,7 +43,7 @@ export default class DOMNodeReference {
      * @param root - Optionally specify the element within to search for the element targeted by 'target'
      * Defaults to 'document.body'
      */
-    /******/ /******/ constructor(target: Element | string, root: Element | undefined, timeoutMs: number);
+    /******/ /******/ constructor(target: Element | string, root: Element | undefined, debounceTime: number);
     private extractLogicalName;
     [s.init](): Promise<void>;
     /**
@@ -72,7 +71,6 @@ export default class DOMNodeReference {
      * @public
      */
     updateValue(e?: Event): void;
-    protected triggerDependentsHandlers(): Promise<void>;
     protected validateValue(value: any): any;
     /**
      * Sets up an event listener based on the specified event type, executing the specified
@@ -151,7 +149,7 @@ export default class DOMNodeReference {
     after(...elements: HTMLElement[]): DOMNodeReference;
     /**
      * Retrieves the label associated with the HTML element.
-     * @returns The label element associated with this element.
+     * @returns {HTMLElement} The label element associated with this element.
      */
     getLabel(): HTMLElement | null;
     /**
@@ -170,7 +168,7 @@ export default class DOMNodeReference {
     addTooltip(innerHTML: string, containerStyle?: Partial<CSSStyleDeclaration>): DOMNodeReference;
     /**
      * Sets the inner HTML content of the HTML element.
-     * @param string - The text to set as the inner HTML of the element.
+     * @param {string} string - The text to set as the inner HTML of the element.
      * @returns - Instance of this [provides option to method chain]
      */
     setInnerHTML(string: string): this;
@@ -193,21 +191,24 @@ export default class DOMNodeReference {
      * Applies a business rule to manage visibility, required state, value, and disabled state dynamically.
      * @see {@link BusinessRule}
      * @param rule The business rule containing conditions for various actions.
-     * @param dependencies For re-evaluation of conditions when the state of the dependencies change
+     * @param dependencies For re-evaluation conditions when the state of the dependencies change
      * @returns Instance of this for method chaining.
      */
     applyBusinessRule(rule: BusinessRule, dependencies: DOMNodeReference[]): DOMNodeReference;
-    protected createValidator(evaluationFunction: () => boolean): HTMLSpanElement;
     /**
      * Sets up tracking for dependencies using both event listeners and mutation observers.
      * @protected
      * @param handler The function to execute when dependencies change
      * @param dependencies Array of dependent DOM nodes to track
+     * @param options Additional configuration options. clearValuesOnHide defaults to false.
      * all other options defaults to true
      */
-    protected _configDependencyTracking(handler: DependencyHandlerFunction, dependencies: Array<DOMNodeReference>): void;
-    protected getVisibility(): boolean;
-    protected receiveNotification(): void;
+    protected _configDependencyTracking(handler: () => void, dependencies: Array<DOMNodeReference>, options?: {
+        clearValuesOnHide?: boolean;
+        observeVisibility?: boolean;
+        trackInputEvents?: boolean;
+        trackRadioButtons?: boolean;
+    }): void;
     /**
      * Sets the required level for the field by adding or removing the "required-field" class on the label.
      *

package/dist/src/globals.d.ts

@@ -70,47 +70,41 @@ declare interface Form extends Partial<SystemForm> {
   formxml: string;
 }
 
-declare type IsValid = (
-  this: DOMNodeReference,
-  isRequired: ReturnType<Condition>
-) => boolean;
-
 declare interface BusinessRule {
   /**
    * @param condition A function that returns a boolean to determine
    * the visibility of the target element. If `condition()` returns true, the element is shown;
    * otherwise, it is hidden.
    
+   * @param clearValuesOnHide Should the values in the targeted field be cleared when hidden? Defaults to true
    */
-  setVisibility?: (this: DOMNodeReference) => boolean;
+  setVisibility?: [
+    condition: (this: DOMNodeReference) => boolean,
+    clearValuesOnHide?: boolean
+  ];
   /**
-   * Configuration function for determining the required level, and field validity of the given fields
-   * @param isRequired - Function determining if field is required
-   * @param isRequired.this - Reference to this DOMNodeReference
-   * @param isValid - Function validating field input.
-   * @param isValid.this - Reference to this DOMNodeReference
-   * @param isValid.isRequiredResult - Only available if 'isRequired' is also returned from the configuration function
+   * @param isRequired Function determining if field is required
+   * @param isValid Function validating field input.
    */
-  setRequirements?: () => {
-    isRequired?: (this: DOMNodeReference) => boolean;
-    isValid?: (this: DOMNodeReference, isRequiredResult?: boolean) => boolean;
-  };
-
+  setRequired?: [
+    isRequired: () => boolean,
+    isValid: (this: DOMNodeReference, isRequired: boolean) => boolean
+  ];
   /**
    * @param condition A function to determine if the value provided should be applied to this field
    * @param value The value to set for the HTML element.
    * for parents of boolean radios, pass true or false as value, or
    * an expression returning a boolean
    */
-  setValue?: () => {
-    condition: (this: DOMNodeReference) => boolean;
-    value: (() => any) | any;
-  };
+  setValue?: [
+    condition: (this: DOMNodeReference) => boolean,
+    value: (() => any) | any
+  ];
   /**
    * @param condition A function to determine if this field
    * should be enabled in a form, or disabled. True || 1 = disabled. False || 0 = enabled
    */
-  setDisabled?: (this: DOMNodeReference) => boolean;
+  setDisabled?: () => boolean;
 }
 
 declare interface CreationOptions {
@@ -134,16 +128,6 @@ declare interface CreationOptions {
   timeoutMs?: number;
 }
 
-declare type DependencyHandlerFunction = () => Promise<void>;
-
-declare type Dependants = Map<DOMNodeReference, DependencyHandlerFunction>;
-
-declare type ValueElement =
-  | HTMLInputElement
-  | HTMLSelectElement
-  | HTMLTextAreaElement
-  | HTMLOptionElement;
-
 declare const Page_Validators: any[];
 
 declare interface ElementValue {