@formio/js 5.0.2 → 5.1.0-dev.5522.066969f

package/lib/cjs/utils/i18n.js

@@ -4,8 +4,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.I18n = void 0;
-const utils_1 = require("@formio/core/utils");
+const Evaluator_1 = require("./Evaluator");
 const i18n_1 = __importDefault(require("../i18n"));
+const lodash_1 = require("lodash");
+const core_1 = require("@formio/core");
 const i18Defaults = {};
 for (const lang in i18n_1.default.resources) {
     if (i18n_1.default.resources.hasOwnProperty(lang)) {
@@ -17,13 +19,28 @@ for (const lang in i18n_1.default.resources) {
  */
 class I18n {
     constructor(languages = {}) {
-        this.languages = i18Defaults;
+        var _a;
+        this.languages = (0, core_1.fastCloneDeep)(I18n.languages || {});
+        this.defaultKeys = ((_a = I18n.languages) === null || _a === void 0 ? void 0 : _a.en) || {};
         this.language = 'en';
         this.currentLanguage = i18Defaults.en;
         this.setLanguages(languages);
         this.changeLanguage(this.language);
     }
-    setLanguages(languages) {
+    static setDefaultTranslations(languages) {
+        if ((0, lodash_1.isEmpty)(languages)) {
+            return;
+        }
+        for (const lang in languages) {
+            if (lang !== 'language' && languages.hasOwnProperty(lang)) {
+                if (!this.languages[lang]) {
+                    this.languages[lang] = {};
+                }
+                this.languages[lang] = Object.assign(Object.assign({}, languages[lang]), this.languages[lang]);
+            }
+        }
+    }
+    setLanguages(languages, noDefaultOverride) {
         if (languages.resources) {
             for (const lang in languages.resources) {
                 if (languages.resources.hasOwnProperty(lang)) {
@@ -50,7 +67,8 @@ class I18n {
                 if (!this.languages[lang]) {
                     this.languages[lang] = {};
                 }
-                this.languages[lang] = Object.assign(Object.assign({}, this.languages[lang]), languages[lang]);
+                this.languages[lang] = noDefaultOverride
+                    ? Object.assign(Object.assign({}, languages[lang]), this.languages[lang]) : Object.assign(Object.assign({}, this.languages[lang]), languages[lang]);
             }
         }
     }
@@ -80,14 +98,23 @@ class I18n {
     }
     t(text, ...args) {
         var _a;
-        if (this.currentLanguage[text]) {
+        let currentTranslation = this.currentLanguage[text];
+        // provide compatibility with cases where the entire phrase is used as a key
+        // get the phrase that is possibly being used as a key
+        const defaultKey = this.defaultKeys[text];
+        if (defaultKey && this.currentLanguage[defaultKey]) {
+            // get translation using the phrase as a key
+            currentTranslation = this.currentLanguage[defaultKey];
+        }
+        if (currentTranslation) {
             const customTranslationFieldName = (_a = args[0]) === null || _a === void 0 ? void 0 : _a.field;
             if (customTranslationFieldName && this.currentLanguage[customTranslationFieldName]) {
                 args[0].field = this.currentLanguage[customTranslationFieldName];
             }
-            return utils_1.Evaluator.interpolateString(this.currentLanguage[text], ...args);
+            return Evaluator_1.Evaluator.interpolateString(currentTranslation, ...args);
         }
-        return utils_1.Evaluator.interpolateString(text, ...args);
+        return Evaluator_1.Evaluator.interpolateString(text, ...args);
     }
 }
 exports.I18n = I18n;
+I18n.languages = i18Defaults;

package/lib/cjs/utils/index.d.ts

@@ -1,3 +1,170 @@
-export { FormioUtils as Utils };
+export * from "./utils";
+export * from "./formUtils";
 export default FormioUtils;
-import * as FormioUtils from './utils';
+declare const FormioUtils: {
+    Evaluator: import("./Evaluator").DefaultEvaluator;
+    interpolate: typeof interpolate;
+    ConditionOperators: {
+        [x: string]: typeof import("./conditionOperators/IsEqualTo").default | typeof import("./conditionOperators/DateGreaterThan").default;
+    };
+    _: any;
+    moment: typeof moment;
+    flattenComponents: typeof import("@formio/core/lib/utils/formUtil").flattenComponents;
+    guid: typeof import("@formio/core/lib/utils/formUtil").guid;
+    uniqueName: typeof import("@formio/core/lib/utils/formUtil").uniqueName;
+    MODEL_TYPES_OF_KNOWN_COMPONENTS: {
+        nestedArray: string[];
+        nestedDataArray: string[];
+        dataObject: string[];
+        object: string[];
+        map: string[];
+        content: string[];
+        string: string[];
+        number: string[];
+        boolean: string[];
+        none: string[];
+        any: string[];
+    };
+    getModelType: typeof import("@formio/core/lib/utils/formUtil").getModelType;
+    getComponentPath: any;
+    setComponentScope: typeof import("@formio/core/lib/utils/formUtil").setComponentScope;
+    resetComponentScope: typeof import("@formio/core/lib/utils/formUtil").resetComponentScope;
+    isComponentNestedDataType: typeof import("@formio/core/lib/utils/formUtil").isComponentNestedDataType;
+    componentPath: typeof import("@formio/core/lib/utils/formUtil").componentPath;
+    getComponentPaths: typeof import("@formio/core/lib/utils/formUtil").getComponentPaths;
+    componentMatches: typeof import("@formio/core/lib/utils/formUtil").componentMatches;
+    getBestMatch: typeof import("@formio/core/lib/utils/formUtil").getBestMatch;
+    getComponentFromPath: typeof import("@formio/core/lib/utils/formUtil").getComponentFromPath;
+    getComponentValue: typeof import("@formio/core/lib/utils/formUtil").getComponentValue;
+    findComponents: typeof import("@formio/core/lib/utils/formUtil").findComponents;
+    eachComponentDataAsync: (components: import("@formio/core").Component[], data: import("@formio/core").DataObject, fn: import("@formio/core").EachComponentDataAsyncCallback, includeAll?: boolean | undefined, local?: boolean | undefined, parent?: import("@formio/core").Component | undefined, parentPaths?: import("@formio/core").ComponentPaths | undefined) => Promise<void>;
+    eachComponentData: (components: import("@formio/core").Component[], data: import("@formio/core").DataObject, fn: import("@formio/core").EachComponentDataCallback, includeAll?: boolean | undefined, local?: boolean | undefined, parent?: import("@formio/core").Component | undefined, parentPaths?: import("@formio/core").ComponentPaths | undefined) => void;
+    getComponentKey: typeof import("@formio/core/lib/utils/formUtil").getComponentKey;
+    getContextualRowPath: typeof import("@formio/core/lib/utils/formUtil").getContextualRowPath;
+    getContextualRowData: typeof import("@formio/core/lib/utils/formUtil").getContextualRowData;
+    componentInfo: typeof import("@formio/core/lib/utils/formUtil").componentInfo;
+    eachComponent: typeof import("@formio/core/lib/utils/formUtil").eachComponent;
+    eachComponentAsync: typeof import("@formio/core/lib/utils/formUtil").eachComponentAsync;
+    getComponentData: typeof import("@formio/core/lib/utils/formUtil").getComponentData;
+    getComponentActualValue: any;
+    isLayoutComponent: typeof import("@formio/core/lib/utils/formUtil").isLayoutComponent;
+    matchComponent: typeof import("@formio/core/lib/utils/formUtil").matchComponent;
+    getComponent: typeof import("@formio/core/lib/utils/formUtil").getComponent;
+    searchComponents: typeof import("@formio/core/lib/utils/formUtil").searchComponents;
+    removeComponent: typeof import("@formio/core/lib/utils/formUtil").removeComponent;
+    hasCondition: typeof import("@formio/core/lib/utils/formUtil").hasCondition;
+    parseFloatExt: typeof import("@formio/core/lib/utils/formUtil").parseFloatExt;
+    formatAsCurrency: typeof import("@formio/core/lib/utils/formUtil").formatAsCurrency;
+    escapeRegExCharacters: typeof import("@formio/core/lib/utils/formUtil").escapeRegExCharacters;
+    getValue: typeof import("@formio/core/lib/utils/formUtil").getValue;
+    getStrings: typeof import("@formio/core/lib/utils/formUtil").getStrings;
+    generateFormChange: typeof import("@formio/core/lib/utils/formUtil").generateFormChange;
+    applyFormChanges: typeof import("@formio/core/lib/utils/formUtil").applyFormChanges;
+    findComponent: typeof import("@formio/core/lib/utils/formUtil").findComponent;
+    getEmptyValue: typeof import("@formio/core/lib/utils/formUtil").getEmptyValue;
+    isComponentDataEmpty: typeof import("@formio/core/lib/utils/formUtil").isComponentDataEmpty;
+    isSelectResourceWithObjectValue: typeof import("@formio/core/lib/utils/formUtil").isSelectResourceWithObjectValue;
+    compareSelectResourceWithObjectTypeValues: typeof import("@formio/core/lib/utils/formUtil").compareSelectResourceWithObjectTypeValues;
+    getItemTemplateKeys: typeof import("@formio/core/lib/utils/formUtil").getItemTemplateKeys;
+    evaluate(func: string | object | Function, args: any, ret: string, interpolate: boolean, options?: import("@formio/core").EvaluatorOptions): any;
+    getRandomComponentId(): string;
+    getPropertyValue(style: CSSStyleDeclaration, prop: string): number;
+    getElementRect(element: HTMLElement): {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
+    getScriptPlugin(property: string): any;
+    boolValue(value: string | boolean): boolean;
+    isMongoId(text: string): boolean;
+    checkCalculated(component: import("@formio/core").Component, submission: import("@formio/core").Submission, rowData: any): void;
+    checkSimpleConditional(component: any, condition: any, row: any, data: any, instance: any): boolean;
+    checkCustomConditional(component: import("@formio/core").Component, custom: string, row: any, data: any, form: import("@formio/core").Form, variable: string, onError: any, instance: any): any;
+    checkJsonConditional(component: import("@formio/core").Component, json: import("@formio/core").JSONConditional, row: any, data: any, form: import("@formio/core").Form, onError: any): boolean;
+    checkCondition(component: import("@formio/core").Component, row: any, data: any, form: import("@formio/core").Form, instance: any): boolean;
+    checkTrigger(component: import("@formio/core").Component, trigger: any, row: import("@formio/core").DataObject, data: import("@formio/core").DataObject, form: import("@formio/core").Form, instance: any): boolean;
+    setActionProperty(component: import("@formio/core").Component, action: any, result: string, row: import("@formio/core").DataObject, data: import("@formio/core").DataObject, instance: any): import("@formio/core").Component;
+    removeHTML(str: string): string;
+    unescapeHTML(str: string): string;
+    convertStringToHTMLElement(str: string, selector: string): HTMLElement;
+    getDateSetting(date: string | Date): import("dayjs").Dayjs | null;
+    isValidDate(date: string | Date): boolean;
+    currentTimezone(): string;
+    offsetDate(date: Date, timezone: string): {
+        date: Date;
+        abbr: string;
+    };
+    shouldHandleTimezone(timezone: string): boolean;
+    dayjsDate(value: string | Date, format: string, timezone: string, options: object): import("dayjs").Dayjs;
+    formatDate(value: string | Date, format: string, timezone: string, flatPickrInputFormat: string): string;
+    formatOffset(formatFn: Function, date: string | Date, format: string, timezone: string): string;
+    getLocaleDateFormatInfo(locale: Intl.LocalesArgument): object;
+    convertFormatToFlatpickr(format: string): string;
+    convertFormatToDayjs(format: string): string;
+    convertFormatToMask(format: string): string;
+    getInputMask(mask: string, placeholderChar: string): any[];
+    unmaskValue(value: string, mask: string, placeholderChar: string): string;
+    matchInputMask(value: string, inputMask: string): boolean;
+    getNumberSeparators(lang?: string): {
+        delimiter: string;
+        decimalSeparator: string;
+    };
+    getNumberDecimalLimit(component: import("@formio/core").Component, defaultLimit: number): number;
+    getCurrencyAffixes({ currency, decimalLimit, decimalSeparator, lang, }: {
+        currency: string;
+        decimalLimit: number;
+        decimalSeparator: string;
+        lang: string;
+    }): {
+        prefix: string;
+        suffix: string;
+    };
+    fieldData(data: import("@formio/core").DataObject, component: import("@formio/core").Component): any;
+    delay(fn: Function, delay?: number, ...args: any[]): any;
+    iterateKey(key: string): string;
+    uniqueKey(map: Record<string, string>, base: string): string;
+    bootstrapVersion(options: {
+        bootstrap: string;
+    }): number;
+    unfold(e: any): any;
+    withSwitch(a: any, b: any): Functions[];
+    observeOverload(callback: Function, options?: {
+        limit: number;
+        delay: number;
+    }): Function;
+    getContextComponents(context: any, excludeNested: boolean, excludedTypes?: string[]): any[];
+    getContextButtons(context: any): any[];
+    translateHTMLTemplate(template: string, translate: Function): string;
+    sanitize(string: string, options: any): string;
+    fastCloneDeep(obj: any): any;
+    isInputComponent(componentJson: import("@formio/core").Component): boolean;
+    getArrayFromComponentPath(pathStr: string): string[];
+    isChildOf(child: any, parent: any): boolean;
+    getStringFromComponentPath(path: number[]): string;
+    round(number: number, precision: number): string;
+    getIEBrowserVersion(): number | null;
+    getBrowserInfo(): object;
+    getComponentPathWithoutIndicies(path?: string): string;
+    getDataParentComponent(componentInstance: Component): any;
+    isPromise(value: any): boolean;
+    getFocusableElements(element: HTMLElement): NodeList<HTMLElement>;
+    getComponentSavedTypes(fullSchema: import("@formio/core").Component): string[] | null;
+    hasEncodedTimezone(value: string): boolean;
+    firstNonNil: any;
+    componentValueTypes: {
+        number: string;
+        string: string;
+        boolean: string;
+        array: string;
+        object: string;
+        date: string;
+        any: string;
+    };
+    interpolateErrors: (component: Component, errors: FieldError[], interpolateFn: Function) => [];
+};
+import { Evaluator } from './Evaluator';
+import { registerEvaluator } from './Evaluator';
+import { interpolate } from './Evaluator';
+import moment from 'moment';
+export { FormioUtils as Utils, Evaluator, registerEvaluator };

package/lib/cjs/utils/index.js

@@ -22,11 +22,31 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Utils = void 0;
-const FormioUtils = __importStar(require("./utils"));
+exports.registerEvaluator = exports.Evaluator = exports.Utils = void 0;
+const utils = __importStar(require("./utils"));
+const formUtils = __importStar(require("./formUtils"));
+const Evaluator_1 = require("./Evaluator");
+Object.defineProperty(exports, "Evaluator", { enumerable: true, get: function () { return Evaluator_1.Evaluator; } });
+Object.defineProperty(exports, "registerEvaluator", { enumerable: true, get: function () { return Evaluator_1.registerEvaluator; } });
+const conditionOperators_1 = __importDefault(require("./conditionOperators"));
+const lodash_1 = __importDefault(require("lodash"));
+const moment_1 = __importDefault(require("moment"));
+const FormioUtils = Object.assign(Object.assign(Object.assign({}, utils), formUtils), { Evaluator: Evaluator_1.Evaluator,
+    interpolate: Evaluator_1.interpolate,
+    ConditionOperators: conditionOperators_1.default,
+    _: lodash_1.default,
+    moment: moment_1.default });
 exports.Utils = FormioUtils;
 if (typeof global === 'object') {
     global.FormioUtils = FormioUtils;
 }
+__exportStar(require("./utils"), exports);
+__exportStar(require("./formUtils"), exports);
 exports.default = FormioUtils;

package/lib/cjs/utils/utils.d.ts

@@ -164,9 +164,9 @@ export function guid(): string;
 /**
  * Return a translated date setting.
  * @param {string|Date} date - The date to translate.
- * @returns {(null|Date)} - The translated date.
+ * @returns {(null|dayjs.Dayjs)} - The translated date.
  */
-export function getDateSetting(date: string | Date): (null | Date);
+export function getDateSetting(date: string | Date): (null | dayjs.Dayjs);
 /**
  * Returns true if the date is a valid date. False otherwise.
  * @param {Date|string} date - The date to check for validity.
@@ -182,55 +182,45 @@ export function currentTimezone(): string;
  * Get an offset date provided a date object and timezone object.
  * @param {Date} date - The date to offset.
  * @param {string} timezone - The timezone to offset the date to.
- * @returns {Date} - The offset date.
+ * @returns {{date: Date, abbr: string}} - The offset date.
  */
-export function offsetDate(date: Date, timezone: string): Date;
-/**
- * Returns if the zones are loaded.
- * @returns {boolean} - TRUE if the zones are loaded; FALSE otherwise.
- */
-export function zonesLoaded(): boolean;
+export function offsetDate(date: Date, timezone: string): {
+    date: Date;
+    abbr: string;
+};
 /**
- * Returns if we should load the zones.
+ * Returns if we should handle a timezone difference.
  * @param {string} timezone - The timezone to check if we should load the zones.
- * @returns {boolean} - TRUE if we should load the zones; FALSE otherwise.
- */
-export function shouldLoadZones(timezone: string): boolean;
-/**
- * Externally load the timezone data.
- * @param {string} url - The URL to load the timezone data from.
- * @param {string} timezone - The timezone to load.
- * @returns {Promise<any> | *} - Resolves when the zones for this timezone are loaded.
+ * @returns {boolean} - TRUE if we should handle timezones; FALSE otherwise.
  */
-export function loadZones(url: string, timezone: string): Promise<any> | any;
+export function shouldHandleTimezone(timezone: string): boolean;
 /**
- * Get the moment date object for translating dates with timezones.
- * @param {string|Date} value - The value to convert into a moment date.
+ * Get the Dayjs date object for translating dates with timezones.
+ * @param {string|Date} value - The value to convert into a dayjs date.
  * @param {string} format - The format to convert the date to.
  * @param {string} timezone - The timezone to convert the date to.
- * @returns {Date} - The moment date object.
+ * @param {object} options - The options object
+ * @returns {dayjs.Dayjs} - The dayjs date object.
  */
-export function momentDate(value: string | Date, format: string, timezone: string): Date;
+export function dayjsDate(value: string | Date, format: string, timezone: string, options: object): dayjs.Dayjs;
 /**
  * Format a date provided a value, format, and timezone object.
- * @param {string} timezonesUrl - The URL to load the timezone data from.
  * @param {string|Date} value - The value to format.
  * @param {string} format - The format to format the date to.
  * @param {string} timezone - The timezone to format the date to.
  * @param {string} flatPickrInputFormat - The format to use for flatpickr input.
  * @returns {string} - The formatted date.
  */
-export function formatDate(timezonesUrl: string, value: string | Date, format: string, timezone: string, flatPickrInputFormat: string): string;
+export function formatDate(value: string | Date, format: string, timezone: string, flatPickrInputFormat: string): string;
 /**
  * Pass a format function to format within a timezone.
- * @param {string} timezonesUrl - The URL to load the timezone data from.
  * @param {Function} formatFn - The format function to use.
  * @param {Date|string} date - The date to format.
  * @param {string} format - The format to format the date to.
  * @param {string} timezone - The timezone to format the date to.
  * @returns {string} - The formatted date.
  */
-export function formatOffset(timezonesUrl: string, formatFn: Function, date: Date | string, format: string, timezone: string): string;
+export function formatOffset(formatFn: Function, date: Date | string, format: string, timezone: string): string;
 /**
  * Returns the local date format information.
  * @param {Intl.LocalesArgument} locale - The locale to get the date format for.
@@ -248,7 +238,7 @@ export function convertFormatToFlatpickr(format: string): string;
  * @param {string} format - The format to convert.
  * @returns {string} - The converted format.
  */
-export function convertFormatToMoment(format: string): string;
+export function convertFormatToDayjs(format: string): string;
 /**
  * Convert the format from the angular-datepicker module to mask format.
  * @param {string} format - The format to convert.
@@ -413,15 +403,15 @@ export function fastCloneDeep(obj: any): any;
 /**
  * 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.
+ * @returns {boolean} - TRUE if the component is an input component; FALSE otherwise.
  */
-export function isInputComponent(componentJson: import('@formio/core').Component): bool;
+export function isInputComponent(componentJson: import('@formio/core').Component): boolean;
 /**
  * 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.
+ * @returns {Array<string>} - The array of paths.
  */
-export function getArrayFromComponentPath(pathStr: string): Arryay<number>;
+export function getArrayFromComponentPath(pathStr: string): Array<string>;
 /**
  * Returns true if the component is a child of the parent.
  * @param {any} child - The child component to check.
@@ -462,10 +452,9 @@ export function getComponentPathWithoutIndicies(path?: string): string;
 /**
  * Returns a path to the component which based on its schema
  * @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: import('@formio/core').Component, path?: string): string;
+export function getComponentPath(component: import('@formio/core').Component): string;
 /**
  * Returns a parent component of the passed component instance skipping all the Layout components
  * @param {Component} componentInstance - The component to check for the parent.
@@ -478,14 +467,6 @@ export function getDataParentComponent(componentInstance: Component): Component
  * @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 {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: Component, firstPass?: boolean): boolean | any;
 /**
  * Returns all the focusable elements within the provided dom element.
  * @param {HTMLElement} element - The element to get the focusable elements from.
@@ -498,7 +479,15 @@ export function getFocusableElements(element: HTMLElement): NodeList<HTMLElement
  * @returns {Array<string>|null} - The saved types for the component
  */
 export function getComponentSavedTypes(fullSchema: import('@formio/core').Component): Array<string> | null;
-export * from "./formUtils";
+/**
+ * Checks if a string has timezone information encoded in it
+ * Example: 2024-01-01T00:00:00Z -> true
+ * Example: 2024-01-01T00:00:00+03:00 -> true
+ * Example: 2011-05-03T00:00:00 -> false
+ * @param {string} value the string value to check
+ * @returns {boolean} if value has encoded timezone
+ */
+export function hasEncodedTimezone(value: string): boolean;
 /**
  * Map values through unfold and return first non-nil value.
  * @param {Array<T>} collection - The collection to map through unfold.;
@@ -515,8 +504,4 @@ export namespace componentValueTypes {
     let any: string;
 }
 export function interpolateErrors(component: Component, errors: FieldError[], interpolateFn: Function): [];
-import jsonLogic from 'json-logic-js';
-import ConditionOperators from './conditionOperators';
-import { Evaluator } from './Evaluator';
-export const interpolate: typeof Evaluator.interpolate;
-export { jsonLogic, ConditionOperators, moment, Evaluator, _ };
+import dayjs from "dayjs";