twenty-sdk 2.31.0 → 2.35.0

package/dist/logic-function/index.d.ts

@@ -62,6 +62,15 @@ type EnqueueJobResult = {
     enqueued: boolean;
     logicFunctionUniversalIdentifier: string;
 };
+type EnqueueJobsInput = EnqueueJobOptions & {
+    logicFunctionUniversalIdentifier: string;
+    payloads: Record<string, unknown>[];
+};
+type EnqueueJobsResult = {
+    enqueued: boolean;
+    logicFunctionUniversalIdentifier: string;
+    enqueuedJobsCount: number;
+};
 
 declare enum HTTPMethod {
     GET = "GET",
@@ -96,6 +105,7 @@ type LogicFunctionHttpResponse = {
 
 type ServerRouteTriggerSettings = {
     forwardedRequestHeaders?: string[];
+    httpMethods?: (HTTPMethod | `${HTTPMethod}`)[];
 };
 
 type InputJsonSchema = {
@@ -122,6 +132,18 @@ type NodeType = 'object' | 'unknown';
 
 declare const jsonSchemaToInputSchema: (jsonSchema: InputJsonSchema) => InputSchema;
 
+type LogicFunctionExecutionContext = {
+    retryCount: number;
+    maxRetries: number;
+    workspaceId: string;
+    userWorkspaceId: string | null;
+    workspaceMemberId: string | null;
+};
+
+declare class RetryableLogicFunctionError extends Error {
+    constructor(message: string);
+}
+
 type RecordSchemaType = 'record' | 'records';
 type InputSchemaPropertyType = LeafType | NodeType | RecordSchemaType | FieldMetadataType;
 type InputSchemaProperty = {
@@ -174,6 +196,20 @@ type HttpRouteTriggerSettings = {
     forwardedRequestHeaders?: string[];
 };
 
+declare const TIMELINE_ACTIVITY_ACTIONS: readonly ["created", "updated", "deleted", "restored", "linked", "unlinked"];
+type TimelineActivityAction = (typeof TIMELINE_ACTIVITY_ACTIONS)[number];
+
+type TimelineActivityTypeSnapshot = {
+    id: string;
+    universalIdentifier: string;
+    name: string;
+    label: string;
+    action: TimelineActivityAction | null;
+    icon: string | null;
+    objectUniversalIdentifier: string | null;
+    frontComponentUniversalIdentifier: string | null;
+};
+
 type RunAgentMessageRole = 'user' | 'assistant';
 type RunAgentMessage = {
     role: RunAgentMessageRole;
@@ -201,9 +237,9 @@ type ServerRouteDispatchResult = {
     payload?: object;
 };
 
-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;
@@ -361,8 +397,35 @@ declare class AppConnectionAuthFailedError extends Error {
 
 declare const runAgent: (input: RunAgentInput) => Promise<RunAgentResult>;
 
+/**
+ * @deprecated Use `enqueueJobs` instead.
+ */
 declare const enqueueJob: (input: EnqueueJobInput) => Promise<EnqueueJobResult>;
 
+declare const enqueueJobs: (input: EnqueueJobsInput) => Promise<EnqueueJobsResult>;
+
+type CreateTimelineActivityBaseInput = {
+    timelineActivityTypeUniversalIdentifier: string;
+    targetObjectUniversalIdentifier: string;
+    targetRecordId: string;
+    happensAt?: string;
+    properties?: Record<string, unknown>;
+};
+type CreateTimelineActivityLinkedRecordInput = {
+    linkedRecordId: string;
+    linkedObjectMetadataUniversalIdentifier: string;
+} | {
+    linkedRecordId?: never;
+    linkedObjectMetadataUniversalIdentifier?: never;
+};
+type CreateTimelineActivityInput = CreateTimelineActivityBaseInput & CreateTimelineActivityLinkedRecordInput;
+type CreatedTimelineActivity = {
+    id: string;
+    timelineActivityTypeId: string;
+    timelineActivityTypeSnapshot: TimelineActivityTypeSnapshot;
+};
+declare const createTimelineActivity: ({ timelineActivityTypeUniversalIdentifier, targetObjectUniversalIdentifier, linkedObjectMetadataUniversalIdentifier, targetRecordId, ...input }: CreateTimelineActivityInput) => Promise<CreatedTimelineActivity>;
+
 type KvOptions = {
     scope?: AppKeyValueScope;
 };
@@ -384,5 +447,5 @@ declare class Response implements LogicFunctionHttpResponse {
     constructor(body: unknown, init?: ResponseInit);
 }
 
-export { AppConnectionAuthFailedError, ObjectRecordBaseEvent, ObjectRecordCreateEvent, ObjectRecordDeleteEvent, ObjectRecordDestroyEvent, ObjectRecordRestoreEvent, ObjectRecordUpdateEvent, ObjectRecordUpsertEvent, Response, enqueueJob, findConnectionForRequest, getConnection, jsonSchemaToInputSchema, kv, listConnections, runAgent };
-export type { AppConnection, AppKeyValue, AppKeyValueScope, CronPayload, DatabaseEventPayload, EnqueueJobInput, EnqueueJobOptions, EnqueueJobResult, InputJsonSchema, InstallHandler, InstallPayload, ListConnectionsFilter, LogicFunctionConfig, LogicFunctionHandler, ObjectRecordEvent, ResponseInit, LogicFunctionEvent as RoutePayload, RunAgentInput, RunAgentResult, ServerRouteDispatchResult, ServerRouteResolverResult, UninstallHandler, UninstallPayload };
+export { AppConnectionAuthFailedError, ObjectRecordBaseEvent, ObjectRecordCreateEvent, ObjectRecordDeleteEvent, ObjectRecordDestroyEvent, ObjectRecordRestoreEvent, ObjectRecordUpdateEvent, ObjectRecordUpsertEvent, Response, RetryableLogicFunctionError, createTimelineActivity, enqueueJob, enqueueJobs, findConnectionForRequest, getConnection, jsonSchemaToInputSchema, kv, listConnections, runAgent };
+export type { AppConnection, AppKeyValue, AppKeyValueScope, CreateTimelineActivityInput, CreatedTimelineActivity, CronPayload, DatabaseEventPayload, EnqueueJobInput, EnqueueJobOptions, EnqueueJobResult, EnqueueJobsInput, EnqueueJobsResult, InputJsonSchema, InstallHandler, InstallPayload, ListConnectionsFilter, LogicFunctionConfig, LogicFunctionExecutionContext, LogicFunctionHandler, ObjectRecordEvent, ResponseInit, LogicFunctionEvent as RoutePayload, RunAgentInput, RunAgentResult, ServerRouteDispatchResult, ServerRouteResolverResult, UninstallHandler, UninstallPayload };