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

package/lib/mjs/components/columns/Columns.form.js

@@ -1,8 +1,9 @@
 import nestedComponentForm from '../_classes/nested/NestedComponent.form';
 import ColumnsEditDisplay from './editForm/Columns.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 nestedComponentForm([

package/lib/mjs/components/columns/Columns.js

@@ -114,7 +114,7 @@ export default class ColumnsComponent extends NestedComponent {
     }
     /**
      * Group columns in rows.
-     * @returns {Array.<ColumnComponent[]>}
+     * @returns {Array.<ColumnComponent[]>} - The array of columns
      */
     groupByRow() {
         const initVal = { stack: [], rows: [] };

package/lib/mjs/components/container/Container.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/container/Container.form.js

@@ -2,8 +2,9 @@ import Components from '../Components';
 import ContainerEditDisplay from './editForm/Container.edit.display';
 import ContainerEditData from './editForm/Container.edit.data';
 /**
- *
- * @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/content/Content.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/content/Content.form.js

@@ -2,8 +2,9 @@ import Components from '../Components';
 import ContentEditDisplay from './editForm/Content.edit.display';
 import ContentEditLogic from './editForm/Content.edit.logic';
 /**
- *
- * @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 editForm = Components.baseEditForm([

package/lib/mjs/components/currency/Currency.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/currency/Currency.form.js

@@ -2,8 +2,9 @@ import baseEditForm from '../textfield/TextField.form';
 import CurrencyEditDisplay from './editForm/Currency.edit.display';
 import CurrencyEditData from './editForm/Currency.edit.data';
 /**
- *
- * @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 baseEditForm([

package/lib/mjs/components/currency/Currency.js

@@ -30,7 +30,7 @@ export default class CurrencyComponent extends NumberComponent {
     }
     /**
      * Creates the number mask for currency numbers.
-     * @returns {*}
+     * @returns {*} - The result of the createNumberMask function
      */
     createNumberMask() {
         const decimalLimit = _.get(this.component, 'decimalLimit', 2);

package/lib/mjs/components/datagrid/DataGrid.d.ts

@@ -32,18 +32,18 @@ export default class DataGridComponent extends NestedArrayComponent {
      * Split rows into chunks.
      * @param {number[]} groups - array of numbers where each item is size of group
      * @param {Array<T>} rows - rows collection
-     * @returns {Array<T[]>}
+     * @returns {Array<T[]>} - The chunked rows
      */
     getRowChunks(groups: number[], rows: Array<T>): Array<T[]>;
     /**
      * Create groups object.
      * Each key in object represents index of first row in group.
-     * @returns {object}
+     * @returns {object} - The groups object.
      */
     getGroups(): object;
     /**
-     * Retrun group sizes.
-     * @returns {number[]}
+     * Get group sizes.
+     * @returns {number[]} - The array of group sizes.
      */
     getGroupSizes(): number[];
     hasRowGroups(): any;

package/lib/mjs/components/datagrid/DataGrid.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/datagrid/DataGrid.form.js

@@ -3,8 +3,9 @@ import DataGridEditData from './editForm/DataGrid.edit.data';
 import DataGridEditDisplay from './editForm/DataGrid.edit.display';
 import DataGridEditValidation from './editForm/DataGrid.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/datagrid/DataGrid.js

@@ -135,7 +135,7 @@ export default class DataGridComponent extends NestedArrayComponent {
      * Split rows into chunks.
      * @param {number[]} groups - array of numbers where each item is size of group
      * @param {Array<T>} rows - rows collection
-     * @returns {Array<T[]>}
+     * @returns {Array<T[]>} - The chunked rows
      */
     getRowChunks(groups, rows) {
         const [, chunks] = groups.reduce(([startIndex, acc], size) => {
@@ -147,7 +147,7 @@ export default class DataGridComponent extends NestedArrayComponent {
     /**
      * Create groups object.
      * Each key in object represents index of first row in group.
-     * @returns {object}
+     * @returns {object} - The groups object.
      */
     getGroups() {
         const groups = _.get(this.component, 'rowGroups', []);
@@ -164,8 +164,8 @@ export default class DataGridComponent extends NestedArrayComponent {
         }, {});
     }
     /**
-     * Retrun group sizes.
-     * @returns {number[]}
+     * Get group sizes.
+     * @returns {number[]} - The array of group sizes.
      */
     getGroupSizes() {
         return _.map(_.get(this.component, 'rowGroups', []), 'numberOfRows');

package/lib/mjs/components/datamap/DataMap.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/datamap/DataMap.form.js

@@ -2,8 +2,9 @@ import Components from '../Components';
 import DataMapEditData from './editForm/DataMap.edit.data';
 import DataMapEditDisplay from './editForm/DataMap.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/datetime/DateTime.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/datetime/DateTime.form.js

@@ -5,8 +5,9 @@ import DateTimeEditDisplay from './editForm/DateTime.edit.display';
 import DateTimeEditTime from './editForm/DateTime.edit.time';
 import DateTimeEditValidation from './editForm/DateTime.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/datetime/editForm/DateTime.edit.date.d.ts

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

package/lib/mjs/components/datetime/editForm/DateTime.edit.date.js

@@ -1,4 +1,4 @@
-import Evaluator from '../../../utils/Evaluator';
+import { Evaluator } from '../../../utils/Evaluator';
 import EditFormUtils from '../../_classes/component/editForm/utils';
 export default [
     {

package/lib/mjs/components/day/Day.d.ts

@@ -17,7 +17,7 @@ export default class DayComponent extends Field {
     constructor(component: any, options: any, data: any);
     /**
      * The empty value for day component.
-     * @returns {'00/00/0000'}
+     * @returns {'00/00/0000'} - The empty value of the day component.
      */
     get emptyValue(): "00/00/0000";
     get valueMask(): RegExp;
@@ -91,11 +91,12 @@ export default class DayComponent extends Field {
     validateRequired(setting: any, value: any): boolean;
     normalizeValue(value: any): any;
     /**
-     * Set the value at a specific index.
-     * @param index
-     * @param value
+     * Set the value at a specific index and updates the component's refs.
+     * @param {number} index - The index to set.
+     * @param {any} value - The value to set.
+     * @returns {null|void} - Returns null if the value is invalid, otherwise void.
      */
-    setValueAt(index: any, value: any): null | undefined;
+    setValueAt(index: number, value: any): null | void;
     getFieldValue(name: any): number;
     get parts(): {
         day: number;
@@ -104,37 +105,31 @@ export default class DayComponent extends Field {
     };
     /**
      * Get the format for the value string.
-     * @returns {string}
+     * @returns {string} - the format for the value string.
      */
     get format(): string;
     /**
      * Return the date for this component.
-     * @param value
-     * @returns {*}
+     * @param {any} value - The value to convert to a date.
+     * @returns {null|string} - The date string.
      */
-    getDate(value: any): any;
+    getDate(value: any): null | string;
     /**
-     * Return the date object for this component.
-     * @returns {Date}
+     * Return the date string for this component.
+     * @returns {string|null} - The date string for this component.
      */
-    get date(): Date;
+    get date(): string | null;
     /**
      * Return the raw value.
-     * @returns {Date}
+     * @returns {string} - The raw value of the component.
      */
-    get validationValue(): Date;
-    /**
-     * Get the value at a specific index.
-     * @param index
-     * @returns {*}
-     */
-    getValueAt(index: any): any;
+    get validationValue(): string;
     /**
      * Get the input value of the date.
-     * @param value
-     * @returns {null}
+     * @param {any} value - The value to convert to a string.
+     * @returns {string|null} - The string value of the date.
      */
-    getValueAsString(value: any): null;
+    getValueAsString(value: any): string | null;
     focus(field: any): void;
     isPartialDay(value: any): boolean;
     getValidationFormat(): "DD-MM-YYYY" | "MM-DD-YYYY";

package/lib/mjs/components/day/Day.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/day/Day.form.js

@@ -6,8 +6,9 @@ import DayEditDay from './editForm/Day.edit.day';
 import DayEditMonth from './editForm/Day.edit.month';
 import DayEditYear from './editForm/Day.edit.year';
 /**
- *
- * @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/day/Day.js

@@ -62,7 +62,7 @@ export default class DayComponent extends Field {
     }
     /**
      * The empty value for day component.
-     * @returns {'00/00/0000'}
+     * @returns {'00/00/0000'} - The empty value of the day component.
      */
     get emptyValue() {
         return '00/00/0000';
@@ -353,9 +353,10 @@ export default class DayComponent extends Field {
         return dateParts.join('/');
     }
     /**
-     * Set the value at a specific index.
-     * @param index
-     * @param value
+     * Set the value at a specific index and updates the component's refs.
+     * @param {number} index - The index to set.
+     * @param {any} value - The value to set.
+     * @returns {null|void} - Returns null if the value is invalid, otherwise void.
      */
     setValueAt(index, value) {
         // temporary solution to avoid input reset
@@ -409,7 +410,7 @@ export default class DayComponent extends Field {
     }
     /**
      * Get the format for the value string.
-     * @returns {string}
+     * @returns {string} - the format for the value string.
      */
     get format() {
         let format = '';
@@ -433,8 +434,8 @@ export default class DayComponent extends Field {
     }
     /**
      * Return the date for this component.
-     * @param value
-     * @returns {*}
+     * @param {any} value - The value to convert to a date.
+     * @returns {null|string} - The date string.
      */
     getDate(value) {
         let defaults = [], day, month, year;
@@ -480,15 +481,15 @@ export default class DayComponent extends Field {
         return result;
     }
     /**
-     * Return the date object for this component.
-     * @returns {Date}
+     * Return the date string for this component.
+     * @returns {string|null} - The date string for this component.
      */
     get date() {
         return this.getDate();
     }
     /**
      * Return the raw value.
-     * @returns {Date}
+     * @returns {string} - The raw value of the component.
      */
     get validationValue() {
         return this.dataValue;
@@ -499,8 +500,8 @@ export default class DayComponent extends Field {
     }
     /**
      * Get the value at a specific index.
-     * @param index
-     * @returns {*}
+     * @param {number} index - The index to get the value from.
+     * @returns {*} - The value at index.
      */
     getValueAt(index) {
         const date = this.date || this.emptyValue;
@@ -515,8 +516,8 @@ export default class DayComponent extends Field {
     }
     /**
      * Get the input value of the date.
-     * @param value
-     * @returns {null}
+     * @param {any} value - The value to convert to a string.
+     * @returns {string|null} - The string value of the date.
      */
     getValueAsString(value) {
         return this.getDate(value) || '';

package/lib/mjs/components/editgrid/EditGrid.d.ts

@@ -19,8 +19,9 @@ export default class EditGridComponent extends NestedArrayComponent {
     get rowTemplate(): any;
     get headerTemplate(): any;
     /**
-     * Returns true if the component has nested components which don't trigger changes on the root level
-     */ get hasScopedChildren(): boolean;
+     * @returns {boolean} - Returns true if the component has nested components which don't trigger changes on the root level
+     */
+    get hasScopedChildren(): boolean;
     get emptyValue(): never[];
     get editgridKey(): string;
     get rowRef(): string;
@@ -92,7 +93,7 @@ export default class EditGridComponent extends NestedArrayComponent {
     validateRow(editRow: any, dirty: any, forceSilentCheck: any): any;
     showRowErrorAlerts(editRow: any, errors: any): void;
     /**
-     * Return that this component processes its own validation.
+     * @returns {boolean} - Return that this component processes its own validation.
      */
     get processOwnValidation(): boolean;
     checkComponentValidity(data: any, dirty: any, row: any, options?: {}, errors?: any[]): boolean;

package/lib/mjs/components/editgrid/EditGrid.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/editgrid/EditGrid.form.js

@@ -4,8 +4,9 @@ import EditGridEditDisplay from './editForm/EditGrid.edit.display';
 import EditGridEditTemplates from './editForm/EditGrid.edit.templates';
 import EditGridEditValidation from './editForm/EditGrid.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/editgrid/EditGrid.js

@@ -161,8 +161,8 @@ export default class EditGridComponent extends NestedArrayComponent {
         return headerTemplate;
     }
     /**
-     * Returns true if the component has nested components which don't trigger changes on the root level
-     */ //
+     * @returns {boolean} - Returns true if the component has nested components which don't trigger changes on the root level
+     */
     get hasScopedChildren() {
         return !this.inlineEditMode;
     }
@@ -1035,7 +1035,7 @@ export default class EditGridComponent extends NestedArrayComponent {
         }
     }
     /**
-     * Return that this component processes its own validation.
+     * @returns {boolean} - Return that this component processes its own validation.
      */
     get processOwnValidation() {
         return true;

package/lib/mjs/components/editgrid/editForm/EditGrid.edit.display.js

@@ -1,4 +1,4 @@
-import Evaluator from '../../../utils/Evaluator';
+import { Evaluator } from '../../../utils/Evaluator';
 export default [
     {
         key: 'placeholder',

package/lib/mjs/components/editgrid/editForm/EditGrid.edit.templates.d.ts

@@ -25,7 +25,7 @@ declare const _default: ({
     placeholder: string;
     description: string;
     tooltip: string;
-    customConditional(): any;
+    customConditional(): boolean;
     clearOnHide?: undefined;
     weight?: undefined;
 } | {

package/lib/mjs/components/editgrid/editForm/EditGrid.edit.templates.js

@@ -1,4 +1,4 @@
-import Evaluator from '../../../utils/Evaluator';
+import { Evaluator } from '../../../utils/Evaluator';
 export default [
     {
         type: 'textarea',

package/lib/mjs/components/email/Email.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/email/Email.form.js

@@ -2,8 +2,9 @@ import baseEditForm from '../textfield/TextField.form';
 import EmailEditFormDisplay from './editForm/Email.edit.display';
 import EmailEditFormValidation from './editForm/Email.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 baseEditForm([

package/lib/mjs/components/fieldset/Fieldset.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/fieldset/Fieldset.form.js

@@ -1,8 +1,9 @@
 import nestedComponentForm from '../_classes/nested/NestedComponent.form';
 import FieldSetEditDisplay from './editForm/Fieldset.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 nestedComponentForm([

package/lib/mjs/components/file/File.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/file/File.form.js

@@ -4,8 +4,9 @@ import FileEditDisplay from './editForm/File.edit.display';
 import FileEditFile from './editForm/File.edit.file';
 import FileEditValidation from './editForm/File.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([