@formio/js 5.0.0-dev.5610.c46fab6 → 5.0.0-dev.5613.3476921

package/lib/mjs/providers/storage/util.js

@@ -1,21 +1,3 @@
-/**
- * @typedef {any[]} Args
- */
-/**
- * Function to be retried
- * @callback RetryFunction
- * @param {...Args} args
- * @returns {Promise<any>}
- */
-/**
- * Executes a function with retries in case of failure.
- * @param {RetryFunction} fn - The function to be executed.
- * @param {Args} args - The arguments to be passed to the function.
- * @param {number} [retries] - The number of retries in case of failure.
- * @param {string} [err] - The error message to be thrown after all retries have failed.
- * @returns {Promise<any>} The result of the function execution.
- * @throws {Error} When all retries have failed.
- */
 export async function withRetries(fn, args, retries = 3, err = null) {
     if (!retries) {
         throw new Error(err);

package/lib/mjs/templates/Templates.d.ts

@@ -1,2 +1 @@
 export default Template;
-import { Template } from '@formio/core/experimental';

package/lib/mjs/translations/en.d.ts

@@ -71,5 +71,6 @@ declare namespace _default {
     let submitButtonAriaLabel: string;
     let reCaptchaTokenValidationError: string;
     let reCaptchaTokenNotSpecifiedError: string;
+    let apiKey: string;
 }
 export default _default;

package/lib/mjs/translations/en.js

@@ -71,4 +71,5 @@ export default {
     submitButtonAriaLabel: 'Submit Form button. Click to submit the form',
     reCaptchaTokenValidationError: 'ReCAPTCHA: Token validation error',
     reCaptchaTokenNotSpecifiedError: 'ReCAPTCHA: Token is not specified in submission',
+    apiKey: 'API Key is not unique: {{key}}'
 };

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

@@ -1,7 +1,4 @@
-export class Evaluator {
-    static cache: {};
-    static protectedEval: boolean;
-    static noeval: boolean;
-    static template(template: any, hash: any): any;
-    static interpolate(rawTemplate: any, data: any, _options: any): any;
+export default Evaluator;
+declare namespace Evaluator {
+    function registerEvaluator(evaluator: any): void;
 }

package/lib/mjs/utils/Evaluator.js

@@ -1,11 +1,13 @@
 import _ from 'lodash';
 import stringHash from 'string-hash';
-import { JSONLogicEvaluator as CoreEvaluator } from '@formio/core/utils';
-export class Evaluator extends CoreEvaluator {
-    static cache = {};
-    static protectedEval = false;
-    static noeval = false;
-    static template(template, hash) {
+import { Evaluator as CoreEvaluator } from '@formio/core/utils';
+const Evaluator = {
+    noeval: false,
+    protectedEval: false, // This property can be customized only by plugins
+    cache: {},
+    templateSettings: CoreEvaluator.templateSettings,
+    evaluator: CoreEvaluator.evaluator,
+    template(template, hash) {
         hash = hash || stringHash(template);
         if (Evaluator.cache[hash]) {
             return Evaluator.cache[hash];
@@ -18,8 +20,8 @@ export class Evaluator extends CoreEvaluator {
         catch (err) {
             console.warn('Error while processing template', err, template);
         }
-    }
-    static interpolate(rawTemplate, data, _options) {
+    },
+    interpolate(rawTemplate, data, _options) {
         // Ensure reverse compatability.
         const options = _.isObject(_options) ? _options : { noeval: _options };
         if (typeof rawTemplate === 'function') {
@@ -49,5 +51,14 @@ export class Evaluator extends CoreEvaluator {
             }
         }
         return template;
+    },
+    evaluate(func, args) {
+        return Array.isArray(args) ? func(...args) : func(args);
     }
-}
+};
+Evaluator.registerEvaluator = (evaluator) => {
+    Object.keys(evaluator).forEach((key) => {
+        Evaluator[key] = evaluator[key];
+    });
+};
+export default Evaluator;

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

@@ -1,19 +1,17 @@
 declare namespace _default {
     /**
      * Appends a number to a component.key to keep it unique
-     * @param {import('@formio/core').Component[]} container - The container of components to uniquify against
-     * @param {import('@formio/core').Component} component - The Component to uniqify.
-     * @returns {boolean} - If the component was changed.
+     *
+     * @param {Object} form
+     *   The components parent form.
+     * @param {Object} component
+     *   The component to uniquify
      */
-    function uniquify(container: import("@formio/core").Component[], component: import("@formio/core").Component): boolean;
+    function uniquify(container: any, component: Object): boolean;
     namespace additionalShortcuts {
         let button: string[];
     }
-    /**
-     * Returns the alpha character shortcuts.
-     * @returns {string[]} - An array of shortcuts of alpha characters.
-     */
-    function getAlphaShortcuts(): string[];
+    function getAlphaShortcuts(): any;
     function getAdditionalShortcuts(type: any): any;
     function getBindedShortcuts(components: any, input: any): any[];
     function getAvailableShortcuts(form: any, component: any): {

package/lib/mjs/utils/builder.js

@@ -3,9 +3,11 @@ import { eachComponent, uniqueKey } from './utils';
 export default {
     /**
      * Appends a number to a component.key to keep it unique
-     * @param {import('@formio/core').Component[]} container - The container of components to uniquify against
-     * @param {import('@formio/core').Component} component - The Component to uniqify.
-     * @returns {boolean} - If the component was changed.
+     *
+     * @param {Object} form
+     *   The components parent form.
+     * @param {Object} component
+     *   The component to uniquify
      */
     uniquify(container, component) {
         let changed = false;
@@ -34,19 +36,12 @@ export default {
         }, true);
         return changed;
     },
-    /**
-     * Additional shortcuts for the builder.
-     */
     additionalShortcuts: {
         button: [
             'Enter',
             'Esc'
         ]
     },
-    /**
-     * Returns the alpha character shortcuts.
-     * @returns {string[]} - An array of shortcuts of alpha characters.
-     */
     getAlphaShortcuts() {
         return _.range('A'.charCodeAt(), 'Z'.charCodeAt() + 1).map((charCode) => String.fromCharCode(charCode));
     },

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

@@ -1,14 +1,15 @@
 /**
  * Checks the value for a min date and max date.
+ *
  * @param {moment} value
  *   The value to check.
- * @param {[string]} format
+ * @param {[String]} format
  *   A moment formats.
  * @param {Date} maxDate
  *   The max date.
  * @param {Date} minDate
  *   The min date.
- * @returns {{message: string, result: boolean}} - The response object.
+ * * @return {{message: string, result: boolean}}
  */
 export function lessOrGreater(value: typeof moment, format: [string], maxDate: Date, minDate: Date): {
     message: string;
@@ -16,11 +17,16 @@ export function lessOrGreater(value: typeof moment, format: [string], maxDate: D
 };
 /**
  * Checks the entered date for validity.
- * @param {string} value - The value to check.
- * @param {[string]} format - A moment formats.
- * @param {Date} minDate - The minimum date.
- * @param {Date} maxDate - The maximum date.
- * @returns {{message: string, result: boolean}} - The response object.
+ *
+ * @param {String} value
+ *   The value to check.
+ * @param {[String]} format
+ *   A moment formats.
+ * @param {Date} maxDate
+ *   The max date.
+ * @param {Date} minDate
+ *   The min date.
+ * * @return {{message: string, result: boolean}}
  */
 export function checkInvalidDate(value: string, format: [string], minDate: Date, maxDate: Date): {
     message: string;

package/lib/mjs/utils/calendarUtils.js

@@ -12,11 +12,12 @@ export const CALENDAR_ERROR_MESSAGES = {
 };
 /**
  * Builds the response for checkInvalidDate.
- * @param {string} message
+ *
+ * @param {String} message
  *   The message for response.
- * @param {boolean} result
+ * @param {Boolean} result
  *   The boolean flag for response.
- * @returns {{message: string, result: boolean}} - The response object.
+ * * @return {{message: string, result: boolean}}
  */
 function buildResponse(message, result) {
     return {
@@ -26,15 +27,16 @@ function buildResponse(message, result) {
 }
 /**
  * Checks the value for a min date and max date.
+ *
  * @param {moment} value
  *   The value to check.
- * @param {[string]} format
+ * @param {[String]} format
  *   A moment formats.
  * @param {Date} maxDate
  *   The max date.
  * @param {Date} minDate
  *   The min date.
- * @returns {{message: string, result: boolean}} - The response object.
+ * * @return {{message: string, result: boolean}}
  */
 export function lessOrGreater(value, format, maxDate, minDate) {
     let message = '';
@@ -60,11 +62,16 @@ export function lessOrGreater(value, format, maxDate, minDate) {
 }
 /**
  * Checks the entered date for validity.
- * @param {string} value - The value to check.
- * @param {[string]} format - A moment formats.
- * @param {Date} minDate - The minimum date.
- * @param {Date} maxDate - The maximum date.
- * @returns {{message: string, result: boolean}} - The response object.
+ *
+ * @param {String} value
+ *   The value to check.
+ * @param {[String]} format
+ *   A moment formats.
+ * @param {Date} maxDate
+ *   The max date.
+ * @param {Date} minDate
+ *   The min date.
+ * * @return {{message: string, result: boolean}}
  */
 export function checkInvalidDate(value, format, minDate, maxDate) {
     const date = moment(value, format, true);

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

@@ -1,45 +1,173 @@
+/**
+ * Determine if a component is a layout component or not.
+ *
+ * @param {Object} component
+ *   The component to check.
+ *
+ * @returns {Boolean}
+ *   Whether or not the component is a layout component.
+ */
+export function isLayoutComponent(component: Object): boolean;
+/**
+ * Iterate through each component within a form.
+ *
+ * @param {Object} components
+ *   The components to iterate.
+ * @param {Function} fn
+ *   The iteration function to invoke for each component.
+ * @param {Boolean} includeAll
+ *   Whether or not to include layout components.
+ * @param {String} path
+ *   The current data path of the element. Example: data.user.firstName
+ * @param {Object} parent
+ *   The parent object.
+ */
+export function eachComponent(components: Object, fn: Function, includeAll: boolean, path: string, parent: Object, inRecursion: any): void;
+/**
+ * Matches if a component matches the query.
+ *
+ * @param component
+ * @param query
+ * @return {boolean}
+ */
+export function matchComponent(component: any, query: any): boolean;
+/**
+ * Get a component by its key
+ *
+ * @param {Object} components
+ *   The components to iterate.
+ * @param {String|Object} key
+ *   The key of the component to get, or a query of the component to search.
+ *
+ * @returns {Object}
+ *   The component that matches the given key, or undefined if not found.
+ */
+export function getComponent(components: Object, key: string | Object, includeAll: any): Object;
+/**
+ * Finds a component provided a query of properties of that component.
+ *
+ * @param components
+ * @param query
+ * @return {*}
+ */
+export function searchComponents(components: any, query: any): any;
 /**
  * Deprecated version of findComponents. Renamed to searchComponents.
- * @param {import('@formio/core').Component[]} components - The components to find components within.
- * @param {object} query - The query to use when searching for the components.
- * @returns {import('@formio/core').Component[]} - The result of the component that is found.
- */
-export function findComponents(components: import('@formio/core').Component[], query: object): import('@formio/core').Component[];
-export const flattenComponents: typeof Utils.flattenComponents;
-export const guid: typeof Utils.guid;
-export const uniqueName: typeof Utils.uniqueName;
-export const MODEL_TYPES: Record<string, string[]>;
-export const getModelType: typeof Utils.getModelType;
-export const getComponentAbsolutePath: typeof Utils.getComponentAbsolutePath;
-export const getComponentPath: typeof Utils.getComponentPath;
-export const isComponentModelType: typeof Utils.isComponentModelType;
-export const isComponentNestedDataType: typeof Utils.isComponentNestedDataType;
-export const componentPath: typeof Utils.componentPath;
-export const componentChildPath: any;
-export const eachComponentDataAsync: (components: Component[], data: DataObject, fn: AsyncComponentDataCallback, path?: string | undefined, index?: number | undefined, parent?: any, includeAll?: boolean | undefined) => Promise<void>;
-export const eachComponentData: (components: Component[], data: DataObject, fn: ComponentDataCallback, path?: string | undefined, index?: number | undefined, parent?: any, includeAll?: boolean | undefined) => void;
-export const getComponentKey: typeof Utils.getComponentKey;
-export const getContextualRowPath: typeof Utils.getContextualRowPath;
-export const getContextualRowData: typeof Utils.getContextualRowData;
-export const componentInfo: typeof Utils.componentInfo;
-export const eachComponent: typeof Utils.eachComponent;
-export const eachComponentAsync: typeof Utils.eachComponentAsync;
-export const getComponentData: typeof Utils.getComponentData;
-export const getComponentActualValue: typeof Utils.getComponentActualValue;
-export const isLayoutComponent: typeof Utils.isLayoutComponent;
-export const matchComponent: typeof Utils.matchComponent;
-export const getComponent: typeof Utils.getComponent;
-export const searchComponents: typeof Utils.searchComponents;
-export const removeComponent: typeof Utils.removeComponent;
-export const hasCondition: typeof Utils.hasCondition;
-export const parseFloatExt: typeof Utils.parseFloatExt;
-export const formatAsCurrency: typeof Utils.formatAsCurrency;
-export const escapeRegExCharacters: typeof Utils.escapeRegExCharacters;
-export const getValue: typeof Utils.getValue;
-export const getStrings: typeof Utils.getStrings;
-export const generateFormChange: typeof Utils.generateFormChange;
-export const applyFormChanges: typeof Utils.applyFormChanges;
-export const findComponent: typeof Utils.findComponent;
-export const getEmptyValue: typeof Utils.getEmptyValue;
-export const isComponentDataEmpty: typeof Utils.isComponentDataEmpty;
-import { Utils } from '@formio/core';
+ *
+ * @param components
+ * @param query
+ * @returns {*}
+ */
+export function findComponents(components: any, query: any): any;
+/**
+ * This function will find a component in a form and return the component AND THE PATH to the component in the form.
+ * Path to the component is stored as an array of nested components and their indexes.The Path is being filled recursively
+ * when you iterating through the nested structure.
+ * If the component is not found the callback won't be called and function won't return anything.
+ *
+ * @param components
+ * @param key
+ * @param fn
+ * @param path
+ * @returns {*}
+ */
+export function findComponent(components: any, key: any, path: any, fn: any): any;
+/**
+ * Remove a component by path.
+ *
+ * @param components
+ * @param path
+ */
+export function removeComponent(components: any, path: any): void;
+export function generateFormChange(type: any, data: any): {
+    op: string;
+    key: any;
+    container: any;
+    path: any;
+    index: any;
+    component: any;
+    patches?: undefined;
+} | {
+    op: string;
+    key: any;
+    patches: import("fast-json-patch").Operation[];
+    container?: undefined;
+    path?: undefined;
+    index?: undefined;
+    component?: undefined;
+} | {
+    op: string;
+    key: any;
+    container?: undefined;
+    path?: undefined;
+    index?: undefined;
+    component?: undefined;
+    patches?: undefined;
+} | null | undefined;
+export function applyFormChanges(form: any, changes: any): {
+    form: any;
+    failed: any[];
+};
+/**
+ * Flatten the form components for data manipulation.
+ *
+ * @param {Object} components
+ *   The components to iterate.
+ * @param {Boolean} includeAll
+ *   Whether or not to include layout components.
+ *
+ * @returns {Object}
+ *   The flattened components map.
+ */
+export function flattenComponents(components: Object, includeAll?: boolean): Object;
+/**
+ * Returns if this component has a conditional statement.
+ *
+ * @param component - The component JSON schema.
+ *
+ * @returns {boolean} - TRUE - This component has a conditional, FALSE - No conditional provided.
+ */
+export function hasCondition(component: any): boolean;
+/**
+ * Extension of standard #parseFloat(value) function, that also clears input string.
+ *
+ * @param {any} value
+ *   The value to parse.
+ *
+ * @returns {Number}
+ *   Parsed value.
+ */
+export function parseFloatExt(value: any): number;
+/**
+ * Formats provided value in way how Currency component uses it.
+ *
+ * @param {any} value
+ *   The value to format.
+ *
+ * @returns {String}
+ *   Value formatted for Currency component.
+ */
+export function formatAsCurrency(value: any): string;
+/**
+ * Escapes RegEx characters in provided String value.
+ *
+ * @param {String} value
+ *   String for escaping RegEx characters.
+ * @returns {string}
+ *   String with escaped RegEx characters.
+ */
+export function escapeRegExCharacters(value: string): string;
+/**
+ * Get the value for a component key, in the given submission.
+ *
+ * @param {Object} submission
+ *   A submission object to search.
+ * @param {String} key
+ *   A for components API key to search for.
+ */
+export function getValue(submission: Object, key: string): any;
+/**
+ * Iterate over all components in a form and get string values for translation.
+ * @param form
+ */
+export function getStrings(form: any): any[];