@formio/js 5.0.0-dev.5610.da13e39 → 5.0.0-dev.5613.3476921

package/lib/cjs/FormBuilder.d.ts

@@ -1,191 +1,6 @@
 export default class FormBuilder extends Form {
-    /**
-     * @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;
-    };
+    static options: {};
+    constructor(element: any, form: any, options: any);
     create(display: any): any;
 }
 import Form from './Form';

package/lib/cjs/FormBuilder.js

@@ -7,13 +7,6 @@ const Formio_1 = require("./Formio");
 const builders_1 = __importDefault(require("./builders"));
 const Form_1 = __importDefault(require("./Form"));
 class FormBuilder extends Form_1.default {
-    /**
-     * 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, form, options) {
         form = form || {};
         options = options || {};
@@ -29,33 +22,18 @@ class FormBuilder extends Form_1.default {
         }
     }
 }
-/**
- * @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} */
 FormBuilder.options = {};
 exports.default = FormBuilder;
 /**
  * Factory that creates a new form builder based on the form parameter.
- * @param {HTMLElement} element - The HTML Element to add this form to.
- * @param {string|object} form - The src of the form, or a form object.
- * @param {object} options - The options to create this form.
- * @returns {Promise} - When the form is instance is ready.
+ *
+ * @param element {HMTLElement} - The HTML Element to add this form to.
+ * @param form {string|Object} - The src of the form, or a form object.
+ * @param options {Object} - The options to create this form.
+ *
+ * @return {Promise} - When the form is instance is ready.
  */
-Formio_1.Formio.builder = (element, form, options) => {
-    return (new FormBuilder(element, form, options)).ready;
+Formio_1.Formio.builder = (...args) => {
+    return (new FormBuilder(...args)).ready;
 };
 Formio_1.Formio.FormBuilder = FormBuilder;

package/lib/cjs/PDF.d.ts

@@ -1,8 +1,8 @@
 export default class PDF extends Webform {
+    constructor(element: any, options: any);
     components: any[];
     init(): void;
-    render(): any;
-    submitButton: any;
+    submitButton: import("./components/_classes/component/Component").default | undefined;
     attachComponents(element: any, components: any, container: any): Promise<void>;
     attach(element: any): Promise<void>;
     iframeReady: Promise<any> | undefined;
@@ -11,24 +11,26 @@ export default class PDF extends Webform {
     iframeElement: any;
     /**
      * Get the submission from the iframe.
-     * @returns {Promise<any>} - The submission from the iframe.
+     *
+     * @return {Promise<any>}
      */
     getSubmission(): Promise<any>;
     /**
      * Ensure we have the submission from the iframe before we submit the form.
-     * @param {any} options - The options for submission.
-     * @returns {Promise<any>} - Resolves when the form is submitted.
+     *
+     * @param options
+     * @return {*}
      */
-    submitForm(options?: any): Promise<any>;
+    submitForm(options?: {}): any;
     getSrc(): string;
-    setForm(form: any, flags?: {}): Promise<void>;
+    setForm(form: any, flags?: {}): any;
     /**
      * Set's the value of this form component.
-     * @param {import('@formio/core').Submission} submission - The submission JSON to set the value of this form.
-     * @param {any} flags - The flags to use when setting the submission.
-     * @returns {boolean} - If the value changed or not.
+     *
+     * @param submission
+     * @param flags
      */
-    setValue(submission: import('@formio/core').Submission, flags?: any): boolean;
+    setValue(submission: any, flags?: {}): boolean;
     postMessage(message: any): void;
     iframeFormSetUp: boolean | undefined;
     focusOnComponent(key: any): void;

package/lib/cjs/PDF.js

@@ -143,7 +143,8 @@ class PDF extends Webform_1.default {
     }
     /**
      * Get the submission from the iframe.
-     * @returns {Promise<any>} - The submission from the iframe.
+     *
+     * @return {Promise<any>}
      */
     getSubmission() {
         return new Promise((resolve) => {
@@ -153,8 +154,9 @@ class PDF extends Webform_1.default {
     }
     /**
      * Ensure we have the submission from the iframe before we submit the form.
-     * @param {any} options - The options for submission.
-     * @returns {Promise<any>} - Resolves when the form is submitted.
+     *
+     * @param options
+     * @return {*}
      */
     submitForm(options = {}) {
         this.postMessage({ name: 'getErrors' });
@@ -196,9 +198,9 @@ class PDF extends Webform_1.default {
     }
     /**
      * Set's the value of this form component.
-     * @param {import('@formio/core').Submission} submission - The submission JSON to set the value of this form.
-     * @param {any} flags - The flags to use when setting the submission.
-     * @returns {boolean} - If the value changed or not.
+     *
+     * @param submission
+     * @param flags
      */
     setValue(submission, flags = {}) {
         const changed = super.setValue(submission, flags);