papi-frontend-react.ts

/**
 * @file Jest mock for @papi/frontend/react. Provides stub implementations of PAPI React hooks so
 * WebView/frontend components can be unit-tested without the real Platform API.
 */

/**
 * Known data-provider method names exposed by this mock. Tests that call an unlisted method will
 * receive a descriptive error rather than silently returning `undefined`, which mirrors the real
 * PAPI behaviour where requesting an unsupported provider key is a programmer error.
 */
const KNOWN_PROJECT_DATA_METHODS = new Set(['BookUSJ']);

/** Known method names on data providers accessed via {@link useData}. */
const KNOWN_DATA_METHODS = new Set(['WebViewMenu']);

/**
 * Mock for `useData`. Returns an object whose known methods each return
 * `[undefined, jest.fn(), false]`, matching the real hook's `[data, setter, isLoading]` tuple.
 * Accessing an unknown method throws to catch misspelled provider keys in tests.
 *
 * @param _providerName - Ignored data provider name.
 * @returns Proxy object exposing known data methods.
 */
const useData = jest.fn((_providerName: unknown) =>
  new Proxy(
    {},
    {
      get(_target, prop: string | symbol) {
        if (typeof prop === 'string' && KNOWN_DATA_METHODS.has(prop)) {
          return () => [undefined, jest.fn(), false];
        }
        throw new Error(
          `useData mock: unknown method "${String(prop)}". Add it to KNOWN_DATA_METHODS if intentional.`,
        );
      },
    },
  ),
);

/**
 * Mock for `useProjectData`. Returns an object whose known methods each return
 * `[undefined, jest.fn(), false]`, matching the real hook's `[data, setter, isLoading]` tuple.
 * Accessing an unknown method throws to catch misspelled provider keys in tests.
 */
const useProjectData = jest.fn(() =>
  new Proxy(
    {},
    {
      get(_target, prop: string | symbol) {
        if (typeof prop === 'string' && KNOWN_PROJECT_DATA_METHODS.has(prop)) {
          return () => [undefined, jest.fn(), false];
        }
        throw new Error(
          `useProjectData mock: unknown method "${String(prop)}". Add it to KNOWN_PROJECT_DATA_METHODS if intentional.`,
        );
      },
    },
  ),
);

/**
 * Mock for `useProjectSetting`. Returns `[defaultState, setSetting, resetSetting, isLoading]`,
 * passing `defaultState` through unchanged so callers receive a predictable initial value.
 *
 * @param _projectDataProviderSource - Ignored project data provider source.
 * @param _key - Ignored setting key.
 * @param defaultState - Value surfaced as the current setting state.
 * @returns Tuple of `[defaultState, jest.fn(), jest.fn(), false]`.
 */
const useProjectSetting = jest
  .fn()
  .mockImplementation((_projectDataProviderSource: unknown, _key: string, defaultState: unknown) => [
    defaultState,
    jest.fn(),
    jest.fn(),
    false,
  ]);

/**
 * Mock for `useLocalizedStrings`. Maps each requested key to itself so tests receive a
 * predictable `Record<string, string>` without a real localization service.
 *
 * @param keys - BCP47-style string keys to resolve.
 * @returns Tuple of `[record, isLoading]` where every key maps to itself and `isLoading` is
 *   `false`.
 */
const useLocalizedStrings = jest.fn().mockImplementation((keys: string[]) => [
  Array.isArray(keys) ? keys.reduce<Record<string, string>>((acc, k) => { acc[k] = k; return acc; }, {}) : {},
  false,
]);

/**
 * Mock for `useRecentScriptureRefs`. Returns an empty history and a no-op `addRecentScriptureRef`
 * so components that display recent references render without errors.
 *
 * @returns Object with `recentScriptureRefs` (empty array) and `addRecentScriptureRef` (jest spy).
 */
const useRecentScriptureRefs = jest
  .fn()
  .mockImplementation(() => ({ recentScriptureRefs: [], addRecentScriptureRef: jest.fn() }));

module.exports = {
  __esModule: true,
  useData,
  useProjectData,
  useProjectSetting,
  useLocalizedStrings,
  useRecentScriptureRefs,
};

/** Marks this file as a module so top-level const/let are module-scoped. */
export {};