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

package/lib/cjs/components/checkbox/fixtures/index.d.ts

@@ -2,5 +2,6 @@ import comp1 from './comp1';
 import comp2 from './comp2';
 import comp3 from './comp3';
 import comp4 from './comp4';
+import comp5 from './comp5';
 import customDefaultComponent from './customDefaultComponent';
-export { comp1, comp2, comp3, comp4, customDefaultComponent };
+export { comp1, comp2, comp3, comp4, comp5, customDefaultComponent };

package/lib/cjs/components/checkbox/fixtures/index.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.customDefaultComponent = exports.comp4 = exports.comp3 = exports.comp2 = exports.comp1 = void 0;
+exports.customDefaultComponent = exports.comp5 = exports.comp4 = exports.comp3 = exports.comp2 = exports.comp1 = void 0;
 const comp1_1 = __importDefault(require("./comp1"));
 exports.comp1 = comp1_1.default;
 const customDefaultComponent_1 = __importDefault(require("./customDefaultComponent"));
@@ -14,3 +14,5 @@ const comp3_1 = __importDefault(require("./comp3"));
 exports.comp3 = comp3_1.default;
 const comp4_1 = __importDefault(require("./comp4"));
 exports.comp4 = comp4_1.default;
+const comp5_1 = __importDefault(require("./comp5"));
+exports.comp5 = comp5_1.default;

package/lib/cjs/components/columns/Columns.d.ts

@@ -20,7 +20,7 @@ export default class ColumnsComponent extends NestedComponent {
     get gridSize(): number;
     /**
      * Group columns in rows.
-     * @returns {Array.<ColumnComponent[]>}
+     * @returns {Array.<ColumnComponent[]>} - The array of columns
      */
     groupByRow(): Array<ColumnComponent[]>;
     checkData(data: any, flags: any, row: any, components: any): void;

package/lib/cjs/components/columns/Columns.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/cjs/components/columns/Columns.form.js

@@ -6,8 +6,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const NestedComponent_form_1 = __importDefault(require("../_classes/nested/NestedComponent.form"));
 const Columns_edit_display_1 = __importDefault(require("./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.
  */
 function default_1(...extend) {
     return (0, NestedComponent_form_1.default)([

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

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

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

@@ -7,8 +7,9 @@ const Components_1 = __importDefault(require("../Components"));
 const Container_edit_display_1 = __importDefault(require("./editForm/Container.edit.display"));
 const Container_edit_data_1 = __importDefault(require("./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.
  */
 function default_1(...extend) {
     return Components_1.default.baseEditForm([

package/lib/cjs/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/cjs/components/content/Content.form.js

@@ -7,8 +7,9 @@ const Components_1 = __importDefault(require("../Components"));
 const Content_edit_display_1 = __importDefault(require("./editForm/Content.edit.display"));
 const Content_edit_logic_1 = __importDefault(require("./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.
  */
 function default_1(...extend) {
     const editForm = Components_1.default.baseEditForm([

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

@@ -7,8 +7,9 @@ const TextField_form_1 = __importDefault(require("../textfield/TextField.form"))
 const Currency_edit_display_1 = __importDefault(require("./editForm/Currency.edit.display"));
 const Currency_edit_data_1 = __importDefault(require("./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.
  */
 function default_1(...extend) {
     return (0, TextField_form_1.default)([

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

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

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

@@ -8,8 +8,9 @@ const DataGrid_edit_data_1 = __importDefault(require("./editForm/DataGrid.edit.d
 const DataGrid_edit_display_1 = __importDefault(require("./editForm/DataGrid.edit.display"));
 const DataGrid_edit_validation_1 = __importDefault(require("./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.
  */
 function default_1(...extend) {
     return Components_1.default.baseEditForm([

package/lib/cjs/components/datagrid/DataGrid.js

@@ -141,7 +141,7 @@ class DataGridComponent extends NestedArrayComponent_1.default {
      * 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) => {
@@ -153,7 +153,7 @@ class DataGridComponent extends NestedArrayComponent_1.default {
     /**
      * Create groups object.
      * Each key in object represents index of first row in group.
-     * @returns {object}
+     * @returns {object} - The groups object.
      */
     getGroups() {
         const groups = lodash_1.default.get(this.component, 'rowGroups', []);
@@ -167,8 +167,8 @@ class DataGridComponent extends NestedArrayComponent_1.default {
         }, {});
     }
     /**
-     * Retrun group sizes.
-     * @returns {number[]}
+     * Get group sizes.
+     * @returns {number[]} - The array of group sizes.
      */
     getGroupSizes() {
         return lodash_1.default.map(lodash_1.default.get(this.component, 'rowGroups', []), 'numberOfRows');

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

@@ -7,8 +7,9 @@ const Components_1 = __importDefault(require("../Components"));
 const DataMap_edit_data_1 = __importDefault(require("./editForm/DataMap.edit.data"));
 const DataMap_edit_display_1 = __importDefault(require("./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.
  */
 function default_1(...extend) {
     return Components_1.default.baseEditForm([

package/lib/cjs/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/cjs/components/datetime/DateTime.form.js

@@ -10,8 +10,9 @@ const DateTime_edit_display_1 = __importDefault(require("./editForm/DateTime.edi
 const DateTime_edit_time_1 = __importDefault(require("./editForm/DateTime.edit.time"));
 const DateTime_edit_validation_1 = __importDefault(require("./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.
  */
 function default_1(...extend) {
     return Components_1.default.baseEditForm([

package/lib/cjs/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/cjs/components/datetime/editForm/DateTime.edit.date.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const Evaluator_1 = __importDefault(require("../../../utils/Evaluator"));
+const Evaluator_1 = require("../../../utils/Evaluator");
 const utils_1 = __importDefault(require("../../_classes/component/editForm/utils"));
 exports.default = [
     {
@@ -34,7 +34,7 @@ exports.default = [
         style: { 'margin-bottom': '10px' },
         key: 'panel-disable-function',
         customConditional() {
-            return !Evaluator_1.default.noeval || Evaluator_1.default.protectedEval;
+            return !Evaluator_1.Evaluator.noeval || Evaluator_1.Evaluator.protectedEval;
         },
         components: [
             utils_1.default.logicVariablesTable('<tr><th>date</th><td>The date object.</td></tr>'),

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

@@ -11,8 +11,9 @@ const Day_edit_day_1 = __importDefault(require("./editForm/Day.edit.day"));
 const Day_edit_month_1 = __importDefault(require("./editForm/Day.edit.month"));
 const Day_edit_year_1 = __importDefault(require("./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.
  */
 function default_1(...extend) {
     return Components_1.default.baseEditForm([

package/lib/cjs/components/day/Day.js

@@ -64,7 +64,7 @@ class DayComponent extends Field_1.default {
     }
     /**
      * 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';
@@ -355,9 +355,10 @@ class DayComponent extends Field_1.default {
         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
@@ -411,7 +412,7 @@ class DayComponent extends Field_1.default {
     }
     /**
      * Get the format for the value string.
-     * @returns {string}
+     * @returns {string} - the format for the value string.
      */
     get format() {
         let format = '';
@@ -435,8 +436,8 @@ class DayComponent extends Field_1.default {
     }
     /**
      * 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;
@@ -482,15 +483,15 @@ class DayComponent extends Field_1.default {
         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;
@@ -501,8 +502,8 @@ class DayComponent extends Field_1.default {
     }
     /**
      * 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;
@@ -517,8 +518,8 @@ class DayComponent extends Field_1.default {
     }
     /**
      * 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/cjs/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/cjs/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/cjs/components/editgrid/EditGrid.form.js

@@ -9,8 +9,9 @@ const EditGrid_edit_display_1 = __importDefault(require("./editForm/EditGrid.edi
 const EditGrid_edit_templates_1 = __importDefault(require("./editForm/EditGrid.edit.templates"));
 const EditGrid_edit_validation_1 = __importDefault(require("./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.
  */
 function default_1(...extend) {
     return Components_1.default.baseEditForm([

package/lib/cjs/components/editgrid/EditGrid.js

@@ -166,8 +166,8 @@ class EditGridComponent extends NestedArrayComponent_1.default {
         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;
     }
@@ -1046,7 +1046,7 @@ class EditGridComponent extends NestedArrayComponent_1.default {
         }
     }
     /**
-     * Return that this component processes its own validation.
+     * @returns {boolean} - Return that this component processes its own validation.
      */
     get processOwnValidation() {
         return true;

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

@@ -1,9 +1,6 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-const Evaluator_1 = __importDefault(require("../../../utils/Evaluator"));
+const Evaluator_1 = require("../../../utils/Evaluator");
 exports.default = [
     {
         key: 'placeholder',
@@ -38,7 +35,7 @@ exports.default = [
         weight: 1002,
         input: false,
         customConditional() {
-            return !Evaluator_1.default.noeval;
+            return !Evaluator_1.Evaluator.noeval;
         },
     },
     {

package/lib/cjs/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;
 } | {