@periskope/types 0.6.243 → 0.6.244

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export * from './object.types';
+export * from './rules.types';
+export * from './supabase.types';
+export * from './types';
+//# sourceMappingURL=index.d.ts.map

package/dist/rules.types.d.ts

@@ -0,0 +1,348 @@
+import { Merge, OverrideProperties } from 'type-fest';
+import { Tables } from './supabase.types';
+import { ChatRuleInfoType, MessageRuleInfoType, ReactionRuleInfoType, SenderRuleInfoType, TicketRuleInfoType } from './types';
+export type AppendTypes<T extends object, O extends string> = {
+    [K in keyof T & string as `${K}${O}${keyof T[K] & string}`]: T[K][keyof T[K]];
+};
+export type TicketVariablesType = TicketRuleInfoType['ticket'];
+export type MessageVariablesType = MessageRuleInfoType['message'];
+export type SenderVariablesType = SenderRuleInfoType;
+export type ReactionVariablesType = ReactionRuleInfoType['reaction'];
+export type ChatVariablesType = ChatRuleInfoType;
+export type MessageRulesInfoType = Merge<AppendTypes<{
+    message: MessageVariablesType;
+    sender: SenderVariablesType;
+    chat: ChatVariablesType;
+}, '.'>, {
+    rule: Tables<'tbl_automation_rules'>[];
+    id: 'message.message_id';
+    type: `message.${'created' | 'updated' | 'flagged'}`;
+    org_id: string;
+}>;
+export type TicketRulesInfoType = Merge<AppendTypes<{
+    ticket: TicketVariablesType;
+    message: MessageVariablesType;
+    sender: SenderVariablesType;
+    chat: ChatVariablesType;
+}, '.'>, {
+    id: 'ticket.ticket_id';
+    type: `ticket.${'created' | 'updated'}`;
+    org_id: string;
+    rule: Tables<'tbl_automation_rules'>[];
+}>;
+export type ReactionRulesInfoType = Merge<AppendTypes<{
+    reaction: ReactionVariablesType;
+    message: MessageVariablesType;
+    sender: SenderVariablesType;
+    chat: ChatVariablesType;
+}, '.'>, {
+    rule: Tables<'tbl_automation_rules'>[];
+    id: 'reaction.reaction_id';
+    type: `reaction.added`;
+    org_id: string;
+}>;
+export type ChatRulesInfoType = Merge<AppendTypes<{
+    chat: ChatVariablesType;
+}, '.'>, {
+    rule: Tables<'tbl_automation_rules'>[];
+    id: 'chat.chat_id';
+    type: 'chat.created' | 'chat.label.updated';
+    org_id: string;
+}>;
+export type RuleInfoType = MessageRulesInfoType | ChatRulesInfoType | TicketRulesInfoType | ReactionRulesInfoType;
+export interface Filter {
+    id: string;
+    condition: 'CONTAINS' | 'NCONTAINS' | 'EQ' | 'NEQ' | 'LT' | 'LTE' | 'GT' | 'GTE' | 'KNOWN' | 'NKNOWN' | 'IS' | 'NIS' | 'ON';
+    variable: string;
+    value: string | string[];
+    variable_type?: 'string' | 'number' | 'boolean' | 'day-time' | 'date' | 'day';
+}
+export declare const isFilter: (filter: any) => filter is Filter;
+export declare const FilterNameMap: Record<Filter['condition'], {
+    name: string;
+    input: boolean;
+}>;
+export type VariableNameValueType = {
+    text: string;
+    type: 'string' | 'time' | 'boolean' | 'dropdown' | 'day-time' | 'number' | 'date';
+    variable_type: 'string' | 'number' | 'boolean' | 'day-time' | 'date';
+    value?: string | {
+        id: string;
+        value: string | number | boolean;
+        label: string;
+    }[] | null;
+    filters: Partial<Record<Filter['condition'], {
+        info?: string;
+    }>> | Filter['condition'][];
+    hidden?: boolean;
+    placeholder?: string;
+    info?: string;
+};
+export declare const MessageVariableNameMap: Record<keyof AppendTypes<{
+    message: MessageVariablesType;
+}, '.'>, VariableNameValueType>;
+export declare const SenderVariableNameMap: Record<keyof AppendTypes<{
+    sender: SenderVariablesType;
+}, '.'>, VariableNameValueType>;
+export declare const ChatVariableNameMap: Record<keyof AppendTypes<{
+    chat: ChatVariablesType;
+}, '.'>, VariableNameValueType>;
+export declare const TicketVariableNameMap: Record<keyof AppendTypes<{
+    ticket: TicketVariablesType;
+}, '.'>, VariableNameValueType>;
+export declare const ReactionVariableNameMap: Record<keyof AppendTypes<{
+    reaction: ReactionVariablesType;
+}, '.'>, VariableNameValueType>;
+export declare enum FilterConditionMap {
+    'CONTAINS' = "contains",
+    'NCONTAINS' = "does not contain",
+    'EQ' = "=",
+    'NEQ' = "<>",
+    'LT' = "<",
+    'LTE' = "<=",
+    'GT' = ">",
+    'GTE' = ">=",
+    'KNOWN' = "is known",
+    'NKNOWN' = "is not known",
+    'IS' = "=",
+    'NIS' = "<>",
+    'ON' = "on"
+}
+interface FilterGroup {
+    filters: Filter[];
+    condition: 'allOf' | 'anyOf';
+}
+export interface Conditions {
+    filters: FilterGroup[];
+    condition: 'allOf' | 'anyOf';
+    variables: string[];
+    delay: `${number} ${'seconds' | 'minutes' | 'hours' | 'days'}`;
+    org_phones: string[];
+    allow_messages_from_org_phones?: boolean;
+}
+export type SendMessageAction = {
+    id: string;
+    type: 'send_message';
+    metadata: {
+        message: string;
+        media?: {
+            url: string;
+            type: 'image' | 'video' | 'audio' | 'document';
+            name: string;
+        };
+        maintain_flag_status: 'true' | 'false';
+        debounce_messages: 'true' | 'false';
+        debounce_message_time: `${number} ${'seconds' | 'minutes' | 'hours' | 'days'}` | null | undefined;
+    };
+    delay: `${number} ${'seconds' | 'minutes' | 'hours' | 'days'}`;
+};
+export type NotifyHttpAction = {
+    id: string;
+    type: 'notify_http';
+    delay: `${number} ${'seconds' | 'minutes' | 'hours' | 'days'}`;
+    metadata: {
+        url: string;
+    };
+};
+export type CreateTicketAction = {
+    id: string;
+    type: 'create_ticket';
+    delay: `${number} ${'seconds' | 'minutes' | 'hours' | 'days'}`;
+    metadata: {
+        priority?: '0' | '1' | '2' | '3' | '4';
+        label?: string;
+        append_to_latest_ticket?: 'true' | 'false';
+        round_robin?: 'true' | 'false';
+        assignee?: string;
+    };
+};
+export type FlagMessageAction = {
+    id: string;
+    type: 'flag_message';
+    delay: `${number} ${'seconds' | 'minutes' | 'hours' | 'days'}`;
+    metadata: {
+        flag: 'true' | 'false';
+    };
+};
+export type AssignTicketAction = {
+    id: string;
+    type: 'assign_ticket';
+    delay: `${number} ${'seconds' | 'minutes' | 'hours' | 'days'}`;
+    metadata: {
+        assignee: string;
+        round_robin: 'true' | 'false';
+    };
+};
+export type CloseTicketAction = {
+    id: string;
+    type: 'close_ticket';
+    delay: `${number} ${'seconds' | 'minutes' | 'hours' | 'days'}`;
+    metadata: {
+        closing_note: string;
+    };
+};
+export type AddChatLabelAction = {
+    id: string;
+    type: 'add_chat_label';
+    delay: `${number} ${'seconds' | 'minutes' | 'hours' | 'days'}`;
+    metadata: {
+        label: string;
+    };
+};
+export type AddTicketLabelAction = {
+    id: string;
+    type: 'add_ticket_label';
+    delay: `${number} ${'seconds' | 'minutes' | 'hours' | 'days'}`;
+    metadata: {
+        label: string;
+    };
+};
+export type AssignChatAction = {
+    id: string;
+    type: 'assign_chat';
+    delay: `${number} ${'seconds' | 'minutes' | 'hours' | 'days'}`;
+    metadata: {
+        assignee: string;
+        round_robin: 'true' | 'false';
+    };
+};
+export type ForwardMessageAction = {
+    id: string;
+    type: 'forward_message';
+    delay: `${number} ${'seconds' | 'minutes' | 'hours' | 'days'}`;
+    metadata: {
+        chat_id: string;
+        prefix: string;
+    };
+};
+export type SendEmailAction = {
+    id: string;
+    type: 'send_email';
+    delay: `${number} ${'seconds' | 'minutes' | 'hours' | 'days'}`;
+    metadata: {
+        email: string;
+        subject: string;
+        body: string;
+    };
+};
+export type ReplyToMessageAction = {
+    id: string;
+    type: 'reply_to_message';
+    delay: `${number} ${'seconds' | 'minutes' | 'hours' | 'days'}`;
+    metadata: {
+        message: string;
+        media?: {
+            url: string;
+            type: 'image' | 'video' | 'audio' | 'document';
+            name: string;
+        };
+        maintain_flag_status: 'true' | 'false';
+        debounce_messages: 'true' | 'false';
+        debounce_message_time: `${number} ${'seconds' | 'minutes' | 'hours' | 'days'}` | null | undefined;
+    };
+};
+export type UpdateCustomPropertyAction = {
+    id: string;
+    type: 'update_custom_property';
+    delay: `${number} ${'seconds' | 'minutes' | 'hours' | 'days'}`;
+    metadata: {
+        property_id: string;
+        value: string;
+    };
+};
+export type DeleteMessageAction = {
+    id: string;
+    type: 'delete_message';
+    delay: `${number} ${'seconds' | 'minutes' | 'hours' | 'days'}`;
+    metadata: {};
+};
+export type SendSlackNotificationAction = {
+    id: string;
+    type: 'send_slack_notification';
+    delay: `${number} ${'seconds' | 'minutes' | 'hours' | 'days'}`;
+    metadata: {
+        slack_payload: string;
+        webhook_url: string;
+    };
+};
+export type AttachMessageToTicketAction = {
+    id: string;
+    type: 'attach_message_to_ticket';
+    delay: `${number} ${'seconds' | 'minutes' | 'hours' | 'days'}`;
+    metadata: {
+        status: 'open' | 'inprogress' | 'open_inprogress' | null;
+    };
+};
+export type CloseChatAction = {
+    id: string;
+    type: 'close_chat';
+    delay: `${number} ${'seconds' | 'minutes' | 'hours' | 'days'}`;
+    metadata: {};
+};
+export type SendMessageToChatAction = {
+    id: string;
+    type: 'send_message_to_chat';
+    delay: `${number} ${'seconds' | 'minutes' | 'hours' | 'days'}`;
+    metadata: {
+        chat_id: string;
+        message: string;
+        media?: {
+            url: string;
+            type: 'image' | 'video' | 'audio' | 'document';
+            name: string;
+        };
+    };
+};
+export type Action = SendMessageAction | NotifyHttpAction | CreateTicketAction | FlagMessageAction | AssignTicketAction | CloseTicketAction | AddChatLabelAction | AddTicketLabelAction | AssignChatAction | ForwardMessageAction | SendEmailAction | ReplyToMessageAction | UpdateCustomPropertyAction | DeleteMessageAction | SendSlackNotificationAction | AttachMessageToTicketAction | CloseChatAction | SendMessageToChatAction;
+export declare const isSendMessageOrReplyToMessageAction: (action: Action) => action is SendMessageAction | ReplyToMessageAction;
+export type Rule = OverrideProperties<Tables<'tbl_automation_rules'>, {
+    actions: Action[];
+    conditions: Conditions;
+    trigger: 'message.created' | 'message.updated' | 'chat.created' | 'ticket.updated' | 'ticket.created' | 'reaction.added' | 'chat.label.updated' | 'message.flagged';
+}>;
+export declare const RuleNameMap: Record<Rule['trigger'], {
+    title: string;
+    description: string;
+    base_conditions: {
+        org_phone: boolean;
+    };
+}>;
+export declare const ActionNameMap: Record<Action['type'], {
+    title: string;
+    description: string;
+    inputs: Record<string, {
+        id: string;
+        type: 'text' | 'dropdown' | 'editor' | 'date' | 'file' | 'textarea' | 'dynamic' | 'json_editor';
+        value: 'ticket.labels' | 'org.members' | 'chat.labels' | 'org.chats' | {
+            id: string;
+            value: string;
+            label: string;
+        }[] | null | 'org.custom_properties' | 'custom_property_values' | 'debounce_messages';
+        label: string;
+        placeholder: string;
+        info?: string;
+        required: boolean;
+        description?: string;
+    }>;
+    info?: string;
+    validTriggers: Rule['trigger'][];
+}>;
+type editorVariablesList = 'chat.assigned_to' | 'chat.chat_id' | 'chat.chat_name' | 'chat.chat_type' | 'chat.org_phone' | 'chat.org_id' | 'chat.group_description' | 'ticket.assignee' | 'ticket.due_date' | 'ticket.priority' | 'ticket.status' | 'ticket.subject' | 'ticket.ticket_id' | 'ticket.raised_by' | 'ticket.created_at' | 'sender.is_internal' | 'sender.is_admin' | 'sender.contact_name' | 'sender.contact_id' | 'reaction.sender_id' | 'reaction.reaction' | 'message.message_id' | 'message.timestamp' | 'message.sender_phone' | 'message.message_type' | 'message.media' | 'message.body';
+export declare const editorVariables: Array<{
+    label: string;
+    value: editorVariablesList;
+    validTriggers: Rule['trigger'][];
+}>;
+export declare const variablesExclusionList: Record<Rule['trigger'], Array<keyof AppendTypes<{
+    message: MessageVariablesType;
+}, '.'> | keyof AppendTypes<{
+    sender: SenderVariablesType;
+}, '.'> | keyof AppendTypes<{
+    chat: ChatVariablesType;
+}, '.'> | keyof AppendTypes<{
+    ticket: TicketVariablesType;
+}, '.'> | keyof AppendTypes<{
+    reaction: ReactionVariablesType;
+}, '.'>>>;
+export {};
+//# sourceMappingURL=rules.types.d.ts.map