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

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

@@ -1,142 +1,18 @@
-/**
- * @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;
-    /**
-     * @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.
-     
-     */
+    set autocompleteOptions(options: any);
+    get autocompleteOptions(): any;
+    _autocompleteOptions: any;
     setAutocompleteOptions(): 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.
-     */
+    beforeMergeOptions(options: any): void;
     getLibraryName(): string;
-    /**
-     * Converts the region to autocomplete option.
-     * @param {ProviderOptions} options - The provider options.
-     */
-    convertRegionToAutocompleteOption(options: ProviderOptions): void;
-    /**
-     * @returns {string[]} The required address properties.
-     */
+    convertRegionToAutocompleteOption(options: any): void;
     getRequiredAddressProperties(): string[];
-    /**
-     * Adds the required provider options to the options.
-     * @param {AutocompleteOptions} options - The autocomplete options.
-     */
-    addRequiredProviderOptions(options: AutocompleteOptions): void;
+    addRequiredProviderOptions(options: any): 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/mjs/providers/address/GoogleAddressProvider.js

@@ -2,49 +2,13 @@
 import { Formio } from '../../Formio';
 import _ from 'lodash';
 import { AddressProvider } from './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
- */
 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();
@@ -54,35 +18,18 @@ export class GoogleAddressProvider extends AddressProvider {
         }
         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)) {
@@ -91,25 +38,13 @@ 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', '');
@@ -123,16 +58,9 @@ 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) {

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

@@ -1,36 +1,11 @@
-/**
- * @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 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 defaultOptions(): {
+        params: {
+            addressdetails: string;
+            format: string;
+        };
+    };
     get displayValueProperty(): 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;
+    getRequestUrl(options?: {}): 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,31 +1,11 @@
 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: {
@@ -34,25 +14,12 @@ 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,8 +1,6 @@
 declare const _default: {
-    [x: string]: typeof AzureAddressProvider | typeof CustomAddressProvider | typeof GoogleAddressProvider | typeof NominatimAddressProvider;
+    [x: string]: typeof CustomAddressProvider | typeof GoogleAddressProvider;
 };
 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,8 +1,2 @@
 export default fileProcessor;
-/**
- * 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>;
+declare function fileProcessor(formio: any, config: any): (file: any, options: any) => Promise<any>;

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

@@ -1,9 +1,3 @@
-/**
- * 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,10 +1,17 @@
 export default azure;
-/**
- * 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 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;
+};
 declare namespace azure {
     let title: string;
 }

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

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

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

@@ -1,7 +1,3 @@
-/**
- * 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,10 +1,8 @@
 export default dropbox;
-/**
- * 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 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>;
+};
 declare namespace dropbox {
     let title: string;
 }

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

@@ -1,9 +1,4 @@
 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,11 +1,9 @@
 export default googledrive;
-/**
- *
- * 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 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;
+};
 declare namespace googledrive {
     let title: string;
 }

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

@@ -1,10 +1,4 @@
 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,9 +1,11 @@
 export default indexeddb;
-/**
- * indexedDb provider for file storage.
- * @returns {import('./typedefs').FileProvider} The FileProvider interface defined in index.js.
- */
-declare function indexeddb(): any;
+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>;
+};
 declare namespace indexeddb {
     let title: string;
 }

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

@@ -1,8 +1,4 @@
 import { v4 as uuidv4 } from 'uuid';
-/**
- * indexedDb provider for file storage.
- * @returns {import('./typedefs').FileProvider} The FileProvider interface defined in index.js.
- */
 function indexeddb() {
     return {
         title: 'indexedDB',

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

@@ -1,10 +1,24 @@
 export default s3;
-/**
- * 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 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;
+};
 declare namespace s3 {
     let title: string;
 }

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

@@ -5,11 +5,6 @@ const loadAbortControllerPolyfill = async () => {
         await import('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 {
         async uploadFile(file, fileName, dir, progressCallback, url, options, fileKey, groupPermissions, groupId, abortCallback, multipartOptions) {

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

@@ -1,10 +1,11 @@
 export default url;
-/**
- *
- * @param {object} formio - formio instance
- * @returns {import('./typedefs').FileProvider} The FileProvider interface defined in index.js.
- */
-declare function url(formio: object): any;
+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>;
+};
 declare namespace url {
     let title: string;
 }

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

@@ -1,14 +1,4 @@
-/**
- *
- * @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) {

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

@@ -1,24 +1 @@
-/**
- * @typedef {any[]} Args
- */
-/**
- * Function to be retried
- * @callback RetryFunction
- * @param {...Args} args
- * @returns {Promise<any>}
- */
-/**
- * Executes a function with retries in case of failure.
- * @param {RetryFunction} fn - The function to be executed.
- * @param {Args} args - The arguments to be passed to the function.
- * @param {number} [retries] - The number of retries in case of failure.
- * @param {string} [err] - The error message to be thrown after all retries have failed.
- * @returns {Promise<any>} The result of the function execution.
- * @throws {Error} When all retries have failed.
- */
-export function withRetries(fn: RetryFunction, args: Args, retries?: number | undefined, err?: string | undefined): Promise<any>;
-export type Args = any[];
-/**
- * Function to be retried
- */
-export type RetryFunction = (...args: Args[]) => Promise<any>;
+export function withRetries(fn: any, args: any, retries?: number, err?: null): Promise<any>;