@formio/js 5.1.0-dev.6000.fab85ea → 5.1.0-dev.6007.fade2e3

package/lib/cjs/Webform.d.ts

@@ -190,7 +190,10 @@ declare class Webform extends NestedDataComponent {
     get language(): string;
     root: this;
     localRoot: this;
+    beforeInit(): void;
+    executeFormController: any;
     get emptyValue(): null;
+    get shouldCallFormController(): any;
     get shadowRoot(): any;
     /**
      * Add a language for translations
@@ -360,7 +363,7 @@ declare class Webform extends NestedDataComponent {
      * @returns {Promise} - The promise that is triggered when the form is built.
      */
     init(): Promise<any>;
-    executeFormController(): false | undefined;
+    _executeFormController(): void;
     build(element: any): Promise<any>;
     getClassName(): string;
     render(): string;

package/lib/cjs/Webform.js

@@ -315,12 +315,24 @@ class Webform extends NestedDataComponent_1.default {
         this.localRoot = this;
     }
     /* eslint-enable max-statements */
+    beforeInit() {
+        this.executeFormController = lodash_1.default.once(this._executeFormController);
+    }
     get language() {
         return this.options.language;
     }
     get emptyValue() {
         return null;
     }
+    get shouldCallFormController() {
+        // If no controller value or
+        // hidden and set to clearOnHide (Don't calculate a value for a hidden field set to clear when hidden)
+        return (this.form &&
+            this.form.controller &&
+            !((!this.visible || this.component.hidden) &&
+                this.component.clearOnHide &&
+                !this.rootPristine));
+    }
     componentContext() {
         return this._data;
     }
@@ -899,19 +911,12 @@ class Webform extends NestedDataComponent_1.default {
         this.on('resetForm', () => this.resetValue(), true);
         this.on('deleteSubmission', () => this.deleteSubmission(), true);
         this.on('refreshData', () => this.updateValue(), true);
-        this.executeFormController();
+        if (this.shouldCallFormController) {
+            this.executeFormController();
+        }
         return this.formReady;
     }
-    executeFormController() {
-        // If no controller value or
-        // hidden and set to clearOnHide (Don't calculate a value for a hidden field set to clear when hidden)
-        if (!this.form ||
-            !this.form.controller ||
-            ((!this.visible || this.component.hidden) &&
-                this.component.clearOnHide &&
-                !this.rootPristine)) {
-            return false;
-        }
+    _executeFormController() {
         this.formReady.then(() => {
             this.evaluate(this.form.controller, {
                 components: this.components,

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

@@ -2,6 +2,7 @@ export default class Components {
     static _editFormUtils: {
         sortAndFilterComponents(components: any): any;
         unifyComponents(objValue: any, srcValue: any): any;
+        tokenVariableDescription(): string;
         logicVariablesTable(additional: any): {
             type: string;
             tag: string;
@@ -86,6 +87,7 @@ export default class Components {
     static set EditFormUtils(value: {
         sortAndFilterComponents(components: any): any;
         unifyComponents(objValue: any, srcValue: any): any;
+        tokenVariableDescription(): string;
         logicVariablesTable(additional: any): {
             type: string;
             tag: string;
@@ -169,6 +171,7 @@ export default class Components {
     static get EditFormUtils(): {
         sortAndFilterComponents(components: any): any;
         unifyComponents(objValue: any, srcValue: any): any;
+        tokenVariableDescription(): string;
         logicVariablesTable(additional: any): {
             type: string;
             tag: string;

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

@@ -453,6 +453,9 @@ class Component extends Element_1.default {
         // Allow anyone to hook into the component creation.
         this.hook('component');
         if (!this.options.skipInit) {
+            if (typeof this.beforeInit === 'function') {
+                this.beforeInit();
+            }
             this.init();
         }
     }

package/lib/cjs/components/_classes/component/editForm/Component.edit.conditional.js

@@ -50,6 +50,6 @@ exports.default = [
     },
     utils_1.default.javaScriptValue('Advanced Conditions', 'customConditional', 'conditional.json', 110, '<p>You must assign the <strong>show</strong> variable a boolean result.</p>' +
         '<p><strong>Note: Advanced Conditional logic will override the results of the Simple Conditional logic.</strong></p>' +
-        '<h5>Example</h5><pre>show = !!data.showMe;</pre>', '<p><a href="https://help.form.io/userguide/form-building/logic-and-conditions" target="_blank" rel="noopener noreferrer">Click here for an example</a></p>')
+        '<h5>Example</h5><pre>show = !!data.showMe;</pre>', '<p><a href="https://help.form.io/userguide/form-building/logic-and-conditions" target="_blank" rel="noopener noreferrer">Click here for an example</a></p>', utils_1.default.tokenVariableDescription())
 ];
 /* eslint-enable quotes, max-len */

package/lib/cjs/components/_classes/component/editForm/Component.edit.data.js

@@ -140,7 +140,7 @@ exports.default = [
         input: true
     },
     utils_1.default.javaScriptValue('Custom Default Value', 'customDefaultValue', 'customDefaultValue', 1000, '<p><h4>Example:</h4><pre>value = data.firstName + " " + data.lastName;</pre></p>', '<p><h4>Example:</h4><pre>{"cat": [{"var": "data.firstName"}, " ", {"var": "data.lastName"}]}</pre>'),
-    utils_1.default.javaScriptValue('Calculated Value', 'calculateValue', 'calculateValue', 1100, '<p><h4>Example:</h4><pre>value = data.a + data.b + data.c;</pre></p>', '<p><h4>Example:</h4><pre>{"+": [{"var": "data.a"}, {"var": "data.b"}, {"var": "data.c"}]}</pre><p><a href="https://help.form.io/userguide/form-building/logic-and-conditions#calculated-values" target="_blank" rel="noopener noreferrer">Click here for an example</a></p>', '<tr><th>token</th><td>The decoded JWT token for the authenticated user.</td></tr>'),
+    utils_1.default.javaScriptValue('Calculated Value', 'calculateValue', 'calculateValue', 1100, '<p><h4>Example:</h4><pre>value = data.a + data.b + data.c;</pre></p>', '<p><h4>Example:</h4><pre>{"+": [{"var": "data.a"}, {"var": "data.b"}, {"var": "data.c"}]}</pre><p><a href="https://help.form.io/userguide/form-building/logic-and-conditions#calculated-values" target="_blank" rel="noopener noreferrer">Click here for an example</a></p>', utils_1.default.tokenVariableDescription()),
     {
         type: 'checkbox',
         input: true,

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

@@ -2,6 +2,7 @@ export default EditFormUtils;
 declare namespace EditFormUtils {
     function sortAndFilterComponents(components: any): any;
     function unifyComponents(objValue: any, srcValue: any): any;
+    function tokenVariableDescription(): string;
     function logicVariablesTable(additional: any): {
         type: string;
         tag: string;

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

@@ -37,6 +37,9 @@ const EditFormUtils = {
         }
         return lodash_1.default.isEqual(objValue, srcValue);
     },
+    tokenVariableDescription() {
+        return '<tr><th>token</th><td>The decoded JWT token for the authenticated user.</td></tr>';
+    },
     logicVariablesTable(additional) {
         additional = additional || '';
         return {

package/lib/cjs/components/form/editForm/Form.edit.form.js

@@ -69,7 +69,7 @@ exports.default = [
         input: true,
         weight: 20,
         key: 'reference',
-        label: 'Save as reference',
-        tooltip: 'Using this option will save this field as a reference and link its value to the value of the origin record.'
+        label: 'Submit as reference',
+        tooltip: 'When "Submit as reference" is enabled, the form submission will be recorded against the Parent Form as well as the Child Form. When a submission recorded with "Submit as reference" is edited, the update is applied to each submission made against the Parent Form and Child Form.'
     }
 ];

package/lib/cjs/components/select/editForm/Select.edit.data.js

@@ -641,8 +641,8 @@ exports.default = [
         input: true,
         weight: 25,
         key: 'reference',
-        label: 'Save as reference',
-        tooltip: 'Using this option will save this field as a reference and link its value to the value of the origin record.',
+        label: 'Submit as reference',
+        tooltip: 'Using this option will submit this field as a reference id and link its value to the value of the origin record.',
         conditional: {
             json: { '===': [{ var: 'data.dataSrc' }, 'resource'] },
         },

package/lib/mjs/Webform.d.ts

@@ -190,7 +190,10 @@ declare class Webform extends NestedDataComponent {
     get language(): string;
     root: this;
     localRoot: this;
+    beforeInit(): void;
+    executeFormController: any;
     get emptyValue(): null;
+    get shouldCallFormController(): any;
     get shadowRoot(): any;
     /**
      * Add a language for translations
@@ -360,7 +363,7 @@ declare class Webform extends NestedDataComponent {
      * @returns {Promise} - The promise that is triggered when the form is built.
      */
     init(): Promise<any>;
-    executeFormController(): false | undefined;
+    _executeFormController(): void;
     build(element: any): Promise<any>;
     getClassName(): string;
     render(): string;

package/lib/mjs/Webform.js

@@ -287,12 +287,24 @@ export default class Webform extends NestedDataComponent {
         this.localRoot = this;
     }
     /* eslint-enable max-statements */
+    beforeInit() {
+        this.executeFormController = _.once(this._executeFormController);
+    }
     get language() {
         return this.options.language;
     }
     get emptyValue() {
         return null;
     }
+    get shouldCallFormController() {
+        // If no controller value or
+        // hidden and set to clearOnHide (Don't calculate a value for a hidden field set to clear when hidden)
+        return (this.form &&
+            this.form.controller &&
+            !((!this.visible || this.component.hidden) &&
+                this.component.clearOnHide &&
+                !this.rootPristine));
+    }
     componentContext() {
         return this._data;
     }
@@ -902,19 +914,12 @@ export default class Webform extends NestedDataComponent {
         this.on('resetForm', () => this.resetValue(), true);
         this.on('deleteSubmission', () => this.deleteSubmission(), true);
         this.on('refreshData', () => this.updateValue(), true);
-        this.executeFormController();
+        if (this.shouldCallFormController) {
+            this.executeFormController();
+        }
         return this.formReady;
     }
-    executeFormController() {
-        // If no controller value or
-        // hidden and set to clearOnHide (Don't calculate a value for a hidden field set to clear when hidden)
-        if (!this.form ||
-            !this.form.controller ||
-            ((!this.visible || this.component.hidden) &&
-                this.component.clearOnHide &&
-                !this.rootPristine)) {
-            return false;
-        }
+    _executeFormController() {
         this.formReady.then(() => {
             this.evaluate(this.form.controller, {
                 components: this.components,

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

@@ -2,6 +2,7 @@ export default class Components {
     static _editFormUtils: {
         sortAndFilterComponents(components: any): any;
         unifyComponents(objValue: any, srcValue: any): any;
+        tokenVariableDescription(): string;
         logicVariablesTable(additional: any): {
             type: string;
             tag: string;
@@ -86,6 +87,7 @@ export default class Components {
     static set EditFormUtils(value: {
         sortAndFilterComponents(components: any): any;
         unifyComponents(objValue: any, srcValue: any): any;
+        tokenVariableDescription(): string;
         logicVariablesTable(additional: any): {
             type: string;
             tag: string;
@@ -169,6 +171,7 @@ export default class Components {
     static get EditFormUtils(): {
         sortAndFilterComponents(components: any): any;
         unifyComponents(objValue: any, srcValue: any): any;
+        tokenVariableDescription(): string;
         logicVariablesTable(additional: any): {
             type: string;
             tag: string;

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

@@ -418,6 +418,9 @@ export default class Component extends Element {
         // Allow anyone to hook into the component creation.
         this.hook('component');
         if (!this.options.skipInit) {
+            if (typeof this.beforeInit === 'function') {
+                this.beforeInit();
+            }
             this.init();
         }
     }

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

@@ -45,6 +45,6 @@ export default [
     },
     EditFormUtils.javaScriptValue('Advanced Conditions', 'customConditional', 'conditional.json', 110, '<p>You must assign the <strong>show</strong> variable a boolean result.</p>' +
         '<p><strong>Note: Advanced Conditional logic will override the results of the Simple Conditional logic.</strong></p>' +
-        '<h5>Example</h5><pre>show = !!data.showMe;</pre>', '<p><a href="https://help.form.io/userguide/form-building/logic-and-conditions" target="_blank" rel="noopener noreferrer">Click here for an example</a></p>')
+        '<h5>Example</h5><pre>show = !!data.showMe;</pre>', '<p><a href="https://help.form.io/userguide/form-building/logic-and-conditions" target="_blank" rel="noopener noreferrer">Click here for an example</a></p>', EditFormUtils.tokenVariableDescription())
 ];
 /* eslint-enable quotes, max-len */

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

@@ -135,7 +135,7 @@ export default [
         input: true
     },
     EditFormUtils.javaScriptValue('Custom Default Value', 'customDefaultValue', 'customDefaultValue', 1000, '<p><h4>Example:</h4><pre>value = data.firstName + " " + data.lastName;</pre></p>', '<p><h4>Example:</h4><pre>{"cat": [{"var": "data.firstName"}, " ", {"var": "data.lastName"}]}</pre>'),
-    EditFormUtils.javaScriptValue('Calculated Value', 'calculateValue', 'calculateValue', 1100, '<p><h4>Example:</h4><pre>value = data.a + data.b + data.c;</pre></p>', '<p><h4>Example:</h4><pre>{"+": [{"var": "data.a"}, {"var": "data.b"}, {"var": "data.c"}]}</pre><p><a href="https://help.form.io/userguide/form-building/logic-and-conditions#calculated-values" target="_blank" rel="noopener noreferrer">Click here for an example</a></p>', '<tr><th>token</th><td>The decoded JWT token for the authenticated user.</td></tr>'),
+    EditFormUtils.javaScriptValue('Calculated Value', 'calculateValue', 'calculateValue', 1100, '<p><h4>Example:</h4><pre>value = data.a + data.b + data.c;</pre></p>', '<p><h4>Example:</h4><pre>{"+": [{"var": "data.a"}, {"var": "data.b"}, {"var": "data.c"}]}</pre><p><a href="https://help.form.io/userguide/form-building/logic-and-conditions#calculated-values" target="_blank" rel="noopener noreferrer">Click here for an example</a></p>', EditFormUtils.tokenVariableDescription()),
     {
         type: 'checkbox',
         input: true,

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

@@ -2,6 +2,7 @@ export default EditFormUtils;
 declare namespace EditFormUtils {
     function sortAndFilterComponents(components: any): any;
     function unifyComponents(objValue: any, srcValue: any): any;
+    function tokenVariableDescription(): string;
     function logicVariablesTable(additional: any): {
         type: string;
         tag: string;

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

@@ -32,6 +32,9 @@ const EditFormUtils = {
         }
         return _.isEqual(objValue, srcValue);
     },
+    tokenVariableDescription() {
+        return '<tr><th>token</th><td>The decoded JWT token for the authenticated user.</td></tr>';
+    },
     logicVariablesTable(additional) {
         additional = additional || '';
         return {

package/lib/mjs/components/form/editForm/Form.edit.form.js

@@ -66,7 +66,7 @@ export default [
         input: true,
         weight: 20,
         key: 'reference',
-        label: 'Save as reference',
-        tooltip: 'Using this option will save this field as a reference and link its value to the value of the origin record.'
+        label: 'Submit as reference',
+        tooltip: 'When "Submit as reference" is enabled, the form submission will be recorded against the Parent Form as well as the Child Form. When a submission recorded with "Submit as reference" is edited, the update is applied to each submission made against the Parent Form and Child Form.'
     }
 ];

package/lib/mjs/components/select/editForm/Select.edit.data.js

@@ -635,8 +635,8 @@ export default [
         input: true,
         weight: 25,
         key: 'reference',
-        label: 'Save as reference',
-        tooltip: 'Using this option will save this field as a reference and link its value to the value of the origin record.',
+        label: 'Submit as reference',
+        tooltip: 'Using this option will submit this field as a reference id and link its value to the value of the origin record.',
         conditional: {
             json: { '===': [{ var: 'data.dataSrc' }, 'resource'] },
         },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@formio/js",
-  "version": "5.1.0-dev.6000.fab85ea",
+  "version": "5.1.0-dev.6007.fade2e3",
   "description": "JavaScript powered Forms with JSON Form Builder",
   "main": "lib/cjs/index.js",
   "exports": {