@formio/js 5.0.0-dev.5636.99a32e6 → 5.0.0-dev.5641.6eb7b96

package/lib/cjs/components/well/Well.form.js

@@ -5,6 +5,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const NestedComponent_form_1 = __importDefault(require("../_classes/nested/NestedComponent.form"));
 const Well_edit_display_1 = __importDefault(require("./editForm/Well.edit.display"));
+/**
+ * The Edit Form function.
+ * @param {...any} extend - The components that extend the edit form.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
+ */
 function default_1(...extend) {
     return (0, NestedComponent_form_1.default)([
         {

package/lib/cjs/formio.embed.d.ts

@@ -1,2 +1 @@
-export { Formio };
-import { Formio } from './Embed';
+export {};

package/lib/cjs/formio.embed.js

@@ -1,102 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Formio = void 0;
-const Embed_1 = require("./Embed");
-Object.defineProperty(exports, "Formio", { enumerable: true, get: function () { return Embed_1.Formio; } });
-const scripts = document.getElementsByTagName('script');
-const config = window.FormioConfig || {};
-let thisScript = null;
-let i = scripts.length;
-const scriptName = config.scriptName || 'formio.embed.';
-while (i--) {
-    if (scripts[i].src && (scripts[i].src.indexOf(scriptName) !== -1)) {
-        thisScript = scripts[i];
-        break;
-    }
-}
-if (thisScript) {
-    const query = {};
-    const queryString = thisScript.src.replace(/^[^?]+\??/, '');
-    queryString.replace(/\?/g, '&').split('&').forEach((item) => {
-        query[item.split('=')[0]] = item.split('=')[1] && decodeURIComponent(item.split('=')[1]);
-    });
-    let scriptSrc = thisScript.src.replace(/^([^?]+).*/, '$1').split('/');
-    scriptSrc.pop();
-    if (config.formioPath) {
-        config.formioPath(scriptSrc);
-    }
-    scriptSrc = scriptSrc.join('/');
-    const debug = (query.debug === 'true' || query.debug === '1');
-    const renderer = debug ? 'formio.form' : 'formio.form.min';
-    Embed_1.Formio.config = Object.assign({
-        script: query.script || (`${config.updatePath ? config.updatePath() : scriptSrc}/${renderer}.js`),
-        style: query.styles || (`${config.updatePath ? config.updatePath() : scriptSrc}/${renderer}.css`),
-        cdn: query.cdn,
-        class: (query.class || 'formio-form-wrapper'),
-        src: query.src,
-        form: null,
-        submission: null,
-        project: query.project,
-        base: query.base || 'https://api.form.io',
-        submit: query.submit,
-        includeLibs: (query.libs === 'true' || query.libs === '1'),
-        template: query.template,
-        debug: debug,
-        config: {},
-        redirect: (query.return || query.redirect),
-        embedCSS: (`${config.updatePath ? config.updatePath() : scriptSrc}/formio.embed.css`),
-        success: query.success || 'Thank you for your submission!',
-        before: null,
-        after: null
-    }, config);
-    const form = (Embed_1.Formio.config.form || Embed_1.Formio.config.src);
-    if (form) {
-        Embed_1.Formio.debug('Embedding Configuration', config);
-        if (Embed_1.Formio.config.addPremiumLib) {
-            Embed_1.Formio.config.addPremiumLib(Embed_1.Formio.config, scriptSrc);
-        }
-        // The id for this embedded form.
-        Embed_1.Formio.config.id = `formio-${Math.random().toString(36).substring(7)}`;
-        Embed_1.Formio.debug('Creating form element');
-        const element = Embed_1.Formio.createElement('div', {
-            'id': Embed_1.Formio.config.id,
-            class: Embed_1.Formio.config.class
-        });
-        // insertAfter doesn't exist, but effect is identical.
-        thisScript.parentNode.insertBefore(element, thisScript.parentNode.firstElementChild.nextSibling);
-        Embed_1.Formio.createForm(element, form, Embed_1.Formio.config.config).then((instance) => {
-            if (Embed_1.Formio.config.submit) {
-                instance.nosubmit = true;
-            }
-            // Configure a redirect.
-            instance.on('submit', (submission) => {
-                Embed_1.Formio.debug("on('submit')", submission);
-                if (Embed_1.Formio.config.submit) {
-                    Embed_1.Formio.debug(`Sending submission to ${Embed_1.Formio.config.submit}`);
-                    const headers = {
-                        'content-type': 'application/json'
-                    };
-                    const token = Embed_1.Formio.FormioClass.getToken();
-                    if (token) {
-                        headers['x-jwt-token'] = token;
-                    }
-                    Embed_1.Formio.FormioClass.fetch(Embed_1.Formio.config.submit, {
-                        body: JSON.stringify(submission),
-                        headers: headers,
-                        method: 'POST',
-                        mode: 'cors',
-                    })
-                        .then(resp => resp.json())
-                        .then(submission => Embed_1.Formio.submitDone(instance, submission));
-                }
-                else {
-                    Embed_1.Formio.submitDone(instance, submission);
-                }
-            });
-        });
-    }
-}
-else {
-    // Show an error if the script cannot be found.
-    document.write('<span>Could not locate the Embedded form.</span>');
-}
+const InlineEmbed_1 = require("./InlineEmbed");
+(0, InlineEmbed_1.embed)();

package/lib/cjs/formio.form.d.ts

@@ -1,10 +1,17 @@
 /**
  * Register a module
- * @param {*} plugin
- * @returns
+ * @param {any} mod - The module object to register. This can also be a function which accepts Formio as an argument.
+ * @param {Function|null} [defaultFn] - The default function to call if the module does not have a known key.
+ * @param {any} options - Options for the module.
+ * @returns {void}
  */
-export function registerModule(mod: any, defaultFn?: null, options?: {}): void;
-export function useModule(defaultFn?: null): (plugins: any, options?: {}) => void;
+export function registerModule(mod: any, defaultFn?: Function | null | undefined, options?: any): void;
+/**
+ * @param {Function|null} defaultFn - The default function to call if the module does not have a known key.
+ * @returns {void}
+ */
+export function useModule(defaultFn?: Function | null): void;
+export { Formio as FormioCore } from "./Formio";
 import Components from './components/Components';
 import Displays from './displays/Displays';
 import Providers from './providers';

package/lib/cjs/formio.form.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Webform = exports.EventEmitter = exports.Licenses = exports.Formio = exports.Form = exports.Utils = exports.Templates = exports.Widgets = exports.Providers = exports.Displays = exports.Components = exports.useModule = exports.registerModule = void 0;
+exports.Webform = exports.EventEmitter = exports.Licenses = exports.Formio = exports.Form = exports.Utils = exports.Templates = exports.Widgets = exports.Providers = exports.Displays = exports.Components = exports.FormioCore = exports.useModule = exports.registerModule = void 0;
 const lodash_1 = __importDefault(require("lodash"));
 const Formio_1 = require("./Formio");
 Object.defineProperty(exports, "Formio", { enumerable: true, get: function () { return Formio_1.Formio; } });
@@ -22,7 +22,7 @@ const Form_1 = __importDefault(require("./Form"));
 exports.Form = Form_1.default;
 const utils_1 = __importDefault(require("./utils"));
 exports.Utils = utils_1.default;
-const Evaluator_1 = __importDefault(require("./utils/Evaluator"));
+const Evaluator_1 = require("./utils/Evaluator");
 const licenses_1 = __importDefault(require("./licenses"));
 exports.Licenses = licenses_1.default;
 const EventEmitter_1 = __importDefault(require("./EventEmitter"));
@@ -44,7 +44,7 @@ Formio_1.Formio.Form = Form_1.default;
 Formio_1.Formio.Displays = Displays_1.default;
 Formio_1.Formio.Providers = providers_1.default;
 Formio_1.Formio.Widgets = widgets_1.default;
-Formio_1.Formio.Evaluator = Evaluator_1.default;
+Formio_1.Formio.Evaluator = Evaluator_1.Evaluator;
 Formio_1.Formio.AllComponents = components_1.default;
 Formio_1.Formio.Licenses = licenses_1.default;
 // This is strange, but is needed for "premium" components to import correctly.
@@ -52,8 +52,10 @@ Formio_1.Formio.Formio = Formio_1.Formio;
 Formio_1.Formio.Components.setComponents(components_1.default);
 /**
  * Register a module
- * @param {*} plugin
- * @returns
+ * @param {any} mod - The module object to register. This can also be a function which accepts Formio as an argument.
+ * @param {Function|null} [defaultFn] - The default function to call if the module does not have a known key.
+ * @param {any} options - Options for the module.
+ * @returns {void}
  */
 function registerModule(mod, defaultFn = null, options = {}) {
     if (typeof mod === 'function') {
@@ -115,6 +117,10 @@ function registerModule(mod, defaultFn = null, options = {}) {
     }
 }
 exports.registerModule = registerModule;
+/**
+ * @param {Function|null} defaultFn - The default function to call if the module does not have a known key.
+ * @returns {void}
+ */
 function useModule(defaultFn = null) {
     return (plugins, options = {}) => {
         plugins = lodash_1.default.isArray(plugins) ? plugins : [plugins];
@@ -136,3 +142,5 @@ exports.useModule = useModule;
  * Formio.plugins([plugin1, plugin2, etc], options);
  */
 Formio_1.Formio.use = useModule();
+var Formio_2 = require("./Formio");
+Object.defineProperty(exports, "FormioCore", { enumerable: true, get: function () { return Formio_2.Formio; } });

package/lib/cjs/providers/Providers.d.ts

@@ -1,7 +1,14 @@
+/**
+ * @class Providers
+ * @classdesc Represents a collection of providers.
+ */
+/**
+ * Represents a collection of providers.
+ */
 export default class Providers {
     static providers: {
         address: {
-            [x: string]: typeof import("./address/CustomAddressProvider").CustomAddressProvider | typeof import("./address/GoogleAddressProvider").GoogleAddressProvider;
+            [x: string]: typeof import("./address/AzureAddressProvider").AzureAddressProvider | typeof import("./address/CustomAddressProvider").CustomAddressProvider | typeof import("./address/GoogleAddressProvider").GoogleAddressProvider | typeof import("./address/NominatimAddressProvider").NominatimAddressProvider;
         };
         auth: {};
         storage: {
@@ -13,8 +20,32 @@ export default class Providers {
             googledrive: typeof import("./storage/googleDrive").default;
         };
     };
-    static addProvider(type: any, name: any, provider: any): void;
-    static addProviders(type: any, providers: any): void;
-    static getProvider(type: any, name: any): any;
-    static getProviders(type: any): any;
+    /**
+     * Adds a provider to the collection.
+     * @param {string} type - The type of the provider.
+     * @param {string} name - The name of the provider.
+     * @param {Provider} provider - The provider object.
+     */
+    static addProvider(type: string, name: string, provider: Provider): void;
+    /**
+     * Adds multiple providers to the collection.
+     * @param {string} type - The type of the providers.
+     * @param {{ [key: string]: Provider }} providers - The collection of providers.
+     */
+    static addProviders(type: string, providers: {
+        [key: string]: Provider;
+    }): void;
+    /**
+     * Retrives a provider a provider from the collection.
+     * @param {string} type - The type of the provider.
+     * @param {string} name - The name of the provider.
+     * @returns {Provider | void} The provider object.
+     */
+    static getProvider(type: string, name: string): Provider | void;
+    /**
+     * Retrives all providers of a given type.
+     * @param {string} type - The type of the providers.
+     * @returns {Provider[] | void} The collection of providers.
+     */
+    static getProviders(type: string): Provider[] | void;
 }

package/lib/cjs/providers/Providers.js

@@ -7,19 +7,48 @@ const lodash_1 = __importDefault(require("lodash"));
 const address_1 = __importDefault(require("./address"));
 const auth_1 = __importDefault(require("./auth"));
 const storage_1 = __importDefault(require("./storage"));
+/**
+ * @class Providers
+ * @classdesc Represents a collection of providers.
+ */
+/**
+ * Represents a collection of providers.
+ */
 class Providers {
+    /**
+     * Adds a provider to the collection.
+     * @param {string} type - The type of the provider.
+     * @param {string} name - The name of the provider.
+     * @param {Provider} provider - The provider object.
+     */
     static addProvider(type, name, provider) {
         Providers.providers[type] = Providers.providers[type] || {};
         Providers.providers[type][name] = provider;
     }
+    /**
+     * Adds multiple providers to the collection.
+     * @param {string} type - The type of the providers.
+     * @param {{ [key: string]: Provider }} providers - The collection of providers.
+     */
     static addProviders(type, providers) {
         Providers.providers[type] = lodash_1.default.merge(Providers.providers[type], providers);
     }
+    /**
+     * Retrives a provider a provider from the collection.
+     * @param {string} type - The type of the provider.
+     * @param {string} name - The name of the provider.
+     * @returns {Provider | void} The provider object.
+     */
     static getProvider(type, name) {
         if (Providers.providers[type] && Providers.providers[type][name]) {
             return Providers.providers[type][name];
         }
     }
+    /**
+     * Retrives all providers of a given type.
+     * @param {string} type - The type of the providers.
+     * @returns {Provider[] | void} The collection of providers.
+     */
     static getProviders(type) {
         if (Providers.providers[type]) {
             return Providers.providers[type];

package/lib/cjs/providers/address/AddressProvider.d.ts

@@ -1,17 +1,136 @@
+/**
+ * @typedef {object} RequestOptions
+ * @property {object} params - The request parameters.
+ * @property {boolean} noToken - Whether to include a token in the request.
+ */
+/**
+ * @typedef {object} Address
+ * @property {string} street - The street address.
+ * @property {string} city - The city.
+ * @property {string} state - The state.
+ * @property {string} country - The country.
+ * @property {string} postalCode - The postal code.
+ */
+/**
+ * @class AddressProvider
+ * @classdesc Represents an address provider.
+ */
 export class AddressProvider {
+    /**
+     * @static
+     * @type {string}
+     * @description The name of the address provider.
+     */
     static get name(): string;
+    /**
+     * @static
+     * @type {string}
+     * @description The display name of the address provider.
+     */
     static get displayName(): string;
-    constructor(options?: {});
+    /**
+     * @class
+     * @param {object} options - The options for the address provider.
+     */
+    constructor(options?: object);
     options: any;
-    beforeMergeOptions(): void;
-    get defaultOptions(): {};
-    get queryProperty(): string;
-    get responseProperty(): null;
-    get displayValueProperty(): null;
-    serialize(params: any): any;
-    getRequestOptions(options?: {}): any;
-    getRequestUrl(options?: {}): void;
-    makeRequest(options?: {}): any;
-    search(query: any, options?: {}): any;
-    getDisplayValue(address: any): any;
+    /**
+     * @private
+     * @description Executes before merging the options.
+     */
+    private beforeMergeOptions;
+    /**
+     * @private
+     * @type {object}
+     * @description The default options for the address provider.
+     */
+    private get defaultOptions();
+    /**
+     * @private
+     * @type {string}
+     * @description The query property name.
+     */
+    private get queryProperty();
+    /**
+     * @private
+     * @type {string|null}
+     * @description The response property name.
+     */
+    private get responseProperty();
+    /**
+     * @private
+     * @type {string|null}
+     * @description The display value property name.
+     */
+    private get displayValueProperty();
+    /**
+     * @private
+     * @param {object} params - The parameters to serialize.
+     * @returns {string} The serialized parameters.
+     */
+    private serialize;
+    /**
+     * @private
+     * @param {object} options - The request options.
+     * @returns {RequestOptions} The merged request options.
+     */
+    private getRequestOptions;
+    /**
+     * @private
+     * @param {object} _options - The request options.
+     * @throws {Error} Throws an error if the method is not implemented.
+     */
+    private getRequestUrl;
+    /**
+     * @private
+     * @param {object} options - The request options.
+     * @returns {Promise} A promise that resolves with the request result.
+     */
+    private makeRequest;
+    /**
+     * @public
+     * @description The search parameters for the request.
+     * @param {string} query - The search query.
+     * @param {object} options - The search options.
+     * @returns {Promise<Address[]>} A promise that resolves with the search results.
+     */
+    public search(query: string, options?: object): Promise<Address[]>;
+    /**
+     * @public
+     * @param {Address} address - The address object.
+     * @returns {string} The display value of the address.
+     */
+    public getDisplayValue(address: Address): string;
 }
+export type RequestOptions = {
+    /**
+     * - The request parameters.
+     */
+    params: object;
+    /**
+     * - Whether to include a token in the request.
+     */
+    noToken: boolean;
+};
+export type Address = {
+    /**
+     * - The street address.
+     */
+    street: string;
+    /**
+     * - The city.
+     */
+    city: string;
+    /**
+     * - The state.
+     */
+    state: string;
+    /**
+     * - The country.
+     */
+    country: string;
+    /**
+     * - The postal code.
+     */
+    postalCode: string;
+};

package/lib/cjs/providers/address/AddressProvider.js

@@ -6,47 +6,128 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AddressProvider = void 0;
 const lodash_1 = __importDefault(require("lodash"));
 const Formio_1 = require("../../Formio");
+/**
+ * @typedef {object} RequestOptions
+ * @property {object} params - The request parameters.
+ * @property {boolean} noToken - Whether to include a token in the request.
+ */
+/**
+ * @typedef {object} Address
+ * @property {string} street - The street address.
+ * @property {string} city - The city.
+ * @property {string} state - The state.
+ * @property {string} country - The country.
+ * @property {string} postalCode - The postal code.
+ */
+/**
+ * @class AddressProvider
+ * @classdesc Represents an address provider.
+ */
 class AddressProvider {
+    /**
+     * @static
+     * @type {string}
+     * @description The name of the address provider.
+     */
     static get name() {
         return 'address';
     }
+    /**
+     * @static
+     * @type {string}
+     * @description The display name of the address provider.
+     */
     static get displayName() {
         return 'Address';
     }
+    /**
+     * @class
+     * @param {object} options - The options for the address provider.
+     */
     constructor(options = {}) {
         this.beforeMergeOptions(options);
         this.options = lodash_1.default.merge({}, this.defaultOptions, options);
     }
+    /**
+     * @private
+     * @description Executes before merging the options.
+     */
     beforeMergeOptions() {
         return;
     }
+    /**
+     * @private
+     * @type {object}
+     * @description The default options for the address provider.
+     */
     get defaultOptions() {
         return {};
     }
+    /**
+     * @private
+     * @type {string}
+     * @description The query property name.
+     */
     get queryProperty() {
         return 'query';
     }
+    /**
+     * @private
+     * @type {string|null}
+     * @description The response property name.
+     */
     get responseProperty() {
         return null;
     }
+    /**
+     * @private
+     * @type {string|null}
+     * @description The display value property name.
+     */
     get displayValueProperty() {
         return null;
     }
+    /**
+     * @private
+     * @param {object} params - The parameters to serialize.
+     * @returns {string} The serialized parameters.
+     */
     serialize(params) {
         return lodash_1.default.toPairs(params).map(([key, value]) => `${encodeURIComponent(key)}=${encodeURIComponent(value)}`).join('&');
     }
+    /**
+     * @private
+     * @param {object} options - The request options.
+     * @returns {RequestOptions} The merged request options.
+     */
     getRequestOptions(options = {}) {
         return lodash_1.default.merge({}, this.options, options);
     }
-    // eslint-disable-next-line no-unused-vars
-    getRequestUrl(options = {}) {
+    /**
+     * @private
+     * @param {object} _options - The request options.
+     * @throws {Error} Throws an error if the method is not implemented.
+     */
+    getRequestUrl(_options = {}) {
         throw new Error('Method AddressProvider#getRequestUrl(options) is abstract.');
     }
+    /**
+     * @private
+     * @param {object} options - The request options.
+     * @returns {Promise} A promise that resolves with the request result.
+     */
     makeRequest(options = {}) {
         return Formio_1.Formio.makeStaticRequest(this.getRequestUrl(options), 'GET', null, {
             noToken: true,
         });
     }
+    /**
+     * @public
+     * @description The search parameters for the request.
+     * @param {string} query - The search query.
+     * @param {object} options - The search options.
+     * @returns {Promise<Address[]>} A promise that resolves with the search results.
+     */
     search(query, options = {}) {
         const requestOptions = this.getRequestOptions(options);
         const params = requestOptions.params = requestOptions.params || {};
@@ -54,6 +135,11 @@ class AddressProvider {
         return this.makeRequest(requestOptions)
             .then((result) => this.responseProperty ? lodash_1.default.get(result, this.responseProperty, []) : result);
     }
+    /**
+     * @public
+     * @param {Address} address - The address object.
+     * @returns {string} The display value of the address.
+     */
     getDisplayValue(address) {
         return this.displayValueProperty ? lodash_1.default.get(address, this.displayValueProperty, '') : String(address);
     }

package/lib/cjs/providers/address/AzureAddressProvider.d.ts

@@ -1,12 +1,59 @@
+/**
+ * @typedef {object} AzureAddressProviderOptionsParams
+ * @property {string} 'api-version' - The version of the Azure Maps API.
+ * @property {string} typeahead - Whether to enable typeahead in the search.
+ * @typedef {object} AzureAddressProviderOptions
+ * @property {AzureAddressProviderOptionsParams} params - The parameters for the Azure Maps API request.
+ */
+/**
+ * @class
+ * @augments AddressProvider
+ * @classdesc Represents an Azure Maps address provider.
+ */
 export class AzureAddressProvider extends AddressProvider {
+    /**
+     * Gets the default options for the address provider.
+     * @returns {{ params: { 'api-version': string, typeahead: string } }} The default options.
+     */
     get defaultOptions(): {
         params: {
             'api-version': string;
             typeahead: string;
         };
     };
+    /**
+     * Gets the response property for the address provider.
+     * @type {string}
+     */
     get responseProperty(): string;
+    /**
+     * Gets the display value property for the address provider.
+     * @type {string}
+     */
     get displayValueProperty(): string;
-    getRequestUrl(options?: {}): string;
+    /**
+     * Gets the request URL for the address provider.
+     * @param {{params: any}} options - The request options.
+     * @returns {string} The request URL.
+     */
+    getRequestUrl(options?: {
+        params: any;
+    }): string;
 }
+export type AzureAddressProviderOptionsParams = {
+    /**
+     * 'api-version' - The version of the Azure Maps API.
+     */
+    "": string;
+    /**
+     * - Whether to enable typeahead in the search.
+     */
+    typeahead: string;
+};
+export type AzureAddressProviderOptions = {
+    /**
+     * - The parameters for the Azure Maps API request.
+     */
+    params: AzureAddressProviderOptionsParams;
+};
 import { AddressProvider } from './AddressProvider';