@formio/js 5.0.0-rc.51 → 5.0.0-rc.53

package/dist/formio.utils.min.js.LICENSE.txt

@@ -1,3 +1,11 @@
+/*!
+ * dist/inputmask
+ * https://github.com/RobinHerbots/Inputmask
+ * Copyright (c) 2010 - 2023 Robin Herbots
+ * Licensed under the MIT license
+ * Version: 5.0.8
+ */
+
 /*!
  * https://github.com/Starcounter-Jack/JSON-Patch
  * (c) 2017-2021 Joachim Wester
@@ -10,57 +18,11 @@
  * MIT licensed
  */
 
-/*!
-* dependencyLibs/inputmask.dependencyLib.js
-* https://github.com/RobinHerbots/Inputmask
-* Copyright (c) 2010 - 2019 Robin Herbots
-* Licensed under the MIT license (http://www.opensource.org/licenses/mit-license.php)
-* Version: 4.0.9
-*/
-
-/*!
-* global/window.js
-* https://github.com/RobinHerbots/Inputmask
-* Copyright (c) 2010 - 2019 Robin Herbots
-* Licensed under the MIT license (http://www.opensource.org/licenses/mit-license.php)
-* Version: 4.0.9
-*/
-
-/*!
-* inputmask.date.extensions.js
-* https://github.com/RobinHerbots/Inputmask
-* Copyright (c) 2010 - 2019 Robin Herbots
-* Licensed under the MIT license (http://www.opensource.org/licenses/mit-license.php)
-* Version: 4.0.9
-*/
-
-/*!
-* inputmask.extensions.js
-* https://github.com/RobinHerbots/Inputmask
-* Copyright (c) 2010 - 2019 Robin Herbots
-* Licensed under the MIT license (http://www.opensource.org/licenses/mit-license.php)
-* Version: 4.0.9
-*/
-
-/*!
-* inputmask.js
-* https://github.com/RobinHerbots/Inputmask
-* Copyright (c) 2010 - 2019 Robin Herbots
-* Licensed under the MIT license (http://www.opensource.org/licenses/mit-license.php)
-* Version: 4.0.9
-*/
-
-/*!
-* inputmask.numeric.extensions.js
-* https://github.com/RobinHerbots/Inputmask
-* Copyright (c) 2010 - 2019 Robin Herbots
-* Licensed under the MIT license (http://www.opensource.org/licenses/mit-license.php)
-* Version: 4.0.9
-*/
-
 /*! @license DOMPurify 3.1.2 | (c) Cure53 and other contributors | Released under the Apache license 2.0 and Mozilla Public License 2.0 | github.com/cure53/DOMPurify/blob/3.1.2/LICENSE */
 
-/*! formiojs v5.0.0-rc.51 | https://unpkg.com/formiojs@5.0.0-rc.51/LICENSE.txt */
+/*! @license DOMPurify 3.1.3 | (c) Cure53 and other contributors | Released under the Apache license 2.0 and Mozilla Public License 2.0 | github.com/cure53/DOMPurify/blob/3.1.3/LICENSE */
+
+/*! formiojs v5.0.0-rc.53 | https://unpkg.com/formiojs@5.0.0-rc.53/LICENSE.txt */
 
 /**
  * @license

package/lib/cjs/Form.d.ts

@@ -1,27 +1,298 @@
 export default class Form extends Element {
     static embed(embed: any): Promise<any>;
+    constructor(elementOrForm: any, formOrOptions: any, options?: {});
+    /**
+     * Represents a JSON value.
+     * @typedef {(string | number | boolean | null | JSONArray | JSONObject)} JSON
+     */
+    /**
+     * Represents a JSON array.
+     * @typedef {Array<JSON>} JSONArray
+     */
+    /**
+     * Represents a JSON object.
+     * @typedef {{[key: string]: JSON}} JSONObject
+     */
+    /**
+     * @typedef {object} FormioHooks
+     * @property {Function} [beforeSubmit]
+     * @property {Function} [beforeCancel]
+     * @property {Function} [beforeNext]
+     * @property {Function} [beforePrev]
+     * @property {Function} [attachComponent]
+     * @property {Function} [setDataValue]
+     * @property {Function} [addComponents]
+     * @property {Function} [addComponent]
+     * @property {Function} [customValidation]
+     * @property {Function} [attachWebform]
+     */
+    /**
+     * @typedef {object} SanitizeConfig
+     * @property {string[]} [addAttr]
+     * @property {string[]} [addTags]
+     * @property {string[]} [allowedAttrs]
+     * @property {string[]} [allowedTags]
+     * @property {string[]} [allowedUriRegex]
+     * @property {string[]} [addUriSafeAttr]
+     */
+    /**
+     * @typedef {object} ButtonSettings
+     * @property {boolean} [showPrevious]
+     * @property {boolean} [showNext]
+     * @property {boolean} [showCancel]
+     * @property {boolean} [showSubmit]
+     */
+    /**
+     * @typedef {object} FormOptions
+     * @property {boolean} [saveDraft] - Enable the save draft feature.
+     * @property {number} [saveDraftThrottle] - The throttle for the save draft feature.
+     * @property {boolean} [readOnly] - Set this form to readOnly.
+     * @property {boolean} [noAlerts] - Disable the alerts dialog.
+     * @property {{[key: string]: string}} [i18n] - The translation file for this rendering.
+     * @property {string} [template] - Custom logic for creation of elements.
+     * @property {boolean} [noDefaults] - Exclude default values from the settings.
+     * @property {any} [fileService] - The file service for this form.
+     * @property {EventEmitter} [events] - The EventEmitter for this form.
+     * @property {string} [language] - The language to render this form in.
+     * @property {{[key: string]: string}} [i18next] - The i18next configuration for this form.
+     * @property {boolean} [viewAsHtml] - View the form as raw HTML.
+     * @property {'form' | 'html' | 'flat' | 'builder' | 'pdf'} [renderMode] - The render mode for this form.
+     * @property {boolean} [highlightErrors] - Highlight any errors on the form.
+     * @property {string} [componentErrorClass] - The error class for components.
+     * @property {any} [templates] - The templates for this form.
+     * @property {string} [iconset] - The iconset for this form.
+     * @property {import('@formio/core').Component[]} [components] - The components for this form.
+     * @property {{[key: string]: boolean}} [disabled] - Disabled components for this form.
+     * @property {boolean} [showHiddenFields] - Show hidden fields.
+     * @property {{[key: string]: boolean}} [hide] - Hidden components for this form.
+     * @property {{[key: string]: boolean}} [show] - Components to show for this form.
+     * @property {Formio} [formio] - The Formio instance for this form.
+     * @property {string} [decimalSeparator] - The decimal separator for this form.
+     * @property {string} [thousandsSeparator] - The thousands separator for this form.
+     * @property {FormioHooks} [hooks] - The hooks for this form.
+     * @property {boolean} [alwaysDirty] - Always be dirty.
+     * @property {boolean} [skipDraftRestore] - Skip restoring a draft.
+     * @property {'form' | 'wizard' | 'pdf'} [display] - The display for this form.
+     * @property {string} [cdnUrl] - The CDN url for this form.
+     * @property {boolean} [flatten] - Flatten the form.
+     * @property {boolean} [sanitize] - Sanitize the form.
+     * @property {SanitizeConfig} [sanitizeConfig] - The sanitize configuration for this form.
+     * @property {ButtonSettings} [buttonSettings] - The button settings for this form.
+     * @property {object} [breadcrumbSettings] - The breadcrumb settings for this form.
+     * @property {boolean} [allowPrevious] - Allow the previous button (for Wizard forms).
+     * @property {string[]} [wizardButtonOrder] - The order of the buttons (for Wizard forms).
+     * @property {boolean} [showCheckboxBackground] - Show the checkbox background.
+     * @property {number} [zoom] - The zoom for PDF forms.
+     */
     /**
      * Creates an easy to use interface for embedding webforms, pdfs, and wizards into your application.
-     * @param {object} element - The DOM element you wish to render this form within.
-     * @param {object | string} form - Either a Form JSON schema or the URL of a hosted form via. form.io.
-     * @param {object} options - The options to create a new form instance.
-     * @param {boolean} options.readOnly - Set this form to readOnly
-     * @param {boolean} options.noAlerts - Set to true to disable the alerts dialog.
-     * @param {boolean} options.i18n - The translation file for this rendering. @see https://github.com/formio/formio.js/blob/master/i18n.js
-     * @param {boolean} options.template - Provides a way to inject custom logic into the creation of every element rendered within the form.
-     * @param {...any} args
+     * @param {object} elementOrForm - The DOM element you wish to render this form within, or the form definition.
+     * @param {object | string | FormOptions} formOrOptions - A Form JSON schema, the URL of a hosted form, or the form options.
+     * @param {FormOptions} [options] - The options to create a new form instance.
      * @example
      * import Form from '@formio/js/Form';
      * const form = new Form(document.getElementById('formio'), 'https://examples.form.io/example');
      * form.build();
      */
-    constructor(...args: any[]);
+    /**
+     * @type {FormOptions} - the options for this Form.
+     */
+    options: {
+        /**
+         * - Enable the save draft feature.
+         */
+        saveDraft?: boolean | undefined;
+        /**
+         * - The throttle for the save draft feature.
+         */
+        saveDraftThrottle?: number | undefined;
+        /**
+         * - Set this form to readOnly.
+         */
+        readOnly?: boolean | undefined;
+        /**
+         * - Disable the alerts dialog.
+         */
+        noAlerts?: boolean | undefined;
+        /**
+         * - The translation file for this rendering.
+         */
+        i18n?: {
+            [key: string]: string;
+        } | undefined;
+        /**
+         * - Custom logic for creation of elements.
+         */
+        template?: string | undefined;
+        /**
+         * - Exclude default values from the settings.
+         */
+        noDefaults?: boolean | undefined;
+        /**
+         * - The file service for this form.
+         */
+        fileService?: any;
+        /**
+         * - The EventEmitter for this form.
+         */
+        events?: any;
+        /**
+         * - The language to render this form in.
+         */
+        language?: string | undefined;
+        /**
+         * - The i18next configuration for this form.
+         */
+        i18next?: {
+            [key: string]: string;
+        } | undefined;
+        /**
+         * - View the form as raw HTML.
+         */
+        viewAsHtml?: boolean | undefined;
+        /**
+         * - The render mode for this form.
+         */
+        renderMode?: "builder" | "form" | "html" | "flat" | "pdf" | undefined;
+        /**
+         * - Highlight any errors on the form.
+         */
+        highlightErrors?: boolean | undefined;
+        /**
+         * - The error class for components.
+         */
+        componentErrorClass?: string | undefined;
+        /**
+         * - The templates for this form.
+         */
+        templates?: any;
+        /**
+         * - The iconset for this form.
+         */
+        iconset?: string | undefined;
+        /**
+         * - The components for this form.
+         */
+        components?: import("@formio/core").Component[] | undefined;
+        /**
+         * - Disabled components for this form.
+         */
+        disabled?: {
+            [key: string]: boolean;
+        } | undefined;
+        /**
+         * - Show hidden fields.
+         */
+        showHiddenFields?: boolean | undefined;
+        /**
+         * - Hidden components for this form.
+         */
+        hide?: {
+            [key: string]: boolean;
+        } | undefined;
+        /**
+         * - Components to show for this form.
+         */
+        show?: {
+            [key: string]: boolean;
+        } | undefined;
+        /**
+         * - The Formio instance for this form.
+         */
+        formio?: any;
+        /**
+         * - The decimal separator for this form.
+         */
+        decimalSeparator?: string | undefined;
+        /**
+         * - The thousands separator for this form.
+         */
+        thousandsSeparator?: string | undefined;
+        /**
+         * - The hooks for this form.
+         */
+        hooks?: {
+            beforeSubmit?: Function | undefined;
+            beforeCancel?: Function | undefined;
+            beforeNext?: Function | undefined;
+            beforePrev?: Function | undefined;
+            attachComponent?: Function | undefined;
+            setDataValue?: Function | undefined;
+            addComponents?: Function | undefined;
+            addComponent?: Function | undefined;
+            customValidation?: Function | undefined;
+            attachWebform?: Function | undefined;
+        } | undefined;
+        /**
+         * - Always be dirty.
+         */
+        alwaysDirty?: boolean | undefined;
+        /**
+         * - Skip restoring a draft.
+         */
+        skipDraftRestore?: boolean | undefined;
+        /**
+         * - The display for this form.
+         */
+        display?: "form" | "pdf" | "wizard" | undefined;
+        /**
+         * - The CDN url for this form.
+         */
+        cdnUrl?: string | undefined;
+        /**
+         * - Flatten the form.
+         */
+        flatten?: boolean | undefined;
+        /**
+         * - Sanitize the form.
+         */
+        sanitize?: boolean | undefined;
+        /**
+         * - The sanitize configuration for this form.
+         */
+        sanitizeConfig?: {
+            addAttr?: string[] | undefined;
+            addTags?: string[] | undefined;
+            allowedAttrs?: string[] | undefined;
+            allowedTags?: string[] | undefined;
+            allowedUriRegex?: string[] | undefined;
+            addUriSafeAttr?: string[] | undefined;
+        } | undefined;
+        /**
+         * - The button settings for this form.
+         */
+        buttonSettings?: {
+            showPrevious?: boolean | undefined;
+            showNext?: boolean | undefined;
+            showCancel?: boolean | undefined;
+            showSubmit?: boolean | undefined;
+        } | undefined;
+        /**
+         * - The breadcrumb settings for this form.
+         */
+        breadcrumbSettings?: object | undefined;
+        /**
+         * - Allow the previous button (for Wizard forms).
+         */
+        allowPrevious?: boolean | undefined;
+        /**
+         * - The order of the buttons (for Wizard forms).
+         */
+        wizardButtonOrder?: string[] | undefined;
+        /**
+         * - Show the checkbox background.
+         */
+        showCheckboxBackground?: boolean | undefined;
+        /**
+         * - The zoom for PDF forms.
+         */
+        zoom?: number | undefined;
+    };
     ready: Promise<any>;
     readyResolve: (value: any) => void;
     readyReject: (reason?: any) => void;
     instance: any;
     element: any;
-    options: any;
     display: string;
     createElement(tag: any, attrs: any, children: any): any;
     set loading(load: any);

package/lib/cjs/Form.js

@@ -32,27 +32,22 @@ const displays_1 = __importDefault(require("./displays"));
 const templates_1 = __importDefault(require("./templates"));
 const FormioUtils = __importStar(require("./utils/utils"));
 class Form extends Element_1.default {
-    /**
-     * Creates an easy to use interface for embedding webforms, pdfs, and wizards into your application.
-     * @param {object} element - The DOM element you wish to render this form within.
-     * @param {object | string} form - Either a Form JSON schema or the URL of a hosted form via. form.io.
-     * @param {object} options - The options to create a new form instance.
-     * @param {boolean} options.readOnly - Set this form to readOnly
-     * @param {boolean} options.noAlerts - Set to true to disable the alerts dialog.
-     * @param {boolean} options.i18n - The translation file for this rendering. @see https://github.com/formio/formio.js/blob/master/i18n.js
-     * @param {boolean} options.template - Provides a way to inject custom logic into the creation of every element rendered within the form.
-     * @param {...any} args
-     * @example
-     * import Form from '@formio/js/Form';
-     * const form = new Form(document.getElementById('formio'), 'https://examples.form.io/example');
-     * form.build();
-     */
-    constructor(...args) {
-        let options = args[0] instanceof HTMLElement ? args[2] : args[1];
+    constructor(elementOrForm, formOrOptions, options = {}) {
+        let element, form, formOptions;
+        if (elementOrForm instanceof HTMLElement) {
+            element = elementOrForm;
+            form = formOrOptions;
+            formOptions = options;
+        }
+        else {
+            element = null;
+            form = elementOrForm;
+            formOptions = formOrOptions || {};
+        }
         if (Formio_1.Formio.options && Formio_1.Formio.options.form) {
-            options = Object.assign(options, Formio_1.Formio.options.form);
+            formOptions = Object.assign(formOptions, Formio_1.Formio.options.form);
         }
-        super(options);
+        super(formOptions);
         if (this.options.useSessionToken) {
             Formio_1.Formio.useSessionToken(this.options);
         }
@@ -61,30 +56,22 @@ class Form extends Element_1.default {
             this.readyReject = reject;
         });
         this.instance = null;
-        if (args[0] instanceof HTMLElement) {
+        if (element) {
             if (this.element) {
                 delete this.element.component;
             }
-            this.element = args[0];
-            this.options = args[2] || {};
-            this.options.events = this.events;
-            this.setForm(args[1])
-                .then(() => this.readyResolve(this.instance))
-                .catch(this.readyReject);
+            this.element = element;
         }
-        else if (args[0]) {
+        else {
             this.element = null;
-            this.options = args[1] || {};
-            this.options.events = this.events;
-            this.setForm(args[0])
+        }
+        if (form) {
+            this.setForm(form)
                 .then(() => this.readyResolve(this.instance))
                 .catch(this.readyReject);
         }
-        else {
-            this.element = null;
-            this.options = {};
-            this.options.events = this.events;
-        }
+        this.options = formOptions;
+        this.options.events = this.events;
         this.display = '';
     }
     createElement(tag, attrs, children) {

package/lib/cjs/FormBuilder.d.ts

@@ -1,6 +1,191 @@
 export default class FormBuilder extends Form {
-    static options: {};
-    constructor(element: any, form: any, options: any);
+    /**
+     * @typedef FormBuilderOptions
+     * @property {string[]} [disabled] - An array of "keys" of components that should be disabled within the form builder. Example: ['firstName', 'lastName']
+     * @property {boolean} [noNewEdit] - When set to TRUE no modal is shown when a component is dragged onto the form.
+     * @property {boolean} [noDefaultSubmitButton] - Set to TRUE to not include the default submit button in Webforms.
+     * @property {boolean} [alwaysConfirmComponentRemoval] - Set to TRUE to always require confirmation before removing a component.
+     * @property {object} [formConfig] - Form configurations to apply to forms being created. These configurations are added to the "config" property of the form object.
+     * @property {string} [resourceTag] - The tag to use to query for the "Existing Resource Fields" section of the builder.
+     * @property {import('./Form').FormOptions} [editForm] - The options to apply to the Edit Form (the form that shows inside the modal when you edit a component).
+     * @property {string} [language] - The language to load into the form builder.
+     * @property {object} [builder] - The builder options to pass to the builder.
+     * @property {'form'|'wizard'|'pdf'} [display] - The display mode of the builder.
+     * @property {string} [resourceFilter] - Filter applied to the resources that appear in the builder's Existing Resource Fields.
+     * @property {boolean} [noSource] - When set to TRUE, the resource ID in the builder's Existing Resource Fields will not be linked.
+     * @property {boolean} [showFullJsonSchema] - When set to TRUE, the full JSON schema will be displayed in the JSON edit menu.
+     */
+    /** @type {FormBuilderOptions} */
+    static options: {
+        /**
+         * - An array of "keys" of components that should be disabled within the form builder. Example: ['firstName', 'lastName']
+         */
+        disabled?: string[] | undefined;
+        /**
+         * - When set to TRUE no modal is shown when a component is dragged onto the form.
+         */
+        noNewEdit?: boolean | undefined;
+        /**
+         * - Set to TRUE to not include the default submit button in Webforms.
+         */
+        noDefaultSubmitButton?: boolean | undefined;
+        /**
+         * - Set to TRUE to always require confirmation before removing a component.
+         */
+        alwaysConfirmComponentRemoval?: boolean | undefined;
+        /**
+         * - Form configurations to apply to forms being created. These configurations are added to the "config" property of the form object.
+         */
+        formConfig?: object | undefined;
+        /**
+         * - The tag to use to query for the "Existing Resource Fields" section of the builder.
+         */
+        resourceTag?: string | undefined;
+        /**
+         * - The options to apply to the Edit Form (the form that shows inside the modal when you edit a component).
+         */
+        editForm?: any;
+        /**
+         * - The language to load into the form builder.
+         */
+        language?: string | undefined;
+        /**
+         * - The builder options to pass to the builder.
+         */
+        builder?: object | undefined;
+        /**
+         * - The display mode of the builder.
+         */
+        display?: "form" | "pdf" | "wizard" | undefined;
+        /**
+         * - Filter applied to the resources that appear in the builder's Existing Resource Fields.
+         */
+        resourceFilter?: string | undefined;
+        /**
+         * - When set to TRUE, the resource ID in the builder's Existing Resource Fields will not be linked.
+         */
+        noSource?: boolean | undefined;
+        /**
+         * - When set to TRUE, the full JSON schema will be displayed in the JSON edit menu.
+         */
+        showFullJsonSchema?: boolean | undefined;
+    };
+    /**
+     * Creates a new form builder.
+     * @param {HTMLElement} element - The HTML element to place the form builder.
+     * @param {string | object} form - The form to pass to the builder
+     * @param {FormBuilderOptions} options - The options to create this builder.
+     * @returns {FormBuilder} - The form builder instance.
+     */
+    constructor(element: HTMLElement, form: string | object, options: {
+        /**
+         * - An array of "keys" of components that should be disabled within the form builder. Example: ['firstName', 'lastName']
+         */
+        disabled?: string[] | undefined;
+        /**
+         * - When set to TRUE no modal is shown when a component is dragged onto the form.
+         */
+        noNewEdit?: boolean | undefined;
+        /**
+         * - Set to TRUE to not include the default submit button in Webforms.
+         */
+        noDefaultSubmitButton?: boolean | undefined;
+        /**
+         * - Set to TRUE to always require confirmation before removing a component.
+         */
+        alwaysConfirmComponentRemoval?: boolean | undefined;
+        /**
+         * - Form configurations to apply to forms being created. These configurations are added to the "config" property of the form object.
+         */
+        formConfig?: object | undefined;
+        /**
+         * - The tag to use to query for the "Existing Resource Fields" section of the builder.
+         */
+        resourceTag?: string | undefined;
+        /**
+         * - The options to apply to the Edit Form (the form that shows inside the modal when you edit a component).
+         */
+        editForm?: any;
+        /**
+         * - The language to load into the form builder.
+         */
+        language?: string | undefined;
+        /**
+         * - The builder options to pass to the builder.
+         */
+        builder?: object | undefined;
+        /**
+         * - The display mode of the builder.
+         */
+        display?: "form" | "pdf" | "wizard" | undefined;
+        /**
+         * - Filter applied to the resources that appear in the builder's Existing Resource Fields.
+         */
+        resourceFilter?: string | undefined;
+        /**
+         * - When set to TRUE, the resource ID in the builder's Existing Resource Fields will not be linked.
+         */
+        noSource?: boolean | undefined;
+        /**
+         * - When set to TRUE, the full JSON schema will be displayed in the JSON edit menu.
+         */
+        showFullJsonSchema?: boolean | undefined;
+    });
+    /** @type {FormBuilderOptions} */
+    options: {
+        /**
+         * - An array of "keys" of components that should be disabled within the form builder. Example: ['firstName', 'lastName']
+         */
+        disabled?: string[] | undefined;
+        /**
+         * - When set to TRUE no modal is shown when a component is dragged onto the form.
+         */
+        noNewEdit?: boolean | undefined;
+        /**
+         * - Set to TRUE to not include the default submit button in Webforms.
+         */
+        noDefaultSubmitButton?: boolean | undefined;
+        /**
+         * - Set to TRUE to always require confirmation before removing a component.
+         */
+        alwaysConfirmComponentRemoval?: boolean | undefined;
+        /**
+         * - Form configurations to apply to forms being created. These configurations are added to the "config" property of the form object.
+         */
+        formConfig?: object | undefined;
+        /**
+         * - The tag to use to query for the "Existing Resource Fields" section of the builder.
+         */
+        resourceTag?: string | undefined;
+        /**
+         * - The options to apply to the Edit Form (the form that shows inside the modal when you edit a component).
+         */
+        editForm?: any;
+        /**
+         * - The language to load into the form builder.
+         */
+        language?: string | undefined;
+        /**
+         * - The builder options to pass to the builder.
+         */
+        builder?: object | undefined;
+        /**
+         * - The display mode of the builder.
+         */
+        display?: "form" | "pdf" | "wizard" | undefined;
+        /**
+         * - Filter applied to the resources that appear in the builder's Existing Resource Fields.
+         */
+        resourceFilter?: string | undefined;
+        /**
+         * - When set to TRUE, the resource ID in the builder's Existing Resource Fields will not be linked.
+         */
+        noSource?: boolean | undefined;
+        /**
+         * - When set to TRUE, the full JSON schema will be displayed in the JSON edit menu.
+         */
+        showFullJsonSchema?: boolean | undefined;
+    };
     create(display: any): any;
 }
 import Form from './Form';