@formio/js 5.2.3 → 5.2.4-rc.0

package/lib/cjs/Webform.d.ts

@@ -1,87 +1,6 @@
 /**
- * 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] - 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] - 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] - 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
- * @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 {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.
+ * Webform class for rendering forms with full component support.
+ * @property {import('./Form.js').FormOptions} options - The options for this Webform instance.
  */
 declare class Webform extends NestedDataComponent {
     /**
@@ -89,11 +8,7 @@ declare class Webform extends NestedDataComponent {
      * @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 | import('Form').FormOptions, options?: any);
-    /**
-     * @type {import('Form').FormOptions} - the options for this Webform.
-     */
-    options: any;
+    constructor(elementOrOptions?: HTMLElement | object | import('Form').FormOptions, options?: import("Form").FormOptions | undefined);
     _src: string;
     _loading: boolean;
     _form: {};
@@ -379,6 +294,10 @@ declare class Webform extends NestedDataComponent {
      * @param {string} key - The key of selected component.
      */
     focusOnComponent(key: string): void;
+    /**
+     * @returns {boolean} - Whether or not the draft submission is being edited
+     */
+    isDraftEdit(): boolean;
     /**
      * Show the errors of this form within the alert dialog.
      * @param {object} error - An optional additional error to display along with the component errors.
@@ -463,281 +382,4 @@ declare namespace Webform {
     let setAppUrl: any;
 }
 export default Webform;
-/**
- * Represents a JSON value.
- */
-export type JSON = (string | number | boolean | null | JSON[] | JSONObject);
-/**
- * Represents a JSON array.
- */
-export type JSONArray = Array<JSON>;
-/**
- * Represents a JSON object.
- */
-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 = {
-    /**
-     * - 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?: EventEmitter | undefined;
-    /**
-     * - 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?: FormioHooks | 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?: SanitizeConfig | undefined;
-    /**
-     * - The button settings for this form.
-     */
-    buttonSettings?: ButtonSettings | 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;
-    /**
-     * - 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 NestedDataComponent from './components/_classes/nesteddata/NestedDataComponent';