@periskope/types 0.6.51 → 0.6.53

package/dist/supabase.columns.d.ts

@@ -6,14 +6,14 @@ export declare const TableColumns: {
     readonly tbl_chat_notifications: readonly ["org_id", "notification_id", "chat_id", "author", "body", "id", "recipientids", "type", "timestamp", "org_phone"];
     readonly tbl_chat_participants: readonly ["org_id", "chat_id", "contact_id", "id", "is_admin", "is_super_admin", "org_phone"];
     readonly tbl_chat_reactions: readonly ["org_id", "message_id", "ack", "id", "orphan", "reaction", "read", "reaction_id", "timestamp", "msg_id", "orphan_reason", "sender_id", "org_phone"];
-    readonly tbl_chat_tickets: readonly ["created_at", "ticket_id", "subject", "status", "assignee", "assigned_by", "chat_id", "due_date", "org_id", "label_ids", "quoted_message_id", "raised_by", "priority", "last_updated_at"];
-    readonly tbl_chats: readonly ["org_id", "chat_id", "archived", "id", "is_group", "is_muted", "is_read_only", "mute_expiration", "name", "pinned", "unread_count", "group_metadata", "chat_image", "timestamp", "invite_link", "org_phone", "label_ids", "updated_at"];
+    readonly tbl_chat_tickets: readonly ["created_at", "ticket_id", "subject", "status", "assignee", "assigned_by", "chat_id", "due_date", "org_id", "label_ids", "quoted_message_id", "raised_by", "priority", "last_updated_at", "is_deleted"];
+    readonly tbl_chats: readonly ["org_id", "chat_id", "archived", "id", "is_group", "is_muted", "is_read_only", "mute_expiration", "name", "pinned", "unread_count", "group_metadata", "chat_image", "timestamp", "invite_link", "org_phone", "label_ids", "updated_at", "latest_message", "member_count"];
     readonly tbl_contacts: readonly ["org_id", "contact_id", "id", "number", "is_business", "is_enterprise", "name", "pushname", "short_name", "contact_type", "is_me", "is_user", "is_group", "is_wa_contact", "is_my_contact", "is_blocked", "contact_image", "contact_color", "business_profile", "verified_name", "is_internal", "label_ids", "verified_level", "updated_at"];
     readonly tbl_org: readonly ["org_id", "created_at", "org_image", "org_name", "support_link", "org_metadata", "org_plan", "stripe_customer_details", "stripe_customer_id", "stripe_subscription_details"];
     readonly tbl_org_labels: readonly ["label_id", "created_at", "org_id", "name", "color", "type"];
     readonly tbl_org_members: readonly ["created_at", "email", "user_id", "invited_at", "invited_by", "org_id", "role", "member_image", "member_name", "is_active", "member_color"];
     readonly tbl_org_phones: readonly ["org_id", "org_phone", "created_at", "updated_at", "wa_state", "phone_id", "qr_code", "phone_image", "phone_name", "server_ip"];
     readonly view_broadcast_logs: readonly ["broadcast_id", "org_id", "message_payload", "created_at", "total_chats", "sent_chats", "failed_chats", "total_member_count", "delivered_member_count", "read_member_count", "completed_at", "scheduled_at", "performed_by", "delivery_percentage", "read_percentage"];
-    readonly view_chat_messages: readonly ["message_id", "org_id", "ack", "author", "body", "from_me", "invite_v4", "links", "location", "mentioned_ids", "message_type", "vcards", "chat_id", "timestamp", "org_phone", "broadcast_id", "is_deleted", "media", "performed_by", "prev_body", "quoted_message_id", "sender_phone", "sent_message_id", "delivery_info", "updated_at", "message_ticket_id", "unique_id"];
-    readonly view_chats: readonly ["org_id", "chat_id", "org_phone", "chat_image", "invite_link", "label_ids", "updated_at", "chat_name", "latest_message", "message_unread_count", "member_count", "chat_type", "chat_access", "has_access", "last_read_timestamp", "chat_org_phones", "active_phone", "group_description"];
+    readonly view_chat_messages: readonly ["message_id", "org_id", "ack", "author", "body", "from_me", "invite_v4", "links", "location", "mentioned_ids", "message_type", "vcards", "chat_id", "timestamp", "org_phone", "broadcast_id", "is_deleted", "media", "performed_by", "prev_body", "quoted_message_id", "sender_phone", "sent_message_id", "delivery_info", "updated_at", "message_ticket_id", "unique_id", "is_gif", "is_forwarded", "is_starred"];
+    readonly view_chats: readonly ["org_id", "chat_id", "org_phone", "chat_image", "invite_link", "label_ids", "updated_at", "chat_name", "latest_message", "member_count", "chat_type", "chat_access", "has_access", "last_read_timestamp", "chat_org_phones", "active_phone", "group_description"];
 };

package/dist/supabase.columns.js

@@ -124,7 +124,8 @@ exports.TableColumns = {
         "quoted_message_id",
         "raised_by",
         "priority",
-        "last_updated_at"
+        "last_updated_at",
+        "is_deleted"
     ],
     "tbl_chats": [
         "org_id",
@@ -144,7 +145,9 @@ exports.TableColumns = {
         "invite_link",
         "org_phone",
         "label_ids",
-        "updated_at"
+        "updated_at",
+        "latest_message",
+        "member_count"
     ],
     "tbl_contacts": [
         "org_id",
@@ -261,7 +264,10 @@ exports.TableColumns = {
         "delivery_info",
         "updated_at",
         "message_ticket_id",
-        "unique_id"
+        "unique_id",
+        "is_gif",
+        "is_forwarded",
+        "is_starred"
     ],
     "view_chats": [
         "org_id",
@@ -273,7 +279,6 @@ exports.TableColumns = {
         "updated_at",
         "chat_name",
         "latest_message",
-        "message_unread_count",
         "member_count",
         "chat_type",
         "chat_access",

package/dist/supabase.types.d.ts

@@ -165,6 +165,7 @@ export interface Database {
                     is_gif: boolean | null;
                     is_starred: boolean | null;
                     is_status: boolean | null;
+                    is_supported_type: boolean | null;
                     links: Json | null;
                     location: Json | null;
                     media: Json | null;
@@ -213,6 +214,7 @@ export interface Database {
                     is_gif?: boolean | null;
                     is_starred?: boolean | null;
                     is_status?: boolean | null;
+                    is_supported_type?: boolean | null;
                     links?: Json | null;
                     location?: Json | null;
                     media?: Json | null;
@@ -261,6 +263,7 @@ export interface Database {
                     is_gif?: boolean | null;
                     is_starred?: boolean | null;
                     is_status?: boolean | null;
+                    is_supported_type?: boolean | null;
                     links?: Json | null;
                     location?: Json | null;
                     media?: Json | null;
@@ -459,6 +462,7 @@ export interface Database {
                     chat_id: string;
                     created_at: string;
                     due_date: string | null;
+                    is_deleted: boolean;
                     label_ids: Json | null;
                     last_updated_at: string;
                     org_id: string;
@@ -475,6 +479,7 @@ export interface Database {
                     chat_id: string;
                     created_at?: string;
                     due_date?: string | null;
+                    is_deleted?: boolean;
                     label_ids?: Json | null;
                     last_updated_at?: string;
                     org_id: string;
@@ -491,6 +496,7 @@ export interface Database {
                     chat_id?: string;
                     created_at?: string;
                     due_date?: string | null;
+                    is_deleted?: boolean;
                     label_ids?: Json | null;
                     last_updated_at?: string;
                     org_id?: string;
@@ -523,6 +529,8 @@ export interface Database {
                     is_muted: boolean | null;
                     is_read_only: boolean | null;
                     label_ids: Json;
+                    latest_message: Json | null;
+                    member_count: number | null;
                     mute_expiration: number | null;
                     name: string | null;
                     org_id: string;
@@ -543,6 +551,8 @@ export interface Database {
                     is_muted?: boolean | null;
                     is_read_only?: boolean | null;
                     label_ids?: Json;
+                    latest_message?: Json | null;
+                    member_count?: number | null;
                     mute_expiration?: number | null;
                     name?: string | null;
                     org_id: string;
@@ -563,6 +573,8 @@ export interface Database {
                     is_muted?: boolean | null;
                     is_read_only?: boolean | null;
                     label_ids?: Json;
+                    latest_message?: Json | null;
+                    member_count?: number | null;
                     mute_expiration?: number | null;
                     name?: string | null;
                     org_id?: string;
@@ -903,6 +915,9 @@ export interface Database {
                     from_me: boolean | null;
                     invite_v4: Json | null;
                     is_deleted: boolean | null;
+                    is_forwarded: boolean | null;
+                    is_gif: boolean | null;
+                    is_starred: boolean | null;
                     links: Json | null;
                     location: Json | null;
                     media: Json | null;
@@ -948,7 +963,6 @@ export interface Database {
                     last_read_timestamp: string | null;
                     latest_message: Json | null;
                     member_count: number | null;
-                    message_unread_count: number | null;
                     org_id: string | null;
                     org_phone: string | null;
                     updated_at: string | null;
@@ -974,7 +988,9 @@ export interface Database {
                 Returns: string;
             };
             gen_ticket_id: {
-                Args: Record<PropertyKey, never>;
+                Args: {
+                    org_id_input?: string;
+                };
                 Returns: string;
             };
             get_broadcast_id: {

package/dist/types.d.ts

@@ -1,3 +1,4 @@
+import type { default as _Stripe } from 'stripe';
 import { Merge, OverrideProperties } from 'type-fest';
 import { Chat, Location, MessageInfo } from 'whatsapp-web.js';
 import { Tables } from './supabase.types';
@@ -6,12 +7,44 @@ export type WhatsappChat = Chat & {
     pinned?: boolean;
     invite_link?: string;
 };
-export type OrgType = Tables<'tbl_org'> & {
+export declare enum AllPlans {
+    FREE_TRIAL = "free-trial",
+    MONTHLY_STARTER = "monthly-starter",
+    YEARLY_STARTER = "yearly-starter",
+    MONTHLY_PRO = "monthly-pro",
+    YEARLY_PRO = "yearly-pro",
+    ENTERPRISE = "enterprise"
+}
+export type Frequency = 'yearly' | 'monthly' | 'weekly' | 'custom';
+export type Enterprise = `${string}-enterprise`;
+export type OrgPlanEnterprise = {
+    plan_id: Enterprise;
+    frequency: Frequency;
+    user_limit: number;
+    phone_limit: number;
+    current_period_start: number;
+    current_period_end: number | null;
+};
+export type OrgPlanNonEnterprise = {
+    plan_id: AllPlans;
+    interval: number;
+    frequency: Frequency;
+    user_limit: number;
+    phone_limit: number;
+    percent_off: number | null;
+};
+export type OrgPlan<T extends AllPlans | Enterprise> = T extends Enterprise ? OrgPlanEnterprise : T extends AllPlans ? OrgPlanNonEnterprise : never;
+export type OrgType = OverrideProperties<Tables<'tbl_org'> & {
     user: Tables<'tbl_org_members'>;
     members: Tables<'tbl_org_members'>[];
     phones: Tables<'tbl_org_phones'>[];
     labels: Tables<'tbl_org_labels'>[];
-};
+}, {
+    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;
+}>;
 export type ChatMemberType = Merge<Tables<'tbl_chat_participants'>, Tables<'tbl_contacts'>>;
 export type ChatType = Merge<Tables<'view_chats'>, {
     chat_id: string;
@@ -39,7 +72,7 @@ export type MessageType = OverrideProperties<Tables<'view_chat_messages'>, {
     org_id: string;
     org_phone: string;
     chat_id: string;
-    message_type: typeof SUPPORTED_TYPES[number];
+    message_type: (typeof SUPPORTED_TYPES)[number];
     media: MediaType | null;
 }>;
 export type TicketType = OverrideProperties<Tables<'tbl_chat_tickets'>, {
@@ -55,7 +88,7 @@ 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"];
 export type SendMessageContent = {
-    message_type?: typeof SUPPORTED_TYPES[number];
+    message_type?: (typeof SUPPORTED_TYPES)[number];
     body?: string;
     media?: MediaType;
     contact_ids?: string[];
@@ -100,6 +133,10 @@ export type ChatParticipantOperation = {
 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 PhoneRealtimeChannel = {
     loading: boolean;
     state: string;

package/dist/types.js

@@ -1,6 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SUPPORTED_TYPES = exports.enumChatColors = exports.labelColors = void 0;
+exports.SUPPORTED_TYPES = exports.enumChatColors = exports.labelColors = exports.AllPlans = void 0;
+/* ------------------------------ PERISKOPE TYPES ------------------------------ */
+var AllPlans;
+(function (AllPlans) {
+    AllPlans["FREE_TRIAL"] = "free-trial";
+    AllPlans["MONTHLY_STARTER"] = "monthly-starter";
+    AllPlans["YEARLY_STARTER"] = "yearly-starter";
+    AllPlans["MONTHLY_PRO"] = "monthly-pro";
+    AllPlans["YEARLY_PRO"] = "yearly-pro";
+    AllPlans["ENTERPRISE"] = "enterprise";
+})(AllPlans || (exports.AllPlans = AllPlans = {}));
 /* -------------------------------- CONSTANTS ------------------------------- */
 exports.labelColors = [
     '#9333EA',

package/package.json

@@ -1,12 +1,13 @@
 {
     "name":  "@periskope/types",
-    "version":  "0.6.51",
+    "version":  "0.6.53",
     "private":  false,
     "main":  "dist/index.js",
     "types":  "dist/index.d.ts",
     "dependencies":  {
                          "@types/pg":  "8.11.2",
                          "pg":  "^8.11.3",
+                         "stripe":  "^14.19.0",
                          "ts-node":  "^10.9.2",
                          "type-fest":  "^4.8.3",
                          "whatsapp-web.js":  "1.23.1-alpha.4"

package/supabase.columns.ts

@@ -121,7 +121,8 @@ export const TableColumns = {
     "quoted_message_id",
     "raised_by",
     "priority",
-    "last_updated_at"
+    "last_updated_at",
+    "is_deleted"
   ],
   "tbl_chats": [
     "org_id",
@@ -141,7 +142,9 @@ export const TableColumns = {
     "invite_link",
     "org_phone",
     "label_ids",
-    "updated_at"
+    "updated_at",
+    "latest_message",
+    "member_count"
   ],
   "tbl_contacts": [
     "org_id",
@@ -258,7 +261,10 @@ export const TableColumns = {
     "delivery_info",
     "updated_at",
     "message_ticket_id",
-    "unique_id"
+    "unique_id",
+    "is_gif",
+    "is_forwarded",
+    "is_starred"
   ],
   "view_chats": [
     "org_id",
@@ -270,7 +276,6 @@ export const TableColumns = {
     "updated_at",
     "chat_name",
     "latest_message",
-    "message_unread_count",
     "member_count",
     "chat_type",
     "chat_access",

package/supabase.types.ts

@@ -164,6 +164,7 @@ export interface Database {
           is_gif: boolean | null
           is_starred: boolean | null
           is_status: boolean | null
+          is_supported_type: boolean | null
           links: Json | null
           location: Json | null
           media: Json | null
@@ -212,6 +213,7 @@ export interface Database {
           is_gif?: boolean | null
           is_starred?: boolean | null
           is_status?: boolean | null
+          is_supported_type?: boolean | null
           links?: Json | null
           location?: Json | null
           media?: Json | null
@@ -260,6 +262,7 @@ export interface Database {
           is_gif?: boolean | null
           is_starred?: boolean | null
           is_status?: boolean | null
+          is_supported_type?: boolean | null
           links?: Json | null
           location?: Json | null
           media?: Json | null
@@ -458,6 +461,7 @@ export interface Database {
           chat_id: string
           created_at: string
           due_date: string | null
+          is_deleted: boolean
           label_ids: Json | null
           last_updated_at: string
           org_id: string
@@ -474,6 +478,7 @@ export interface Database {
           chat_id: string
           created_at?: string
           due_date?: string | null
+          is_deleted?: boolean
           label_ids?: Json | null
           last_updated_at?: string
           org_id: string
@@ -492,6 +497,7 @@ export interface Database {
           chat_id?: string
           created_at?: string
           due_date?: string | null
+          is_deleted?: boolean
           label_ids?: Json | null
           last_updated_at?: string
           org_id?: string
@@ -526,6 +532,8 @@ export interface Database {
           is_muted: boolean | null
           is_read_only: boolean | null
           label_ids: Json
+          latest_message: Json | null
+          member_count: number | null
           mute_expiration: number | null
           name: string | null
           org_id: string
@@ -546,6 +554,8 @@ export interface Database {
           is_muted?: boolean | null
           is_read_only?: boolean | null
           label_ids?: Json
+          latest_message?: Json | null
+          member_count?: number | null
           mute_expiration?: number | null
           name?: string | null
           org_id: string
@@ -566,6 +576,8 @@ export interface Database {
           is_muted?: boolean | null
           is_read_only?: boolean | null
           label_ids?: Json
+          latest_message?: Json | null
+          member_count?: number | null
           mute_expiration?: number | null
           name?: string | null
           org_id?: string
@@ -906,6 +918,9 @@ export interface Database {
           from_me: boolean | null
           invite_v4: Json | null
           is_deleted: boolean | null
+          is_forwarded: boolean | null
+          is_gif: boolean | null
+          is_starred: boolean | null
           links: Json | null
           location: Json | null
           media: Json | null
@@ -951,7 +966,6 @@ export interface Database {
           last_read_timestamp: string | null
           latest_message: Json | null
           member_count: number | null
-          message_unread_count: number | null
           org_id: string | null
           org_phone: string | null
           updated_at: string | null
@@ -977,7 +991,9 @@ export interface Database {
         Returns: string
       }
       gen_ticket_id: {
-        Args: Record<PropertyKey, never>
+        Args: {
+          org_id_input?: string
+        }
         Returns: string
       }
       get_broadcast_id: {

package/types.ts

@@ -1,3 +1,4 @@
+import type { default as _Stripe } from 'stripe';
 import { Merge, OverrideProperties } from 'type-fest';
 import { Chat, Location, MessageInfo } from 'whatsapp-web.js';
 import { Tables } from './supabase.types';
@@ -14,13 +15,58 @@ export type WhatsappChat = Chat & {
 
 /* ------------------------------ PERISKOPE TYPES ------------------------------ */
 
-export type OrgType = Tables<'tbl_org'> & {
-  user: Tables<'tbl_org_members'>;
-  members: Tables<'tbl_org_members'>[];
-  phones: Tables<'tbl_org_phones'>[];
-  labels: Tables<'tbl_org_labels'>[];
+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',
+}
+
+export type Frequency = 'yearly' | 'monthly' | 'weekly' | 'custom';
+
+export type Enterprise = `${string}-enterprise`;
+
+export type OrgPlanEnterprise = {
+  plan_id: Enterprise;
+  frequency: Frequency;
+  user_limit: number;
+  phone_limit: number;
+  current_period_start: number;
+  current_period_end: number | null;
 };
 
+export type OrgPlanNonEnterprise = {
+  plan_id: AllPlans;
+  interval: number;
+  frequency: Frequency;
+  user_limit: number;
+  phone_limit: number;
+  percent_off: number | null;
+};
+
+export type OrgPlan<T extends AllPlans | Enterprise> = T extends Enterprise
+  ? OrgPlanEnterprise
+  : T extends AllPlans
+    ? OrgPlanNonEnterprise
+    : never;
+
+export type OrgType = OverrideProperties<
+  Tables<'tbl_org'> & {
+    user: Tables<'tbl_org_members'>;
+    members: Tables<'tbl_org_members'>[];
+    phones: Tables<'tbl_org_phones'>[];
+    labels: Tables<'tbl_org_labels'>[];
+  },
+  {
+    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;
+  }
+>;
+
 export type ChatMemberType = Merge<
   Tables<'tbl_chat_participants'>,
   Tables<'tbl_contacts'>
@@ -55,7 +101,7 @@ export type MessageType = OverrideProperties<
     org_id: string;
     org_phone: string;
     chat_id: string;
-    message_type: typeof SUPPORTED_TYPES[number];
+    message_type: (typeof SUPPORTED_TYPES)[number];
     media: MediaType | null;
   }
 >;
@@ -124,7 +170,7 @@ export const SUPPORTED_TYPES = [
 ] as const;
 
 export type SendMessageContent = {
-  message_type?: typeof SUPPORTED_TYPES[number];
+  message_type?: (typeof SUPPORTED_TYPES)[number];
   body?: string;
   media?: MediaType;
   contact_ids?: string[];
@@ -182,6 +228,12 @@ export type ChatParticipantOperationPayload = ChatParticipantOperation & {
   chat_ids: string[];
 };
 
+/* ----------------------- BILLING - STRIPE ----------------------- */
+
+export type StripeSubscription = _Stripe.Subscription;
+export type StripeCustomer = _Stripe.Customer;
+export type StripeCoupon = _Stripe.Coupon;
+export type StripePrice = _Stripe.Price;
 
 /* -------------------------------- REALTIME -------------------------------- */
 
@@ -194,4 +246,4 @@ export type PhoneRealtimeChannel = {
   message?: string;
   error?: string;
   presence_ref?: string;
-}
+};