@periskope/types 0.6.8 → 0.6.9-2.2

package/dist/types.d.ts

@@ -1,47 +1,326 @@
+import { Chat, Location } from '@periskope/whatsapp-web.js';
+import type { default as _Stripe } from 'stripe';
 import { Merge, OverrideProperties } from 'type-fest';
-import { Chat, MessageTypes } from 'whatsapp-web.js';
 import { Tables } from './supabase.types';
 export type WhatsappChat = Chat & {
     groupMetadata?: any;
     pinned?: boolean;
     invite_link?: string;
 };
-export type OrgType = Tables<'tbl_org'> & {
+export declare enum AllPlans {
+    FREE_TRIAL = "free-trial",
+    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;
+    allow_exports?: boolean;
+    sync_phone_contacts?: boolean;
+};
+export type OrgMetadata = {
+    phone_number: string;
+    ticket_prefix: string;
+    referralSource?: string;
+    surveyData?: MicrosurveyData;
+    onboarding: Record<string, boolean>;
+    onboarding_completed_at: Date | null;
+    preferences?: OrgPreferences;
+    hubspot_pipelines?: {
+        id: string;
+        label: string;
+        default_stage: {
+            id: string;
+            label: string;
+        };
+    }[];
+};
+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;
+}>, {
+    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;
-    members: Record<string, ChatMemberType> | null;
-    chat_type: 'user' | 'group' | 'business';
-    active_phone?: boolean;
-    org_participants?: Tables<'tbl_chat_participants'>[];
-    chat_access: Record<string, boolean>;
-    label_ids: Record<string, boolean>;
+    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;
 }>;
 export type MediaType = {
     path: string;
-    mimetype: string | null;
-    filename: string | null;
+    mimetype?: string;
+    filename?: string;
+    dimensions?: {
+        width: number;
+        height: number;
+        ar: number;
+    };
+    size?: number;
+    thumbnail?: string;
 };
 export type MessageType = OverrideProperties<Tables<'tbl_chat_messages'>, {
-    message_type: MessageTypes;
+    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;
+}>;
+export type MessageFlagType = {
+    status: boolean;
+    response_type?: 'message' | 'reaction' | 'ticket';
+    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;
 }>;
 export type ContactType = Merge<Tables<'tbl_contacts'>, {
     chats: ChatType[] | null;
-    chat_count: number | null;
-    chat_ids: string[] | null;
+    chat_ids?: string[];
 }>;
+export type ReactionType = Tables<'tbl_chat_reactions'>;
+export type NotificationType = Tables<'tbl_chat_notifications'>;
 export type ChatAccessType = Merge<Partial<Tables<'tbl_chat_access'>>, Tables<'tbl_org_members'>>;
-export type ServerStateType = {
+export declare const labelColors: string[];
+export declare const enumChatColors: readonly ["#B4876E", "#A5B337", "#06CF9C", "#25D366", "#02A698", "#7D9EF1", "#007BFC", "#5E47DE", "#7F66FF", "#9333EA", "#FA6533", "#C4532D", "#DC2626", "#FF2E74", "#DB2777"];
+export declare const SUPPORTED_TYPES: readonly ["chat", "sticker", "image", "video", "document", "vcard", "multi_vcard", "audio", "ptt", "poll_creation", "location"];
+export type SendMessageContent = {
+    message_type?: (typeof SUPPORTED_TYPES)[number];
+    body?: string;
+    media?: MediaType;
+    contact_ids?: string[];
+    location?: Location;
+    quoted_message_id?: string;
+    quoted_message_type?: 'reply' | 'forward' | 'reply_private';
+    broadcast_id?: string;
+    performed_by?: string;
+    variables?: {
+        [key: string]: VariableType;
+    };
+};
+export type QuickReplyContent = Omit<SendMessageContent, 'broadcast_id' | 'variables'>;
+export type VariableType = {
+    [key: string]: string;
+};
+export type BroadcastMessagePayload = SendMessageContent & {
+    chat_ids: string[];
+    broadcast_id?: string;
+};
+export type SingleMessagePayload = SendMessageContent & {
+    chat_id: string;
+    job_id?: string;
+};
+export type MessageAttachmentFileTypes = 'image' | 'audio' | 'document' | 'video';
+export type AttachmentTypeProps = {
+    result: string;
+    file: File | null;
+    type: MessageAttachmentFileTypes;
+} | {
+    link: {
+        url: string;
+        type: MessageAttachmentFileTypes;
+        name: string;
+        mimetype?: string;
+    };
+};
+export type BroadcastLogType = Tables<'view_broadcast_logs'> & {
+    logs: (Tables<'tbl_broadcast_logs'> & Partial<ChatType>)[];
+} & {
+    chats: ChatType[];
+};
+export type ChatParticipantOperation = {
+    participant_ids: string[];
+    operation_type: 'ADD' | 'REMOVE' | 'PROMOTE' | 'DEMOTE';
+};
+export type ChatParticipantOperationPayload = ChatParticipantOperation & {
+    chat_ids: string[];
+};
+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;
+export type PhoneStateType = {
     loading: boolean;
+    state: string;
+    sync: number;
     percent: number | null;
-    ready: boolean;
+    message?: string;
+    error?: string;
+};
+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;
+    };
+};
+export declare enum IntegrationLogType {
+    NEW_CHAT = "chat.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"
+}
+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 ? 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;
+    }[]>;
+};
+export type UserPreferences = {
+    theme: 'light' | 'dark';
+    language: 'en' | 'es';
+    left_sidebar_open: boolean;
+    right_sidepanel_open: boolean;
+    sync_wa_unread_count: boolean;
 };
-export declare const labelColors: string[];
-export declare const enumChatColors: readonly ["#B4876E", "#A5B337", "#06CF9C", "#25D366", "#02A698", "#7D9EF1", "#007BFC", "#5E47DE", "#7F66FF", "#9333EA", "#FA6533", "#C4532D", "#DC2626", "#FF2E74", "#DB2777"];

package/dist/types.js

@@ -1,6 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.enumChatColors = exports.labelColors = void 0;
+exports.IntegrationLogType = exports.SUPPORTED_TYPES = exports.enumChatColors = exports.labelColors = exports.AllPlans = void 0;
+/* ------------------------------ PERISKOPE TYPES ------------------------------ */
+var AllPlans;
+(function (AllPlans) {
+    AllPlans["FREE_TRIAL"] = "free-trial";
+    // MONTHLY_STARTER = 'monthly-starter',
+    // YEARLY_STARTER = 'yearly-starter',
+    // MONTHLY_PRO = 'monthly-pro',
+    // YEARLY_PRO = 'yearly-pro',
+    AllPlans["ENTERPRISE"] = "enterprise";
+    AllPlans["MONTHLY_STARTER_SINGLE"] = "monthly-starter-single";
+    AllPlans["YEARLY_STARTER_SINGLE"] = "yearly-starter-single";
+    AllPlans["MONTHLY_PRO_SINGLE"] = "monthly-pro-single";
+    AllPlans["YEARLY_PRO_SINGLE"] = "yearly-pro-single";
+})(AllPlans || (exports.AllPlans = AllPlans = {}));
 /* -------------------------------- CONSTANTS ------------------------------- */
 exports.labelColors = [
     '#9333EA',
@@ -26,3 +40,30 @@ exports.enumChatColors = [
     '#FF2E74',
     '#DB2777',
 ];
+/* -------------------------- SEND MESSAGE PAYLOAD -------------------------- */
+exports.SUPPORTED_TYPES = [
+    'chat',
+    'sticker',
+    'image',
+    'video',
+    'document',
+    'vcard',
+    'multi_vcard',
+    'audio',
+    'ptt',
+    'poll_creation',
+    'location',
+];
+var IntegrationLogType;
+(function (IntegrationLogType) {
+    IntegrationLogType["NEW_CHAT"] = "chat.created";
+    IntegrationLogType["NEW_MESSAGE"] = "message.created";
+    IntegrationLogType["MESSAGE_UPDATED"] = "message.updated";
+    IntegrationLogType["MESSAGE_DELETED"] = "message.deleted";
+    IntegrationLogType["MESSAGE_ACK_UPDATED"] = "message.ack.updated";
+    IntegrationLogType["REACTION_CREATED"] = "reaction.created";
+    IntegrationLogType["REACTION_UPDATED"] = "reaction.updated";
+    IntegrationLogType["NEW_TICKET"] = "ticket.created";
+    IntegrationLogType["TICKET_UPDATED"] = "ticket.updated";
+    IntegrationLogType["TICKET_DELETED"] = "ticket.deleted";
+})(IntegrationLogType || (exports.IntegrationLogType = IntegrationLogType = {}));

package/mod_json_type.ps1

@@ -11,5 +11,99 @@ $newTypeDefinition = 'export type Json = { [key: string]: any } | any'
 # Replace the old type definition with the new one
 $updatedContent = $fileContent -replace $oldTypeDefinition, $newTypeDefinition
 
+# Update interface to type
+$oldText = 'export interface Database '
+$newText = 'export type Database = '
+
+$updatedContent = $updatedContent -replace $oldText, $newText
+
+# Append the new type definition if it doesn't exist
+$addContent = @"
+type PublicSchema = Database[Extract<keyof Database, "public">]
+
+export type Tables<
+  PublicTableNameOrOptions extends
+    | keyof (PublicSchema["Tables"] & PublicSchema["Views"])
+    | { schema: keyof Database },
+  TableName extends PublicTableNameOrOptions extends { schema: keyof Database }
+    ? keyof (Database[PublicTableNameOrOptions["schema"]]["Tables"] &
+        Database[PublicTableNameOrOptions["schema"]]["Views"])
+    : never = never,
+> = PublicTableNameOrOptions extends { schema: keyof Database }
+  ? (Database[PublicTableNameOrOptions["schema"]]["Tables"] &
+      Database[PublicTableNameOrOptions["schema"]]["Views"])[TableName] extends {
+      Row: infer R
+    }
+    ? R
+    : never
+  : PublicTableNameOrOptions extends keyof (PublicSchema["Tables"] &
+        PublicSchema["Views"])
+    ? (PublicSchema["Tables"] &
+        PublicSchema["Views"])[PublicTableNameOrOptions] extends {
+        Row: infer R
+      }
+      ? R
+      : never
+    : never
+
+export type TablesInsert<
+  PublicTableNameOrOptions extends
+    | keyof PublicSchema["Tables"]
+    | { schema: keyof Database },
+  TableName extends PublicTableNameOrOptions extends { schema: keyof Database }
+    ? keyof Database[PublicTableNameOrOptions["schema"]]["Tables"]
+    : never = never,
+> = PublicTableNameOrOptions extends { schema: keyof Database }
+  ? Database[PublicTableNameOrOptions["schema"]]["Tables"][TableName] extends {
+      Insert: infer I
+    }
+    ? I
+    : never
+  : PublicTableNameOrOptions extends keyof PublicSchema["Tables"]
+    ? PublicSchema["Tables"][PublicTableNameOrOptions] extends {
+        Insert: infer I
+      }
+      ? I
+      : never
+    : never
+
+export type TablesUpdate<
+  PublicTableNameOrOptions extends
+    | keyof PublicSchema["Tables"]
+    | { schema: keyof Database },
+  TableName extends PublicTableNameOrOptions extends { schema: keyof Database }
+    ? keyof Database[PublicTableNameOrOptions["schema"]]["Tables"]
+    : never = never,
+> = PublicTableNameOrOptions extends { schema: keyof Database }
+  ? Database[PublicTableNameOrOptions["schema"]]["Tables"][TableName] extends {
+      Update: infer U
+    }
+    ? U
+    : never
+  : PublicTableNameOrOptions extends keyof PublicSchema["Tables"]
+    ? PublicSchema["Tables"][PublicTableNameOrOptions] extends {
+        Update: infer U
+      }
+      ? U
+      : never
+    : never
+
+export type Enums<
+  PublicEnumNameOrOptions extends
+    | keyof PublicSchema["Enums"]
+    | { schema: keyof Database },
+  EnumName extends PublicEnumNameOrOptions extends { schema: keyof Database }
+    ? keyof Database[PublicEnumNameOrOptions["schema"]]["Enums"]
+    : never = never,
+> = PublicEnumNameOrOptions extends { schema: keyof Database }
+  ? Database[PublicEnumNameOrOptions["schema"]]["Enums"][EnumName]
+  : PublicEnumNameOrOptions extends keyof PublicSchema["Enums"]
+    ? PublicSchema["Enums"][PublicEnumNameOrOptions]
+    : never
+"@
+
+# Append the new content to the updated content
+$updatedContent += $addContent
+
 # Write the updated content back to the file
-$updatedContent | Set-Content $filePath
+$updatedContent | Set-Content $filePath

package/package.json

@@ -1,14 +1,18 @@
 {
-  "name": "@periskope/types",
-  "version": "0.6.8",
-  "private": false,
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "dependencies": {
-    "type-fest": "^4.8.3",
-    "whatsapp-web.js": "^1.23.0"
-  },
-  "scripts": {
-    "update-package": "tsc && npm publish --access public"
-  }
+    "name": "@periskope/types",
+    "version": "0.6.92.2",
+    "private": false,
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "dependencies": {
+        "@periskope/whatsapp-web.js": "1.23.1-alpha.exodus.8",
+        "@types/pg": "8.11.2",
+        "pg": "^8.11.3",
+        "stripe": "^14.19.0",
+        "ts-node": "^10.9.2",
+        "type-fest": "^4.8.3"
+    },
+    "scripts": {
+        "update-package": "tsc \u0026\u0026 npm publish --access public"
+    }
 }