@metamask/react-native-search-api/index.js

A React Native module that allows to perform the Spotlight integration on iOS

import { NativeModules, NativeEventEmitter } from 'react-native';
const SearchApiManager = NativeModules.SearchApiManager;

const SPOTLIGHT_SEARCH_ITEM_TAPPED_EVENT = "spotlightSearchItemTapped";
const APP_HISTORY_SEARCH_ITEM_TAPPED = "appHistorySearchItemTapped";

/**
 * `SearchApi` gives you a general interface to interact with the iOS Search API.
 *
 * ## Search item keys
 *
 * Dictionaries, passed to create spotlight and app history items have some common
 * and some specific keys, here is the list of all possible keys.
 *
 * ### Common keys
 *
 * #### title: string
 * Title of the item. Required for both item types.
 *
 * #### contentDescription: string
 * Description of the item. Optional.
 *
 * #### keywords: Array<string>
 * An array of keywords, assigned to the search item. Optional.
 *
 * #### thumbnailURL: string
 * URL of the thumbnail, presented in the search results. Optional.
 *
 * ### Spotlight-specific keys
 *
 * #### uniqueIdentifier: string
 * The unique identifier of the spotlight item, passed later on during
 * the item opening event. Required.
 *
 * #### domain: string
 * The domain for the spotlight item. Optional.
 *
 * ### App history-specific keys
 *
 * #### userInfo: Object
 * A dictionary, passed later on during the item opening event. Required.
 *
 * #### eligibleForPublicIndexing: boolean
 * A flag, that when set to `true` allows to add the item to the public index.
 * Optional.
 *
 * #### expirationDate: Date
 * Expiration date of the search item. Optional.
 *
 * #### webpageURL: string
 * URL of the page, representing the same content on the app's website.
 */
class SearchApi extends NativeEventEmitter {

    constructor() {
        super(SearchApiManager);
    }

   /**
    * Registers for the spotlight item opening event.
    *
    * @NOTE A good place for calling this method is the component's
    * `componentDidMount` override.
    *
    * @param listener A function that takes a single parameter
    * of type `string`, containing the unique identifier of the
    * spotlight item.
    */
    addOnSpotlightItemOpenEventListener(listener: Function) {
        this.addListener(SPOTLIGHT_SEARCH_ITEM_TAPPED_EVENT, listener);
    }

    /**
     * Removes the spotlight item opening event listener.
     *
     * @NOTE A good place for calling this method is the component's
     * `componentWillUnmount` override.
     *
     * @param listener The function, previously passed to
     * `addOnSpotlightItemOpenEventListener`.
     */
    removeOnSpotlightItemOpenEventListener(listener: Function) {
        this.removeListener(SPOTLIGHT_SEARCH_ITEM_TAPPED_EVENT, listener);
    }

    /**
     * Registers for the app history item opening event.
     *
     * @NOTE A good place for calling this method is the component's
     * `componentDidMount` override.
     *
     * @param listener A function that takes a single parameter
     * of type `Object`, containing the user info, passed when
     * creating the search item.
     */
    addOnAppHistoryItemOpenEventListener(listener: Function) {
        this.addListener(APP_HISTORY_SEARCH_ITEM_TAPPED, listener);
    }

    /**
     * Removes the app history item opening event listener.
     *
     * @NOTE A good place for calling this method is the component's
     * `componentWillUnmount` override.
     *
     * @param listener The function, previously passed to
     * `addOnAppHistoryItemOpenEventListener`.
     */
    removeOnAppHistoryItemOpenEventListener(listener: Function) {
        this.removeListener(APP_HISTORY_SEARCH_ITEM_TAPPED, listener);
    }

   /**
    * Adds a new item to the spotlight index.
    *
    * @param item A dictionary with the item's parameters.
    * See the comment above this class for more info.
    */
    indexSpotlightItem(item: Object): Promise {
        return SearchApiManager.indexItem(item);
    }

    /**
     * Adds an array of new items to the spotlight index.
     *
     * @param item An array with new items to be added.
     * See the comment above this class for more info.
     */
    indexSpotlightItems(items: Array): Promise {
        return SearchApiManager.indexItems(items);
    }

    /**
     * Deletes all items with specified identifiers from the
     * spotlight index.
     *
     * @param identifiers An array of unique item identifiers.
     */
    deleteSpotlightItemsWithIdentifiers(identifiers: Array): Promise {
        return SearchApiManager.deleteItemsWithIdentifiers(identifiers);
    }

    /**
     * Deletes all items in specified domains from the spotlight index.
     *
     * @param domains An array of spotlight item domains.
     */
    deleteSpotlightItemsInDomains(domains: Array): Promise {
        return SearchApiManager.deleteItemsInDomains(domains);
    }

    /**
     * Clears up the spotlight index.
     */
    deleteAllSpotlightItems(): Promise {
        return SearchApiManager.deleteAllItems();
    }

    /**
     * Creates a new search item, added to the app history.
     *
     * @param item A dictionary with the item's parameters.
     * See the comment above this class for more info.
     */
    indexAppHistoryItem(item: Object): Promise {
        return SearchApiManager.createUserActivity(item);
    }

}

export default new SearchApi();