scrivito/src/scrivito_sdk/app_support/basic_navigate_to.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.

import * as BrowserLocation from 'scrivito_sdk/app_support/browser_location';
import { changeLocation } from 'scrivito_sdk/app_support/change_location';
import {
  CrossSiteDestination,
  DestinationUnavailable,
  LocalDestination,
  RemoteDestination,
  generateDestinationUnavailable,
} from 'scrivito_sdk/app_support/destination_types';
import {
  Hash,
  generateDestination,
  generateDestinationForId,
  isOriginLocal,
  isSiteLocal,
} from 'scrivito_sdk/app_support/routing';
import {
  QueryParameters,
  assignLocation,
  logError,
  urlResource,
} from 'scrivito_sdk/common';
import { load } from 'scrivito_sdk/loadable';
import { BasicObj } from 'scrivito_sdk/models';
import { isBinaryBasicObj } from 'scrivito_sdk/realm';
import { failIfFrozen } from 'scrivito_sdk/state';

export type RoutingTarget = UrlRoutingTarget | ObjIdRoutingTarget;

interface UrlRoutingTarget {
  url: string;
}

interface ObjIdRoutingTarget {
  objId: string;
  query?: QueryParameters;
  hash?: Hash;
}

let latestCallId = 0;

export function getNextNavigateToCallId(): number {
  latestCallId++;

  return latestCallId;
}

export function isLatestNavigateToCallId(callId: number): boolean {
  return latestCallId === callId;
}

export async function basicNavigateTo(
  target: RoutingTarget,
  callId = getNextNavigateToCallId()
): Promise<void> {
  failIfFrozen('basicNavigateTo');

  const routingTarget = await load(() => destinationForTarget(target));
  if (isLatestNavigateToCallId(callId)) {
    switch (routingTarget.type) {
      case 'remote':
        changeLocation(routingTarget.url);
        break;
      case 'local':
        navigateToResource(routingTarget.resource);
        break;
      case 'crossSite':
        assignLocation(routingTarget.url);
        break;
      case 'unavailable':
        logError(
          `Could not navigate to Obj ${routingTarget.objId}, no URL found`
        );
    }
  }
}

type NavigationDestination =
  | CrossSiteDestination
  | DestinationUnavailable
  | LocalDestination
  | RemoteDestination;

function destinationForTarget(target: RoutingTarget): NavigationDestination {
  if (isUrlRoutingTarget(target)) return destinationForUrl(target.url);

  const { objId, query, hash } = target;
  const obj = BasicObj.get(objId);
  if (!obj) return generateDestinationForId({ objId, query, hash });

  if (isBinaryBasicObj(obj)) {
    const blob = obj.get('blob', ['binary']);
    if (!blob) return generateDestinationUnavailable({ objId });

    return { type: 'remote', url: blob.url() };
  }

  return generateDestination({ obj, query, hash });
}

function navigateToResource(resource: string): void {
  const currentResource = BrowserLocation.get();

  if (resource === currentResource) {
    BrowserLocation.replace(resource);
  } else {
    BrowserLocation.push(resource);
  }
}

function isUrlRoutingTarget(
  routingTarget: RoutingTarget
): routingTarget is UrlRoutingTarget {
  return !!(routingTarget as UrlRoutingTarget).url;
}

function destinationForUrl(url: string) {
  if (!URL.canParse(url)) return { type: 'local' as const, resource: url };

  if (isOriginLocal(url)) {
    if (!isSiteLocal(url)) return { type: 'crossSite' as const, url };
    return {
      type: 'local' as const,
      resource: urlResource(new URL(url)),
    };
  }

  return { type: 'remote' as const, url };
}