@formio/js 5.0.0-rc.20 → 5.0.0-rc.22

package/lib/mjs/Embed.d.ts

@@ -1 +1,21 @@
-export function embed(config?: {}): void;
+export class Formio {
+    static baseUrl: any;
+    static projectUrl: any;
+    static language: any;
+    static wrapper: any;
+    static element: any;
+    static config: {};
+    static loader: null;
+    static cdn: null;
+    static proxy: boolean;
+    static setBaseUrl(url: any): Promise<void>;
+    static setProjectUrl(url: any): Promise<void>;
+    static debug(...args: any[]): void;
+    static global(prop: any): any;
+    static createElement(type: any, attrs: any, children: any): any;
+    static addScript(src: any, name: any): Promise<any>;
+    static addStyles(href: any, addGlobally?: boolean): Promise<void>;
+    static submitDone(instance: any, submission: any): Promise<void>;
+    static renderForm(form: any, options: any): Promise<any>;
+    static createForm(element: any, form: any, options: any): Promise<any>;
+}

package/lib/mjs/Embed.js

@@ -1,181 +1,179 @@
-import CDN from './CDN';
-// eslint-disable-next-line max-statements
-export function embed(config = {}) {
-    const scripts = document.getElementsByTagName('script');
-    config = Object.assign(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;
+import CDN from './CDN.js';
+class Formio {
+    static baseUrl;
+    static projectUrl;
+    static language;
+    static wrapper;
+    static element;
+    static config = {};
+    static loader = null;
+    static cdn = null;
+    static proxy = true;
+    static async setBaseUrl(url) {
+        Formio.baseUrl = url;
+    }
+    static async setProjectUrl(url) {
+        Formio.projectUrl = url;
+    }
+    static debug(...args) {
+        if (Formio.config.debug) {
+            console.log(...args);
+        }
+    }
+    static global(prop) {
+        const globalValue = window[prop];
+        if (globalValue && globalValue.proxy) {
+            return null;
         }
+        Formio.debug(`Getting global ${prop}`, globalValue);
+        return globalValue;
     }
-    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]);
+    static createElement(type, attrs, children) {
+        const element = document.createElement(type);
+        Object.keys(attrs).forEach(key => {
+            element.setAttribute(key, attrs[key]);
         });
-        let scriptSrc = thisScript.src.replace(/^([^?]+).*/, '$1').split('/');
-        scriptSrc.pop();
-        if (config.formioPath) {
-            config.formioPath(scriptSrc);
+        (children || []).forEach(child => {
+            element.appendChild(Formio.createElement(child.tag, child.attrs, child.children));
+        });
+        return element;
+    }
+    static async addScript(src, name) {
+        if (!src) {
+            return Promise.resolve();
         }
-        scriptSrc = scriptSrc.join('/');
-        query.script = query.script || (`${config.updatePath ? config.updatePath() : scriptSrc}/formio.form.min.js`);
-        query.styles = query.styles || (`${config.updatePath ? config.updatePath() : scriptSrc}/formio.form.min.css`);
-        const cdn = query.cdn || 'https://cdn.jsdelivr.net/npm';
-        const resolveLibs = (cdn) => {
-            const libs = {
-                uswds: {
-                    fa: true,
-                    js: `${cdn}/uswds@2.10.0/dist/js/uswds.min.js`,
-                    css: `${cdn}/uswds@2.10.0/dist/css/uswds.min.css`
-                },
-                fontawesome: {
-                    css: `${cdn}/font-awesome@4.7.0/css/font-awesome.min.css`
-                },
-                bootstrap: {
-                    css: `${cdn}/bootstrap@4.6.0/dist/css/bootstrap.min.css`
-                }
-            };
-            // Check if using cdn.form.io standart folders format
-            if (cdn instanceof CDN) {
-                const url = cdn.baseUrl;
-                libs.uswds.js = `${url}/uswds/${cdn.getVersion('uswds')}/uswds.min.js`;
-                libs.uswds.css = `${url}/uswds/${cdn.getVersion('uswds')}/uswds.min.css`;
-                libs.fontawesome.css = `${url}/font-awesome/${cdn.getVersion('font-awesome')}/css/font-awesome.min.css`;
-                libs.bootstrap.css = `${url}/bootstrap/${cdn.getVersion('bootstrap')}/css/bootstrap.min.css`;
-            }
-            return libs;
-        };
-        config = Object.assign({
-            script: query.script,
-            style: query.styles,
-            class: (query.class || 'formio-form-wrapper'),
-            src: query.src,
-            form: null,
-            submission: null,
-            project: query.project,
-            base: query.base,
-            submit: query.submit,
-            includeLibs: (query.libs === 'true' || query.libs === '1'),
-            template: query.template,
-            debug: (query.debug === 'true' || query.debug === '1'),
-            config: {},
-            redirect: (query.return || query.redirect),
-            before: () => { },
-            after: () => { }
-        }, config);
-        /**
-         * Print debug statements.
-         *
-         * @param  {...any} args Arguments to pass to the console.log method.
-         */
-        const debug = (...args) => {
-            if (config.debug) {
-                console.log(...args);
-            }
-        };
-        /**
-         * Creates a new DOM element.
-         *
-         * @param {string} tag The HTMLElement to add to the wrapper or shadow dom.
-         * @param {Object} attrs The attributes to add to this element.
-         * @param {Array<Object>} children The children attached to this element.
-         */
-        const createElement = (tag, attrs, children) => {
-            const element = document.createElement(tag);
-            for (const attr in attrs) {
-                if (attrs.hasOwnProperty(attr)) {
-                    element.setAttribute(attr, attrs[attr]);
+        if (typeof src !== 'string' && src.length) {
+            return Promise.all(src.map(ref => Formio.addScript(ref)));
+        }
+        if (name && Formio.global(name)) {
+            Formio.debug(`${name} already loaded.`);
+            return Promise.resolve(Formio.global(name));
+        }
+        Formio.debug('Adding Script', src);
+        Formio.wrapper.appendChild(Formio.createElement('script', {
+            src
+        }));
+        if (!name) {
+            return Promise.resolve();
+        }
+        return new Promise((resolve) => {
+            Formio.debug(`Waiting to load ${name}`);
+            const wait = setInterval(() => {
+                if (Formio.global(name)) {
+                    clearInterval(wait);
+                    Formio.debug(`${name} loaded.`);
+                    resolve(Formio.global(name));
                 }
-            }
-            (children || []).forEach(child => {
-                element.appendChild(createElement(child.tag, child.attrs, child.children));
-            });
-            return element;
-        };
-        debug('Embedding Configuration', config);
-        if (config.addPremiumLib) {
-            config.addPremiumLib(config, scriptSrc);
+            }, 100);
+        });
+    }
+    static async addStyles(href, addGlobally = false) {
+        if (!href) {
+            return;
+        }
+        if (typeof href !== 'string' && href.length) {
+            href.forEach(ref => Formio.addStyles(ref));
+            return;
         }
-        // The id for this embedded form.
-        const id = `formio-${Math.random().toString(36).substring(7)}`;
-        config.id = id;
-        debug('Creating form wrapper');
-        let wrapper = createElement('div', {
-            'id': `"${id}-wrapper"`
+        Formio.debug('Adding Styles', href);
+        const link = Formio.createElement('link', {
+            rel: 'stylesheet',
+            href
         });
-        // insertAfter doesn't exist, but effect is identical.
-        thisScript.parentNode.insertBefore(wrapper, thisScript.parentNode.firstElementChild.nextSibling);
-        // If we include the libraries, then we will attempt to run this in shadow dom.
-        if (config.includeLibs && (typeof wrapper.attachShadow === 'function') && !config.premium) {
-            wrapper = wrapper.attachShadow({
-                mode: 'open'
-            });
-            config.config.shadowRoot = wrapper;
+        if (addGlobally) {
+            // Add globally as well.
+            document.head.appendChild(link);
         }
-        const global = (name) => {
-            const globalValue = window[name];
-            debug(`Getting global ${name}`, globalValue);
-            return globalValue;
-        };
-        const addStyles = (href, global) => {
-            if (!href) {
-                return;
-            }
-            if (typeof href !== 'string' && href.length) {
-                href.forEach(ref => addStyles(ref));
-                return;
-            }
-            debug('Adding Styles', href);
-            const link = createElement('link', {
-                rel: 'stylesheet',
-                href
-            });
-            if (global) {
-                // Add globally as well.
-                document.head.appendChild(link);
-            }
-            wrapper.appendChild(createElement('link', {
-                rel: 'stylesheet',
-                href
-            }));
-        };
-        const addScript = (src, globalProp, onReady) => {
-            if (!src) {
-                return;
-            }
-            if (typeof src !== 'string' && src.length) {
-                src.forEach(ref => addScript(ref));
-                return;
-            }
-            if (globalProp && global(globalProp)) {
-                debug(`${globalProp} already loaded.`);
-                return global(globalProp);
+        Formio.wrapper.appendChild(Formio.createElement('link', {
+            rel: 'stylesheet',
+            href
+        }));
+    }
+    static async submitDone(instance, submission) {
+        Formio.debug('Submision Complete', submission);
+        let returnUrl = Formio.config.redirect;
+        // Allow form based configuration for return url.
+        if (!returnUrl &&
+            (instance._form &&
+                instance._form.settings &&
+                (instance._form.settings.returnUrl ||
+                    instance._form.settings.redirect))) {
+            Formio.debug('Return url found in form configuration');
+            returnUrl = instance._form.settings.returnUrl || instance._form.settings.redirect;
+        }
+        if (returnUrl) {
+            const formSrc = instance.formio ? instance.formio.formUrl : '';
+            const hasQuery = !!returnUrl.match(/\?/);
+            const isOrigin = returnUrl.indexOf(location.origin) === 0;
+            returnUrl += hasQuery ? '&' : '?';
+            returnUrl += `sub=${submission._id}`;
+            if (!isOrigin && formSrc) {
+                returnUrl += `&form=${encodeURIComponent(formSrc)}`;
+            }
+            Formio.debug('Return URL', returnUrl);
+            window.location.href = returnUrl;
+            if (isOrigin) {
+                window.location.reload();
             }
-            debug('Adding Script', src);
-            wrapper.appendChild(createElement('script', {
-                src
-            }));
-            if (globalProp && onReady) {
-                debug(`Waiting to load ${globalProp}`);
-                const wait = setInterval(() => {
-                    if (global(globalProp)) {
-                        clearInterval(wait);
-                        debug(`${globalProp} loaded.`);
-                        onReady(global(globalProp));
-                    }
-                }, 100);
+        }
+    }
+    static async renderForm(form, options) {
+        if (Formio.config.before) {
+            await Formio.config.before(Formio.FormioClass, Formio.element, Formio.config);
+        }
+        Formio.FormioClass.license = true;
+        return Formio.FormioClass.createForm(Formio.element, form, {
+            ...options,
+            ...{ noLoader: true }
+        }).then((instance) => {
+            Formio.debug('Form created', instance);
+            // Remove the loader.
+            Formio.debug('Removing loader');
+            Formio.wrapper.removeChild(Formio.loader);
+            // Set the default submission data.
+            if (Formio.config.submission) {
+                Formio.debug('Setting submission', Formio.config.submission);
+                instance.submission = Formio.config.submission;
+            }
+            // Allow them to provide additional configs.
+            Formio.debug('Triggering embed event');
+            Formio.FormioClass.events.emit('formEmbedded', instance);
+            // Trigger the after handler.
+            if (Formio.config.after) {
+                Formio.debug('Calling ready callback');
+                Formio.config.after(instance, Formio.config);
+            }
+            return instance;
+        });
+    }
+    // eslint-disable-next-line max-statements
+    static async createForm(element, form, options) {
+        Formio.element = element;
+        Formio.cdn = new CDN(Formio.config.cdn);
+        Formio.config.libs = Formio.config.libs || {
+            uswds: {
+                fa: true,
+                js: `${Formio.cdn.uswds}/uswds.min.js`,
+                css: `${Formio.cdn.uswds}/uswds.min.css`,
+            },
+            fontawesome: {
+                css: `${Formio.cdn['font-awesome']}/css/font-awesome.min.css`
+            },
+            bootstrap: {
+                css: `${Formio.cdn.bootstrap}/css/bootstrap.min.css`
             }
         };
-        // Create a loader
-        addStyles(`${config.updatePath ? config.updatePath() : scriptSrc}/formio.embed.min.css`);
-        debug('Creating loader');
-        const loader = createElement('div', {
+        Formio.config.id = Formio.config.id || `formio-${Math.random().toString(36).substring(7)}`;
+        // Create a new wrapper and add the element inside of a new wrapper.
+        Formio.wrapper = Formio.createElement('div', {
+            'id': `"${Formio.config.id}-wrapper"`
+        });
+        element.parentNode.insertBefore(Formio.wrapper, element);
+        element.parentNode.removeChild(element);
+        Formio.wrapper.appendChild(element);
+        // Load the renderer styles.
+        await Formio.addStyles(Formio.config.embedCSS || `${Formio.cdn.js}/formio.embed.css`);
+        Formio.loader = Formio.createElement('div', {
             'class': 'formio-loader'
         }, [{
                 tag: 'div',
@@ -189,163 +187,51 @@ export function embed(config = {}) {
                         }
                     }]
             }]);
-        wrapper.appendChild(loader);
-        // Add the wrapper for the rendered form.
-        debug('Creating form element');
-        const formElement = createElement('div', {
-            class: config.class
-        });
-        wrapper.appendChild(formElement);
-        // Add the main formio script.
-        addScript(config.script, 'Formio', (Formio) => {
-            const renderForm = () => {
-                addStyles(config.style);
-                const isReady = config.before(Formio, formElement, config) || Formio.Promise.resolve();
-                const form = (config.form || config.src);
-                debug('Creating form', form, config.config);
-                isReady.then(() => {
-                    Formio.license = true;
-                    Formio.createForm(formElement, form, {
-                        ...config.config,
-                        ...{ noLoader: true }
-                    }).then((instance) => {
-                        const submitDone = (submission) => {
-                            debug('Submision Complete', submission);
-                            let returnUrl = config.redirect;
-                            // Allow form based configuration for return url.
-                            if (!returnUrl &&
-                                (instance._form &&
-                                    instance._form.settings &&
-                                    (instance._form.settings.returnUrl ||
-                                        instance._form.settings.redirect))) {
-                                debug('Return url found in form configuration');
-                                returnUrl = instance._form.settings.returnUrl || instance._form.settings.redirect;
-                            }
-                            if (returnUrl) {
-                                const formSrc = instance.formio ? instance.formio.formUrl : '';
-                                const hasQuery = !!returnUrl.match(/\?/);
-                                const isOrigin = returnUrl.indexOf(location.origin) === 0;
-                                returnUrl += hasQuery ? '&' : '?';
-                                returnUrl += `sub=${submission._id}`;
-                                if (!isOrigin && formSrc) {
-                                    returnUrl += `&form=${encodeURIComponent(formSrc)}`;
-                                }
-                                debug('Return URL', returnUrl);
-                                window.location.href = returnUrl;
-                                if (isOrigin) {
-                                    window.location.reload();
-                                }
-                            }
-                        };
-                        if (config.submit) {
-                            instance.nosubmit = true;
-                        }
-                        debug('Form created', instance);
-                        // Remove the loader.
-                        debug('Removing loader');
-                        wrapper.removeChild(loader);
-                        // Set the default submission data.
-                        if (config.submission) {
-                            debug('Setting submission', config.submission);
-                            instance.submission = config.submission;
-                        }
-                        // Allow them to provide additional configs.
-                        debug('Triggering embed event');
-                        Formio.events.emit('formEmbedded', instance);
-                        debug('Calling ready callback');
-                        config.after(instance, config);
-                        // Configure a redirect.
-                        instance.on('submit', (submission) => {
-                            debug("on('submit')", submission);
-                            if (config.submit) {
-                                debug(`Sending submission to ${config.submit}`);
-                                const headers = {
-                                    'content-type': 'application/json'
-                                };
-                                const token = Formio.getToken();
-                                if (token) {
-                                    headers['x-jwt-token'] = token;
-                                }
-                                Formio.fetch(config.submit, {
-                                    body: JSON.stringify(submission),
-                                    headers: headers,
-                                    method: 'POST',
-                                    mode: 'cors',
-                                })
-                                    .then(resp => resp.json())
-                                    .then(submission => submitDone(submission));
-                            }
-                            else {
-                                submitDone(submission);
-                            }
-                        });
-                    });
-                });
-            };
-            if (config.base) {
-                Formio.setBaseUrl(config.base);
-            }
-            if (config.project) {
-                Formio.setProjectUrl(config.project);
-            }
-            // Add premium modules
-            if (global('premium')) {
-                debug('Using premium module.');
-                Formio.use(global('premium'));
-            }
-            if (global('vpat')) {
-                debug('Using vpat module.');
-                Formio.use(global('vpat'));
-            }
-            if (config.template) {
-                if (config.includeLibs) {
-                    addStyles(config.libs[config.template].css);
-                    addScript(config.libs[config.template].js);
-                    if (config.libs[config.template].fa) {
-                        addStyles(config.libs.fontawesome.css, true);
-                    }
-                }
-                let templateSrc;
-                if (cdn instanceof CDN) {
-                    templateSrc = `${cdn[config.template]}/${config.template}.min`;
-                }
-                else {
-                    templateSrc = `${cdn}/@formio/${config.template}@latest/dist/${config.template}.min`;
+        Formio.wrapper.appendChild(Formio.loader);
+        Formio.FormioClass = await Formio.addScript(Formio.config.script || `${Formio.cdn.js}/formio.form.min.js`, 'Formio');
+        Formio.FormioClass.setBaseUrl(Formio.baseUrl || Formio.config.base);
+        Formio.FormioClass.setProjectUrl(Formio.projectUrl || Formio.config.project);
+        Formio.FormioClass.language = Formio.language;
+        // Add premium modules
+        if (Formio.global('premium')) {
+            Formio.debug('Using premium module.');
+            Formio.FormioClass.use(Formio.global('premium'));
+        }
+        if (Formio.global('vpat')) {
+            Formio.debug('Using vpat module.');
+            Formio.FormioClass.use(Formio.global('vpat'));
+        }
+        if (Formio.config.template) {
+            if (Formio.config.includeLibs) {
+                await Formio.addStyles(Formio.config.libs[Formio.config.template].css);
+                await Formio.addScript(Formio.config.libs[Formio.config.template].js);
+                if (Formio.config.libs[Formio.config.template].fa) {
+                    await Formio.addStyles(Formio.config.libs.fontawesome.css, true);
                 }
-                addStyles(`${templateSrc}.css`);
-                addScript(`${templateSrc}.js`, config.template, (template) => {
-                    debug(`Using ${config.template}`);
-                    Formio.use(template);
-                    renderForm();
-                });
-            }
-            else if (global('uswds')) {
-                debug('Using uswds module.');
-                Formio.use(global('uswds'));
-            }
-            // Default bootstrap + fontawesome.
-            else if (config.includeLibs) {
-                Formio.cdn = new CDN();
-                config.libs = resolveLibs(query.cdn || Formio.cdn);
-                addStyles(config.libs.fontawesome.css, true);
-                addStyles(config.libs.bootstrap.css);
             }
-            if (config.premium) {
-                addStyles(config.premium.css);
-                addScript(config.premium.js, 'premium', (premium) => {
-                    debug('Using premium');
-                    Formio.use(premium);
-                    renderForm();
-                });
+            if (Formio.cdn[Formio.config.template]) {
+                const templateSrc = `${Formio.cdn[Formio.config.template]}/${Formio.config.template}.min`;
+                await Formio.addStyles(`${templateSrc}.css`);
+                Formio.debug(`Using ${Formio.config.template}`);
+                Formio.FormioClass.use(await Formio.addScript(`${templateSrc}.js`, Formio.config.template));
             }
-            // Render the form if no template is provided.
-            if (!config.template && !config.premium) {
-                renderForm();
-            }
-        });
-    }
-    else {
-        // Show an error if the script cannot be found.
-        document.write('<span>Could not locate the Embedded form.</span>');
+        }
+        else if (Formio.global('uswds')) {
+            Formio.debug('Using uswds module.');
+            Formio.FormioClass.use(Formio.global('uswds'));
+        }
+        // Default bootstrap + fontawesome.
+        else if (Formio.config.includeLibs) {
+            await Formio.addStyles(Formio.config.libs.fontawesome.css, true);
+            await Formio.addStyles(Formio.config.libs.bootstrap.css);
+        }
+        if (Formio.config.premium) {
+            await Formio.addStyles(Formio.config.premium.css);
+            Formio.debug('Using premium');
+            Formio.FormioClass.use(await Formio.addScript(Formio.config.premium.js, 'premium'));
+        }
+        await Formio.addStyles(Formio.config.style || `${Formio.cdn.js}/formio.form.min.css`);
+        return await Formio.renderForm(form, options);
     }
 }
+export { Formio };

package/lib/mjs/Form.d.ts

@@ -12,7 +12,7 @@ export default class Form extends Element {
      * @param {boolean} options.template - Provides a way to inject custom logic into the creation of every element rendered within the form.
      *
      * @example
-     * import Form from 'formiojs/Form';
+     * import Form from '@formio/js/Form';
      * const form = new Form(document.getElementById('formio'), 'https://examples.form.io/example');
      * form.build();
      */

package/lib/mjs/Form.js

@@ -16,7 +16,7 @@ export default class Form extends Element {
      * @param {boolean} options.template - Provides a way to inject custom logic into the creation of every element rendered within the form.
      *
      * @example
-     * import Form from 'formiojs/Form';
+     * import Form from '@formio/js/Form';
      * const form = new Form(document.getElementById('formio'), 'https://examples.form.io/example');
      * form.build();
      */

package/lib/mjs/Webform.d.ts

@@ -65,7 +65,7 @@ declare class Webform extends NestedDataComponent {
      * @type {Promise}
      *
      * @example
-     * import Webform from 'formiojs/Webform';
+     * import Webform from '@formio/js/Webform';
      * let form = new Webform(document.getElementById('formio'));
      * form.formReady.then(() => {
      *   console.log('The form is ready!');
@@ -90,7 +90,7 @@ declare class Webform extends NestedDataComponent {
      * @type {Promise}
      *
      * @example
-     * import Webform from 'formiojs/Webform';
+     * import Webform from '@formio/js/Webform';
      * let form = new Webform(document.getElementById('formio'));
      * form.submissionReady.then(() => {
      *   console.log('The submission is ready!');
@@ -140,7 +140,7 @@ declare class Webform extends NestedDataComponent {
      * @param {string} value - The value of the form embed url.
      *
      * @example
-     * import Webform from 'formiojs/Webform';
+     * import Webform from '@formio/js/Webform';
      * let form = new Webform(document.getElementById('formio'));
      * form.formReady.then(() => {
      *   console.log('The form is formReady!');
@@ -207,7 +207,7 @@ declare class Webform extends NestedDataComponent {
      * Sets the JSON schema for the form to be rendered.
      *
      * @example
-     * import Webform from 'formiojs/Webform';
+     * import Webform from '@formio/js/Webform';
      * let form = new Webform(document.getElementById('formio'));
      * form.setForm({
      *   components: [
@@ -257,7 +257,7 @@ declare class Webform extends NestedDataComponent {
      * Sets the submission of a form.
      *
      * @example
-     * import Webform from 'formiojs/Webform';
+     * import Webform from '@formio/js/Webform';
      * let form = new Webform(document.getElementById('formio'));
      * form.src = 'https://examples.form.io/example';
      * form.submission = {data: {
@@ -372,7 +372,7 @@ declare class Webform extends NestedDataComponent {
      * Submits the form.
      *
      * @example
-     * import Webform from 'formiojs/Webform';
+     * import Webform from '@formio/js/Webform';
      * let form = new Webform(document.getElementById('formio'));
      * form.src = 'https://examples.form.io/example';
      * form.submission = {data: {