twenty/packages/twenty-sdk/src/sdk/front-component/globals/frontComponentHostCommunicationApi.ts

import {
  type AppPath,
  type SidePanelPages,
  type EnqueueSnackbarParams,
  type NavigateOptions,
} from 'twenty-shared/types';
import { type getAppPath } from 'twenty-shared/utils';

export type NavigateFunction = <T extends AppPath>(
  to: T,
  params?: Parameters<typeof getAppPath<T>>[1],
  queryParams?: Record<string, any>,
  options?: NavigateOptions,
) => Promise<void>;

export type OpenSidePanelPageParams =
  | {
      page: SidePanelPages.ViewRecord;
      recordId: string;
      objectNameSingular: string;
      resetNavigationStack?: boolean;
    }
  | {
      page: SidePanelPages.EditRichText;
      recordId: string;
      objectNameSingular: string;
      fieldName?: string;
    }
  | {
      page: SidePanelPages.ComposeEmail;
      connectedAccountId: string;
      threadId?: string;
      defaultTo?: string;
      defaultSubject?: string;
      defaultInReplyTo?: string;
      pageTitle?: string;
      pageIcon?: string;
    }
  | {
      page: SidePanelPages.ViewFrontComponent;
      frontComponentId: string;
      recordId?: string;
      objectNameSingular?: string;
      pageTitle: string;
      pageIcon?: string;
      resetNavigationStack?: boolean;
    }
  | {
      page: SidePanelPages.AskAI;
      pageTitle: string;
      pageIcon?: string;
      shouldResetSearchState?: boolean;
      preprompt?: {
        text: string;
        mode?: 'PREFILL' | 'SEND';
      };
    }
  | {
      page: Exclude<
        SidePanelPages,
        | SidePanelPages.ViewRecord
        | SidePanelPages.EditRichText
        | SidePanelPages.ComposeEmail
        | SidePanelPages.ViewFrontComponent
        | SidePanelPages.AskAI
      >;
      pageTitle: string;
      pageIcon?: string;
      shouldResetSearchState?: boolean;
    };

export type OpenSidePanelPageFunction = (
  params: OpenSidePanelPageParams,
) => Promise<void>;

export type CommandConfirmationModalResult = 'confirm' | 'cancel';

export type CommandConfirmationModalAccent = 'default' | 'blue' | 'danger';

export type OpenCommandConfirmationModalFunction = (params: {
  title: string;
  subtitle: string;
  confirmButtonText?: string;
  confirmButtonAccent?: CommandConfirmationModalAccent;
}) => Promise<CommandConfirmationModalResult>;

export type UnmountFrontComponentFunction = () => Promise<void>;

export type EnqueueSnackbarFunction = (
  params: EnqueueSnackbarParams,
) => Promise<void>;

export type CloseSidePanelFunction = () => Promise<void>;

export type UpdateProgressFunction = (progress: number) => Promise<void>;

export type RequestAccessTokenRefreshFunction = () => Promise<string>;

export type CopyToClipboardFunction = (text: string) => Promise<void>;

export type OpenCommandConfirmationModalHostFunction = (
  params: Parameters<OpenCommandConfirmationModalFunction>[0],
) => Promise<void>;

export type FrontComponentHostCommunicationApiStore = {
  navigate?: NavigateFunction;
  requestAccessTokenRefresh?: RequestAccessTokenRefreshFunction;
  openSidePanelPage?: OpenSidePanelPageFunction;
  openCommandConfirmationModal?: OpenCommandConfirmationModalFunction;
  unmountFrontComponent?: UnmountFrontComponentFunction;
  enqueueSnackbar?: EnqueueSnackbarFunction;
  closeSidePanel?: CloseSidePanelFunction;
  updateProgress?: UpdateProgressFunction;
  copyToClipboard?: CopyToClipboardFunction;
};

import { FRONT_COMPONENT_HOST_COMMUNICATION_API_KEY } from '../constants/front-component-host-communication-api-key';

declare global {
  var frontComponentHostCommunicationApi: FrontComponentHostCommunicationApiStore;
}

globalThis[FRONT_COMPONENT_HOST_COMMUNICATION_API_KEY] ??= {};

export const frontComponentHostCommunicationApi =
  globalThis.frontComponentHostCommunicationApi;