@formio/js 5.0.0-dev.5641.d9ab3df → 5.0.0-dev.5642.afd813e

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

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

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

@@ -1,59 +1,12 @@
-/**
- * @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;
-    /**
-     * 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;
+    getRequestUrl(options?: {}): 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/cjs/providers/address/AzureAddressProvider.js

@@ -2,37 +2,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AzureAddressProvider = void 0;
 const AddressProvider_1 = require("./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.
- */
 class AzureAddressProvider extends AddressProvider_1.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: {
@@ -41,25 +17,12 @@ class AzureAddressProvider extends AddressProvider_1.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/cjs/providers/address/CustomAddressProvider.d.ts

@@ -1,30 +1,7 @@
-/**
- * CustomAddressProvider class extends the AddressProvider class and provides custom functionality for address handling.
- * @augments AddressProvider
- */
 export class CustomAddressProvider extends AddressProvider {
-    /**
-     * 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;
+    get queryProperty(): any;
+    get responseProperty(): any;
+    get displayValueProperty(): any;
+    getRequestUrl(options?: {}): string;
 }
 import { AddressProvider } from './AddressProvider';

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

@@ -2,56 +2,22 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CustomAddressProvider = void 0;
 const AddressProvider_1 = require("./AddressProvider");
-/**
- * CustomAddressProvider class extends the AddressProvider class and provides custom functionality for address handling.
- * @augments AddressProvider
- */
 class CustomAddressProvider extends AddressProvider_1.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/cjs/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/cjs/providers/address/GoogleAddressProvider.js

@@ -8,49 +8,13 @@ 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);
@@ -61,35 +25,18 @@ class GoogleAddressProvider extends AddressProvider_1.AddressProvider {
         }
         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)) {
@@ -98,25 +45,13 @@ 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', '');
@@ -130,16 +65,9 @@ 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,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';