@formio/js 5.0.0-dev.5604.02ffada → 5.0.0-dev.5610.11a9aca

package/lib/mjs/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/mjs/providers/Providers.js

@@ -2,24 +2,53 @@ import _ from 'lodash';
 import address from './address';
 import auth from './auth';
 import storage from './storage';
+/**
+ * @class Providers
+ * @classdesc Represents a collection of providers.
+ */
+/**
+ * Represents a collection of providers.
+ */
 export default class Providers {
     static providers = {
         address,
         auth,
         storage,
     };
+    /**
+     * 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] = _.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/mjs/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/mjs/providers/address/AddressProvider.js

@@ -1,46 +1,127 @@
 import _ from 'lodash';
 import { Formio } from '../../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.
+ */
 export 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 = _.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 _.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 _.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.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 || {};
@@ -48,6 +129,11 @@ export class AddressProvider {
         return this.makeRequest(requestOptions)
             .then((result) => this.responseProperty ? _.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 ? _.get(address, this.displayValueProperty, '') : String(address);
     }

package/lib/mjs/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';

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

@@ -1,11 +1,35 @@
 import { AddressProvider } from './AddressProvider';
+/**
+ * @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 name of the address provider.
+     * @type {string}
+     */
     static get name() {
         return 'azure';
     }
+    /**
+     * Gets the display name of the address provider.
+     * @type {string}
+     */
     static get displayName() {
         return 'Azure Maps';
     }
+    /**
+     * Gets the default options for the address provider.
+     * @returns {{ params: { 'api-version': string, typeahead: string } }} The default options.
+     */
     get defaultOptions() {
         return {
             params: {
@@ -14,12 +38,25 @@ export class AzureAddressProvider extends AddressProvider {
             },
         };
     }
+    /**
+     * Gets the response property for the address provider.
+     * @type {string}
+     */
     get responseProperty() {
         return 'results';
     }
+    /**
+     * Gets the display value property for the address provider.
+     * @type {string}
+     */
     get displayValueProperty() {
         return 'address.freeformAddress';
     }
+    /**
+     * Gets the request URL for the address provider.
+     * @param {{params: any}} options - The request options.
+     * @returns {string} The request URL.
+     */
     getRequestUrl(options = {}) {
         const { params } = options;
         return `https://atlas.microsoft.com/search/address/json?${this.serialize(params)}`;

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)}`;