scrivito/src/scrivito_sdk/app_support/current_page.ts

Scrivito is a professional, yet easy to use SaaS Enterprise Content Management Service, built for digital agencies and medium to large businesses. It is completely maintenance-free, cost-effective, and has unprecedented performance and security.

// @rewire
import * as URI from 'urijs';
import {
  getCurrentPageData,
  getCurrentRoute,
} from 'scrivito_sdk/app_support/current_page_data';
import {
  ContextContainer,
  QueryParameters,
  ScrivitoError,
  throwInvalidArgumentsError,
} from 'scrivito_sdk/common';
import { assertNotUsingInMemoryTenant } from 'scrivito_sdk/data';
import { isWrappingBasicObj } from 'scrivito_sdk/models';
import { Obj, wrapInAppClass } from 'scrivito_sdk/realm';
import { createStateContainer } from 'scrivito_sdk/state';

/** @public */
export function currentPage(): Obj | null {
  assertNotUsingInMemoryTenant('Scrivito.currentPage');

  const page = getCurrentPageData()?.currentPage;
  return page ? wrapInAppClass(page) : null;
}

/** @public */
export function isCurrentPage(page: Obj): boolean {
  assertNotUsingInMemoryTenant('Scrivito.isCurrentPage');
  checkIsCurrentPage(page);

  return currentPage()?.id() === page.id();
}

/** @public */
export function currentPageParams(): QueryParameters {
  assertNotUsingInMemoryTenant('Scrivito.currentPageParams');

  return URI.parseQuery(getCurrentRoute()?.query || '');
}

const currentSiteContext = new ContextContainer<string>();
const forbiddenSiteContext = new ContextContainer<string>();

/** @public */
export function currentSiteId(): string | null {
  const errorMessage = forbiddenSiteContext.current();
  if (errorMessage) throw new ScrivitoError(errorMessage);

  const customComponentSiteId = customComponentSiteIdState.get();
  if (customComponentSiteId !== undefined) return customComponentSiteId;

  return (
    currentSiteContext.current() ?? getCurrentRoute()?.siteData?.siteId ?? null
  );
}

export function withDefaultSiteContext<T>(fn: () => T): T {
  return currentSiteContext.runWith('default', fn);
}

export function withForbiddenSiteContext<T>(message: string, fn: () => T): T {
  return forbiddenSiteContext.runWith(message, fn);
}

const customComponentSiteIdState = createStateContainer<string | null>();

export function setCustomComponentSiteId(siteId: string | null): void {
  customComponentSiteIdState.set(siteId);
}

function checkIsCurrentPage(obj: Obj) {
  if (!isWrappingBasicObj(obj)) {
    throwInvalidArgumentsError(
      'isCurrentPage',
      "'obj' must be an instance of 'Obj'.",
      {
        docPermalink: 'js-sdk/isCurrentPage',
      }
    );
  }
}