@sovaria/sdk 0.0.0-stage → 0.5.0

package/dist/inapp.d.ts

@@ -0,0 +1,52 @@
+/**
+ * In-app messages and message engagement (opens and clicks).
+ *
+ * ```ts
+ * // On app start (and on screens / events you target in the console):
+ * const [msg] = await sov.inApp.fetch('app_open')
+ * if (msg) { showBanner(msg.content); await sov.inApp.impression(msg.id) }
+ * // button → await sov.inApp.click(msg.id); close → await sov.inApp.dismiss(msg.id)
+ *
+ * // When the user opens a push notification (its data has sov_send):
+ * await sov.inApp.trackOpen(notification.data)
+ * ```
+ *
+ * Messages are headless: your app draws them (`content.layout` is `banner`, `modal` or `card`, with `title`, `body`,
+ * `image` and up to two `buttons` `{label, action}`), so they match your design. A message is shown to a user at most
+ * its `max_impressions` times, and never again after a dismissal.
+ */
+export interface InAppMessage {
+    id: string;
+    name: string;
+    trigger: string;
+    priority: number;
+    content: {
+        title: string;
+        body: string;
+        image: string | null;
+        layout: 'banner' | 'modal' | 'card';
+        buttons: {
+            label: string;
+            action: string | null;
+        }[];
+        data: Record<string, string>;
+    };
+}
+type Requester = <T>(method: string, path: string, options?: {
+    body?: unknown;
+    query?: Record<string, string | number>;
+    requiresScope?: boolean;
+}) => Promise<T>;
+export declare class InAppMessages {
+    private readonly request;
+    constructor(request: Requester);
+    /** Messages the signed-in user should see now for `trigger` (`app_open`, `screen:<name>`, `event:<name>`). */
+    fetch(trigger?: string, limit?: number): Promise<InAppMessage[]>;
+    impression(id: string): Promise<unknown>;
+    click(id: string): Promise<unknown>;
+    dismiss(id: string): Promise<unknown>;
+    /** Report that the user opened a push from a messaging send (`data.sov_send`); does nothing for other pushes. */
+    trackOpen(data: Record<string, unknown> | null | undefined, kind?: 'open' | 'click'): Promise<boolean>;
+    private event;
+}
+export {};

package/dist/inapp.js

@@ -0,0 +1,48 @@
+/**
+ * In-app messages and message engagement (opens and clicks).
+ *
+ * ```ts
+ * // On app start (and on screens / events you target in the console):
+ * const [msg] = await sov.inApp.fetch('app_open')
+ * if (msg) { showBanner(msg.content); await sov.inApp.impression(msg.id) }
+ * // button → await sov.inApp.click(msg.id); close → await sov.inApp.dismiss(msg.id)
+ *
+ * // When the user opens a push notification (its data has sov_send):
+ * await sov.inApp.trackOpen(notification.data)
+ * ```
+ *
+ * Messages are headless: your app draws them (`content.layout` is `banner`, `modal` or `card`, with `title`, `body`,
+ * `image` and up to two `buttons` `{label, action}`), so they match your design. A message is shown to a user at most
+ * its `max_impressions` times, and never again after a dismissal.
+ */
+export class InAppMessages {
+    request;
+    constructor(request) {
+        this.request = request;
+    }
+    /** Messages the signed-in user should see now for `trigger` (`app_open`, `screen:<name>`, `event:<name>`). */
+    async fetch(trigger = 'app_open', limit = 3) {
+        const out = await this.request('GET', '/api/v1/messaging/in-app', { query: { trigger, limit }, requiresScope: false });
+        return out.messages ?? [];
+    }
+    impression(id) {
+        return this.event(id, 'impression');
+    }
+    click(id) {
+        return this.event(id, 'click');
+    }
+    dismiss(id) {
+        return this.event(id, 'dismiss');
+    }
+    /** Report that the user opened a push from a messaging send (`data.sov_send`); does nothing for other pushes. */
+    async trackOpen(data, kind = 'open') {
+        const sendId = typeof data?.sov_send === 'string' ? data.sov_send : '';
+        if (!sendId)
+            return false;
+        const out = await this.request('POST', '/api/v1/messaging/events', { body: { send_id: sendId, channel: 'push', kind }, requiresScope: false });
+        return Boolean(out?.recorded);
+    }
+    event(id, kind) {
+        return this.request('POST', `/api/v1/messaging/in-app/${encodeURIComponent(id)}/events`, { body: { kind }, requiresScope: false });
+    }
+}