@formio/js 5.0.0-rc.54 → 5.0.0-rc.56

package/lib/mjs/utils/utils.d.ts

@@ -3,10 +3,11 @@
  * @param {Function|string|object} func - The function to evaluate.
  * @param {*} args - A map of arguments to pass to the function.
  * @param {string} ret - The name of the "return" variable in the script.
- * @param {boolean} tokenize - True if the script should be interpolated before being executed.
+ * @param {boolean} interpolate - True if the script should be interpolated before being executed.
+ * @param {import('@formio/core').EvaluatorOptions} options - The evaluator options.
  * @returns {*} - The result of the evaluation.
  */
-export function evaluate(func: Function | string | object, args: any, ret: string, tokenize: boolean): any;
+export function evaluate(func: Function | string | object, args: any, ret: string, interpolate: boolean, options?: import('@formio/core').EvaluatorOptions): any;
 /**
  * Returns a random compoennt ID.
  * @returns {string} - A random component ID.
@@ -324,99 +325,115 @@ export function delay(fn: Function, delay?: number, ...args: any[]): any;
 export function iterateKey(key: string): string;
 /**
  * Determines a unique key within a map provided the base key.
- * @param map
- * @param base
- * @returns {*}
+ * @param {Record<string, string>} map - The map to check for uniqueness.
+ * @param {string} base - The base path of the key.
+ * @returns {string} - The unique key.
  */
-export function uniqueKey(map: any, base: any): any;
+export function uniqueKey(map: Record<string, string>, base: string): string;
 /**
  * Determines the major version number of bootstrap.
- * @param options
- * @returns {number}
+ * @param {object} options - The options to check for bootstrap version.
+ * @param {string} options.bootstrap - The bootstrap version to use.
+ * @returns {number} - The bootstrap version.
  */
-export function bootstrapVersion(options: any): number;
+export function bootstrapVersion(options: {
+    bootstrap: string;
+}): number;
 /**
  * Retrun provided argument.
  * If argument is a function, returns the result of a function call.
- * @param {*} e;
- * @param e
- * @returns {*}
+ * @param {Function|any} e - The argument to check if a function and call if so.
+ * @returns {any} - Either the result of the function call (e) or e if it is not a function.
  */
-export function unfold(e: any): any;
+export function unfold(e: Function | any): any;
 /**
- *
- * @param a
- * @param b
+ * Create enclosed state. Returns functions to getting and cycling between states.
+ * @param {*} a - initial state.
+ * @param {*} b - next state.
+ * @returns {Functions[]} -- [get, toggle];
  */
-export function withSwitch(a: any, b: any): (() => any)[];
+export function withSwitch(a: any, b: any): Functions[];
 /**
- *
- * @param callback
- * @param options
+ * Create a function that will call the provided function only the provided limit.
+ * @param {Function} callback - The callback to call.
+ * @param {object} options - The options to use.
+ * @param {number} options.limit - The limit to call the callback.
+ * @param {number} options.delay - The delay to wait before resetting the call count.
+ * @returns {Function} - The function that will call the callback only the provided limit.
  */
-export function observeOverload(callback: any, options?: {}): () => any;
+export function observeOverload(callback: Function, options?: {
+    limit: number;
+    delay: number;
+}): Function;
 /**
- *
- * @param context
- * @param excludeNested
- * @param excludedTypes
+ * Returns the components that are provided within an evaluation context.
+ * @param {any} context - The evaluation context to get the components from.
+ * @param {boolean} excludeNested - Exclude nested components.
+ * @param {Array<string>} excludedTypes - The types of components to exclude.
+ * @returns {Array} - The components within the evaluation context.
  */
-export function getContextComponents(context: any, excludeNested?: boolean, excludedTypes?: any[]): any[];
+export function getContextComponents(context: any, excludeNested: boolean, excludedTypes?: Array<string>): any[];
 /**
- *
- * @param context
+ * Returns the button components that are within an evaluation context.
+ * @param {any} context - The evaluation context to get the components from.
+ * @returns {Array} - The button components within the evaluation context.
  */
 export function getContextButtons(context: any): any[];
 /**
  * Translates text values in html template.
- * @param {string} template
- * @param {Function} translate
- * @returns {string}
- *   Html template with translated values.
+ * @param {string} template - The template to translate.
+ * @param {Function} translate - The translation function.
+ * @returns {string} - Html template with translated values.
  */
 export function translateHTMLTemplate(template: string, translate: Function): string;
 /**
  * Sanitize an html string.
- * @param string
- * @param options
- * @returns {*}
+ * @param {string} string - The string to sanitize.
+ * @param {any} options - The options to use for sanitization.
+ * @returns {string} - The sanitized html string.
  */
-export function sanitize(string: any, options: any): any;
+export function sanitize(string: string, options: any): string;
 /**
  * Fast cloneDeep for JSON objects only.
- * @param obj
+ * @param {any} obj - The object to perform a fast clone deep against.
+ * @returns {any} - The cloned object.
  */
 export function fastCloneDeep(obj: any): any;
 /**
- *
- * @param componentJson
+ * Returns if the component is an input component.
+ * @param {import('@formio/core').Component} componentJson - The JSON of a component.
+ * @returns {bool} - TRUE if the component is an input component; FALSE otherwise.
  */
-export function isInputComponent(componentJson: any): any;
+export function isInputComponent(componentJson: import('@formio/core').Component): bool;
 /**
- *
- * @param pathStr
+ * Takes a component path, and returns a component path array.
+ * @param {string} pathStr - The path string to convert to an array.
+ * @returns {Arryay<number>} - The array of paths.
  */
-export function getArrayFromComponentPath(pathStr: any): any;
+export function getArrayFromComponentPath(pathStr: string): Arryay<number>;
 /**
- *
- * @param child
- * @param parent
+ * Returns true if the component is a child of the parent.
+ * @param {any} child - The child component to check.
+ * @param {any} parent - The parent component to check.
+ * @returns {boolean} - TRUE if the child is a child of the parent; FALSE otherwise.
  */
 export function isChildOf(child: any, parent: any): boolean;
 /**
- *
- * @param path
+ * Takes an array of component path indexes, and returns a string version of that array.
+ * @param {Array<number>} path - The path array to convert to a string.
+ * @returns {string} - The string version of the path.
  */
-export function getStringFromComponentPath(path: any): any;
+export function getStringFromComponentPath(path: Array<number>): string;
 /**
- *
- * @param number
- * @param precision
+ * Takes a number and rounds it to the provided precision amount.
+ * @param {number} number - The number to round.
+ * @param {number} precision - The precision to round the number to.
+ * @returns {string} - The rounded number.
  */
-export function round(number: any, precision: any): any;
+export function round(number: number, precision: number): string;
 /**
  * Check for Internet Explorer browser version
- * @returns {(number|null)}
+ * @returns {(number|null)} - The IE browser version or null if not IE
  */
 export function getIEBrowserVersion(): (number | null);
 /**
@@ -426,61 +443,67 @@ export function getIEBrowserVersion(): (number | null);
  */
 export function getBrowserInfo(): object;
 /**
- *
- * @param path
+ * Takes a component path, which may include array indicies (i.e. [0][1]), and returns the compoennt path without the indicies.
+ * @param {string} path - The path to remove the indicies from.
+ * @returns {string} - The path without the indicies.
  */
 export function getComponentPathWithoutIndicies(path?: string): string;
 /**
  * Returns a path to the component which based on its schema
- * @param {*} component is a component's schema containing link to its parent's schema in the 'parent' property
- * @param path
+ * @param {import('@formio/core').Component} component - Component containing link to its parent's schema in the 'parent' property
+ * @param {string} path - Path to the component
+ * @returns {string} - Path to the component
  */
-export function getComponentPath(component: any, path?: string): string;
+export function getComponentPath(component: import('@formio/core').Component, path?: string): string;
 /**
  * Returns a parent component of the passed component instance skipping all the Layout components
- * @param {*} componentInstance
- * @returns {(Component|undefined)}
+ * @param {Component} componentInstance - The component to check for the parent.
+ * @returns {Component|undefined} - The parent data component.
  */
-export function getDataParentComponent(componentInstance: any): (Component | undefined);
+export function getDataParentComponent(componentInstance: Component): Component | undefined;
 /**
  * Returns whether the value is a promise
- * @param value
- * @returns {boolean}
+ * @param {any} value - The value to check
+ * @returns {boolean} - TRUE if the value is a promise; FALSE otherwise
  */
 export function isPromise(value: any): boolean;
 /**
  * Determines if the component has a scoping parent in tree (a component which scopes its children and manages its
  * changes by itself, e.g. EditGrid)
- * @param componentInstance
- * @param firstPass
- * @returns {boolean|boolean|*}
+ * @param {Component} componentInstance - The component to check for the scoping parent.
+ * @param {boolean} firstPass - Whether it is the first pass of the function
+ * @returns {boolean|*} - TRUE if the component has a scoping parent; FALSE otherwise
  */
-export function isInsideScopingComponent(componentInstance: any, firstPass?: boolean): boolean | boolean | any;
+export function isInsideScopingComponent(componentInstance: Component, firstPass?: boolean): boolean | any;
 /**
- *
- * @param element
+ * Returns all the focusable elements within the provided dom element.
+ * @param {HTMLElement} element - The element to get the focusable elements from.
+ * @returns {NodeList<HTMLElement>} - The focusable elements within the provided element.
  */
-export function getFocusableElements(element: any): any;
+export function getFocusableElements(element: HTMLElement): NodeList<HTMLElement>;
 /**
- *
- * @param fullSchema
+ * Returns the saved types for the component
+ * @param {import('@formio/core').Component} fullSchema - The component schema
+ * @returns {Array<string>|null} - The saved types for the component
  */
-export function getComponentSavedTypes(fullSchema: any): string[] | null;
+export function getComponentSavedTypes(fullSchema: import('@formio/core').Component): Array<string> | null;
 /**
- *
- * @param template
+ * Returns the template keys inside the template code.
+ * @param {string} template - The template to get the keys from.
+ * @returns {Array<string>} - The keys inside the template.
  */
-export function getItemTemplateKeys(template: any): any[];
+export function getItemTemplateKeys(template: string): Array<string>;
 /**
- *
- * @param comp
+ * Returns if the component is a select resource with an object for its value.
+ * @param {import('@formio/core').Component} comp - The component to check.
+ * @returns {boolean} - TRUE if the component is a select resource with an object for its value; FALSE otherwise.
  */
-export function isSelectResourceWithObjectValue(comp?: {}): any;
+export function isSelectResourceWithObjectValue(comp?: import('@formio/core').Component): boolean;
 export * from "./formUtils";
 /**
  * Map values through unfold and return first non-nil value.
- * @param {Array<T>} collection;
- * @returns {T}
+ * @param {Array<T>} collection - The collection to map through unfold.;
+ * @returns {T} - The first non-nil value.
  */
 export const firstNonNil: any;
 export namespace componentValueTypes {
@@ -492,7 +515,7 @@ export namespace componentValueTypes {
     let date: string;
     let any: string;
 }
-export function interpolateErrors(component: any, errors: FieldError[], interpolateFn: any): [];
+export function interpolateErrors(component: Component, errors: FieldError[], interpolateFn: Function): [];
 import jsonLogic from 'json-logic-js';
 import ConditionOperators from './conditionOperators';
 import { Evaluator } from './Evaluator';