twenty-sdk 2.31.0 → 2.33.0

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

@@ -1,8 +1,6 @@
 import { ReactNode } from 'react';
 import { PathParam, NavigateOptions as NavigateOptions$1 } from 'react-router-dom';
 
-type TranslationValues = Record<string, string | number>;
-
 type MessageDescriptor = {
     message: string;
     context?: string;
@@ -43,6 +41,8 @@ declare const APP_LOCALES: {
 };
 type AppLocale = keyof typeof APP_LOCALES;
 
+type TranslationValues = Record<string, string | number>;
+
 type TransProps = {
     children?: ReactNode;
     message?: string;
@@ -67,11 +67,13 @@ declare enum AppPath {
     BookCall = "/book-call",
     AiChat = "/chat/:threadId?",
     Index = "/",
+    Home = "/home",
     TasksPage = "/objects/tasks",
     OpportunitiesPage = "/objects/opportunities",
     RecordIndexPage = "/objects/:objectNamePlural",
     RecordShowPage = "/object/:objectNameSingular/:objectRecordId",
     PageLayoutPage = "/page/:pageLayoutId",
+    WorkflowCoreIndexPage = "/workflow-core",
     Settings = "settings",
     SettingsCatchAll = "/settings/*",
     Developers = "developers",
@@ -126,11 +128,14 @@ declare enum SidePanelPages {
     PageLayoutRecordPageWidgetTypeSelect = "page-layout-record-page-widget-type-select",
     ComposeEmail = "compose-email",
     SendCampaignTest = "send-campaign-test",
-    EmailBlockSettings = "email-block-settings"
+    EmailBlockSettings = "email-block-settings",
+    SettingsMetadataTranslations = "settings-metadata-translations"
 }
 
 declare const getAppPath: <T extends AppPath>(to: T, params?: { [key in PathParam<T>]: string | null; } | undefined, queryParams?: Record<string, any> | undefined) => string;
 
+type FrontComponentStorageType = 'localStorage' | 'sessionStorage';
+
 type NavigateFunction = <T extends AppPath>(to: T, params?: Parameters<typeof getAppPath<T>>[1], queryParams?: Record<string, any>, options?: NavigateOptions) => Promise<void>;
 type OpenSidePanelPageParams = {
     page: SidePanelPages.ViewRecord;
@@ -191,7 +196,39 @@ type CloseSidePanelFunction = () => Promise<void>;
 type UpdateProgressFunction = (progress: number) => Promise<void>;
 type RequestAccessTokenRefreshFunction = () => Promise<string>;
 type CopyToClipboardFunction = (text: string) => Promise<void>;
+type UploadedFrontComponentFile = {
+    fileId: string;
+    path: string;
+    url: string;
+    size: number;
+    mimeType: string;
+};
+type UploadFileParams = {
+    fieldMetadataId: string;
+    fileName?: string;
+};
+type UploadFileFailureReason = 'invalid-params' | 'upload-failed';
+type UploadFileResult = {
+    status: 'uploaded';
+    file: UploadedFrontComponentFile;
+} | {
+    status: 'failed';
+    reason: UploadFileFailureReason;
+};
+type UploadFileFunction = (file: Blob, params: UploadFileParams) => Promise<UploadFileResult>;
 type OpenCommandConfirmationModalHostFunction = (params: Parameters<OpenCommandConfirmationModalFunction>[0]) => Promise<void>;
+type StorageSetFunction = (params: {
+    storageType: FrontComponentStorageType;
+    key: string;
+    serializedValue: string;
+}) => Promise<void>;
+type StorageDeleteFunction = (params: {
+    storageType: FrontComponentStorageType;
+    key: string;
+}) => Promise<void>;
+type StorageClearFunction = (params: {
+    storageType: FrontComponentStorageType;
+}) => Promise<void>;
 type FrontComponentHostCommunicationApiStore = {
     navigate?: NavigateFunction;
     requestAccessTokenRefresh?: RequestAccessTokenRefreshFunction;
@@ -202,6 +239,10 @@ type FrontComponentHostCommunicationApiStore = {
     closeSidePanel?: CloseSidePanelFunction;
     updateProgress?: UpdateProgressFunction;
     copyToClipboard?: CopyToClipboardFunction;
+    uploadFile?: UploadFileFunction;
+    storageSet?: StorageSetFunction;
+    storageDelete?: StorageDeleteFunction;
+    storageClear?: StorageClearFunction;
 };
 declare global {
     var frontComponentHostCommunicationApi: FrontComponentHostCommunicationApiStore;
@@ -225,6 +266,8 @@ declare const unmountFrontComponent: UnmountFrontComponentFunction;
 
 declare const updateProgress: UpdateProgressFunction;
 
+declare const uploadFile: UploadFileFunction;
+
 declare const useColorScheme: () => "light" | "dark";
 
 type FrontComponentExecutionContext = {
@@ -294,5 +337,5 @@ type CommandModalProps = {
 };
 declare const CommandModal: ({ title, subtitle, execute, confirmButtonText, confirmButtonAccent, }: CommandModalProps) => null;
 
-export { AppPath, Command, CommandLink, CommandModal, CommandOpenSidePanelPage, SidePanelPages, Trans, closeSidePanel, copyToClipboard, enqueueSnackbar, getApplicationVariable, getFrontComponentCommandErrorDedupeKey, msg, navigate, openCommandConfirmationModal, openSidePanelPage, t, unmountFrontComponent, updateProgress, useColorScheme, useFrontComponentExecutionContext, useFrontComponentId, useLocale, useRecordId, useSelectedRecordIds, useTranslate, useUserId };
-export type { CloseSidePanelFunction, CommandConfirmationModalAccent, CommandConfirmationModalResult, CommandLinkProps, CommandModalProps, CommandOpenSidePanelPageProps, CommandProps, CopyToClipboardFunction, EnqueueSnackbarFunction, EnqueueSnackbarParams, FrontComponentExecutionContext, MessageDescriptor, NavigateFunction, OpenCommandConfirmationModalFunction, OpenCommandConfirmationModalHostFunction, OpenSidePanelPageFunction, OpenSidePanelPageParams, RequestAccessTokenRefreshFunction, SnackBarVariant, TransProps, TranslationValues, UnmountFrontComponentFunction, UpdateProgressFunction, UseTranslateResult };
+export { AppPath, Command, CommandLink, CommandModal, CommandOpenSidePanelPage, SidePanelPages, Trans, closeSidePanel, copyToClipboard, enqueueSnackbar, getApplicationVariable, getFrontComponentCommandErrorDedupeKey, msg, navigate, openCommandConfirmationModal, openSidePanelPage, t, unmountFrontComponent, updateProgress, uploadFile, useColorScheme, useFrontComponentExecutionContext, useFrontComponentId, useLocale, useRecordId, useSelectedRecordIds, useTranslate, useUserId };
+export type { CloseSidePanelFunction, CommandConfirmationModalAccent, CommandConfirmationModalResult, CommandLinkProps, CommandModalProps, CommandOpenSidePanelPageProps, CommandProps, CopyToClipboardFunction, EnqueueSnackbarFunction, EnqueueSnackbarParams, FrontComponentExecutionContext, FrontComponentStorageType, MessageDescriptor, NavigateFunction, OpenCommandConfirmationModalFunction, OpenCommandConfirmationModalHostFunction, OpenSidePanelPageFunction, OpenSidePanelPageParams, RequestAccessTokenRefreshFunction, SnackBarVariant, StorageClearFunction, StorageDeleteFunction, StorageSetFunction, TransProps, TranslationValues, UnmountFrontComponentFunction, UpdateProgressFunction, UploadFileFailureReason, UploadFileFunction, UploadFileParams, UploadFileResult, UploadedFrontComponentFile, UseTranslateResult };