@periskope/types 0.6.147 → 0.6.149

package/rules.types.ts

@@ -113,7 +113,7 @@ export interface Filter {
     | 'NIS'; // Add other condition types as needed
   variable: string;
   value: string | string[];
-  variable_type?: 'string' | 'date'; // Optional, like 'Date'
+  variable_type?: 'string' | 'number' | 'boolean' | 'day-time' | 'date' | 'day'; // Optional, like 'Date'
 }
 
 export const isFilter = (filter: any): filter is Filter => {
@@ -185,12 +185,20 @@ export const FilterNameMap: Record<
 
 export type VariableNameValueType = {
   text: string;
-  type: 'string' | 'time' | 'boolean' | 'dropdown' | 'day-time' | 'number';
+  type:
+    | 'string'
+    | 'time'
+    | 'boolean'
+    | 'dropdown'
+    | 'day-time'
+    | 'number'
+    | 'date';
+  variable_type: 'string' | 'number' | 'boolean' | 'day-time' | 'date';
   value?:
     | string
     | {
         id: string;
-        value: string;
+        value: string | number | boolean;
         label: string;
       }[]
     | null;
@@ -208,63 +216,73 @@ export const MessageVariableNameMap: Record<
     type: 'string',
     filters: ['CONTAINS', 'NCONTAINS', 'EQ', 'NEQ', 'KNOWN', 'NKNOWN'],
     placeholder: 'e.g. Test message',
+    variable_type: 'string',
   },
   'message.sender_phone': {
     text: 'Message Sender Phone',
     type: 'string',
     filters: ['EQ', 'NEQ'],
-    placeholder: 'e.g. 919876543210@c.us',
+    placeholder: 'e.g. 919876543210',
+    variable_type: 'string',
   },
   'message.timestamp': {
     text: 'Message Timestamp',
     type: 'day-time',
     filters: ['LT', 'LTE', 'GT', 'GTE', 'IS'],
+    variable_type: 'day-time',
   },
   'message.flag_status': {
     text: 'Message Flag Status',
     filters: ['IS'],
     type: 'boolean',
-
+    variable_type: 'boolean',
   },
   'message.has_quoted_msg': {
     text: 'Quoted Message',
     filters: ['IS'],
     type: 'boolean',
+    variable_type: 'boolean',
   },
   'message.media': {
     text: 'Message Media',
     type: 'boolean',
     filters: ['KNOWN', 'NKNOWN'],
+    variable_type: 'boolean',
   },
   'message.performed_by': {
     text: 'Message Performed By',
     type: 'dropdown',
     value: 'org.members',
     filters: ['EQ', 'NEQ'],
+    variable_type: 'string',
   },
   'message.chat_id': {
     text: 'Chat ID',
     type: 'string',
     filters: ['EQ', 'NEQ'],
     hidden: true,
+    variable_type: 'string',
   },
   'message.message_id': {
     text: 'Message ID',
     type: 'string',
     filters: ['EQ', 'NEQ'],
     hidden: true,
+    variable_type: 'string',
   },
   'message.org_phone': {
     text: 'Org Phone',
     type: 'string',
     filters: ['EQ', 'NEQ'],
     hidden: true,
+    variable_type: 'string',
   },
   'message.org_id': {
     text: 'Org ID',
     type: 'string',
     filters: ['EQ', 'NEQ'],
     hidden: true,
+    variable_type: 'string',
   },
   'message.message_type': {
     text: 'Message Type',
@@ -277,23 +295,26 @@ export const MessageVariableNameMap: Record<
       { id: 'document', value: 'document', label: 'Document' },
     ],
     filters: ['EQ', 'NEQ'],
+    variable_type: 'string',
   },
   'message.author': {
     text: 'Message Author',
     type: 'string',
     filters: ['EQ', 'NEQ'],
     hidden: true,
+    variable_type: 'string',
   },
   'message.ack': {
     text: 'Message acknowledment status',
     type: 'dropdown',
     value: [
-      { id: '0', value: '0', label: '0' },
-      { id: '1', value: '1', label: '1' },
-      { id: '2', value: '2', label: '2' },
-      { id: '3', value: '3', label: '3' },
+      { id: '0', value: 0, label: '0' },
+      { id: '1', value: 1, label: '1' },
+      { id: '2', value: 2, label: '2' },
+      { id: '3', value: 3, label: '3' },
     ],
     filters: ['EQ'],
+    variable_type: 'number',
   },
 };
 
@@ -305,40 +326,47 @@ export const SenderVariableNameMap: Record<
     text: 'Sender is business',
     type: 'boolean',
     filters: ['IS'],
+    variable_type: 'boolean',
   },
   'sender.is_enterprise': {
     text: 'Sender is enterprise',
     type: 'boolean',
     filters: ['IS'],
+    variable_type: 'boolean',
   },
   'sender.is_internal': {
     text: 'Sender is internal',
     type: 'boolean',
     filters: ['IS'],
+    variable_type: 'boolean',
   },
   'sender.contact_name': {
     text: 'Sender Name',
     type: 'string',
     filters: ['EQ', 'NEQ', 'KNOWN', 'NKNOWN'],
     placeholder: 'e.g. John Doe',
+    variable_type: 'string',
   },
   'sender.contact_id': {
     text: 'Sender Contact Phone',
     type: 'string',
     filters: ['EQ', 'NEQ'],
-    placeholder: 'e.g. 919876543210@c.us'
+    placeholder: 'e.g. 919876543210',
+    variable_type: 'string',
   },
   'sender.labels': {
     text: 'Sender Labels',
     type: 'dropdown',
     value: 'org.labels',
     filters: ['EQ', 'NEQ'],
+    variable_type: 'string',
   },
   'sender.org_id': {
     text: 'Org ID',
     type: 'string',
     filters: ['EQ', 'NEQ'],
     hidden: true,
+    variable_type: 'string',
   },
   'sender.is_super_admin': {
     text: 'Sender is super admin',
@@ -347,15 +375,16 @@ export const SenderVariableNameMap: Record<
     value: [
       {
         id: 'true',
-        value: 'true',
+        value: true,
         label: 'True',
       },
       {
         id: 'false',
-        value: 'false',
+        value: false,
         label: 'False',
       },
     ],
+    variable_type: 'boolean',
   },
   'sender.is_admin': {
     text: 'Sender is admin',
@@ -364,15 +393,16 @@ export const SenderVariableNameMap: Record<
     value: [
       {
         id: 'true',
-        value: 'true',
+        value: true,
         label: 'True',
       },
       {
         id: 'false',
-        value: 'false',
+        value: false,
         label: 'False',
       },
     ],
+    variable_type: 'boolean',
   },
 };
 
@@ -385,18 +415,21 @@ export const ChatVariableNameMap: Record<
     type: 'dropdown',
     value: 'org.members',
     filters: ['EQ', 'NEQ', 'KNOWN', 'NKNOWN'],
+    variable_type: 'string',
   },
   'chat.chat_name': {
     text: 'Chat Name',
     type: 'string',
-    filters: ['EQ', 'NEQ'],
+    filters: ['EQ', 'NEQ', 'CONTAINS', 'NCONTAINS'],
     placeholder: 'e.g. Support Chat',
+    variable_type: 'string',
   },
   'chat.org_phone': {
     text: 'Chat Org Phone',
     type: 'dropdown',
     value: 'org.org_phones',
     filters: ['EQ', 'NEQ'],
+    variable_type: 'string',
   },
   'chat.chat_type': {
     text: 'Chat Type',
@@ -406,36 +439,42 @@ export const ChatVariableNameMap: Record<
       { id: 'group', value: 'group', label: 'Group' },
     ],
     filters: ['EQ', 'NEQ'],
+    variable_type: 'string',
   },
   'chat.members': {
     text: 'Chat Members',
     type: 'string',
     filters: ['CONTAINS', 'NCONTAINS'],
-    placeholder: 'e.g. 919876543210'
+    placeholder: 'e.g. 919876543210',
+    variable_type: 'string',
   },
   'chat.labels': {
     text: 'Chat Labels',
     type: 'dropdown',
     value: 'org.labels',
     filters: ['CONTAINS', 'NCONTAINS'],
+    variable_type: 'string',
   },
   'chat.chat_id': {
     text: 'Chat ID',
     type: 'string',
     filters: ['EQ', 'NEQ'],
-    placeholder: 'e.g. 12027747916749@c.us'
+    placeholder: 'e.g. 12027747916749@c.us',
+    variable_type: 'string',
   },
   'chat.chat_org_phones': {
     text: 'Chat Org Phones',
     type: 'dropdown',
     filters: ['CONTAINS', 'NCONTAINS'],
     hidden: true,
+    variable_type: 'string',
   },
   'chat.org_id': {
     text: 'Org ID',
     type: 'string',
     filters: [],
     hidden: true,
+    variable_type: 'string',
   },
   'chat.messages_admins_only': {
     text: 'Chat Messages Admins Only',
@@ -444,15 +483,16 @@ export const ChatVariableNameMap: Record<
     value: [
       {
         id: 'true',
-        value: 'true',
+        value: true,
         label: 'True',
       },
       {
         id: 'false',
-        value: 'false',
+        value: false,
         label: 'False',
       },
     ],
+    variable_type: 'boolean',
   },
   'chat.is_muted': {
     text: 'Chat is muted',
@@ -461,15 +501,16 @@ export const ChatVariableNameMap: Record<
     value: [
       {
         id: 'true',
-        value: 'true',
+        value: true,
         label: 'True',
       },
       {
         id: 'false',
-        value: 'false',
+        value: false,
         label: 'False',
       },
     ],
+    variable_type: 'boolean',
   },
   'chat.is_exited': {
     text: 'Chat is exited',
@@ -478,33 +519,17 @@ export const ChatVariableNameMap: Record<
     value: [
       {
         id: 'true',
-        value: 'true',
+        value: true,
         label: 'True',
       },
       {
         id: 'false',
-        value: 'false',
+        value: false,
         label: 'False',
       },
     ],
+    variable_type: 'boolean',
   },
-  // 'chat.is_archived': {
-  //   text: 'Chat is archived',
-  //   type: 'boolean',
-  //   filters: ['EQ', 'NEQ'],
-  //   value: [
-  //     {
-  //       id: 'true',
-  //       value: 'true',
-  //       label: 'True',
-  //     },
-  //     {
-  //       id: 'false',
-  //       value: 'false',
-  //       label: 'False',
-  //     },
-  //   ],
-  // },
   'chat.info_admins_only': {
     text: 'Chat Info Admins Only',
     type: 'boolean',
@@ -512,15 +537,16 @@ export const ChatVariableNameMap: Record<
     value: [
       {
         id: 'true',
-        value: 'true',
+        value: true,
         label: 'True',
       },
       {
         id: 'false',
-        value: 'false',
+        value: false,
         label: 'False',
       },
     ],
+    variable_type: 'boolean',
   },
   'chat.has_flagged_messages': {
     text: 'Chat has flagged messages',
@@ -529,21 +555,23 @@ export const ChatVariableNameMap: Record<
     value: [
       {
         id: 'true',
-        value: 'true',
+        value: true,
         label: 'True',
       },
       {
         id: 'false',
-        value: 'false',
+        value: false,
         label: 'False',
       },
     ],
+    variable_type: 'boolean',
   },
   'chat.group_description': {
     text: 'Group Description',
     type: 'string',
     filters: ['CONTAINS', 'NCONTAINS', 'EQ', 'NEQ'],
     placeholder: 'e.g. Group description',
+    variable_type: 'string',
   },
   'chat.custom_properties': {
     text: 'Chat Custom Properties',
@@ -551,11 +579,13 @@ export const ChatVariableNameMap: Record<
     value: 'org.custom_properties',
     filters: ['EQ', 'NEQ'],
     hidden: true,
+    variable_type: 'string',
   },
   'chat.created_at': {
     text: 'Chat Created At',
     type: 'day-time',
     filters: ['LT', 'LTE', 'GT', 'GTE', 'IS'],
+    variable_type: 'day-time',
   },
 };
 
@@ -568,6 +598,7 @@ export const TicketVariableNameMap: Record<
     type: 'string',
     filters: ['CONTAINS', 'NCONTAINS', 'EQ', 'NEQ'],
     placeholder: 'e.g. Test ticket',
+    variable_type: 'string',
   },
   'ticket.status': {
     text: 'Ticket Status',
@@ -578,58 +609,80 @@ export const TicketVariableNameMap: Record<
       { id: 'inprogress', value: 'inprogress', label: 'In progress' },
     ],
     filters: ['EQ', 'NEQ'],
+    variable_type: 'string',
   },
   'ticket.priority': {
     text: 'Ticket Priority',
     type: 'dropdown',
     value: [
-      { id: '0', value: '0', label: 'No Prioriy' },
-      { id: '1', value: '1', label: 'Low' },
-      { id: '2', value: '2', label: 'Medium' },
-      { id: '3', value: '3', label: 'High' },
-      { id: '4', value: '4', label: 'Urgent' },
+      { id: '0', value: 0, label: 'No Prioriy' },
+      { id: '1', value: 1, label: 'Low' },
+      { id: '2', value: 2, label: 'Medium' },
+      { id: '3', value: 3, label: 'High' },
+      { id: '4', value: 4, label: 'Urgent' },
     ],
     filters: ['EQ', 'NEQ'],
+    variable_type: 'number',
   },
   'ticket.assignee': {
     text: 'Ticket Assignee',
     type: 'dropdown',
     value: 'org.members',
-    filters: ['EQ', 'NEQ', "KNOWN", "NKNOWN"],
+    filters: ['EQ', 'NEQ', 'KNOWN', 'NKNOWN'],
+    variable_type: 'string',
   },
   'ticket.labels': {
     text: 'Ticket Labels',
     type: 'dropdown',
     value: 'org.labels',
     filters: ['EQ', 'NEQ'],
+    variable_type: 'string',
   },
   'ticket.is_deleted': {
     text: 'Ticket is deleted',
     type: 'boolean',
+    value: [
+      {
+        id: 'true',
+        value: true,
+        label: 'True',
+      },
+      {
+        id: 'false',
+        value: false,
+        label: 'False',
+      },
+    ],
     filters: ['IS'],
+    variable_type: 'boolean',
   },
   'ticket.raised_by': {
     text: 'Ticket Raised By',
     type: 'dropdown',
     value: 'org.members',
     filters: ['EQ', 'NEQ'],
+    variable_type: 'string',
   },
   'ticket.due_date': {
     text: 'Ticket Due Date',
-    type: 'string',
+    type: 'date',
     filters: ['KNOWN', 'NKNOWN'],
+    variable_type: 'date',
+    hidden: true,
   },
   'ticket.ticket_id': {
     text: 'Ticket ID',
     type: 'string',
     filters: ['EQ', 'NEQ'],
     hidden: true,
+    variable_type: 'string',
   },
   'ticket.org_id': {
     text: 'Org ID',
     type: 'string',
     filters: ['EQ', 'NEQ'],
     hidden: true,
+    variable_type: 'string',
   },
   'ticket.custom_properties': {
     text: 'Ticket Custom Properties',
@@ -637,17 +690,20 @@ export const TicketVariableNameMap: Record<
     value: 'org.custom_properties',
     filters: ['EQ', 'NEQ'],
     hidden: true,
+    variable_type: 'string',
   },
   'ticket.created_at': {
     text: 'Ticket Created At',
     type: 'day-time',
     filters: ['LT', 'LTE', 'GT', 'GTE'],
+    variable_type: 'day-time',
   },
   'ticket.chat_id': {
     text: 'Chat ID',
     type: 'string',
     filters: ['EQ', 'NEQ'],
     hidden: true,
+    variable_type: 'string',
   },
 };
 
@@ -660,30 +716,35 @@ export const ReactionVariableNameMap: Record<
     type: 'string',
     filters: ['EQ', 'NEQ'],
     placeholder: 'e.g. 👍',
+    variable_type: 'string',
   },
   'reaction.sender_id': {
     text: 'Reaction Sender Phone',
     type: 'string',
     filters: ['EQ', 'NEQ'],
-    placeholder: 'e.g. 919876543210@c.us'
+    placeholder: 'e.g. 919876543210',
+    variable_type: 'string',
   },
   'reaction.message_id': {
     text: 'Reaction Message ID',
     type: 'string',
     filters: ['EQ', 'NEQ'],
     hidden: true,
+    variable_type: 'string',
   },
   'reaction.chat_id': {
     text: 'Chat ID',
     type: 'string',
     filters: ['EQ', 'NEQ'],
     hidden: true,
+    variable_type: 'string',
   },
   'reaction.reaction_id': {
     text: 'Reaction ID',
     type: 'string',
     filters: ['EQ', 'NEQ'],
     hidden: true,
+    variable_type: 'string',
   },
 };
 
@@ -725,6 +786,7 @@ export type SendMessageAction = {
       type: 'image' | 'video' | 'audio' | 'document';
       name: string;
     };
+    maintain_flag_status: 'true' | 'false';
   };
   delay: `${number} ${'seconds' | 'minutes' | 'hours' | 'days'}`;
 };
@@ -744,7 +806,7 @@ export type CreateTicketAction = {
   delay: `${number} ${'seconds' | 'minutes' | 'hours' | 'days'}`;
   metadata: {
     assignee?: string;
-    priority?: 0 | 1 | 2 | 3 | 4;
+    priority?: '0' | '1' | '2' | '3' | '4';
     label?: string;
   };
 };
@@ -753,7 +815,9 @@ export type FlagMessageAction = {
   id: string;
   type: 'flag_message';
   delay: `${number} ${'seconds' | 'minutes' | 'hours' | 'days'}`;
-  metadata: {};
+  metadata: {
+    flag: 'true' | 'false';
+  };
 };
 
 export type AssignTicketAction = {
@@ -761,7 +825,8 @@ export type AssignTicketAction = {
   type: 'assign_ticket';
   delay: `${number} ${'seconds' | 'minutes' | 'hours' | 'days'}`;
   metadata: {
-    email: string;
+    assignee: string;
+    round_robin: 'true' | 'false';
   };
 };
 
@@ -797,7 +862,8 @@ export type AssignChatAction = {
   type: 'assign_chat';
   delay: `${number} ${'seconds' | 'minutes' | 'hours' | 'days'}`;
   metadata: {
-    email: string;
+    assignee: string;
+    round_robin: 'true' | 'false';
   };
 };
 
@@ -833,6 +899,7 @@ export type ReplyToMessageAction = {
       type: 'image' | 'video' | 'audio' | 'document';
       name: string;
     };
+    maintain_flag_status: boolean;
   };
 };
 
@@ -984,6 +1051,7 @@ export const ActionNameMap: Record<
           | 'custom_property_values';
         label: string;
         placeholder: string;
+        info?: string;
       }
     >;
     validTriggers: Rule['trigger'][];
@@ -1007,6 +1075,16 @@ export const ActionNameMap: Record<
         placeholder: 'Upload media',
         value: null,
       },
+      maintain_flag_status: {
+        id: 'maintain_flag_status',
+        type: 'dropdown',
+        label: 'Maintain Flag Status',
+        placeholder: 'Select...',
+        value: [
+          { id: 'true', value: 'true', label: 'True' },
+          { id: 'false', value: 'false', label: 'False' },
+        ],
+      },
     },
     validTriggers: [
       'message.created',
@@ -1016,7 +1094,7 @@ export const ActionNameMap: Record<
       'ticket.created',
       'reaction.added',
       'message.flagged',
-      'chat.label.updated'
+      'chat.label.updated',
     ],
   },
   reply_to_message: {
@@ -1037,6 +1115,16 @@ export const ActionNameMap: Record<
         placeholder: 'Upload media',
         value: null,
       },
+      maintain_flag_status: {
+        id: 'maintain_flag_status',
+        type: 'dropdown',
+        label: 'Maintain Flag Status',
+        placeholder: 'Select...',
+        value: [
+          { id: 'true', value: 'true', label: 'True' },
+          { id: 'false', value: 'false', label: 'False' },
+        ],
+      },
     },
     validTriggers: [
       'message.created',
@@ -1065,7 +1153,7 @@ export const ActionNameMap: Record<
       'ticket.created',
       'reaction.added',
       'message.flagged',
-      'chat.label.updated'
+      'chat.label.updated',
     ],
   },
   create_ticket: {
@@ -1083,11 +1171,11 @@ export const ActionNameMap: Record<
         id: 'priority',
         type: 'dropdown',
         value: [
-          { id: '0', value: '0', label: 'Low' },
-          { id: '1', value: '1', label: 'Medium' },
-          { id: '2', value: '2', label: 'High' },
-          { id: '3', value: '3', label: 'Urgent' },
-          { id: '4', value: '4', label: 'Immediate' },
+          { id: '0', value: '0', label: 'No Prioriy' },
+          { id: '1', value: '1', label: 'Low' },
+          { id: '2', value: '2', label: 'Medium' },
+          { id: '3', value: '3', label: 'High' },
+          { id: '4', value: '4', label: 'Urgent' },
         ],
         label: 'Priority',
         placeholder: 'Select priority',
@@ -1128,12 +1216,24 @@ export const ActionNameMap: Record<
     title: 'Assign Ticket',
     description: 'Assign a ticket',
     inputs: {
-      email: {
-        id: 'email',
+      round_robin: {
+        id: 'round_robin',
         type: 'dropdown',
+        value: [
+          { id: 'true', value: 'true', label: 'True' },
+          { id: 'false', value: 'false', label: 'False' },
+        ],
+        label: 'Enable Round Robin',
+        placeholder: 'Select...',
+        info: 'If enabled, the ticket will be assigned to the next available agent in the list',
+      },
+      assignee: {
+        id: 'email',
+        type: 'dynamic',
         value: 'org.members',
         label: 'Assignee',
         placeholder: 'Select assignee',
+        info: "If round robin is enabled, the ticket will be assigned to the next available agent in the list else it'll be assigned to the selected agent",
       },
     },
     validTriggers: ['ticket.updated', 'ticket.created'],
@@ -1171,7 +1271,7 @@ export const ActionNameMap: Record<
       'ticket.updated',
       'ticket.created',
       'reaction.added',
-      'chat.label.updated'
+      'chat.label.updated',
     ],
   },
   add_ticket_label: {
@@ -1189,7 +1289,7 @@ export const ActionNameMap: Record<
     validTriggers: ['ticket.updated', 'ticket.created'],
   },
   update_custom_property: {
-    description: 'Update a custom property',
+    description: 'Update a chat custom property',
     title: 'Update Chat Custom Property',
     validTriggers: [
       'message.created',
@@ -1221,9 +1321,20 @@ export const ActionNameMap: Record<
     title: 'Assign Chat',
     description: 'Assign a chat',
     inputs: {
-      email: {
-        id: 'email',
+      round_robin: {
+        id: 'round_robin',
         type: 'dropdown',
+        value: [
+          { id: 'true', value: 'true', label: 'True' },
+          { id: 'false', value: 'false', label: 'False' },
+        ],
+        label: 'Enable Round Robin',
+        placeholder: 'Select...',
+        info: 'If enabled, the chat will be assigned to the next available agent in the list',
+      },
+      assignee: {
+        id: 'assignee',
+        type: 'dynamic',
         value: 'org.members',
         label: 'Assignee',
         placeholder: 'Select assignee',
@@ -1236,7 +1347,7 @@ export const ActionNameMap: Record<
       'ticket.updated',
       'ticket.created',
       'reaction.added',
-      'chat.label.updated'
+      'chat.label.updated',
     ],
   },
   forward_message: {
@@ -1302,7 +1413,51 @@ export const ActionNameMap: Record<
       'ticket.created',
       'reaction.added',
       'message.flagged',
-      'chat.label.updated'
+      'chat.label.updated',
     ],
   },
 };
+
+export const editorVariables: Array<{
+  label: string;
+  value: string;
+  validTriggers: Rule['trigger'][];
+}> = [
+  {
+    label: 'Message Body',
+    value: 'message.body',
+    validTriggers: [
+      'message.created',
+      'message.updated',
+      'reaction.added',
+      'message.flagged',
+    ],
+  },
+  {
+    label: 'Sender Name',
+    value: 'sender.contact_name',
+    validTriggers: [
+      'message.created',
+      'message.updated',
+      'reaction.added',
+      'message.flagged',
+    ],
+  },
+  {
+    label: 'Chat Name',
+    value: 'chat.chat_name',
+    validTriggers: [
+      'message.created',
+      'message.updated',
+      'reaction.added',
+      'message.flagged',
+      'chat.created',
+      'chat.label.updated',
+    ],
+  },
+  {
+    label: 'Ticket ID',
+    value: 'ticket.ticket_id',
+    validTriggers: ['ticket.updated', 'ticket.created'],
+  },
+];