@formio/js 5.0.0-dev.5647.4cf82e8 → 5.0.0-dev.5650.cd53187

package/lib/mjs/Webform.d.ts

@@ -11,36 +11,36 @@
  * @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} FormioHooks
+ * @property {Function} [beforeSubmit] - A function that is called before the form is submitted.
+ * @property {Function} [beforeCancel] - A function that is called before the form is canceled.
+ * @property {Function} [beforeNext] - A function that is called before moving to the next page in a multi-page form.
+ * @property {Function} [beforePrev] - A function that is called before moving to the previous page in a multi-page form.
+ * @property {Function} [attachComponent] - A function that is called when a component is attached to the form.
+ * @property {Function} [setDataValue] - A function that is called when setting the value of a data component.
+ * @property {Function} [addComponents] - A function that is called when adding multiple components to the form.
+ * @property {Function} [addComponent] - A function that is called when adding a single component to the form.
+ * @property {Function} [customValidation] - A function that is called for custom validation of the form.
+ * @property {Function} [attachWebform] - A function that is called when attaching a webform to the form.
  */
 /**
- * @typedef {Object} SanitizeConfig
- * @property {string[]} [addAttr]
- * @property {string[]} [addTags]
- * @property {string[]} [allowedAttrs]
- * @property {string[]} [allowedTags]
- * @property {string[]} [allowedUriRegex]
- * @property {string[]} [addUriSafeAttr]
+ * @typedef {object} SanitizeConfig
+ * @property {string[]} [addAttr] - The attributes to add.
+ * @property {string[]} [addTags] - The tags to add.
+ * @property {string[]} [allowedAttrs] - The allowed attributes.
+ * @property {string[]} [allowedTags] - The allowed tags.
+ * @property {string[]} [allowedUriRegex] - The allowed URI regex.
+ * @property {string[]} [addUriSafeAttr] - The URI safe attributes.
  */
 /**
- * @typedef {Object} ButtonSettings
- * @property {boolean} [showPrevious]
- * @property {boolean} [showNext]
- * @property {boolean} [showCancel]
- * @property {boolean} [showSubmit]
+ * @typedef {object} ButtonSettings
+ * @property {boolean} [showPrevious] - Show the "Previous" button.
+ * @property {boolean} [showNext] - Show the "Next" button.
+ * @property {boolean} [showCancel] - Show the "Cancel" button.
+ * @property {boolean} [showSubmit] - Show the "Submit" button.
  */
 /**
- * @typedef {Object} FormOptions
+ * @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.
@@ -58,7 +58,7 @@
  * @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 {Component[]} [components] - The components 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.
@@ -75,27 +75,25 @@
  * @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 {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 {boolean} [inputsOnly] - Only show inputs in the form and no labels.
+ * @property {boolean} [building] - If we are in the process of building the form.
  * @property {number} [zoom] - The zoom for PDF forms.
  */
-/**
- * Renders a Form.io form within the webpage.
- */
 declare class Webform extends NestedDataComponent {
     /**
      * Creates a new Form instance.
-     *
-     * @param {HTMLElement | Object | FormOptions} [elementOrOptions] - The DOM element to render this form within or the options to create this form instance.
-     * @param {FormOptions} [options] - The options to create a new form instance.
+     * @param {HTMLElement | object | import('Form').FormOptions} [elementOrOptions] - The DOM element to render this form within or the options to create this form instance.
+     * @param {import('Form').FormOptions} [options] - The options to create a new form instance.
      */
-    constructor(elementOrOptions?: HTMLElement | Object | FormOptions, options?: FormOptions | undefined);
+    constructor(elementOrOptions?: HTMLElement | object | import('Form').FormOptions, options?: any);
     /**
-     * @type {FormOptions} - the options for this Webform.
+     * @type {import('Form').FormOptions} - the options for this Webform.
      */
-    options: FormOptions;
+    options: any;
     _src: string;
     _loading: boolean;
     _form: {};
@@ -106,13 +104,11 @@ declare class Webform extends NestedDataComponent {
     get nosubmit(): any;
     /**
      * Determines if the form has tried to be submitted, error or not.
-     *
      * @type {boolean}
      */
     submitted: boolean;
     /**
      * Determines if the form is being submitted at the moment.
-     *
      * @type {boolean}
      */
     submitting: boolean;
@@ -144,7 +140,6 @@ declare class Webform extends NestedDataComponent {
     /**
      * Promise that executes when the form is ready and rendered.
      * @type {Promise}
-     *
      * @example
      * import Webform from '@formio/js/Webform';
      * let form = new Webform(document.getElementById('formio'));
@@ -156,20 +151,17 @@ declare class Webform extends NestedDataComponent {
     formReady: Promise<any>;
     /**
      * Called when the formReady state of this form has been resolved.
-     *
-     * @type {function}
+     * @type {Function}
      */
     formReadyResolve: Function;
     /**
      * Called when this form could not load and is rejected.
-     *
-     * @type {function}
+     * @type {Function}
      */
     formReadyReject: Function;
     /**
      * Promise that executes when the submission is ready and rendered.
      * @type {Promise}
-     *
      * @example
      * import Webform from '@formio/js/Webform';
      * let form = new Webform(document.getElementById('formio'));
@@ -181,45 +173,39 @@ declare class Webform extends NestedDataComponent {
     submissionReady: Promise<any>;
     /**
      * Called when the formReady state of this form has been resolved.
-     *
-     * @type {function}
+     * @type {Function}
      */
     submissionReadyResolve: Function;
     /**
      * Called when this form could not load and is rejected.
-     *
-     * @type {function}
+     * @type {Function}
      */
     submissionReadyReject: Function;
     shortcuts: any[];
     /**
      * Sets the language for this form.
-     *
-     * @param lang
-     * @return {Promise}
+     * @param {string} lang - The language to use (e.g. 'en', 'sp', etc.)
      */
-    set language(lang: string | undefined);
-    get language(): string | undefined;
+    set language(lang: string);
+    get language(): string;
     root: this;
     localRoot: this;
     get emptyValue(): null;
     get shadowRoot(): any;
     /**
      * Add a language for translations
-     *
-     * @param code
-     * @param lang
-     * @param active
-     * @return {*}
+     * @param {string} code - The language code for the language being added.
+     * @param {object} lang - The language translations.
+     * @param {boolean} [active] - If this language should be set as the active language.
      */
-    addLanguage(code: any, lang: any, active?: boolean): any;
+    addLanguage(code: string, lang: object, active?: boolean | undefined): void;
     keyboardCatchableElement(element: any): boolean;
     executeShortcuts: (event: any) => void;
+    addShortcut(element: any, shortcut: any): void;
+    removeShortcut(element: any, shortcut: any): void;
     /**
      * Set the Form source, which is typically the Form.io embed URL.
-     *
      * @param {string} value - The value of the form embed url.
-     *
      * @example
      * import Webform from '@formio/js/Webform';
      * let form = new Webform(document.getElementById('formio'));
@@ -231,62 +217,56 @@ declare class Webform extends NestedDataComponent {
     set src(value: string);
     /**
      * Get the embed source of the form.
-     *
-     * @returns {string}
+     * @returns {string} - The source of the form.
      */
     get src(): string;
     /**
      * Loads the submission if applicable.
+     * @returns {Promise} - The promise that is triggered when the submission is loaded.
      */
     loadSubmission(): Promise<any>;
     loadingSubmission: boolean | undefined;
     /**
      * Set the src of the form renderer.
-     *
-     * @param value
-     * @param options
+     * @param {string} value - The source value to set.
+     * @param {any} options - The options to set.
+     * @returns {Promise} - The promise that is triggered when the form is set.
      */
-    setSrc(value: any, options: any): any;
+    setSrc(value: string, options: any): Promise<any>;
     /**
      * Set the form source but don't initialize the form and submission from the url.
-     *
      * @param {string} value - The value of the form embed url.
      */
     set url(value: string);
     /**
      * Get the embed source of the form.
-     *
-     * @returns {string}
+     * @returns {string} - returns the source of the form.
      */
     get url(): string;
     /**
      * Sets the url of the form renderer.
-     *
-     * @param value
-     * @param options
+     * @param {string} value - The value to set the url to.
+     * @param {any} options - The options to set.
+     * @returns {boolean} - TRUE means the url was set, FALSE otherwise.
      */
-    setUrl(value: any, options: any): boolean;
+    setUrl(value: string, options: any): boolean;
     /**
      * Called when both the form and submission have been loaded.
-     *
      * @returns {Promise} - The promise to trigger when both form and submission have loaded.
      */
     get ready(): Promise<any>;
     /**
      * Set the loading state for this form, and also show the loader spinner.
-     *
      * @param {boolean} loading - If this form should be "loading" or not.
      */
     set loading(loading: boolean);
     /**
      * Returns if this form is loading.
-     *
      * @returns {boolean} - TRUE means the form is loading, FALSE otherwise.
      */
     get loading(): boolean;
     /**
      * Sets the JSON schema for the form to be rendered.
-     *
      * @example
      * import Webform from '@formio/js/Webform';
      * let form = new Webform(document.getElementById('formio'));
@@ -314,29 +294,25 @@ declare class Webform extends NestedDataComponent {
      *     }
      *   ]
      * });
-     *
-     * @param {Object} form - The JSON schema of the form @see https://examples.form.io/example for an example JSON schema.
-     * @param flags
-     * @returns {*}
+     * @param {object} form - The JSON schema of the form @see https://examples.form.io/example for an example JSON schema.
+     * @param {any} flags - Any flags to apply when setting the form.
+     * @returns {Promise} - The promise that is triggered when the form is set.
      */
-    setForm(form: Object, flags: any): any;
+    setForm(form: object, flags?: any): Promise<any>;
     initialized: boolean | undefined;
     /**
      * Sets the form value.
-     *
      * @alias setForm
-     * @param {Object} form - The form schema object.
+     * @param {object} form - The form schema object.
      */
-    set form(form: Object);
+    set form(form: object);
     /**
      * Gets the form object.
-     *
-     * @returns {Object} - The form JSON schema.
+     * @returns {object} - The form JSON schema.
      */
-    get form(): Object;
+    get form(): object;
     /**
      * Sets the submission of a form.
-     *
      * @example
      * import Webform from '@formio/js/Webform';
      * let form = new Webform(document.getElementById('formio'));
@@ -346,102 +322,109 @@ declare class Webform extends NestedDataComponent {
      *   lastName: 'Smith',
      *   email: 'joe@example.com'
      * }};
-     *
-     * @param {Object} submission - The Form.io submission object.
+     * @param {object} submission - The Form.io submission object.
      */
-    set submission(submission: Object);
+    set submission(submission: object);
     /**
      * Returns the submission object that was set within this form.
-     *
-     * @returns {Object}
+     * @returns {object} - The submission object.
      */
-    get submission(): Object;
+    get submission(): object;
     /**
-     * Sets a submission and returns the promise when it is ready.
-     * @param submission
-     * @param flags
-     * @return {Promise.<TResult>}
+     * Sets the submission value
+     * @param {object|null|undefined} submission - The submission to set.
+     * @param {object|null|undefined} flags - Any flags to apply when setting the submission.
+     * @returns {void}
      */
-    setSubmission(submission: any, flags?: {}): Promise<TResult>;
-    handleDraftError(errName: any, errDetails: any, restoreDraft: any): void;
+    onSetSubmission(submission: object | null | undefined, flags?: object | null | undefined): void;
     /**
-     * Saves a submission draft.
+     * Sets a submission and returns the promise when it is ready.
+     * @param {any} submission - The submission to set.
+     * @param {any} flags - Any flags to apply when setting the submission.
+     * @returns {Promise} - The promise that is triggered when the submission is set.
      */
+    setSubmission(submission: any, flags?: any): Promise<any>;
+    handleDraftError(errName: any, errDetails: any, restoreDraft: any): void;
     saveDraft(): void;
     /**
      * Restores a draft submission based on the user who is authenticated.
-     *
-     * @param {userId} - The user id where we need to restore the draft from.
+     * @param {string} userId - The user id where we need to restore the draft from.
      */
-    restoreDraft(userId: any): void;
+    restoreDraft(userId: string): void;
+    get schema(): any;
     mergeData(_this: any, _that: any): void;
     editing: boolean | undefined;
     _submission: any;
     /**
      * Build the form.
+     * @returns {Promise} - The promise that is triggered when the form is built.
      */
     init(): Promise<any>;
     executeFormController(): false | undefined;
     build(element: any): Promise<any>;
     getClassName(): string;
-    render(): any;
+    render(): import("./components/_classes/field/Field").default;
     redraw(): Promise<void> | Promise<boolean>;
     attach(element: any): Promise<boolean>;
     hasRequiredFields(): boolean;
     /**
      * Sets a new alert to display in the error dialog of the form.
-     *
      * @param {string} type - The type of alert to display. "danger", "success", "warning", etc.
      * @param {string} message - The message to show in the alert.
-     * @param {Object} options
+     * @param {object} options - The options for the alert.
      */
-    setAlert(type: string, message: string, options: Object): void;
+    setAlert(type: string, message: string, options: object): void;
     /**
      * Focus on selected component.
-     *
      * @param {string} key - The key of selected component.
-     * @returns {*}
      */
-    focusOnComponent(key: string): any;
+    focusOnComponent(key: string): void;
     /**
      * Show the errors of this form within the alert dialog.
-     *
-     * @param {Object} error - An optional additional error to display along with the component errors.
+     * @param {object} error - An optional additional error to display along with the component errors.
      * @returns {*}
      */
-    showErrors(errors: any, triggerEvent: any): any;
     /**
-     * Called when the submission has completed, or if the submission needs to be sent to an external library.
      *
-     * @param {Object} submission - The submission object.
+     * @param {Array} errors - An array of errors to display.
+     * @param {boolean} triggerEvent - Whether or not to trigger the error event.
+     * @returns {void|Array} - The errors that were set.
+     */
+    showErrors(errors: any[], triggerEvent: boolean): void | any[];
+    /**
+     * Called when the submission has completed, or if the submission needs to be sent to an external library.
+     * @param {object} submission - The submission object.
      * @param {boolean} saved - Whether or not this submission was saved to the server.
      * @returns {object} - The submission object.
      */
-    onSubmit(submission: Object, saved: boolean): object;
+    onSubmit(submission: object, saved: boolean): object;
     normalizeError(error: any): any;
     /**
      * Called when an error occurs during the submission.
-     *
-     * @param {Object} error - The error that occured.
+     * @param {object} error - The error that occured.
+     * @returns {Array} errors - All errors.
      */
-    onSubmissionError(error: Object): any;
+    onSubmissionError(error: object): any[];
     /**
      * Trigger the change event for this form.
-     *
-     * @param changed
-     * @param flags
+     * @param {any} flags - The flags to set on this change event.
+     * @param {any} changed - The changed object which reflects the changes in the form.
+     * @param {boolean} modified - Whether or not the form has been modified.
+     * @param {any} changes - The changes that have occured in the form.
      */
-    onChange(flags: any, changed: any, modified: any, changes: any): void;
+    onChange(flags: any, changed: any, modified: boolean, changes: any): void;
     /**
      * Send a delete request to the server.
+     * @returns {Promise} - The promise that is triggered when the delete is complete.
      */
-    deleteSubmission(): any;
+    deleteSubmission(): Promise<any>;
     /**
      * Cancels the submission.
-     *
+     * @param {boolean} noconfirm - Whether or not to confirm the cancellation.
      * @alias reset
+     * @returns {boolean} - TRUE means the submission was cancelled, FALSE otherwise.
      */
-    cancel(noconfirm: any): boolean;
+    cancel(noconfirm: boolean): boolean;
     setMetadata(submission: any): void;
     submitForm(options?: {}): Promise<any>;
     setServerErrors(error: any): void;
@@ -451,7 +434,6 @@ declare class Webform extends NestedDataComponent {
     clearServerErrors(): void;
     /**
      * Submits the form.
-     *
      * @example
      * import Webform from '@formio/js/Webform';
      * let form = new Webform(document.getElementById('formio'));
@@ -464,12 +446,11 @@ declare class Webform extends NestedDataComponent {
      * form.submit().then((submission) => {
      *   console.log(submission);
      * });
-     *
      * @param {boolean} before - If this submission occured from the before handlers.
-     *
+     * @param {any} options - The options to use when submitting this form.
      * @returns {Promise} - A promise when the form is done submitting.
      */
-    submit(before: boolean, options?: {}): Promise<any>;
+    submit(before?: boolean, options?: any): Promise<any>;
     submitUrl(URL: any, headers: any): void;
     triggerCaptcha(): void;
     _nosubmit: any;
@@ -497,29 +478,89 @@ export type JSONObject = {
     [key: string]: JSON;
 };
 export type FormioHooks = {
+    /**
+     * - A function that is called before the form is submitted.
+     */
     beforeSubmit?: Function | undefined;
+    /**
+     * - A function that is called before the form is canceled.
+     */
     beforeCancel?: Function | undefined;
+    /**
+     * - A function that is called before moving to the next page in a multi-page form.
+     */
     beforeNext?: Function | undefined;
+    /**
+     * - A function that is called before moving to the previous page in a multi-page form.
+     */
     beforePrev?: Function | undefined;
+    /**
+     * - A function that is called when a component is attached to the form.
+     */
     attachComponent?: Function | undefined;
+    /**
+     * - A function that is called when setting the value of a data component.
+     */
     setDataValue?: Function | undefined;
+    /**
+     * - A function that is called when adding multiple components to the form.
+     */
     addComponents?: Function | undefined;
+    /**
+     * - A function that is called when adding a single component to the form.
+     */
     addComponent?: Function | undefined;
+    /**
+     * - A function that is called for custom validation of the form.
+     */
     customValidation?: Function | undefined;
+    /**
+     * - A function that is called when attaching a webform to the form.
+     */
     attachWebform?: Function | undefined;
 };
 export type SanitizeConfig = {
+    /**
+     * - The attributes to add.
+     */
     addAttr?: string[] | undefined;
+    /**
+     * - The tags to add.
+     */
     addTags?: string[] | undefined;
+    /**
+     * - The allowed attributes.
+     */
     allowedAttrs?: string[] | undefined;
+    /**
+     * - The allowed tags.
+     */
     allowedTags?: string[] | undefined;
+    /**
+     * - The allowed URI regex.
+     */
     allowedUriRegex?: string[] | undefined;
+    /**
+     * - The URI safe attributes.
+     */
     addUriSafeAttr?: string[] | undefined;
 };
 export type ButtonSettings = {
+    /**
+     * - Show the "Previous" button.
+     */
     showPrevious?: boolean | undefined;
+    /**
+     * - Show the "Next" button.
+     */
     showNext?: boolean | undefined;
+    /**
+     * - Show the "Cancel" button.
+     */
     showCancel?: boolean | undefined;
+    /**
+     * - Show the "Submit" button.
+     */
     showSubmit?: boolean | undefined;
 };
 export type FormOptions = {
@@ -578,7 +619,7 @@ export type FormOptions = {
     /**
      * - The render mode for this form.
      */
-    renderMode?: "html" | "form" | "flat" | "builder" | "pdf" | undefined;
+    renderMode?: "builder" | "form" | "html" | "flat" | "pdf" | undefined;
     /**
      * - Highlight any errors on the form.
      */
@@ -598,7 +639,7 @@ export type FormOptions = {
     /**
      * - The components for this form.
      */
-    components?: Component[] | undefined;
+    components?: import("@formio/core").Component[] | undefined;
     /**
      * - Disabled components for this form.
      */
@@ -648,7 +689,7 @@ export type FormOptions = {
     /**
      * - The display for this form.
      */
-    display?: "form" | "wizard" | "pdf" | undefined;
+    display?: "form" | "pdf" | "wizard" | undefined;
     /**
      * - The CDN url for this form.
      */
@@ -672,7 +713,7 @@ export type FormOptions = {
     /**
      * - The breadcrumb settings for this form.
      */
-    breadCrumbSettings?: Object | undefined;
+    breadcrumbSettings?: object | undefined;
     /**
      * - Allow the previous button (for Wizard forms).
      */
@@ -685,11 +726,18 @@ export type FormOptions = {
      * - Show the checkbox background.
      */
     showCheckboxBackground?: boolean | undefined;
+    /**
+     * - Only show inputs in the form and no labels.
+     */
+    inputsOnly?: boolean | undefined;
+    /**
+     * - If we are in the process of building the form.
+     */
+    building?: boolean | undefined;
     /**
      * - The zoom for PDF forms.
      */
     zoom?: number | undefined;
 };
-import NestedDataComponent from './components/_classes/nesteddata/NestedDataComponent';
-import EventEmitter from './EventEmitter';
-import { Component } from '@formio/core';
+import NestedDataComponent from "./components/_classes/nesteddata/NestedDataComponent";
+import EventEmitter from "./EventEmitter";