@formio/js 5.0.0-dev.5643.9c5173a → 5.0.0-dev.5646.35daa65

package/lib/cjs/components/day/Day.form.d.ts

@@ -1,3 +1,6 @@
-export default function _default(...extend: any[]): {
-    components: any;
-};
+/**
+ * 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[]): import('@formio/core').Component[];

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

@@ -10,6 +10,11 @@ const Day_edit_validation_1 = __importDefault(require("./editForm/Day.edit.valid
 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"));
+/**
+ * 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,8 +64,7 @@ class DayComponent extends Field_1.default {
     }
     /**
      * The empty value for day component.
-     *
-     * @return {'00/00/0000'}
+     * @returns {'00/00/0000'} - The empty value of the day component.
      */
     get emptyValue() {
         return '00/00/0000';
@@ -125,7 +124,7 @@ class DayComponent extends Field_1.default {
                 id: `${this.component.key}-${name}`,
                 class: `form-control ${this.transform('class', `formio-day-component-${name}`)}`,
                 type: this.component.fields[name].type === 'select' ? 'select' : 'number',
-                placeholder: this.component.fields[name].placeholder,
+                placeholder: this.t(this.component.fields[name].placeholder),
                 step: 1,
                 min,
                 max,
@@ -356,10 +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
@@ -413,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 = '';
@@ -437,9 +436,8 @@ class DayComponent extends Field_1.default {
     }
     /**
      * Return the date for this component.
-     *
-     * @param value
-     * @return {*}
+     * @param {any} value - The value to convert to a date.
+     * @returns {null|string} - The date string.
      */
     getDate(value) {
         let defaults = [], day, month, year;
@@ -485,16 +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;
@@ -505,9 +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;
@@ -522,9 +518,8 @@ class DayComponent extends Field_1.default {
     }
     /**
      * Get the input value of the date.
-     *
-     * @param value
-     * @return {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/day/fixtures/comp7.d.ts

@@ -0,0 +1,109 @@
+declare namespace _default {
+    let components: ({
+        type: string;
+        key: string;
+        label: string;
+        placeholder: string;
+        input: boolean;
+        applyMaskOn?: undefined;
+        tableView?: undefined;
+        hideInputLabels?: undefined;
+        inputsLabelPosition?: undefined;
+        useLocaleSettings?: undefined;
+        fields?: undefined;
+        defaultValue?: undefined;
+        values?: undefined;
+        questions?: undefined;
+        action?: undefined;
+        theme?: undefined;
+    } | {
+        label: string;
+        placeholder: string;
+        applyMaskOn: string;
+        tableView: boolean;
+        key: string;
+        type: string;
+        input: boolean;
+        hideInputLabels?: undefined;
+        inputsLabelPosition?: undefined;
+        useLocaleSettings?: undefined;
+        fields?: undefined;
+        defaultValue?: undefined;
+        values?: undefined;
+        questions?: undefined;
+        action?: undefined;
+        theme?: undefined;
+    } | {
+        label: string;
+        hideInputLabels: boolean;
+        inputsLabelPosition: string;
+        useLocaleSettings: boolean;
+        tableView: boolean;
+        fields: {
+            day: {
+                placeholder: string;
+                hide: boolean;
+            };
+            month: {
+                type: string;
+                placeholder: string;
+                hide: boolean;
+            };
+            year: {
+                placeholder: string;
+                hide: boolean;
+            };
+        };
+        key: string;
+        type: string;
+        input: boolean;
+        defaultValue: string;
+        placeholder?: undefined;
+        applyMaskOn?: undefined;
+        values?: undefined;
+        questions?: undefined;
+        action?: undefined;
+        theme?: undefined;
+    } | {
+        type: string;
+        key: string;
+        label: string;
+        values: {
+            label: string;
+            value: string;
+        }[];
+        questions: {
+            label: string;
+            value: string;
+        }[];
+        placeholder?: undefined;
+        input?: undefined;
+        applyMaskOn?: undefined;
+        tableView?: undefined;
+        hideInputLabels?: undefined;
+        inputsLabelPosition?: undefined;
+        useLocaleSettings?: undefined;
+        fields?: undefined;
+        defaultValue?: undefined;
+        action?: undefined;
+        theme?: undefined;
+    } | {
+        type: string;
+        action: string;
+        label: string;
+        theme: string;
+        key?: undefined;
+        placeholder?: undefined;
+        input?: undefined;
+        applyMaskOn?: undefined;
+        tableView?: undefined;
+        hideInputLabels?: undefined;
+        inputsLabelPosition?: undefined;
+        useLocaleSettings?: undefined;
+        fields?: undefined;
+        defaultValue?: undefined;
+        values?: undefined;
+        questions?: undefined;
+    })[];
+}
+export default _default;

package/lib/cjs/components/day/fixtures/comp7.js

@@ -0,0 +1,109 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = {
+    components: [
+        {
+            type: 'textfield',
+            key: 'firstName',
+            label: 'First Name',
+            placeholder: 'Enter your first name',
+            input: true
+        }, {
+            "label": "Day",
+            "placeholder": "Day",
+            "applyMaskOn": "change",
+            "tableView": true,
+            "key": "day2",
+            "type": "textfield",
+            "input": true
+        }, {
+            "label": "Month",
+            "placeholder": "Month",
+            "applyMaskOn": "change",
+            "tableView": true,
+            "key": "month2",
+            "type": "textfield",
+            "input": true
+        }, {
+            "label": "Year",
+            "placeholder": "Year",
+            "applyMaskOn": "change",
+            "tableView": true,
+            "key": "year2",
+            "type": "textfield",
+            "input": true
+        },
+        {
+            "label": "Day",
+            "hideInputLabels": false,
+            "inputsLabelPosition": "top",
+            "useLocaleSettings": false,
+            "tableView": false,
+            "fields": {
+                "day": {
+                    "placeholder": "Day",
+                    "hide": false
+                },
+                "month": {
+                    "type": "number",
+                    "placeholder": "Month",
+                    "hide": false
+                },
+                "year": {
+                    "placeholder": "Year",
+                    "hide": false
+                }
+            },
+            "key": "day",
+            "type": "day",
+            "input": true,
+            "defaultValue": "00/00/0000"
+        },
+        {
+            type: 'textfield',
+            key: 'lastName',
+            label: 'Last Name',
+            placeholder: 'Enter your last name',
+            input: true
+        },
+        {
+            type: 'survey',
+            key: 'questions',
+            label: 'Survey',
+            values: [
+                {
+                    label: 'Great',
+                    value: 'great'
+                },
+                {
+                    label: 'Good',
+                    value: 'good'
+                },
+                {
+                    label: 'Poor',
+                    value: 'poor'
+                }
+            ],
+            questions: [
+                {
+                    label: 'How would you rate the Form.io platform?',
+                    value: 'howWouldYouRateTheFormIoPlatform'
+                },
+                {
+                    label: 'How was Customer Support?',
+                    value: 'howWasCustomerSupport'
+                },
+                {
+                    label: 'Overall Experience?',
+                    value: 'overallExperience'
+                }
+            ]
+        },
+        {
+            type: 'button',
+            action: 'submit',
+            label: 'Submit',
+            theme: 'primary'
+        }
+    ]
+};

package/lib/cjs/components/day/fixtures/comp8.d.ts

@@ -0,0 +1,41 @@
+declare namespace _default {
+    let components: ({
+        label: string;
+        hideInputLabels: boolean;
+        inputsLabelPosition: string;
+        useLocaleSettings: boolean;
+        alwaysEnabled: boolean;
+        tableView: boolean;
+        fields: {
+            day: {
+                hide: boolean;
+                required: boolean;
+            };
+            month: {
+                hide: boolean;
+                required: boolean;
+            };
+            year: {
+                hide: boolean;
+                required: boolean;
+            };
+        };
+        key: string;
+        type: string;
+        input: boolean;
+        showValidations?: undefined;
+    } | {
+        label: string;
+        showValidations: boolean;
+        alwaysEnabled: boolean;
+        tableView: boolean;
+        key: string;
+        type: string;
+        input: boolean;
+        hideInputLabels?: undefined;
+        inputsLabelPosition?: undefined;
+        useLocaleSettings?: undefined;
+        fields?: undefined;
+    })[];
+}
+export default _default;

package/lib/cjs/components/day/fixtures/comp8.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = {
+    "components": [
+        {
+            "label": "Day - Table",
+            "hideInputLabels": false,
+            "inputsLabelPosition": "top",
+            "useLocaleSettings": false,
+            "alwaysEnabled": false,
+            "tableView": false,
+            "fields": {
+                "day": {
+                    "hide": false,
+                    "required": true
+                },
+                "month": {
+                    "hide": false,
+                    "required": true
+                },
+                "year": {
+                    "hide": false,
+                    "required": true
+                }
+            },
+            "key": "dayTable",
+            "type": "day",
+            "input": true
+        },
+        {
+            "label": "Submit",
+            "showValidations": false,
+            "alwaysEnabled": false,
+            "tableView": false,
+            "key": "submit",
+            "type": "button",
+            "input": true
+        }
+    ]
+};

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

@@ -4,4 +4,6 @@ import comp3 from './comp3';
 import comp4 from './comp4';
 import comp5 from './comp5';
 import comp6 from './comp6';
-export { comp1, comp2, comp3, comp4, comp5, comp6 };
+import comp7 from './comp7';
+import comp8 from './comp8';
+export { comp1, comp2, comp3, comp4, comp5, comp6, comp7, comp8 };

package/lib/cjs/components/day/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.comp6 = exports.comp5 = exports.comp4 = exports.comp3 = exports.comp2 = exports.comp1 = void 0;
+exports.comp8 = exports.comp7 = exports.comp6 = exports.comp5 = exports.comp4 = exports.comp3 = exports.comp2 = exports.comp1 = void 0;
 const comp1_1 = __importDefault(require("./comp1"));
 exports.comp1 = comp1_1.default;
 const comp2_1 = __importDefault(require("./comp2"));
@@ -16,3 +16,7 @@ const comp5_1 = __importDefault(require("./comp5"));
 exports.comp5 = comp5_1.default;
 const comp6_1 = __importDefault(require("./comp6"));
 exports.comp6 = comp6_1.default;
+const comp7_1 = __importDefault(require("./comp7"));
+exports.comp7 = comp7_1.default;
+const comp8_1 = __importDefault(require("./comp8"));
+exports.comp8 = comp8_1.default;

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;
@@ -35,6 +36,8 @@ export default class EditGridComponent extends NestedArrayComponent {
     get inlineEditMode(): any;
     get saveEditMode(): boolean;
     get minLength(): any;
+    set data(value: any);
+    get data(): any;
     get displayAsTable(): any;
     get iteratableRows(): any;
     get defaultValue(): any[];
@@ -90,9 +93,10 @@ 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;
     setRowInvalid(ref: any, index: any): void;
     changeState(changed: any, flags: any): void;
     openWhenEmpty(): void;

package/lib/cjs/components/editgrid/EditGrid.form.d.ts

@@ -1,3 +1,6 @@
-export default function _default(...extend: any[]): {
-    components: any;
-};
+/**
+ * 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[]): import('@formio/core').Component[];

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

@@ -8,6 +8,11 @@ const EditGrid_edit_data_1 = __importDefault(require("./editForm/EditGrid.edit.d
 const EditGrid_edit_display_1 = __importDefault(require("./editForm/EditGrid.edit.display"));
 const EditGrid_edit_templates_1 = __importDefault(require("./editForm/EditGrid.edit.templates"));
 const EditGrid_edit_validation_1 = __importDefault(require("./editForm/EditGrid.edit.validation"));
+/**
+ * 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

@@ -88,7 +88,7 @@ class EditGridComponent extends NestedArrayComponent_1.default {
       {% if (!instance.options.readOnly && !instance.disabled) { %}
         <div class="col-sm-2">
           <div class="btn-group pull-right">
-            <button class="btn btn-default btn-light btn-sm editRow"><i class="{{ iconClass('pen-fill') }}"></i></button>
+            <button class="btn btn-default btn-light btn-sm editRow"><i class="{{ iconClass('edit') }}"></i></button>
             {% if (!instance.hasRemoveButtons || instance.hasRemoveButtons()) { %}
               <button class="btn btn-danger btn-sm removeRow"><i class="{{ iconClass('trash') }}"></i></button>
             {% } %}
@@ -109,7 +109,7 @@ class EditGridComponent extends NestedArrayComponent_1.default {
         {% if (!instance.options.readOnly && !instance.disabled) { %}
           <td class="editgrid-table-column">
             <div class="btn-group">
-              <button class="btn btn-default btn-light btn-sm editRow" aria-label="{{ t('Edit row') }}"><i class="{{ iconClass('pen-fill') }}"></i></button>
+              <button class="btn btn-default btn-light btn-sm editRow" aria-label="{{ t('Edit row') }}"><i class="{{ iconClass('edit') }}"></i></button>
               {% if (!instance.hasRemoveButtons || instance.hasRemoveButtons()) { %}
               <button class="btn btn-danger btn-sm removeRow" aria-label="{{ t('Remove row') }}"><i class="{{ iconClass('trash') }}"></i></button>
               {% } %}
@@ -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.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 = [
     {
         type: 'textarea',
@@ -18,7 +15,7 @@ exports.default = [
         description: 'Two available variables. "value" is the array of row data and "components" is the array of components in the grid.',
         tooltip: 'This is the <a href=\'https://lodash.com/docs/4.17.5#template\'>Lodash Template</a> used to render the header of the Edit grid.',
         customConditional({ data }) {
-            return (!Evaluator_1.default.noeval || Evaluator_1.default.protectedEval) && !data.displayAsTable;
+            return (!Evaluator_1.Evaluator.noeval || Evaluator_1.Evaluator.protectedEval) && !data.displayAsTable;
         }
     },
     {
@@ -34,7 +31,7 @@ exports.default = [
         description: 'Two available variables. "value" is the array of row data and "components" is the array of components in the grid.',
         tooltip: 'This is the <a href=\'https://lodash.com/docs/4.17.5#template\'>Lodash Template</a> used to render the header of the Edit grid.',
         customConditional({ data }) {
-            return (!Evaluator_1.default.noeval || Evaluator_1.default.protectedEval) && data.displayAsTable;
+            return (!Evaluator_1.Evaluator.noeval || Evaluator_1.Evaluator.protectedEval) && data.displayAsTable;
         }
     },
     {
@@ -52,7 +49,7 @@ exports.default = [
             ' To add click events, add the classes "editRow" and "removeRow" to elements.',
         tooltip: 'This is the <a href=\'https://lodash.com/docs/4.17.5#template\'>Lodash Template</a> used to render each row of the Edit grid.',
         customConditional({ data }) {
-            return (!Evaluator_1.default.noeval || Evaluator_1.default.protectedEval) && !data.displayAsTable;
+            return (!Evaluator_1.Evaluator.noeval || Evaluator_1.Evaluator.protectedEval) && !data.displayAsTable;
         }
     },
     {
@@ -70,7 +67,7 @@ exports.default = [
             ' To add click events, add the classes "editRow" and "removeRow" to elements.',
         tooltip: 'This is the <a href=\'https://lodash.com/docs/4.17.5#template\'>Lodash Template</a> used to render each row of the Edit grid.',
         customConditional({ data }) {
-            return (!Evaluator_1.default.noeval || Evaluator_1.default.protectedEval) && data.displayAsTable;
+            return (!Evaluator_1.Evaluator.noeval || Evaluator_1.Evaluator.protectedEval) && data.displayAsTable;
         }
     },
     {
@@ -85,7 +82,7 @@ exports.default = [
         description: 'Two available variables. "value" is the array of row data and "components" is the array of components in the grid.',
         tooltip: 'This is the <a href=\'https://lodash.com/docs/4.17.5#template\'>Lodash Template</a> used to render the footer of the Edit grid.',
         customConditional() {
-            return !Evaluator_1.default.noeval || Evaluator_1.default.protectedEval;
+            return !Evaluator_1.Evaluator.noeval || Evaluator_1.Evaluator.protectedEval;
         }
     },
     {

package/lib/cjs/components/email/Email.form.d.ts

@@ -1,3 +1,6 @@
-export default function _default(...extend: any[]): {
-    components: any;
-};
+/**
+ * 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[]): import('@formio/core').Component[];

package/lib/cjs/components/email/Email.form.js

@@ -6,6 +6,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const TextField_form_1 = __importDefault(require("../textfield/TextField.form"));
 const Email_edit_display_1 = __importDefault(require("./editForm/Email.edit.display"));
 const Email_edit_validation_1 = __importDefault(require("./editForm/Email.edit.validation"));
+/**
+ * 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/fieldset/Fieldset.form.d.ts

@@ -1,3 +1,6 @@
-export default function _default(...extend: any[]): {
-    components: any;
-};
+/**
+ * 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[]): import('@formio/core').Component[];

package/lib/cjs/components/fieldset/Fieldset.form.js

@@ -5,6 +5,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const NestedComponent_form_1 = __importDefault(require("../_classes/nested/NestedComponent.form"));
 const Fieldset_edit_display_1 = __importDefault(require("./editForm/Fieldset.edit.display"));
+/**
+ * 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)([
         {