twenty-sdk 2.23.0 → 2.25.0

package/dist/define/index.d.ts

@@ -33,6 +33,7 @@ type AgentManifest = SyncableEntityOptions$1 & {
     prompt: string;
     modelId?: string;
     responseFormat?: AgentResponseFormat;
+    roleUniversalIdentifier?: string;
 };
 
 declare const APPLICATION_CATEGORIES: readonly ["Communication", "Productivity", "Product management", "Sales", "Marketing", "Enrichment", "Data", "Search", "Other"];
@@ -48,6 +49,12 @@ type PostInstallLogicFunctionApplicationManifest = PreInstallLogicFunctionApplic
     shouldRunSynchronously?: boolean;
 };
 
+type SettingsFrontComponentApplicationManifest = {
+    universalIdentifier: string;
+};
+
+type UninstallLogicFunctionApplicationManifest = SyncableEntityOptions$1;
+
 declare enum FieldMetadataType {
     ACTOR = "ACTOR",
     ADDRESS = "ADDRESS",
@@ -133,10 +140,11 @@ type ApplicationManifest = SyncableEntityOptions$1 & {
     issueReportUrl?: string;
     postInstallLogicFunction?: PostInstallLogicFunctionApplicationManifest;
     preInstallLogicFunction?: PreInstallLogicFunctionApplicationManifest;
+    uninstallLogicFunction?: UninstallLogicFunctionApplicationManifest;
+    settingsFrontComponent?: SettingsFrontComponentApplicationManifest;
     /**
-     * @deprecated Custom settings tabs are no longer supported. This property is
-     * kept for backward compatibility with older manifests but is now ignored.
-     * Use typed `applicationVariables` / `serverVariables` instead.
+     * @deprecated Use `defineSettingsFrontComponent()` (exposed on the manifest
+     * as `settingsFrontComponent`) instead. This property is ignored.
      */
     settingsCustomTabFrontComponentUniversalIdentifier?: string;
     packageJsonChecksum: string | null;
@@ -163,6 +171,7 @@ type ConnectionProviderManifest = SyncableEntityOptions$1 & {
     displayName: string;
     type: 'oauth';
     oauth: OAuthConnectionProviderConfig;
+    onConnectLogicFunction?: SyncableEntityOptions$1;
 };
 
 declare const getFieldUniversalIdentifier: ({ applicationUniversalIdentifier, objectUniversalIdentifier, name, }: {
@@ -606,6 +615,13 @@ type LogicFunctionEvent<TBody = object> = {
     userWorkspaceId: string | null;
 };
 
+type LogicFunctionHttpResponse = {
+    __twentyHttpResponse: true;
+    body: unknown;
+    status?: number;
+    headers?: Record<string, string>;
+};
+
 declare enum NavigationMenuItemType {
     VIEW = "VIEW",
     FOLDER = "FOLDER",
@@ -787,6 +803,12 @@ type EmailsConfiguration = {
 type EmailThreadConfiguration = {
     configurationType: 'EMAIL_THREAD';
 };
+type MessageCampaignBodyConfiguration = {
+    configurationType: 'MESSAGE_CAMPAIGN_BODY';
+};
+type MessageCampaignDetailsConfiguration = {
+    configurationType: 'MESSAGE_CAMPAIGN_DETAILS';
+};
 type CalendarConfiguration = {
     configurationType: 'CALENDAR';
 };
@@ -799,11 +821,16 @@ type WorkflowVersionConfiguration = {
 type WorkflowRunConfiguration = {
     configurationType: 'WORKFLOW_RUN';
 };
-type PageLayoutWidgetConfiguration = AggregateChartConfiguration | PieChartConfiguration | BarChartConfiguration | LineChartConfiguration | ViewConfiguration | RecordTableConfiguration | FieldConfiguration | FieldsConfiguration | FieldRichTextConfiguration | StandaloneRichTextConfiguration | IframeConfiguration | FrontComponentConfiguration | TimelineConfiguration | TasksConfiguration | NotesConfiguration | FilesConfiguration | EmailsConfiguration | CalendarConfiguration | WorkflowConfiguration | WorkflowVersionConfiguration | WorkflowRunConfiguration | EmailThreadConfiguration;
+type PageLayoutWidgetConfiguration = AggregateChartConfiguration | PieChartConfiguration | BarChartConfiguration | LineChartConfiguration | ViewConfiguration | RecordTableConfiguration | FieldConfiguration | FieldsConfiguration | FieldRichTextConfiguration | StandaloneRichTextConfiguration | IframeConfiguration | FrontComponentConfiguration | TimelineConfiguration | TasksConfiguration | NotesConfiguration | FilesConfiguration | EmailsConfiguration | CalendarConfiguration | WorkflowConfiguration | WorkflowVersionConfiguration | WorkflowRunConfiguration | EmailThreadConfiguration | MessageCampaignBodyConfiguration | MessageCampaignDetailsConfiguration;
 
 declare enum PageLayoutTabLayoutMode {
     GRID = "GRID",
     VERTICAL_LIST = "VERTICAL_LIST",
+    /**
+     * @deprecated Solo full-page tabs are no longer stored as a layout mode.
+     * Presentation (solo vs stack) is derived from the tab's widgets. Kept only to
+     * read layouts persisted before this change; nothing new should write it.
+     */
     CANVAS = "CANVAS"
 }
 
@@ -1075,7 +1102,7 @@ type PageLayoutTabManifest = SyncableEntityOptions$1 & {
 };
 type PageLayoutManifest = SyncableEntityOptions$1 & {
     name: string;
-    type: string;
+    type: `${PageLayoutType}`;
     objectUniversalIdentifier?: string;
     defaultTabToFocusOnMobileAndSidePanelUniversalIdentifier?: string;
     tabs?: PageLayoutTabManifest[];
@@ -1214,7 +1241,13 @@ type ViewManifest = SyncableEntityOptions$1 & {
     sorts?: ViewSortManifest[];
 };
 
-type ApplicationConfig = Omit<ApplicationManifest, 'packageJsonChecksum' | 'yarnLockChecksum' | 'requiredServerVersionRange' | 'postInstallLogicFunction' | 'preInstallLogicFunction' | 'defaultRoleUniversalIdentifier' | 'aboutDescription'> & {
+type ServerRouteDispatchResult = {
+    workspaceId: string;
+    targetLogicFunctionUniversalIdentifier: string;
+    payload?: object;
+};
+
+type ApplicationConfig = Omit<ApplicationManifest, 'packageJsonChecksum' | 'yarnLockChecksum' | 'requiredServerVersionRange' | 'postInstallLogicFunction' | 'preInstallLogicFunction' | 'settingsFrontComponent' | 'defaultRoleUniversalIdentifier' | 'aboutDescription'> & {
     /**
      * @deprecated Use `defineApplicationRole()` in your role file instead.
      */
@@ -1233,11 +1266,7 @@ type FrontComponentConfig = Omit<FrontComponentManifest, 'sourceComponentPath' |
 type IndexConfig = IndexManifest;
 
 type LogicFunctionHandler = (...args: any[]) => any | Promise<any>;
-type ServerRouteResolverResult = {
-    workspaceId: string;
-    targetLogicFunctionUniversalIdentifier: string;
-    payload?: object;
-};
+type ServerRouteResolverResult = ServerRouteDispatchResult | LogicFunctionHttpResponse;
 type ServerRouteResolverHandler = (...args: any[]) => ServerRouteResolverResult | Promise<ServerRouteResolverResult>;
 type LogicFunctionConfigBase = Omit<LogicFunctionManifest, 'sourceHandlerPath' | 'builtHandlerPath' | 'builtHandlerChecksum' | 'handlerName' | 'serverRouteTriggerSettings'>;
 type LogicFunctionConfig = LogicFunctionConfigBase & ({
@@ -1277,6 +1306,15 @@ type PostInstallLogicFunctionConfig = PreInstallLogicFunctionConfig & {
     shouldRunSynchronously?: boolean;
 };
 
+type UninstallPayload = {
+    version?: string;
+};
+type UninstallHandler = (payload: UninstallPayload) => any | Promise<any>;
+
+type UninstallLogicFunctionConfig = Omit<LogicFunctionConfig, 'cronTriggerSettings' | 'databaseEventTriggerSettings' | 'httpRouteTriggerSettings' | 'toolTriggerSettings' | 'workflowActionTriggerSettings' | 'handler'> & {
+    handler: UninstallHandler;
+};
+
 type RoleConfig = Omit<RoleManifest, 'objectPermissions' | 'fieldPermissions'> & {
     objectPermissions?: Omit<ObjectPermissionManifest, 'universalIdentifier'>[];
     fieldPermissions?: Omit<FieldPermissionManifest, 'universalIdentifier'>[];
@@ -1288,7 +1326,7 @@ type ValidationResult<T> = {
     errors: string[];
     warnings?: string[];
 };
-type DefinableEntity = ApplicationConfig | ObjectConfig | FieldManifest | FrontComponentConfig | IndexConfig | LogicFunctionConfig | PostInstallLogicFunctionConfig | PreInstallLogicFunctionConfig | AgentManifest | ConnectionProviderManifest | RoleConfig | SkillManifest | ViewConfig | StandaloneViewFieldManifest | NavigationMenuItemManifest | PageLayoutConfig | PageLayoutTabConfig | PermissionFlagConfig | CommandMenuItemConfig;
+type DefinableEntity = ApplicationConfig | ObjectConfig | FieldManifest | FrontComponentConfig | IndexConfig | LogicFunctionConfig | PostInstallLogicFunctionConfig | PreInstallLogicFunctionConfig | UninstallLogicFunctionConfig | AgentManifest | ConnectionProviderManifest | RoleConfig | SkillManifest | ViewConfig | StandaloneViewFieldManifest | NavigationMenuItemManifest | PageLayoutConfig | PageLayoutTabConfig | PermissionFlagConfig | CommandMenuItemConfig;
 type DefineEntity<T extends DefinableEntity = DefinableEntity> = (config: T) => ValidationResult<T>;
 
 declare const defineAgent: DefineEntity<AgentManifest>;
@@ -1345,6 +1383,10 @@ declare const includesEvery: (array: unknown, prop: string, value: unknown) => b
 
 declare const defineFrontComponent: DefineEntity<FrontComponentConfig>;
 
+type SettingsFrontComponentConfig = Omit<FrontComponentConfig, 'isHeadless'>;
+
+declare const defineSettingsFrontComponent: DefineEntity<SettingsFrontComponentConfig>;
+
 declare const defineIndex: DefineEntity<IndexConfig>;
 
 declare const defineLogicFunction: DefineEntity<LogicFunctionConfig>;
@@ -1353,6 +1395,8 @@ declare const definePostInstallLogicFunction: DefineEntity<PostInstallLogicFunct
 
 declare const definePreInstallLogicFunction: DefineEntity<PreInstallLogicFunctionConfig>;
 
+declare const defineUninstallLogicFunction: DefineEntity<UninstallLogicFunctionConfig>;
+
 type CronPayload = Record<string, never>;
 
 type ObjectRecordDiff<T> = {
@@ -2433,6 +2477,9 @@ declare const STANDARD_OBJECTS: {
     readonly messageCampaign: {
         readonly universalIdentifier: "238acb94-dd4c-4036-bc55-19b99d821efd";
         readonly fields: {
+            readonly name: {
+                readonly universalIdentifier: "dc8bca0e-37c4-4b78-814d-2e91124274e3";
+            };
             readonly subject: {
                 readonly universalIdentifier: "7251544c-b07a-4f0d-9d0a-48514367f230";
             };
@@ -2515,6 +2562,9 @@ declare const STANDARD_OBJECTS: {
             readonly allMessageCampaigns: {
                 readonly universalIdentifier: "ffedb368-33f0-43a7-b84e-e622b4e97be9";
                 readonly viewFields: {
+                    readonly name: {
+                        readonly universalIdentifier: "4d40646c-853d-48e6-8ddb-81e6dedabc99";
+                    };
                     readonly subject: {
                         readonly universalIdentifier: "b017c851-e38d-4a81-ab38-0fb10e9f239e";
                     };
@@ -2550,6 +2600,34 @@ declare const STANDARD_OBJECTS: {
                     };
                 };
             };
+            readonly messageCampaignRecordPageFields: {
+                readonly universalIdentifier: "20202020-a009-4a09-8a09-fa9de11ca901";
+                readonly viewFieldGroups: {
+                    readonly stats: {
+                        readonly universalIdentifier: "20202020-a009-4a09-8a09-fa9de11ca902";
+                    };
+                };
+                readonly viewFields: {
+                    readonly status: {
+                        readonly universalIdentifier: "20202020-af09-4a09-8a09-fa9de11ca903";
+                    };
+                    readonly sentAt: {
+                        readonly universalIdentifier: "20202020-af09-4a09-8a09-fa9de11ca904";
+                    };
+                    readonly sentCount: {
+                        readonly universalIdentifier: "20202020-af09-4a09-8a09-fa9de11ca905";
+                    };
+                    readonly failedCount: {
+                        readonly universalIdentifier: "20202020-af09-4a09-8a09-fa9de11ca906";
+                    };
+                    readonly bouncedCount: {
+                        readonly universalIdentifier: "20202020-af09-4a09-8a09-fa9de11ca907";
+                    };
+                    readonly complainedCount: {
+                        readonly universalIdentifier: "20202020-af09-4a09-8a09-fa9de11ca908";
+                    };
+                };
+            };
         };
     };
     readonly messageList: {
@@ -5372,12 +5450,23 @@ declare const STANDARD_PAGE_LAYOUT_UNIVERSAL_IDENTIFIERS: {
     messageCampaignRecordPage: {
         universalIdentifier: string;
         tabs: {
+            composer: {
+                universalIdentifier: string;
+                widgets: {
+                    messageCampaign: {
+                        universalIdentifier: string;
+                    };
+                };
+            };
             home: {
                 universalIdentifier: string;
                 widgets: {
                     fields: {
                         universalIdentifier: string;
                     };
+                    details: {
+                        universalIdentifier: string;
+                    };
                     messages: {
                         universalIdentifier: string;
                     };
@@ -5442,5 +5531,5 @@ declare const defineView: DefineEntity<ViewConfig>;
 
 declare const defineViewField: DefineEntity<StandaloneViewFieldManifest>;
 
-export { AggregateOperations, DateDisplayFormat, FieldMetadataSettingsOnClickAction, FieldMetadataType as FieldType, HTTPMethod, NavigationMenuItemType, NumberDataType, ObjectRecordBaseEvent, ObjectRecordCreateEvent, ObjectRecordDeleteEvent, ObjectRecordDestroyEvent, ObjectRecordGroupByDateGranularity, ObjectRecordRestoreEvent, ObjectRecordUpdateEvent, ObjectRecordUpsertEvent, RelationOnDeleteAction as OnDeleteAction, PageLayoutTabLayoutMode, PageLayoutType, RelationType, RowLevelPermissionPredicateGroupLogicalOperator, RowLevelPermissionPredicateOperand, STANDARD_OBJECTS as STANDARD_OBJECT, STANDARD_OBJECTS as STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS, STANDARD_PAGE_LAYOUT_UNIVERSAL_IDENTIFIERS as STANDARD_PAGE_LAYOUT, STANDARD_PAGE_LAYOUT_UNIVERSAL_IDENTIFIERS, SystemPermissionFlag, ViewCalendarLayout, ViewFilterGroupLogicalOperator, ViewFilterOperand, ViewKey, ViewOpenRecordIn, ViewSortDirection, ViewType, ViewVisibility, canAccessFullAdminPanel, canImpersonate, createValidationResult, defineAgent, defineApplication, defineApplicationRole, defineCommandMenuItem, defineConnectionProvider, defineField, defineFrontComponent, defineIndex, defineLogicFunction, defineNavigationMenuItem, defineObject, definePageLayout, definePageLayoutTab, definePermissionFlag, definePostInstallLogicFunction, definePreInstallLogicFunction, defineRole, defineSkill, defineView, defineViewField, every, everyDefined, everyEquals, favoriteRecordIds, featureFlags, getFieldUniversalIdentifier, getSystemRelationFieldUniversalIdentifier, hasAnySoftDeleteFilterOnView, includes, includesEvery, isDashboardPageLayoutInEditMode, isDefined, isInSidePanel, isLayoutCustomizationModeEnabled, isNonEmptyString, isSelectAll, none, noneDefined, noneEquals, numberOfSelectedRecords, objectMetadataItem, objectMetadataLabel, objectPermissions, pageType, selectedRecords, some, someDefined, someEquals, someNonEmptyString, targetObjectReadPermissions, targetObjectWritePermissions, validateFields };
-export type { ActorMetadata as ActorField, AddressMetadata as AddressField, ApplicationConfig, CommandMenuItemConfig, CommandMenuItemManifest, CronPayload, CurrencyMetadata as CurrencyField, DatabaseEventPayload, DefinableEntity, DefineEntity, EmailsMetadata as EmailsField, FrontComponentConfig, FrontComponentType, FullNameMetadata as FullNameField, GridPosition, IndexConfig, IndexFieldManifest, IndexManifest, InputJsonSchema, InstallHandler, InstallPayload, LinksMetadata as LinksField, LogicFunctionConfig, LogicFunctionHandler, ObjectRecordEvent, PageLayoutConfig, PageLayoutManifest, PageLayoutTabConfig, PageLayoutTabManifest, PageLayoutWidgetConditionalDisplay, PageLayoutWidgetManifest, PageLayoutWidgetUniversalConfiguration, PermissionFlagConfig, PermissionFlagManifest, PermissionFlagPermissionType, PhonesMetadata as PhonesField, RichTextMetadata as RichTextField, LogicFunctionEvent as RoutePayload, RowLevelPermissionPredicateGroupManifest, RowLevelPermissionPredicateManifest, StandaloneViewFieldManifest, SyncableEntityOptions, TwentyRecord, ValidationResult, ViewConfig, ViewFieldGroupManifest, ViewFieldManifest, ViewFilterGroupManifest, ViewFilterManifest, ViewGroupManifest, ViewManifestFilterValue, ViewSortManifest };
+export { AggregateOperations, DateDisplayFormat, FieldMetadataSettingsOnClickAction, FieldMetadataType as FieldType, HTTPMethod, NavigationMenuItemType, NumberDataType, ObjectRecordBaseEvent, ObjectRecordCreateEvent, ObjectRecordDeleteEvent, ObjectRecordDestroyEvent, ObjectRecordGroupByDateGranularity, ObjectRecordRestoreEvent, ObjectRecordUpdateEvent, ObjectRecordUpsertEvent, RelationOnDeleteAction as OnDeleteAction, PageLayoutTabLayoutMode, PageLayoutType, RelationType, RowLevelPermissionPredicateGroupLogicalOperator, RowLevelPermissionPredicateOperand, STANDARD_OBJECTS as STANDARD_OBJECT, STANDARD_OBJECTS as STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS, STANDARD_PAGE_LAYOUT_UNIVERSAL_IDENTIFIERS as STANDARD_PAGE_LAYOUT, STANDARD_PAGE_LAYOUT_UNIVERSAL_IDENTIFIERS, SystemPermissionFlag, ViewCalendarLayout, ViewFilterGroupLogicalOperator, ViewFilterOperand, ViewKey, ViewOpenRecordIn, ViewSortDirection, ViewType, ViewVisibility, canAccessFullAdminPanel, canImpersonate, createValidationResult, defineAgent, defineApplication, defineApplicationRole, defineCommandMenuItem, defineConnectionProvider, defineField, defineFrontComponent, defineIndex, defineLogicFunction, defineNavigationMenuItem, defineObject, definePageLayout, definePageLayoutTab, definePermissionFlag, definePostInstallLogicFunction, definePreInstallLogicFunction, defineRole, defineSettingsFrontComponent, defineSkill, defineUninstallLogicFunction, defineView, defineViewField, every, everyDefined, everyEquals, favoriteRecordIds, featureFlags, getFieldUniversalIdentifier, getSystemRelationFieldUniversalIdentifier, hasAnySoftDeleteFilterOnView, includes, includesEvery, isDashboardPageLayoutInEditMode, isDefined, isInSidePanel, isLayoutCustomizationModeEnabled, isNonEmptyString, isSelectAll, none, noneDefined, noneEquals, numberOfSelectedRecords, objectMetadataItem, objectMetadataLabel, objectPermissions, pageType, selectedRecords, some, someDefined, someEquals, someNonEmptyString, targetObjectReadPermissions, targetObjectWritePermissions, validateFields };
+export type { ActorMetadata as ActorField, AddressMetadata as AddressField, ApplicationConfig, CommandMenuItemConfig, CommandMenuItemManifest, CronPayload, CurrencyMetadata as CurrencyField, DatabaseEventPayload, DefinableEntity, DefineEntity, EmailsMetadata as EmailsField, FrontComponentConfig, FrontComponentType, FullNameMetadata as FullNameField, GridPosition, IndexConfig, IndexFieldManifest, IndexManifest, InputJsonSchema, InstallHandler, InstallPayload, LinksMetadata as LinksField, LogicFunctionConfig, LogicFunctionHandler, ObjectRecordEvent, PageLayoutConfig, PageLayoutManifest, PageLayoutTabConfig, PageLayoutTabManifest, PageLayoutWidgetConditionalDisplay, PageLayoutWidgetManifest, PageLayoutWidgetUniversalConfiguration, PermissionFlagConfig, PermissionFlagManifest, PermissionFlagPermissionType, PhonesMetadata as PhonesField, RichTextMetadata as RichTextField, LogicFunctionEvent as RoutePayload, RowLevelPermissionPredicateGroupManifest, RowLevelPermissionPredicateManifest, ServerRouteDispatchResult, ServerRouteResolverResult, SettingsFrontComponentConfig, StandaloneViewFieldManifest, SyncableEntityOptions, TwentyRecord, UninstallHandler, UninstallPayload, ValidationResult, ViewConfig, ViewFieldGroupManifest, ViewFieldManifest, ViewFilterGroupManifest, ViewFilterManifest, ViewGroupManifest, ViewManifestFilterValue, ViewSortManifest };