scrivito/src/scrivito_sdk/app_ui_protocol/ui_adapter_interface.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 type { UiContext } from 'scrivito_sdk/app_support/ui_context';
import type { UserData } from 'scrivito_sdk/app_support/user';
import { GET, SEND, STREAM } from 'scrivito_sdk/bridge';
import type {
  CmsRetrieval,
  ComparisonRange,
  ObjSpaceId,
} from 'scrivito_sdk/client';
import type { Position } from 'scrivito_sdk/common';
import type {
  ContentUpdateHandler,
  ObjStreamReplicationEndpoint,
} from 'scrivito_sdk/data';
import type {
  ContentBrowserResult,
  TeamData,
} from 'scrivito_sdk/editing_support';
import type { ResolvedUrl } from 'scrivito_sdk/link_resolution';
import type {
  BinaryHandler,
  CopyObjHandler,
  ObjSearchParams,
} from 'scrivito_sdk/models';
import type { WorkspaceData } from 'scrivito_sdk/models/workspace';
import type { OptionMarkerPosition } from 'scrivito_sdk/react_editing/option_marker';

export const uiAdapterDescription = {
  canEdit: GET,
  canWrite: GET,
  comparisonBase: GET,
  comparisonRange: GET,
  getEditorAuthToken: GET,
  getContentStateId: GET,
  translate: GET,
  currentEditor: GET,
  currentEditorTeams: GET,
  currentWorkspace: GET,
  currentEditingContext: GET,
  getUiContext: GET,
  getUiLanguage: GET,
  getEditableArea: GET,

  // LinkResolution methods
  getResolvedUrl: GET,

  // CmsRetrieval methods
  retrieveObjQuery: SEND,
  retrieveFacetQuery: SEND,
  retrieveSuggest: SEND,
  retrieveBinaryMetadata: SEND,
  retrieveBinaryUrls: SEND,
  retrieveObjFieldDiffs: SEND,

  // BinaryHandler methods
  copyBinary: SEND,
  uploadBinary: SEND,

  // ObjStreamReplicationEndpoint methods
  objReplicationMessageStream: STREAM,
  finishSavingObj: SEND,

  copyObj: SEND,
  finishReplicatingObj: SEND,
  insertWidget: SEND,
  navigateToExternalUrl: SEND,
  openInNewUiWindow: SEND,
  configureContentBrowser: SEND,
  openContentBrowser: SEND,
  openCustomDialog: SEND,
  setAppAdapter: SEND,
  configureTenant: SEND,
  showWidgetMenu: SEND,
  showWidgetlistMenu: SEND,
  showChildListMenu: SEND,

  startDrag: SEND,
  endDrag: SEND,
  dragTo: SEND,
  drop: SEND,
};

export interface UiAdapterInterface
  extends CmsRetrieval,
    CopyObjHandler,
    BinaryHandler,
    ContentUpdateHandler,
    ObjStreamReplicationEndpoint {
  canEdit(workspaceId: string, objId: string): boolean;
  canWrite(workspaceId: string): boolean;
  getEditorAuthToken(options?: {
    audience?: string;
    treatLocalhostLike?: string;
    authViaAccount?: string;
    authViaInstance?: string;
  }): { token: string } | { error: string } | undefined;
  comparisonBase(): ObjSpaceId;
  comparisonRange(): ComparisonRange;
  setAppAdapter(adapterPort: MessagePort): void;
  showWidgetMenu(
    elementId: number,
    objId: string,
    widgetId: string,
    options?: { objSpaceId: ObjSpaceId }
  ): void;
  showWidgetlistMenu(
    elementId: number,
    relativePosition: Position,
    objId: string,
    attributeName: string,
    widgetId?: string
  ): void;
  showChildListMenu(elementId: number, objId: string): void;
  insertWidget(
    objId: string,
    widgetId: string,
    position: OptionMarkerPosition
  ): void;
  startDrag(objId: string, widgetId: string): void;
  endDrag(): void;
  finishReplicatingObj(objSpaceId: ObjSpaceId, objId: string): Promise<void>;
  getResolvedUrl(url: string): ResolvedUrl;
  navigateToExternalUrl(url: string): void;
  openInNewUiWindow(url: string): void;
  configureContentBrowser({ baseQuery }: { baseQuery: ObjSearchParams }): void;
  openContentBrowser(
    options: UiAdapterOpenContentBrowserOptions
  ): Promise<ContentBrowserResult>;
  configureTenant(configuration: TenantConfiguration): void;
  openCustomDialog(name: string): void;
  translate(key: string): string | undefined;
  dragTo(position: Position): void;
  drop(): void;
  currentEditor(): UserData;
  currentEditorTeams(): TeamData[];
  currentEditingContext(): { windowName?: string };
  currentWorkspace(): WorkspaceData;
  getUiContext(): UiContext;
  getUiLanguage(): Locale | null;
  getEditableArea(): EditableArea | undefined;
}

export interface TenantConfiguration {
  tenant: string;
  endpoint?: string;
}

export interface UiAdapterOpenContentBrowserOptions {
  selectionMode?: 'single' | 'multi';
  selection?: string[];
  validObjClasses?: readonly string[];
}

export type Locale = 'de' | 'fr' | 'en';
export type EditableArea = 'everywhere' | 'layout' | 'page';