@periskope/types 0.6.261 → 0.6.263

package/src/types.ts

@@ -1,7 +1,8 @@
 import type { default as _Stripe } from 'stripe';
 import { Merge, OverrideProperties } from 'type-fest';
 import { Filter, Rule } from './rules.types';
-import { Tables, TablesInsert, TablesUpdate } from './supabase.types';
+import { Enums, Tables, TablesInsert, TablesUpdate } from './supabase.types';
+import { WorkflowActionTypes } from './workflows.types';
 
 /* ----------------------------- TYPE SHORTHANDS ---------------------------- */
 
@@ -64,7 +65,6 @@ export type MicrosurveyData = {
 
 export type OrgPreferences = {
   disable_ai_flagging?: boolean;
-  disable_ai_responder?: boolean;
   disable_allow_exports?: boolean;
   sync_phone_contacts?: boolean;
   mask_phone_numbers?: boolean;
@@ -1229,4 +1229,4 @@ export type FreshdeskCustomFieldType = {
   created_at: string;
   updated_at: string;
   choices?: Choice[];
-};
+};

package/src/workflows.types.ts

@@ -0,0 +1,692 @@
+import { Merge, OverrideProperties } from 'type-fest';
+import { AppendTypes } from './rules.types';
+import { Tables } from './supabase.types';
+import { TaskType } from './types';
+
+/***************************** WORKFLOWS *****************************/
+
+type WorkflowActions = {
+  id: string;
+  action_metadata: NormalWorkflowActionTypes;
+  next: string;
+};
+
+type SplitPathActions = {
+  id: string;
+  action_metadata: SplitPathAction;
+};
+
+export type WorkflowType = OverrideProperties<
+  Tables<'tbl_org_workflows'>,
+  {
+    trigger_metadata: {
+      org_phones: string[];
+      allow_internal_messages?: boolean;
+      first_action_id: string;
+    };
+    trigger: Triggers;
+    actions: Array<WorkflowActions | SplitPathActions>;
+  }
+>;
+
+export function isSplitPathAction(
+  workflow_action: WorkflowType['actions'][number]
+): workflow_action is SplitPathActions {
+  return workflow_action.action_metadata.type === 'split_path';
+}
+
+/***************************** CONDITIONS TYPES *****************************/
+
+// {
+//   "operator": "AND",
+//   "conditions": [
+//     {
+//       "id": "cond1",
+//       "variable_name": "message",
+//       "variable_type": "string",
+//       "condition": "CONTAINS",
+//       "value": "urgent"
+//     },
+//     {
+//       "operator": "OR",
+//       "conditions": [
+//         {
+//           "id": "cond2",
+//           "variable_name": "priority",
+//           "variable_type": "number",
+//           "condition": "GT",
+//           "value": 2
+//         },
+//         {
+//           "id": "cond3",
+//           "variable_name": "assigned",
+//           "variable_type": "boolean",
+//           "condition": "NKNOWN"
+//         }
+//       ]
+//     }
+//   ]
+// }
+
+enum Conditions {
+  // string
+  CONTAINS = 'contains',
+  NCONTAINS = 'not contains',
+  EQUALS = 'equals',
+  NEQUALS = 'not equals',
+  STARTS_WITH = 'starts with',
+  ENDS_WITH = 'ends with',
+
+  // number, date, time
+  GREATER_THAN = 'greater than',
+  GREATER_THAN_OR_EQUAL = 'greater than or equal',
+  LESS_THAN = 'less than',
+  LESS_THAN_OR_EQUAL = 'less than or equal',
+
+  // none
+  IS_KNOWN = 'is known',
+  IS_UNKNOWN = 'is unknown',
+
+  // boolean
+  IS = 'is',
+  IS_NOT = 'is not',
+
+  // array
+  IS_ANY_OF = 'is any of',
+  IS_NOT_ANY_OF = 'is not any of',
+
+  // day
+  ON = 'on',
+}
+
+type BaseCondition<T extends Triggers> = {
+  id: string;
+  variable_name: keyof WorkflowDataType<T>;
+};
+
+type StringCondition = BaseCondition<Triggers> & {
+  condition:
+    | 'CONTAINS'
+    | 'NCONTAINS'
+    | 'EQUALS'
+    | 'NEQUALS'
+    | 'STARTS_WITH'
+    | 'ENDS_WITH';
+  value: string;
+  variable_type: 'string';
+};
+
+type DateTimeNumberCondition = BaseCondition<Triggers> & {
+  condition:
+    | 'GREATER_THAN'
+    | 'GREATER_THAN_OR_EQUAL'
+    | 'LESS_THAN'
+    | 'LESS_THAN_OR_EQUAL';
+} & (
+    | {
+        value: string;
+        variable_type: 'number';
+      }
+    | {
+        value: string;
+        timezone: string;
+        variable_type: 'date' | 'time';
+      }
+  );
+
+type ExistsCondition = BaseCondition<Triggers> & {
+  condition: 'IS_KNOWN' | 'IS_UNKNOWN';
+  value: undefined | null;
+  variable_type: null;
+};
+
+type OnCondition = BaseCondition<Triggers> & {
+  condition: 'ON';
+  value: string | string[];
+  timezone: string;
+  variable_type: 'day';
+};
+
+type BooleanCondition = BaseCondition<Triggers> & {
+  condition: 'IS' | 'IS_NOT';
+  value: boolean | 'true' | 'false';
+  variable_type: 'boolean';
+};
+
+type ArrayCondition = BaseCondition<Triggers> & {
+  condition: 'IS_ANY_OF' | 'IS_NOT_ANY_OF';
+  value: string[];
+  variable_type: 'array';
+};
+
+export type ConditionLeaf =
+  | StringCondition
+  | DateTimeNumberCondition
+  | ExistsCondition
+  | OnCondition
+  | BooleanCondition
+  | ArrayCondition;
+
+type ConditionOperator = 'AND' | 'OR';
+
+export type WorkflowConditionGroup = {
+  operator: ConditionOperator;
+  conditions: Array<ConditionLeaf | WorkflowConditionGroup>;
+};
+
+export function isConditionLeaf(
+  condition: ConditionLeaf | WorkflowConditionGroup
+): condition is ConditionLeaf {
+  return 'id' in condition && !('operator' in condition);
+}
+
+/***************************** WORKFLOW DATA TYPES *****************************/
+
+export type WorkflowRawDataTypes = {
+  message: Tables<'tbl_chat_messages'>;
+  reaction: Tables<'tbl_chat_reactions'>;
+  chat: Merge<
+    Merge<Tables<'tbl_chats'>, Tables<'tbl_chat_properties'>>,
+    {
+      has_flagged_messages: boolean;
+      last_message_self: boolean;
+      members: string[];
+    }
+  >;
+  ticket: Tables<'tbl_chat_tickets'>;
+  task: Tables<'tbl_org_tasks'>;
+  sender: Tables<'tbl_contacts'> & Tables<'tbl_chat_participants'>;
+};
+
+export type MessageWorkflowDataTypes = AppendTypes<
+  {
+    message: WorkflowRawDataTypes['message'];
+    sender: WorkflowRawDataTypes['sender'];
+    chat: WorkflowRawDataTypes['chat'];
+    ticket: WorkflowRawDataTypes['ticket'];
+  },
+  '.'
+>;
+
+export type ReactionWorkflowDataTypes = AppendTypes<
+  {
+    reaction: WorkflowRawDataTypes['reaction'];
+    sender: WorkflowRawDataTypes['sender'];
+    message: MessageWorkflowDataTypes;
+  },
+  '.'
+>;
+
+export type TicketWorkflowDataTypes = AppendTypes<
+  {
+    ticket: WorkflowRawDataTypes['ticket'];
+    message: MessageWorkflowDataTypes;
+  },
+  '.'
+>;
+
+export type TaskWorkflowDataTypes = AppendTypes<
+  {
+    task: WorkflowRawDataTypes['task'];
+    associated_object: TaskType['associated_object_metadata'];
+  },
+  '.'
+>;
+
+export type ChatWorkflowDataTypes = AppendTypes<
+  {
+    chat: WorkflowRawDataTypes['chat'];
+  },
+  '.'
+>;
+
+export enum Triggers {
+  MESSAGE_CREATED = 'message.created',
+  MESSAGE_UPDATED = 'message.updated',
+  MESSAGE_DELETED = 'message.deleted',
+  MESSAGE_FLAGGED = 'message.flagged',
+  MESSAGE_UNFLAGGED = 'message.unflagged',
+  REACTION_ADDED = 'reaction.added',
+  TICKET_CREATED = 'ticket.created',
+  TICKET_UPDATED = 'ticket.updated',
+  TICKET_DELETED = 'ticket.deleted',
+  TICKET_CLOSED = 'ticket.closed',
+  TICKET_DUE = 'ticket.due',
+  CHAT_CREATED = 'chat.created',
+  CHAT_LABEL_UPDATED = 'chat.label.updated',
+  CHAT_CLOSED = 'chat.closed',
+  TASK_CREATED = 'task.created',
+  TASK_DUE = 'task.due',
+}
+
+export type WorkflowDataType<T extends Triggers> = T extends
+  | Triggers.MESSAGE_CREATED
+  | Triggers.MESSAGE_DELETED
+  | Triggers.MESSAGE_UPDATED
+  | Triggers.MESSAGE_FLAGGED
+  | 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;
+
+/***************************** ACTION TYPES *****************************/
+
+export type SendMessageToChatWorkflowAction = {
+  type: 'send_message_to_chat';
+  metadata: {
+    message: string;
+    media?: {
+      url: string;
+      type: 'image' | 'video' | 'audio' | 'document';
+      name: string;
+    };
+    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;
+  };
+};
+
+export type CreateTicketWorkflowAction = {
+  type: 'create_ticket';
+  metadata: {
+    subject: string;
+    assignee:
+      | {
+          round_robin: true;
+          emails: string[];
+          assignee_check_for?: 'shift_times' | 'online_offline' | 'all';
+        }
+      | {
+          email: string;
+        };
+    priority?: '0' | '1' | '2' | '3' | '4';
+    status: 'open' | 'inprogress' | 'closed';
+    labels: string[];
+    due_date: `${number} ${'seconds' | 'minutes' | 'hours' | 'days'}` | null;
+  };
+};
+
+export type AttachToLatestTicket = {
+  type: 'attach_to_latest_ticket';
+  metadata: {
+    status: ('open' | 'inprogress' | 'closed')[];
+  };
+};
+
+export type NotifyHTTPWorkflowAction = {
+  type: 'notify_http';
+  metadata: {
+    url: string;
+    method: 'GET' | 'POST' | 'PUT' | 'DELETE';
+    headers: Record<string, string>;
+    body: string;
+  };
+};
+
+export type FlagMessageWorkflowAction = {
+  type: 'flag_message';
+  metadata: {};
+};
+
+export type UnflagMessageWorkflowAction = {
+  type: 'unflag_message';
+  metadata: {};
+};
+
+export type AssignTicketWorkflowAction = {
+  type: 'assign_ticket';
+  metadata: {
+    assignee:
+      | {
+          round_robin: true;
+          emails: string[];
+          assignee_check_for?: 'shift_times' | 'online_offline' | 'all';
+        }
+      | {
+          email: string;
+        };
+  };
+};
+
+export type CloseTicketWorkflowAction = {
+  type: 'close_ticket';
+  metadata: {
+    bypass_mandatory_fields?: boolean;
+    closing_note: string;
+  };
+};
+
+export type AddChatLabelWorkflowAction = {
+  type: 'add_chat_label';
+  metadata: {
+    labels: string[];
+  };
+};
+
+export type RemoveChatLabelWorkflowAction = {
+  type: 'remove_chat_label';
+  metadata: {
+    labels: string[];
+  };
+};
+
+export type AddTicketLabelWorkflowAction = {
+  type: 'add_ticket_label';
+  metadata: {
+    labels: string[];
+  };
+};
+
+export type RemoveTicketLabelWorkflowAction = {
+  type: 'remove_ticket_label';
+  metadata: {
+    labels: string[];
+  };
+};
+
+export type AssignChatWorkflowAction = {
+  type: 'assign_chat';
+  metadata: {
+    assignee:
+      | {
+          round_robin: true;
+          emails: string[];
+          assignee_check_for?: 'shift_times' | 'online_offline' | 'all';
+        }
+      | {
+          email: string;
+        };
+  };
+};
+
+export type ForwardMessageWorkflowAction = {
+  type: 'forward_message';
+  metadata: {
+    chat_id: `${string}${'@g.us' | '@c.us'}`;
+  };
+};
+
+export type SendEmailWorkflowAction = {
+  type: 'send_email';
+  metadata: {
+    email: string;
+    subject: string;
+    body: string;
+  };
+};
+
+export type DeleteMessageWorkflowAction = {
+  type: 'delete_message';
+  metadata: {};
+};
+
+export type CloseChatWorkflowAction = {
+  type: 'close_chat';
+  metadata: {};
+};
+
+export type ValidateWorkflowAction = {
+  type: 'validate_action';
+  metadata: WorkflowConditionGroup;
+};
+
+export type DelayAction = {
+  type: 'delay';
+  metadata: {
+    delay: `${number} ${'seconds' | 'minutes' | 'hours' | 'days'}`;
+  };
+};
+
+export type SendSlackNotification = {
+  type: 'send_slack_notification';
+  metadata: {
+    slack_payload: string;
+    url: string;
+  };
+};
+
+export type SplitPathAction = {
+  type: 'split_path';
+  metadata: {
+    paths: Array<{
+      id: string;
+      condition_action_id: string;
+    }>;
+  };
+};
+
+// experimental
+export type AIPromptCheckWorkflowAction = {
+  type: 'ai_prompt_check';
+  metadata: {
+    query: string;
+    body: string;
+  };
+};
+
+export type NormalWorkflowActionTypes =
+  | SendMessageToChatWorkflowAction
+  | SendReplyWorkflowAction
+  | CreateTicketWorkflowAction
+  | AttachToLatestTicket
+  | NotifyHTTPWorkflowAction
+  | FlagMessageWorkflowAction
+  | UnflagMessageWorkflowAction
+  | AssignTicketWorkflowAction
+  | CloseTicketWorkflowAction
+  | AddChatLabelWorkflowAction
+  | RemoveChatLabelWorkflowAction
+  | AddTicketLabelWorkflowAction
+  | RemoveTicketLabelWorkflowAction
+  | AssignChatWorkflowAction
+  | ForwardMessageWorkflowAction
+  | SendEmailWorkflowAction
+  | DeleteMessageWorkflowAction
+  | CloseChatWorkflowAction
+  | ValidateWorkflowAction
+  | DelayAction
+  | SendSlackNotification
+  | AIPromptCheckWorkflowAction;
+
+export type WorkflowActionTypes = NormalWorkflowActionTypes | SplitPathAction;
+
+
+// Example workflow type -> 
+
+// const demoWorkflow: WorkflowType = {
+//   id: 'workflow-1',
+//   name: 'Urgent Chat Auto-Responder',
+//   trigger: Triggers.MESSAGE_CREATED,
+//   trigger_metadata: {
+//     org_phones: ['phone-1'],
+//     allow_internal_messages: false,
+//     first_action_id: 'action-validate',
+//   },
+//   actions: [
+//     {
+//       id: 'action-validate',
+//       action_metadata: {
+//         type: 'validate_action',
+//         metadata: {
+//           operator: 'AND',
+//           conditions: [
+//             {
+//               id: 'cond-1',
+//               variable_name: 'message.text',
+//               variable_type: 'string',
+//               condition: 'CONTAINS',
+//               value: 'urgent',
+//             },
+//             {
+//               id: 'cond-2',
+//               variable_name: 'chat.assigned',
+//               variable_type: 'boolean',
+//               condition: 'IS',
+//               value: false,
+//             },
+//           ],
+//         },
+//       },
+//       next: 'action-add-label',
+//     },
+//     {
+//       id: 'action-add-label',
+//       action_metadata: {
+//         type: 'add_chat_label',
+//         metadata: {
+//           labels: ['urgent'],
+//         },
+//       },
+//       next: 'action-assign-chat',
+//     },
+//     {
+//       id: 'action-assign-chat',
+//       action_metadata: {
+//         type: 'assign_chat',
+//         metadata: {
+//           assignee: {
+//             round_robin: true,
+//             emails: ['agent1@example.com', 'agent2@example.com'],
+//             assignee_check_for: 'all',
+//           },
+//         },
+//       },
+//       next: 'action-delay',
+//     },
+//     {
+//       id: 'action-delay',
+//       action_metadata: {
+//         type: 'delay',
+//         metadata: {
+//           delay: '5 minutes',
+//         },
+//       },
+//       next: 'action-send-message',
+//     },
+//     {
+//       id: 'action-send-message',
+//       action_metadata: {
+//         type: 'send_message_to_chat',
+//         metadata: {
+//           message: 'We’re on it!',
+//           chat_id: 'trigger_chat',
+//         },
+//       },
+//       next: 'action-split',
+//     },
+//     {
+//       id: 'action-split',
+//       action_metadata: {
+//         type: 'split_path',
+//         metadata: {
+//           paths: [
+//             {
+//               id: 'path-flagged',
+//               condition_action_id: 'action-condition-flagged',
+//             },
+//             {
+//               id: 'path-not-flagged',
+//               condition_action_id: 'action-condition-not-flagged',
+//             },
+//           ],
+//         },
+//     },
+//     {
+//       id: 'action-condition-flagged',
+//       action_metadata: {
+//         type: 'validate_action',
+//         metadata: {
+//           operator: 'AND',
+//           conditions: [
+//             {
+//               id: 'cond-flagged',
+//               variable_name: 'chat.has_flagged_messages',
+//               variable_type: 'boolean',
+//               condition: 'IS',
+//               value: true,
+//             },
+//           ],
+//         },
+//       },
+//       next: 'action-create-ticket',
+//     },
+//     {
+//       id: 'action-condition-not-flagged',
+//       action_metadata: {
+//         type: 'validate_action',
+//         metadata: {
+//           operator: 'AND',
+//           conditions: [
+//             {
+//               id: 'cond-unflagged',
+//               variable_name: 'chat.has_flagged_messages',
+//               variable_type: 'boolean',
+//               condition: 'IS',
+//               value: false,
+//             },
+//           ],
+//         },
+//       },
+//       next: 'action-send-slack',
+//     },
+//     {
+//       id: 'action-create-ticket',
+//       action_metadata: {
+//         type: 'create_ticket',
+//         metadata: {
+//           subject: 'Urgent Chat Follow-up',
+//           assignee: {
+//             email: 'manager@example.com',
+//           },
+//           priority: '4',
+//           status: 'open',
+//           labels: ['urgent', 'auto-created'],
+//           due_date: '30 minutes',
+//         },
+//       },
+//       next: '', // End
+//     },
+//     {
+//       id: 'action-send-slack',
+//       action_metadata: {
+//         type: 'send_slack_notification',
+//         metadata: {
+//           slack_payload: JSON.stringify({
+//             text: 'An urgent chat was received, no flagged messages.',
+//           }),
+//           url: 'https://hooks.slack.com/services/XXX/YYY/ZZZ',
+//         },
+//       },
+//       next: '', // End
+//     },
+//   ],
+// };