@periskope/types 0.6.176 → 0.6.177

package/types.ts

@@ -1,852 +1,856 @@
-import type { default as _Stripe } from 'stripe';
-import { Merge, OverrideProperties } from 'type-fest';
-import { Filter, Rule } from './rules.types';
-import { Tables, TablesUpdate } from './supabase.types';
-
-/* ----------------------------- TYPE SHORTHANDS ---------------------------- */
-
-/* ------------------------------ PERISKOPE TYPES ------------------------------ */
-
-export enum AllPlans {
-  FREE_TRIAL = 'free-trial',
-  // MONTHLY_STARTER = 'monthly-starter',
-  // YEARLY_STARTER = 'yearly-starter',
-  // MONTHLY_PRO = 'monthly-pro',
-  // YEARLY_PRO = 'yearly-pro',
-  ENTERPRISE = 'enterprise',
-  MONTHLY_STARTER_SINGLE = 'monthly-starter-single',
-  YEARLY_STARTER_SINGLE = 'yearly-starter-single',
-  MONTHLY_PRO_SINGLE = 'monthly-pro-single',
-  YEARLY_PRO_SINGLE = 'yearly-pro-single',
-}
-
-export type Frequency = 'yearly' | 'monthly' | 'weekly' | 'custom';
-
-export type Enterprise = `${string}-enterprise`;
-
-export type OrgPlanEnterprise = {
-  subscription_id: string;
-  plan_id: Enterprise;
-  interval: number;
-  frequency: Frequency;
-  user_limit: number;
-  phone_limit: number;
-  current_period_start: number;
-  current_period_end: number | null;
-};
-
-export type OrgPlanNonEnterprise = {
-  subscription_id: string;
-  plan_id: AllPlans;
-  interval: number;
-  frequency: Frequency;
-  user_limit: number;
-  phone_limit: number;
-  current_period_end: number;
-  current_period_start: number;
-};
-
-export type OrgPlan<T extends AllPlans | Enterprise> = T extends Enterprise
-  ? OrgPlanEnterprise
-  : T extends AllPlans
-    ? OrgPlanNonEnterprise
-    : never;
-
-export type MicrosurveyData = {
-  key: string;
-  text: string;
-  checked: boolean;
-}[];
-
-export type OrgPreferences = {
-  disable_ai_flagging?: boolean;
-  disable_allow_exports?: boolean;
-  sync_phone_contacts?: boolean;
-  mask_phone_numbers?: boolean;
-  show_sender_names?: boolean;
-  closed_chats?: Record<string, number>;
-  auto_read_muted_chats?: boolean;
-};
-
-type OrgPreferenceKey = keyof OrgPreferences;
-
-export type OrgPreferencesValue = {
-  [K in OrgPreferenceKey]: { key: K; value: OrgPreferences[K] };
-}[OrgPreferenceKey];
-
-export type OrgMetadata = {
-  phone_number: string;
-  ticket_prefix: string;
-  referralSource?: string;
-  surveyData?: MicrosurveyData;
-  preferences?: OrgPreferences;
-  hubspot: {
-    hubspot_pipelines?: {
-      id: string;
-      label: string;
-      default_stage: { id: string; label: string };
-    }[];
-    hubspot_hidden_fields?: string[];
-  };
-  partition?: boolean;
-  tickets: {
-    prefix?: string;
-    emoji_ticketing: {
-      is_enabled?: boolean;
-      is_message_enabled?: boolean;
-      message_template?: string;
-    };
-  };
-  attribution?: Object;
-  custom_properties?: {
-    chats_order?: {
-      [id: string]: number;
-    };
-    tickets_order?: {
-      [id: string]: number;
-    };
-  };
-};
-
-type AccessScopes = {
-  feature_flags: Record<string, boolean>;
-  integrations: boolean;
-  exports: boolean;
-};
-
-export type OrgType = OverrideProperties<
-  Merge<
-    Tables<'tbl_org'>,
-    {
-      user: Tables<'tbl_org_members'>;
-      members: Tables<'tbl_org_members'>[];
-      phones: Tables<'tbl_org_phones'>[];
-      labels: Tables<'tbl_org_labels'>[];
-      quick_replies: Tables<'tbl_quick_replies'>[];
-      custom_properties: Tables<'tbl_custom_properties'>[];
-      subscription_status: 'active' | 'inactive' | 'unpaid';
-      is_enterprise: boolean;
-      is_free_trial: boolean;
-      is_hubspot_connected: boolean;
-      is_freshdesk_connected: boolean;
-      is_zohodesk_connected: boolean;
-      access_scopes: AccessScopes;
-      rules: Rule[];
-    }
-  >,
-  {
-    org_plan: OrgPlan<AllPlans | Enterprise>;
-    stripe_customer_details: _Stripe.Customer | null;
-    stripe_subscription_details: Array<_Stripe.Subscription> | null;
-    stripe_customer_id: _Stripe.Customer['id'] | null;
-    org_metadata: OrgMetadata;
-  }
->;
-
-export type ChatMemberType = Merge<
-  Tables<'tbl_chat_participants'>,
-  Tables<'tbl_contacts'>
->;
-
-export type ChatType = Merge<
-  Tables<'view_chats'>,
-  {
-    chat_id: string;
-    latest_message: MessageType | null;
-    latest_message_timestamp: number | null;
-    members: { [key: string]: ChatMemberType } | null;
-    chat_type: 'user' | 'group' | 'business' | 'unknown';
-    chat_access: { [key: string]: boolean };
-    label_ids: { [key: string]: boolean };
-    chat_org_phones?: string[];
-    message_unread_count: number | null;
-    hubspot_metadata: {
-      id: string;
-      type: string;
-      hubId: string;
-      object_data: HubspotObjectDataType;
-    } | null;
-    info_admins_only: boolean;
-    messages_admins_only: boolean;
-    unread_count?: { [key: string]: number };
-    active_phone: string | null;
-    flag_count_map?: { [key: string]: number };
-    is_archived?: boolean;
-    is_pinned?: boolean;
-    closed_at?: number | null;
-    common_chats?: string[];
-  }
->;
-
-/* -------------------------------------------------------------------------- */
-/*                                   MESSAGE                                  */
-/* -------------------------------------------------------------------------- */
-
-export type MediaType = {
-  path?: string;
-  mimetype?: string;
-  filename?: string;
-  dimensions?: { width: number; height: number; ar: number };
-  size?: number;
-  thumbnail?: string;
-  filedata?: string;
-  compress?: boolean;
-};
-
-export type MessageType = Merge<
-  OverrideProperties<
-    Tables<'tbl_chat_messages'>,
-    {
-      message_id: string;
-      org_id: string;
-      org_phone: string;
-      chat_id: string;
-      message_type: (typeof SUPPORTED_TYPES)[number];
-      media: MediaType | null;
-      flag_metadata: MessageFlagType | null;
-      poll_info?: PollSendType | null;
-      poll_results?: PollResultType | null;
-      delivery_info?: DeliveryInfoType | null;
-    }
-  >,
-  {
-    reactions?: ReactionType[];
-    message_payload?: SingleMessagePayload;
-    highlight?: number;
-  }
->;
-
-export type MessageFlagType = {
-  status: boolean;
-  response_type?: 'message' | 'reaction' | 'ticket' | 'manual';
-  response_id?: string;
-  response_timestamp?: string;
-  response_email?: string;
-};
-
-/* -------------------------------------------------------------------------- */
-
-export type TicketType = OverrideProperties<
-  Tables<'tbl_chat_tickets'>,
-  {
-    label_ids: { [key: string]: boolean };
-    hubspot_metadata: {
-      id?: string;
-      type?: string;
-      hubId?: string;
-      pipeline: {
-        id: string;
-        label: string;
-      };
-      object_data?: HubspotObjectDataType;
-    } | null;
-    freshdesk_metadata: Record<string, string>;
-    close_ticket_metadata?:
-      | {
-          closed_by: string;
-          closed_at: string;
-          closed_message?: string | null;
-          send_reply_message_id?: string | null;
-        }
-      | any;
-  }
->;
-
-export type ContactType = Merge<
-  Tables<'tbl_contacts'>,
-  {
-    chats: ChatType[] | null;
-    chat_ids?: string[];
-  }
->;
-export type ReactionType = Tables<'tbl_chat_reactions'>;
-
-export type NotificationType = Tables<'tbl_chat_notifications'>;
-
-export type ChatAccessType = Merge<
-  TablesUpdate<'tbl_org_members'>,
-  {
-    has_access?: boolean;
-    email: string | null;
-  }
->;
-
-export type PhoneQueueStatusType = {
-    active: number;
-    failed: number;
-    completed: number;
-    is_running: boolean;
-    pending: number;
-};
-
-export type PhoneType = OverrideProperties<
-  Tables<'tbl_org_phones'>,
-  {
-    queue_status: {
-      [key: string]: PhoneQueueStatusType;
-    };
-  }
->;
-
-/* -------------------------------- CONSTANTS ------------------------------- */
-
-export const labelColors = [
-  '#9333EA',
-  '#0D9488',
-  '#DB2777',
-  '#2563EB',
-  '#F97316',
-];
-
-export const enumChatColors = [
-  '#B4876E',
-  '#A5B337',
-  '#06CF9C',
-  '#25D366',
-  '#02A698',
-  '#7D9EF1',
-  '#007BFC',
-  '#5E47DE',
-  '#7F66FF',
-  '#9333EA',
-  '#FA6533',
-  '#C4532D',
-  '#DC2626',
-  '#FF2E74',
-  '#DB2777',
-] as const;
-
-/* -------------------------- SEND MESSAGE PAYLOAD -------------------------- */
-
-export const SUPPORTED_TYPES = [
-  'chat',
-  'sticker',
-  'image',
-  'video',
-  'document',
-  'vcard',
-  'multi_vcard',
-  'audio',
-  'ptt',
-  'poll_creation',
-  'location',
-  'ciphertext',
-] as const;
-
-export type SendMessageContent = {
-  message_type?: (typeof SUPPORTED_TYPES)[number];
-  body?: string;
-  media?: MediaType;
-  contact_ids?: string[];
-  location?: {
-    latitude: string;
-    longitude: string;
-    options?: { name?: string; address?: string; url?: string };
-  };
-  poll?: PollSendType;
-  quoted_message_id?: string;
-  quoted_message_type?: 'reply' | 'forward' | 'reply_private';
-  broadcast_id?: string;
-  performed_by?: string;
-};
-
-export type QuickReplyContent = Omit<
-  SendMessageContent,
-  'broadcast_id' | 'variables'
->;
-
-export type BroadcastVariableType = {
-  chat_id: string;
-  values: { [key: string]: string };
-};
-
-export type BroadcastMessagePayload = SendMessageContent & {
-  chat_ids: string[];
-  broadcast_id?: string;
-  variables?: BroadcastVariableType[];
-  delay?: number;
-};
-
-export type SingleMessagePayload = SendMessageContent & {
-  chat_id: string;
-  job_id?: string;
-  priority?: number;
-};
-
-export type MessageAttachmentFileTypes =
-  | 'image'
-  | 'audio'
-  | 'document'
-  | 'video';
-
-export type AttachmentFileType = {
-  result: string;
-  file: File | null;
-  type: MessageAttachmentFileTypes;
-  localFileURL?: string;
-};
-
-export type AttachmentLinkType = {
-  link: {
-    url: string;
-    type: MessageAttachmentFileTypes;
-    name: string;
-    mimetype?: string;
-  };
-};
-
-export type AttachmentTypeProps = AttachmentFileType | AttachmentLinkType;
-
-/* -------------------------------- BROADCAST ------------------------------- */
-
-export type BroadcastLogType = Tables<'view_broadcast_logs'> & {
-  logs: (Tables<'tbl_broadcast_logs'> & Partial<ChatType>)[];
-} & {
-  chats: ChatType[];
-};
-
-/* ----------------------- CHAT PARTICIPANT OPERATION ----------------------- */
-
-export type ChatLogType = {
-  log: Tables<'view_chat_logs'>;
-  operations: Tables<'tbl_chat_logs'>[];
-};
-export type ChatOperationsType = 'ADD' | 'REMOVE' | 'PROMOTE' | 'DEMOTE';
-
-export type ChatParticipantOperationPayload = {
-  participant_ids: string[];
-  chat_ids: string[];
-  performed_by: string;
-};
-
-export type ChatOperationReturn = {
-  [participant_id: string]: {
-    is_success: boolean;
-    message?: string;
-    code?: number;
-    isInviteV4Sent?: boolean;
-  };
-};
-
-/* ----------------------- BILLING - STRIPE ----------------------- */
-
-export type StripeSubscription = _Stripe.Subscription;
-export type StripeCustomer = _Stripe.Customer;
-export type StripeCoupon = _Stripe.Coupon;
-export type StripePrice = _Stripe.Price;
-export type Stripe = _Stripe;
-export type StripeUpcomingInvoice = _Stripe.UpcomingInvoice;
-export type StripeLineItem = _Stripe.Checkout.SessionCreateParams.LineItem;
-
-/* -------------------------------- REALTIME -------------------------------- */
-
-export type PhoneStateType = {
-  loading: boolean;
-  state: string;
-  sync: number;
-  percent: number | null;
-  message?: string;
-  error?: string;
-};
-
-/* ------------------------------- INTEGRATIONS ----------------------------- */
-
-export type ChatInfoType = Merge<
-  ChatType,
-  {
-    members: {
-      [key: string]: Merge<ChatMemberType, { contact_labels: string }>;
-    } | null;
-    chat_labels: string | null;
-    custom_properties: { [key: string]: string } | null;
-  }
->;
-
-export type TicketInfoType = {
-  chat: ChatInfoType;
-  message: {
-    body: string;
-    chat_id: string;
-    org_phone: string;
-    timestamp: string;
-    media_path: string;
-    message_id: string;
-    sender_name: string;
-    performed_by: string;
-    sender_phone: string;
-  };
-  ticket: {
-    org_id: string;
-    status: string;
-    subject: string;
-    assignee: string;
-    due_date: string;
-    priority: 0 | 1 | 2 | 3 | 4;
-    raised_by: string;
-    ticket_id: string;
-    created_at: string;
-    assigned_by: string;
-    ticket_labels: string;
-    quoted_message_id: string;
-    ticket_custom_properties: { [key: string]: string } | null;
-  };
-  attached_messages: {
-    body: string;
-    chat_id: string;
-    org_phone: string;
-    timestamp: string;
-    media_path: string;
-    message_id: string;
-    sender_name: string;
-    performed_by: string;
-    sender_phone: string;
-  }[];
-};
-
-export type IntegrationLogObjectType =
-  | 'chat'
-  | 'message'
-  | 'reaction'
-  | 'ticket';
-
-export enum IntegrationLogType {
-  NEW_CHAT = 'chat.created',
-  NEW_CHAT_NOTIFICATION = 'chat.notification.created',
-  NEW_MESSAGE = 'message.created',
-  MESSAGE_UPDATED = 'message.updated',
-  MESSAGE_DELETED = 'message.deleted',
-  MESSAGE_ACK_UPDATED = 'message.ack.updated',
-  REACTION_CREATED = 'reaction.created',
-  REACTION_UPDATED = 'reaction.updated',
-  NEW_TICKET = 'ticket.created',
-  TICKET_UPDATED = 'ticket.updated',
-  TICKET_DELETED = 'ticket.deleted',
-  MESSAGE_FLAGGED = 'message.flagged',
-  MESSAGE_UNFLAGGED = 'message.unflagged',
-}
-
-export type IntegrationLogMetadataType<T extends IntegrationLogType> =
-  T extends IntegrationLogType.NEW_TICKET | IntegrationLogType.TICKET_UPDATED
-    ? TicketInfoType
-    : T extends IntegrationLogType.NEW_CHAT
-      ? Tables<'tbl_chats'>
-      : T extends
-            | IntegrationLogType.NEW_MESSAGE
-            | IntegrationLogType.MESSAGE_UPDATED
-            | IntegrationLogType.MESSAGE_DELETED
-            | IntegrationLogType.MESSAGE_ACK_UPDATED
-            | IntegrationLogType.MESSAGE_FLAGGED
-            | IntegrationLogType.MESSAGE_UNFLAGGED
-        ? Tables<'tbl_chat_messages'>
-        : T extends
-              | IntegrationLogType.REACTION_CREATED
-              | IntegrationLogType.REACTION_UPDATED
-          ? Tables<'tbl_chat_reactions'>
-          : {
-              [key: string]: unknown;
-            };
-
-export type IntegrationLogDetailsType<T extends IntegrationLogType> =
-  OverrideProperties<
-    Tables<'tbl_integration_logs'>,
-    {
-      integration_name: T;
-      metadata: {
-        event: IntegrationLogMetadataType<T> & {
-          event_type: string;
-          org_id: string;
-          previous_attributes: {
-            [key: string]: unknown;
-          };
-        };
-        hook_id: string;
-        name: string;
-      };
-    }
-  >;
-
-export type APIAuthDetails = {
-  org_details: Tables<'view_org'> | null;
-  phone_details: Tables<'tbl_org_phones'> | null;
-  token_details: Tables<'tbl_integration_tokens'> | null;
-};
-
-export type WebhookDataType = OverrideProperties<
-  Tables<'tbl_integration_hooks'>,
-  {
-    integration_name: string[];
-  }
->;
-
-export type HubspotObjectDataType = {
-  createdAt: string;
-  archived: boolean;
-  id: string;
-  type: 'contacts' | 'tickets' | 'companies';
-  properties: Record<
-    string,
-    {
-      groupLabel: string;
-      groupName: string;
-      propertyKeyName: string;
-      propertyKey: string;
-      propertyInternalValue: string;
-      propertyValue: string;
-      propertyType: string;
-      propertyFieldType: string;
-    }[]
-  >;
-};
-
-/* ---------------------------- USER PREFERENCES ---------------------------- */
-
-export type UserPreferences = {
-  theme: 'light' | 'dark';
-  language: 'en' | 'es';
-  left_sidebar_open: boolean;
-  right_sidepanel_open: boolean;
-  sync_wa_unread_count: boolean;
-  pinned_chats: string[];
-  archived_chats: string[];
-  closed_chats: Record<string, number>;
-  periskope_chat_limit: number;
-};
-
-/* ----------------------------- POLL VOTE INFO ----------------------------- */
-
-export type PollSendType = {
-  pollName: string;
-  pollOptions: string[];
-  options?: {
-    allowMultipleAnswers?: boolean;
-    messageSecret?: number[] | null;
-    pollId?: string;
-  };
-};
-
-export type PollResultType = {
-  [name: string]: Record<string, string>;
-};
-
-/* -------------------------- CREATE GROUP OPTIONS -------------------------- */
-
-export type CreateGroupOptions = {
-  messagesAdminsOnly?: boolean;
-  infoAdminsOnly?: boolean;
-  memberAddMode?: boolean;
-  image?: string;
-  name?: string;
-  description?: string;
-};
-
-/* ------------------------------ DELIVERY INFO ----------------------------- */
-
-export type DeliveryInfoType = {
-  delivered: Record<string, number | undefined>;
-  read: Record<string, number | undefined>;
-  pending: string[];
-  read_count: number;
-  delivered_count: number;
-};
-
-/* ---------------------------- CREDITS SYSTEM ---------------------------- */
-
-export type OrgCreditsType = {
-  org_id: string;
-  recurring_allowance: number; // recurring credits replenished every month
-  recurring_balance: number; // recurring credits remaining in current month
-  topup_balance: number; // topup credits remaining
-  total_credits_used: number; // total credits used in current month
-  next_renewal_date: string;
-};
-
-/* --------------------------------- RULE INFO TYPE -------------------------------- */
-
-export type ChatRuleInfoType = Merge<
-  Pick<
-    Tables<'view_chats'>,
-    | 'assigned_to'
-    | 'chat_id'
-    | 'chat_name'
-    | 'chat_type'
-    | 'created_at'
-    | 'group_description'
-    | 'info_admins_only'
-    | 'org_id'
-    | 'org_phone'
-    | 'chat_org_phones'
-    | 'messages_admins_only'
-    | 'custom_properties'
-  >,
-  {
-    has_flagged_messages: boolean;
-    labels: string[];
-    members: string[];
-    custom_properties: { [key: string]: string } | null;
-  }
->;
-
-export type SenderRuleInfoType = Merge<
-  Omit<
-    Merge<Tables<'tbl_contacts'>, Tables<'tbl_chat_participants'>>,
-    | 'verified_name'
-    | 'verified_level'
-    | 'updated_at'
-    | 'short_name'
-    | 'pushname'
-    | 'periskope_name'
-    | 'org_phone'
-    | 'number'
-    | 'name'
-    | 'label_ids'
-    | 'is_wa_contact'
-    | 'is_user'
-    | 'is_my_contact'
-    | 'is_me'
-    | 'is_imported'
-    | 'is_group'
-    | 'is_blocked'
-    | 'contact_color'
-    | 'business_profile'
-    | 'id'
-    | 'contact_image'
-    | 'contact_type'
-    | 'chat_id'
-    | 'is_business'
-    | 'is_enterprise'
-    | 'is_super_admin'
-  >,
-  {
-    is_internal: boolean;
-    labels: string[] | null;
-  }
->;
-
-export type MessageRuleInfoType = {
-  chat: ChatRuleInfoType;
-  sender: SenderRuleInfoType;
-  message: OverrideProperties<
-    Omit<
-      Tables<'tbl_chat_messages'>,
-      | 'vcards'
-      | 'updated_at'
-      | 'unique_id'
-      | 'token'
-      | 'to'
-      | 'sent_message_id'
-      | 'raw_data'
-      | 'delivery_info'
-      | 'poll_results'
-      | 'poll_info'
-      | 'order_id'
-      | 'mentioned_ids'
-      | 'media_key'
-      | 'location'
-      | 'links'
-      | 'is_status'
-      | 'is_starred'
-      | 'is_gif'
-      | 'is_forwarded'
-      | 'is_ephemeral'
-      | 'is_deleted'
-      | 'fts'
-      | 'quoted_message_id'
-      | 'invite_v4'
-      | 'id'
-      | 'has_reaction'
-      | 'has_media'
-      | 'duration'
-      | 'broadcast'
-      | 'broadcast_id'
-      | 'device_type'
-      | 'forwarding_score'
-      | 'from'
-      | 'from_me'
-      | 'message_ticket_id'
-      | 'prev_body'
-      | 'flag_response_time'
-      | 'flag_metadata'
-      | 'ack'
-    >,
-    {
-      media: MediaType | null;
-    }
-  >;
-};
-
-export type ReactionRuleInfoType = {
-  chat: ChatRuleInfoType;
-  sender: SenderRuleInfoType;
-  message: MessageRuleInfoType['message'];
-  reaction: Pick<
-    Tables<'tbl_chat_reactions'>,
-    'reaction' | 'sender_id' | 'message_id' | 'chat_id' | 'reaction_id'
-  >;
-};
-
-export type TicketRuleInfoType = {
-  chat: ChatRuleInfoType;
-  sender: SenderRuleInfoType;
-  ticket: Merge<
-    Pick<
-      Tables<'tbl_chat_tickets'>,
-      | 'org_id'
-      | 'status'
-      | 'chat_id'
-      | 'subject'
-      | 'assignee'
-      | 'due_date'
-      | 'priority'
-      | 'raised_by'
-      | 'ticket_id'
-      | 'created_at'
-      | 'is_deleted'
-    >,
-    {
-      labels: string[] | null;
-      custom_properties: { [key: string]: string } | null;
-    }
-  >;
-  message: MessageRuleInfoType['message'];
-};
-export type FeatureFlagReturnType = Record<string, boolean>;
-
-export type RuleLogsType = OverrideProperties<
-  Tables<'tbl_rules_logs'>,
-  {
-    actions_progress: {
-      action_id: string;
-      action_type: Rule['actions'][number]['type'];
-      action_delay: Rule['actions'][number]['delay'];
-      ran_at: string | null;
-      action_status: 'success' | 'failed' | 'pending';
-      action_response: {
-        success: boolean;
-        data: Record<string, unknown> | null;
-        error: {
-          message: string;
-          name: string;
-          stack?: string;
-          _error?: Error | Record<string, unknown>;
-        } | null;
-      };
-    }[];
-    metadata: {
-      conditions: Rule['conditions'];
-      actions: Rule['actions'];
-      data: Record<string, unknown>;
-    };
-    conditions_progress: {
-      is_valid: boolean;
-      validation_progress: Record<
-        string,
-        {
-          res: boolean;
-          filter: Filter;
-          value: unknown;
-        }
-      >;
-      checked_at: string | null;
-    };
-  }
->;
+import type { default as _Stripe } from 'stripe';
+import { Merge, OverrideProperties } from 'type-fest';
+import { Filter, Rule } from './rules.types';
+import { Tables, TablesUpdate } from './supabase.types';
+
+/* ----------------------------- TYPE SHORTHANDS ---------------------------- */
+
+/* ------------------------------ PERISKOPE TYPES ------------------------------ */
+
+export enum AllPlans {
+  FREE_TRIAL = 'free-trial',
+  // MONTHLY_STARTER = 'monthly-starter',
+  // YEARLY_STARTER = 'yearly-starter',
+  // MONTHLY_PRO = 'monthly-pro',
+  // YEARLY_PRO = 'yearly-pro',
+  ENTERPRISE = 'enterprise',
+  MONTHLY_STARTER_SINGLE = 'monthly-starter-single',
+  YEARLY_STARTER_SINGLE = 'yearly-starter-single',
+  MONTHLY_PRO_SINGLE = 'monthly-pro-single',
+  YEARLY_PRO_SINGLE = 'yearly-pro-single',
+}
+
+export type Frequency = 'yearly' | 'monthly' | 'weekly' | 'custom';
+
+export type Enterprise = `${string}-enterprise`;
+
+export type OrgPlanEnterprise = {
+  subscription_id: string;
+  plan_id: Enterprise;
+  interval: number;
+  frequency: Frequency;
+  user_limit: number;
+  phone_limit: number;
+  current_period_start: number;
+  current_period_end: number | null;
+};
+
+export type OrgPlanNonEnterprise = {
+  subscription_id: string;
+  plan_id: AllPlans;
+  interval: number;
+  frequency: Frequency;
+  user_limit: number;
+  phone_limit: number;
+  current_period_end: number;
+  current_period_start: number;
+};
+
+export type OrgPlan<T extends AllPlans | Enterprise> = T extends Enterprise
+  ? OrgPlanEnterprise
+  : T extends AllPlans
+    ? OrgPlanNonEnterprise
+    : never;
+
+export type MicrosurveyData = {
+  key: string;
+  text: string;
+  checked: boolean;
+}[];
+
+export type OrgPreferences = {
+  disable_ai_flagging?: boolean;
+  disable_allow_exports?: boolean;
+  sync_phone_contacts?: boolean;
+  mask_phone_numbers?: boolean;
+  show_sender_names?: boolean;
+  closed_chats?: Record<string, number>;
+  auto_read_muted_chats?: boolean;
+};
+
+type OrgPreferenceKey = keyof OrgPreferences;
+
+export type OrgPreferencesValue = {
+  [K in OrgPreferenceKey]: { key: K; value: OrgPreferences[K] };
+}[OrgPreferenceKey];
+
+export type OrgMetadata = {
+  phone_number: string;
+  ticket_prefix: string;
+  referralSource?: string;
+  surveyData?: MicrosurveyData;
+  preferences?: OrgPreferences;
+  hubspot: {
+    hubspot_pipelines?: {
+      id: string;
+      label: string;
+      default_stage: { id: string; label: string };
+    }[];
+    hubspot_hidden_fields?: string[];
+  };
+  partition?: boolean;
+  tickets: {
+    prefix?: string;
+    emoji_ticketing: {
+      is_enabled?: boolean;
+      is_message_enabled?: boolean;
+      message_template?: string;
+    };
+  };
+  attribution?: Object;
+  custom_properties?: {
+    chats_order?: {
+      [id: string]: number;
+    };
+    tickets_order?: {
+      [id: string]: number;
+    };
+  };
+  rules?: {
+    limit?: number;
+  }
+};
+
+type AccessScopes = {
+  feature_flags: Record<string, boolean>;
+  integrations: boolean;
+  rules: boolean;
+  exports: boolean;
+};
+
+export type OrgType = OverrideProperties<
+  Merge<
+    Tables<'tbl_org'>,
+    {
+      user: Tables<'tbl_org_members'>;
+      members: Tables<'tbl_org_members'>[];
+      phones: Tables<'tbl_org_phones'>[];
+      labels: Tables<'tbl_org_labels'>[];
+      quick_replies: Tables<'tbl_quick_replies'>[];
+      custom_properties: Tables<'tbl_custom_properties'>[];
+      subscription_status: 'active' | 'inactive' | 'unpaid';
+      is_enterprise: boolean;
+      is_free_trial: boolean;
+      is_hubspot_connected: boolean;
+      is_freshdesk_connected: boolean;
+      is_zohodesk_connected: boolean;
+      access_scopes: AccessScopes;
+      rules: Rule[];
+    }
+  >,
+  {
+    org_plan: OrgPlan<AllPlans | Enterprise>;
+    stripe_customer_details: _Stripe.Customer | null;
+    stripe_subscription_details: Array<_Stripe.Subscription> | null;
+    stripe_customer_id: _Stripe.Customer['id'] | null;
+    org_metadata: OrgMetadata;
+  }
+>;
+
+export type ChatMemberType = Merge<
+  Tables<'tbl_chat_participants'>,
+  Tables<'tbl_contacts'>
+>;
+
+export type ChatType = Merge<
+  Tables<'view_chats'>,
+  {
+    chat_id: string;
+    latest_message: MessageType | null;
+    latest_message_timestamp: number | null;
+    members: { [key: string]: ChatMemberType } | null;
+    chat_type: 'user' | 'group' | 'business' | 'unknown';
+    chat_access: { [key: string]: boolean };
+    label_ids: { [key: string]: boolean };
+    chat_org_phones?: string[];
+    message_unread_count: number | null;
+    hubspot_metadata: {
+      id: string;
+      type: string;
+      hubId: string;
+      object_data: HubspotObjectDataType;
+    } | null;
+    info_admins_only: boolean;
+    messages_admins_only: boolean;
+    unread_count?: { [key: string]: number };
+    active_phone: string | null;
+    flag_count_map?: { [key: string]: number };
+    is_archived?: boolean;
+    is_pinned?: boolean;
+    closed_at?: number | null;
+    common_chats?: string[];
+  }
+>;
+
+/* -------------------------------------------------------------------------- */
+/*                                   MESSAGE                                  */
+/* -------------------------------------------------------------------------- */
+
+export type MediaType = {
+  path?: string;
+  mimetype?: string;
+  filename?: string;
+  dimensions?: { width: number; height: number; ar: number };
+  size?: number;
+  thumbnail?: string;
+  filedata?: string;
+  compress?: boolean;
+};
+
+export type MessageType = Merge<
+  OverrideProperties<
+    Tables<'tbl_chat_messages'>,
+    {
+      message_id: string;
+      org_id: string;
+      org_phone: string;
+      chat_id: string;
+      message_type: (typeof SUPPORTED_TYPES)[number];
+      media: MediaType | null;
+      flag_metadata: MessageFlagType | null;
+      poll_info?: PollSendType | null;
+      poll_results?: PollResultType | null;
+      delivery_info?: DeliveryInfoType | null;
+    }
+  >,
+  {
+    reactions?: ReactionType[];
+    message_payload?: SingleMessagePayload;
+    highlight?: number;
+  }
+>;
+
+export type MessageFlagType = {
+  status: boolean;
+  response_type?: 'message' | 'reaction' | 'ticket' | 'manual';
+  response_id?: string;
+  response_timestamp?: string;
+  response_email?: string;
+};
+
+/* -------------------------------------------------------------------------- */
+
+export type TicketType = OverrideProperties<
+  Tables<'tbl_chat_tickets'>,
+  {
+    label_ids: { [key: string]: boolean };
+    hubspot_metadata: {
+      id?: string;
+      type?: string;
+      hubId?: string;
+      pipeline: {
+        id: string;
+        label: string;
+      };
+      object_data?: HubspotObjectDataType;
+    } | null;
+    freshdesk_metadata: Record<string, string>;
+    close_ticket_metadata?:
+      | {
+          closed_by: string;
+          closed_at: string;
+          closed_message?: string | null;
+          send_reply_message_id?: string | null;
+        }
+      | any;
+  }
+>;
+
+export type ContactType = Merge<
+  Tables<'tbl_contacts'>,
+  {
+    chats: ChatType[] | null;
+    chat_ids?: string[];
+  }
+>;
+export type ReactionType = Tables<'tbl_chat_reactions'>;
+
+export type NotificationType = Tables<'tbl_chat_notifications'>;
+
+export type ChatAccessType = Merge<
+  TablesUpdate<'tbl_org_members'>,
+  {
+    has_access?: boolean;
+    email: string | null;
+  }
+>;
+
+export type PhoneQueueStatusType = {
+    active: number;
+    failed: number;
+    completed: number;
+    is_running: boolean;
+    pending: number;
+};
+
+export type PhoneType = OverrideProperties<
+  Tables<'tbl_org_phones'>,
+  {
+    queue_status: {
+      [key: string]: PhoneQueueStatusType;
+    };
+  }
+>;
+
+/* -------------------------------- CONSTANTS ------------------------------- */
+
+export const labelColors = [
+  '#9333EA',
+  '#0D9488',
+  '#DB2777',
+  '#2563EB',
+  '#F97316',
+];
+
+export const enumChatColors = [
+  '#B4876E',
+  '#A5B337',
+  '#06CF9C',
+  '#25D366',
+  '#02A698',
+  '#7D9EF1',
+  '#007BFC',
+  '#5E47DE',
+  '#7F66FF',
+  '#9333EA',
+  '#FA6533',
+  '#C4532D',
+  '#DC2626',
+  '#FF2E74',
+  '#DB2777',
+] as const;
+
+/* -------------------------- SEND MESSAGE PAYLOAD -------------------------- */
+
+export const SUPPORTED_TYPES = [
+  'chat',
+  'sticker',
+  'image',
+  'video',
+  'document',
+  'vcard',
+  'multi_vcard',
+  'audio',
+  'ptt',
+  'poll_creation',
+  'location',
+  'ciphertext',
+] as const;
+
+export type SendMessageContent = {
+  message_type?: (typeof SUPPORTED_TYPES)[number];
+  body?: string;
+  media?: MediaType;
+  contact_ids?: string[];
+  location?: {
+    latitude: string;
+    longitude: string;
+    options?: { name?: string; address?: string; url?: string };
+  };
+  poll?: PollSendType;
+  quoted_message_id?: string;
+  quoted_message_type?: 'reply' | 'forward' | 'reply_private';
+  broadcast_id?: string;
+  performed_by?: string;
+};
+
+export type QuickReplyContent = Omit<
+  SendMessageContent,
+  'broadcast_id' | 'variables'
+>;
+
+export type BroadcastVariableType = {
+  chat_id: string;
+  values: { [key: string]: string };
+};
+
+export type BroadcastMessagePayload = SendMessageContent & {
+  chat_ids: string[];
+  broadcast_id?: string;
+  variables?: BroadcastVariableType[];
+  delay?: number;
+};
+
+export type SingleMessagePayload = SendMessageContent & {
+  chat_id: string;
+  job_id?: string;
+  priority?: number;
+};
+
+export type MessageAttachmentFileTypes =
+  | 'image'
+  | 'audio'
+  | 'document'
+  | 'video';
+
+export type AttachmentFileType = {
+  result: string;
+  file: File | null;
+  type: MessageAttachmentFileTypes;
+  localFileURL?: string;
+};
+
+export type AttachmentLinkType = {
+  link: {
+    url: string;
+    type: MessageAttachmentFileTypes;
+    name: string;
+    mimetype?: string;
+  };
+};
+
+export type AttachmentTypeProps = AttachmentFileType | AttachmentLinkType;
+
+/* -------------------------------- BROADCAST ------------------------------- */
+
+export type BroadcastLogType = Tables<'view_broadcast_logs'> & {
+  logs: (Tables<'tbl_broadcast_logs'> & Partial<ChatType>)[];
+} & {
+  chats: ChatType[];
+};
+
+/* ----------------------- CHAT PARTICIPANT OPERATION ----------------------- */
+
+export type ChatLogType = {
+  log: Tables<'view_chat_logs'>;
+  operations: Tables<'tbl_chat_logs'>[];
+};
+export type ChatOperationsType = 'ADD' | 'REMOVE' | 'PROMOTE' | 'DEMOTE';
+
+export type ChatParticipantOperationPayload = {
+  participant_ids: string[];
+  chat_ids: string[];
+  performed_by: string;
+};
+
+export type ChatOperationReturn = {
+  [participant_id: string]: {
+    is_success: boolean;
+    message?: string;
+    code?: number;
+    isInviteV4Sent?: boolean;
+  };
+};
+
+/* ----------------------- BILLING - STRIPE ----------------------- */
+
+export type StripeSubscription = _Stripe.Subscription;
+export type StripeCustomer = _Stripe.Customer;
+export type StripeCoupon = _Stripe.Coupon;
+export type StripePrice = _Stripe.Price;
+export type Stripe = _Stripe;
+export type StripeUpcomingInvoice = _Stripe.UpcomingInvoice;
+export type StripeLineItem = _Stripe.Checkout.SessionCreateParams.LineItem;
+
+/* -------------------------------- REALTIME -------------------------------- */
+
+export type PhoneStateType = {
+  loading: boolean;
+  state: string;
+  sync: number;
+  percent: number | null;
+  message?: string;
+  error?: string;
+};
+
+/* ------------------------------- INTEGRATIONS ----------------------------- */
+
+export type ChatInfoType = Merge<
+  ChatType,
+  {
+    members: {
+      [key: string]: Merge<ChatMemberType, { contact_labels: string }>;
+    } | null;
+    chat_labels: string | null;
+    custom_properties: { [key: string]: string } | null;
+  }
+>;
+
+export type TicketInfoType = {
+  chat: ChatInfoType;
+  message: {
+    body: string;
+    chat_id: string;
+    org_phone: string;
+    timestamp: string;
+    media_path: string;
+    message_id: string;
+    sender_name: string;
+    performed_by: string;
+    sender_phone: string;
+  };
+  ticket: {
+    org_id: string;
+    status: string;
+    subject: string;
+    assignee: string;
+    due_date: string;
+    priority: 0 | 1 | 2 | 3 | 4;
+    raised_by: string;
+    ticket_id: string;
+    created_at: string;
+    assigned_by: string;
+    ticket_labels: string;
+    quoted_message_id: string;
+    ticket_custom_properties: { [key: string]: string } | null;
+  };
+  attached_messages: {
+    body: string;
+    chat_id: string;
+    org_phone: string;
+    timestamp: string;
+    media_path: string;
+    message_id: string;
+    sender_name: string;
+    performed_by: string;
+    sender_phone: string;
+  }[];
+};
+
+export type IntegrationLogObjectType =
+  | 'chat'
+  | 'message'
+  | 'reaction'
+  | 'ticket';
+
+export enum IntegrationLogType {
+  NEW_CHAT = 'chat.created',
+  NEW_CHAT_NOTIFICATION = 'chat.notification.created',
+  NEW_MESSAGE = 'message.created',
+  MESSAGE_UPDATED = 'message.updated',
+  MESSAGE_DELETED = 'message.deleted',
+  MESSAGE_ACK_UPDATED = 'message.ack.updated',
+  REACTION_CREATED = 'reaction.created',
+  REACTION_UPDATED = 'reaction.updated',
+  NEW_TICKET = 'ticket.created',
+  TICKET_UPDATED = 'ticket.updated',
+  TICKET_DELETED = 'ticket.deleted',
+  MESSAGE_FLAGGED = 'message.flagged',
+  MESSAGE_UNFLAGGED = 'message.unflagged',
+}
+
+export type IntegrationLogMetadataType<T extends IntegrationLogType> =
+  T extends IntegrationLogType.NEW_TICKET | IntegrationLogType.TICKET_UPDATED
+    ? TicketInfoType
+    : T extends IntegrationLogType.NEW_CHAT
+      ? Tables<'tbl_chats'>
+      : T extends
+            | IntegrationLogType.NEW_MESSAGE
+            | IntegrationLogType.MESSAGE_UPDATED
+            | IntegrationLogType.MESSAGE_DELETED
+            | IntegrationLogType.MESSAGE_ACK_UPDATED
+            | IntegrationLogType.MESSAGE_FLAGGED
+            | IntegrationLogType.MESSAGE_UNFLAGGED
+        ? Tables<'tbl_chat_messages'>
+        : T extends
+              | IntegrationLogType.REACTION_CREATED
+              | IntegrationLogType.REACTION_UPDATED
+          ? Tables<'tbl_chat_reactions'>
+          : {
+              [key: string]: unknown;
+            };
+
+export type IntegrationLogDetailsType<T extends IntegrationLogType> =
+  OverrideProperties<
+    Tables<'tbl_integration_logs'>,
+    {
+      integration_name: T;
+      metadata: {
+        event: IntegrationLogMetadataType<T> & {
+          event_type: string;
+          org_id: string;
+          previous_attributes: {
+            [key: string]: unknown;
+          };
+        };
+        hook_id: string;
+        name: string;
+      };
+    }
+  >;
+
+export type APIAuthDetails = {
+  org_details: Tables<'view_org'> | null;
+  phone_details: Tables<'tbl_org_phones'> | null;
+  token_details: Tables<'tbl_integration_tokens'> | null;
+};
+
+export type WebhookDataType = OverrideProperties<
+  Tables<'tbl_integration_hooks'>,
+  {
+    integration_name: string[];
+  }
+>;
+
+export type HubspotObjectDataType = {
+  createdAt: string;
+  archived: boolean;
+  id: string;
+  type: 'contacts' | 'tickets' | 'companies';
+  properties: Record<
+    string,
+    {
+      groupLabel: string;
+      groupName: string;
+      propertyKeyName: string;
+      propertyKey: string;
+      propertyInternalValue: string;
+      propertyValue: string;
+      propertyType: string;
+      propertyFieldType: string;
+    }[]
+  >;
+};
+
+/* ---------------------------- USER PREFERENCES ---------------------------- */
+
+export type UserPreferences = {
+  theme: 'light' | 'dark';
+  language: 'en' | 'es';
+  left_sidebar_open: boolean;
+  right_sidepanel_open: boolean;
+  sync_wa_unread_count: boolean;
+  pinned_chats: string[];
+  archived_chats: string[];
+  closed_chats: Record<string, number>;
+  periskope_chat_limit: number;
+};
+
+/* ----------------------------- POLL VOTE INFO ----------------------------- */
+
+export type PollSendType = {
+  pollName: string;
+  pollOptions: string[];
+  options?: {
+    allowMultipleAnswers?: boolean;
+    messageSecret?: number[] | null;
+    pollId?: string;
+  };
+};
+
+export type PollResultType = {
+  [name: string]: Record<string, string>;
+};
+
+/* -------------------------- CREATE GROUP OPTIONS -------------------------- */
+
+export type CreateGroupOptions = {
+  messagesAdminsOnly?: boolean;
+  infoAdminsOnly?: boolean;
+  memberAddMode?: boolean;
+  image?: string;
+  name?: string;
+  description?: string;
+};
+
+/* ------------------------------ DELIVERY INFO ----------------------------- */
+
+export type DeliveryInfoType = {
+  delivered: Record<string, number | undefined>;
+  read: Record<string, number | undefined>;
+  pending: string[];
+  read_count: number;
+  delivered_count: number;
+};
+
+/* ---------------------------- CREDITS SYSTEM ---------------------------- */
+
+export type OrgCreditsType = {
+  org_id: string;
+  recurring_allowance: number; // recurring credits replenished every month
+  recurring_balance: number; // recurring credits remaining in current month
+  topup_balance: number; // topup credits remaining
+  total_credits_used: number; // total credits used in current month
+  next_renewal_date: string;
+};
+
+/* --------------------------------- RULE INFO TYPE -------------------------------- */
+
+export type ChatRuleInfoType = Merge<
+  Pick<
+    Tables<'view_chats'>,
+    | 'assigned_to'
+    | 'chat_id'
+    | 'chat_name'
+    | 'chat_type'
+    | 'created_at'
+    | 'group_description'
+    | 'info_admins_only'
+    | 'org_id'
+    | 'org_phone'
+    | 'chat_org_phones'
+    | 'messages_admins_only'
+    | 'custom_properties'
+  >,
+  {
+    has_flagged_messages: boolean;
+    labels: string[];
+    members: string[];
+    custom_properties: { [key: string]: string } | null;
+  }
+>;
+
+export type SenderRuleInfoType = Merge<
+  Omit<
+    Merge<Tables<'tbl_contacts'>, Tables<'tbl_chat_participants'>>,
+    | 'verified_name'
+    | 'verified_level'
+    | 'updated_at'
+    | 'short_name'
+    | 'pushname'
+    | 'periskope_name'
+    | 'org_phone'
+    | 'number'
+    | 'name'
+    | 'label_ids'
+    | 'is_wa_contact'
+    | 'is_user'
+    | 'is_my_contact'
+    | 'is_me'
+    | 'is_imported'
+    | 'is_group'
+    | 'is_blocked'
+    | 'contact_color'
+    | 'business_profile'
+    | 'id'
+    | 'contact_image'
+    | 'contact_type'
+    | 'chat_id'
+    | 'is_business'
+    | 'is_enterprise'
+    | 'is_super_admin'
+  >,
+  {
+    is_internal: boolean;
+    labels: string[] | null;
+  }
+>;
+
+export type MessageRuleInfoType = {
+  chat: ChatRuleInfoType;
+  sender: SenderRuleInfoType;
+  message: OverrideProperties<
+    Omit<
+      Tables<'tbl_chat_messages'>,
+      | 'vcards'
+      | 'updated_at'
+      | 'unique_id'
+      | 'token'
+      | 'to'
+      | 'sent_message_id'
+      | 'raw_data'
+      | 'delivery_info'
+      | 'poll_results'
+      | 'poll_info'
+      | 'order_id'
+      | 'mentioned_ids'
+      | 'media_key'
+      | 'location'
+      | 'links'
+      | 'is_status'
+      | 'is_starred'
+      | 'is_gif'
+      | 'is_forwarded'
+      | 'is_ephemeral'
+      | 'is_deleted'
+      | 'fts'
+      | 'quoted_message_id'
+      | 'invite_v4'
+      | 'id'
+      | 'has_reaction'
+      | 'has_media'
+      | 'duration'
+      | 'broadcast'
+      | 'broadcast_id'
+      | 'device_type'
+      | 'forwarding_score'
+      | 'from'
+      | 'from_me'
+      | 'message_ticket_id'
+      | 'prev_body'
+      | 'flag_response_time'
+      | 'flag_metadata'
+      | 'ack'
+    >,
+    {
+      media: MediaType | null;
+    }
+  >;
+};
+
+export type ReactionRuleInfoType = {
+  chat: ChatRuleInfoType;
+  sender: SenderRuleInfoType;
+  message: MessageRuleInfoType['message'];
+  reaction: Pick<
+    Tables<'tbl_chat_reactions'>,
+    'reaction' | 'sender_id' | 'message_id' | 'chat_id' | 'reaction_id'
+  >;
+};
+
+export type TicketRuleInfoType = {
+  chat: ChatRuleInfoType;
+  sender: SenderRuleInfoType;
+  ticket: Merge<
+    Pick<
+      Tables<'tbl_chat_tickets'>,
+      | 'org_id'
+      | 'status'
+      | 'chat_id'
+      | 'subject'
+      | 'assignee'
+      | 'due_date'
+      | 'priority'
+      | 'raised_by'
+      | 'ticket_id'
+      | 'created_at'
+      | 'is_deleted'
+    >,
+    {
+      labels: string[] | null;
+      custom_properties: { [key: string]: string } | null;
+    }
+  >;
+  message: MessageRuleInfoType['message'];
+};
+export type FeatureFlagReturnType = Record<string, boolean>;
+
+export type RuleLogsType = OverrideProperties<
+  Tables<'tbl_rules_logs'>,
+  {
+    actions_progress: {
+      action_id: string;
+      action_type: Rule['actions'][number]['type'];
+      action_delay: Rule['actions'][number]['delay'];
+      ran_at: string | null;
+      action_status: 'success' | 'failed' | 'pending';
+      action_response: {
+        success: boolean;
+        data: Record<string, unknown> | null;
+        error: {
+          message: string;
+          name: string;
+          stack?: string;
+          _error?: Error | Record<string, unknown>;
+        } | null;
+      };
+    }[];
+    metadata: {
+      conditions: Rule['conditions'];
+      actions: Rule['actions'];
+      data: Record<string, unknown>;
+    };
+    conditions_progress: {
+      is_valid: boolean;
+      validation_progress: Record<
+        string,
+        {
+          res: boolean;
+          filter: Filter;
+          value: unknown;
+        }
+      >;
+      checked_at: string | null;
+    };
+  }
+>;