mirador/src/state/selectors/getters.js

An open-source, web-based 'multi-up' viewer that supports zoom-pan-rotate functionality, ability to display/compare simple images, and images with annotations.

import { createSelector } from 'reselect';
import { miradorSlice, EMPTY_ARRAY, EMPTY_OBJECT } from './utils';

/**
 * Returns the manifest titles for all open windows.
 * @param {object} state
 * @returns {Array} containing manifests ids.
 */
export function getWindowManifests(state) {
  return Object.values(miradorSlice(state).windows).map(window => window.manifestId);
}

/**
 * Returns the opened windows.
 * @param {object} state
 * @returns {object} {id: {canvasId: {...}, ...}, ...}
 */
export function getWindows(state) {
  return miradorSlice(state).windows || EMPTY_OBJECT;
}

/**
 * Returns a window based on a given windowId.
 * @param {object} state
 * @param {object} props
 * @param {string} props.windowId
 * @returns {object|undefined}
 */
export function getWindow(state, { windowId }) {
  return getWindows(state)[windowId];
}

/**
 * Returns the viewer for a given window.
 * @param {object} state
 * @param {object} props
 * @param {string} props.windowId
 * @returns {object|undefined} {flip: false, rotation: 0, x: 1, y: 2, zoom: 0.5}
 */
export const getViewer = createSelector(
  [
    state => miradorSlice(state).viewers,
    (state, { windowId }) => windowId,
  ],
  (viewers, windowId) => viewers[windowId],
);

/**
 * Returns the workspace.
 * @param {object} state
 * @returns {object}
 */
export function getWorkspace(state) {
  return miradorSlice(state).workspace;
}

/**
 * Returns the windowIds.
 * @param {object} state
 * @returns {Array}
 */
export const getWindowIds = createSelector(
  [getWorkspace],
  ({ windowIds }) => windowIds || EMPTY_ARRAY,
);

/**
 * Returns all manifests including manifest information.
 * @param {object} state
 * @returns {object}
 */
export function getManifests(state) {
  return miradorSlice(state).manifests || EMPTY_OBJECT;
}

/**
 * Get the relevant manifest information for a given manifest.
 * @param {object} state
 * @param {object} props
 * @param {string} props.manifestId
 * @param {string} props.windowId
 * @returns {object}
 */
export function getManifest(state, { manifestId, windowId }) {
  const manifests = getManifests(state);
  return manifests && manifests[
    manifestId
    || (windowId && (getWindow(state, { windowId }) || EMPTY_OBJECT).manifestId)
  ];
}

/**
 * Get the opened catalog.
 * @param {object} state
 * @returns {object} containing manifestIds for the manifests in the catalog
 */
export function getCatalog(state) {
  return miradorSlice(state).catalog || EMPTY_OBJECT;
}