@periskope/types 0.6.283 → 0.6.284

package/dist/workflows.types.js

@@ -0,0 +1,256 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Triggers = void 0;
+exports.isSplitPathAction = isSplitPathAction;
+exports.isConditionLeaf = isConditionLeaf;
+function isSplitPathAction(workflow_action) {
+    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"
+//         }
+//       ]
+//     }
+//   ]
+// }
+var Conditions;
+(function (Conditions) {
+    // string
+    Conditions["CONTAINS"] = "contains";
+    Conditions["NCONTAINS"] = "not contains";
+    Conditions["EQUALS"] = "equals";
+    Conditions["NEQUALS"] = "not equals";
+    Conditions["STARTS_WITH"] = "starts with";
+    Conditions["ENDS_WITH"] = "ends with";
+    // number, date, time
+    Conditions["GREATER_THAN"] = "greater than";
+    Conditions["GREATER_THAN_OR_EQUAL"] = "greater than or equal";
+    Conditions["LESS_THAN"] = "less than";
+    Conditions["LESS_THAN_OR_EQUAL"] = "less than or equal";
+    // none
+    Conditions["IS_KNOWN"] = "is known";
+    Conditions["IS_UNKNOWN"] = "is unknown";
+    // boolean
+    Conditions["IS"] = "is";
+    Conditions["IS_NOT"] = "is not";
+    // array
+    Conditions["IS_ANY_OF"] = "is any of";
+    Conditions["IS_NOT_ANY_OF"] = "is not any of";
+    // day
+    Conditions["ON"] = "on";
+})(Conditions || (Conditions = {}));
+function isConditionLeaf(condition) {
+    return 'id' in condition && !('operator' in condition);
+}
+var Triggers;
+(function (Triggers) {
+    Triggers["MESSAGE_CREATED"] = "message.created";
+    Triggers["MESSAGE_UPDATED"] = "message.updated";
+    Triggers["MESSAGE_DELETED"] = "message.deleted";
+    Triggers["MESSAGE_FLAGGED"] = "message.flagged";
+    Triggers["MESSAGE_UNFLAGGED"] = "message.unflagged";
+    Triggers["REACTION_ADDED"] = "reaction.added";
+    Triggers["TICKET_CREATED"] = "ticket.created";
+    Triggers["TICKET_UPDATED"] = "ticket.updated";
+    Triggers["TICKET_DELETED"] = "ticket.deleted";
+    Triggers["TICKET_CLOSED"] = "ticket.closed";
+    Triggers["TICKET_DUE"] = "ticket.due";
+    Triggers["CHAT_CREATED"] = "chat.created";
+    Triggers["CHAT_LABEL_UPDATED"] = "chat.label.updated";
+    Triggers["CHAT_CLOSED"] = "chat.closed";
+    Triggers["TASK_CREATED"] = "task.created";
+    Triggers["TASK_DUE"] = "task.due";
+})(Triggers || (exports.Triggers = Triggers = {}));
+// 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
+//     },
+//   ],
+// };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@periskope/types",
-    "version": "0.6.283",
+    "version": "0.6.284",
     "private": false,
     "main": "dist/index.js",
     "types": "dist/index.d.ts",

package/src/index.ts

@@ -2,3 +2,4 @@ export * from './object.types';
 export * from './rules.types';
 export * from './supabase.types';
 export * from './types';
+export * from './workflows.types';

package/src/supabase.types.ts

@@ -1950,6 +1950,63 @@ export type Database = {
           },
         ]
       }
+      tbl_org_workflows: {
+        Row: {
+          actions: Json
+          created_at: string
+          deleted_at: string | null
+          id: string
+          is_active: boolean
+          name: string
+          org_id: string
+          trigger: string
+          trigger_metadata: Json
+          updated_at: string
+          updated_by: string
+        }
+        Insert: {
+          actions?: Json
+          created_at?: string
+          deleted_at?: string | null
+          id?: string
+          is_active?: boolean
+          name: string
+          org_id: string
+          trigger: string
+          trigger_metadata?: Json
+          updated_at?: string
+          updated_by: string
+        }
+        Update: {
+          actions?: Json
+          created_at?: string
+          deleted_at?: string | null
+          id?: string
+          is_active?: boolean
+          name?: string
+          org_id?: string
+          trigger?: string
+          trigger_metadata?: Json
+          updated_at?: string
+          updated_by?: string
+        }
+        Relationships: [
+          {
+            foreignKeyName: "tbl_org_workflows_org_id_fkey"
+            columns: ["org_id"]
+            isOneToOne: false
+            referencedRelation: "tbl_org"
+            referencedColumns: ["org_id"]
+          },
+          {
+            foreignKeyName: "tbl_org_workflows_org_id_fkey"
+            columns: ["org_id"]
+            isOneToOne: false
+            referencedRelation: "view_org"
+            referencedColumns: ["org_id"]
+          },
+        ]
+      }
       tbl_quick_replies: {
         Row: {
           command: string | null

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 ---------------------------- */
 
@@ -1287,4 +1288,4 @@ export type FreshdeskCustomFieldType = {
   created_at: string;
   updated_at: string;
   choices?: Choice[];
-};
+};