@formio/js 5.0.0-dev.5956.0e71b6d → 5.0.0-dev.5957.bed9ce0

package/lib/cjs/translations/en.js

@@ -1,83 +1,10 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = {
-    unsavedRowsError: 'Please save all rows before proceeding.',
-    invalidRowsError: 'Please correct invalid rows before proceeding.',
-    invalidRowError: 'Invalid row. Please correct it or delete.',
-    invalidOption: '{{field}} is an invalid value.',
-    invalidDay: '{{field}} is not a valid day.',
-    alertMessageWithLabel: '{{label}}: {{message}}',
-    alertMessage: '{{message}}',
-    complete: 'Submission Complete',
-    error: 'Please fix the following errors before submitting.',
-    errorListHotkey: 'Press Ctrl + Alt + X to go back to the error list.',
-    errorsListNavigationMessage: 'Click to navigate to the field with following error.',
-    submitError: 'Please check the form and correct all errors before submitting.',
-    required: '{{field}} is required',
-    unique: '{{field}} must be unique',
-    array: '{{field}} must be an array',
-    array_nonempty: '{{field}} must be a non-empty array', // eslint-disable-line camelcase
-    nonarray: '{{field}} must not be an array',
-    select: '{{field}} contains an invalid selection',
-    pattern: '{{field}} does not match the pattern {{pattern}}',
-    minLength: '{{field}} must have at least {{length}} characters.',
-    maxLength: '{{field}} must have no more than {{length}} characters.',
-    minWords: '{{field}} must have at least {{length}} words.',
-    maxWords: '{{field}} must have no more than {{length}} words.',
-    min: '{{field}} cannot be less than {{min}}.',
-    max: '{{field}} cannot be greater than {{max}}.',
-    maxDate: '{{field}} should not contain date after {{- maxDate}}',
-    minDate: '{{field}} should not contain date before {{- minDate}}',
-    maxYear: '{{field}} should not contain year greater than {{maxYear}}',
-    minYear: '{{field}} should not contain year less than {{minYear}}',
-    minSelectedCount: 'You must select at least {{minCount}} items',
-    maxSelectedCount: 'You may only select up to {{maxCount}} items',
-    invalid_email: '{{field}} must be a valid email.', // eslint-disable-line camelcase
-    invalid_url: '{{field}} must be a valid url.', // eslint-disable-line camelcase
-    invalid_regex: '{{field}} does not match the pattern {{regex}}.', // eslint-disable-line camelcase
-    invalid_date: '{{field}} is not a valid date.', // eslint-disable-line camelcase
-    invalid_day: '{{field}} is not a valid day.', // eslint-disable-line camelcase
-    invalidValueProperty: 'Invalid Value Property',
-    mask: '{{field}} does not match the mask.',
-    valueIsNotAvailable: '{{ field }} is an invalid value.',
-    stripe: '{{stripe}}',
-    month: 'Month',
-    day: 'Day',
-    year: 'Year',
-    january: 'January',
-    february: 'February',
-    march: 'March',
-    april: 'April',
-    may: 'May',
-    june: 'June',
-    july: 'July',
-    august: 'August',
-    september: 'September',
-    october: 'October',
-    november: 'November',
-    december: 'December',
-    next: 'Next',
-    previous: 'Previous',
-    cancel: 'Cancel',
-    submit: 'Submit Form',
-    confirmCancel: 'Are you sure you want to cancel?',
-    saveDraftInstanceError: 'Cannot save draft because there is no formio instance.',
-    saveDraftAuthError: 'Cannot save draft unless a user is authenticated.',
-    restoreDraftInstanceError: 'Cannot restore draft because there is no formio instance.',
-    saveDraftError: 'Unable to save draft.',
-    restoreDraftError: 'Unable to restore draft.',
-    time: 'Invalid time',
-    cancelButtonAriaLabel: 'Cancel button. Click to reset the form',
-    previousButtonAriaLabel: 'Previous button. Click to go back to the previous tab',
-    nextButtonAriaLabel: 'Next button. Click to go to the next tab',
-    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}}',
-    typeRemaining: '{{ remaining }} {{ type }} remaining.',
-    typeCount: '{{ count }} {{ type }}',
-    requiredDayField: '{{ field }} is required',
-    requiredDayEmpty: '{{ field }} is required',
-    requiredMonthField: '{{ field }} is required',
-    requiredYearField: '{{ field }} is required'
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
 };
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+const bootstrap_1 = __importDefault(require("@formio/bootstrap"));
+exports.default = Object.assign(Object.assign({}, (((_a = bootstrap_1.default === null || bootstrap_1.default === void 0 ? void 0 : bootstrap_1.default.translations) === null || _a === void 0 ? void 0 : _a.en) || {})), { unsavedRowsError: 'Please save all rows before proceeding.', invalidRowsError: 'Please correct invalid rows before proceeding.', invalidRowError: 'Invalid row. Please correct it or delete.', invalidOption: '{{field}} is an invalid value.', invalidDay: '{{field}} is not a valid day.', alertMessageWithLabel: '{{label}}: {{message}}', alertMessage: '{{message}}', complete: 'Submission Complete', error: 'Please fix the following errors before submitting.', errorListHotkey: 'Press Ctrl + Alt + X to go back to the error list.', errorsListNavigationMessage: 'Click to navigate to the field with following error.', submitError: 'Please check the form and correct all errors before submitting.', required: '{{field}} is required', unique: '{{field}} must be unique', array: '{{field}} must be an array', array_nonempty: '{{field}} must be a non-empty array', nonarray: '{{field}} must not be an array', select: '{{field}} contains an invalid selection', pattern: '{{field}} does not match the pattern {{pattern}}', minLength: '{{field}} must have at least {{length}} characters.', maxLength: '{{field}} must have no more than {{length}} characters.', minWords: '{{field}} must have at least {{length}} words.', maxWords: '{{field}} must have no more than {{length}} words.', min: '{{field}} cannot be less than {{min}}.', max: '{{field}} cannot be greater than {{max}}.', maxDate: '{{field}} should not contain date after {{- maxDate}}', minDate: '{{field}} should not contain date before {{- minDate}}', maxYear: '{{field}} should not contain year greater than {{maxYear}}', minYear: '{{field}} should not contain year less than {{minYear}}', minSelectedCount: 'You must select at least {{minCount}} items', maxSelectedCount: 'You may only select up to {{maxCount}} items', invalid_email: '{{field}} must be a valid email.', invalid_url: '{{field}} must be a valid url.', invalid_regex: '{{field}} does not match the pattern {{regex}}.', invalid_date: '{{field}} is not a valid date.', invalid_day: '{{field}} is not a valid day.', invalidValueProperty: 'Invalid Value Property', mask: '{{field}} does not match the mask.', valueIsNotAvailable: '{{ field }} is an invalid value.', stripe: '{{stripe}}', month: 'Month', day: 'Day', year: 'Year', january: 'January', february: 'February', march: 'March', april: 'April', may: 'May', june: 'June', july: 'July', august: 'August', september: 'September', october: 'October', november: 'November', december: 'December', next: 'Next', previous: 'Previous', cancel: 'Cancel', submit: 'Submit Form', confirmCancel: 'Are you sure you want to cancel?', saveDraftInstanceError: 'Cannot save draft because there is no formio instance.', saveDraftAuthError: 'Cannot save draft unless a user is authenticated.', restoreDraftInstanceError: 'Cannot restore draft because there is no formio instance.', saveDraftError: 'Unable to save draft.', restoreDraftError: 'Unable to restore draft.', time: 'Invalid time', cancelButtonAriaLabel: 'Cancel button. Click to reset the form', previousButtonAriaLabel: 'Previous button. Click to go back to the previous tab', nextButtonAriaLabel: 'Next button. Click to go to the next tab', 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}}', typeRemaining: '{{ remaining }} {{ type }} remaining.', typeCount: '{{ count }} {{ type }}', requiredDayField: '{{ field }} is required', requiredDayEmpty: '{{ field }} is required', requiredMonthField: '{{ field }} is required', requiredYearField: '{{ field }} is required', formNotReady: 'Form not ready. Use form.ready promise', noFormElement: 'No DOM element for form.', notUniqueKey: 'API Key is not unique', newFormSchema: 'Form schema is for a newer version, please upgrade your renderer. Some functionality may not work.', missingUrl: 'Missing URL argument', urlNotAttachedToBtn: 'You should add a URL to this button.', loadingProjectSettingsError: 'Could not load project settings', sessionStorageSupportError: 'Session storage is not supported in this browser.', builderUniqueError: `You cannot add more than one {{componentKeyOrTitle}} component to one page.`, pageNotFound: 'Page not found', noDragInfoError: 'There is no Drag Info available for either dragged or sibling element', addonSupportTypeError: 'Addon {{label}} does not support component of type {{type}}', setPathError: 'Should not be setting the path of a component.', calculatedPathDeprecation: 'component.calculatedPath was deprecated, use component.path instead.', unknownTemplate: 'Unknown template: {{name}}', unknownComponent: 'Unknown component: {{type}}', renderTemplateFunctionDeprecation: `Form.io 'render' template function is deprecated.
+    If you need to render template (template A) inside of another template (template B),
+    pass pre-compiled template A (use this.renderTemplate('template_A_name') as template context variable for template B`, whenReadyDeprecation: 'The whenReady() method has been deprecated. Please use the dataReady property instead.', loadResourcesError: 'Unable to load resources for {{componentKey}}', noSelectDataConfiguration: 'Select component {{componentKey}} does not have data configuration.', indexedDBSupportError: "Your browser doesn't support current version of indexedDB", caretPositionSavingError: 'An error occurred while trying to save caret position', iteratableRowsError: 'Getter #iteratableRows() is not implemented', checkRowDeprecation: 'Deprecation Warning: checkRow method has been replaced with processRow', noOAuthBtn: 'You must add the OAuth button to a form for it to function properly', noOAuthConfiguration: 'OAuth not configured. You must configure oauth for your project before it will work.', oAuthErrorsTitle: 'The Following Error Has Occured', noOAuthFormUrl: 'You must attach a Form API url to your form in order to use OAuth buttons.', oAuthStateError: 'OAuth state does not match. Please try logging in again.', componentInvalidRowValidation: 'Invalid row validation for {{componentKey}}', videoPlayerNotFound: 'Video player not found in template.', synchronizationFailed: 'Synchronization is failed', fileWithDuplicatedNameInProgress: 'File with the same name is already being uploaded', fileWithDuplicatedNameLoaded: 'File with the same name is already uploaded', nestedForm: 'Nested form', noDataProvided: 'No data provided', subformSubmissionLoadingError: 'Unable to load subform submission {{submissionId}}:', noDelimiterSet: 'In order for thousands separator to work properly, you must set the delimiter to true in the component json', noSiteKey: 'There is no Site Key specified in settings in form JSON', failedToNormalize: 'Failed to normalize value', failedToCompareItems: 'Error while comparing items', editorFocusError: 'An editor did not initialize properly when trying to focus:', quillImageUploadFailed: 'Quill image upload failed', noFilesSelected: 'No files selected', needConfigurationForQuill: 'The WYSIWYG settings are configured for CKEditor. For this renderer, you will need to use configurations for the Quill Editor. See https://quilljs.com/docs/configuration for more information.', waitPdfConverting: 'Converting PDF. Please wait.', uploading: 'Uploading', pasteBelow: 'Paste below', copy: 'Copy', move: 'Move', edit: 'Edit', editJson: 'Edit JSON', remove: 'Remove', clickToSetValue: 'Click to set value', words: 'words', characters: 'characters', addAnother: 'Add Another', yes: 'Yes', no: 'No', wantToClearData: 'Do you want to clear data?', yesDelete: 'Yes, delete it', waitFileProcessing: 'Processing file. Please wait...', wrongFileType: 'File is the wrong type; it must be {{ pattern }}', fileTooSmall: 'File is too small; it must be at least {{ size }}', fileTooBig: 'File is too big; it must be at most {{ size }}', noFileService: 'File Service not provided.', fileProcessingFailed: 'File processing has been failed.', readyForUpload: 'Ready to be uploaded into storage', readyForRemovingFromStorage: 'Ready to be removed from storage', preparingFileToRemove: 'Preparing file to remove', succefullyRemoved: 'Succefully removed', succefullyUploaded: 'Succefully uploaded', maxSelectItems: 'You may only select up to {{maxCount}} items', minSelectItems: 'You must select at least {{minCount}} items', clickToSign: 'Click to Sign', surveyQuestion: 'Question', surveyQuestionValue: 'Value', success: 'Success', noResultsFound: 'No results found', noChoices: 'No choices to choose from', typeToSearch: 'Type to search', loading: 'Loading' });

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

@@ -2,13 +2,16 @@
  * This file is used to mimic the i18n library interface.
  */
 export class I18n {
+    static languages: {};
+    static setDefaultTranslations(languages: any): void;
     static init(languages?: {}): I18n;
     static createInstance(): I18n;
     constructor(languages?: {});
-    languages: {};
+    languages: any;
+    defaultKeys: any;
     language: string;
     currentLanguage: any;
-    setLanguages(languages: any): void;
+    setLanguages(languages: any, noDefaultOverride: any): void;
     dir(lang?: string): "rtl" | "ltr";
     changeLanguage(language: any, ready?: null): void;
     addResourceBundle(language: any, type: any, strings: any): void;

package/lib/cjs/utils/i18n.js

@@ -6,6 +6,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.I18n = void 0;
 const utils_1 = require("@formio/core/utils");
 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 utils_1.Evaluator.interpolateString(currentTranslation, ...args);
         }
         return utils_1.Evaluator.interpolateString(text, ...args);
     }
 }
 exports.I18n = I18n;
+I18n.languages = i18Defaults;

package/lib/mjs/Form.js

@@ -406,10 +406,10 @@ export default class Form extends Element {
      */
     build() {
         if (!this.instance) {
-            return Promise.reject('Form not ready. Use form.ready promise');
+            return Promise.reject(this.t('formNotReady'));
         }
         if (!this.element) {
-            return Promise.reject('No DOM element for form.');
+            return Promise.reject(this.t('noFormElement'));
         }
         // Add temporary loader.
         const template = (this.options && this.options.template) ? this.options.template : 'bootstrap';
@@ -426,7 +426,7 @@ export default class Form extends Element {
     }
     render() {
         if (!this.instance) {
-            return Promise.reject('Form not ready. Use form.ready promise');
+            return Promise.reject(this.t('formNotReady'));
         }
         return Promise.resolve(this.instance.render())
             .then((param) => {
@@ -436,7 +436,7 @@ export default class Form extends Element {
     }
     attach(element) {
         if (!this.instance) {
-            return Promise.reject('Form not ready. Use form.ready promise');
+            return Promise.reject(this.t('formNotReady'));
         }
         if (this.element) {
             delete this.element.component;

package/lib/mjs/PDFBuilder.js

@@ -196,10 +196,10 @@ export default class PDFBuilder extends WebformBuilder {
                 const progress = Math.floor((event.loaded / event.total) * 100);
                 this.refs.uploadProgress.style.width = `${progress}%`;
                 if (progress > 98) {
-                    this.refs.uploadProgress.innerHTML = this.t('Converting PDF. Please wait.');
+                    this.refs.uploadProgress.innerHTML = this.t('waitPdfConverting');
                 }
                 else {
-                    this.refs.uploadProgress.innerHTML = `${this.t('Uploading')} ${progress}%`;
+                    this.refs.uploadProgress.innerHTML = `${this.t('uploading')} ${progress}%`;
                 }
             }
         }, `${this.projectUrl}/upload`, {}, 'file')
@@ -236,7 +236,7 @@ export default class PDFBuilder extends WebformBuilder {
             return;
         }
         this.refs.uploadError.style.display = message ? '' : 'none';
-        this.refs.uploadError.innerHTML = message;
+        this.refs.uploadError.innerHTML = this.t(`${message}`);
     }
     createForm(options) {
         // Instantiate the webform from the PDF class instead of Webform
@@ -464,7 +464,7 @@ export default class PDFBuilder extends WebformBuilder {
                     name: 'showBuilderErrors',
                     data: {
                         compId: comp.component.id,
-                        errorMessage: `API Key is not unique: ${comp.key}`,
+                        errorMessage: `${this.t('notUniqueKey')}: ${comp.key}`,
                     }
                 });
             }

package/lib/mjs/Webform.d.ts

@@ -34,10 +34,10 @@
  */
 /**
  * @typedef {object} ButtonSettings
- * @property {boolean} [showPrevious] - Show the "Previous" button.
- * @property {boolean} [showNext] - Show the "Next" button.
- * @property {boolean} [showCancel] - Show the "Cancel" button.
- * @property {boolean} [showSubmit] - Show the "Submit" button.
+ * @property {boolean} [showPrevious] - Show the 'Previous' button.
+ * @property {boolean} [showNext] - Show the 'Next' button.
+ * @property {boolean} [showCancel] - Show the 'Cancel' button.
+ * @property {boolean} [showSubmit] - Show the 'Submit' button.
  */
 /**
  * @typedef {object} FormOptions
@@ -257,7 +257,7 @@ declare class Webform extends NestedDataComponent {
     get ready(): Promise<any>;
     /**
      * Set the loading state for this form, and also show the loader spinner.
-     * @param {boolean} loading - If this form should be "loading" or not.
+     * @param {boolean} loading - If this form should be 'loading' or not.
      */
     set loading(loading: boolean);
     /**
@@ -363,13 +363,13 @@ declare class Webform extends NestedDataComponent {
     executeFormController(): false | undefined;
     build(element: any): Promise<any>;
     getClassName(): string;
-    render(): string;
+    render(): import("./components/_classes/field/Field").default;
     redraw(): Promise<void> | Promise<boolean>;
     attach(element: any): Promise<boolean>;
     hasRequiredFields(): boolean;
     /**
      * Sets a new alert to display in the error dialog of the form.
-     * @param {string} type - The type of alert to display. "danger", "success", "warning", etc.
+     * @param {string} type - The type of alert to display. 'danger', 'success', 'warning', etc.
      * @param {string} message - The message to show in the alert.
      * @param {object} options - The options for the alert.
      */
@@ -547,19 +547,19 @@ export type SanitizeConfig = {
 };
 export type ButtonSettings = {
     /**
-     * - Show the "Previous" button.
+     * - Show the 'Previous' button.
      */
     showPrevious?: boolean | undefined;
     /**
-     * - Show the "Next" button.
+     * - Show the 'Next' button.
      */
     showNext?: boolean | undefined;
     /**
-     * - Show the "Cancel" button.
+     * - Show the 'Cancel' button.
      */
     showCancel?: boolean | undefined;
     /**
-     * - Show the "Submit" button.
+     * - Show the 'Submit' button.
      */
     showSubmit?: boolean | undefined;
 };
@@ -739,5 +739,5 @@ export type FormOptions = {
      */
     zoom?: number | undefined;
 };
-import NestedDataComponent from "./components/_classes/nesteddata/NestedDataComponent";
-import EventEmitter from "./EventEmitter";
+import NestedDataComponent from './components/_classes/nesteddata/NestedDataComponent';
+import EventEmitter from './EventEmitter';