outsystems-ui/src/scripts/OutSystems/OSUI/Patterns/SearchAPI.ts

OutSystems UI Framework

// eslint-disable-next-line @typescript-eslint/no-unused-vars
namespace OutSystems.OSUI.Patterns.SearchAPI {
	const _searchMap = new Map<string, OSFramework.OSUI.Patterns.Search.ISearch>();
	/**
	 * Function that will change the property of a given Search.
	 *
	 * @export
	 * @param {string} searchId
	 * @param {string} propertyName
	 * @param {*} propertyValue
	 */
	// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
	export function ChangeProperty(searchId: string, propertyName: string, propertyValue: any): string {
		const result = OutSystems.OSUI.Utils.CreateApiResponse({
			errorCode: ErrorCodes.Search.FailChangeProperty,
			callback: () => {
				const search = GetSearchById(searchId);

				search.changeProperty(propertyName, propertyValue);
			},
		});

		return result;
	}

	/**
	 * Create the new Search instance and add it to the SearchesMap
	 *
	 * @export
	 * @param {string} searchId
	 * @param {string} configs
	 * @return {*}  {OSFramework.OSUI.Patterns.Search.ISearch}
	 */
	export function Create(searchId: string, configs: string): OSFramework.OSUI.Patterns.Search.ISearch {
		if (_searchMap.has(searchId)) {
			throw new Error(
				`There is already a ${OSFramework.OSUI.GlobalEnum.PatternName.Search} registered under id: ${searchId}`
			);
		}

		const _newSearch = new OSFramework.OSUI.Patterns.Search.Search(searchId, JSON.parse(configs));
		_searchMap.set(searchId, _newSearch);
		return _newSearch;
	}

	/**
	 * Function that will destroy the instance of the given Search
	 *
	 * @export
	 * @param {string} searchId
	 */
	export function Dispose(searchId: string): string {
		const result = OutSystems.OSUI.Utils.CreateApiResponse({
			errorCode: ErrorCodes.Search.FailDispose,
			callback: () => {
				const search = GetSearchById(searchId);

				search.dispose();

				_searchMap.delete(searchId);
			},
		});

		return result;
	}

	/**
	 * Fucntion that will return the Map with all the Search instances at the page
	 *
	 * @export
	 * @return {*}  {Array<string>}
	 */
	export function GetAllSearches(): Array<string> {
		return OSFramework.OSUI.Helper.MapOperation.ExportKeys(_searchMap);
	}

	/**
	 * Function that gets the instance of Search, by a given ID.
	 *
	 * @export
	 * @param {string} searchId
	 * @return {*}  {OSFramework.OSUI.Patterns.Search.ISearch}
	 */
	export function GetSearchById(searchId: string): OSFramework.OSUI.Patterns.Search.ISearch {
		return OSFramework.OSUI.Helper.MapOperation.FindInMap(
			'Search',
			searchId,
			_searchMap
		) as OSFramework.OSUI.Patterns.Search.ISearch;
	}

	/**
	 * Function that will initialize the pattern instance.
	 *
	 * @export
	 * @param {string} searchId
	 * @return {*}  {OSFramework.OSUI.Patterns.Search.ISearch}
	 */
	export function Initialize(searchId: string): OSFramework.OSUI.Patterns.Search.ISearch {
		const search = GetSearchById(searchId);

		search.build();

		return search;
	}

	/**
	 * Function to register a provider callback
	 *
	 * @export
	 * @param {string} searchId
	 * @param {string} eventName
	 * @param {OSFramework.OSUI.GlobalCallbacks.OSGeneric} callback
	 * @return {*} {string} Return Message Success or message of error info if it's the case.
	 */
	export function RegisterCallback(
		searchId: string,
		eventName: string,
		callback: OSFramework.OSUI.GlobalCallbacks.OSGeneric
	): string {
		const result = OutSystems.OSUI.Utils.CreateApiResponse({
			errorCode: ErrorCodes.Search.FailRegisterCallback,
			callback: () => {
				const _SearchItem = this.GetSearchById(searchId);

				_SearchItem.registerCallback(eventName, callback);
			},
		});

		return result;
	}
}