powerpagestoolkit 2.7.0 → 2.7.2

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

@@ -0,0 +1,88 @@
+/// <reference path="../globals.d.ts" />
+import DOMNodeReference from "./DOMNodeReference.d.ts";
+import type DOMNodeReferenceArray from "./DOMNodeReferenceArray.d.ts";
+/**
+ * Creates and initializes a DOMNodeReference instance.
+ * @see {@link CreationOptions}
+ * @param  **target** - The selector, using `querySelector` syntax, for the desired DOM element. Or, the `HTMLElement` itself for which to create a DOMNodeReference.
+ * @param **options** - Options for advanced retrieval of elements
+ * @param **options.multiple** - Should this call return an array of instantiated references, or just a single? Defaults to false, returning a single instance
+ * @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?: {
+    /**
+     * Should this call return an array of instantiated references, or just a single?
+     * Defaults to false, returning a single instance.
+     */
+    multiple?: (() => boolean) | boolean;
+    /**
+     * Optionally specify the element within which to search for the element targeted by 'target'.
+     * Defaults to 'document.body'.
+     */
+    root?: HTMLElement;
+    /**
+     * Optionally specify the amount of time that should be waited to find the targeted element before throwing an error.
+     * Useful for async DOM loading. Relies on MutationObserver.
+     * WARNING: Implementing multiple references with timeout can result in infinite loading.
+     */
+    timeoutMs?: number;
+}): Promise<DOMNodeReference>;
+export default function createDOMNodeReference(target: string, options?: {
+    /**
+     * Should this call return an array of instantiated references, or just a single?
+     * Defaults to false, returning a single instance.
+     */
+    multiple?: false;
+    /**
+     * Optionally specify the element within which to search for the element targeted by 'target'.
+     * Defaults to 'document.body'.
+     */
+    root?: HTMLElement;
+    /**
+     * Optionally specify the amount of time that should be waited to find the targeted element before throwing an error.
+     * Useful for async DOM loading. Relies on MutationObserver.
+     * WARNING: Implementing multiple references with timeout can result in infinite loading.
+     */
+    timeoutMs?: number;
+}): Promise<DOMNodeReference>;
+export default function createDOMNodeReference(target: Element, options?: {
+    /**
+     * Optionally specify the element within which to search for the element targeted by 'target'.
+     * Defaults to 'document.body'.
+     */
+    root?: HTMLElement;
+    /**
+     * Optionally specify the amount of time that should be waited to find the targeted element before throwing an error.
+     * Useful for async DOM loading. Relies on MutationObserver.
+     * WARNING: Implementing multiple references with timeout can result in infinite loading.
+     */
+    timeoutMs?: number;
+}): Promise<DOMNodeReference>;
+export default function createDOMNodeReference(target: string, options?: {
+    /**
+     * Should this call return an array of instantiated references, or just a single?
+     * Defaults to false, returning a single instance.
+     */
+    multiple?: true;
+    /**
+     * Optionally specify the element within which to search for the element targeted by 'target'.
+     * Defaults to 'document.body'.
+     */
+    root?: HTMLElement;
+    /**
+     * Optionally specify the amount of time that should be waited to find the targeted element before throwing an error.
+     * Useful for async DOM loading. Relies on MutationObserver.
+     * WARNING: Implementing multiple references with timeout can result in infinite loading.
+     */
+    timeoutMs?: number;
+}): Promise<DOMNodeReferenceArray>;
+export declare function validateOptions(options: Partial<CreationOptions>): void;
+export declare function createProxyHandler(): {
+    get: (target: DOMNodeReference, prop: string | symbol) => any;
+};

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

@@ -0,0 +1,9 @@
+/// <reference path="../globals.d.ts" />
+/**
+ * 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: 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/{errors.d.ts → src/errors/errors.d.ts}

@@ -1,4 +1,5 @@
-import DOMNodeReference from "./DOMNodeReference.js";
+/// <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

@@ -0,0 +1,150 @@
+/// <reference path="../core/DOMNodeReference.ts"/>
+
+declare interface CreationOptions {
+  /**
+   * Should this call return an array of instantiated references, or just a single?
+   * Defaults to false, returning a single instance.
+   */
+  multiple?: (() => boolean) | boolean;
+
+  /**
+   * Optionally specify the element within which to search for the element targeted by 'target'.
+   * Defaults to 'document.body'.
+   */
+  root?: HTMLElement;
+
+  /**
+   * Optionally specify the amount of time that should be waited to find the targeted element before throwing an error.
+   * Useful for async DOM loading. Relies on MutationObserver.
+   * WARNING: Implementing multiple references with timeout can result in infinite loading.
+   */
+  timeoutMs?: number;
+}
+
+declare interface SystemForm extends Object {
+  "@odata.context": string;
+  "@odata.etag": string;
+  "overwritetime@OData.Community.Display.V1.FormattedValue": string;
+  overwritetime: Date;
+  "isdesktopenabled@OData.Community.Display.V1.FormattedValue": string;
+  isdesktopenabled: boolean;
+  "publishedon@OData.Community.Display.V1.FormattedValue": Date;
+  publishedon: Date;
+  "_organizationid_value@OData.Community.Display.V1.FormattedValue": string;
+  "_organizationid_value@Microsoft.Dynamics.CRM.associatednavigationproperty": string;
+  "_organizationid_value@Microsoft.Dynamics.CRM.lookuplogicalname": string;
+  _organizationid_value: string;
+  formxml: string;
+  introducedversion: string;
+  "isairmerged@OData.Community.Display.V1.FormattedValue": string;
+  isairmerged: boolean;
+  "istabletenabled@OData.Community.Display.V1.FormattedValue": string;
+  istabletenabled: boolean;
+  solutionid: string;
+  formidunique: string;
+  "ismanaged@OData.Community.Display.V1.FormattedValue": string;
+  ismanaged: boolean;
+  "isdefault@OData.Community.Display.V1.FormattedValue": string;
+  isdefault: boolean;
+  "objecttypecode@OData.Community.Display.V1.FormattedValue": string;
+  objecttypecode: string;
+  "type@OData.Community.Display.V1.FormattedValue": string;
+  type: number;
+  "componentstate@OData.Community.Display.V1.FormattedValue": string;
+  componentstate: number;
+  "formpresentation@OData.Community.Display.V1.FormattedValue": string;
+  formpresentation: number;
+  "formactivationstate@OData.Community.Display.V1.FormattedValue": string;
+  formactivationstate: number;
+  name: string;
+  "versionnumber@OData.Community.Display.V1.FormattedValue": string;
+  versionnumber: number;
+  formjson: string;
+  description: string;
+  formid: string;
+}
+
+declare interface Form extends Partial<SystemForm> {
+  formxml: string;
+}
+
+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?: [
+    condition: (this: DOMNodeReference) => boolean,
+    clearValuesOnHide?: boolean
+  ];
+  /**
+   * @param isRequired Function determining if field is required
+   * @param isValid Function validating field input.
+   */
+  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
+  ];
+  /**
+   * @param condition A function to determine if this field
+   * should be enabled in a form, or disabled. True || 1 = disabled. False || 0 = enabled
+   */
+  setDisabled?: () => boolean;
+}
+
+declare interface CreationOptions {
+  /**
+   * Should this call return an array of instantiated references, or just a single?
+   * Defaults to false, returning a single instance.
+   */
+  multiple?: (() => boolean) | boolean;
+
+  /**
+   * Optionally specify the element within which to search for the element targeted by 'target'.
+   * Defaults to 'document.body'.
+   */
+  root?: HTMLElement;
+
+  /**
+   * Optionally specify the amount of time that should be waited to find the targeted element before throwing an error.
+   * Useful for async DOM loading. Relies on MutationObserver.
+   * WARNING: Implementing multiple references with timeout can result in infinite loading.
+   */
+  timeoutMs?: number;
+}
+
+declare const Page_Validators: any[];
+
+declare interface ElementValue {
+  value: any;
+  checked?: boolean;
+}
+
+declare type RadioType = "truthy" | "falsy";
+
+declare interface BoundEventListener {
+  element: Element;
+  event: keyof HTMLElementEventMap;
+  handler: (e: Event) => unknown;
+}
+
+declare type FormElement =
+  | HTMLInputElement
+  | HTMLSelectElement
+  | HTMLTextAreaElement
+  | HTMLSpanElement
+  | HTMLButtonElement
+  | HTMLFieldSetElement;

package/dist/src/index.d.ts

@@ -0,0 +1,5 @@
+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, bindForm, createRef, waitFor };