menu-data.service-model.ts

import {
  OnDidDispose,
  UnsubscriberAsync,
  MultiColumnMenu,
  ReferencedItem,
  WebViewMenu,
} from 'platform-bible-utils';
import {
  DataProviderDataType,
  DataProviderSubscriberOptions,
  DataProviderUpdateInstructions,
} from '@shared/models/data-provider.model';
import { IDataProvider } from './papi-core.service';

/** JSDOC DESTINATION menuDataServiceProviderName */
export const menuDataServiceProviderName = 'platform.menuDataServiceDataProvider';
export const menuDataServiceObjectToProxy = Object.freeze({
  /**
   * JSDOC SOURCE menuDataServiceProviderName
   *
   * This name is used to register the menu data data provider on the papi. You can use this name to
   * find the data provider when accessing it using the useData hook
   */
  dataProviderName: menuDataServiceProviderName,
});

// Data Type to initialize data provider engine with
export type MenuDataDataTypes = {
  MainMenu: DataProviderDataType<undefined, MultiColumnMenu, never>;
  WebViewMenu: DataProviderDataType<ReferencedItem, WebViewMenu, never>;
};

declare module 'papi-shared-types' {
  export interface DataProviders {
    [menuDataServiceProviderName]: IMenuDataService;
  }
}

/**
 * JSDOC SOURCE menuDataService
 *
 * Service that allows to get and store menu data
 */
export type IMenuDataService = {
  /**
   * JSDOC SOURCE getMainMenu
   *
   * Get menu content for the main menu
   *
   * @param mainMenuType Does not have to be defined
   * @returns MultiColumnMenu object of main menu content
   */
  getMainMenu(mainMenuType: undefined): Promise<MultiColumnMenu>;
  /** JSDOC DESTINATION getMainMenu */
  getMainMenu(): Promise<MultiColumnMenu>;
  /**
   * This data cannot be changed. Trying to use this setter this will always throw
   *
   * @param mainMenuType Does not have to be defined
   * @param value MultiColumnMenu object to set as the main menu
   * @returns Unsubscriber function
   */
  setMainMenu(
    mainMenuType: undefined,
    value: never,
  ): Promise<DataProviderUpdateInstructions<MenuDataDataTypes>>;
  /**
   * Subscribe to run a callback function when the main menu data is changed
   *
   * @param mainMenuType Does not have to be defined
   * @param callback Function to run with the updated menuContent for this selector
   * @param options Various options to adjust how the subscriber emits updates
   * @returns Unsubscriber function (run to unsubscribe from listening for updates)
   */
  subscribeMainMenu(
    mainMenuType: undefined,
    callback: (menuContent: MultiColumnMenu) => void,
    options?: DataProviderSubscriberOptions,
  ): Promise<UnsubscriberAsync>;
  /**
   * Get menu content for a web view
   *
   * @param webViewType The type of webview for which a menu should be retrieved
   * @returns WebViewMenu object of web view menu content
   */
  getWebViewMenu(webViewType: ReferencedItem): Promise<WebViewMenu>;
  /**
   * This data cannot be changed. Trying to use this setter this will always throw
   *
   * @param webViewType The type of webview for which a menu should be set
   * @param value Menu of specified webViewType
   * @returns Unsubscriber function
   */
  setWebViewMenu(
    webViewType: ReferencedItem,
    value: never,
  ): Promise<DataProviderUpdateInstructions<MenuDataDataTypes>>;
  /**
   * Subscribe to run a callback function when the web view menu data is changed
   *
   * @param webViewType The type of webview for which a menu should be subscribed
   * @param callback Function to run with the updated menuContent for this selector
   * @param options Various options to adjust how the subscriber emits updates
   * @returns Unsubscriber function (run to unsubscribe from listening for updates)
   */
  subscribeWebViewMenu(
    webViewType: ReferencedItem,
    callback: (menuContent: WebViewMenu) => void,
    options?: DataProviderSubscriberOptions,
  ): Promise<UnsubscriberAsync>;
} & OnDidDispose &
  typeof menuDataServiceObjectToProxy &
  IDataProvider<MenuDataDataTypes>;