Contexts

interface CatalogContext {
  /**
   * The set of all assigned catalogs for the current site.
   */
  assignedCatalogs: [string],

  /**
   * The ID of the currently chosen catalog.
   */
  currentCatalogId: string,

  /**
   * The default locale for the current catalog selection.
   */
  currentCatalogLocale: string,

  /**
   * The primary method used for hydrating assigned catalogs.
   */
  hydrateAssignedCatalogs: () => Promise<void>;

  /**
   * The primary method used by the catalog selector (or other components) for
   * setting the current catalog.
   */
  setCurrentCatalogById: (catalogId: string) => void;
}

interface ChangeContainerContext {
  // the current change container name
  containerName: string;
  // the current change container ID
  containerId: string;
  // the summaries for the current change container
  containerSummaries: [object];
  // whether or not polling is disabled
  disablePolling: boolean;
  // an error that occurred when trying to poll summaries
  errorPollingSummaries?: Error;
  // whether or not summaries are being "polled"
  isPollingSummaries: boolean;
  // the last time we updated summaries
  lastUpdatedSummaries?: number;
}

interface ChangeContainerCallbackContext {
  /**
   * Polls the change summaries and sets change container state
   * using the provided container name and ID.
   */
  pollChangeSummaries: () => Promise<void>;

  /**
   * Updates the state with the provided `containerName` and `containerId`.
   */
  setChangeContainer: (changeContainer: { containerName?: string; containerId?: string; }) => void;

  /**
   * Disables polling by the provider either by `#pollChangeSummaries` or by
   * the internal re-poll done in reaction to `SandboxOperationContext` changes.
   */
  setDisableSummaryPolling: (isDisabled: boolean) => void;
}

type ComponentRouterContext = [{
  componentId?: string;
  componentName?: string;
  exact: boolean;
  path: string;
  scopes: [string];
}]

interface DevSettingsContext {
  /**
   * If the application is currently in dev mode, allowing dev settings.
   */
  devMode: boolean;
  /**
   * This controls if the dev settings modal is open
   */
  showDevSettings: boolean;
  /**
   * Enables the 'View Metadata' action on metadata components.
   */
  showMetadata: boolean;
}

interface I18nContext {
  /**
   * The currently selected locale code.
   */
  currentLocale: string;
  /**
   * The set of allowed locales.
   *
   */
  allowedLocales: [string];
  /**
   * Sets the current locale to the provided locale code.
   * @param locale the new locale code
   */
  setCurrentLocale: (locale: string) => void;
}

interface LocaleContext {
  allowedLocales: [string];
  defaultLocale: string;
}

interface MetadataContext {
   /**
   * Whether or not the current user is allowed to augment metadata. This is used
   * to visually hide or show the controls around augmentation.
   */
  canAugment: boolean;

  /**
   * Fetches new metadata for the view container from the metadata service.
   */
  hydrateMetadata: () => Promise<void>;

  /**
   * Whether or not the current user is augmenting metadata. This flag is used
   * to indicate whether to render the augmentation controls or the "Live" view.
   *
   */
  isAugmenting: boolean;

  /**
   * The metadata for the view container.
   */
  metadata: {
    classifier: string;
    type: string;
    [key: string]: unknown;
  };

  /**
   * Toggles `isAugmenting` to either true or false.
   * @param isAugmenting the new value of `isAugmenting`
   */
  toggleAugmenting: (isAugmenting?: boolean) => void;
}

interface SandboxContext {
  /**
   * The ID of the currently active sandbox. Most of the time this will be the
   * user's default sandbox, but it can be changed using `#setCurrentSandboxById`.
   */
  currentSandboxId: string;

  /**
   * The primary method used for hyrating user sandboxes. This is typically
   * useful for down-stream components to populate (i.e., hydrate) the set
   * of user sandboxes to ensure they are up to date.
   */
  hydrateUserSandboxes: () => Promise<void>;

  /**
   * The primary method used by a sandbox selector component to set the current
   * sandbox by ID. This will be implemented by the sandbox provider component
   * to update the `currentSandboxId` state with a new sandbox ID.
   *
   * It is important that only a sandbox within the `userSandboxes` array is
   * passed to this setter.
   */
  setCurrentSandboxById: (sandboxId: string) => void;

  /**
   * The set of all available sandboxes for the current user. This array of
   * sandboxes should be resolved AFTER a user has been authenticated for the
   * current site.
   */
  userSandboxes: [{ id: string; name: string; color: string;}]
}

interface SandboxOperationContext {
  isCancelled: boolean;
  isOperationInProgress: boolean;
  operationType?: string;
  operationData?: any;
  operationError?: Error;
}

type SandboxOperationDispatchContext = (action: any) => void;

type TenantContext = [
  {
    applicationById: { [id: string]: { id: string; name: string; }},
    applicationId: string;
    applicationIds: [string];
    isFetchApplicationsQueued: boolean;
    tenantById: { [id: string]: { id: string; name: string; }},
    tenantId: string;
  },
  (action: any) => void
]

interface Toast {
  autoClose: boolean;
  closeOnClick: boolean;
  content: any;
  id: string;
  isPaused: boolean;
  pauseOnHover: boolean;
  progressDuration: number;
  progress: number;
  showProgress: boolean;
  type: string;
}

interface ToastContainerContext {
  addToast: (content: any, options: any) => void;
  dispatch: (action: any) => void;
  pauseToast: (toastId: string) => void;
  playToast: (toastId: string) => void;
  removeToast: (toastId: string) => void;
  state: {
    toastsById: { [toastId: string]: Toast }
  };
  updateToast: (toastId: string) => void;
}

interface TranslateModeContext {
  /**
   * Whether or not the translate mode is currently active. This affects whether
   * non-translatable fields are read-only, and whether or not saves persist to
   * a special translation endpoint.
   */
  isActive: boolean;

  /**
   * The currently active locale selection. This is set when translate mode is
   * enabled by a user interaction. This should be a valid locale code.
   */
  locale: string;
}

type TranslateModeDispatchContext = (action: any) => void;

interface UserAccessContext {
  /**
   * User operation types by scope.
   */
  operationTypesByScope: { [scope: string]: [string]; },

  /**
   * Request state for fetching by scope.
   */
  requestsByScope: { [scope: string]: { error?: Error, isFetching: boolean; lastUpdated?: number; }}
}

type UserAccessDispatchContext = (action: any) => void;