powerpagestoolkit 2.7.1420 → 2.7.1433

package/dist/src/constants/eventMapping.d.ts

@@ -1,2 +1,7 @@
+/// <reference path="../globals.d.ts" />
+/**
+ * For use in setting up event management in the instances of DOMNodeReference
+ * @see {@link DOMNodeReference}
+ */
 declare const eventMapping: Record<string, keyof HTMLElementEventMap>;
 export default eventMapping;

package/dist/src/constants/symbols.d.ts

@@ -1,3 +1,4 @@
+/// <reference path="../globals.d.ts" />
 export declare const init: unique symbol;
 export declare const destroy: unique symbol;
 export declare const valueSync: unique symbol;

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

@@ -1,7 +1,10 @@
+/// <reference path="../globals.d.ts" />
 /**
- * @module API
- * Provides an abstract class API that allows basic create, read, and update operations
- * via the PowerPages API
+ * Provides abstract class `API` that allows basic create, read, and update operations in DataVerse via the PowerPages API
+ * @method `createRecord` - Create a record in DataVerse
+ * @method `getRecord<T>` - Get a record by ID from DataVerse
+ * @method `getMultiple` - Get multiple records from DataVerse; with optional OData filtering
+ * @method `updateRecord` - Update a record by ID in DataVerse
  */
 declare abstract class API {
     /**
@@ -9,7 +12,7 @@ declare abstract class API {
      * @param data The JSON of the fields and data that are to be updated on the targeted record
      * @returns a Promise resolving the successful results *[record id]* of the POST request, or rejecting the failed results *[error]* of the POST request.
      */
-    static createRecord(tableSetName: string, data: object): Promise<string>;
+    static createRecord(tableSetName: string, data: JSON): Promise<string>;
     /**
      *
      * @param tableSetName The DataVerse SET name of the table being queried

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

@@ -1,3 +1,4 @@
+/// <reference path="../globals.d.ts" />
 import * as s from "../constants/symbols.d.ts";
 export default class DOMNodeReference {
     target: Element | string;
@@ -89,7 +90,6 @@ export default class DOMNodeReference {
      */
     show(): DOMNodeReference;
     /**
-     *
      * @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]
@@ -123,7 +123,6 @@ export default class DOMNodeReference {
      */
     enable(): DOMNodeReference;
     /**
-     *
      * @param elements - The elements to prepend to the element targeted by this.
      * @returns - Instance of this [provides option to method chain]
      */
@@ -177,7 +176,6 @@ export default class DOMNodeReference {
      */
     remove(): this;
     /**
-     *
      * @param options and object containing the styles you want to set : {key: value} e.g.: {'display': 'block'}
      * @returns - Instance of this [provides option to method chain]
      */

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

@@ -1,3 +1,4 @@
+/// <reference path="../globals.d.ts" />
 import type DOMNodeReference from "./DOMNodeReference.d.ts";
 export default class DOMNodeReferenceArray extends Array<DOMNodeReference> {
     /**

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

@@ -0,0 +1,13 @@
+/// <reference path="../globals.d.ts" />
+export default class List {
+    private static _instance;
+    private _root;
+    private _listItems;
+    private _observer;
+    private constructor();
+    static get(): List;
+    private _observe;
+    private _update;
+    private _destroy;
+    destroy(): void;
+}

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

@@ -1,28 +1,31 @@
+/// <reference path="../globals.d.ts" />
 /**
  * @module
- * This module provides the bindForm function. When loading into a page in PowerPages that has a form,
- * you can use this function by passing in the GUID of the form, and you will receive an array/record
- * of DOMNodeReferences that represent all fields, sections, sub-grids, and tabs of the given form.
- * @see {@link DOMNodeReference}
- * Access these properties of the BoundForm {@link BoundForm} using the logical name of the control you need to access: form['logical_name']
- * you can then execute all the methods available from DOMNodeReference
  */
+import type DOMNodeReference from "./DOMNodeReference.d.ts";
+import type DOMNodeReferenceArray from "./DOMNodeReferenceArray.d.ts";
 /**
- * Get all controls related to the form for manipulating with the
- * DOMNodeReference class. Rather than having to instantiate each fields that you need manually,
- * you can call this method once with the form ID and gain access to all fields
+ * When loading into a page in PowerPages that has a form,
+ * you can use this function by passing in the GUID of the form, and you will receive an array/record
+ * of {@link DOMNodeReference}s that represent all fields, sections, sub-grids, and tabs of the given form.
+ * Access these properties of the {@link BoundForm} using the logical name of the control you need to access: form['logical_name']
+ * you can then execute all the methods available from DOMNodeReference
  * @param formId - The string GUID of the form you want to bind to
- * @callback `callbackFn` - Function to execute after the form has been retrieved and bound; the form itself is provided as the argument
  * @returns An array of DOMNodeReferences, accessible as properties of a Record<string, DOMNodeReference> i.e. formProp = form["some_logicalName"]
  * @example
  * ```js
- * bindForm("some-guid-0000", (form) => {
+ * bindForm("form-guid-0000").then((form) => {
  *    //...use the form
  *    const field = form["field_logical_name"]
  *    // or
  *    form["other_logical_name"].someMethod()
  * })
+ *
+ * // or
+ *
+ * const form = await bindForm("form-guid-0000")
  * ```
  *  @see {@link BoundForm}
+ *  @see {@link DOMNodeReference}
  */
-export default function bindForm(formId: string, callbackFn: (form: BoundForm) => void): Promise<BoundForm>;
+export default function bindForm(formId: string): Promise<DOMNodeReferenceArray & Record<string, DOMNodeReference>>;

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

@@ -1,8 +1,4 @@
-/**
- * @module createRef
- * Provides a factory function for creating new DOMNodeReferences
- * @see {@link DOMNodeReference}
- */
+/// <reference path="../globals.d.ts" />
 import DOMNodeReference from "./DOMNodeReference.d.ts";
 import type DOMNodeReferenceArray from "./DOMNodeReferenceArray.d.ts";
 /**
@@ -14,6 +10,10 @@ import type DOMNodeReferenceArray from "./DOMNodeReferenceArray.d.ts";
  * @param **options.root** - Optionally specify the element within to search for the element targeted by 'target'. Defaults to `document.body`
  * @param **options.timeoutMs** - Optionally specify the amount of time that should be waited to find the targeted element before throwing error - useful for async DOM loading. Relies on MutationObserver.  ***WARNING***: Implementing multiple references with timeout can result in infinite loading.
  * @returns  A promise that resolves to a Proxy of the initialized DOMNodeReference instance.
+ *
+ * @see {@link DOMNodeReference}
+ * @see {@link DOMNodeReferenceArray}
+ * @see {@link enhanceArray}
  */
 export default function createDOMNodeReference(target: string | HTMLElement, options?: {
     /**

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

@@ -1,6 +1,9 @@
+/// <reference path="../globals.d.ts" />
 /**
- * @module waitFor
  * Provides an async way to capture DOM elements; for when querySelector cannot capture the target due to async DOM content loading
+ * @param **target** - basic querySelector syntax to select an element
+ * @param **root** - optional parameter to replace document as the root from which to perform the node search
+ * @returns the element(s) targeted by the `querySelector` string
  */
-export default function waitFor(target: Element | string, root: Element | Document, multiple: false, debounceTime: number): Promise<HTMLElement>;
-export default function waitFor(target: Element | string, root: Element | Document, multiple: true, debounceTime: number): Promise<HTMLElement[]>;
+export default function waitFor(target: string, root: Element | Document, multiple: false, debounceTime: number): Promise<HTMLElement>;
+export default function waitFor(target: string, root: Element | Document, multiple: true, debounceTime: number): Promise<HTMLElement[]>;

package/dist/src/errors/errors.d.ts

@@ -1,3 +1,4 @@
+/// <reference path="../globals.d.ts" />
 import type DOMNodeReference from "../core/DOMNodeReference.d.ts";
 export declare class DOMNodeInitializationError extends Error {
     constructor(instance: DOMNodeReference, error: string);

package/dist/src/globals.d.ts

@@ -1,3 +1,4 @@
+/// <reference path="../globals.d.ts" />
 import type DOMNodeReference from "./core/DOMNodeReference.d.ts";
 import type DOMNodeReferenceArray from "./core/DOMNodeReferenceArray.d.ts";
 

package/dist/src/index.d.ts

@@ -1,5 +1,6 @@
+/// <reference path="../globals.d.ts" />
 import API from "./core/API.d.ts";
 import createRef from "./core/createDOMNodeReferences.d.ts";
 import waitFor from "./core/waitFor.d.ts";
 import bindForm from "./core/bindForm.d.ts";
-export { API, createRef, waitFor, bindForm };
+export { API, bindForm, createRef, waitFor };

package/dist/src/index.js

@@ -35,7 +35,7 @@ var API = class {
         url: `/_api/${tableSetName}`,
         data: JSON.stringify(data),
         contentType: "application/json",
-        success: function(response, status, xhr) {
+        success: function(_response, _status, xhr) {
           resolve(xhr.getResponseHeader("entityid"));
         },
         error: (error) => {
@@ -159,10 +159,6 @@ function waitFor(target, root = document, multiple = false, debounceTime2) {
           )
         );
       }, debounceTime2);
-      if (target instanceof HTMLElement) {
-        clearTimeout(timeout);
-        return resolve(target);
-      }
       const element = root.querySelector(target);
       if (element) {
         clearTimeout(timeout);
@@ -458,13 +454,15 @@ var DOMNodeReference = class _DOMNodeReference {
         return {
           value: input.value !== "" ? Number(input.value) : null
         };
-      default:
+      default: {
         let cleanValue = input.value;
-        if (this.element.classList.contains("decimal") || this.element.classList.contains("money"))
+        if (this.element.classList.contains("decimal") || this.element.classList.contains("money")) {
           cleanValue = input.value.replace(/[$,]/g, "");
+        }
         return {
           value: this.element.classList.contains("decimal") || this.element.classList.contains("money") ? parseFloat(cleanValue) : cleanValue
         };
+      }
     }
   }
   [attachVisibilityController]() {
@@ -588,7 +586,6 @@ var DOMNodeReference = class _DOMNodeReference {
     return this;
   }
   /**
-   *
    * @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]
@@ -722,7 +719,7 @@ var DOMNodeReference = class _DOMNodeReference {
   enable() {
     try {
       this.element.disabled = false;
-    } catch (e) {
+    } catch (_error) {
       throw new Error(
         `There was an error trying to disable the target: ${this.target}`
       );
@@ -730,7 +727,6 @@ var DOMNodeReference = class _DOMNodeReference {
     return this;
   }
   /**
-   *
    * @param elements - The elements to prepend to the element targeted by this.
    * @returns - Instance of this [provides option to method chain]
    */
@@ -812,7 +808,6 @@ var DOMNodeReference = class _DOMNodeReference {
     return this;
   }
   /**
-   *
    * @param options and object containing the styles you want to set : {key: value} e.g.: {'display': 'block'}
    * @returns - Instance of this [provides option to method chain]
    */
@@ -873,12 +868,13 @@ var DOMNodeReference = class _DOMNodeReference {
         const [isRequired, isValid] = rule.setRequired;
         const fieldDisplayName = (() => {
           let label = this.getLabel();
-          if (!label)
+          if (!label) {
             return new Error(
               `There was an error accessing the label for this element: ${String(
                 this.target
               )}`
             );
+          }
           label = label.innerHTML;
           if (label.length > 50) {
             label = label.substring(0, 50) + "...";
@@ -1285,7 +1281,7 @@ function createProxyHandler() {
 }
 
 // src/core/bindForm.ts
-async function bindForm(formId, callbackFn) {
+async function bindForm(formId) {
   try {
     const form = await API_default.getRecord("systemforms", formId);
     const { formxml } = form;
@@ -1295,11 +1291,6 @@ async function bindForm(formId, callbackFn) {
     const sections = processElements(xmlDoc.getElementsByTagName("section"));
     const tabs = processElements(xmlDoc.getElementsByTagName("tab"));
     const resolvedRefs = await Promise.all([...controls, ...sections, ...tabs]);
-    callbackFn(
-      enhanceArray(
-        resolvedRefs.filter((ref) => ref !== null)
-      )
-    );
     return enhanceArray(
       resolvedRefs.filter((ref) => ref !== null)
     );
@@ -1337,8 +1328,9 @@ function getIdentifyingAttribute(tagName) {
 }
 function createReferenceString(tagName, datafieldname) {
   if (tagName === "control") return `#${datafieldname}`;
-  if (tagName === "tab" || tagName === "section")
+  if (tagName === "tab" || tagName === "section") {
     return `[data-name="${datafieldname}"]`;
+  }
   return null;
 }
 export {