twenty-sdk 2.31.0 → 2.35.0

package/dist/define/index.d.ts

@@ -649,6 +649,12 @@ type LogicFunctionHttpResponse = {
     headers?: Record<string, string>;
 };
 
+declare enum MetadataWritability {
+    OPEN = "OPEN",
+    APPLICATION = "APPLICATION",
+    SYSTEM = "SYSTEM"
+}
+
 declare enum NavigationMenuItemType {
     VIEW = "VIEW",
     FOLDER = "FOLDER",
@@ -821,6 +827,7 @@ type IframeConfiguration = {
 type FrontComponentConfiguration = {
     configurationType: 'FRONT_COMPONENT';
     frontComponentId: SerializedRelation;
+    headerCommandMenuItemUniversalIdentifiers?: string[];
 };
 type TimelineConfiguration = {
     configurationType: 'TIMELINE';
@@ -961,6 +968,7 @@ type BaseRegularFieldManifest<T extends FieldMetadataType = Exclude<FieldMetadat
     options?: FieldMetadataOptions<T>;
     universalSettings?: FieldMetadataUniversalSettings<T>;
     isUIEditable?: boolean;
+    writability?: MetadataWritability;
     isUnique?: boolean;
     objectUniversalIdentifier: string;
 };
@@ -1023,6 +1031,7 @@ type IndexManifest = SyncableEntityOptions$1 & {
 
 type ServerRouteTriggerSettings = {
     forwardedRequestHeaders?: string[];
+    httpMethods?: (HTTPMethod | `${HTTPMethod}`)[];
 };
 
 type InputJsonSchema = {
@@ -1047,6 +1056,14 @@ type ToolTriggerSettings = {
 type LeafType = 'string' | 'number' | 'boolean' | 'array' | 'unknown';
 type NodeType = 'object' | 'unknown';
 
+type LogicFunctionExecutionContext = {
+    retryCount: number;
+    maxRetries: number;
+    workspaceId: string;
+    userWorkspaceId: string | null;
+    workspaceMemberId: string | null;
+};
+
 type RecordSchemaType = 'record' | 'records';
 type InputSchemaPropertyType = LeafType | NodeType | RecordSchemaType | FieldMetadataType;
 type InputSchemaProperty = {
@@ -1125,6 +1142,7 @@ type ObjectManifest = SyncableEntityOptions$1 & {
     isSearchable?: boolean;
     isUICreatable?: boolean;
     isUIEditable?: boolean;
+    writability?: MetadataWritability;
     openRecordIn?: ObjectOpenRecordIn;
     fields: ObjectFieldManifest[];
     labelIdentifierFieldMetadataUniversalIdentifier: string;
@@ -1220,6 +1238,27 @@ type SkillManifest = SyncableEntityOptions$1 & {
     content: string;
 };
 
+declare const TIMELINE_ACTIVITY_ACTIONS: readonly ["created", "updated", "deleted", "restored", "linked", "unlinked"];
+type TimelineActivityAction = (typeof TIMELINE_ACTIVITY_ACTIONS)[number];
+
+type TimelineActivityTypeEmitThroughManifest = {
+    relationFieldUniversalIdentifier: string;
+    triggerFieldUniversalIdentifiers?: string[];
+};
+type TimelineActivityTypeEmitManifest = {
+    on: TimelineActivityAction;
+    objectUniversalIdentifier: string;
+    through?: TimelineActivityTypeEmitThroughManifest;
+};
+type TimelineActivityTypeManifest = SyncableEntityOptions$1 & {
+    name: string;
+    label: string;
+    icon?: string;
+    emit?: TimelineActivityTypeEmitManifest;
+    frontComponentUniversalIdentifier?: string;
+    replacesTimelineActivityTypeUniversalIdentifier?: string;
+};
+
 type ViewManifestFilterValue = string | string[] | boolean | number | Record<string, unknown>;
 type ViewFieldManifest = SyncableEntityOptions$1 & {
     fieldMetadataUniversalIdentifier: string;
@@ -1317,9 +1356,9 @@ type FrontComponentConfig = Omit<FrontComponentManifest, 'sourceComponentPath' |
 
 type IndexConfig = IndexManifest;
 
-type LogicFunctionHandler = (...args: any[]) => any | Promise<any>;
+type LogicFunctionHandler<TPayload = any> = (payload: TPayload, context: LogicFunctionExecutionContext) => any | Promise<any>;
 type ServerRouteResolverResult = ServerRouteDispatchResult | LogicFunctionHttpResponse;
-type ServerRouteResolverHandler = (...args: any[]) => ServerRouteResolverResult | Promise<ServerRouteResolverResult>;
+type ServerRouteResolverHandler<TPayload = any> = (payload: TPayload, context: LogicFunctionExecutionContext) => ServerRouteResolverResult | Promise<ServerRouteResolverResult>;
 type LogicFunctionConfigBase = Omit<LogicFunctionManifest, 'sourceHandlerPath' | 'builtHandlerPath' | 'builtHandlerChecksum' | 'handlerName' | 'serverRouteTriggerSettings'>;
 type LogicFunctionConfig = LogicFunctionConfigBase & ({
     serverRouteTriggerSettings?: undefined;
@@ -1401,6 +1440,10 @@ declare const validateFields: (fields: ObjectFieldManifest[] | undefined) => str
 
 declare const defineCommandMenuItem: DefineEntity<CommandMenuItemConfig>;
 
+type TimelineActivityTypeConfig = TimelineActivityTypeManifest;
+
+declare const defineTimelineActivityType: DefineEntity<TimelineActivityTypeConfig>;
+
 declare const pageType: CommandMenuContextApi["pageType"];
 declare const isInSidePanel: CommandMenuContextApi["isInSidePanel"];
 declare const isDashboardPageLayoutInEditMode: CommandMenuContextApi["isDashboardPageLayoutInEditMode"];
@@ -3344,6 +3387,12 @@ declare const STANDARD_OBJECTS: {
             name: {
                 universalIdentifier: string;
             };
+            timelineActivityTypeId: {
+                universalIdentifier: string;
+            };
+            timelineActivityTypeSnapshot: {
+                universalIdentifier: string;
+            };
             happensAt: {
                 universalIdentifier: string;
             };
@@ -3460,7 +3509,7 @@ declare const STANDARD_OBJECTS: {
         readonly views: {
             readonly allTimelineActivities: {
                 universalIdentifier: string;
-                viewFields: Record<"happensAt" | "name" | "targetCompany" | "targetDashboard" | "targetNote" | "targetOpportunity" | "targetPerson" | "targetTask" | "targetWorkflow" | "targetWorkflowRun" | "targetWorkflowVersion" | "workspaceMember", {
+                viewFields: Record<"happensAt" | "linkedRecordCachedName" | "targetCompany" | "targetDashboard" | "targetNote" | "targetOpportunity" | "targetPerson" | "targetTask" | "targetWorkflow" | "targetWorkflowRun" | "targetWorkflowVersion" | "workspaceMember", {
                     universalIdentifier: string;
                 }>;
             };
@@ -3769,6 +3818,9 @@ declare const STANDARD_OBJECTS: {
             colorScheme: {
                 universalIdentifier: string;
             };
+            uiScale: {
+                universalIdentifier: string;
+            };
             openRecordIn: {
                 universalIdentifier: string;
             };
@@ -4317,6 +4369,14 @@ declare const STANDARD_PAGE_LAYOUT_UNIVERSAL_IDENTIFIERS: {
                     };
                 };
             };
+            readonly summary: {
+                universalIdentifier: string;
+                widgets: {
+                    readonly summary: {
+                        universalIdentifier: string;
+                    };
+                };
+            };
             readonly callRecording: {
                 universalIdentifier: string;
                 widgets: {
@@ -4563,5 +4623,5 @@ declare const defineView: DefineEntity<ViewConfig>;
 
 declare const defineViewField: DefineEntity<StandaloneViewFieldManifest>;
 
-export { AggregateOperations, DateDisplayFormat, FieldMetadataSettingsOnClickAction, FieldMetadataType as FieldType, HTTPMethod, NavigationMenuItemType, NumberDataType, ObjectOpenRecordIn, 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, SYSTEM_VIEW_KEYS, 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, getSystemViewFieldUniversalIdentifier, getSystemViewUniversalIdentifier, 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, SystemViewKey, TwentyRecord, UninstallHandler, UninstallPayload, ValidationResult, ViewConfig, ViewFieldGroupManifest, ViewFieldManifest, ViewFilterGroupManifest, ViewFilterManifest, ViewGroupManifest, ViewManifestFilterValue, ViewSortManifest };
+export { AggregateOperations, DateDisplayFormat, FieldMetadataSettingsOnClickAction, FieldMetadataType as FieldType, HTTPMethod, MetadataWritability, NavigationMenuItemType, NumberDataType, ObjectOpenRecordIn, 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, SYSTEM_VIEW_KEYS, 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, defineTimelineActivityType, defineUninstallLogicFunction, defineView, defineViewField, every, everyDefined, everyEquals, favoriteRecordIds, featureFlags, getFieldUniversalIdentifier, getSystemRelationFieldUniversalIdentifier, getSystemViewFieldUniversalIdentifier, getSystemViewUniversalIdentifier, 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, SystemViewKey, TimelineActivityTypeConfig, TimelineActivityTypeManifest, TwentyRecord, UninstallHandler, UninstallPayload, ValidationResult, ViewConfig, ViewFieldGroupManifest, ViewFieldManifest, ViewFilterGroupManifest, ViewFilterManifest, ViewGroupManifest, ViewManifestFilterValue, ViewSortManifest };