powerpagestoolkit 1.0.14 → 1.0.21

package/index.d.ts

@@ -1,36 +1,147 @@
 declare module "powerpagestoolkit" {
+  /**
+   * Class representing a reference to a DOM node.
+   */
   class DOMNodeReference {
+    /**
+     * Creates an instance of DOMNodeReference.
+     * @param {string} querySelector - The CSS selector to find the desired DOM element.
+     */
     constructor(querySelector: string);
+
     element: HTMLElement | null;
     isLoaded: boolean;
 
+    /**
+     * Initializes the DOMNodeReference instance by waiting for the element to be available in the DOM.
+     * @returns {Promise<Proxy>} A promise that resolves to a Proxy of the DOMNodeReference instance.
+     * @throws {Error} Throws an error if the element cannot be found using the provided query selector.
+     */
     init(): Promise<this>;
 
+    /**
+     * Hides the element by setting its display style to "none".
+     */
     hide(): void;
+
+    /**
+     * Shows the element by restoring its default display style.
+     */
     show(): void;
+
+    /**
+     * Hides the parent element by setting its display style to "none".
+     */
     hideParent(): void;
+
+    /**
+     * Shows the parent element by restoring its default display style.
+     */
     showParent(): void;
+
+    /**
+     * Hides the container (grandparent of the element) by setting its display style to "none".
+     */
     hideContainer(): void;
+
+    /**
+     * Shows the container (grandparent of the element) by restoring its default display style.
+     */
     showContainer(): void;
+
+    /**
+     * Sets the value of the HTML element.
+     * @param {string} value - The value to set for the HTML element.
+     */
     setValue(value: string): void;
+
+    /**
+     * Gets the value of the HTML element.
+     * @returns {string} The current value of the HTML element.
+     */
     getValue(): string;
+
+    /**
+     * Appends child elements to the HTML element.
+     * @param {...HTMLElement} elements - The elements to append to the HTML element.
+     */
     append(...elements: HTMLElement[]): void;
+
+    /**
+     * Inserts elements after the HTML element.
+     * @param {...HTMLElement} elements - The elements to insert after the HTML element.
+     */
     after(...elements: HTMLElement[]): void;
+
+    /**
+     * Retrieves the label associated with the HTML element.
+     * @returns {HTMLElement} The label element associated with this element.
+     * @throws {Error} Throws an error if the label cannot be found.
+     */
     getLabel(): HTMLElement;
+
+    /**
+     * Appends child elements to the label associated with the HTML element.
+     * @param {...HTMLElement} elements - The elements to append to the label.
+     */
     appendToLabel(...elements: HTMLElement[]): void;
+
+    /**
+     * Adds a click event listener to the HTML element.
+     * @param {Function} eventHandler - The function to execute when the element is clicked.
+     */
     addClickListener(eventHandler: () => void): void;
+
+    /**
+     * Adds a change event listener to the HTML element.
+     * @param {Function} eventHandler - The function to execute when the element's value changes.
+     */
     addChangeListener(eventHandler: () => void): void;
+
+    /**
+     * Unchecks both the yes and no radio buttons if they exist.
+     */
     uncheckRadios(): void;
+
+    /**
+     * Creates a validation instance for the field.
+     * @param {Function} evaluationFunction - The function used to evaluate the field.
+     * @param {string} fieldDisplayName - The field name to display in error if validation fails.
+     */
     createValidation(
       evaluationFunction: (value: any) => boolean,
       fieldDisplayName: string
     ): void;
+
+    /**
+     * Adds a tooltip with specified text to the label associated with the HTML element.
+     * @param {string} text - The text to display in the tooltip.
+     */
     addLabelTooltip(text: string): void;
+
+    /**
+     * Sets the inner HTML content of the HTML element.
+     * @param {string} text - The text to set as the inner HTML of the element.
+     */
     setTextContent(text: string): void;
+
+    /**
+     * Executes a callback function once the element is fully loaded.
+     * If the element is already loaded, the callback is called immediately.
+     * Otherwise, a MutationObserver is used to detect when the element is added to the DOM.
+     * @param {Function} callback - A callback function to execute once the element is loaded.
+     */
     onceLoaded(callback: (instance: this) => void): void;
   }
 
-  export async function createDOMNodeReference(
+  /**
+   * Creates and initializes a DOMNodeReference instance.
+   * @async
+   * @function createDOMNodeReference
+   * @param {string} querySelector - The CSS selector for the desired DOM element.
+   * @returns {Promise<DOMNodeReference>} A promise that resolves to a Proxy of the initialized DOMNodeReference instance.
+   */
+  export default function createDOMNodeReference(
     querySelector: string
   ): Promise<DOMNodeReference>;
 
@@ -39,6 +150,7 @@ declare module "powerpagestoolkit" {
     value(): any; // Adjust this type based on the structure of your schema values
   }
 
+  
   export interface API {
     /**
      * Creates a new record in DataVerse.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "powerpagestoolkit",
-  "version": "1.0.14",
+  "version": "1.0.21",
   "description": "Reference, manipulate, and engage with Power Pages sites through the nodes in the DOM; use a variety of custom methods that allow customizing your power pages site quicker and easier.  ",
   "main": "index.js",
   "types": "index.d.ts",