@formio/js 5.0.0-dev.5633.8d2b30d → 5.0.0-dev.5633.fde3bc9

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

@@ -1,18 +1,142 @@
+/**
+ * @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;
 }
+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/cjs/providers/address/GoogleAddressProvider.js

@@ -8,35 +8,88 @@ exports.GoogleAddressProvider = void 0;
 const Formio_1 = require("../../Formio");
 const lodash_1 = __importDefault(require("lodash"));
 const AddressProvider_1 = require("./AddressProvider");
+/**
+ * @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
+ */
 class GoogleAddressProvider extends AddressProvider_1.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 = {}) {
         var _a;
         super(options);
         this.setAutocompleteOptions();
-        let src = 'https://maps.googleapis.com/maps/api/js?v=quarterly&libraries=places&callback=googleMapsCallback';
+        let src = 'https://maps.googleapis.com/maps/api/js?v=quarterly&libraries=places&loading=async&callback=googleMapsCallback';
         if ((_a = options.params) === null || _a === void 0 ? void 0 : _a.key) {
             src += `&key=${options.params.key}`;
         }
         Formio_1.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 = lodash_1.default.get(this.options, 'params.autocompleteOptions', {});
         if (!lodash_1.default.isObject(options)) {
@@ -45,13 +98,25 @@ class GoogleAddressProvider extends AddressProvider_1.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 = lodash_1.default.get(providerOptions, 'params.region', '');
@@ -65,9 +130,16 @@ class GoogleAddressProvider extends AddressProvider_1.AddressProvider {
             lodash_1.default.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 (lodash_1.default.isArray(options.fields) && options.fields.length > 0) {

package/lib/cjs/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/cjs/providers/address/NominatimAddressProvider.js

@@ -2,13 +2,33 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NominatimAddressProvider = void 0;
 const AddressProvider_1 = require("./AddressProvider");
+/**
+ * @typedef {object} NominatimAddressProviderOptionsParams
+ * @property {{ addressdetails: string, format: string } } params - The parameters for the Nominatim API request.
+ */
+/**
+ * Represents an Nominatim address provider.
+ * {extends AddressProvider}
+ */
 class NominatimAddressProvider extends AddressProvider_1.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: {
@@ -17,12 +37,25 @@ class NominatimAddressProvider extends AddressProvider_1.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/cjs/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/cjs/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/cjs/providers/processor/fileProcessor.js

@@ -1,5 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * 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/cjs/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/cjs/providers/storage/azure.js

@@ -4,6 +4,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const xhr_1 = __importDefault(require("./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/cjs/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/cjs/providers/storage/base64.js

@@ -1,5 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * 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/cjs/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/cjs/providers/storage/dropbox.js

@@ -1,6 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const xhr_1 = require("./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/cjs/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/cjs/providers/storage/googleDrive.js

@@ -1,6 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const xhr_1 = require("./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/cjs/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;
 }

package/lib/cjs/providers/storage/indexeddb.js

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const uuid_1 = require("uuid");
+/**
+ * indexedDb provider for file storage.
+ * @returns {import('./typedefs').FileProvider} The FileProvider interface defined in index.js.
+ */
 function indexeddb() {
     return {
         title: 'indexedDB',

package/lib/cjs/providers/storage/s3.d.ts

@@ -1,24 +1,10 @@
 export default s3;
-declare function s3(formio: any): {
-    uploadFile(file: any, fileName: any, dir: any, progressCallback: any, url: any, options: any, fileKey: any, groupPermissions: any, groupId: any, abortCallback: any, multipartOptions: any): Promise<{
-        storage: string;
-        name: any;
-        bucket: any;
-        key: any;
-        url: any;
-        acl: any;
-        size: any;
-        type: any;
-    }>;
-    completeMultipartUpload(serverResponse: any, parts: any, multipart: any): Promise<void>;
-    abortMultipartUpload(serverResponse: any): void;
-    uploadParts(file: any, urls: any, headers: any, partSize: any, multipart: any, abortSignal: any): Promise<{
-        ETag: string;
-        PartNumber: number;
-    }[]>;
-    downloadFile(file: any): any;
-    deleteFile(fileInfo: any): any;
-};
+/**
+ * S3 File Services provider for file storage.
+ * @param {object} formio formio instance
+ * @returns {import('./typedefs').FileProvider} The FileProvider interface defined in index.js.
+ */
+declare function s3(formio: object): any;
 declare namespace s3 {
     let title: string;
 }

package/lib/cjs/providers/storage/s3.js

@@ -42,6 +42,11 @@ const loadAbortControllerPolyfill = () => __awaiter(void 0, void 0, void 0, func
         yield Promise.resolve().then(() => __importStar(require('abortcontroller-polyfill/dist/polyfill-patch-fetch')));
     }
 });
+/**
+ * S3 File Services provider for file storage.
+ * @param {object} formio formio instance
+ * @returns {import('./typedefs').FileProvider} The FileProvider interface defined in index.js.
+ */
 function s3(formio) {
     return {
         uploadFile(file, fileName, dir, progressCallback, url, options, fileKey, groupPermissions, groupId, abortCallback, multipartOptions) {

package/lib/cjs/providers/storage/url.d.ts

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

package/lib/cjs/providers/storage/url.js

@@ -1,6 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ *
+ * @param {object} formio - formio instance
+ * @returns {import('./typedefs').FileProvider} The FileProvider interface defined in index.js.
+ */
 function url(formio) {
+    /**
+     *
+     * @param {object} options - options to set on the xhr
+     * @param {object} xhr - the xhr object
+     */
     function setOptions(options, xhr) {
         const parsedOptions = typeof options === 'string' ? JSON.parse(options) : options;
         for (const prop in parsedOptions) {