@formio/js 5.0.0-rc.53 → 5.0.0-rc.55

package/lib/mjs/WebformBuilder.d.ts

@@ -56,9 +56,10 @@ export default class WebformBuilder extends Component {
     /**
      * When a component sets its api key, we need to check if it is unique within its namespace. Find the namespace root
      * so we can calculate this correctly.
-     * @param component
+     * @param {import('@formio/core').Component} component - The component to find the namespace root for.
+     * @returns {import('@formio/core').Component[]} - The components root for this namespace.
      */
-    findNamespaceRoot(component: any): any;
+    findNamespaceRoot(component: import('@formio/core').Component): import('@formio/core').Component[];
     recurseNamespace(component: any): any;
     render(): any;
     attach(element: any): Promise<any>;
@@ -80,13 +81,13 @@ export default class WebformBuilder extends Component {
     highlightInvalidComponents(): void;
     /**
      * Called when a new component is saved.
-     * @param parent
-     * @param component
-     * @param isNew
-     * @param original
-     * @returns {boolean}
+     * @param {Component} component - The component instance to save.
+     * @param {Component} parent - The parent component.
+     * @param {boolean} isNew - If this is a new component.
+     * @param {Component} original - The original component.
+     * @returns {boolean} - If the component was saved.
      */
-    saveComponent(component: any, parent: any, isNew: any, original: any): boolean;
+    saveComponent(component: Component, parent: Component, isNew: boolean, original: Component): boolean;
     isComponentCreated: boolean | undefined;
     emitSaveComponentEvent(schema: any, originalComp: any, parentComponentSchema: any, path: any, index: any, isNew: any, originalComponentSchema: any): void;
     attachEditComponentControls(component: any, parent: any, isNew: any, original: any, ComponentClass: any): void;
@@ -106,16 +107,16 @@ export default class WebformBuilder extends Component {
     addNewComponent(element: any): void;
     /**
      * Creates copy of component schema and stores it under sessionStorage.
-     * @param {Component} component
-     * @returns {*}
+     * @param {Component} component - The component to copy.
+     * @returns {void}
      */
-    copyComponent(component: Component): any;
+    copyComponent(component: Component): void;
     /**
      * Paste copied component after the current component.
-     * @param {Component} component
-     * @returns {*}
+     * @param {Component} component - The component to paste after.
+     * @returns {void}
      */
-    pasteComponent(component: Component): any;
+    pasteComponent(component: Component): void;
     isParentSaveChildMethod(parentComp: any): boolean;
     getParentElement(element: any): any;
     addBuilderComponentInfo(component: any): any;

package/lib/mjs/WebformBuilder.js

@@ -414,7 +414,8 @@ export default class WebformBuilder extends Component {
     /**
      * When a component sets its api key, we need to check if it is unique within its namespace. Find the namespace root
      * so we can calculate this correctly.
-     * @param component
+     * @param {import('@formio/core').Component} component - The component to find the namespace root for.
+     * @returns {import('@formio/core').Component[]} - The components root for this namespace.
      */
     findNamespaceRoot(component) {
         const path = getArrayFromComponentPath(component.path);
@@ -1116,11 +1117,11 @@ export default class WebformBuilder extends Component {
     }
     /**
      * Called when a new component is saved.
-     * @param parent
-     * @param component
-     * @param isNew
-     * @param original
-     * @returns {boolean}
+     * @param {Component} component - The component instance to save.
+     * @param {Component} parent - The parent component.
+     * @param {boolean} isNew - If this is a new component.
+     * @param {Component} original - The original component.
+     * @returns {boolean} - If the component was saved.
      */
     saveComponent(component, parent, isNew, original) {
         this.editForm.detach();
@@ -1507,8 +1508,8 @@ export default class WebformBuilder extends Component {
     }
     /**
      * Creates copy of component schema and stores it under sessionStorage.
-     * @param {Component} component
-     * @returns {*}
+     * @param {Component} component - The component to copy.
+     * @returns {void}
      */
     copyComponent(component) {
         if (!window.sessionStorage) {
@@ -1519,8 +1520,8 @@ export default class WebformBuilder extends Component {
     }
     /**
      * Paste copied component after the current component.
-     * @param {Component} component
-     * @returns {*}
+     * @param {Component} component - The component to paste after.
+     * @returns {void}
      */
     pasteComponent(component) {
         if (!window.sessionStorage) {

package/lib/mjs/Wizard.d.ts

@@ -1,13 +1,4 @@
 declare class Wizard extends Webform {
-    /**
-     * Constructor for wizard-based forms.
-     * @param {HTMLElement} [element] - The DOM element to place this wizard.
-     * @param {object} [options] - Options object, supported options include:
-     *    - breadcrumbSettings.clickable: true (default) - determines if the breadcrumb bar is clickable.
-     *    - buttonSettings.show*(Previous, Next, Cancel): true (default) - determines if the button is shown.
-     *    - allowPrevious: false (default) - determines if the breadcrumb bar is clickable for visited tabs.
-     */
-    constructor(...args: any[]);
     pages: any[];
     prefixComps: any[];
     suffixComps: any[];
@@ -28,8 +19,6 @@ declare class Wizard extends Webform {
     getPages(args?: {}): any[];
     get hasExtraPages(): boolean;
     get localData(): any;
-    isClickableDefined: boolean | undefined;
-    isSecondInit: boolean | undefined;
     get wizardKey(): string;
     set wizard(form: object);
     get wizard(): object;

package/lib/mjs/Wizard.js

@@ -5,20 +5,20 @@ import { fastCloneDeep, checkCondition, firstNonNil, uniqueKey, eachComponent, }
 export default class Wizard extends Webform {
     /**
      * Constructor for wizard-based forms.
-     * @param {HTMLElement} [element] - The DOM element to place this wizard.
-     * @param {object} [options] - Options object, supported options include:
+     * @param {HTMLElement | object | import('Form').FormOptions} [elementOrOptions] - The DOM element to render this form within or the options to create this form instance.
+     * @param {import('Form').FormOptions} [_options] - The options to create a new form instance.
      *    - breadcrumbSettings.clickable: true (default) - determines if the breadcrumb bar is clickable.
      *    - buttonSettings.show*(Previous, Next, Cancel): true (default) - determines if the button is shown.
      *    - allowPrevious: false (default) - determines if the breadcrumb bar is clickable for visited tabs.
      */
-    constructor() {
+    constructor(elementOrOptions = undefined, _options = undefined) {
         let element, options;
-        if (arguments[0] instanceof HTMLElement || arguments[1]) {
-            element = arguments[0];
-            options = arguments[1] || {};
+        if (elementOrOptions instanceof HTMLElement || options) {
+            element = elementOrOptions;
+            options = _options || {};
         }
         else {
-            options = arguments[0] || {};
+            options = elementOrOptions || {};
         }
         options.display = 'wizard';
         super(element, options);
@@ -90,10 +90,6 @@ export default class Wizard extends Webform {
             showSubmit: true,
             showCancel: !this.options.readOnly
         });
-        if (!this.isSecondInit) {
-            this.isClickableDefined = Object.prototype.hasOwnProperty.call(this.options?.breadcrumbSettings, 'clickable');
-            this.isSecondInit = true;
-        }
         this.options.breadcrumbSettings = _.defaults(this.options.breadcrumbSettings, {
             clickable: true
         });
@@ -295,7 +291,13 @@ export default class Wizard extends Webform {
                 currentPage = page;
             }
         });
-        return this.isClickableDefined ? this.options.breadcrumbSettings.clickable : _.get(currentPage, 'component.breadcrumbClickable', true);
+        if (_.has(currentPage, 'component.breadcrumbClickable')) {
+            return _.get(currentPage, 'component.breadcrumbClickable');
+        }
+        if (_.has(this.options, 'breadcrumbSettings.clickable')) {
+            return this.options.breadcrumbSettings.clickable;
+        }
+        return true;
     }
     isAllowPrevious() {
         let currentPage = null;

package/lib/mjs/WizardBuilder.d.ts

@@ -45,6 +45,6 @@ export default class WizardBuilder extends WebformBuilder {
         key: string;
         components: any[];
     };
-    pasteComponent(component: any): any;
+    pasteComponent(component: any): void;
 }
 import WebformBuilder from './WebformBuilder';

package/lib/mjs/addons/PasswordStrength/PasswordStrengthAddon.d.ts

@@ -23,7 +23,7 @@ export default class PasswordStrengthAddon extends FormioAddon {
                     'margin-bottom': string;
                 };
                 key: string;
-                customConditional(): any;
+                customConditional(): boolean;
                 components: ({
                     type: string;
                     key: any;
@@ -321,7 +321,7 @@ export default class PasswordStrengthAddon extends FormioAddon {
                         'margin-bottom': string;
                     };
                     key: string;
-                    customConditional(): any;
+                    customConditional(): boolean;
                     components: ({
                         type: string;
                         key: any;

package/lib/mjs/addons/PasswordStrength/PasswordStrengthAddon.form.d.ts

@@ -19,7 +19,7 @@ declare const _default: ({
             'margin-bottom': string;
         };
         key: string;
-        customConditional(): any;
+        customConditional(): boolean;
         components: ({
             type: string;
             key: any;
@@ -317,7 +317,7 @@ declare const _default: ({
                 'margin-bottom': string;
             };
             key: string;
-            customConditional(): any;
+            customConditional(): boolean;
             components: ({
                 type: string;
                 key: any;

package/lib/mjs/addons/index.d.ts

@@ -24,7 +24,7 @@ export const editForms: {
                 'margin-bottom': string;
             };
             key: string;
-            customConditional(): any;
+            customConditional(): boolean;
             components: ({
                 type: string;
                 key: any;
@@ -322,7 +322,7 @@ export const editForms: {
                     'margin-bottom': string;
                 };
                 key: string;
-                customConditional(): any;
+                customConditional(): boolean;
                 components: ({
                     type: string;
                     key: any;

package/lib/mjs/components/Components.d.ts

@@ -28,7 +28,7 @@ export default class Components {
                     'margin-bottom': string;
                 };
                 key: string;
-                customConditional(): any;
+                customConditional(): boolean;
                 components: ({
                     type: string;
                     key: any;
@@ -112,7 +112,7 @@ export default class Components {
                     'margin-bottom': string;
                 };
                 key: string;
-                customConditional(): any;
+                customConditional(): boolean;
                 components: ({
                     type: string;
                     key: any;
@@ -195,7 +195,7 @@ export default class Components {
                     'margin-bottom': string;
                 };
                 key: string;
-                customConditional(): any;
+                customConditional(): boolean;
                 components: ({
                     type: string;
                     key: any;
@@ -258,10 +258,11 @@ export default class Components {
     static setComponent(name: any, comp: any): void;
     /**
      * Return a path of component's value.
-     * @param {object} component - The component instance.
+     * @param {Component} component - The component instance.
      * @returns {string} - The component's value path.
      */
-    static getComponentPath(component: object): string;
+    static getComponentPath(component: Component): string;
     static create(component: any, options: any, data: any): any;
 }
 import BaseEditForm from './_classes/component/Component.form';
+import Component from './_classes/component/Component';

package/lib/mjs/components/Components.js

@@ -47,7 +47,7 @@ export default class Components {
     }
     /**
      * Return a path of component's value.
-     * @param {object} component - The component instance.
+     * @param {Component} component - The component instance.
      * @returns {string} - The component's value path.
      */
     static getComponentPath(component) {
@@ -67,6 +67,7 @@ export default class Components {
             path += component.component.key;
             return _.trim(path, '.');
         }
+        return path;
     }
     static create(component, options, data) {
         let comp = null;

package/lib/mjs/components/_classes/component/Component.form.d.ts

@@ -1,7 +1,6 @@
 /**
- *
- * @param {...any} extend
+ * The Edit Form function.
+ * @param {...any} extend - The components that extend the edit form.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
  */
-export default function _default(...extend: any[]): {
-    components: any;
-};
+export default function _default(...extend: any[]): import('@formio/core').Component[];

package/lib/mjs/components/_classes/component/Component.form.js

@@ -8,8 +8,9 @@ import ComponentEditValidation from './editForm/Component.edit.validation';
 import ComponentEditLayout from './editForm/Component.edit.layout';
 import EditFormUtils from './editForm/utils';
 /**
- *
- * @param {...any} extend
+ * The Edit Form function.
+ * @param {...any} extend - The components that extend the edit form.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
  */
 export default function (...extend) {
     const components = _.cloneDeep([

package/lib/mjs/components/_classes/component/Component.js

@@ -989,6 +989,9 @@ export default class Component extends Element {
      * @param {string} [referenceAttributeName] - The attribute name to use for the reference.
      */
     loadRefs(element, refs, referenceAttributeName) {
+        if (!element) {
+            return;
+        }
         for (const ref in refs) {
             const refType = refs[ref];
             const isString = typeof refType === 'string';
@@ -2997,11 +3000,9 @@ export default class Component extends Element {
     checkValidity(data = null, dirty = false, row = null, silentCheck = false, errors = []) {
         data = data || this.rootValue;
         row = row || this.data;
-        console.log('Deprecation warning:  Component.checkValidity() will be deprecated in 6.x version of renderer. Use Component.validateComponent instead.');
         return this.checkComponentValidity(data, dirty, row, { silentCheck }, errors);
     }
     checkAsyncValidity(data = null, dirty = false, row = null, silentCheck = false, errors = []) {
-        console.log('Deprecation warning:  Component.checkAsyncValidity() will be deprecated in 6.x version of renderer. Use Component.validateComponent instead.');
         return this.checkComponentValidity(data, dirty, row, { async: true, silentCheck }, errors);
     }
     /**

package/lib/mjs/components/_classes/component/editForm/Component.edit.addons.d.ts

@@ -36,7 +36,7 @@ declare const _default: {
                     'margin-bottom': string;
                 };
                 key: string;
-                customConditional(): any;
+                customConditional(): boolean;
                 components: ({
                     type: string;
                     key: any;
@@ -334,7 +334,7 @@ declare const _default: {
                         'margin-bottom': string;
                     };
                     key: string;
-                    customConditional(): any;
+                    customConditional(): boolean;
                     components: ({
                         type: string;
                         key: any;

package/lib/mjs/components/_classes/component/editForm/Component.edit.conditional.d.ts

@@ -19,7 +19,7 @@ declare const _default: ({
             'margin-bottom': string;
         };
         key: string;
-        customConditional(): any;
+        customConditional(): boolean;
         components: ({
             type: string;
             key: any;

package/lib/mjs/components/_classes/component/editForm/Component.edit.data.d.ts

@@ -19,7 +19,7 @@ declare const _default: ({
             'margin-bottom': string;
         };
         key: string;
-        customConditional(): any;
+        customConditional(): boolean;
         components: ({
             type: string;
             key: any;

package/lib/mjs/components/_classes/component/editForm/Component.edit.validation.d.ts

@@ -64,7 +64,7 @@ declare const _default: ({
     };
     key: string;
     weight: number;
-    customConditional(): any;
+    customConditional(): boolean;
     components: ({
         type: string;
         tag: string;

package/lib/mjs/components/_classes/component/editForm/Component.edit.validation.js

@@ -1,5 +1,5 @@
 import EditFormUtils from './utils';
-import Evaluator from '../../../../utils/Evaluator';
+import { Evaluator } from '../../../../utils/Evaluator';
 /* eslint-disable quotes, max-len */
 export default [
     {

package/lib/mjs/components/_classes/component/editForm/utils.d.ts

@@ -28,7 +28,7 @@ declare namespace EditFormUtils {
                 'margin-bottom': string;
             };
             key: string;
-            customConditional(): any;
+            customConditional(): boolean;
             components: ({
                 type: string;
                 key: any;

package/lib/mjs/components/_classes/component/editForm/utils.js

@@ -1,5 +1,5 @@
 import _ from 'lodash';
-import Evaluator from '../../../../utils/Evaluator';
+import { Evaluator } from '../../../../utils/Evaluator';
 const EditFormUtils = {
     sortAndFilterComponents(components) {
         return _.filter(_.sortBy(components, 'weight'), (item) => !item.ignore);

package/lib/mjs/components/_classes/list/ListComponent.d.ts

@@ -1,9 +1,9 @@
 export default class ListComponent extends Field {
     get isSelectURL(): boolean;
     get selectData(): any;
-    get shouldLoad(): any;
+    get shouldLoad(): boolean;
     getTemplateKeys(): void;
-    templateKeys: any[] | undefined;
+    templateKeys: string[] | undefined;
     get requestHeaders(): any;
     setItems(): void;
     updateCustomItems(): void;

package/lib/mjs/components/_classes/list/ListComponent.form.d.ts

@@ -1,6 +1,6 @@
 /**
- * List Component edit form.
- * @param {...any} extend - The extended schema.
- * @returns {object} - The List Component edit form.
+ * The Edit Form function.
+ * @param {...any} extend - The components that extend the edit form.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
  */
-export default function _default(...extend: any[]): object;
+export default function _default(...extend: any[]): import('@formio/core').Component[];

package/lib/mjs/components/_classes/list/ListComponent.form.js

@@ -1,9 +1,9 @@
 import Components from '../../Components';
 import ListEditData from './editForm/ListComponent.edit.data';
 /**
- * List Component edit form.
- * @param {...any} extend - The extended schema.
- * @returns {object} - The List Component edit form.
+ * The Edit Form function.
+ * @param {...any} extend - The components that extend the edit form.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
  */
 export default function (...extend) {
     return Components.baseEditForm([

package/lib/mjs/components/_classes/nested/NestedComponent.form.d.ts

@@ -1,7 +1,6 @@
 /**
- *
- * @param {...any} extend
+ * The Edit Form function.
+ * @param {...any} extend - The components that extend the edit form.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
  */
-export default function _default(...extend: any[]): {
-    components: any;
-};
+export default function _default(...extend: any[]): import('@formio/core').Component[];

package/lib/mjs/components/_classes/nested/NestedComponent.form.js

@@ -1,7 +1,8 @@
 import Components from '../../Components';
 /**
- *
- * @param {...any} extend
+ * The Edit Form function.
+ * @param {...any} extend - The components that extend the edit form.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
  */
 export default function (...extend) {
     return Components.baseEditForm([

package/lib/mjs/components/_classes/nested/NestedComponent.js

@@ -751,12 +751,10 @@ export default class NestedComponent extends Field {
      * @returns {boolean} - TRUE if the component is valid.
      */
     checkValidity(data = null, dirty = false, row = null, silentCheck = false, childErrors = []) {
-        console.log('Deprecation warning:  Component.checkValidity() will be deprecated in 6.x version of renderer. Use "validate" method instead.');
         childErrors.push(...this.validate(data, { dirty, silentCheck }));
         return this.checkComponentValidity(data, dirty, row, { dirty, silentCheck }, childErrors) && childErrors.length === 0;
     }
     checkAsyncValidity(data = null, dirty = false, row = null, silentCheck = false) {
-        console.log('Deprecation warning:  Component.checkAsyncValidity() will be deprecated in 6.x version of renderer.');
         return this.ready.then(() => {
             return this.validate(data, { dirty, silentCheck, async: true }).then((childErrors) => {
                 return this.checkComponentValidity(data, dirty, row, { dirty, silentCheck, async: true }, childErrors).then((valid) => {

package/lib/mjs/components/_classes/nesteddata/NestedDataComponent.d.ts

@@ -9,7 +9,7 @@ export default class NestedDataComponent extends NestedComponent {
     everyComponent(fn: any, options?: {}): void;
     /**
      * Get the value of this component.
-     * @returns {*}
+     * @returns {any} - Return the value of this component.
      */
     getValue(): any;
     updateValue(value: any, flags?: {}): boolean;

package/lib/mjs/components/_classes/nesteddata/NestedDataComponent.js

@@ -100,7 +100,7 @@ export default class NestedDataComponent extends NestedComponent {
     }
     /**
      * Get the value of this component.
-     * @returns {*}
+     * @returns {any} - Return the value of this component.
      */
     getValue() {
         return this.dataValue;

package/lib/mjs/components/address/Address.form.d.ts

@@ -1,7 +1,6 @@
 /**
- *
- * @param {...any} extend
+ * The Edit Form function.
+ * @param {...any} extend - The components that extend the edit form.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
  */
-export default function _default(...extend: any[]): {
-    components: any;
-};
+export default function _default(...extend: any[]): import('@formio/core').Component[];

package/lib/mjs/components/address/Address.form.js

@@ -3,8 +3,9 @@ import AddressEditData from './editForm/Address.edit.data';
 import AddressEditDisplay from './editForm/Address.edit.display';
 import AddressEditProvider from './editForm/Address.edit.provider';
 /**
- *
- * @param {...any} extend
+ * The Edit Form function.
+ * @param {...any} extend - The components that extend the edit form.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
  */
 export default function (...extend) {
     return Components.baseEditForm([

package/lib/mjs/components/button/Button.form.d.ts

@@ -1,7 +1,6 @@
 /**
- *
- * @param {...any} extend
+ * The Edit Form function.
+ * @param {...any} extend - The components that extend the edit form.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
  */
-export default function _default(...extend: any[]): {
-    components: any;
-};
+export default function _default(...extend: any[]): import('@formio/core').Component[];

package/lib/mjs/components/button/Button.form.js

@@ -1,8 +1,9 @@
 import Components from '../Components';
 import ButtonEditDisplay from './editForm/Button.edit.display';
 /**
- *
- * @param {...any} extend
+ * The Edit Form function.
+ * @param {...any} extend - The components that extend the edit form.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
  */
 export default function (...extend) {
     return Components.baseEditForm([

package/lib/mjs/components/button/Button.js

@@ -225,8 +225,9 @@ export default class ButtonComponent extends Field {
         this.disabled = this.shouldDisabled;
         this.setDisabled(this.refs.button, this.disabled);
         /**
-         *
-         * @param name
+         * Get url parameter by name
+         * @param {string} name - The url parameter
+         * @returns {string} - The url parameter value
          */
         function getUrlParameter(name) {
             name = name.replace(/[[]/, '\\[').replace(/[\]]/, '\\]');

package/lib/mjs/components/checkbox/Checkbox.form.d.ts

@@ -1,7 +1,6 @@
 /**
- *
- * @param {...any} extend
+ * The Edit Form function.
+ * @param {...any} extend - The components that extend the edit form.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
  */
-export default function _default(...extend: any[]): {
-    components: any;
-};
+export default function _default(...extend: any[]): import('@formio/core').Component[];

package/lib/mjs/components/checkbox/Checkbox.form.js

@@ -3,8 +3,9 @@ import CheckboxEditData from './editForm/Checkbox.edit.data';
 import CheckboxEditDisplay from './editForm/Checkbox.edit.display';
 import CheckboxEditValidation from './editForm/Checkbox.edit.validation';
 /**
- *
- * @param {...any} extend
+ * The Edit Form function.
+ * @param {...any} extend - The components that extend the edit form.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
  */
 export default function (...extend) {
     return Components.baseEditForm([

package/lib/mjs/components/checkbox/Checkbox.js

@@ -178,15 +178,8 @@ export default class CheckBoxComponent extends Field {
         return value;
     }
     setValue(value, flags = {}) {
-        if (this.setCheckedState(value) !== undefined ||
-            (!this.input && value !== undefined && (this.visible || this.conditionallyVisible() || !this.component.clearOnHide))) {
-            const changed = this.updateValue(value, flags);
-            if (this.isHtmlRenderMode() && flags && flags.fromSubmission && changed) {
-                this.redraw();
-            }
-            return changed;
-        }
-        return false;
+        this.setCheckedState(value);
+        return super.setValue(value, flags);
     }
     getValueAsString(value) {
         const { name: componentName, value: componentValue } = this.component;