twenty-sdk 2.15.0 → 2.18.0

package/dist/front-component/index.d.ts

@@ -2,15 +2,22 @@ import { PathParam, NavigateOptions as NavigateOptions$1 } from 'react-router-do
 
 declare enum AppPath {
     Verify = "/verify",
+    VerifyV2 = "/verify-v2",
     VerifyEmail = "/verify-email",
     SignInUp = "/welcome",
+    SignInUpV2 = "/welcome-v2",
     Invite = "/invite/:workspaceInviteHash",
     ResetPassword = "/reset-password/:passwordResetToken",
     WorkspaceActivation = "/workspace-activation",
+    WorkspaceActivationV2 = "/workspace-activation-v2",
     CreateProfile = "/create/profile",
+    CreateProfileV2 = "/create/profile-v2",
     SyncEmails = "/sync/emails",
+    SyncEmailsV2 = "/sync/emails-v2",
     InviteTeam = "/invite-team",
+    InviteTeamV2 = "/invite-team-v2",
     PlanRequired = "/plan-required",
+    PlanRequiredV2 = "/plan-required-v2",
     PlanRequiredSuccess = "/plan-required/payment-success",
     BookCallDecision = "/book-call-decision",
     BookCall = "/book-call",
@@ -25,6 +32,7 @@ declare enum AppPath {
     Developers = "developers",
     DevelopersCatchAll = "/developers/*",
     Authorize = "/authorize",
+    Dpa = "/dpa",
     NotFoundWildcard = "*",
     NotFound = "/not-found"
 }
@@ -78,12 +86,40 @@ declare enum SidePanelPages {
 declare const getAppPath: <T extends AppPath>(to: T, params?: { [key in PathParam<T>]: string | null; } | undefined, queryParams?: Record<string, any> | undefined) => string;
 
 type NavigateFunction = <T extends AppPath>(to: T, params?: Parameters<typeof getAppPath<T>>[1], queryParams?: Record<string, any>, options?: NavigateOptions) => Promise<void>;
-type OpenSidePanelPageFunction = (params: {
-    page: SidePanelPages;
+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: Exclude<SidePanelPages, SidePanelPages.ViewRecord | SidePanelPages.EditRichText | SidePanelPages.ComposeEmail | SidePanelPages.ViewFrontComponent>;
     pageTitle: string;
     pageIcon?: string;
     shouldResetSearchState?: boolean;
-}) => Promise<void>;
+};
+type OpenSidePanelPageFunction = (params: OpenSidePanelPageParams) => Promise<void>;
 type CommandConfirmationModalResult = 'confirm' | 'cancel';
 type CommandConfirmationModalAccent = 'default' | 'blue' | 'danger';
 type OpenCommandConfirmationModalFunction = (params: {
@@ -145,6 +181,7 @@ type FrontComponentExecutionContext = {
     selectedRecordIds: string[];
     /** Resolved color scheme of the host UI ('System' is already resolved) */
     colorScheme: 'light' | 'dark';
+    locale?: string;
 };
 
 declare const useFrontComponentExecutionContext: <T>(selector: (context: FrontComponentExecutionContext) => T) => T;
@@ -176,14 +213,8 @@ type CommandLinkProps<T extends AppPath> = {
 };
 declare const CommandLink: <T extends AppPath>({ to, params, queryParams, options, }: CommandLinkProps<T>) => null;
 
-type CommandOpenSidePanelPageProps = {
-    page: SidePanelPages;
-    pageTitle: string;
-    pageIcon: string;
-    onClick?: () => void;
-    shouldResetSearchState?: boolean;
-};
-declare const CommandOpenSidePanelPage: ({ page, pageTitle, pageIcon, onClick, shouldResetSearchState, }: CommandOpenSidePanelPageProps) => null;
+type CommandOpenSidePanelPageProps = OpenSidePanelPageParams;
+declare const CommandOpenSidePanelPage: (props: CommandOpenSidePanelPageProps) => null;
 
 type CommandModalProps = {
     title: string;
@@ -195,4 +226,4 @@ type CommandModalProps = {
 declare const CommandModal: ({ title, subtitle, execute, confirmButtonText, confirmButtonAccent, }: CommandModalProps) => null;
 
 export { AppPath, Command, CommandLink, CommandModal, CommandOpenSidePanelPage, SidePanelPages, closeSidePanel, copyToClipboard, enqueueSnackbar, getApplicationVariable, getFrontComponentCommandErrorDedupeKey, navigate, openCommandConfirmationModal, openSidePanelPage, unmountFrontComponent, updateProgress, useColorScheme, useFrontComponentExecutionContext, useFrontComponentId, useRecordId, useSelectedRecordIds, useUserId };
-export type { CloseSidePanelFunction, CommandConfirmationModalAccent, CommandConfirmationModalResult, CommandLinkProps, CommandModalProps, CommandOpenSidePanelPageProps, CommandProps, CopyToClipboardFunction, EnqueueSnackbarFunction, EnqueueSnackbarParams, FrontComponentExecutionContext, NavigateFunction, OpenCommandConfirmationModalFunction, OpenCommandConfirmationModalHostFunction, OpenSidePanelPageFunction, RequestAccessTokenRefreshFunction, SnackBarVariant, UnmountFrontComponentFunction, UpdateProgressFunction };
+export type { CloseSidePanelFunction, CommandConfirmationModalAccent, CommandConfirmationModalResult, CommandLinkProps, CommandModalProps, CommandOpenSidePanelPageProps, CommandProps, CopyToClipboardFunction, EnqueueSnackbarFunction, EnqueueSnackbarParams, FrontComponentExecutionContext, NavigateFunction, OpenCommandConfirmationModalFunction, OpenCommandConfirmationModalHostFunction, OpenSidePanelPageFunction, OpenSidePanelPageParams, RequestAccessTokenRefreshFunction, SnackBarVariant, UnmountFrontComponentFunction, UpdateProgressFunction };