@koloseum/types 0.3.6 → 0.3.8

package/dist/database-generated.d.ts

@@ -2955,6 +2955,7 @@ export type Database = {
                     id: string;
                     lounge_branch_id: string | null;
                     lounge_id: string;
+                    metadata: Json;
                     player_id: string;
                     role: string;
                     user_id: string;
@@ -2964,6 +2965,7 @@ export type Database = {
                     id?: string;
                     lounge_branch_id?: string | null;
                     lounge_id: string;
+                    metadata?: Json;
                     player_id: string;
                     role: string;
                     user_id: string;
@@ -2973,6 +2975,7 @@ export type Database = {
                     id?: string;
                     lounge_branch_id?: string | null;
                     lounge_id?: string;
+                    metadata?: Json;
                     player_id?: string;
                     role?: string;
                     user_id?: string;
@@ -3071,6 +3074,86 @@ export type Database = {
                 };
                 Relationships: [];
             };
+            notification_events: {
+                Row: {
+                    created_at: string;
+                    idempotency_key: string | null;
+                    request_id: number | null;
+                    response_data: Json | null;
+                    system_event_id: string;
+                    workflow_event_key: string;
+                };
+                Insert: {
+                    created_at?: string;
+                    idempotency_key?: string | null;
+                    request_id?: number | null;
+                    response_data?: Json | null;
+                    system_event_id: string;
+                    workflow_event_key: string;
+                };
+                Update: {
+                    created_at?: string;
+                    idempotency_key?: string | null;
+                    request_id?: number | null;
+                    response_data?: Json | null;
+                    system_event_id?: string;
+                    workflow_event_key?: string;
+                };
+                Relationships: [
+                    {
+                        foreignKeyName: "notification_events_system_event_id_fkey";
+                        columns: ["system_event_id"];
+                        isOneToOne: false;
+                        referencedRelation: "system_events";
+                        referencedColumns: ["id"];
+                    },
+                    {
+                        foreignKeyName: "notification_events_workflow_event_key_fkey";
+                        columns: ["workflow_event_key"];
+                        isOneToOne: false;
+                        referencedRelation: "notification_workflows";
+                        referencedColumns: ["event_key"];
+                    }
+                ];
+            };
+            notification_workflows: {
+                Row: {
+                    created_at: string;
+                    description: string | null;
+                    enabled: boolean;
+                    event_key: string;
+                    metadata: Json;
+                    system_event_type: string;
+                    updated_at: string | null;
+                };
+                Insert: {
+                    created_at?: string;
+                    description?: string | null;
+                    enabled?: boolean;
+                    event_key: string;
+                    metadata?: Json;
+                    system_event_type: string;
+                    updated_at?: string | null;
+                };
+                Update: {
+                    created_at?: string;
+                    description?: string | null;
+                    enabled?: boolean;
+                    event_key?: string;
+                    metadata?: Json;
+                    system_event_type?: string;
+                    updated_at?: string | null;
+                };
+                Relationships: [
+                    {
+                        foreignKeyName: "notification_workflows_system_event_type_fkey";
+                        columns: ["system_event_type"];
+                        isOneToOne: false;
+                        referencedRelation: "system_event_types";
+                        referencedColumns: ["event_type"];
+                    }
+                ];
+            };
             phone_verification_attempts: {
                 Row: {
                     created_at: string;
@@ -3692,6 +3775,7 @@ export type Database = {
                     gender_identity: Database["compliance"]["Enums"]["gender_identity"] | null;
                     id: string;
                     last_name: string;
+                    metadata: Json;
                     middle_names: string | null;
                     nationality: string;
                     phone: string;
@@ -3711,6 +3795,7 @@ export type Database = {
                     gender_identity?: Database["compliance"]["Enums"]["gender_identity"] | null;
                     id?: string;
                     last_name: string;
+                    metadata?: Json;
                     middle_names?: string | null;
                     nationality: string;
                     phone?: string;
@@ -3730,6 +3815,7 @@ export type Database = {
                     gender_identity?: Database["compliance"]["Enums"]["gender_identity"] | null;
                     id?: string;
                     last_name?: string;
+                    metadata?: Json;
                     middle_names?: string | null;
                     nationality?: string;
                     phone?: string;
@@ -4045,6 +4131,10 @@ export type Database = {
                 };
                 Returns: boolean;
             };
+            backfill_notification_response_data: {
+                Args: never;
+                Returns: number;
+            };
             check_annual_update_limit: {
                 Args: {
                     p_account_type: Database["compliance"]["Enums"]["account_type"];
@@ -4250,6 +4340,12 @@ export type Database = {
                     institution_name: string;
                 }[];
             };
+            get_suprsend_response: {
+                Args: {
+                    p_search: string;
+                };
+                Returns: Json;
+            };
             get_user_phone: {
                 Args: {
                     search?: string;
@@ -4371,6 +4467,15 @@ export type Database = {
                     user_id: string;
                 }[];
             };
+            send_suprsend_notification: {
+                Args: {
+                    p_idempotency_key?: string;
+                    p_system_event_id?: string;
+                    p_workflow_body: Json;
+                    p_workflow_event_key?: string;
+                };
+                Returns: undefined;
+            };
             submit_gaming_and_socials_data: {
                 Args: {
                     p_consoles: Json[];
@@ -4396,6 +4501,13 @@ export type Database = {
                 };
                 Returns: boolean;
             };
+            validate_suprsend_subscriber: {
+                Args: {
+                    p_person_data: Json;
+                    p_user_id: string;
+                };
+                Returns: undefined;
+            };
         };
         Enums: {
             account_type: "player" | "lounge";
@@ -4703,6 +4815,28 @@ export type Database = {
                     pronouns: Database["compliance"]["Enums"]["pronouns"][] | null;
                     pseudonym: string | null;
                 };
+                Insert: {
+                    birth_date?: never;
+                    created_at?: string | null;
+                    first_name?: string | null;
+                    id?: string | null;
+                    last_name?: string | null;
+                    middle_names?: string | null;
+                    nationality?: string | null;
+                    pronouns?: never;
+                    pseudonym?: string | null;
+                };
+                Update: {
+                    birth_date?: never;
+                    created_at?: string | null;
+                    first_name?: string | null;
+                    id?: string | null;
+                    last_name?: string | null;
+                    middle_names?: string | null;
+                    nationality?: string | null;
+                    pronouns?: never;
+                    pseudonym?: string | null;
+                };
                 Relationships: [
                     {
                         foreignKeyName: "players_nationality_fkey";
@@ -5862,7 +5996,13 @@ export type Database = {
             };
         };
         Views: {
-            [_ in never]: never;
+            lounge_average_ratings: {
+                Row: {
+                    average_rating: number | null;
+                    lounge_id: string | null;
+                };
+                Relationships: [];
+            };
         };
         Functions: {
             accept_session_invite: {

package/dist/external/suprsend.d.ts

@@ -1,15 +1,11 @@
 /**
- * Notification body for SuprSend workflow. Points to note:
+ * Notification body for SuprSend workflow.
  * - `delay` is the time delay after which the first notification will be sent
  * - `trigger_at` is the date string in ISO 8601 to trigger scheduled notifications
- * - `users` is the array of users to send the notification to
- * - `users[i].distinct_id` is the unique identifier of the user
- * - `users[i].$channels` is the array of channels to send the notification to
- * - `users[i].$email` is the email address to send the notification to
- * - `users[i].$whatsapp` is the WhatsApp number to send the notification to
- * - `delivery` is the delivery instruction for the notification, dictating how should notifications be sent and the success metric
- * - `delivery.time_to_live` and `delivery.mandatory_channels` will only be applicable if `delivery.smart` is true
- * - `data` is the data for the notification, can be any JSON
+ * - `users` is the array of users to send the notification to (legacy shape; API uses `recipients`)
+ * - `users[i]` / recipients: use WorkflowRecipient for type-safe construction
+ * - `delivery` is the delivery instruction for the notification
+ * - `data` is the variable data for the notification template
  * @see https://docs.suprsend.com/docs/node-trigger-workflow-from-api#dynamic-workflow-trigger
  */
 export interface WorkflowBody {
@@ -18,52 +14,96 @@ export interface WorkflowBody {
     notification_category: "transactional" | "promotional" | "system";
     delay?: string;
     trigger_at?: string;
-    users: {
-        distinct_id: string;
-        $channels?: string[];
-        $email?: string[];
-        $whatsapp?: string[];
-        $sms?: string[];
-        $androidpush?: {
-            token: string;
-            provider: string;
-            device_id: string;
-        }[];
-        $iospush?: {
-            token: string;
-            provider: string;
-            device_id: string;
-        }[];
-        $slack?: {
-            email?: string;
-            access_token: string;
-        } | {
-            user_id?: string;
-            access_token: string;
-        } | {
-            channel?: string;
-            access_token: string;
-        } | {
-            incoming_webhook: {
-                url: string;
-            };
-        };
-        $ms_teams?: {
-            tenant_id: string;
-            service_url: string;
-            conversation_id?: string;
-            user_id?: string;
-        } | {
-            incoming_webhook: {
-                url: string;
-            };
-        };
-    }[];
+    users: WorkflowRecipient[];
     delivery?: {
         smart: boolean;
         success: string;
         time_to_live?: string;
         mandatory_channels?: string[];
     };
-    data?: Record<string, any>;
+    data?: Record<string, unknown>;
+}
+/**
+ * One recipient in a SuprSend workflow trigger.
+ * - each item is either a user recipient (WorkflowUserRecipient) or an object recipient (WorkflowObjectRecipient)
+ * - used in the `recipients` array of the workflow trigger body (SuprSend API uses `recipients`; this codebase may alias as `users`)
+ * - custom properties on the recipient are available in templates as `$recipient.<property>`
+ * @see https://docs.suprsend.com/docs/node-trigger-workflow-from-api#identifying-recipients-inline
+ */
+export type WorkflowRecipient = WorkflowUserRecipient | WorkflowObjectRecipient;
+/**
+ * User recipient in a SuprSend workflow trigger.
+ * - `distinct_id` is the unique identifier of the user (e.g. platform user id)
+ * - `$channels` is the array of channels to send the notification to (email, sms, inbox, androidpush, iospush, slack, ms_teams, webpush, whatsapp)
+ * - `$email` is the array of email addresses to send the notification to
+ * - `$sms` is the array of phone numbers for SMS
+ * - `$whatsapp` is the array of WhatsApp numbers
+ * - `$preferred_language` is the recipient language (ISO 639-1 2-letter) for localisation
+ * - `$timezone` is the recipient timezone (IANA TZ identifier) for local-time delivery
+ * - `$skip_create` when true, do not auto-create the user in SuprSend (use when the user is already synced, e.g. from DB triggers)
+ * - additional keys are custom properties and are available in templates as `$recipient.<key>`
+ * @see https://docs.suprsend.com/docs/node-trigger-workflow-from-api#identifying-recipients-inline
+ */
+export interface WorkflowUserRecipient {
+    distinct_id: string;
+    $channels?: string[];
+    $email?: string[];
+    $sms?: string[];
+    $whatsapp?: string[];
+    $preferred_language?: string;
+    $timezone?: string;
+    $skip_create?: boolean;
+    $androidpush?: {
+        token: string;
+        provider: string;
+        device_id: string;
+    }[];
+    $iospush?: {
+        token: string;
+        provider: string;
+        device_id: string;
+    }[];
+    $slack?: {
+        email?: string;
+        access_token: string;
+    } | {
+        user_id?: string;
+        access_token: string;
+    } | {
+        channel?: string;
+        access_token: string;
+    } | {
+        incoming_webhook: {
+            url: string;
+        };
+    };
+    $ms_teams?: {
+        tenant_id: string;
+        service_url: string;
+        conversation_id?: string;
+        user_id?: string;
+    } | {
+        incoming_webhook: {
+            url: string;
+        };
+    };
+    [key: string]: string | string[] | boolean | number | object | undefined;
+}
+/**
+ * Object recipient in a SuprSend workflow trigger (non-user entity, e.g. team, channel, shared inbox). Points to note:
+ * - `object_type` is the type of the object (e.g. teams, departments)
+ * - `id` is the unique identifier of the object within that type
+ * - `$skip_create` when true, do not auto-create the object in SuprSend
+ * - `$email` is the array of email addresses for the object (e.g. shared inbox)
+ * - `$channels` is the array of channels to send the notification to
+ * - additional keys are custom properties and are available in templates as `$recipient.<key>`
+ * @see https://docs.suprsend.com/docs/node-trigger-workflow-from-api#identifying-recipients-inline
+ */
+export interface WorkflowObjectRecipient {
+    object_type: string;
+    id: string;
+    $skip_create?: boolean;
+    $email?: string[];
+    $channels?: string[];
+    [key: string]: string | string[] | boolean | number | object | undefined;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@koloseum/types",
-	"version": "0.3.6",
+	"version": "0.3.8",
 	"author": "Koloseum Technologies Limited",
 	"type": "module",
 	"description": "Type definitions for use across web apps (TypeScript)",