@formio/js 5.0.0-dev.5613.77144cc → 5.0.0-dev.5614.b5c93f3

package/lib/mjs/providers/address/CustomAddressProvider.d.ts

@@ -1,7 +1,30 @@
+/**
+ * CustomAddressProvider class extends the AddressProvider class and provides custom functionality for address handling.
+ * @augments AddressProvider
+ */
 export class CustomAddressProvider extends AddressProvider {
-    get queryProperty(): any;
-    get responseProperty(): any;
-    get displayValueProperty(): any;
-    getRequestUrl(options?: {}): string;
+    /**
+     * Returns the response property of the custom address provider.
+     * If not provided, falls back to the response property of the parent class.
+     * @type {string}
+     */
+    get responseProperty(): string;
+    /**
+     * Returns the display value property of the custom address provider.
+     * If not provided, falls back to the display value property of the parent class.
+     * @type {string}
+     */
+    get displayValueProperty(): string;
+    /**
+     * Returns the request URL for the custom address provider.
+     * @param {object} options - The options for the request.
+     * @param {object} options.params - The parameters for the request.
+     * @param {string} options.url - The URL for the request.
+     * @returns {string} The request URL.
+     */
+    getRequestUrl(options?: {
+        params: object;
+        url: string;
+    }): string;
 }
 import { AddressProvider } from './AddressProvider';

package/lib/mjs/providers/address/CustomAddressProvider.js

@@ -1,20 +1,54 @@
 import { AddressProvider } from './AddressProvider';
+/**
+ * CustomAddressProvider class extends the AddressProvider class and provides custom functionality for address handling.
+ * @augments AddressProvider
+ */
 export class CustomAddressProvider extends AddressProvider {
+    /**
+     * Returns the name of the custom address provider.
+     * @type {string}
+     */
     static get name() {
         return 'custom';
     }
+    /**
+     * Returns the display name of the custom address provider.
+     * @type {string}
+     */
     static get displayName() {
         return 'Custom';
     }
+    /**
+     * Returns the query property of the custom address provider.
+     * If not provided, falls back to the query property of the parent class.
+     * @type {string}
+     */
     get queryProperty() {
         return this.options.queryProperty || super.queryProperty;
     }
+    /**
+     * Returns the response property of the custom address provider.
+     * If not provided, falls back to the response property of the parent class.
+     * @type {string}
+     */
     get responseProperty() {
         return this.options.responseProperty || super.responseProperty;
     }
+    /**
+     * Returns the display value property of the custom address provider.
+     * If not provided, falls back to the display value property of the parent class.
+     * @type {string}
+     */
     get displayValueProperty() {
         return this.options.displayValueProperty || super.displayValueProperty;
     }
+    /**
+     * Returns the request URL for the custom address provider.
+     * @param {object} options - The options for the request.
+     * @param {object} options.params - The parameters for the request.
+     * @param {string} options.url - The URL for the request.
+     * @returns {string} The request URL.
+     */
     getRequestUrl(options = {}) {
         const { params, url } = options;
         return `${url}?${this.serialize(params)}`;

package/lib/mjs/providers/address/GoogleAddressProvider.d.ts

@@ -1,18 +1,147 @@
+/**
+ * @typedef {object} AutocompleteOptions
+ * @property {string[]} fields - The fields to include in the autocomplete response.
+ * @property {object} componentRestrictions - The component restrictions for the autocomplete response.
+ * @property {string[]} componentRestrictions.country - The country codes to restrict the autocomplete response to.
+ */
+/**
+ * @typedef {object} ProviderOptions
+ * @property {string} region - The region to restrict the autocomplete response to.
+ * @property {string} key - The API key for Google Maps.
+ * @property {AutocompleteOptions} autocompleteOptions - The options for the autocomplete functionality.
+ */
+/**
+ * @typedef {object} Place
+ * @property {object} address_components - The address components of the place.
+ * @property {string} formatted_address - The formatted address of the place.
+ * @property {object} geometry - The geometry information of the place.
+ * @property {string} place_id - The place ID of the place.
+ * @property {object} plus_code - The plus code of the place.
+ * @property {string[]} types - The types of the place.
+ * @property {string} formattedPlace - The formatted place value.
+ */
+/**
+ * @class GoogleAddressProvider
+ * @augments AddressProvider
+ */
 export class GoogleAddressProvider extends AddressProvider {
+    /**
+     
+     * @param {ProviderOptions} options - The options for the provider.
+     */
+    constructor(options?: ProviderOptions);
+    /**
+     * get display value property
+     * @returns {string} The property to use for display value.
+     */
     get displayValueProperty(): string;
+    /**
+     * @returns {string} The alternative property to use for display value.
+     */
     get alternativeDisplayValueProperty(): string;
-    set autocompleteOptions(options: any);
-    get autocompleteOptions(): any;
-    _autocompleteOptions: any;
+    /**
+     * @param {AutocompleteOptions} options - The autocomplete options.
+     */
+    set autocompleteOptions(options: AutocompleteOptions);
+    /**
+     * @returns {AutocompleteOptions} The autocomplete options.
+     */
+    get autocompleteOptions(): AutocompleteOptions;
+    _autocompleteOptions: AutocompleteOptions | undefined;
+    /**
+     * Sets the autocomplete options based on the provider options.
+     
+     */
     setAutocompleteOptions(): void;
-    beforeMergeOptions(options: any): void;
+    /**
+     
+     * Converts the region to autocomplete option if it exists.
+     * @param {ProviderOptions} options - The provider options.
+     */
+    beforeMergeOptions(options: ProviderOptions): void;
+    /**
+     * @returns {string} The name of the library.
+     */
     getLibraryName(): string;
-    convertRegionToAutocompleteOption(options: any): void;
+    /**
+     * Converts the region to autocomplete option.
+     * @param {ProviderOptions} options - The provider options.
+     */
+    convertRegionToAutocompleteOption(options: ProviderOptions): void;
+    /**
+     * @returns {string[]} The required address properties.
+     */
     getRequiredAddressProperties(): string[];
-    addRequiredProviderOptions(options: any): void;
+    /**
+     * Adds the required provider options to the options.
+     * @param {AutocompleteOptions} options - The autocomplete options.
+     */
+    addRequiredProviderOptions(options: AutocompleteOptions): void;
     filterPlace(place: any): {};
     attachAutocomplete(elem: any, index: any, onSelectAddress: any): void;
     search(): Promise<void>;
     makeRequest(): Promise<void>;
+    getDisplayValue(address: any): any;
+    /**
+     * Tries to remove the library if api key for loaded script is different.
+     * @param {ProviderOptions} options - The options for the provider.
+     */
+    tryRemoveLibrary(options?: ProviderOptions): void;
 }
+export type AutocompleteOptions = {
+    /**
+     * - The fields to include in the autocomplete response.
+     */
+    fields: string[];
+    /**
+     * - The component restrictions for the autocomplete response.
+     */
+    componentRestrictions: {
+        country: string[];
+    };
+};
+export type ProviderOptions = {
+    /**
+     * - The region to restrict the autocomplete response to.
+     */
+    region: string;
+    /**
+     * - The API key for Google Maps.
+     */
+    key: string;
+    /**
+     * - The options for the autocomplete functionality.
+     */
+    autocompleteOptions: AutocompleteOptions;
+};
+export type Place = {
+    /**
+     * - The address components of the place.
+     */
+    address_components: object;
+    /**
+     * - The formatted address of the place.
+     */
+    formatted_address: string;
+    /**
+     * - The geometry information of the place.
+     */
+    geometry: object;
+    /**
+     * - The place ID of the place.
+     */
+    place_id: string;
+    /**
+     * - The plus code of the place.
+     */
+    plus_code: object;
+    /**
+     * - The types of the place.
+     */
+    types: string[];
+    /**
+     * - The formatted place value.
+     */
+    formattedPlace: string;
+};
 import { AddressProvider } from './AddressProvider';

package/lib/mjs/providers/address/GoogleAddressProvider.js

@@ -2,34 +2,91 @@
 import { Formio } from '../../Formio';
 import _ from 'lodash';
 import { AddressProvider } from './AddressProvider';
+const GOOGLE_MAPS_BASE_URL = 'https://maps.googleapis.com';
+const GOOGLE_MAPS_JS_URL = `${GOOGLE_MAPS_BASE_URL}/maps/api/js`;
+const GOOGLE_MAPS_JS_WITH_PARAMS_URL = `${GOOGLE_MAPS_JS_URL}?v=quarterly&libraries=places&loading=async&callback=googleMapsCallback`;
+/**
+ * @typedef {object} AutocompleteOptions
+ * @property {string[]} fields - The fields to include in the autocomplete response.
+ * @property {object} componentRestrictions - The component restrictions for the autocomplete response.
+ * @property {string[]} componentRestrictions.country - The country codes to restrict the autocomplete response to.
+ */
+/**
+ * @typedef {object} ProviderOptions
+ * @property {string} region - The region to restrict the autocomplete response to.
+ * @property {string} key - The API key for Google Maps.
+ * @property {AutocompleteOptions} autocompleteOptions - The options for the autocomplete functionality.
+ */
+/**
+ * @typedef {object} Place
+ * @property {object} address_components - The address components of the place.
+ * @property {string} formatted_address - The formatted address of the place.
+ * @property {object} geometry - The geometry information of the place.
+ * @property {string} place_id - The place ID of the place.
+ * @property {object} plus_code - The plus code of the place.
+ * @property {string[]} types - The types of the place.
+ * @property {string} formattedPlace - The formatted place value.
+ */
+/**
+ * @class GoogleAddressProvider
+ * @augments AddressProvider
+ */
 export class GoogleAddressProvider extends AddressProvider {
+    /**
+     * @returns {string} The name of the provider.
+     */
     static get name() {
         return 'google';
     }
+    /**
+     * @returns {string} The display name of the provider.
+     */
     static get displayName() {
         return 'Google Maps';
     }
+    /**
+     
+     * @param {ProviderOptions} options - The options for the provider.
+     */
     constructor(options = {}) {
         super(options);
         this.setAutocompleteOptions();
-        let src = 'https://maps.googleapis.com/maps/api/js?v=quarterly&libraries=places&callback=googleMapsCallback';
+        let src = GOOGLE_MAPS_JS_WITH_PARAMS_URL;
         if (options.params?.key) {
             src += `&key=${options.params.key}`;
         }
+        this.tryRemoveLibrary(options);
         Formio.requireLibrary(this.getLibraryName(), 'google.maps.places', src);
     }
+    /**
+     * get display value property
+     * @returns {string} The property to use for display value.
+     */
     get displayValueProperty() {
         return 'formattedPlace';
     }
+    /**
+     * @returns {string} The alternative property to use for display value.
+     */
     get alternativeDisplayValueProperty() {
         return 'formatted_address';
     }
+    /**
+     * @param {AutocompleteOptions} options - The autocomplete options.
+     */
     set autocompleteOptions(options) {
         this._autocompleteOptions = options;
     }
+    /**
+     * @returns {AutocompleteOptions} The autocomplete options.
+     */
     get autocompleteOptions() {
         return this._autocompleteOptions;
     }
+    /**
+     * Sets the autocomplete options based on the provider options.
+     
+     */
     setAutocompleteOptions() {
         let options = _.get(this.options, 'params.autocompleteOptions', {});
         if (!_.isObject(options)) {
@@ -38,13 +95,25 @@ export class GoogleAddressProvider extends AddressProvider {
         this.addRequiredProviderOptions(options);
         this.autocompleteOptions = options;
     }
+    /**
+     
+     * Converts the region to autocomplete option if it exists.
+     * @param {ProviderOptions} options - The provider options.
+     */
     beforeMergeOptions(options) {
         // providing support of old Google Provider option
         this.convertRegionToAutocompleteOption(options);
     }
+    /**
+     * @returns {string} The name of the library.
+     */
     getLibraryName() {
         return 'googleMaps';
     }
+    /**
+     * Converts the region to autocomplete option.
+     * @param {ProviderOptions} options - The provider options.
+     */
     convertRegionToAutocompleteOption(options) {
         const providerOptions = options;
         let region = _.get(providerOptions, 'params.region', '');
@@ -58,9 +127,16 @@ export class GoogleAddressProvider extends AddressProvider {
             _.set(providerOptions, 'params.autocompleteOptions.componentRestrictions.country', [region]);
         }
     }
+    /**
+     * @returns {string[]} The required address properties.
+     */
     getRequiredAddressProperties() {
         return ['address_components', 'formatted_address', 'geometry', 'place_id', 'plus_code', 'types'];
     }
+    /**
+     * Adds the required provider options to the options.
+     * @param {AutocompleteOptions} options - The autocomplete options.
+     */
     addRequiredProviderOptions(options) {
         const addressProperties = this.getRequiredAddressProperties();
         if (_.isArray(options.fields) && options.fields.length > 0) {
@@ -106,4 +182,21 @@ export class GoogleAddressProvider extends AddressProvider {
             : this.alternativeDisplayValueProperty;
         return _.get(address, displayedProperty, '');
     }
+    /**
+     * Tries to remove the library if api key for loaded script is different.
+     * @param {ProviderOptions} options - The options for the provider.
+     */
+    tryRemoveLibrary(options = {}) {
+        if (!Formio.libraries[this.getLibraryName()]) {
+            return;
+        }
+        const existingScript = document.querySelector(`script[src^="${GOOGLE_MAPS_JS_URL}"]`);
+        if (existingScript && options.params?.key && !existingScript.attributes.src.value.endsWith(options.params.key)) {
+            const googleMapsScripts = document.querySelectorAll(`script[src^="${GOOGLE_MAPS_BASE_URL}"]`) ?? [];
+            googleMapsScripts.forEach(script => script.parentNode.removeChild(script));
+            delete Formio.libraries[this.getLibraryName()];
+            delete global?.google?.maps;
+            delete global[`${this.getLibraryName()}Callback`];
+        }
+    }
 }

package/lib/mjs/providers/address/NominatimAddressProvider.d.ts

@@ -1,11 +1,36 @@
+/**
+ * @typedef {object} NominatimAddressProviderOptionsParams
+ * @property {{ addressdetails: string, format: string } } params - The parameters for the Nominatim API request.
+ */
+/**
+ * Represents an Nominatim address provider.
+ * {extends AddressProvider}
+ */
 export class NominatimAddressProvider extends AddressProvider {
-    get defaultOptions(): {
-        params: {
-            addressdetails: string;
-            format: string;
-        };
-    };
+    /**
+     * Gets the default options for the address provider.
+     * @returns {NominatimAddressProviderOptionsParams}  The default options.
+     */
+    get defaultOptions(): NominatimAddressProviderOptionsParams;
+    /**
+     * Gets the display value property for the address provider.
+     * @returns {string} The property to use for display value.
+     */
     get displayValueProperty(): string;
-    getRequestUrl(options?: {}): string;
+    /**
+     * Generates the request URL for the address provider with options.
+     * @param {NominatimAddressProviderOptionsParams} options - The request options.
+     * @returns {string} The formatted Url.
+     */
+    getRequestUrl(options?: NominatimAddressProviderOptionsParams): string;
 }
+export type NominatimAddressProviderOptionsParams = {
+    /**
+     * - The parameters for the Nominatim API request.
+     */
+    params: {
+        addressdetails: string;
+        format: string;
+    };
+};
 import { AddressProvider } from './AddressProvider';

package/lib/mjs/providers/address/NominatimAddressProvider.js

@@ -1,11 +1,31 @@
 import { AddressProvider } from './AddressProvider';
+/**
+ * @typedef {object} NominatimAddressProviderOptionsParams
+ * @property {{ addressdetails: string, format: string } } params - The parameters for the Nominatim API request.
+ */
+/**
+ * Represents an Nominatim address provider.
+ * {extends AddressProvider}
+ */
 export class NominatimAddressProvider extends AddressProvider {
+    /**
+     * Gets the name of the address provider.
+     * @type {string}
+     */
     static get name() {
         return 'nominatim';
     }
+    /**
+     * Gets the display name of the address provider.
+     * @type {string}
+     */
     static get displayName() {
         return 'OpenStreetMap Nominatim';
     }
+    /**
+     * Gets the default options for the address provider.
+     * @returns {NominatimAddressProviderOptionsParams}  The default options.
+     */
     get defaultOptions() {
         return {
             params: {
@@ -14,12 +34,25 @@ export class NominatimAddressProvider extends AddressProvider {
             },
         };
     }
+    /**
+     * Gets the response property for the address provider.
+     * @type {string}
+     */
     get queryProperty() {
         return 'q';
     }
+    /**
+     * Gets the display value property for the address provider.
+     * @returns {string} The property to use for display value.
+     */
     get displayValueProperty() {
         return 'display_name';
     }
+    /**
+     * Generates the request URL for the address provider with options.
+     * @param {NominatimAddressProviderOptionsParams} options - The request options.
+     * @returns {string} The formatted Url.
+     */
     getRequestUrl(options = {}) {
         const { params } = options;
         return `https://nominatim.openstreetmap.org/search?${this.serialize(params)}`;

package/lib/mjs/providers/address/index.d.ts

@@ -1,6 +1,8 @@
 declare const _default: {
-    [x: string]: typeof CustomAddressProvider | typeof GoogleAddressProvider;
+    [x: string]: typeof AzureAddressProvider | typeof CustomAddressProvider | typeof GoogleAddressProvider | typeof NominatimAddressProvider;
 };
 export default _default;
+import { AzureAddressProvider } from './AzureAddressProvider';
 import { CustomAddressProvider } from './CustomAddressProvider';
 import { GoogleAddressProvider } from './GoogleAddressProvider';
+import { NominatimAddressProvider } from './NominatimAddressProvider';

package/lib/mjs/providers/processor/fileProcessor.d.ts

@@ -1,2 +1,8 @@
 export default fileProcessor;
-declare function fileProcessor(formio: any, config: any): (file: any, options: any) => Promise<any>;
+/**
+ * Creates a file processor function.
+ * @param {Formio} formio - The Formio instance.
+ * @param {object} config - The configuration object.
+ * @returns {function(File, object): Promise<FormData>} A function that takes a file and options, and returns a Promise that resolves with the processed file.
+ */
+declare function fileProcessor(formio: Formio, config: object): (arg0: File, arg1: object) => Promise<FormData>;

package/lib/mjs/providers/processor/fileProcessor.js

@@ -1,3 +1,9 @@
+/**
+ * Creates a file processor function.
+ * @param {Formio} formio - The Formio instance.
+ * @param {object} config - The configuration object.
+ * @returns {function(File, object): Promise<FormData>} A function that takes a file and options, and returns a Promise that resolves with the processed file.
+ */
 const fileProcessor = (formio, config) => (file, options) => new Promise((resolve, reject) => {
     const xhr = new XMLHttpRequest();
     // Fire on network error.

package/lib/mjs/providers/storage/azure.d.ts

@@ -1,17 +1,10 @@
 export default azure;
-declare function azure(formio: any): {
-    uploadFile(file: any, fileName: any, dir: any, progressCallback: any, url: any, options: any, fileKey: any, groupPermissions: any, groupId: any, abortCallback: any): Promise<{
-        storage: string;
-        name: any;
-        size: any;
-        type: any;
-        groupPermissions: any;
-        groupId: any;
-        key: any;
-    }>;
-    downloadFile(file: any): any;
-    deleteFile: (fileInfo: any) => any;
-};
+/**
+ * Azure File Services provider for file storage.
+ * @param {object} formio formio instance
+ * @returns {import('./typedefs').FileProvider} The FileProvider interface defined in index.js.
+ */
+declare function azure(formio: object): any;
 declare namespace azure {
     let title: string;
 }

package/lib/mjs/providers/storage/azure.js

@@ -1,4 +1,9 @@
 import XHR from './xhr';
+/**
+ * Azure File Services provider for file storage.
+ * @param {object} formio formio instance
+ * @returns {import('./typedefs').FileProvider} The FileProvider interface defined in index.js.
+ */
 function azure(formio) {
     return {
         uploadFile(file, fileName, dir, progressCallback, url, options, fileKey, groupPermissions, groupId, abortCallback) {

package/lib/mjs/providers/storage/base64.d.ts

@@ -1,10 +1,9 @@
 export default base64;
-declare function base64(): {
-    title: string;
-    name: string;
-    uploadFile(file: any, fileName: any): Promise<any>;
-    downloadFile(file: any): Promise<any>;
-};
+/**
+ * base64 File Services provider for file storage.
+ * @returns {import('./typedefs').FileProvider} The FileProvider interface defined in index.js.
+ */
+declare function base64(): any;
 declare namespace base64 {
     let title: string;
 }

package/lib/mjs/providers/storage/base64.js

@@ -1,3 +1,7 @@
+/**
+ * base64 File Services provider for file storage.
+ * @returns {import('./typedefs').FileProvider} The FileProvider interface defined in index.js.
+ */
 function base64() {
     return {
         title: 'Base64',

package/lib/mjs/providers/storage/dropbox.d.ts

@@ -1,8 +1,10 @@
 export default dropbox;
-declare function dropbox(formio: any): {
-    uploadFile(file: any, fileName: any, dir: any, progressCallback: any, url: any, options: any, fileKey: any, groupPermissions: any, groupId: any, abortCallback: any): Promise<any>;
-    downloadFile(file: any): Promise<any>;
-};
+/**
+ * Dropbox provider for file storage.
+ * @param {object} formio formio instance
+ * @returns {import('./typedefs').FileProvider} The FileProvider interface defined in index.js.
+ */
+declare function dropbox(formio: object): any;
 declare namespace dropbox {
     let title: string;
 }

package/lib/mjs/providers/storage/dropbox.js

@@ -1,4 +1,9 @@
 import { setXhrHeaders } from './xhr';
+/**
+ * Dropbox provider for file storage.
+ * @param {object} formio formio instance
+ * @returns {import('./typedefs').FileProvider} The FileProvider interface defined in index.js.
+ */
 function dropbox(formio) {
     return {
         uploadFile(file, fileName, dir, progressCallback, url, options, fileKey, groupPermissions, groupId, abortCallback) {

package/lib/mjs/providers/storage/googleDrive.d.ts

@@ -1,9 +1,11 @@
 export default googledrive;
-declare function googledrive(formio: any): {
-    uploadFile(file: any, fileName: any, dir: any, progressCallback: any, url: any, options: any, fileKey: any, groupPermissions: any, groupId: any, abortCallback: any): Promise<any>;
-    downloadFile(file: any): Promise<any>;
-    deleteFile: (fileInfo: any) => any;
-};
+/**
+ *
+ * Google Drive provider for file storage.
+ * @param {object} formio - formio instance
+ * @returns {import('./typedefs').FileProvider} The FileProvider interface defined in index.js.
+ */
+declare function googledrive(formio: object): any;
 declare namespace googledrive {
     let title: string;
 }

package/lib/mjs/providers/storage/googleDrive.js

@@ -1,4 +1,10 @@
 import { setXhrHeaders } from './xhr';
+/**
+ *
+ * Google Drive provider for file storage.
+ * @param {object} formio - formio instance
+ * @returns {import('./typedefs').FileProvider} The FileProvider interface defined in index.js.
+ */
 function googledrive(formio) {
     return {
         uploadFile(file, fileName, dir, progressCallback, url, options, fileKey, groupPermissions, groupId, abortCallback) {

package/lib/mjs/providers/storage/indexeddb.d.ts

@@ -1,11 +1,9 @@
 export default indexeddb;
-declare function indexeddb(): {
-    title: string;
-    name: string;
-    uploadFile(file: any, fileName: any, dir: any, progressCallback: any, url: any, options: any): Promise<any> | undefined;
-    downloadFile(file: any, options: any): Promise<any>;
-    deleteFile(file: any, options: any): Promise<any>;
-};
+/**
+ * indexedDb provider for file storage.
+ * @returns {import('./typedefs').FileProvider} The FileProvider interface defined in index.js.
+ */
+declare function indexeddb(): any;
 declare namespace indexeddb {
     let title: string;
 }