@formio/js 5.0.0-rc.29 → 5.0.0-rc.31

package/lib/cjs/Webform.d.ts

@@ -1,402 +0,0 @@
-/**
- * Renders a Form.io form within the webpage.
- */
-declare class Webform extends NestedDataComponent {
-    /**
-     * Creates a new Form instance.
-     *
-     * @param {Object} options - The options to create a new form instance.
-     * @param {boolean} options.saveDraft - Set this if you would like to enable the save draft feature.
-     * @param {boolean} options.saveDraftThrottle - The throttle for the save draft feature.
-     * @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.
-     */
-    constructor(...args: any[]);
-    _src: string;
-    _loading: boolean;
-    _form: {};
-    draftEnabled: boolean;
-    savingDraft: boolean;
-    triggerSaveDraft: any;
-    set nosubmit(arg: any);
-    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;
-    /**
-     * The Formio instance for this form.
-     * @type {Formio}
-     */
-    formio: Formio;
-    /**
-     * The loader HTML element.
-     * @type {HTMLElement}
-     */
-    loader: HTMLElement;
-    /**
-     * The alert HTML element
-     * @type {HTMLElement}
-     */
-    alert: HTMLElement;
-    /**
-     * Promise that is triggered when the submission is done loading.
-     * @type {Promise}
-     */
-    onSubmission: Promise<any>;
-    /**
-     * Determines if this submission is explicitly set.
-     * @type {boolean}
-     */
-    submissionSet: boolean;
-    /**
-     * 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'));
-     * form.formReady.then(() => {
-     *   console.log('The form is ready!');
-     * });
-     * form.src = 'https://examples.form.io/example';
-     */
-    formReady: Promise<any>;
-    /**
-     * Called when the formReady state of this form has been resolved.
-     *
-     * @type {function}
-     */
-    formReadyResolve: Function;
-    /**
-     * Called when this form could not load and is rejected.
-     *
-     * @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'));
-     * form.submissionReady.then(() => {
-     *   console.log('The submission is ready!');
-     * });
-     * form.src = 'https://examples.form.io/example/submission/234234234234234243';
-     */
-    submissionReady: Promise<any>;
-    /**
-     * Called when the formReady state of this form has been resolved.
-     *
-     * @type {function}
-     */
-    submissionReadyResolve: Function;
-    /**
-     * Called when this form could not load and is rejected.
-     *
-     * @type {function}
-     */
-    submissionReadyReject: Function;
-    shortcuts: any[];
-    /**
-     * Sets the language for this form.
-     *
-     * @param lang
-     * @return {Promise}
-     */
-    set language(arg: any);
-    get language(): any;
-    root: Webform;
-    localRoot: Webform;
-    get emptyValue(): null;
-    get shadowRoot(): any;
-    /**
-     * Add a language for translations
-     *
-     * @param code
-     * @param lang
-     * @param active
-     * @return {*}
-     */
-    addLanguage(code: any, lang: any, active?: boolean): any;
-    keyboardCatchableElement(element: any): boolean;
-    executeShortcuts: (event: 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'));
-     * form.formReady.then(() => {
-     *   console.log('The form is formReady!');
-     * });
-     * form.src = 'https://examples.form.io/example';
-     */
-    set src(arg: string);
-    /**
-     * Get the embed source of the form.
-     *
-     * @returns {string}
-     */
-    get src(): string;
-    /**
-     * Loads the submission if applicable.
-     */
-    loadSubmission(): Promise<any>;
-    loadingSubmission: boolean | undefined;
-    /**
-     * Set the src of the form renderer.
-     *
-     * @param value
-     * @param options
-     */
-    setSrc(value: any, options: any): 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(arg: string);
-    /**
-     * Get the embed source of the form.
-     *
-     * @returns {string}
-     */
-    get url(): string;
-    /**
-     * Sets the url of the form renderer.
-     *
-     * @param value
-     * @param options
-     */
-    setUrl(value: any, 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(arg: 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'));
-     * form.setForm({
-     *   components: [
-     *     {
-     *       type: 'textfield',
-     *       key: 'firstName',
-     *       label: 'First Name',
-     *       placeholder: 'Enter your first name.',
-     *       input: true
-     *     },
-     *     {
-     *       type: 'textfield',
-     *       key: 'lastName',
-     *       label: 'Last Name',
-     *       placeholder: 'Enter your last name',
-     *       input: true
-     *     },
-     *     {
-     *       type: 'button',
-     *       action: 'submit',
-     *       label: 'Submit',
-     *       theme: 'primary'
-     *     }
-     *   ]
-     * });
-     *
-     * @param {Object} form - The JSON schema of the form @see https://examples.form.io/example for an example JSON schema.
-     * @param flags
-     * @returns {*}
-     */
-    setForm(form: Object, flags: any): any;
-    initialized: boolean | undefined;
-    /**
-     * Sets the form value.
-     *
-     * @alias setForm
-     * @param {Object} form - The form schema object.
-     */
-    set form(arg: Object);
-    /**
-     * Gets the form object.
-     *
-     * @returns {Object} - The form JSON schema.
-     */
-    get form(): Object;
-    /**
-     * Sets the submission of a form.
-     *
-     * @example
-     * import Webform from '@formio/js/Webform';
-     * let form = new Webform(document.getElementById('formio'));
-     * form.src = 'https://examples.form.io/example';
-     * form.submission = {data: {
-     *   firstName: 'Joe',
-     *   lastName: 'Smith',
-     *   email: 'joe@example.com'
-     * }};
-     *
-     * @param {Object} submission - The Form.io submission object.
-     */
-    set submission(arg: Object);
-    /**
-     * Returns the submission object that was set within this form.
-     *
-     * @returns {Object}
-     */
-    get submission(): Object;
-    /**
-     * Sets a submission and returns the promise when it is ready.
-     * @param submission
-     * @param flags
-     * @return {Promise.<TResult>}
-     */
-    setSubmission(submission: any, flags?: {}): Promise<TResult>;
-    /**
-     * Saves a submission draft.
-     */
-    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.
-     */
-    restoreDraft(userId: any): void;
-    mergeData(_this: any, _that: any): void;
-    editing: boolean | undefined;
-    _submission: any;
-    /**
-     * Build the form.
-     */
-    init(): Promise<any>;
-    executeFormController(): false | undefined;
-    build(element: any): Promise<any>;
-    getClassName(): string;
-    render(): any;
-    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
-     */
-    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;
-    /**
-     * Show the errors of this form within the alert dialog.
-     *
-     * @param {Object} error - An optional additional error to display along with the component errors.
-     * @returns {*}
-     */
-    showErrors(errors: any, triggerEvent: any, onChange: 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 {boolean} saved - Whether or not this submission was saved to the server.
-     * @returns {object} - The submission 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.
-     */
-    onSubmissionError(error: Object): false | undefined;
-    /**
-     * Trigger the change event for this form.
-     *
-     * @param changed
-     * @param flags
-     */
-    onChange(flags: any, changed: any, modified: any, changes: any): void;
-    /**
-     * Send a delete request to the server.
-     */
-    deleteSubmission(): any;
-    /**
-     * Cancels the submission.
-     *
-     * @alias reset
-     */
-    cancel(noconfirm: any): boolean;
-    setMetadata(submission: any): void;
-    submitForm(options?: {}): Promise<any>;
-    setServerErrors(error: any): void;
-    serverErrors: any;
-    executeSubmit(options: any): Promise<object>;
-    submissionInProcess: boolean | undefined;
-    clearServerErrors(): void;
-    /**
-     * Submits the form.
-     *
-     * @example
-     * import Webform from '@formio/js/Webform';
-     * let form = new Webform(document.getElementById('formio'));
-     * form.src = 'https://examples.form.io/example';
-     * form.submission = {data: {
-     *   firstName: 'Joe',
-     *   lastName: 'Smith',
-     *   email: 'joe@example.com'
-     * }};
-     * form.submit().then((submission) => {
-     *   console.log(submission);
-     * });
-     *
-     * @param {boolean} before - If this submission occured from the before handlers.
-     *
-     * @returns {Promise} - A promise when the form is done submitting.
-     */
-    submit(before: boolean, options?: {}): Promise<any>;
-    submitUrl(URL: any, headers: any): void;
-    triggerRecaptcha(): void;
-    _nosubmit: any;
-    get conditions(): any;
-    get variables(): any;
-}
-declare namespace Webform {
-    const setBaseUrl: any;
-    const setApiUrl: any;
-    const setAppUrl: any;
-}
-export default Webform;
-import NestedDataComponent from './components/_classes/nesteddata/NestedDataComponent';

package/lib/cjs/WebformBuilder.d.ts

@@ -1,126 +0,0 @@
-export default class WebformBuilder extends Component {
-    constructor(...args: any[]);
-    dragulaLib: any;
-    builderHeight: number;
-    schemas: {};
-    repeatablePaths: any[];
-    sideBarScroll: any;
-    sideBarScrollOffset: any;
-    dragDropEnabled: boolean;
-    builder: any;
-    groups: {};
-    groupOrder: any[];
-    webform: any;
-    pathComponentsMapping: {};
-    arrayDataComponentPaths: any[];
-    nestedDataComponents: any[];
-    arrayDataComponents: any[];
-    allowDrop(): boolean;
-    addExistingResourceFields(resources: any): void;
-    attachTooltip(component: any, title: any): import("tippy.js").Instance<import("tippy.js").Props>[];
-    attachComponent(element: any, component: any): any;
-    createForm(options: any): any;
-    /**
-     * Called when everything is ready.
-     *
-     * @returns {Promise} - Wait for webform to be ready.
-     */
-    get ready(): Promise<any>;
-    get defaultGroups(): {
-        basic: {
-            title: string;
-            weight: number;
-            default: boolean;
-        };
-        advanced: {
-            title: string;
-            weight: number;
-        };
-        layout: {
-            title: string;
-            weight: number;
-        };
-        data: {
-            title: string;
-            weight: number;
-        };
-        premium: {
-            title: string;
-            weight: number;
-        };
-    };
-    redraw(): Promise<void> | Promise<boolean>;
-    set form(arg: any);
-    get form(): any;
-    get container(): any;
-    /**
-     * When a component sets its api key, we need to check if it is unique within its namespace. Find the namespace root
-     * so we can calculate this correctly.
-     * @param component
-     */
-    findNamespaceRoot(component: any): any;
-    recurseNamespace(component: any): any;
-    render(): any;
-    attach(element: any): Promise<any>;
-    searchFields(searchString?: string): void;
-    orderComponents(groupInfo: any, foundComponents: any): void;
-    updateDragAndDrop(): any;
-    initDragula(): void;
-    dragula: any;
-    getComponentInfo(key: any, group: any): any;
-    getComponentsPath(component: any, parent: any): string;
-    onDrop(element: any, target: any, source: any, sibling: any): any;
-    setForm(form: any): any;
-    keyboardActionsEnabled: any;
-    populateRecaptchaSettings(form: any): void;
-    removeComponent(component: any, parent: any, original: any, componentInstance: any): boolean | undefined;
-    replaceDoubleQuotes(data: any, fieldsToRemoveDoubleQuotes?: any[]): any;
-    updateComponent(component: any, changed: any): void;
-    findRepeatablePaths(): any[];
-    highlightInvalidComponents(): void;
-    /**
-     * Called when a new component is saved.
-     *
-     * @param parent
-     * @param component
-     * @return {boolean}
-     */
-    saveComponent(component: any, parent: any, isNew: any, original: any): boolean;
-    isComponentCreated: boolean | undefined;
-    emitSaveComponentEvent(schema: any, originalComp: any, parentComponentSchema: any, path: any, index: any, isNew: any, originalComponentSchema: any): void;
-    attachEditComponentControls(component: any, parent: any, isNew: any, original: any, ComponentClass: any): void;
-    saved: boolean | undefined;
-    showPreview: any;
-    editComponent(component: any, parent: any, isNew: any, isJsonEdit: any, original: any, flags?: {}): void;
-    editForm: Webform | undefined;
-    preview: Webform | null | undefined;
-    componentEdit: any;
-    dialog: any;
-    updateComponentKey(data: any): any;
-    moveComponent(component: any): void;
-    selectedComponent: any;
-    moveHandler: (e: any) => void;
-    updateComponentPlacement(direction: any): void;
-    stopMoving(comp: any): void;
-    addNewComponent(element: any): void;
-    /**
-     * Creates copy of component schema and stores it under sessionStorage.
-     * @param {Component} component
-     * @return {*}
-     */
-    copyComponent(component: Component): any;
-    /**
-     * Paste copied component after the current component.
-     * @param {Component} component
-     * @return {*}
-     */
-    pasteComponent(component: Component): any;
-    isParentSaveChildMethod(parentComp: any): boolean;
-    getParentElement(element: any): any;
-    addBuilderComponentInfo(component: any): any;
-    addBuilderGroup(name: any, group: any): void;
-    updateBuilderGroup(name: any, group: any): void;
-    generateKey(info: any): any;
-}
-import Component from './components/_classes/component/Component';
-import Webform from './Webform';

package/lib/cjs/Wizard.d.ts

@@ -1,97 +0,0 @@
-declare class Wizard extends Webform {
-    pages: any[];
-    prefixComps: any[];
-    suffixComps: any[];
-    components: any[];
-    originalComponents: any[];
-    page: number;
-    currentPanel: any;
-    currentPanels: any[] | null;
-    currentNextPage: number;
-    _seenPages: number[];
-    subWizards: any[];
-    allPages: any[];
-    lastPromise: Promise<void>;
-    enabledIndex: number;
-    editMode: boolean;
-    originalOptions: any;
-    isLastPage(): any;
-    getPages(args?: {}): any[];
-    get hasExtraPages(): boolean;
-    get localData(): any;
-    isClickableDefined: any;
-    isSecondInit: boolean | undefined;
-    get wizardKey(): string;
-    set wizard(arg: Object);
-    get wizard(): Object;
-    get buttons(): {};
-    get buttonOrder(): any;
-    get renderContext(): {
-        disableWizardSubmit: any;
-        wizardKey: string;
-        isBreadcrumbClickable: any;
-        isSubForm: boolean;
-        panels: any[];
-        buttons: {};
-        currentPage: number;
-        buttonOrder: any;
-    };
-    prepareNavigationSettings(ctx: any): any;
-    prepareHeaderSettings(ctx: any, headerType: any): any;
-    redrawNavigation(): void;
-    redrawHeader(): void;
-    attach(element: any): Promise<void>;
-    scrollPageToTop(): void;
-    isBreadcrumbClickable(): any;
-    isAllowPrevious(): any;
-    handleNaviageteOnEnter(event: any): void;
-    handleSaveOnEnter(event: any): void;
-    attachNav(): void;
-    emitWizardPageSelected(index: any): void;
-    attachHeader(): void;
-    detachNav(): void;
-    detachHeader(): void;
-    transformPages(): void;
-    getSortedComponents({ components, originalComponents }: {
-        components: any;
-        originalComponents: any;
-    }): any[];
-    findRootPanel(component: any): any;
-    setRootPanelId(component: any): void;
-    establishPages(data?: any): any[];
-    updatePages(): void;
-    addComponents(): void;
-    setPage(num: any): Promise<void>;
-    pageFieldLogic(page: any): void;
-    get currentPage(): any;
-    getNextPage(): number | null;
-    getPreviousPage(): number;
-    beforeSubmit(): Promise<any[]>;
-    beforePage(next: any): Promise<any>;
-    emitNextPage(): void;
-    nextPage(): Promise<void>;
-    validateCurrentPage(flags?: {}): any;
-    emitPrevPage(): void;
-    prevPage(): Promise<void>;
-    cancel(noconfirm: any): Promise<void> | Promise<number>;
-    getPageIndexByKey(key: any): number;
-    get schema(): Object;
-    setComponentSchema(): void;
-    setForm(form: any, flags: any): any;
-    onSetForm(clonedForm: any, initialForm: any): void;
-    setEditMode(submission: any): void;
-    setValue(submission: any, flags: {} | undefined, ignoreEstablishment: any): any;
-    isClickable(page: any, index: any): any;
-    hasButton(name: any, nextPage?: number | null): any;
-    pageId(page: any): any;
-    onChange(flags: any, changed: any, modified: any, changes: any): void;
-    checkValidity(data: any, dirty: any, row: any, currentPageOnly: any, childErrors?: any[]): any;
-    focusOnComponent(key: any): any;
-}
-declare namespace Wizard {
-    const setBaseUrl: any;
-    const setApiUrl: any;
-    const setAppUrl: any;
-}
-export default Wizard;
-import Webform from './Webform';

package/lib/cjs/WizardBuilder.d.ts

@@ -1,49 +0,0 @@
-export default class WizardBuilder extends WebformBuilder {
-    _form: {
-        components: {
-            title: string;
-            label: string;
-            type: string;
-            key: string;
-            components: any[];
-        }[];
-    };
-    page: number;
-    removeComponent(component: any, parent: any, original: any): boolean | undefined;
-    allowDrop(element: any): boolean;
-    get pages(): any;
-    get currentPage(): any;
-    set form(arg: {
-        components: {
-            title: string;
-            label: string;
-            type: string;
-            key: string;
-            components: any[];
-        }[];
-    });
-    get form(): {
-        components: {
-            title: string;
-            label: string;
-            type: string;
-            key: string;
-            components: any[];
-        }[];
-    };
-    navigationDragula: any;
-    rebuild(): Promise<void> | Promise<boolean>;
-    addPage(page: any): Promise<void> | Promise<boolean>;
-    removePage(pageIndex: any, componentIndex: any): Promise<void> | Promise<boolean> | undefined;
-    onReorder(element: any, _target: any, _source: any, sibling: any): Promise<void> | undefined;
-    setPage(index: any): Promise<void> | Promise<boolean> | undefined;
-    getPageConfig(index: any, components?: any[]): {
-        title: string;
-        label: string;
-        type: string;
-        key: string;
-        components: any[];
-    };
-    pasteComponent(component: any): any;
-}
-import WebformBuilder from './WebformBuilder';

package/lib/cjs/addons/FormioAddon.d.ts

@@ -1,19 +0,0 @@
-export default class FormioAddon extends Element {
-    static get info(): {
-        supportedComponents: never[];
-        name: string;
-        components: never[];
-        label: string;
-        defaultSettings: {};
-    };
-    constructor(settings: any, componentInstance: any);
-    get defaultSettings(): {};
-    get element(): any;
-    namespace: string;
-    component: any;
-    settings: any;
-    attach(element: any): Promise<void>;
-    _element: any;
-    destroy(): void;
-}
-import Element from '../Element';