powerpagestoolkit 2.5.411 → 2.5.4111

package/README.md

@@ -21,7 +21,7 @@ npm install powerpagestoolkit
 
 # Core Modules
 
-- ### DOMNodeReference
+### DOMNodeReference
 
 A powerful class for managing DOM elements with automatic value synchronization and event handling.
 
@@ -92,11 +92,11 @@ node.hide();
 node.show();
 ```
 
-##### Advanced conditional rendering
+**_Advanced conditional rendering_**
 
 Out of the box, Microsoft does not provide PowerPages developers the ability to hide or show fields or form elements based on the value of another field. This method allows such configurations
 
-- Method Signature
+_Method signature:_
 
 ```typescript
 DOMNodeReference.configureConditionalRendering(
@@ -106,7 +106,7 @@ DOMNodeReference.configureConditionalRendering(
   ): DOMNodeReference
 ```
 
-- Method Implementation
+_Example implementation:_
 
 ```typescript
 node.configureConditionalRendering(
@@ -125,6 +125,8 @@ node.configureConditionalRendering(
 
 This utility enhances PowerPages forms by adding dynamic field validation and conditional requirements based on other field values.
 
+_Method signature:_
+
 ```typescript
 // Core method for setting up validation
 function configureValidationAndRequirements(
@@ -136,7 +138,7 @@ function configureValidationAndRequirements(
  method chaining */
 ```
 
-- Here's a practical example showing how to make a field required only when a "Yes" radio button is selected:
+_Example implementation:_
 
 ```typescript
 node.configureValidationAndRequirements(
@@ -172,6 +174,9 @@ node.setValue(() => {
 // Sync with DOM
 node.updateValue();
 
+// Clear the value for both the instance and the target element
+node.clearValue()
+
 /****/ Content manipulation /****/
 
 node.setInnerHTML("<span>New content</span>");
@@ -213,11 +218,11 @@ node.addTooltip(
 );
 ```
 
-- ### DataVerse API
+### DataVerse API
 
-Type-safe wrapper for DataVerse API operations.
+Perform secure API calls to DataVerse from your PowerPages site. This method implements the shell deferred token to send requests with `__RequestVerificationToken`
 
-#### Create Record
+#### Create Records
 
 ```typescript
 await API.createRecord("accounts", {
@@ -277,18 +282,10 @@ node.configureConditionalRendering(
 
 3. Use TypeScript for better type safety and IntelliSense support.
 
-4. Handle loading states:
+4. Use proper error handling with API operations:
 
 ```typescript
-node.onceLoaded((instance) => {
-  // Safe to manipulate the element here
-});
-```
-
-5. Use proper error handling with API operations:
-
-```typescript
-await API.createRecord(/*...*/)
+/* optionally await */ API.createRecord(/*...*/)
   .then((recordId) => {})
   .catch((error) => {
     // handle your errors appropriately
@@ -306,3 +303,7 @@ Contributions are welcome, feel free to create a pull request with enhancements.
 ## License
 
 This project is licensed under the AGPL-3.0 License - see the [LICENSE](LICENSE) file for details.
+
+## Funding
+
+If you like this project, found it useful, or would like to help support the long-term support of this package, please feel free to contribute via GitHub Sponsors: [Keaton-Brewster](https://github.com/sponsors/Keaton-Brewster)

package/dist/DOMNodeReference.d.ts

@@ -80,7 +80,7 @@ export default class DOMNodeReference {
     show(): DOMNodeReference;
     /**
      *
-     * @param {function(instance: DOMNodeReference): boolean | boolean} shouldShow - Either a function that returns true or false,
+     * @param shouldShow - Either a function that returns true or false,
      * or a natural boolean to determine the visibility of this
      * @returns - Instance of this [provides option to method chain]
      */
@@ -105,7 +105,7 @@ export default class DOMNodeReference {
      * @returns - Instance of this [provides option to method chain]
      * @throws If clearing values fails
      */
-    clearValues(): Promise<DOMNodeReference>;
+    clearValue(): Promise<DOMNodeReference>;
     /**
      * Enables the element so that users can input data
      * @returns - Instance of this [provides option to method chain]

package/dist/bundle.js

@@ -441,7 +441,7 @@ var DOMNodeReference = class _DOMNodeReference {
   }
   /**
    *
-   * @param {function(instance: DOMNodeReference): boolean | boolean} shouldShow - Either a function that returns true or false,
+   * @param shouldShow - Either a function that returns true or false,
    * or a natural boolean to determine the visibility of this
    * @returns - Instance of this [provides option to method chain]
    */
@@ -493,7 +493,7 @@ var DOMNodeReference = class _DOMNodeReference {
    * @returns - Instance of this [provides option to method chain]
    * @throws If clearing values fails
    */
-  async clearValues() {
+  async clearValue() {
     try {
       const element = this.element;
       if (element instanceof HTMLInputElement) {
@@ -534,14 +534,14 @@ var DOMNodeReference = class _DOMNodeReference {
         if (childInputs.length > 0) {
           const clearPromises = childInputs.map(async (input) => {
             const inputRef = await createDOMNodeReference(input, false);
-            return inputRef.clearValues();
+            return inputRef.clearValue();
           });
           await Promise.all(clearPromises);
         }
       }
       if (this.yesRadio instanceof _DOMNodeReference && this.noRadio instanceof _DOMNodeReference) {
-        await this.yesRadio.clearValues();
-        await this.noRadio.clearValues();
+        await this.yesRadio.clearValue();
+        await this.noRadio.clearValue();
       }
       const events = [
         new Event("input", { bubbles: true }),
@@ -813,7 +813,7 @@ var DOMNodeReference = class _DOMNodeReference {
       const handleChange = () => {
         handler();
         if (clearValuesOnHide && window.getComputedStyle(this.visibilityController).display === "none") {
-          this.clearValues();
+          this.clearValue();
         }
       };
       dep.on("change", handleChange);

package/package.json

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