powerpagestoolkit 1.3.304 → 1.3.501

package/dist/index.bundle.js

@@ -804,7 +804,7 @@ var DOMNodeReference = /*#__PURE__*/function () {
                 _context.next = 7;
                 break;
               }
-              throw new DOMNodeNotFoundError(this);
+              return _context.abrupt("return", new DOMNodeNotFoundError(this));
             case 7:
               if (!this.element.classList.contains("boolean-radio")) {
                 _context.next = 10;
@@ -822,7 +822,7 @@ var DOMNodeReference = /*#__PURE__*/function () {
             case 16:
               _context.prev = 16;
               _context.t0 = _context["catch"](0);
-              throw new DOMNodeInitializationError(this, _context.t0);
+              return _context.abrupt("return", new DOMNodeInitializationError(this, _context.t0));
             case 19:
             case "end":
               return _context.stop();
@@ -976,7 +976,7 @@ var DOMNodeReference = /*#__PURE__*/function () {
       try {
         this.element.disabled = true;
       } catch (e) {
-        throw new Error("There was an error trying to disable the target: ".concat(this.target));
+        return new Error("There was an error trying to disable the target: ".concat(this.target));
       }
       return this;
     }
@@ -986,7 +986,7 @@ var DOMNodeReference = /*#__PURE__*/function () {
       try {
         this.element.disabled = false;
       } catch (e) {
-        throw new Error("There was an error trying to disable the target: ".concat(this.target));
+        return new Error("There was an error trying to disable the target: ".concat(this.target));
       }
       return this;
     }
@@ -1084,9 +1084,15 @@ var DOMNodeReference = /*#__PURE__*/function () {
       return this;
     }
   }, {
-    key: "setTextContent",
-    value: function setTextContent(text) {
-      this.element.innerHTML = text;
+    key: "setInnerHTML",
+    value: function setInnerHTML(string) {
+      this.element.innerHTML = string;
+      return this;
+    }
+  }, {
+    key: "remove",
+    value: function remove() {
+      this.element.remove();
       return this;
     }
   }, {
@@ -1094,7 +1100,7 @@ var DOMNodeReference = /*#__PURE__*/function () {
     value: function setStyle(options) {
       var _this5 = this;
       if (Object.prototype.toString.call(options) !== "[object Object]") {
-        throw new Error("powerpagestoolkit: 'DOMNodeReference.setStyle' required options to be in the form of an object. Argument passed was of type: ".concat(DOMNodeReferences_typeof(options)));
+        return new Error("powerpagestoolkit: 'DOMNodeReference.setStyle' required options to be in the form of an object. Argument passed was of type: ".concat(DOMNodeReferences_typeof(options)));
       }
       Object.keys(options).forEach(function (key) {
         _this5.element.style[key] = options[key];
@@ -1135,7 +1141,7 @@ var DOMNodeReference = /*#__PURE__*/function () {
           });
         }
       } catch (e) {
-        throw new ConditionalRenderingError(this, e);
+        return new ConditionalRenderingError(this, e);
       }
       return this;
     }
@@ -1154,7 +1160,7 @@ var DOMNodeReference = /*#__PURE__*/function () {
         //eslint-disable-next-line
         Page_Validators.push(newValidator);
       } else {
-        throw new Error("Attempted to add to Validator where Page_Validators do not exist");
+        return new Error("Attempted to add to Validator where Page_Validators do not exist");
       }
       this.setRequiredLevel(isRequired(this));
       if (!dependencies) return this;
@@ -1241,9 +1247,10 @@ function _createDOMNodeReference() {
                   for (var _len6 = arguments.length, args = new Array(_len6), _key6 = 0; _key6 < _len6; _key6++) {
                     args[_key6] = arguments[_key6];
                   }
-                  return target.onceLoaded(function () {
+                  target.onceLoaded(function () {
                     return value.apply(target, args);
                   });
+                  return target;
                 };
               }
               return value;
@@ -1253,7 +1260,7 @@ function _createDOMNodeReference() {
           _context3.prev = 7;
           _context3.t0 = _context3["catch"](0);
           console.error("There was an error creating a DOMNodeReference: ".concat(_context3.t0));
-          throw new Error(_context3.t0);
+          return _context3.abrupt("return", new Error(_context3.t0));
         case 11:
         case "end":
           return _context3.stop();
@@ -1294,7 +1301,7 @@ function _createMultipleDOMNodeReferences() {
           _context4.prev = 10;
           _context4.t0 = _context4["catch"](0);
           console.error("There was an error creating multiple DOMNodeReferences: ".concat(_context4.t0));
-          throw new Error(_context4.t0);
+          return _context4.abrupt("return", new Error(_context4.t0));
         case 14:
         case "end":
           return _context4.stop();

package/index.d.ts

@@ -47,55 +47,64 @@ class DOMNodeReference {
 
   /**
    * Hides the element by setting its display style to "none".
+   * @returns {DOMNodeReference} Returns 'this'
    */
-  hide(): void;
+  hide(): DOMNodeReference;
 
   /**
    * Shows the element by restoring its default display style.
+   * @returns {DOMNodeReference} Returns 'this'
    */
-  show(): void;
+  show(): DOMNodeReference;
 
   /**
    * Sets the value of the HTML element.
    * @param {() => any} 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
+   * @returns {DOMNodeReference} Returns 'this'
    */
-  setValue(value: string): void;
+  setValue(value: string): DOMNodeReference;
 
   /**
    * Disables the element so that users cannot input any data
+   * @returns {DOMNodeReference} Returns 'this'
    */
-  disable(): void;
+  disable(): DOMNodeReference;
 
   /**
    * Enables the element so that users can input data
+   * @returns {DOMNodeReference} Returns 'this'
    */
-  enable(): void;
+  enable(): DOMNodeReference;
 
   /**
    * Prepends elements to the target
    * @param {HTMLElement[] | DOMNodeReference[]} nodes - The elements to prepend to the HTML element
+   * @returns {DOMNodeReference} Returns 'this'
    */
-  prepend(...nodes: HTMLElement[] | DOMNodeReference[]): void;
+  prepend(...nodes: HTMLElement[] | DOMNodeReference[]): DOMNodeReference;
 
   /**
    * Appends child elements to the HTML element.
    * @param {HTMLElement[] | DOMNodeReference[]} nodes - The elements to append to the HTML element.
+   * @returns {DOMNodeReference} Returns 'this'
    */
-  append(...nodes: HTMLElement[] | DOMNodeReference[]): void;
+  append(...nodes: HTMLElement[] | DOMNodeReference[]): DOMNodeReference;
 
   /**
    * Inserts elements before the HTML element.
    * @param {HTMLElement[] | DOMNodeReference[]} nodes - The elements to insert before the HTML element.
+   * @returns {DOMNodeReference} Returns 'this'
    */
-  before(...nodes: HTMLElement[] | DOMNodeReference[]): void;
+  before(...nodes: HTMLElement[] | DOMNodeReference[]): DOMNodeReference;
 
   /**
    * Inserts elements after the HTML element.
    * @param {HTMLElement[] | DOMNodeReference[]} nodes - The elements to insert after the HTML element.
+   * @returns {DOMNodeReference} Returns 'this'
    */
-  after(...nodes: HTMLElement[] | DOMNodeReference[]): void;
+  after(...nodes: HTMLElement[] | DOMNodeReference[]): DOMNodeReference;
 
   /**
    * Retrieves the label associated with the HTML element.
@@ -107,8 +116,9 @@ class DOMNodeReference {
   /**
    * Appends child elements to the label associated with the HTML element.
    * @param {...HTMLElement} elements - The elements to append to the label.
+   * @returns {DOMNodeReference} Returns 'this'
    */
-  appendToLabel(...elements: HTMLElement[]): void;
+  appendToLabel(...elements: HTMLElement[]): DOMNodeReference;
 
   /**
    * Sets up an event listener based on the specified event type, executing the specified
@@ -116,12 +126,15 @@ class DOMNodeReference {
    * @param {string} eventType - The DOM event to watch for
    * @param {(this: DOMNodeReference, e: Event) => void} eventHandler - The callback function that runs when the
    * specified event occurs
+   * @returns {DOMNodeReference} Returns 'this'
    */
-  on(eventType: string, eventHandler: (event: Event) => void): void;
+  on(eventType: string, eventHandler: (event: Event) => void): DOMNodeReference;
+
   /**
    * Unchecks both the yes and no radio buttons if they exist.
+   * @returns {DOMNodeReference} Returns 'this'
    */
-  uncheckRadios(): void;
+  uncheckRadios(): DOMNodeReference;
 
   /**
    * Sets up validation and requirement rules for the field. This function dynamically updates the field's required status and validates its input based on the specified conditions.
@@ -130,53 +143,66 @@ class DOMNodeReference {
    * @param {function(this: DOMNodeReference): boolean} isValid - A function that checks if the field's input is valid. Returns `true` if valid, `false` otherwise.
    * @param {string} fieldDisplayName - The name of the field, used in error messages if validation fails.
    * @param {Array<DOMNodeReference>} [dependencies] Other fields that this field’s requirement depends on. When these fields change, the required status of this field is re-evaluated. Make sure any DOMNodeReference used in `isRequired` or `isValid` is included in this array.
+   * @returns {DOMNodeReference} Returns 'this'
    */
   configureValidationAndRequirements(
     isRequired: (this: this) => boolean,
     isValid: (this: this) => boolean,
     fieldDisplayName: string,
     dependencies: Array<DOMNodeReference>
-  ): void;
+  ): DOMNodeReference;
 
   /**
    * Sets the required level for the field by adding or removing the "required-field" class on the label.
    *
    * @param {boolean} isRequired - Determines whether the field should be marked as required.
    * If true, the "required-field" class is added to the label; if false, it is removed.
+   * @returns {DOMNodeReference} Returns 'this'
    */
-  setRequiredLevel(isRequired: boolean): void;
+  setRequiredLevel(isRequired: boolean): DOMNodeReference;
 
   /**
    * Adds a tooltip with specified text to the label associated with the HTML element.
    * @param {string} text - The text to display in the tooltip.
+   * @returns {DOMNodeReference} Returns 'this'
    */
-  addLabelTooltip(text: string): void;
+  addLabelTooltip(text: string): DOMNodeReference;
 
   /**
    * Adds a tooltip with the specified text to the element
    * @param {string} text - The text to display in the tooltip
+   * @returns {DOMNodeReference} Returns 'this'
    */
-  addTooltip(text: string): void;
+  addTooltip(text: string): DOMNodeReference;
 
   /**
    * Sets the inner HTML content of the HTML element.
    * @param {string} text - The text to set as the inner HTML of the element.
+   * @returns {DOMNodeReference} Returns 'this'
+   */
+  setInnerHTML(text: string): DOMNodeReference;
+
+  /**
+   * Removes the element from the DOM
+   * @returns {DOMNodeReference} Returns 'this'
    */
-  setTextContent(text: string): void;
+  remove(): DOMNodeReference;
 
   /**
    *
    * @param {Partial<CSSStyleDeclaration>} options - An object with the style properties (keys) and updated styles (values)
    * to apply to the this. {"key": "value"}
+   * @returns {DOMNodeReference} Returns 'this'
    */
-  setStyle(options: Partial<CSSStyleDeclaration>): void;
+  setStyle(options: Partial<CSSStyleDeclaration>): DOMNodeReference;
 
   /**
    *
    * @param {boolean} shouldShow shows or hides the target
    * if = true => show, if = false => hide
+   * @returns {DOMNodeReference} Returns 'this'
    */
-  toggleVisibility(shouldShow: boolean): void;
+  toggleVisibility(shouldShow: boolean): DOMNodeReference;
 
   /**
    * Configures conditional rendering for the target element based on a condition
@@ -188,11 +214,12 @@ class DOMNodeReference {
    * @param {Array<DOMNodeReference>} dependencies - An array of `DOMNodeReference` instances. Event listeners are
    * registered on each to toggle the visibility of the target element based on the `condition` and the visibility of
    * the target node.
+   * @returns {DOMNodeReference} Returns 'this'
    */
   configureConditionalRendering(
     condition: (this: DOMNodeReference) => boolean,
     dependencies: DOMNodeReference[]
-  ): void;
+  ): DOMNodeReference;
 
   /**
    * Executes a callback function once the element is fully loaded.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "powerpagestoolkit",
-  "version": "1.3.304",
+  "version": "1.3.501",
   "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": "./dist/index.bundle.js",
   "types": "index.d.ts",