@proveanything/smartlinks 1.2.0 → 1.2.2

package/API_SUMMARY.md

@@ -1,6 +1,6 @@
 # Smartlinks API Summary
 
-Version: 1.2.0  |  Generated: 2026-01-21T15:47:06.455Z
+Version: 1.2.2  |  Generated: 2026-01-23T13:52:47.824Z
 
 This is a concise summary of all available API functions and types.
 
@@ -454,13 +454,13 @@ interface BroadcastRecord {
   }
   broadcastType?: string
   topic: string
+  templateParams?: Record<string, unknown>;
   channelSettings?: {
   mode?: 'preferred' | 'channels' | 'all'
   channels?: Array<{
-  channel: import('./broadcasts').BroadcastChannel
+  channel: BroadcastChannel
   enabled?: boolean
   priority?: number
-  templateId?: string
   }>
   }
   [key: string]: unknown
@@ -823,26 +823,6 @@ interface PushSubscriptionJSON {
 }
 ```
 
-**PushSubscribeMeta** (interface)
-```typescript
-interface PushSubscribeMeta {
-  collectionId: string
-  contactId?: string
-  userId?: string
-  productId?: string
-  labels?: Record<string, string>
-  [key: string]: any
-}
-```
-
-**PushSubscribeRequest** (interface)
-```typescript
-interface PushSubscribeRequest {
-  subscription: PushSubscriptionJSON
-  meta: PushSubscribeMeta
-}
-```
-
 **PushVapidResponse** (interface)
 ```typescript
 interface PushVapidResponse {
@@ -857,6 +837,16 @@ interface PushSubscribeResponse {
 }
 ```
 
+**RegisterPushMethodRequest** (interface)
+```typescript
+interface RegisterPushMethodRequest {
+  contactId: string
+  endpoint: string
+  keys: { p256dh: string; auth: string }
+  meta?: Record<string, any>
+}
+```
+
 **CommsSettings** (interface)
 ```typescript
 interface CommsSettings {
@@ -876,9 +866,12 @@ interface TopicConfig {
   label?: string
   description?: string
   labels?: string[]
+  classification?: 'transactional' | 'marketing'
   defaults?: {
   channels?: Partial<Record<BroadcastChannel, boolean>>
   topics?: Record<string, boolean | undefined>
+  policy?: 'opt-in' | 'opt-out'
+  byChannel?: Partial<Record<BroadcastChannel, 'opt-in' | 'opt-out'>>
   }
   rules?: {
   allowChannels?: BroadcastChannel[]
@@ -1203,6 +1196,33 @@ interface CommsState {
 }
 ```
 
+**BaseField** (interface)
+```typescript
+interface BaseField {
+  key: string
+  label: string
+  type: FieldType
+  widget: FieldWidget
+  visible: boolean
+  editable: boolean
+  readOnly: boolean
+}
+```
+
+**ContactSchema** (interface)
+```typescript
+interface ContactSchema {
+  version: number          // 1
+  fields: CoreField[]      // core fields
+  customFields: CustomField[]
+  settings: {
+  publicVisibleFields: string[]
+  publicEditableFields: string[]
+  customFieldsVersion: number
+  }
+}
+```
+
 **ContactCustomFields** = `Record<string, any>`
 
 **ContactResponse** = `Contact`
@@ -1219,6 +1239,10 @@ interface CommsState {
 
 **SubjectType** = `'product' | 'proof' | 'batch'`
 
+**FieldWidget** = `'text' | 'email' | 'tel' | 'select' | 'checkbox'`
+
+**FieldType** = ``
+
 ### error
 
 **ErrorResponse** (interface)
@@ -1888,6 +1912,7 @@ interface TemplateBase {
   push: { title: string; body: string, url?: string, iconUrl?: string },
   wallet?: { header: string; body: string; imageUri?: string }
   }
+  parameters: TemplateParameterSchema[]
   subject?: string
   body?: string
   css?: string
@@ -2604,6 +2629,8 @@ Logging: Append many communication events for a list of IDs. POST /admin/collect
 **publicUpdateMine**(collectionId: string,
     data: ContactPatch) → `Promise<PublicUpdateMyContactResponse>`
 
+**publicGetSchema**(collectionId: string) → `Promise<ContactSchema>`
+
 **erase**(collectionId: string, contactId: string, body?: any) → `Promise<ContactResponse>`
 
 **getUser**(collectionId: string,

package/dist/api/comms.d.ts

@@ -13,7 +13,7 @@ export declare namespace comms {
      * 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>;
+    function registerPush(collectionId: string, body: import("../types/comms").RegisterPushMethodRequest): Promise<import("../types/comms").PushSubscribeResponse>;
     /**
      * Admin: Get current comms settings for a collection.
      * GET /admin/collection/:collectionId/comm.settings

package/dist/api/contact.d.ts

@@ -1,4 +1,4 @@
-import { ContactResponse, ContactCreateRequest, ContactUpdateRequest, ContactListResponse, PublicContactUpsertRequest, PublicContactUpsertResponse, UserSearchResponse, ContactPatch, PublicGetMyContactResponse, PublicUpdateMyContactResponse } from "../types";
+import { ContactResponse, ContactCreateRequest, ContactUpdateRequest, ContactListResponse, PublicContactUpsertRequest, PublicContactUpsertResponse, UserSearchResponse, ContactPatch, PublicGetMyContactResponse, PublicUpdateMyContactResponse, ContactSchema } from "../types";
 export declare namespace contact {
     function create(collectionId: string, data: ContactCreateRequest): Promise<ContactResponse>;
     function list(collectionId: string, params?: {
@@ -19,6 +19,7 @@ export declare namespace contact {
     function publicUpsert(collectionId: string, data: PublicContactUpsertRequest): Promise<PublicContactUpsertResponse>;
     function publicGetMine(collectionId: string): Promise<PublicGetMyContactResponse>;
     function publicUpdateMine(collectionId: string, data: ContactPatch): Promise<PublicUpdateMyContactResponse>;
+    function publicGetSchema(collectionId: string): Promise<ContactSchema>;
     function erase(collectionId: string, contactId: string, body?: any): Promise<ContactResponse>;
     function getUser(collectionId: string, userId: string): Promise<UserSearchResponse>;
 }

package/dist/api/contact.js

@@ -71,6 +71,12 @@ export var contact;
         return patch(path, data);
     }
     contact.publicUpdateMine = publicUpdateMine;
+    // Public: Get contact update schema for a collection
+    async function publicGetSchema(collectionId) {
+        const path = `/public/collection/${encodeURIComponent(collectionId)}/contacts/schema`;
+        return request(path);
+    }
+    contact.publicGetSchema = publicGetSchema;
     async function erase(collectionId, contactId, body) {
         const path = `/admin/collection/${encodeURIComponent(collectionId)}/contacts/${encodeURIComponent(contactId)}/erase`;
         return post(path, body || {});

package/dist/types/broadcasts.d.ts

@@ -3,6 +3,7 @@ export interface ListBroadcastsQuery {
     offset?: number;
     appId?: string;
 }
+export type BroadcastChannel = 'email' | 'push' | 'sms' | 'wallet';
 export interface BroadcastRecord {
     id: string;
     collectionId: string;
@@ -22,14 +23,15 @@ export interface BroadcastRecord {
         broadcastType?: string;
         /** Required topic key for consent enforcement (e.g. newsletter, marketing, critical) */
         topic: string;
+        /** Required topic key for consent enforcement (e.g. newsletter, marketing, critical) */
+        templateParams?: Record<string, unknown>;
         /** Per-channel enablement/priority and optional template overrides */
         channelSettings?: {
             mode?: 'preferred' | 'channels' | 'all';
             channels?: Array<{
-                channel: import('./broadcasts').BroadcastChannel;
+                channel: BroadcastChannel;
                 enabled?: boolean;
                 priority?: number;
-                templateId?: string;
             }>;
         };
         [key: string]: unknown;
@@ -48,7 +50,6 @@ export interface BroadcastRecipientsResponse {
     offset: number;
     note?: string;
 }
-export type BroadcastChannel = 'email' | 'push' | 'sms' | 'wallet';
 export interface BroadcastPreviewRequest {
     contactId?: string;
     email?: string;

package/dist/types/comms.d.ts

@@ -108,25 +108,6 @@ export interface PushSubscriptionJSON {
         auth?: string;
     };
 }
-export interface PushSubscribeMeta {
-    /** Required collection scope */
-    collectionId: string;
-    /** Optional explicit contact ID */
-    contactId?: string;
-    /** Optional user ID; may be mapped to a contact like "user:{userId}" */
-    userId?: string;
-    /** Optional product scope */
-    productId?: string;
-    /** Optional labels and arbitrary metadata */
-    labels?: Record<string, string>;
-    [key: string]: any;
-}
-export interface PushSubscribeRequest {
-    /** Browser/service worker subscription payload */
-    subscription: PushSubscriptionJSON;
-    /** Metadata and scoping */
-    meta: PushSubscribeMeta;
-}
 export interface PushVapidResponse {
     publicKey: string;
 }
@@ -134,6 +115,15 @@ export interface PushSubscribeResponse {
     ok: true;
     id: string;
 }
+export interface RegisterPushMethodRequest {
+    contactId: string;
+    endpoint: string;
+    keys: {
+        p256dh: string;
+        auth: string;
+    };
+    meta?: Record<string, any>;
+}
 export interface CommsSettings {
     unsub?: {
         requireToken?: boolean;
@@ -151,9 +141,15 @@ export interface TopicConfig {
     description?: string;
     /** Optional UI-only grouping labels */
     labels?: string[];
+    /** Classification for UI and default policy guidance */
+    classification?: 'transactional' | 'marketing';
     defaults?: {
         channels?: Partial<Record<BroadcastChannel, boolean>>;
         topics?: Record<string, boolean | undefined>;
+        /** Default consent policy when explicit preferences are absent */
+        policy?: 'opt-in' | 'opt-out';
+        /** Per-channel default policy (overrides policy when present) */
+        byChannel?: Partial<Record<BroadcastChannel, 'opt-in' | 'opt-out'>>;
     };
     rules?: {
         allowChannels?: BroadcastChannel[];

package/dist/types/contact.d.ts

@@ -129,3 +129,32 @@ export interface CommsState {
     /** Keyed by `_default` or `${type}_${id}` */
     preferences?: Record<string, PreferenceEntry>;
 }
+export type FieldWidget = 'text' | 'email' | 'tel' | 'select' | 'checkbox';
+export type FieldType = 'string' | 'url' | 'email' | 'tel' | 'text' | 'select' | 'checkbox' | 'boolean';
+export interface BaseField {
+    key: string;
+    label: string;
+    type: FieldType;
+    widget: FieldWidget;
+    visible: boolean;
+    editable: boolean;
+    readOnly: boolean;
+}
+export interface CoreField extends BaseField {
+}
+export interface CustomField extends BaseField {
+    path: string;
+    required: boolean;
+    order?: number;
+    options?: string[];
+}
+export interface ContactSchema {
+    version: number;
+    fields: CoreField[];
+    customFields: CustomField[];
+    settings: {
+        publicVisibleFields: string[];
+        publicEditableFields: string[];
+        customFieldsVersion: number;
+    };
+}

package/dist/types/template.d.ts

@@ -1,3 +1,10 @@
+interface TemplateParameterSchema {
+    key: string;
+    label?: string;
+    type?: string;
+    required?: boolean;
+    defaultValue?: string;
+}
 export interface TemplateBase {
     id: string;
     collectionId: string;
@@ -31,6 +38,7 @@ export interface TemplateBase {
             imageUri?: string;
         };
     };
+    parameters: TemplateParameterSchema[];
     subject?: string;
     body?: string;
     css?: string;
@@ -65,3 +73,4 @@ export interface TemplateRenderSourceResponse {
     ok: boolean;
     html: string;
 }
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@proveanything/smartlinks",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "description": "Official JavaScript/TypeScript SDK for the Smartlinks API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",