@formio/js 5.0.0-dev.5633.8d2b30d → 5.0.0-dev.5633.fde3bc9

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

@@ -2,6 +2,11 @@ import Components from '../Components';
 import TextFieldEditData from './editForm/TextField.edit.data';
 import TextFieldEditDisplay from './editForm/TextField.edit.display';
 import TextFieldEditValidation from './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.
+ */
 export default function (...extend) {
     return Components.baseEditForm([
         {

package/lib/mjs/components/textfield/TextField.js

@@ -95,11 +95,10 @@ export default class TextFieldComponent extends Input {
         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.
@@ -118,10 +117,9 @@ export default class TextFieldComponent extends Input {
     }
     /**
      * 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) {
@@ -134,10 +132,10 @@ export default class TextFieldComponent extends Input {
     }
     /**
      * 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) {
@@ -149,6 +147,9 @@ export default class TextFieldComponent extends Input {
         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);
@@ -157,7 +158,6 @@ export default class TextFieldComponent extends Input {
                 const placeholderChar = this.placeholderChar;
                 textInput.value = conformToMask(textValue, FormioUtils.getInputMask(mask), { placeholderChar }).conformedValue;
             }
-            maskInput.value = value.maskName;
         }
         else {
             return super.setValueAt(index, textValue, flags);
@@ -169,9 +169,8 @@ export default class TextFieldComponent extends Input {
     }
     /**
      * 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) {
         if (!this.isMultipleMasksField) {

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

@@ -1,6 +1,11 @@
 import baseEditForm from '../_classes/component/Component.form';
 import TimeEditData from './editForm/Time.edit.data';
 import TimeEditDisplay from './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.
+ */
 export default function (...extend) {
     return baseEditForm([
         {

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

@@ -1,4 +1,8 @@
 import UnknownEditDisplay from './editForm/Unknown.edit.display';
+/**
+ * Unknown Component schema.
+ * @returns {object} - The Unknown Component edit form.
+ */
 export default function () {
     return {
         components: [

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

@@ -2,6 +2,11 @@ import textEditForm from '../textfield/TextField.form';
 import UrlEditDisplay from './editForm/Url.edit.display';
 import UrlEditData from './editForm/Url.edit.data';
 import UrlEditValidation from './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.
+ */
 export default function (...extend) {
     return textEditForm([
         {

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

@@ -1,5 +1,10 @@
 import nestedComponentForm from '../_classes/nested/NestedComponent.form';
 import WellEditDisplay from './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.
+ */
 export default function (...extend) {
     return nestedComponentForm([
         {

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

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

package/lib/mjs/formio.embed.js

@@ -1,99 +1,2 @@
-import { Formio } from './Embed';
-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';
-    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 = (Formio.config.form || Formio.config.src);
-    if (form) {
-        Formio.debug('Embedding Configuration', config);
-        if (Formio.config.addPremiumLib) {
-            Formio.config.addPremiumLib(Formio.config, scriptSrc);
-        }
-        // The id for this embedded form.
-        Formio.config.id = `formio-${Math.random().toString(36).substring(7)}`;
-        Formio.debug('Creating form element');
-        const element = Formio.createElement('div', {
-            'id': Formio.config.id,
-            class: Formio.config.class
-        });
-        // insertAfter doesn't exist, but effect is identical.
-        thisScript.parentNode.insertBefore(element, thisScript.parentNode.firstElementChild.nextSibling);
-        Formio.createForm(element, form, Formio.config.config).then((instance) => {
-            if (Formio.config.submit) {
-                instance.nosubmit = true;
-            }
-            // Configure a redirect.
-            instance.on('submit', (submission) => {
-                Formio.debug("on('submit')", submission);
-                if (Formio.config.submit) {
-                    Formio.debug(`Sending submission to ${Formio.config.submit}`);
-                    const headers = {
-                        'content-type': 'application/json'
-                    };
-                    const token = Formio.FormioClass.getToken();
-                    if (token) {
-                        headers['x-jwt-token'] = token;
-                    }
-                    Formio.FormioClass.fetch(Formio.config.submit, {
-                        body: JSON.stringify(submission),
-                        headers: headers,
-                        method: 'POST',
-                        mode: 'cors',
-                    })
-                        .then(resp => resp.json())
-                        .then(submission => Formio.submitDone(instance, submission));
-                }
-                else {
-                    Formio.submitDone(instance, submission);
-                }
-            });
-        });
-    }
-}
-else {
-    // Show an error if the script cannot be found.
-    document.write('<span>Could not locate the Embedded form.</span>');
-}
-export { Formio };
+import { embed } from './InlineEmbed';
+embed();

package/lib/mjs/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/mjs/formio.form.js

@@ -8,7 +8,7 @@ import Providers from './providers';
 import Widgets from './widgets';
 import Form from './Form';
 import Utils from './utils';
-import Evaluator from './utils/Evaluator';
+import { Evaluator } from './utils/Evaluator';
 import Licenses from './licenses';
 import EventEmitter from './EventEmitter';
 import Webform from './Webform';
@@ -35,8 +35,10 @@ Formio.Formio = Formio;
 Formio.Components.setComponents(AllComponents);
 /**
  * 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, defaultFn = null, options = {}) {
     if (typeof mod === 'function') {
@@ -97,6 +99,10 @@ export function registerModule(mod, defaultFn = null, options = {}) {
         }
     }
 }
+/**
+ * @param {Function|null} defaultFn - The default function to call if the module does not have a known key.
+ * @returns {void}
+ */
 export function useModule(defaultFn = null) {
     return (plugins, options = {}) => {
         plugins = _.isArray(plugins) ? plugins : [plugins];
@@ -117,5 +123,6 @@ export function useModule(defaultFn = null) {
  * Formio.plugins([plugin1, plugin2, etc], options);
  */
 Formio.use = useModule();
+export { Formio as FormioCore } from './Formio';
 // Export the components.
 export { Components, Displays, Providers, Widgets, Templates, Utils, Form, Formio, Licenses, EventEmitter, Webform };

package/lib/mjs/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/mjs/providers/Providers.js

@@ -2,24 +2,53 @@ import _ from 'lodash';
 import address from './address';
 import auth from './auth';
 import storage from './storage';
+/**
+ * @class Providers
+ * @classdesc Represents a collection of providers.
+ */
+/**
+ * Represents a collection of providers.
+ */
 export default class Providers {
     static providers = {
         address,
         auth,
         storage,
     };
+    /**
+     * 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] = _.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];