@periskope/types 0.6.288-1 → 0.6.290

package/src/supabase.types.ts

@@ -1042,6 +1042,7 @@ export type Database = {
           created_at: string
           custom_properties: Json | null
           due_date: string | null
+          first_assigned_at: string | null
           freshdesk_metadata: Json | null
           hubspot_metadata: Json | null
           is_deleted: boolean
@@ -1066,6 +1067,7 @@ export type Database = {
           created_at?: string
           custom_properties?: Json | null
           due_date?: string | null
+          first_assigned_at?: string | null
           freshdesk_metadata?: Json | null
           hubspot_metadata?: Json | null
           is_deleted?: boolean
@@ -1092,6 +1094,7 @@ export type Database = {
           created_at?: string
           custom_properties?: Json | null
           due_date?: string | null
+          first_assigned_at?: string | null
           freshdesk_metadata?: Json | null
           hubspot_metadata?: Json | null
           is_deleted?: boolean
@@ -2392,6 +2395,7 @@ export type Database = {
           info_admins_only: boolean | null
           initiated_by: string | null
           invite_link: string | null
+          is_archived: boolean | null
           is_exited: boolean | null
           is_muted: boolean | null
           label_ids: Json | null
@@ -2402,6 +2406,7 @@ export type Database = {
           messages_admins_only: boolean | null
           org_id: string | null
           org_phone: string | null
+          parent_community_id: string | null
           pinned_messages: Json | null
           snooze_metadata: Json | null
           updated_at: string | null
@@ -2576,6 +2581,14 @@ export type Database = {
         }
         Returns: Json
       }
+      get_chat_workflow_info: {
+        Args: {
+          chat_id_input: string
+          org_id_input: string
+          org_phone_input: string
+        }
+        Returns: Json
+      }
       get_chats: {
         Args: {
           org_id_input: string
@@ -2660,6 +2673,16 @@ export type Database = {
         }
         Returns: Json
       }
+      get_message_workflow_info: {
+        Args: {
+          chat_id_input: string
+          org_id_input: string
+          org_phone_input: string
+          message_id_input: string
+          sender_id_input: string
+        }
+        Returns: Json
+      }
       get_messages_notifications_reactions: {
         Args: {
           org_id_input: string
@@ -2710,6 +2733,15 @@ export type Database = {
             }
         Returns: Json
       }
+      get_sender_workflow_info: {
+        Args: {
+          chat_id_input: string
+          org_id_input: string
+          org_phone_input: string
+          contact_id_input: string
+        }
+        Returns: Json
+      }
       get_team_metrics_between_dates: {
         Args: {
           org_id_input: string

package/src/types.ts

@@ -1,8 +1,7 @@
 import type { default as _Stripe } from 'stripe';
 import { Merge, OverrideProperties } from 'type-fest';
 import { Filter, Rule } from './rules.types';
-import { Enums, Tables, TablesInsert, TablesUpdate } from './supabase.types';
-import { WorkflowActionTypes } from './workflows.types';
+import { Tables, TablesInsert, TablesUpdate } from './supabase.types';
 
 /* ----------------------------- TYPE SHORTHANDS ---------------------------- */
 
@@ -812,6 +811,7 @@ export type TicketInfoType = {
     closed_at: string;
     closed_by: string;
     closed_message: string;
+    first_assigned_at: string | null;
   };
   attached_messages: {
     body: string;

package/src/workflows.types.ts

@@ -1,7 +1,8 @@
 import { Merge, OverrideProperties } from 'type-fest';
-import { AppendTypes } from './rules.types';
 import { Tables } from './supabase.types';
-import { ChatInfoType, TaskType } from './types';
+import { TaskType } from './types';
+import { AppendTypes } from './rules.types';
+
 
 /***************************** WORKFLOWS *****************************/
 
@@ -13,7 +14,7 @@ export type NormalWorkflowActions = {
 
 export type SplitPathActions = {
   id: string;
-  action_metadata: SplitPathAction;
+  action_metadata: SplitPathWorkflowAction;
 };
 
 export type WorkflowAction = NormalWorkflowActions | SplitPathActions;
@@ -210,17 +211,46 @@ export type WorkflowRawDataTypes = {
       members: string[];
     }
   >;
+  chat_label: Tables<'tbl_chat_properties'>;
   ticket: Tables<'tbl_chat_tickets'>;
   task: Tables<'tbl_org_tasks'>;
   sender: Tables<'tbl_contacts'> & Tables<'tbl_chat_participants'>;
 };
 
+export type GetMessageWorkflowDataTypes = {
+  message: WorkflowRawDataTypes['message'];
+  sender: WorkflowRawDataTypes['sender'];
+  chat: WorkflowRawDataTypes['chat'];
+};
+
+export type GetChatWorkflowDataTypes = {
+  chat: WorkflowRawDataTypes['chat'];
+};
+
+export type GetTicketWorkflowDataTypes = {
+  ticket: WorkflowRawDataTypes['ticket'];
+  message: WorkflowRawDataTypes['message'];
+  sender: WorkflowRawDataTypes['sender'];
+  chat: WorkflowRawDataTypes['chat'];
+};
+
+export type GetTaskWorkflowDataTypes = {
+  task: WorkflowRawDataTypes['task'];
+  associated_object: TaskType['associated_object_metadata'];
+};
+
+export type GetReactionWorkflowDataTypes = {
+  reaction: WorkflowRawDataTypes['reaction'];
+  sender: WorkflowRawDataTypes['sender'];
+  message: WorkflowRawDataTypes['message'];
+  chat: WorkflowRawDataTypes['chat'];
+};
+
 export type MessageWorkflowDataTypes = AppendTypes<
   {
     message: WorkflowRawDataTypes['message'];
     sender: WorkflowRawDataTypes['sender'];
     chat: WorkflowRawDataTypes['chat'];
-    ticket: WorkflowRawDataTypes['ticket'];
   },
   '.'
 >;
@@ -229,7 +259,8 @@ export type ReactionWorkflowDataTypes = AppendTypes<
   {
     reaction: WorkflowRawDataTypes['reaction'];
     sender: WorkflowRawDataTypes['sender'];
-    message: MessageWorkflowDataTypes;
+    message: WorkflowRawDataTypes['message'];
+    chat: WorkflowRawDataTypes['chat'];
   },
   '.'
 >;
@@ -237,7 +268,9 @@ export type ReactionWorkflowDataTypes = AppendTypes<
 export type TicketWorkflowDataTypes = AppendTypes<
   {
     ticket: WorkflowRawDataTypes['ticket'];
-    message: MessageWorkflowDataTypes;
+    message: WorkflowRawDataTypes['message'];
+    sender: WorkflowRawDataTypes['sender'];
+    chat: WorkflowRawDataTypes['chat'];
   },
   '.'
 >;
@@ -284,22 +317,22 @@ export type WorkflowDataType<T extends Triggers = Triggers> = T extends
   | Triggers.MESSAGE_UNFLAGGED
   ? MessageWorkflowDataTypes
   : T extends
-        | Triggers.CHAT_CREATED
-        | Triggers.CHAT_LABEL_UPDATED
-        | Triggers.CHAT_CLOSED
-    ? ChatWorkflowDataTypes
-    : T extends
-          | Triggers.TICKET_CREATED
-          | Triggers.TICKET_UPDATED
-          | Triggers.TICKET_DELETED
-          | Triggers.TICKET_CLOSED
-          | Triggers.TICKET_DUE
-      ? TicketWorkflowDataTypes
-      : T extends Triggers.REACTION_ADDED
-        ? ReactionWorkflowDataTypes
-        : T extends Triggers.TASK_CREATED | Triggers.TASK_DUE
-          ? TaskWorkflowDataTypes
-          : never;
+      | Triggers.CHAT_CREATED
+      | Triggers.CHAT_LABEL_UPDATED
+      | Triggers.CHAT_CLOSED
+  ? ChatWorkflowDataTypes
+  : T extends
+      | Triggers.TICKET_CREATED
+      | Triggers.TICKET_UPDATED
+      | Triggers.TICKET_DELETED
+      | Triggers.TICKET_CLOSED
+      | Triggers.TICKET_DUE
+  ? TicketWorkflowDataTypes
+  : T extends Triggers.REACTION_ADDED
+  ? ReactionWorkflowDataTypes
+  : T extends Triggers.TASK_CREATED | Triggers.TASK_DUE
+  ? TaskWorkflowDataTypes
+  : never;
 
 /***************************** ACTION TYPES *****************************/
 
@@ -311,32 +344,18 @@ export type SendMessageToChatWorkflowAction = {
       url: string;
       type: 'image' | 'video' | 'audio' | 'document';
       name: string;
-    };
-    is_reply?: boolean;
+    } | null;
     debounce?: `${number} ${'seconds' | 'minutes' | 'hours' | 'days'}` | null;
     chat_id: `${string}${'@g.us' | '@c.us'}` | 'trigger_chat' | null;
     unflag_chat?: boolean;
-  };
-};
-
-export type SendReplyWorkflowAction = {
-  type: 'send_reply_message';
-  metadata: {
-    message: string;
-    media?: {
-      url: string;
-      type: 'image' | 'video' | 'audio' | 'document';
-      name: string;
-    };
-    debounce?: `${number} ${'seconds' | 'minutes' | 'hours' | 'days'}` | null;
-    unflag_chat?: boolean;
+    as_reply?: boolean;
   };
 };
 
 export type CreateTicketWorkflowAction = {
   type: 'create_ticket';
   metadata: {
-    subject: string;
+    subject: string | null;
     assignee:
       | {
           round_robin: true;
@@ -344,13 +363,13 @@ export type CreateTicketWorkflowAction = {
           assignee_check_for?: 'shift_times' | 'online_offline' | 'all';
         }
       | {
-          email: string;
+          email: string | null;
           round_robin: false;
         };
     priority?: '0' | '1' | '2' | '3' | '4';
     status: 'open' | 'inprogress' | 'closed';
     labels: string[];
-    due_date: `${number} ${'seconds' | 'minutes' | 'hours' | 'days'}` | null;
+    due_in: `${number} ${'seconds' | 'minutes' | 'hours' | 'days'}` | null;
   };
 };
 
@@ -391,7 +410,7 @@ export type AssignTicketWorkflowAction = {
           assignee_check_for?: 'shift_times' | 'online_offline' | 'all';
         }
       | {
-          email: string;
+          email: string | null;
           round_robin: false;
         };
   };
@@ -443,7 +462,7 @@ export type AssignChatWorkflowAction = {
           assignee_check_for?: 'shift_times' | 'online_offline' | 'all';
         }
       | {
-          email: string;
+          email: string | null;
           round_robin: false;
         };
   };
@@ -452,7 +471,7 @@ export type AssignChatWorkflowAction = {
 export type ForwardMessageWorkflowAction = {
   type: 'forward_message';
   metadata: {
-    chat_id: `${string}${'@g.us' | '@c.us'}`;
+    chat_id: `${string}${'@g.us' | '@c.us'}` | null;
   };
 };
 
@@ -480,14 +499,14 @@ export type ValidateWorkflowAction = {
   metadata: WorkflowConditionGroup;
 };
 
-export type DelayAction = {
+export type DelayWorkflowAction = {
   type: 'delay';
   metadata: {
     delay: `${number} ${'seconds' | 'minutes' | 'hours' | 'days'}`;
   };
 };
 
-export type SendSlackNotification = {
+export type SendSlackNotificationWorkflowAction = {
   type: 'send_slack_notification';
   metadata: {
     slack_payload: string;
@@ -495,7 +514,7 @@ export type SendSlackNotification = {
   };
 };
 
-export type SplitPathAction = {
+export type SplitPathWorkflowAction = {
   type: 'split_path';
   metadata: {
     paths: Array<{
@@ -506,8 +525,8 @@ export type SplitPathAction = {
 };
 
 // experimental
-export type AIPromptCheckWorkflowAction = {
-  type: 'ai_prompt_check';
+export type AIPromptWorkflowAction = {
+  type: 'ai_prompt';
   metadata: {
     query: string;
     body: string;
@@ -516,7 +535,6 @@ export type AIPromptCheckWorkflowAction = {
 
 export type NormalWorkflowActionTypes =
   | SendMessageToChatWorkflowAction
-  | SendReplyWorkflowAction
   | CreateTicketWorkflowAction
   | AttachToLatestTicket
   | NotifyHTTPWorkflowAction
@@ -534,11 +552,200 @@ export type NormalWorkflowActionTypes =
   | DeleteMessageWorkflowAction
   | CloseChatWorkflowAction
   | ValidateWorkflowAction
-  | DelayAction
-  | SendSlackNotification
-  | AIPromptCheckWorkflowAction;
+  | DelayWorkflowAction
+  | SendSlackNotificationWorkflowAction
+  | AIPromptWorkflowAction;
+
+export type WorkflowActionsTypeMap = {
+  send_message_to_chat: SendMessageToChatWorkflowAction;
+  create_ticket: CreateTicketWorkflowAction;
+  attach_to_latest_ticket: AttachToLatestTicket;
+  notify_http: NotifyHTTPWorkflowAction;
+  flag_message: FlagMessageWorkflowAction;
+  unflag_message: UnflagMessageWorkflowAction;
+  assign_ticket: AssignTicketWorkflowAction;
+  close_ticket: CloseTicketWorkflowAction;
+  add_chat_label: AddChatLabelWorkflowAction;
+  remove_chat_label: RemoveChatLabelWorkflowAction;
+  add_ticket_label: AddTicketLabelWorkflowAction;
+  remove_ticket_label: RemoveTicketLabelWorkflowAction;
+  assign_chat: AssignChatWorkflowAction;
+  forward_message: ForwardMessageWorkflowAction;
+  send_email: SendEmailWorkflowAction;
+  delete_message: DeleteMessageWorkflowAction;
+  close_chat: CloseChatWorkflowAction;
+  validate_action: ValidateWorkflowAction;
+  delay: DelayWorkflowAction;
+  send_slack_notification: SendSlackNotificationWorkflowAction;
+  ai_prompt: AIPromptWorkflowAction;
+  split_path: SplitPathWorkflowAction;
+};
+
+export type WorkflowActionTypes =
+  | NormalWorkflowActionTypes
+  | SplitPathWorkflowAction;
+
+export type WorkflowActionCategory =
+  | 'message'
+  | 'ticket'
+  | 'chat'
+  | 'custom'
+  | 'flow'
+  | 'ai';
+
+export const ActionCategoryMap: Record<
+  WorkflowActionTypes['type'],
+  WorkflowActionCategory
+> = {
+  send_message_to_chat: 'message',
+  create_ticket: 'ticket',
+  attach_to_latest_ticket: 'ticket',
+  notify_http: 'custom',
+  flag_message: 'message',
+  unflag_message: 'message',
+  assign_ticket: 'ticket',
+  close_ticket: 'ticket',
+  add_chat_label: 'chat',
+  remove_chat_label: 'chat',
+  add_ticket_label: 'ticket',
+  remove_ticket_label: 'ticket',
+  assign_chat: 'chat',
+  forward_message: 'message',
+  send_email: 'custom',
+  delete_message: 'message',
+  close_chat: 'chat',
+  validate_action: 'flow',
+  delay: 'flow',
+  send_slack_notification: 'custom',
+  ai_prompt: 'ai',
+  split_path: 'flow',
+};
+
+export const CategoryNameMap: Record<WorkflowActionCategory, string> = {
+  message: 'Message',
+  ticket: 'Ticket',
+  chat: 'Chat',
+  custom: 'Custom',
+  flow: 'Flow',
+  ai: 'AI',
+};
 
-export type WorkflowActionTypes = NormalWorkflowActionTypes | SplitPathAction;
+export const TriggerNameMap: Record<Triggers, string> = {
+  'chat.closed': 'Chat Closed',
+  'chat.created': 'Chat Created',
+  'chat.label.updated': 'Chat Label Updated',
+  'message.created': 'Message Created',
+  'message.deleted': 'Message Deleted',
+  'message.flagged': 'Message Flagged',
+  'message.unflagged': 'Message Unflagged',
+  'message.updated': 'Message Updated',
+  'reaction.added': 'Reaction Added',
+  'ticket.closed': 'Ticket Closed',
+  'ticket.created': 'Ticket Created',
+  'ticket.deleted': 'Ticket Deleted',
+  'ticket.due': 'Ticket Due',
+  'ticket.updated': 'Ticket Updated',
+  'task.created': 'Task Created',
+  'task.due': 'Task Due',
+};
+
+export const WorkflowActionNameMap: Record<
+  WorkflowType['actions'][number]['action_metadata']['type'],
+  {
+    title: string;
+    description: string;
+  }
+> = {
+  add_chat_label: {
+    title: 'Add Chat Label',
+    description: 'Add a label to the trigger chat',
+  },
+  add_ticket_label: {
+    title: 'Add Ticket Label',
+    description: 'Add a label to the trigger ticket',
+  },
+  assign_chat: {
+    title: 'Assign Chat',
+    description: 'Assign a chat to org user',
+  },
+  attach_to_latest_ticket: {
+    title: 'Attach to Latest Ticket',
+    description: 'Attach to the latest ticket of trigger chat',
+  },
+  close_chat: {
+    title: 'Close Chat',
+    description: 'Close the chat',
+  },
+  close_ticket: {
+    title: 'Close Ticket',
+    description: 'Close the trigger ticket or ticket attached to the message',
+  },
+  create_ticket: {
+    title: 'Create Ticket',
+    description: 'Create a ticket attached to the trigger message',
+  },
+  delay: {
+    title: 'Delay',
+    description: 'Add a delay to next sequential actions',
+  },
+  ai_prompt: {
+    title: 'AI Prompt',
+    description: 'Analyse, filter, categorise, and generate text using AI',
+  },
+  flag_message: {
+    title: 'Flag Message',
+    description: 'Flag the trigger message or message attached to the ticket',
+  },
+  remove_chat_label: {
+    title: 'Remove Chat Label',
+    description: 'Remove a label from the trigger chat',
+  },
+  remove_ticket_label: {
+    title: 'Remove Ticket Label',
+    description:
+      'Remove a label from the trigger ticket or ticket attached to the message',
+  },
+  send_email: {
+    title: 'Send Email',
+    description: 'Send custom text to an email',
+  },
+  send_message_to_chat: {
+    title: 'Send Message to Chat',
+    description: 'Send a message to the chat attached to the trigger',
+  },
+  send_slack_notification: {
+    title: 'Send Slack Notification',
+    description: 'Send a slack notification',
+  },
+  split_path: {
+    title: 'Split Path',
+    description: 'Split the workflow path based on the condition',
+  },
+  unflag_message: {
+    title: 'Unflag Message',
+    description: 'Unflag the trigger message or message attached to the ticket',
+  },
+  validate_action: {
+    title: 'Validate Action',
+    description: 'Validate the action based on multiple criterias',
+  },
+  notify_http: {
+    title: 'Notify HTTP',
+    description: 'Send a custom HTTP request to an endpoint',
+  },
+  assign_ticket: {
+    title: 'Assign Ticket',
+    description: 'Assign a ticket to an org user',
+  },
+  forward_message: {
+    title: 'Forward Message',
+    description: 'Forward a message to a chat',
+  },
+  delete_message: {
+    title: 'Delete Message',
+    description: 'Delete the trigger message or message attached to the ticket',
+  },
+};
 
 export type SendMessageToChatActionReturnInfo = {
   message_details: {
@@ -574,54 +781,6 @@ export type ActionInfo = {
   add_chat_label: AddChatLabelActionReturnInfo;
 };
 
-export const TriggerNameMap: Record<Triggers, string> = {
-  'chat.closed': 'Chat Closed',
-  'chat.created': 'Chat Created',
-  'chat.label.updated': 'Chat Label Updated',
-  'message.created': 'Message Created',
-  'message.deleted': 'Message Deleted',
-  'message.flagged': 'Message Flagged',
-  'message.unflagged': 'Message Unflagged',
-  'message.updated': 'Message Updated',
-  'reaction.added': 'Reaction Added',
-  'ticket.closed': 'Ticket Closed',
-  'ticket.created': 'Ticket Created',
-  'ticket.deleted': 'Ticket Deleted',
-  'ticket.due': 'Ticket Due',
-  'ticket.updated': 'Ticket Updated',
-  'task.created': 'Task Created',
-  'task.due': 'Task Due',
-};
-
-export const WorkflowActionNameMap: Record<
-  WorkflowType['actions'][number]['action_metadata']['type'],
-  string
-> = {
-  add_chat_label: 'Add Chat Label',
-  add_ticket_label: 'Add Ticket Label',
-  assign_chat: 'Assign Chat',
-  assign_ticket: 'Assign Ticket',
-  attach_to_latest_ticket: 'Attach to Latest Ticket',
-  close_chat: 'Close Chat',
-  close_ticket: 'Close Ticket',
-  create_ticket: 'Create Ticket',
-  delete_message: 'Delete Message',
-  delay: 'Delay',
-  ai_prompt_check: 'AI Prompt',
-  flag_message: 'Flag Message',
-  forward_message: 'Forward Message',
-  notify_http: 'Notify HTTP',
-  remove_chat_label: 'Remove Chat Label',
-  remove_ticket_label: 'Remove Ticket Label',
-  send_email: 'Send Email',
-  send_message_to_chat: 'Send Message to Chat',
-  send_reply_message: 'Send Reply Message',
-  send_slack_notification: 'Send Slack Notification',
-  split_path: 'Split Path',
-  unflag_message: 'Unflag Message',
-  validate_action: 'Validate Action',
-};
-
 // Example workflow type ->
 
 // const demoWorkflow: WorkflowType = {

package/tsconfig.json

@@ -1,8 +1,9 @@
 {
   "extends": "../../tsconfig.json",
   "include": [
-    "src/**/*"
-    // "src/index.ts",
+    "src/**/*",
+    "src/index.ts",
+    "index.d.ts"
   ],
   "exclude": [
     "node_modules",