@formio/js 5.0.0-dev.5613.3476921 → 5.0.0-dev.5614.b5c93f3

package/lib/cjs/components/textfield/TextField.d.ts

@@ -10,55 +10,39 @@ export default class TextFieldComponent extends Input {
     static get serverConditionSettings(): {
         operators: any[];
         valueComponent(classComp: any): any;
-        constructor: Function;
-        toString(): string;
-        toLocaleString(): string;
-        valueOf(): Object;
-        hasOwnProperty(v: PropertyKey): boolean;
-        isPrototypeOf(v: Object): boolean;
-        propertyIsEnumerable(v: PropertyKey): boolean;
     };
     static get conditionOperatorsSettings(): {
         operators: any[];
         valueComponent(classComp: any): any;
-        constructor: Function;
-        toString(): string;
-        toLocaleString(): string;
-        valueOf(): Object;
-        hasOwnProperty(v: PropertyKey): boolean;
-        isPrototypeOf(v: Object): boolean;
-        propertyIsEnumerable(v: PropertyKey): boolean;
     };
     static savedValueTypes(schema: any): string[];
     get emptyValue(): string;
     /**
-     * Returns the mask value object.
-     *
-     * @param value
-     * @param flags
-     * @return {*}
+     * Returns the mask value object (mutates value!).
+     * @param {any} [value] - The value to convert to a mask value.
+     * @param {any} [flags] - The flags to use when converting to a mask value.
+     * @returns {*} - The value as a mask value.
      */
-    maskValue(value: any, flags?: {}): any;
+    maskValue(value?: any, flags?: any): any;
     /**
      * Normalize the value set in the data object.
-     *
-     * @param value
-     * @param flags
-     * @return {*}
+     * @param {any} value - The value to normalize.
+     * @param {any} flags - The flags to use when normalizing the value.
+     * @returns {*} - Returns the normalized value.
      */
-    normalizeValue(value: any, flags?: {}): any;
-    unmaskValue(value: any, format?: any): any;
+    normalizeValue(value: any, flags?: any): any;
+    unmaskValue(value: any, format?: any): string;
     /**
      * Returns the value at this index.
-     *
-     * @param index
-     * @return {*}
+     * @param {number} index - The index to get the value from.
+     * @returns {*} - The value at the index.
      */
-    getValueAt(index: any): any;
+    getValueAt(index: number): any;
     checkInputMaskValue(inputMask: any): boolean;
     setInputMask(input: any, inputMask: any, usePlaceholder: any): void;
     isHtmlRenderMode(): any;
     truncateMultipleSpaces(value: any): any;
     beforeSubmit(): Promise<any>;
+    getValueAsString(value: any, options: any): string;
 }
 import Input from '../_classes/input/Input';

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

@@ -7,6 +7,11 @@ const Components_1 = __importDefault(require("../Components"));
 const TextField_edit_data_1 = __importDefault(require("./editForm/TextField.edit.data"));
 const TextField_edit_display_1 = __importDefault(require("./editForm/TextField.edit.display"));
 const TextField_edit_validation_1 = __importDefault(require("./editForm/TextField.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/textfield/TextField.js

@@ -111,11 +111,10 @@ class TextFieldComponent extends Input_1.default {
         return super.attach(element);
     }
     /**
-     * Returns the mask value object.
-     *
-     * @param value
-     * @param flags
-     * @return {*}
+     * Returns the mask value object (mutates value!).
+     * @param {any} [value] - The value to convert to a mask value.
+     * @param {any} [flags] - The flags to use when converting to a mask value.
+     * @returns {*} - The value as a mask value.
      */
     maskValue(value, flags = {}) {
         // Convert it into the correct format.
@@ -134,10 +133,9 @@ class TextFieldComponent extends Input_1.default {
     }
     /**
      * Normalize the value set in the data object.
-     *
-     * @param value
-     * @param flags
-     * @return {*}
+     * @param {any} value - The value to normalize.
+     * @param {any} flags - The flags to use when normalizing the value.
+     * @returns {*} - Returns the normalized value.
      */
     normalizeValue(value, flags = {}) {
         if (!this.isMultipleMasksField) {
@@ -150,10 +148,10 @@ class TextFieldComponent extends Input_1.default {
     }
     /**
      * Sets the value at this index.
-     *
-     * @param index
-     * @param value
-     * @param flags
+     * @param {number} index - The index to set the value at.
+     * @param {any} value - The value to set.
+     * @param {any} [flags] - The flags to use when setting the value.
+     * @returns {void}
      */
     setValueAt(index, value, flags = {}) {
         if (!this.isMultipleMasksField) {
@@ -165,6 +163,9 @@ class TextFieldComponent extends Input_1.default {
         const maskInput = this.refs.select ? this.refs.select[index] : null;
         const mask = this.getMaskPattern(value.maskName);
         if (textInput && maskInput && mask) {
+            // We need to set the maskInput (select dropdown) value before calling inputmask.setValue because, this
+            // function will trigger a "change" event, which was calling updateValue setting the mask type to an incorrect value.
+            maskInput.value = value.maskName;
             if (textInput.inputmask) {
                 this.setInputMask(textInput, mask);
                 textInput.inputmask.setValue(textValue);
@@ -173,7 +174,6 @@ class TextFieldComponent extends Input_1.default {
                 const placeholderChar = this.placeholderChar;
                 textInput.value = (0, vanilla_text_mask_1.conformToMask)(textValue, FormioUtils.getInputMask(mask), { placeholderChar }).conformedValue;
             }
-            maskInput.value = value.maskName;
         }
         else {
             return super.setValueAt(index, textValue, flags);
@@ -185,9 +185,8 @@ class TextFieldComponent extends Input_1.default {
     }
     /**
      * Returns the value at this index.
-     *
-     * @param index
-     * @return {*}
+     * @param {number} index - The index to get the value from.
+     * @returns {*} - The value at the index.
      */
     getValueAt(index) {
         var _a, _b;

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

@@ -6,6 +6,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const Component_form_1 = __importDefault(require("../_classes/component/Component.form"));
 const Time_edit_data_1 = __importDefault(require("./editForm/Time.edit.data"));
 const Time_edit_display_1 = __importDefault(require("./editForm/Time.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, Component_form_1.default)([
         {

package/lib/cjs/components/unknown/Unknown.form.d.ts

@@ -1,34 +1,5 @@
-export default function _default(): {
-    components: {
-        type: string;
-        key: string;
-        components: {
-            label: string;
-            key: string;
-            weight: number;
-            components: ({
-                key: string;
-                label: string;
-                input: boolean;
-                tag: string;
-                content: string;
-                type: string;
-                weight: number;
-                as?: undefined;
-                editor?: undefined;
-                tooltip?: undefined;
-            } | {
-                type: string;
-                as: string;
-                editor: string;
-                weight: number;
-                input: boolean;
-                key: string;
-                label: string;
-                tooltip: string;
-                tag?: undefined;
-                content?: undefined;
-            })[];
-        }[];
-    }[];
-};
+/**
+ * Unknown Component schema.
+ * @returns {object} - The Unknown Component edit form.
+ */
+export default function _default(): object;

package/lib/cjs/components/unknown/Unknown.form.js

@@ -4,6 +4,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const Unknown_edit_display_1 = __importDefault(require("./editForm/Unknown.edit.display"));
+/**
+ * Unknown Component schema.
+ * @returns {object} - The Unknown Component edit form.
+ */
 function default_1() {
     return {
         components: [

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

@@ -7,6 +7,11 @@ const TextField_form_1 = __importDefault(require("../textfield/TextField.form"))
 const Url_edit_display_1 = __importDefault(require("./editForm/Url.edit.display"));
 const Url_edit_data_1 = __importDefault(require("./editForm/Url.edit.data"));
 const Url_edit_validation_1 = __importDefault(require("./editForm/Url.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/well/Well.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/well/Well.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 Well_edit_display_1 = __importDefault(require("./editForm/Well.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)([
         {

package/lib/cjs/formio.embed.d.ts

@@ -1,2 +1 @@
-export { Formio };
-import { Formio } from './Embed';
+export {};

package/lib/cjs/formio.embed.js

@@ -1,102 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Formio = void 0;
-const Embed_1 = require("./Embed");
-Object.defineProperty(exports, "Formio", { enumerable: true, get: function () { return Embed_1.Formio; } });
-const scripts = document.getElementsByTagName('script');
-const config = window.FormioConfig || {};
-let thisScript = null;
-let i = scripts.length;
-const scriptName = config.scriptName || 'formio.embed.';
-while (i--) {
-    if (scripts[i].src && (scripts[i].src.indexOf(scriptName) !== -1)) {
-        thisScript = scripts[i];
-        break;
-    }
-}
-if (thisScript) {
-    const query = {};
-    const queryString = thisScript.src.replace(/^[^?]+\??/, '');
-    queryString.replace(/\?/g, '&').split('&').forEach((item) => {
-        query[item.split('=')[0]] = item.split('=')[1] && decodeURIComponent(item.split('=')[1]);
-    });
-    let scriptSrc = thisScript.src.replace(/^([^?]+).*/, '$1').split('/');
-    scriptSrc.pop();
-    if (config.formioPath) {
-        config.formioPath(scriptSrc);
-    }
-    scriptSrc = scriptSrc.join('/');
-    const debug = (query.debug === 'true' || query.debug === '1');
-    const renderer = debug ? 'formio.form' : 'formio.form.min';
-    Embed_1.Formio.config = Object.assign({
-        script: query.script || (`${config.updatePath ? config.updatePath() : scriptSrc}/${renderer}.js`),
-        style: query.styles || (`${config.updatePath ? config.updatePath() : scriptSrc}/${renderer}.css`),
-        cdn: query.cdn,
-        class: (query.class || 'formio-form-wrapper'),
-        src: query.src,
-        form: null,
-        submission: null,
-        project: query.project,
-        base: query.base || 'https://api.form.io',
-        submit: query.submit,
-        includeLibs: (query.libs === 'true' || query.libs === '1'),
-        template: query.template,
-        debug: debug,
-        config: {},
-        redirect: (query.return || query.redirect),
-        embedCSS: (`${config.updatePath ? config.updatePath() : scriptSrc}/formio.embed.css`),
-        success: query.success || 'Thank you for your submission!',
-        before: null,
-        after: null
-    }, config);
-    const form = (Embed_1.Formio.config.form || Embed_1.Formio.config.src);
-    if (form) {
-        Embed_1.Formio.debug('Embedding Configuration', config);
-        if (Embed_1.Formio.config.addPremiumLib) {
-            Embed_1.Formio.config.addPremiumLib(Embed_1.Formio.config, scriptSrc);
-        }
-        // The id for this embedded form.
-        Embed_1.Formio.config.id = `formio-${Math.random().toString(36).substring(7)}`;
-        Embed_1.Formio.debug('Creating form element');
-        const element = Embed_1.Formio.createElement('div', {
-            'id': Embed_1.Formio.config.id,
-            class: Embed_1.Formio.config.class
-        });
-        // insertAfter doesn't exist, but effect is identical.
-        thisScript.parentNode.insertBefore(element, thisScript.parentNode.firstElementChild.nextSibling);
-        Embed_1.Formio.createForm(element, form, Embed_1.Formio.config.config).then((instance) => {
-            if (Embed_1.Formio.config.submit) {
-                instance.nosubmit = true;
-            }
-            // Configure a redirect.
-            instance.on('submit', (submission) => {
-                Embed_1.Formio.debug("on('submit')", submission);
-                if (Embed_1.Formio.config.submit) {
-                    Embed_1.Formio.debug(`Sending submission to ${Embed_1.Formio.config.submit}`);
-                    const headers = {
-                        'content-type': 'application/json'
-                    };
-                    const token = Embed_1.Formio.FormioClass.getToken();
-                    if (token) {
-                        headers['x-jwt-token'] = token;
-                    }
-                    Embed_1.Formio.FormioClass.fetch(Embed_1.Formio.config.submit, {
-                        body: JSON.stringify(submission),
-                        headers: headers,
-                        method: 'POST',
-                        mode: 'cors',
-                    })
-                        .then(resp => resp.json())
-                        .then(submission => Embed_1.Formio.submitDone(instance, submission));
-                }
-                else {
-                    Embed_1.Formio.submitDone(instance, submission);
-                }
-            });
-        });
-    }
-}
-else {
-    // Show an error if the script cannot be found.
-    document.write('<span>Could not locate the Embedded form.</span>');
-}
+const InlineEmbed_1 = require("./InlineEmbed");
+(0, InlineEmbed_1.embed)();

package/lib/cjs/formio.form.d.ts

@@ -1,10 +1,17 @@
 /**
  * Register a module
- * @param {*} plugin
- * @returns
+ * @param {any} mod - The module object to register. This can also be a function which accepts Formio as an argument.
+ * @param {Function|null} [defaultFn] - The default function to call if the module does not have a known key.
+ * @param {any} options - Options for the module.
+ * @returns {void}
  */
-export function registerModule(mod: any, defaultFn?: null, options?: {}): void;
-export function useModule(defaultFn?: null): (plugins: any, options?: {}) => void;
+export function registerModule(mod: any, defaultFn?: Function | null | undefined, options?: any): void;
+/**
+ * @param {Function|null} defaultFn - The default function to call if the module does not have a known key.
+ * @returns {void}
+ */
+export function useModule(defaultFn?: Function | null): void;
+export { Formio as FormioCore } from "./Formio";
 import Components from './components/Components';
 import Displays from './displays/Displays';
 import Providers from './providers';

package/lib/cjs/formio.form.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.Webform = exports.EventEmitter = exports.Licenses = exports.Formio = exports.Form = exports.Utils = exports.Templates = exports.Widgets = exports.Providers = exports.Displays = exports.Components = exports.useModule = exports.registerModule = void 0;
+exports.Webform = exports.EventEmitter = exports.Licenses = exports.Formio = exports.Form = exports.Utils = exports.Templates = exports.Widgets = exports.Providers = exports.Displays = exports.Components = exports.FormioCore = exports.useModule = exports.registerModule = void 0;
 const lodash_1 = __importDefault(require("lodash"));
 const Formio_1 = require("./Formio");
 Object.defineProperty(exports, "Formio", { enumerable: true, get: function () { return Formio_1.Formio; } });
@@ -22,7 +22,7 @@ const Form_1 = __importDefault(require("./Form"));
 exports.Form = Form_1.default;
 const utils_1 = __importDefault(require("./utils"));
 exports.Utils = utils_1.default;
-const Evaluator_1 = __importDefault(require("./utils/Evaluator"));
+const Evaluator_1 = require("./utils/Evaluator");
 const licenses_1 = __importDefault(require("./licenses"));
 exports.Licenses = licenses_1.default;
 const EventEmitter_1 = __importDefault(require("./EventEmitter"));
@@ -44,7 +44,7 @@ Formio_1.Formio.Form = Form_1.default;
 Formio_1.Formio.Displays = Displays_1.default;
 Formio_1.Formio.Providers = providers_1.default;
 Formio_1.Formio.Widgets = widgets_1.default;
-Formio_1.Formio.Evaluator = Evaluator_1.default;
+Formio_1.Formio.Evaluator = Evaluator_1.Evaluator;
 Formio_1.Formio.AllComponents = components_1.default;
 Formio_1.Formio.Licenses = licenses_1.default;
 // This is strange, but is needed for "premium" components to import correctly.
@@ -52,8 +52,10 @@ Formio_1.Formio.Formio = Formio_1.Formio;
 Formio_1.Formio.Components.setComponents(components_1.default);
 /**
  * Register a module
- * @param {*} plugin
- * @returns
+ * @param {any} mod - The module object to register. This can also be a function which accepts Formio as an argument.
+ * @param {Function|null} [defaultFn] - The default function to call if the module does not have a known key.
+ * @param {any} options - Options for the module.
+ * @returns {void}
  */
 function registerModule(mod, defaultFn = null, options = {}) {
     if (typeof mod === 'function') {
@@ -115,6 +117,10 @@ function registerModule(mod, defaultFn = null, options = {}) {
     }
 }
 exports.registerModule = registerModule;
+/**
+ * @param {Function|null} defaultFn - The default function to call if the module does not have a known key.
+ * @returns {void}
+ */
 function useModule(defaultFn = null) {
     return (plugins, options = {}) => {
         plugins = lodash_1.default.isArray(plugins) ? plugins : [plugins];
@@ -136,3 +142,5 @@ exports.useModule = useModule;
  * Formio.plugins([plugin1, plugin2, etc], options);
  */
 Formio_1.Formio.use = useModule();
+var Formio_2 = require("./Formio");
+Object.defineProperty(exports, "FormioCore", { enumerable: true, get: function () { return Formio_2.Formio; } });

package/lib/cjs/providers/Providers.d.ts

@@ -1,7 +1,14 @@
+/**
+ * @class Providers
+ * @classdesc Represents a collection of providers.
+ */
+/**
+ * Represents a collection of providers.
+ */
 export default class Providers {
     static providers: {
         address: {
-            [x: string]: typeof import("./address/CustomAddressProvider").CustomAddressProvider | typeof import("./address/GoogleAddressProvider").GoogleAddressProvider;
+            [x: string]: typeof import("./address/AzureAddressProvider").AzureAddressProvider | typeof import("./address/CustomAddressProvider").CustomAddressProvider | typeof import("./address/GoogleAddressProvider").GoogleAddressProvider | typeof import("./address/NominatimAddressProvider").NominatimAddressProvider;
         };
         auth: {};
         storage: {
@@ -13,8 +20,32 @@ export default class Providers {
             googledrive: typeof import("./storage/googleDrive").default;
         };
     };
-    static addProvider(type: any, name: any, provider: any): void;
-    static addProviders(type: any, providers: any): void;
-    static getProvider(type: any, name: any): any;
-    static getProviders(type: any): any;
+    /**
+     * Adds a provider to the collection.
+     * @param {string} type - The type of the provider.
+     * @param {string} name - The name of the provider.
+     * @param {Provider} provider - The provider object.
+     */
+    static addProvider(type: string, name: string, provider: Provider): void;
+    /**
+     * Adds multiple providers to the collection.
+     * @param {string} type - The type of the providers.
+     * @param {{ [key: string]: Provider }} providers - The collection of providers.
+     */
+    static addProviders(type: string, providers: {
+        [key: string]: Provider;
+    }): void;
+    /**
+     * Retrives a provider a provider from the collection.
+     * @param {string} type - The type of the provider.
+     * @param {string} name - The name of the provider.
+     * @returns {Provider | void} The provider object.
+     */
+    static getProvider(type: string, name: string): Provider | void;
+    /**
+     * Retrives all providers of a given type.
+     * @param {string} type - The type of the providers.
+     * @returns {Provider[] | void} The collection of providers.
+     */
+    static getProviders(type: string): Provider[] | void;
 }

package/lib/cjs/providers/Providers.js

@@ -7,19 +7,48 @@ const lodash_1 = __importDefault(require("lodash"));
 const address_1 = __importDefault(require("./address"));
 const auth_1 = __importDefault(require("./auth"));
 const storage_1 = __importDefault(require("./storage"));
+/**
+ * @class Providers
+ * @classdesc Represents a collection of providers.
+ */
+/**
+ * Represents a collection of providers.
+ */
 class Providers {
+    /**
+     * Adds a provider to the collection.
+     * @param {string} type - The type of the provider.
+     * @param {string} name - The name of the provider.
+     * @param {Provider} provider - The provider object.
+     */
     static addProvider(type, name, provider) {
         Providers.providers[type] = Providers.providers[type] || {};
         Providers.providers[type][name] = provider;
     }
+    /**
+     * Adds multiple providers to the collection.
+     * @param {string} type - The type of the providers.
+     * @param {{ [key: string]: Provider }} providers - The collection of providers.
+     */
     static addProviders(type, providers) {
         Providers.providers[type] = lodash_1.default.merge(Providers.providers[type], providers);
     }
+    /**
+     * Retrives a provider a provider from the collection.
+     * @param {string} type - The type of the provider.
+     * @param {string} name - The name of the provider.
+     * @returns {Provider | void} The provider object.
+     */
     static getProvider(type, name) {
         if (Providers.providers[type] && Providers.providers[type][name]) {
             return Providers.providers[type][name];
         }
     }
+    /**
+     * Retrives all providers of a given type.
+     * @param {string} type - The type of the providers.
+     * @returns {Provider[] | void} The collection of providers.
+     */
     static getProviders(type) {
         if (Providers.providers[type]) {
             return Providers.providers[type];