@formio/js 5.0.0-dev.5954.7e72629 → 5.0.0-dev.5957.bed9ce0

package/lib/mjs/components/signature/Signature.js

@@ -174,7 +174,7 @@ export default class SignatureComponent extends Input {
         return this.renderModalPreview({
             previewText: this.dataValue ?
                 `<img src=${this.dataValue} ${this._referenceAttributeName}='openModal' style="width: 100%;height: 100%;" />` :
-                this.t('Click to Sign')
+                this.t('clickToSign')
         });
     }
     attach(element) {
@@ -242,7 +242,7 @@ export default class SignatureComponent extends Input {
         if (_.isUndefined(value) && this.inDataTable) {
             return '';
         }
-        return value ? 'Yes' : 'No';
+        return this.t(value ? 'yes' : 'no');
     }
     focus() {
         this.refs.padBody.focus();

package/lib/mjs/components/survey/Survey.js

@@ -126,8 +126,8 @@ export default class SurveyComponent extends Field {
         <table border="1" style="width:100%">
           <thead>
             <tr>
-              <th>Question</th>
-              <th>Value</th>
+              <th>${this.t('surveyQuestion')}</th>
+              <th>${this.t('surveyQuestionValue')}</th>
             </tr>
           </thead>
           <tbody>

package/lib/mjs/components/textarea/TextArea.js

@@ -131,7 +131,7 @@ export default class TextAreaComponent extends TextFieldComponent {
                 case 'quill':
                     // Normalize the configurations for quill.
                     if (settings.hasOwnProperty('toolbarGroups') || settings.hasOwnProperty('toolbar')) {
-                        console.warn('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.');
+                        console.warn(this.t('needConfigurationForQuill'));
                         settings = this.wysiwygDefault.quill;
                     }
                     // Add the quill editor.
@@ -203,7 +203,7 @@ export default class TextAreaComponent extends TextFieldComponent {
     imageHandler(moduleInstance, range, files) {
         const quillInstance = moduleInstance.quill;
         if (!files || !files.length) {
-            console.warn('No files selected');
+            console.warn(this.t('noFilesSelected'));
             return;
         }
         quillInstance.enable(false);
@@ -228,7 +228,7 @@ export default class TextAreaComponent extends TextFieldComponent {
                 alt: JSON.stringify(requestData),
             }), Quill.sources.USER);
         }).catch(error => {
-            console.warn('Quill image upload failed');
+            console.warn(this.t('quillImageUploadFailed'));
             console.warn(error);
             quillInstance.enable(true);
         });
@@ -523,7 +523,7 @@ export default class TextAreaComponent extends TextFieldComponent {
                     }
                     this.element.scrollIntoView();
                 }).catch((err) => {
-                    console.warn('An editor did not initialize properly when trying to focus:', err);
+                    console.warn(this.t('editorFocusError'), err);
                 });
                 break;
             }
@@ -532,7 +532,7 @@ export default class TextAreaComponent extends TextFieldComponent {
                     this.editors[0].focus();
                     this.element.scrollIntoView();
                 }).catch((err) => {
-                    console.warn('An editor did not initialize properly when trying to focus:', err);
+                    console.warn(this.t('editorFocusError'), err);
                 });
                 break;
             }
@@ -540,7 +540,7 @@ export default class TextAreaComponent extends TextFieldComponent {
                 this.editorsReady[0]?.then(() => {
                     this.editors[0].focus();
                 }).catch((err) => {
-                    console.warn('An editor did not initialize properly when trying to focus:', err);
+                    console.warn(this.t('editorFocusError'), err);
                 });
                 break;
             }

package/lib/mjs/formio.form.js

@@ -12,6 +12,7 @@ import { Evaluator } from './utils/Evaluator';
 import Licenses from './licenses';
 import EventEmitter from './EventEmitter';
 import Webform from './Webform';
+import { I18n } from './utils/i18n';
 Formio.loadModules = (path = `${Formio.getApiUrl()}/externalModules.js`, name = 'externalModules') => {
     Formio.requireLibrary(name, name, path, true)
         .then((modules) => {
@@ -84,6 +85,9 @@ export function registerModule(mod, defaultFn = null, options = {}) {
             case 'evaluator':
                 Formio.Evaluator.registerEvaluator(mod.evaluator);
                 break;
+            case 'translations':
+                I18n.setDefaultTranslations(mod.translations);
+                break;
             case 'library':
                 options.license
                     ? Formio.Licenses.addLicense(mod.library, options.license)

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

@@ -1,82 +1,235 @@
-declare namespace _default {
-    let unsavedRowsError: string;
-    let invalidRowsError: string;
-    let invalidRowError: string;
-    let invalidOption: string;
-    let invalidDay: string;
-    let alertMessageWithLabel: string;
-    let alertMessage: string;
-    let complete: string;
-    let error: string;
-    let errorListHotkey: string;
-    let errorsListNavigationMessage: string;
-    let submitError: string;
-    let required: string;
-    let unique: string;
-    let array: string;
-    let array_nonempty: string;
-    let nonarray: string;
-    let select: string;
-    let pattern: string;
-    let minLength: string;
-    let maxLength: string;
-    let minWords: string;
-    let maxWords: string;
-    let min: string;
-    let max: string;
-    let maxDate: string;
-    let minDate: string;
-    let maxYear: string;
-    let minYear: string;
-    let minSelectedCount: string;
-    let maxSelectedCount: string;
-    let invalid_email: string;
-    let invalid_url: string;
-    let invalid_regex: string;
-    let invalid_date: string;
-    let invalid_day: string;
-    let invalidValueProperty: string;
-    let mask: string;
-    let valueIsNotAvailable: string;
-    let stripe: string;
-    let month: string;
-    let day: string;
-    let year: string;
-    let january: string;
-    let february: string;
-    let march: string;
-    let april: string;
-    let may: string;
-    let june: string;
-    let july: string;
-    let august: string;
-    let september: string;
-    let october: string;
-    let november: string;
-    let december: string;
-    let next: string;
-    let previous: string;
-    let cancel: string;
-    let submit: string;
-    let confirmCancel: string;
-    let saveDraftInstanceError: string;
-    let saveDraftAuthError: string;
-    let restoreDraftInstanceError: string;
-    let saveDraftError: string;
-    let restoreDraftError: string;
-    let time: string;
-    let cancelButtonAriaLabel: string;
-    let previousButtonAriaLabel: string;
-    let nextButtonAriaLabel: string;
-    let submitButtonAriaLabel: string;
-    let reCaptchaTokenValidationError: string;
-    let reCaptchaTokenNotSpecifiedError: string;
-    let apiKey: string;
-    let typeRemaining: string;
-    let typeCount: string;
-    let requiredDayField: string;
-    let requiredDayEmpty: string;
-    let requiredMonthField: string;
-    let requiredYearField: string;
-}
+declare const _default: {
+    unsavedRowsError: string;
+    invalidRowsError: string;
+    invalidRowError: string;
+    invalidOption: string;
+    invalidDay: string;
+    alertMessageWithLabel: string;
+    alertMessage: string;
+    complete: string;
+    error: string;
+    errorListHotkey: string;
+    errorsListNavigationMessage: string;
+    submitError: string;
+    required: string;
+    unique: string;
+    array: string;
+    array_nonempty: string;
+    nonarray: string;
+    select: string;
+    pattern: string;
+    minLength: string;
+    maxLength: string;
+    minWords: string;
+    maxWords: string;
+    min: string;
+    max: string;
+    maxDate: string;
+    minDate: string;
+    maxYear: string;
+    minYear: string;
+    minSelectedCount: string;
+    maxSelectedCount: string;
+    invalid_email: string;
+    invalid_url: string;
+    invalid_regex: string;
+    invalid_date: string;
+    invalid_day: string;
+    invalidValueProperty: string;
+    mask: string;
+    valueIsNotAvailable: string;
+    stripe: string;
+    month: string;
+    day: string;
+    year: string;
+    january: string;
+    february: string;
+    march: string;
+    april: string;
+    may: string;
+    june: string;
+    july: string;
+    august: string;
+    september: string;
+    october: string;
+    november: string;
+    december: string;
+    next: string;
+    previous: string;
+    cancel: string;
+    submit: string;
+    confirmCancel: string;
+    saveDraftInstanceError: string;
+    saveDraftAuthError: string;
+    restoreDraftInstanceError: string;
+    saveDraftError: string;
+    restoreDraftError: string;
+    time: string;
+    cancelButtonAriaLabel: string;
+    previousButtonAriaLabel: string;
+    nextButtonAriaLabel: string;
+    submitButtonAriaLabel: string;
+    reCaptchaTokenValidationError: string;
+    reCaptchaTokenNotSpecifiedError: string;
+    apiKey: string;
+    typeRemaining: string;
+    typeCount: string;
+    requiredDayField: string;
+    requiredDayEmpty: string;
+    requiredMonthField: string;
+    requiredYearField: string;
+    formNotReady: string;
+    noFormElement: string;
+    notUniqueKey: string;
+    newFormSchema: string;
+    missingUrl: string;
+    urlNotAttachedToBtn: string;
+    loadingProjectSettingsError: string;
+    sessionStorageSupportError: string;
+    builderUniqueError: string;
+    pageNotFound: string;
+    noDragInfoError: string;
+    addonSupportTypeError: string;
+    setPathError: string;
+    calculatedPathDeprecation: string;
+    unknownTemplate: string;
+    unknownComponent: string;
+    renderTemplateFunctionDeprecation: string;
+    whenReadyDeprecation: string;
+    loadResourcesError: string;
+    noSelectDataConfiguration: string;
+    indexedDBSupportError: string;
+    caretPositionSavingError: string;
+    iteratableRowsError: string;
+    checkRowDeprecation: string;
+    noOAuthBtn: string;
+    noOAuthConfiguration: string;
+    oAuthErrorsTitle: string;
+    noOAuthFormUrl: string;
+    oAuthStateError: string;
+    componentInvalidRowValidation: string;
+    videoPlayerNotFound: string;
+    synchronizationFailed: string;
+    fileWithDuplicatedNameInProgress: string;
+    fileWithDuplicatedNameLoaded: string;
+    nestedForm: string;
+    noDataProvided: string;
+    subformSubmissionLoadingError: string;
+    noDelimiterSet: string;
+    noSiteKey: string;
+    failedToNormalize: string;
+    failedToCompareItems: string;
+    editorFocusError: string;
+    quillImageUploadFailed: string;
+    noFilesSelected: string;
+    needConfigurationForQuill: string;
+    waitPdfConverting: string;
+    uploading: string;
+    pasteBelow: string;
+    copy: string;
+    move: string;
+    edit: string;
+    editJson: string;
+    remove: string;
+    clickToSetValue: string;
+    words: string;
+    characters: string;
+    addAnother: string;
+    yes: string;
+    no: string;
+    wantToClearData: string;
+    yesDelete: string;
+    waitFileProcessing: string;
+    wrongFileType: string;
+    fileTooSmall: string;
+    fileTooBig: string;
+    noFileService: string;
+    fileProcessingFailed: string;
+    readyForUpload: string;
+    readyForRemovingFromStorage: string;
+    preparingFileToRemove: string;
+    succefullyRemoved: string;
+    succefullyUploaded: string;
+    maxSelectItems: string;
+    minSelectItems: string;
+    clickToSign: string;
+    surveyQuestion: string;
+    surveyQuestionValue: string;
+    success: string;
+    noResultsFound: string;
+    noChoices: string;
+    typeToSearch: string;
+    loading: string;
+    help: string;
+    component: string;
+    save: string;
+    preview: string;
+    dragAndDropComponent: string;
+    searchFields: string;
+    noMatchesFound: string;
+    fileName: string;
+    size: string;
+    type: string;
+    gallery: string;
+    camera: string;
+    dropFilesToAttach: string;
+    useCamera: string;
+    browse: string;
+    takePicture: string;
+    switchToFileUpload: string;
+    completeStatus: string;
+    noStorageSet: string;
+    noFileApiSupport: string;
+    noFormDataSupport: string;
+    noProgressSupport: string;
+    close: string;
+    addResource: string;
+    autocomplete: string;
+    showPreview: string;
+    hidePreview: string;
+    createPage: string;
+    page: string;
+    closeBtnDescription: string;
+    cancelBtnDescription: string;
+    saveBtnDescription: string;
+    addOrRemove: string;
+    anyFileTypesAllowed: string;
+    allowedFileTypes: string;
+    syncing: string;
+    syncNow: string;
+    pressToOpen: string;
+    browseToAttachFileFor: string;
+    or: string;
+    numericOnly: string;
+    uploadPdfFile: string;
+    dropToStart: string;
+    expand: string;
+    collapse: string;
+    add: string;
+    delete: string;
+    revert: string;
+    removeBtnPressToRemove: string;
+    file: string;
+    captureVideo: string;
+    captureAudio: string;
+    captureImage: string;
+    browseFiles: string;
+    noComponentsSetInGrid: string;
+    sortAscending: string;
+    sortDescending: string;
+    filter: string;
+    clear: string;
+    showItemsWithValue: string;
+    gridItemsPerPage: string;
+    gridAllItems: string;
+    recordsSelectedOnPage: string;
+    recordsSelectedInTable: string;
+    gridSelectAll: string;
+    itemsInTable: string;
+    clearSelection: string;
+    editGridRow: string;
+    deleteGridRow: string;
+    selected: string;
+    actions: string;
+};
 export default _default;

package/lib/mjs/translations/en.js

@@ -1,4 +1,6 @@
+import bootstrap from '@formio/bootstrap';
 export default {
+    ...(bootstrap?.translations?.en || {}),
     unsavedRowsError: 'Please save all rows before proceeding.',
     invalidRowsError: 'Please correct invalid rows before proceeding.',
     invalidRowError: 'Invalid row. Please correct it or delete.',
@@ -77,5 +79,89 @@ export default {
     requiredDayField: '{{ field }} is required',
     requiredDayEmpty: '{{ field }} is required',
     requiredMonthField: '{{ field }} is required',
-    requiredYearField: '{{ 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/mjs/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/mjs/utils/i18n.js

@@ -1,5 +1,7 @@
 import { Evaluator } from '@formio/core/utils';
 import i18n from '../i18n';
+import { isEmpty } from 'lodash';
+import { fastCloneDeep } from '@formio/core';
 const i18Defaults = {};
 for (const lang in i18n.resources) {
     if (i18n.resources.hasOwnProperty(lang)) {
@@ -10,14 +12,29 @@ for (const lang in i18n.resources) {
  * This file is used to mimic the i18n library interface.
  */
 export class I18n {
-    languages = i18Defaults;
+    static languages = i18Defaults;
+    languages = fastCloneDeep(I18n.languages || {});
+    defaultKeys = I18n.languages?.en || {};
     language = 'en';
     currentLanguage = i18Defaults.en;
     constructor(languages = {}) {
         this.setLanguages(languages);
         this.changeLanguage(this.language);
     }
-    setLanguages(languages) {
+    static setDefaultTranslations(languages) {
+        if (isEmpty(languages)) {
+            return;
+        }
+        for (const lang in languages) {
+            if (lang !== 'language' && languages.hasOwnProperty(lang)) {
+                if (!this.languages[lang]) {
+                    this.languages[lang] = {};
+                }
+                this.languages[lang] = { ...languages[lang], ...this.languages[lang], };
+            }
+        }
+    }
+    setLanguages(languages, noDefaultOverride) {
         if (languages.resources) {
             for (const lang in languages.resources) {
                 if (languages.resources.hasOwnProperty(lang)) {
@@ -44,7 +61,9 @@ export class I18n {
                 if (!this.languages[lang]) {
                     this.languages[lang] = {};
                 }
-                this.languages[lang] = { ...this.languages[lang], ...languages[lang] };
+                this.languages[lang] = noDefaultOverride
+                    ? { ...languages[lang], ...this.languages[lang] }
+                    : { ...this.languages[lang], ...languages[lang] };
             }
         }
     }
@@ -73,12 +92,20 @@ export class I18n {
         this.languages[language] = strings;
     }
     t(text, ...args) {
-        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 = args[0]?.field;
             if (customTranslationFieldName && this.currentLanguage[customTranslationFieldName]) {
                 args[0].field = this.currentLanguage[customTranslationFieldName];
             }
-            return Evaluator.interpolateString(this.currentLanguage[text], ...args);
+            return Evaluator.interpolateString(currentTranslation, ...args);
         }
         return Evaluator.interpolateString(text, ...args);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@formio/js",
-  "version": "5.0.0-dev.5954.7e72629",
+  "version": "5.0.0-dev.5957.bed9ce0",
   "description": "JavaScript powered Forms with JSON Form Builder",
   "main": "lib/cjs/index.js",
   "exports": {
@@ -80,7 +80,7 @@
   },
   "homepage": "https://github.com/formio/formio.js#readme",
   "dependencies": {
-    "@formio/bootstrap": "3.0.0-dev.119.c4cb299",
+    "@formio/bootstrap": "v3.0.0-dev.121.085d187",
     "@formio/choices.js": "^10.2.1",
     "@formio/core": "2.1.0-dev.193.68cf8c3",
     "@formio/text-mask-addons": "3.8.0-formio.4",