twenty-sdk 2.2.0 → 2.3.1

package/dist/define/index.d.ts

@@ -14,11 +14,16 @@ type AgentManifest = SyncableEntityOptions$1 & {
     modelId?: string;
 };
 
-type ApplicationVariable = SyncableEntityOptions$1 & {
+type SecretApplicationVariable = SyncableEntityOptions$1 & {
+    description?: string;
+    isSecret: true;
+};
+type NonSecretApplicationVariable = SyncableEntityOptions$1 & {
     value?: string;
     description?: string;
-    isSecret?: boolean;
+    isSecret?: false;
 };
+type ApplicationVariable = SecretApplicationVariable | NonSecretApplicationVariable;
 type ApplicationVariables = Record<string, ApplicationVariable>;
 
 type ServerVariableSchema = {
@@ -59,6 +64,27 @@ type ApplicationManifest = SyncableEntityOptions$1 & {
     yarnLockChecksum: string | null;
 };
 
+type OAuthProviderTokenRequestContentType = 'json' | 'form-urlencoded';
+
+type OAuthConnectionProviderConfig = {
+    authorizationEndpoint: string;
+    tokenEndpoint: string;
+    revokeEndpoint?: string;
+    scopes: string[];
+    clientIdVariable: string;
+    clientSecretVariable: string;
+    authorizationParams?: Record<string, string>;
+    tokenRequestContentType?: OAuthProviderTokenRequestContentType;
+    usePkce?: boolean;
+};
+
+type ConnectionProviderManifest = SyncableEntityOptions$1 & {
+    name: string;
+    displayName: string;
+    type: 'oauth';
+    oauth: OAuthConnectionProviderConfig;
+};
+
 declare const ALLOWED_ADDRESS_SUBFIELDS: readonly ["addressStreet1", "addressStreet2", "addressCity", "addressState", "addressPostcode", "addressCountry", "addressLat", "addressLng"];
 type AllowedAddressSubField = (typeof ALLOWED_ADDRESS_SUBFIELDS)[number];
 
@@ -130,7 +156,9 @@ declare enum ConnectedAccountProvider {
     MICROSOFT = "microsoft",
     IMAP_SMTP_CALDAV = "imap_smtp_caldav",
     OIDC = "oidc",
-    SAML = "saml"
+    SAML = "saml",
+    EMAIL_GROUP = "email_group",
+    APP = "app"
 }
 
 declare enum FieldActorSource {
@@ -406,6 +434,7 @@ type LogicFunctionEvent<TBody = object> = {
             path: string;
         };
     };
+    userWorkspaceId: string | null;
 };
 
 declare enum NavigationMenuItemType {
@@ -708,7 +737,6 @@ type CommandMenuItemManifest = SyncableEntityOptions$1 & {
     frontComponentUniversalIdentifier: string;
     conditionalAvailabilityExpression?: string;
 };
-type FrontComponentCommandManifest = Omit<CommandMenuItemManifest, 'frontComponentUniversalIdentifier'>;
 type FrontComponentManifest = {
     universalIdentifier: string;
     name?: string;
@@ -719,7 +747,6 @@ type FrontComponentManifest = {
     componentName: string;
     isHeadless?: boolean;
     usesSdkClient?: boolean;
-    command?: FrontComponentCommandManifest;
 };
 
 type InputJsonSchema = {
@@ -732,6 +759,34 @@ type InputJsonSchema = {
     additionalProperties?: boolean | InputJsonSchema;
     minimum?: number;
     maximum?: number;
+    multiline?: boolean;
+};
+
+type ToolTriggerSettings = {
+    inputSchema?: InputJsonSchema;
+};
+
+type LeafType = 'string' | 'number' | 'boolean' | 'array' | 'unknown';
+type NodeType = 'object' | 'unknown';
+
+type InputSchemaPropertyType = LeafType | NodeType | FieldMetadataType;
+type InputSchemaProperty = {
+    type: InputSchemaPropertyType;
+    enum?: string[];
+    items?: InputSchemaProperty;
+    properties?: Properties$1;
+    multiline?: boolean;
+};
+type Properties$1 = {
+    [name: string]: InputSchemaProperty;
+};
+type InputSchema = InputSchemaProperty[];
+
+type WorkflowActionTriggerSettings = {
+    inputSchema?: InputSchema;
+    outputSchema?: InputSchema;
+    icon?: string;
+    label?: string;
 };
 
 type LogicFunctionManifest = SyncableEntityOptions$1 & {
@@ -741,12 +796,12 @@ type LogicFunctionManifest = SyncableEntityOptions$1 & {
     cronTriggerSettings?: CronTriggerSettings;
     databaseEventTriggerSettings?: DatabaseEventTriggerSettings;
     httpRouteTriggerSettings?: HttpRouteTriggerSettings;
+    toolTriggerSettings?: ToolTriggerSettings;
+    workflowActionTriggerSettings?: WorkflowActionTriggerSettings;
     sourceHandlerPath: string;
     builtHandlerPath: string;
     builtHandlerChecksum: string;
     handlerName: string;
-    toolInputSchema: InputJsonSchema;
-    isTool?: boolean;
 };
 type CronTriggerSettings = {
     pattern: string;
@@ -943,21 +998,25 @@ type ViewManifest = SyncableEntityOptions$1 & {
     sorts?: ViewSortManifest[];
 };
 
-type ApplicationConfig = Omit<ApplicationManifest, 'packageJsonChecksum' | 'yarnLockChecksum' | 'postInstallLogicFunction' | 'preInstallLogicFunction'>;
+type ApplicationConfig = Omit<ApplicationManifest, 'packageJsonChecksum' | 'yarnLockChecksum' | 'postInstallLogicFunction' | 'preInstallLogicFunction' | 'defaultRoleUniversalIdentifier'> & {
+    /**
+     * @deprecated Use `defineApplicationRole()` in your role file instead.
+     */
+    defaultRoleUniversalIdentifier?: string;
+};
 
-type FrontComponentType = React.ComponentType<any>;
-type FrontComponentCommandConfig = Omit<FrontComponentCommandManifest, 'conditionalAvailabilityExpression'> & {
+type CommandMenuItemConfig = Omit<CommandMenuItemManifest, 'conditionalAvailabilityExpression'> & {
     conditionalAvailabilityExpression?: boolean | string;
 };
-type FrontComponentConfig = Omit<FrontComponentManifest, 'sourceComponentPath' | 'builtComponentPath' | 'builtComponentChecksum' | 'componentName' | 'usesSdkClient' | 'command'> & {
+
+type FrontComponentType = React.ComponentType<any>;
+type FrontComponentConfig = Omit<FrontComponentManifest, 'sourceComponentPath' | 'builtComponentPath' | 'builtComponentChecksum' | 'componentName' | 'usesSdkClient'> & {
     component: FrontComponentType;
-    command?: FrontComponentCommandConfig;
 };
 
 type LogicFunctionHandler = (...args: any[]) => any | Promise<any>;
-type LogicFunctionConfig = Omit<LogicFunctionManifest, 'sourceHandlerPath' | 'builtHandlerPath' | 'builtHandlerChecksum' | 'handlerName' | 'toolInputSchema'> & {
+type LogicFunctionConfig = Omit<LogicFunctionManifest, 'sourceHandlerPath' | 'builtHandlerPath' | 'builtHandlerChecksum' | 'handlerName'> & {
     handler: LogicFunctionHandler;
-    toolInputSchema?: InputJsonSchema;
 };
 
 type ObjectConfig = Omit<ObjectManifest, 'labelIdentifierFieldMetadataUniversalIdentifier'> & {
@@ -978,7 +1037,7 @@ type InstallPayload = {
 };
 type InstallHandler = (payload: InstallPayload) => any | Promise<any>;
 
-type PreInstallLogicFunctionConfig = Omit<LogicFunctionConfig, 'cronTriggerSettings' | 'databaseEventTriggerSettings' | 'httpRouteTriggerSettings' | 'isTool' | 'handler'> & {
+type PreInstallLogicFunctionConfig = Omit<LogicFunctionConfig, 'cronTriggerSettings' | 'databaseEventTriggerSettings' | 'httpRouteTriggerSettings' | 'toolTriggerSettings' | 'workflowActionTriggerSettings' | 'handler'> & {
     handler: InstallHandler;
     shouldRunOnVersionUpgrade?: boolean;
 };
@@ -997,8 +1056,9 @@ type ValidationResult<T> = {
     success: boolean;
     config: T;
     errors: string[];
+    warnings?: string[];
 };
-type DefinableEntity = ApplicationConfig | ObjectConfig | FieldManifest | FrontComponentConfig | LogicFunctionConfig | PostInstallLogicFunctionConfig | PreInstallLogicFunctionConfig | AgentManifest | RoleConfig | SkillManifest | ViewConfig | NavigationMenuItemManifest | PageLayoutConfig | PageLayoutTabConfig;
+type DefinableEntity = ApplicationConfig | ObjectConfig | FieldManifest | FrontComponentConfig | LogicFunctionConfig | PostInstallLogicFunctionConfig | PreInstallLogicFunctionConfig | AgentManifest | ConnectionProviderManifest | RoleConfig | SkillManifest | ViewConfig | NavigationMenuItemManifest | PageLayoutConfig | PageLayoutTabConfig | CommandMenuItemConfig;
 type DefineEntity<T extends DefinableEntity = DefinableEntity> = (config: T) => ValidationResult<T>;
 
 declare const defineAgent: DefineEntity<AgentManifest>;
@@ -1009,15 +1069,18 @@ type SyncableEntityOptions = {
     universalIdentifier: string;
 };
 
-declare const createValidationResult: <T>({ config, errors, }: {
+declare const createValidationResult: <T>({ config, errors, warnings, }: {
     config: T;
     errors: string[];
+    warnings?: string[];
 }) => ValidationResult<T>;
 
 declare const defineField: DefineEntity<FieldManifest>;
 
 declare const validateFields: (fields: ObjectFieldManifest[] | undefined) => string[];
 
+declare const defineCommandMenuItem: DefineEntity<CommandMenuItemConfig>;
+
 declare const defineFrontComponent: DefineEntity<FrontComponentConfig>;
 
 declare const defineLogicFunction: DefineEntity<LogicFunctionConfig>;
@@ -1147,6 +1210,8 @@ type WorkspaceEventBatch<WorkspaceEvent> = {
 };
 type DatabaseEventPayload<T = ObjectRecordEvent> = Omit<WorkspaceEventBatch<T>, 'events'> & T;
 
+declare const defineConnectionProvider: DefineEntity<ConnectionProviderManifest>;
+
 declare const defineNavigationMenuItem: DefineEntity<NavigationMenuItemManifest>;
 
 declare const defineObject: DefineEntity<ObjectConfig>;
@@ -2862,9 +2927,6 @@ declare const STANDARD_OBJECTS: {
             readonly messageThread: {
                 readonly universalIdentifier: "20202020-30f2-4ccd-9f5c-e41bb9d26214";
             };
-            readonly direction: {
-                readonly universalIdentifier: "20202020-0203-4118-8e2a-05b9bdae6dab";
-            };
             readonly subject: {
                 readonly universalIdentifier: "20202020-52d1-4036-b9ae-84bd722bb37a";
             };
@@ -4553,6 +4615,8 @@ declare const definePageLayout: DefineEntity<PageLayoutConfig>;
 
 declare const definePageLayoutTab: DefineEntity<PageLayoutTabConfig>;
 
+declare const defineApplicationRole: DefineEntity<RoleConfig>;
+
 declare const defineRole: DefineEntity<RoleConfig>;
 
 declare const defineSkill: DefineEntity<SkillManifest>;
@@ -4561,5 +4625,5 @@ declare const defineView: DefineEntity<ViewConfig>;
 
 declare const getPublicAssetUrl: (path: string) => string;
 
-export { AggregateOperations, DateDisplayFormat, FieldMetadataSettingsOnClickAction, FieldMetadataType as FieldType, HTTPMethod, NavigationMenuItemType, NumberDataType, ObjectRecordBaseEvent, ObjectRecordCreateEvent, ObjectRecordDeleteEvent, ObjectRecordDestroyEvent, ObjectRecordGroupByDateGranularity, ObjectRecordRestoreEvent, ObjectRecordUpdateEvent, ObjectRecordUpsertEvent, RelationOnDeleteAction as OnDeleteAction, PageLayoutTabLayoutMode, PermissionFlagType as PermissionFlag, RelationType, STANDARD_OBJECTS as STANDARD_OBJECT, STANDARD_OBJECTS as STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS, ViewCalendarLayout, ViewFilterGroupLogicalOperator, ViewFilterOperand, ViewKey, ViewOpenRecordIn, ViewSortDirection, ViewType, ViewVisibility, createValidationResult, defineAgent, defineApplication, defineField, defineFrontComponent, defineLogicFunction, defineNavigationMenuItem, defineObject, definePageLayout, definePageLayoutTab, definePostInstallLogicFunction, definePreInstallLogicFunction, defineRole, defineSkill, defineView, generateDefaultFieldUniversalIdentifier, getPublicAssetUrl, validateFields };
-export type { ActorMetadata as ActorField, AddressMetadata as AddressField, ApplicationConfig, CronPayload, CurrencyMetadata as CurrencyField, DatabaseEventPayload, DefinableEntity, DefineEntity, EmailsMetadata as EmailsField, FrontComponentCommandConfig, FrontComponentConfig, FrontComponentType, FullNameMetadata as FullNameField, GridPosition, InputJsonSchema, InstallHandler, InstallPayload, LinksMetadata as LinksField, LogicFunctionConfig, LogicFunctionHandler, ObjectRecordEvent, PageLayoutConfig, PageLayoutManifest, PageLayoutTabConfig, PageLayoutTabManifest, PageLayoutWidgetConditionalDisplay, PageLayoutWidgetManifest, PageLayoutWidgetUniversalConfiguration, PhonesMetadata as PhonesField, RichTextMetadata as RichTextField, LogicFunctionEvent as RoutePayload, SyncableEntityOptions, 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, PermissionFlagType as PermissionFlag, RelationType, STANDARD_OBJECTS as STANDARD_OBJECT, STANDARD_OBJECTS as STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS, ViewCalendarLayout, ViewFilterGroupLogicalOperator, ViewFilterOperand, ViewKey, ViewOpenRecordIn, ViewSortDirection, ViewType, ViewVisibility, createValidationResult, defineAgent, defineApplication, defineApplicationRole, defineCommandMenuItem, defineConnectionProvider, defineField, defineFrontComponent, defineLogicFunction, defineNavigationMenuItem, defineObject, definePageLayout, definePageLayoutTab, definePostInstallLogicFunction, definePreInstallLogicFunction, defineRole, defineSkill, defineView, generateDefaultFieldUniversalIdentifier, getPublicAssetUrl, 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, InputJsonSchema, InstallHandler, InstallPayload, LinksMetadata as LinksField, LogicFunctionConfig, LogicFunctionHandler, ObjectRecordEvent, PageLayoutConfig, PageLayoutManifest, PageLayoutTabConfig, PageLayoutTabManifest, PageLayoutWidgetConditionalDisplay, PageLayoutWidgetManifest, PageLayoutWidgetUniversalConfiguration, PhonesMetadata as PhonesField, RichTextMetadata as RichTextField, LogicFunctionEvent as RoutePayload, SyncableEntityOptions, ValidationResult, ViewConfig, ViewFieldGroupManifest, ViewFieldManifest, ViewFilterGroupManifest, ViewFilterManifest, ViewGroupManifest, ViewManifestFilterValue, ViewSortManifest };