@proveanything/smartlinks 1.1.25 → 1.2.0

package/dist/api/comms.d.ts

@@ -1,49 +1,86 @@
-import type { SendNotificationRequest, SendNotificationResponse, CommunicationEvent, CommsQueryByUser, CommsRecipientIdsQuery, CommsRecipientsWithoutActionQuery, CommsRecipientsWithActionQuery, RecipientId, RecipientWithOutcome, LogCommunicationEventBody, LogBulkCommunicationEventsBody, AppendResult, AppendBulkResult } from "../types/comms";
+import type { CommunicationEvent, CommsQueryByUser, CommsRecipientIdsQuery, CommsRecipientsWithoutActionQuery, CommsRecipientsWithActionQuery, RecipientId, RecipientWithOutcome, LogCommunicationEventBody, LogBulkCommunicationEventsBody, AppendResult, AppendBulkResult } from "../types/comms";
 /**
  * Communications namespace for sending notifications and managing user communications
  */
 export declare namespace comms {
     /**
-     * Send a notification to specified targets within a collection.
-     *
-     * Supports multiple delivery methods including push notifications, email, and wallet pass updates.
-     * The notification will be delivered based on user preferences and the specified delivery mode.
-     *
-     * @param collectionId - ID of the collection containing the notification targets
-     * @param request - Notification configuration including targets, severity, and content templates
-    * @returns Promise resolving to the notification enqueue/queue status and totals
-     * @throws ErrorResponse if the request fails or targets are invalid
-     *
-     * @example
-     * ```typescript
-     * const result = await comms.sendNotification('my-collection', {
-     *   subjectTargets: [{ type: 'product', id: 'prod_123' }],
-     *   severity: 'important',
-     *   mode: 'preferred',
-     *   template: {
-     *     push: {
-     *       title: 'Update available',
-     *       body: 'We\'ve shipped an important update.',
-     *       icon: 'https://cdn.example.com/brand/logo-128.png'
-     *     },
-     *     email: {
-     *       subject: 'Important update for your product',
-     *       body: 'There\'s an important update. Open your pass or profile to learn more.'
-     *     },
-     *     walletUpdate: {
-     *       textModulesData: [
-     *         { id: 'notice', header: 'Update', body: 'Open your wallet pass for details.' }
-     *       ]
-     *     }
-     *   }
-     * })
-     * if (result.ok) {
-     *   console.log('Notification queued:', result.notificationId)
-     *   console.log('Totals:', result.status.totals)
-     * }
-     * ```
-     */
-    function sendNotification(collectionId: string, request: SendNotificationRequest): Promise<SendNotificationResponse>;
+     * Public: Get VAPID public key used for Web Push subscriptions.
+     * GET /public/collection/:collectionId/comm/push/vapidPublicKey
+     * Note: Key may be global; path is collection-scoped for consistency.
+     */
+    function getPushVapidPublicKey(collectionId: string): Promise<import("../types/comms").PushVapidResponse>;
+    /**
+     * Public: Register a Web Push subscription under unified comms.
+     * POST /public/collection/:collectionId/comm/push/register
+     */
+    function registerPush(collectionId: string, body: import("../types/comms").PushSubscribeRequest): Promise<import("../types/comms").PushSubscribeResponse>;
+    /**
+     * Admin: Get current comms settings for a collection.
+     * GET /admin/collection/:collectionId/comm.settings
+     * Optional query: includeSecret=true to include unsub.secret in response.
+     */
+    function getSettings(collectionId: string, opts?: {
+        includeSecret?: boolean;
+    }): Promise<import("../types/comms").CommsSettingsGetResponse>;
+    /**
+     * Admin: Patch comms settings for a collection.
+     * PATCH /admin/collection/:collectionId/comm.settings
+     */
+    function patchSettings(collectionId: string, body: import("../types/comms").CommsSettingsPatchBody): Promise<import("../types/comms").CommsSettingsGetResponse>;
+    /**
+     * Public: Fetch configured topics for a collection.
+     * GET /public/collection/:collectionId/comm/topics
+     */
+    function getPublicTopics(collectionId: string): Promise<import("../types/comms").CommsPublicTopicsResponse>;
+    /**
+     * Public: Unsubscribe a contact from a category or channel.
+     * GET /public/collection/:collectionId/comm/unsubscribe
+     */
+    function unsubscribe(collectionId: string, query: import("../types/comms").UnsubscribeQuery): Promise<import("../types/comms").UnsubscribeResponse>;
+    /**
+     * Public: Upsert default consent for a contact.
+     * POST /public/collection/:collectionId/comm/consent
+     */
+    function upsertConsent(collectionId: string, body: import("../types/comms").CommsConsentUpsertRequest): Promise<{
+        ok: true;
+    }>;
+    /**
+     * Public: Upsert preferences for a specific subject (or default if subject omitted).
+     * POST /public/collection/:collectionId/comm/preferences
+     */
+    function upsertPreferences(collectionId: string, body: import("../types/comms").CommsPreferencesUpsertRequest): Promise<{
+        ok: true;
+    }>;
+    /**
+     * Public: Subscribe/unsubscribe contact to a subject.
+     * POST /public/collection/:collectionId/comm/subscribe
+     */
+    function subscribe(collectionId: string, body: import("../types/comms").CommsSubscribeRequest): Promise<import("../types/comms").CommsSubscribeResponse>;
+    /**
+     * Public: Check subscription status for a subject.
+     * GET /public/collection/:collectionId/comm/subscription/check
+     */
+    function checkSubscription(collectionId: string, query: import("../types/comms").CommsSubscriptionCheckQuery): Promise<import("../types/comms").CommsSubscriptionCheckResponse>;
+    /**
+     * Public: List registered contact methods.
+     * GET /public/collection/:collectionId/comm/methods
+     */
+    function listMethods(collectionId: string, query: import("../types/comms").CommsListMethodsQuery): Promise<import("../types/comms").CommsListMethodsResponse>;
+    /**
+     * Public: Register email method for a contact.
+     * POST /public/collection/:collectionId/comm/email/register
+     */
+    function registerEmail(collectionId: string, body: import("../types/comms").RegisterEmailMethodRequest): Promise<import("../types/comms").RegisterMethodResponse>;
+    /**
+     * Public: Register SMS method for a contact.
+     * POST /public/collection/:collectionId/comm/sms/register
+     */
+    function registerSms(collectionId: string, body: import("../types/comms").RegisterSmsMethodRequest): Promise<import("../types/comms").RegisterMethodResponse>;
+    /**
+     * Public: Resolve contacts for a subject with identity hints.
+     * POST /public/collection/:collectionId/comm/subscriptions/resolve
+     */
+    function resolveSubscriptions(collectionId: string, body: import("../types/comms").SubscriptionsResolveRequest): Promise<import("../types/comms").SubscriptionsResolveResponse>;
     /**
      * Analytics: Query communication events by user or contact.
      * POST /admin/collection/:collectionId/comm/query/by-user

package/dist/api/comms.js

@@ -1,56 +1,165 @@
 // src/api/comms.ts
 // Communications and notifications API for Smartlinks
-import { post } from "../http";
+import { post, request, patch } from "../http";
 /**
  * Communications namespace for sending notifications and managing user communications
  */
 export var comms;
 (function (comms) {
     /**
-     * Send a notification to specified targets within a collection.
-     *
-     * Supports multiple delivery methods including push notifications, email, and wallet pass updates.
-     * The notification will be delivered based on user preferences and the specified delivery mode.
-     *
-     * @param collectionId - ID of the collection containing the notification targets
-     * @param request - Notification configuration including targets, severity, and content templates
-    * @returns Promise resolving to the notification enqueue/queue status and totals
-     * @throws ErrorResponse if the request fails or targets are invalid
-     *
-     * @example
-     * ```typescript
-     * const result = await comms.sendNotification('my-collection', {
-     *   subjectTargets: [{ type: 'product', id: 'prod_123' }],
-     *   severity: 'important',
-     *   mode: 'preferred',
-     *   template: {
-     *     push: {
-     *       title: 'Update available',
-     *       body: 'We\'ve shipped an important update.',
-     *       icon: 'https://cdn.example.com/brand/logo-128.png'
-     *     },
-     *     email: {
-     *       subject: 'Important update for your product',
-     *       body: 'There\'s an important update. Open your pass or profile to learn more.'
-     *     },
-     *     walletUpdate: {
-     *       textModulesData: [
-     *         { id: 'notice', header: 'Update', body: 'Open your wallet pass for details.' }
-     *       ]
-     *     }
-     *   }
-     * })
-     * if (result.ok) {
-     *   console.log('Notification queued:', result.notificationId)
-     *   console.log('Totals:', result.status.totals)
-     * }
-     * ```
-     */
-    async function sendNotification(collectionId, request) {
-        const path = `/admin/collection/${encodeURIComponent(collectionId)}/comm/notify`;
-        return post(path, request);
-    }
-    comms.sendNotification = sendNotification;
+     * Public: Get VAPID public key used for Web Push subscriptions.
+     * GET /public/collection/:collectionId/comm/push/vapidPublicKey
+     * Note: Key may be global; path is collection-scoped for consistency.
+     */
+    async function getPushVapidPublicKey(collectionId) {
+        const path = `/public/collection/${encodeURIComponent(collectionId)}/comm/push/vapidPublicKey`;
+        return request(path);
+    }
+    comms.getPushVapidPublicKey = getPushVapidPublicKey;
+    /**
+     * Public: Register a Web Push subscription under unified comms.
+     * POST /public/collection/:collectionId/comm/push/register
+     */
+    async function registerPush(collectionId, body) {
+        const path = `/public/collection/${encodeURIComponent(collectionId)}/comm/push/register`;
+        return post(path, body);
+    }
+    comms.registerPush = registerPush;
+    // Admin Comms Settings
+    /**
+     * Admin: Get current comms settings for a collection.
+     * GET /admin/collection/:collectionId/comm.settings
+     * Optional query: includeSecret=true to include unsub.secret in response.
+     */
+    async function getSettings(collectionId, opts = {}) {
+        const params = new URLSearchParams();
+        if (opts.includeSecret)
+            params.set('includeSecret', 'true');
+        const qs = params.toString() ? `?${params.toString()}` : '';
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/comm.settings${qs}`;
+        return request(path);
+    }
+    comms.getSettings = getSettings;
+    /**
+     * Admin: Patch comms settings for a collection.
+     * PATCH /admin/collection/:collectionId/comm.settings
+     */
+    async function patchSettings(collectionId, body) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/comm.settings`;
+        return patch(path, body);
+    }
+    comms.patchSettings = patchSettings;
+    /**
+     * Public: Fetch configured topics for a collection.
+     * GET /public/collection/:collectionId/comm/topics
+     */
+    async function getPublicTopics(collectionId) {
+        const path = `/public/collection/${encodeURIComponent(collectionId)}/comm/topics`;
+        return request(path);
+    }
+    comms.getPublicTopics = getPublicTopics;
+    /**
+     * Public: Unsubscribe a contact from a category or channel.
+     * GET /public/collection/:collectionId/comm/unsubscribe
+     */
+    async function unsubscribe(collectionId, query) {
+        const params = new URLSearchParams();
+        params.set('contactId', query.contactId);
+        if (query.topic)
+            params.set('topic', query.topic);
+        if (query.channel)
+            params.set('channel', query.channel);
+        if (query.token)
+            params.set('token', query.token);
+        const qs = `?${params.toString()}`;
+        const path = `/public/collection/${encodeURIComponent(collectionId)}/comm/unsubscribe${qs}`;
+        return request(path);
+    }
+    comms.unsubscribe = unsubscribe;
+    /**
+     * Public: Upsert default consent for a contact.
+     * POST /public/collection/:collectionId/comm/consent
+     */
+    async function upsertConsent(collectionId, body) {
+        const path = `/public/collection/${encodeURIComponent(collectionId)}/comm/consent`;
+        return post(path, body);
+    }
+    comms.upsertConsent = upsertConsent;
+    /**
+     * Public: Upsert preferences for a specific subject (or default if subject omitted).
+     * POST /public/collection/:collectionId/comm/preferences
+     */
+    async function upsertPreferences(collectionId, body) {
+        const path = `/public/collection/${encodeURIComponent(collectionId)}/comm/preferences`;
+        return post(path, body);
+    }
+    comms.upsertPreferences = upsertPreferences;
+    /**
+     * Public: Subscribe/unsubscribe contact to a subject.
+     * POST /public/collection/:collectionId/comm/subscribe
+     */
+    async function subscribe(collectionId, body) {
+        const path = `/public/collection/${encodeURIComponent(collectionId)}/comm/subscribe`;
+        return post(path, body);
+    }
+    comms.subscribe = subscribe;
+    /**
+     * Public: Check subscription status for a subject.
+     * GET /public/collection/:collectionId/comm/subscription/check
+     */
+    async function checkSubscription(collectionId, query) {
+        const params = new URLSearchParams();
+        params.set('contactId', query.contactId);
+        params.set('subjectType', query.subjectType);
+        params.set('subjectId', query.subjectId);
+        if (query.productId)
+            params.set('productId', String(query.productId));
+        const qs = `?${params.toString()}`;
+        const path = `/public/collection/${encodeURIComponent(collectionId)}/comm/subscription/check${qs}`;
+        return request(path);
+    }
+    comms.checkSubscription = checkSubscription;
+    /**
+     * Public: List registered contact methods.
+     * GET /public/collection/:collectionId/comm/methods
+     */
+    async function listMethods(collectionId, query) {
+        const params = new URLSearchParams();
+        params.set('contactId', query.contactId);
+        if (query.type)
+            params.set('type', query.type);
+        const qs = `?${params.toString()}`;
+        const path = `/public/collection/${encodeURIComponent(collectionId)}/comm/methods${qs}`;
+        return request(path);
+    }
+    comms.listMethods = listMethods;
+    /**
+     * Public: Register email method for a contact.
+     * POST /public/collection/:collectionId/comm/email/register
+     */
+    async function registerEmail(collectionId, body) {
+        const path = `/public/collection/${encodeURIComponent(collectionId)}/comm/email/register`;
+        return post(path, body);
+    }
+    comms.registerEmail = registerEmail;
+    /**
+     * Public: Register SMS method for a contact.
+     * POST /public/collection/:collectionId/comm/sms/register
+     */
+    async function registerSms(collectionId, body) {
+        const path = `/public/collection/${encodeURIComponent(collectionId)}/comm/sms/register`;
+        return post(path, body);
+    }
+    comms.registerSms = registerSms;
+    /**
+     * Public: Resolve contacts for a subject with identity hints.
+     * POST /public/collection/:collectionId/comm/subscriptions/resolve
+     */
+    async function resolveSubscriptions(collectionId, body) {
+        const path = `/public/collection/${encodeURIComponent(collectionId)}/comm/subscriptions/resolve`;
+        return post(path, body);
+    }
+    comms.resolveSubscriptions = resolveSubscriptions;
     /**
      * Analytics: Query communication events by user or contact.
      * POST /admin/collection/:collectionId/comm/query/by-user

package/dist/index.d.ts

@@ -4,10 +4,11 @@ export * from "./types";
 export { iframe } from "./iframe";
 export type { LoginResponse, VerifyTokenResponse, AccountInfoResponse, } from "./api/auth";
 export type { UserAccountRegistrationRequest, } from "./types/auth";
-export type { SendNotificationRequest, SendNotificationResponse, NotificationSubjectTarget, NotificationTemplate, PushNotificationTemplate, EmailNotificationTemplate, WalletUpdateTemplate, CommunicationEvent, CommsQueryByUser, CommsRecipientIdsQuery, CommsRecipientsWithoutActionQuery, CommsRecipientsWithActionQuery, RecipientId, RecipientWithOutcome, LogCommunicationEventBody, LogBulkCommunicationEventsBody, AppendResult, AppendBulkResult, } from "./types/comms";
+export type { CommunicationEvent, CommsQueryByUser, CommsRecipientIdsQuery, CommsRecipientsWithoutActionQuery, CommsRecipientsWithActionQuery, RecipientId, RecipientWithOutcome, LogCommunicationEventBody, LogBulkCommunicationEventsBody, AppendResult, AppendBulkResult, CommsSettings, TopicConfig, CommsSettingsGetResponse, CommsSettingsPatchBody, CommsPublicTopicsResponse, UnsubscribeQuery, UnsubscribeResponse, CommsConsentUpsertRequest, CommsPreferencesUpsertRequest, CommsSubscribeRequest, CommsSubscribeResponse, CommsSubscriptionCheckQuery, CommsSubscriptionCheckResponse, CommsListMethodsQuery, CommsListMethodsResponse, RegisterEmailMethodRequest, RegisterSmsMethodRequest, RegisterMethodResponse, SubscriptionsResolveRequest, SubscriptionsResolveResponse, } from "./types/comms";
 export type { AttestationResponse, AttestationCreateRequest, AttestationUpdateRequest, } from "./types/attestation";
 export type { BatchResponse, BatchCreateRequest, BatchUpdateRequest, } from "./types/batch";
 export type { VariantResponse, VariantCreateRequest, VariantUpdateRequest, } from "./types/variant";
+export type { BroadcastSendRequest } from "./types/broadcasts";
 export type { AppConfigOptions } from "./api/appConfiguration";
 export type { ProductCreateRequest, ProductUpdateRequest, Product, } from "./types/product";
 export type { Collection, CollectionResponse, CollectionCreateRequest, CollectionUpdateRequest, } from "./types/collection";

package/dist/types/broadcasts.d.ts

@@ -20,6 +20,18 @@ export interface BroadcastRecord {
             color?: string;
         };
         broadcastType?: string;
+        /** Required topic key for consent enforcement (e.g. newsletter, marketing, critical) */
+        topic: string;
+        /** Per-channel enablement/priority and optional template overrides */
+        channelSettings?: {
+            mode?: 'preferred' | 'channels' | 'all';
+            channels?: Array<{
+                channel: import('./broadcasts').BroadcastChannel;
+                enabled?: boolean;
+                priority?: number;
+                templateId?: string;
+            }>;
+        };
         [key: string]: unknown;
     };
     createdAt: string;
@@ -36,23 +48,55 @@ export interface BroadcastRecipientsResponse {
     offset: number;
     note?: string;
 }
+export type BroadcastChannel = 'email' | 'push' | 'sms' | 'wallet';
 export interface BroadcastPreviewRequest {
     contactId?: string;
     email?: string;
+    phone?: string;
     props?: Record<string, any>;
+    channelOverride?: BroadcastChannel;
+    hydrate?: boolean;
+    include?: {
+        product?: boolean;
+        proof?: boolean;
+        user?: boolean;
+        [k: string]: boolean | undefined;
+    };
 }
-export interface BroadcastPreviewResponse {
-    ok: boolean;
+export type BroadcastPreviewResponse = {
+    channel: 'email';
     html: string;
-}
-export interface BroadcastSendTestRequest {
-    to: string;
     subject?: string;
+    templateId?: string;
+} | {
+    channel: 'push';
+    payload: any;
+    subject?: string;
+} | {
+    channel: 'sms';
+    body: string;
+} | {
+    channel: 'wallet';
+    payload: any;
+};
+export interface BroadcastSendTestRequest {
+    contactId?: string;
+    email?: string;
+    phone?: string;
     props?: Record<string, any>;
+    channelOverride?: BroadcastChannel;
+    hydrate?: boolean;
+    include?: {
+        product?: boolean;
+        proof?: boolean;
+        user?: boolean;
+        [k: string]: boolean | undefined;
+    };
 }
 export interface BroadcastSendTestResponse {
     ok: boolean;
     id?: string;
+    channel?: BroadcastChannel;
 }
 export interface BroadcastSendManualRequest {
     limit?: number;
@@ -80,10 +124,23 @@ export interface BroadcastSendManualResponse {
         message?: string;
     }>;
 }
+export interface BroadcastSendRequest {
+    pageSize?: number;
+    maxPages?: number;
+    sharedContext?: Record<string, any>;
+    channel?: BroadcastChannel;
+    hydrate?: boolean;
+    include?: {
+        product?: boolean;
+        proof?: boolean;
+        user?: boolean;
+        [k: string]: boolean | undefined;
+    };
+}
 export interface BroadcastAppendEventBody {
     broadcastId: string;
     contactId?: string;
-    channel?: 'email';
+    channel?: BroadcastChannel;
     templateId?: string;
     eventType: string;
     outcome?: 'success' | 'failed';