@proveanything/smartlinks 1.0.60 → 1.0.62

package/API_SUMMARY.md

@@ -1,6 +1,6 @@
 # Smartlinks API Summary
 
-Version: 1.0.60  |  Generated: 2025-12-10T13:55:07.921Z
+Version: 1.0.62  |  Generated: 2025-12-17T18:11:04.911Z
 
 This is a concise summary of all available API functions and types.
 
@@ -19,6 +19,7 @@ The Smartlinks SDK is organized into the following namespaces:
 - **claimSet** - Claim creation, management, and verification
 - **collection** - Collection CRUD operations and management
 - **comms** - Functions for comms operations
+- **contact** - Functions for contact operations
 - **crate** - Container/crate management for organizing products
 - **form** - Dynamic form creation and submission
 - **nfc** - Functions for nfc operations
@@ -65,6 +66,11 @@ Internal helper that performs a POST request to `${baseURL}${path}`, injecting h
   extraHeaders?: Record<string, string>) → `Promise<T>`
 Internal helper that performs a PUT request to `${baseURL}${path}`, injecting headers for apiKey or bearerToken if present. If body is FormData, Content-Type is not set. Returns the parsed JSON as T, or throws an Error.
 
+**patch**(path: string,
+  body: any,
+  extraHeaders?: Record<string, string>) → `Promise<T>`
+Internal helper that performs a PATCH request to `${baseURL}${path}`, injecting headers for apiKey or bearerToken if present. If body is FormData, Content-Type is not set. Returns the parsed JSON as T, or throws an Error.
+
 **requestWithOptions**(path: string,
   options: RequestInit) → `Promise<T>`
 Internal helper that performs a request to `${baseURL}${path}` with custom options, injecting headers for apiKey or bearerToken if present. Returns the parsed JSON as T, or throws an Error.
@@ -108,29 +114,29 @@ interface AssetResponse {
 **AttestationResponse** (interface)
 ```typescript
 interface AttestationResponse {
-  id: string // Attestation id
-  createdAt: string // Creation timestamp
-  updatedAt: string // Last updated timestamp
-  public: Record<string, any> // Public attestation data
-  private: Record<string, any> // Private attestation data
-  proof: Record<string, any> // Associated proof reference/data
+  id: string
+  createdAt: string
+  updatedAt: string
+  public: Record<string, any>
+  private: Record<string, any>
+  proof: Record<string, any>
 }
 ```
 
 **AttestationCreateRequest** (interface)
 ```typescript
 interface AttestationCreateRequest {
-  public: Record<string, any> // Public attestation payload
-  private: Record<string, any> // Private attestation payload
-  proof: Record<string, any> // Proof linkage or payload
+  public: Record<string, any>
+  private: Record<string, any>
+  proof: Record<string, any>
 }
 ```
 
 **AttestationUpdateRequest** (interface)
 ```typescript
 interface AttestationUpdateRequest {
-  type?: string // Update operation/type
-  data?: Record<string, any> // Partial attestation data
+  type?: string
+  data?: Record<string, any>
 }
 ```
 
@@ -138,14 +144,21 @@ interface AttestationUpdateRequest {
 
 **UserAccountRegistrationRequest** (type)
 ```typescript
-type UserAccountRegistrationRequest = {
-  name: string // User's display name
-  email?: string // Optional user email
-  phone?: string // Optional user phone number
-  password?: string // Optional password for email login
-  sendAccountConfirmation?: boolean // Send confirmation email after registration
-  collectionId?: string, // Optional collection context for registration
-  tokenType?: 'bearer' | 'firebase' // Desired token type returned
+type UserAccountRegistrationRequest = {
+  /** User's display name */
+  name: string
+  /** Optional user email */
+  email?: string
+  /** Optional user phone number */
+  phone?: string
+  /** Optional password for email login */
+  password?: string
+  /** Send confirmation email after registration */
+  sendAccountConfirmation?: boolean
+  /** Optional collection context for registration */
+  collectionId?: string,
+  /** Desired token type returned */
+  tokenType?: 'bearer' | 'firebase'
 }
 ```
 
@@ -320,30 +333,30 @@ interface AuthKitConfig {
 **ClaimCodeRef** (interface)
 ```typescript
 interface ClaimCodeRef {
-  codeId: string // Identifier of the code (e.g., tag or QR code)
-  claimId: string // Identifier of the claim within the claim set
+  codeId: string
+  claimId: string
 }
 ```
 
 **UpdateClaimDataRequest** (interface)
 ```typescript
 interface UpdateClaimDataRequest {
-  data: Record<string, any> // Arbitrary key/value pairs for the claim data update
-  codes: ClaimCodeRef[] // Array of code+claim references affected by this update
+  data: Record<string, any>
+  codes: ClaimCodeRef[]
 }
 ```
 
 **AssignClaimsRequest** (interface)
 ```typescript
 interface AssignClaimsRequest {
-  id: string // The claim set ID (required)
-  collectionId: string // The collection ID (required)
-  productId: string // The product ID (required)
-  batchId?: string // Optional batch identifier
-  start?: number // Optional start index for bulk assignment
-  end?: number // Optional end index for bulk assignment
-  codeId?: string // Optional single code identifier for single assignment
-  data?: Record<string, any> // Optional key/value pairs to set on the claim
+  id: string
+  collectionId: string
+  productId: string
+  batchId?: string
+  start?: number
+  end?: number
+  codeId?: string
+  data?: Record<string, any>
 }
 ```
 
@@ -352,35 +365,35 @@ interface AssignClaimsRequest {
 **CollectionResponse** (interface)
 ```typescript
 interface CollectionResponse {
-  id: string // Unique identifier for the collection
-  title: string // Human-readable title of the collection
-  description: string // Description of collection
+  id: string
+  title: string
+  description: string
   headerImage?: {
-  url: string // URL to the asset
-  thumbnails: { // Thumbnail URLs in different sizes
+  url: string
+  thumbnails: {
   x100: string
   x200: string
   x512: string
   }
   }
   logoImage?: {
-  url: string // URL to the asset
-  thumbnails: { // Thumbnail URLs in different sizes
+  url: string
+  thumbnails: {
   x100: string
   x200: string
   x512: string
   }
   }
   loaderImage?: {
-  overwriteName: string // Override name for the file
-  name: string // Name of the asset
-  type: string // File type/extension
-  url: string // URL to the asset
+  overwriteName: string
+  name: string
+  type: string
+  url: string
   }
   languages?: {
-  code: string // Language code (e.g., "fr", "it", "es")
-  lang: string // Human-readable language name (e.g., "French", "Italian")
-  supported: boolean // Whether this language is supported
+  code: string
+  lang: string
+  supported: boolean
   }[],
   roles: {
   [userId: string]: string
@@ -397,25 +410,25 @@ interface CollectionResponse {
 **NotificationSubjectTarget** (interface)
 ```typescript
 interface NotificationSubjectTarget {
-  type: 'product' | 'collection' | 'user' | 'batch' | 'proof' // Type of target entity
-  id: string // ID of the target entity
+  type: 'product' | 'collection' | 'user' | 'batch' | 'proof'
+  id: string
 }
 ```
 
 **PushNotificationTemplate** (interface)
 ```typescript
 interface PushNotificationTemplate {
-  title: string // Notification title
-  body: string // Notification body text
-  icon?: string // Optional icon URL for the notification
+  title: string
+  body: string
+  icon?: string
 }
 ```
 
 **EmailNotificationTemplate** (interface)
 ```typescript
 interface EmailNotificationTemplate {
-  subject: string // Email subject line
-  body: string // Email body content (plain text or HTML)
+  subject: string
+  body: string
 }
 ```
 
@@ -423,9 +436,9 @@ interface EmailNotificationTemplate {
 ```typescript
 interface WalletUpdateTemplate {
   textModulesData?: Array<{
-  id: string // Module ID
-  header: string // Module header text
-  body: string // Module body text
+  id: string
+  header: string
+  body: string
   }>
 }
 ```
@@ -433,42 +446,42 @@ interface WalletUpdateTemplate {
 **NotificationTemplate** (interface)
 ```typescript
 interface NotificationTemplate {
-  push?: PushNotificationTemplate // Push notification content
-  email?: EmailNotificationTemplate // Email notification content
-  walletUpdate?: WalletUpdateTemplate // Wallet pass update content
+  push?: PushNotificationTemplate
+  email?: EmailNotificationTemplate
+  walletUpdate?: WalletUpdateTemplate
 }
 ```
 
 **SendNotificationRequest** (interface)
 ```typescript
 interface SendNotificationRequest {
-  subjectTargets: NotificationSubjectTarget[] // Target subjects that should receive the notification
-  severity: 'low' | 'normal' | 'important' | 'critical' // Severity level of the notification
-  mode: 'preferred' | 'all' // Delivery channel mode preference
-  channels : ("push" | "email" | "wallet")[] // Specific channels to use for delivery
-  template: NotificationTemplate // Notification content templates for different delivery methods
+  subjectTargets: NotificationSubjectTarget[]
+  severity: 'low' | 'normal' | 'important' | 'critical'
+  mode: 'preferred' | 'all'
+  channels : ("push" | "email" | "wallet")[]
+  template: NotificationTemplate
 }
 ```
 
 **SendNotificationResponse** (interface)
 ```typescript
 interface SendNotificationResponse {
-  ok: boolean // Whether the request was accepted
-  notificationId: string // Unique ID for this notification
-  counts: { // Basic counts for contacts and attempts
+  ok: boolean
+  notificationId: string
+  counts: {
   contacts: number
   attempts: number
   }
-  status: { // Detailed status for the notification
+  status: {
   notification: {
-  notificationId: string // The notification ID (repeated for convenience)
-  state: 'queued' | 'sent' | 'failed' | 'confirmed' | string // Current processing state
-  subjectTargets: NotificationSubjectTarget[] // Targets this notification refers to
-  severity: 'low' | 'normal' | 'important' | 'critical' | string // Severity of this notification
-  channelsOverride: Record<string, any> // Optional channel overrides used when sending
-  template: NotificationTemplate // The effective template used
+  notificationId: string
+  state: 'queued' | 'sent' | 'failed' | 'confirmed' | string
+  subjectTargets: NotificationSubjectTarget[]
+  severity: 'low' | 'normal' | 'important' | 'critical' | string
+  channelsOverride: Record<string, any>
+  template: NotificationTemplate
   }
-  totals: { // Totals across all contacts
+  totals: {
   queued: number
   sent: number
   failed: number
@@ -478,6 +491,66 @@ interface SendNotificationResponse {
 }
 ```
 
+### contact
+
+**ContactResponse** (interface)
+```typescript
+interface ContactResponse {
+  contactId: string
+  orgId: string
+  firstName: string | null
+  lastName: string | null
+  displayName: string | null
+  company: string | null
+  email: string | null
+  phone: string | null
+  emails?: string[]
+  phones?: string[]
+  customFields: ContactCustomFields
+  createdAt: string
+  updatedAt: string
+  deletedAt: string | null
+  erasedAt: string | null
+}
+```
+
+**ContactCreateRequest** (interface)
+```typescript
+interface ContactCreateRequest {
+  firstName?: string | null
+  lastName?: string | null
+  displayName?: string | null
+  company?: string | null
+  email?: string | null
+  phone?: string | null
+  customFields?: ContactCustomFields
+}
+```
+
+**ContactUpdateRequest** (interface)
+```typescript
+interface ContactUpdateRequest {
+  firstName?: string | null
+  lastName?: string | null
+  displayName?: string | null
+  company?: string | null
+  email?: string | null
+  phone?: string | null
+  customFields?: ContactCustomFields
+}
+```
+
+**ContactListResponse** (interface)
+```typescript
+interface ContactListResponse {
+  items: ContactResponse[]
+  limit: number
+  offset: number
+}
+```
+
+**ContactCustomFields** = `Record<string, any>`
+
 ### error
 
 **ErrorResponse** (interface)
@@ -552,15 +625,15 @@ interface NfcClaimTagRequest {
 **ProductResponse** (interface)
 ```typescript
 interface ProductResponse {
-  id: string // Unique identifier for the product
-  name: string // Name of the product
-  collectionId: string // Unique identifier for the product's collection
-  description: string // Detailed description of the product
-  gtin?: string // A product GTIN (Global Trade Item Number)
-  type?: string // An optional product type from the standard smartlinks types
+  id: string
+  name: string
+  collectionId: string
+  description: string
+  gtin?: string
+  type?: string
   heroImage: {
-  url: string // URL to the asset
-  thumbnails: { // Thumbnail URLs in different sizes
+  url: string
+  thumbnails: {
   x100: string
   x200: string
   x512: string
@@ -584,15 +657,15 @@ interface ProductResponse {
 **ProofResponse** (interface)
 ```typescript
 interface ProofResponse {
-  collectionId: string // Unique identifier for the collection
-  createdAt: string // Creation timestamp
-  id: string // Unique identifier for the proof
-  productId: string // Unique identifier for the product
-  tokenId: string // Unique identifier for the token
-  userId: string // Unique identifier for the user
-  claimable: boolean // Is this proof available to be claimed
-  transient: boolean // Is this proof transient
-  values: Record<string, any> // Arbitrary key-value pairs for proof values
+  collectionId: string
+  createdAt: string
+  id: string
+  productId: string
+  tokenId: string
+  userId: string
+  claimable?: boolean
+  transient?: boolean
+  values: Record<string, any>
 }
 ```
 
@@ -1082,6 +1155,31 @@ Assign a value to a serial number for a collection (admin only).
     request: SendNotificationRequest) → `Promise<SendNotificationResponse>`
 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. ```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) } ```
 
+### contact
+
+**create**(collectionId: string, data: ContactCreateRequest) → `Promise<ContactResponse>`
+
+**list**(collectionId: string,
+    params?: { limit?: number; offset?: number; includeDeleted?: boolean }) → `Promise<ContactListResponse>`
+
+**get**(collectionId: string,
+    contactId: string,
+    params?: { includeDeleted?: boolean }) → `Promise<ContactResponse>`
+
+**update**(collectionId: string,
+    contactId: string,
+    data: ContactUpdateRequest) → `Promise<ContactResponse>`
+
+**remove**(collectionId: string, contactId: string) → `Promise<void>`
+
+**lookup**(collectionId: string,
+    params: { email?: string; phone?: string }) → `Promise<ContactResponse>`
+
+**upsert**(collectionId: string,
+    data: ContactCreateRequest) → `Promise<ContactResponse>`
+
+**erase**(collectionId: string, contactId: string, body?: any) → `Promise<ContactResponse>`
+
 ### crate
 
 **get**(collectionId: string, crateId: string) → `Promise<any>`

package/dist/api/contact.d.ts

@@ -0,0 +1,20 @@
+import { ContactResponse, ContactCreateRequest, ContactUpdateRequest, ContactListResponse } from "../types/contact";
+export declare namespace contact {
+    function create(collectionId: string, data: ContactCreateRequest): Promise<ContactResponse>;
+    function list(collectionId: string, params?: {
+        limit?: number;
+        offset?: number;
+        includeDeleted?: boolean;
+    }): Promise<ContactListResponse>;
+    function get(collectionId: string, contactId: string, params?: {
+        includeDeleted?: boolean;
+    }): Promise<ContactResponse>;
+    function update(collectionId: string, contactId: string, data: ContactUpdateRequest): Promise<ContactResponse>;
+    function remove(collectionId: string, contactId: string): Promise<void>;
+    function lookup(collectionId: string, params: {
+        email?: string;
+        phone?: string;
+    }): Promise<ContactResponse>;
+    function upsert(collectionId: string, data: ContactCreateRequest): Promise<ContactResponse>;
+    function erase(collectionId: string, contactId: string, body?: any): Promise<ContactResponse>;
+}

package/dist/api/contact.js

@@ -0,0 +1,61 @@
+import { request, post, del, patch } from "../http";
+export var contact;
+(function (contact) {
+    async function create(collectionId, data) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/crm/contacts`;
+        return post(path, data);
+    }
+    contact.create = create;
+    async function list(collectionId, params) {
+        const query = new URLSearchParams();
+        if ((params === null || params === void 0 ? void 0 : params.limit) !== undefined)
+            query.set("limit", String(params.limit));
+        if ((params === null || params === void 0 ? void 0 : params.offset) !== undefined)
+            query.set("offset", String(params.offset));
+        if ((params === null || params === void 0 ? void 0 : params.includeDeleted) !== undefined)
+            query.set("includeDeleted", String(params.includeDeleted));
+        const qs = query.toString();
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/crm/contacts${qs ? `?${qs}` : ""}`;
+        return request(path);
+    }
+    contact.list = list;
+    async function get(collectionId, contactId, params) {
+        const query = new URLSearchParams();
+        if ((params === null || params === void 0 ? void 0 : params.includeDeleted) !== undefined)
+            query.set("includeDeleted", String(params.includeDeleted));
+        const qs = query.toString();
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/crm/contacts/${encodeURIComponent(contactId)}${qs ? `?${qs}` : ""}`;
+        return request(path);
+    }
+    contact.get = get;
+    async function update(collectionId, contactId, data) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/crm/contacts/${encodeURIComponent(contactId)}`;
+        return patch(path, data);
+    }
+    contact.update = update;
+    async function remove(collectionId, contactId) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/crm/contacts/${encodeURIComponent(contactId)}`;
+        return del(path);
+    }
+    contact.remove = remove;
+    async function lookup(collectionId, params) {
+        const query = new URLSearchParams();
+        if (params.email)
+            query.set("email", params.email);
+        if (params.phone)
+            query.set("phone", params.phone);
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/crm/contacts/lookup?${query.toString()}`;
+        return request(path);
+    }
+    contact.lookup = lookup;
+    async function upsert(collectionId, data) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/crm/contacts:upsert`;
+        return post(path, data);
+    }
+    contact.upsert = upsert;
+    async function erase(collectionId, contactId, body) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/crm/contacts/${encodeURIComponent(contactId)}/erase`;
+        return post(path, body || {});
+    }
+    contact.erase = erase;
+})(contact || (contact = {}));

package/dist/http.d.ts

@@ -43,6 +43,13 @@ export declare function post<T>(path: string, body: any, extraHeaders?: Record<s
  * Returns the parsed JSON as T, or throws an Error.
  */
 export declare function put<T>(path: string, body: any, extraHeaders?: Record<string, string>): Promise<T>;
+/**
+ * Internal helper that performs a PATCH request to `${baseURL}${path}`,
+ * injecting headers for apiKey or bearerToken if present.
+ * If body is FormData, Content-Type is not set.
+ * Returns the parsed JSON as T, or throws an Error.
+ */
+export declare function patch<T>(path: string, body: any, extraHeaders?: Record<string, string>): Promise<T>;
 /**
  * Internal helper that performs a request to `${baseURL}${path}` with custom options,
  * injecting headers for apiKey or bearerToken if present.

package/dist/http.js

@@ -68,7 +68,7 @@ function safeBodyPreview(body) {
  * @property {string} [options.bearerToken] - (Optional) Bearer token for AUTHORIZATION header
  * @property {boolean} [options.proxyMode] - (Optional) Tells the API that it is running in an iframe via parent proxy
  */
-import { enableAutoIframeResize, isIframe } from './iframe';
+import { iframe } from './iframe';
 export function initializeApi(options) {
     // Normalize baseURL by removing trailing slashes.
     baseURL = options.baseURL.replace(/\/+$/g, "");
@@ -83,8 +83,8 @@ export function initializeApi(options) {
         : inferredNgrok;
     extraHeadersGlobal = options.extraHeaders ? Object.assign({}, options.extraHeaders) : {};
     // Auto-enable iframe resize unless explicitly disabled
-    if (isIframe() && options.iframeAutoResize !== false) {
-        enableAutoIframeResize();
+    if (iframe.isIframe() && options.iframeAutoResize !== false) {
+        iframe.enableAutoIframeResize();
     }
     logger = options.logger;
     logDebug('[smartlinks] initializeApi', {
@@ -93,7 +93,7 @@ export function initializeApi(options) {
         inferredNgrok,
         ngrokSkipBrowserWarning,
         extraHeaders: Object.keys(extraHeadersGlobal),
-        iframeAutoResizeEnabled: isIframe() && options.iframeAutoResize !== false,
+        iframeAutoResizeEnabled: iframe.isIframe() && options.iframeAutoResize !== false,
     });
 }
 /** Enable/disable automatic "ngrok-skip-browser-warning" header. */
@@ -292,6 +292,53 @@ export async function put(path, body, extraHeaders) {
     }
     return (await response.json());
 }
+/**
+ * Internal helper that performs a PATCH request to `${baseURL}${path}`,
+ * injecting headers for apiKey or bearerToken if present.
+ * If body is FormData, Content-Type is not set.
+ * Returns the parsed JSON as T, or throws an Error.
+ */
+export async function patch(path, body, extraHeaders) {
+    if (proxyMode) {
+        logDebug('[smartlinks] PATCH via proxy', { path, body: safeBodyPreview(body) });
+        return proxyRequest("PATCH", path, body, extraHeaders);
+    }
+    if (!baseURL) {
+        throw new Error("HTTP client is not initialized. Call initializeApi(...) first.");
+    }
+    const url = `${baseURL}${path}`;
+    const headers = extraHeaders ? Object.assign({}, extraHeaders) : {};
+    if (apiKey)
+        headers["X-API-Key"] = apiKey;
+    if (bearerToken)
+        headers["AUTHORIZATION"] = `Bearer ${bearerToken}`;
+    if (ngrokSkipBrowserWarning)
+        headers["ngrok-skip-browser-warning"] = "true";
+    for (const [k, v] of Object.entries(extraHeadersGlobal))
+        if (!(k in headers))
+            headers[k] = v;
+    // Only set Content-Type for non-FormData bodies
+    if (!(body instanceof FormData)) {
+        headers["Content-Type"] = "application/json";
+    }
+    logDebug('[smartlinks] PATCH fetch', { url, headers: redactHeaders(headers), body: safeBodyPreview(body) });
+    const response = await fetch(url, {
+        method: "PATCH",
+        headers,
+        body: body instanceof FormData ? body : JSON.stringify(body),
+    });
+    logDebug('[smartlinks] PATCH response', { url, status: response.status, ok: response.ok });
+    if (!response.ok) {
+        try {
+            const errBody = (await response.json());
+            throw new Error(`Error ${errBody.code}: ${errBody.message}`);
+        }
+        catch (_a) {
+            throw new Error(`Request to ${url} failed with status ${response.status}`);
+        }
+    }
+    return (await response.json());
+}
 /**
  * Internal helper that performs a request to `${baseURL}${path}` with custom options,
  * injecting headers for apiKey or bearerToken if present.

package/dist/iframe.d.ts

@@ -1,25 +1,27 @@
-interface IframeResizeOptions {
-    /** Minimum ms between height postMessages (default 100). */
-    intervalMs?: number;
-    /** Post even if height unchanged (default false). */
-    alwaysSend?: boolean;
-    /** Additional payload properties to include with each resize message. */
-    extra?: Record<string, any>;
-    /** Custom message type name (default 'smartlinks:resize'). */
-    messageType?: string;
+export declare namespace iframe {
+    interface IframeResizeOptions {
+        /** Minimum ms between height postMessages (default 100). */
+        intervalMs?: number;
+        /** Post even if height unchanged (default false). */
+        alwaysSend?: boolean;
+        /** Additional payload properties to include with each resize message. */
+        extra?: Record<string, any>;
+        /** Custom message type name (default 'smartlinks:resize'). */
+        messageType?: string;
+    }
+    /** Redirect parent window to a URL (if in iframe). */
+    export function redirectParent(url: string): void;
+    /** Request parent to adjust iframe height to current content height. */
+    export function sendHeight(height?: number, extra?: Record<string, any>): void;
+    /** Enable automatic height reporting to parent iframe. */
+    export function enableAutoIframeResize(options?: IframeResizeOptions): void;
+    /** Disable automatic height reporting. */
+    export function disableAutoIframeResize(): void;
+    /** Send a custom message to parent (browser-only). */
+    export function sendParentCustom(type: string, payload: Record<string, any>): void;
+    /** Returns true if running inside an iframe (browser). */
+    export function isIframe(): boolean;
+    /** Returns true if ResizeObserver is supported in current environment. */
+    export function supportsResizeObserver(): boolean;
+    export {};
 }
-/** Redirect parent window to a URL (if in iframe). */
-export declare function redirectParent(url: string): void;
-/** Request parent to adjust iframe height to current content height. */
-export declare function sendHeight(height?: number, extra?: Record<string, any>): void;
-/** Enable automatic height reporting to parent iframe. */
-export declare function enableAutoIframeResize(options?: IframeResizeOptions): void;
-/** Disable automatic height reporting. */
-export declare function disableAutoIframeResize(): void;
-/** Send a custom message to parent (browser-only). */
-export declare function sendParentCustom(type: string, payload: Record<string, any>): void;
-/** Returns true if running inside an iframe (browser). */
-export declare function isIframe(): boolean;
-/** Returns true if ResizeObserver is supported in current environment. */
-export declare function supportsResizeObserver(): boolean;
-export {};

package/dist/iframe.js

@@ -2,122 +2,132 @@
 // Utilities to communicate with parent window when running inside an iframe.
 // These helpers are optional and safe in non-browser / Node environments.
 // They build on the existing proxyMode infrastructure but can also be used standalone.
-let autoResizeTimer;
-let lastHeight = 0;
-let resizeOptions;
-let resizeObserver;
-let mutationObserver;
-function isBrowser() {
-    return typeof window !== 'undefined' && typeof document !== 'undefined';
-}
-function inIframe() {
-    return isBrowser() && window.parent && window.parent !== window;
-}
-function postParentMessage(type, payload) {
-    if (!inIframe())
-        return;
-    try {
-        window.parent.postMessage({ _smartlinksIframeMessage: true, type, payload }, '*');
+export var iframe;
+(function (iframe) {
+    let autoResizeTimer;
+    let lastHeight = 0;
+    let resizeOptions;
+    let resizeObserver;
+    let mutationObserver;
+    function isBrowser() {
+        return typeof window !== 'undefined' && typeof document !== 'undefined';
     }
-    catch (_a) {
-        // swallow errors silently
+    function inIframe() {
+        return isBrowser() && window.parent && window.parent !== window;
     }
-}
-/** Redirect parent window to a URL (if in iframe). */
-export function redirectParent(url) {
-    postParentMessage('smartlinks:redirect', { url });
-}
-/** Request parent to adjust iframe height to current content height. */
-export function sendHeight(height, extra) {
-    if (!inIframe())
-        return;
-    const h = height !== null && height !== void 0 ? height : document.documentElement.scrollHeight;
-    postParentMessage((resizeOptions === null || resizeOptions === void 0 ? void 0 : resizeOptions.messageType) || 'smartlinks:resize', Object.assign(Object.assign({ height: h }, resizeOptions === null || resizeOptions === void 0 ? void 0 : resizeOptions.extra), extra));
-}
-function measureHeight() {
-    if (!isBrowser())
-        return 0;
-    const doc = document.documentElement;
-    // Use max of several properties for robustness
-    return Math.max(doc.scrollHeight, doc.offsetHeight, doc.clientHeight, document.body ? document.body.scrollHeight : 0, document.body ? document.body.offsetHeight : 0);
-}
-function scheduleManualPolling() {
-    var _a;
-    if (!isBrowser())
-        return;
-    clearInterval(autoResizeTimer);
-    const interval = (_a = resizeOptions === null || resizeOptions === void 0 ? void 0 : resizeOptions.intervalMs) !== null && _a !== void 0 ? _a : 100;
-    autoResizeTimer = window.setInterval(() => {
-        const h = measureHeight();
-        if ((resizeOptions === null || resizeOptions === void 0 ? void 0 : resizeOptions.alwaysSend) || h !== lastHeight) {
-            lastHeight = h;
-            sendHeight(h);
+    function postParentMessage(type, payload) {
+        if (!inIframe())
+            return;
+        try {
+            window.parent.postMessage({ _smartlinksIframeMessage: true, type, payload }, '*');
         }
-    }, interval);
-}
-function setupObservers() {
-    if (!isBrowser())
-        return;
-    // Prefer ResizeObserver for layout changes
-    if (typeof ResizeObserver !== 'undefined') {
-        resizeObserver = new ResizeObserver(() => {
-            const h = measureHeight();
-            if ((resizeOptions === null || resizeOptions === void 0 ? void 0 : resizeOptions.alwaysSend) || h !== lastHeight) {
-                lastHeight = h;
-                sendHeight(h);
-            }
-        });
-        resizeObserver.observe(document.body);
+        catch (_a) {
+            // swallow errors silently
+        }
+    }
+    /** Redirect parent window to a URL (if in iframe). */
+    function redirectParent(url) {
+        postParentMessage('smartlinks:redirect', { url });
+    }
+    iframe.redirectParent = redirectParent;
+    /** Request parent to adjust iframe height to current content height. */
+    function sendHeight(height, extra) {
+        if (!inIframe())
+            return;
+        const h = height !== null && height !== void 0 ? height : document.documentElement.scrollHeight;
+        postParentMessage((resizeOptions === null || resizeOptions === void 0 ? void 0 : resizeOptions.messageType) || 'smartlinks:resize', Object.assign(Object.assign({ height: h }, resizeOptions === null || resizeOptions === void 0 ? void 0 : resizeOptions.extra), extra));
     }
-    else {
-        // Fallback: MutationObserver for DOM changes
-        mutationObserver = new MutationObserver(() => {
+    iframe.sendHeight = sendHeight;
+    function measureHeight() {
+        if (!isBrowser())
+            return 0;
+        const doc = document.documentElement;
+        // Use max of several properties for robustness
+        return Math.max(doc.scrollHeight, doc.offsetHeight, doc.clientHeight, document.body ? document.body.scrollHeight : 0, document.body ? document.body.offsetHeight : 0);
+    }
+    function scheduleManualPolling() {
+        var _a;
+        if (!isBrowser())
+            return;
+        clearInterval(autoResizeTimer);
+        const interval = (_a = resizeOptions === null || resizeOptions === void 0 ? void 0 : resizeOptions.intervalMs) !== null && _a !== void 0 ? _a : 100;
+        autoResizeTimer = window.setInterval(() => {
             const h = measureHeight();
             if ((resizeOptions === null || resizeOptions === void 0 ? void 0 : resizeOptions.alwaysSend) || h !== lastHeight) {
                 lastHeight = h;
                 sendHeight(h);
             }
-        });
-        mutationObserver.observe(document.body, { childList: true, subtree: true, attributes: true });
-        // Manual polling as additional safeguard
-        scheduleManualPolling();
+        }, interval);
     }
-}
-/** Enable automatic height reporting to parent iframe. */
-export function enableAutoIframeResize(options) {
-    if (!inIframe())
-        return;
-    resizeOptions = options || {};
-    lastHeight = measureHeight();
-    sendHeight(lastHeight);
-    setupObservers();
-    if (!resizeObserver) {
-        // If no ResizeObserver, MutationObserver is active and we also poll
-        scheduleManualPolling();
+    function setupObservers() {
+        if (!isBrowser())
+            return;
+        // Prefer ResizeObserver for layout changes
+        if (typeof ResizeObserver !== 'undefined') {
+            resizeObserver = new ResizeObserver(() => {
+                const h = measureHeight();
+                if ((resizeOptions === null || resizeOptions === void 0 ? void 0 : resizeOptions.alwaysSend) || h !== lastHeight) {
+                    lastHeight = h;
+                    sendHeight(h);
+                }
+            });
+            resizeObserver.observe(document.body);
+        }
+        else {
+            // Fallback: MutationObserver for DOM changes
+            mutationObserver = new MutationObserver(() => {
+                const h = measureHeight();
+                if ((resizeOptions === null || resizeOptions === void 0 ? void 0 : resizeOptions.alwaysSend) || h !== lastHeight) {
+                    lastHeight = h;
+                    sendHeight(h);
+                }
+            });
+            mutationObserver.observe(document.body, { childList: true, subtree: true, attributes: true });
+            // Manual polling as additional safeguard
+            scheduleManualPolling();
+        }
     }
-}
-/** Disable automatic height reporting. */
-export function disableAutoIframeResize() {
-    if (resizeObserver)
-        resizeObserver.disconnect();
-    if (mutationObserver)
-        mutationObserver.disconnect();
-    if (isBrowser())
-        clearInterval(autoResizeTimer);
-    resizeObserver = undefined;
-    mutationObserver = undefined;
-    autoResizeTimer = undefined;
-    resizeOptions = undefined;
-}
-/** Send a custom message to parent (browser-only). */
-export function sendParentCustom(type, payload) {
-    postParentMessage(type, payload);
-}
-/** Returns true if running inside an iframe (browser). */
-export function isIframe() {
-    return inIframe();
-}
-/** Returns true if ResizeObserver is supported in current environment. */
-export function supportsResizeObserver() {
-    return typeof ResizeObserver !== 'undefined';
-}
+    /** Enable automatic height reporting to parent iframe. */
+    function enableAutoIframeResize(options) {
+        if (!inIframe())
+            return;
+        resizeOptions = options || {};
+        lastHeight = measureHeight();
+        sendHeight(lastHeight);
+        setupObservers();
+        if (!resizeObserver) {
+            // If no ResizeObserver, MutationObserver is active and we also poll
+            scheduleManualPolling();
+        }
+    }
+    iframe.enableAutoIframeResize = enableAutoIframeResize;
+    /** Disable automatic height reporting. */
+    function disableAutoIframeResize() {
+        if (resizeObserver)
+            resizeObserver.disconnect();
+        if (mutationObserver)
+            mutationObserver.disconnect();
+        if (isBrowser())
+            clearInterval(autoResizeTimer);
+        resizeObserver = undefined;
+        mutationObserver = undefined;
+        autoResizeTimer = undefined;
+        resizeOptions = undefined;
+    }
+    iframe.disableAutoIframeResize = disableAutoIframeResize;
+    /** Send a custom message to parent (browser-only). */
+    function sendParentCustom(type, payload) {
+        postParentMessage(type, payload);
+    }
+    iframe.sendParentCustom = sendParentCustom;
+    /** Returns true if running inside an iframe (browser). */
+    function isIframe() {
+        return inIframe();
+    }
+    iframe.isIframe = isIframe;
+    /** Returns true if ResizeObserver is supported in current environment. */
+    function supportsResizeObserver() {
+        return typeof ResizeObserver !== 'undefined';
+    }
+    iframe.supportsResizeObserver = supportsResizeObserver;
+})(iframe || (iframe = {}));

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 export { initializeApi, request, sendCustomProxyMessage } from "./http";
 export * from "./api";
 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, } from "./types/comms";

package/dist/index.js

@@ -3,3 +3,5 @@
 export { initializeApi, request, sendCustomProxyMessage } from "./http";
 export * from "./api";
 export * from "./types";
+// Iframe namespace
+export { iframe } from "./iframe";

package/dist/types/attestation.d.ts

@@ -1,17 +1,28 @@
 export interface AttestationResponse {
+    /** Attestation id */
     id: string;
+    /** Creation timestamp */
     createdAt: string;
+    /** Last updated timestamp */
     updatedAt: string;
+    /** Public attestation data */
     public: Record<string, any>;
+    /** Private attestation data */
     private: Record<string, any>;
+    /** Associated proof reference/data */
     proof: Record<string, any>;
 }
 export interface AttestationCreateRequest {
+    /** Public attestation payload */
     public: Record<string, any>;
+    /** Private attestation payload */
     private: Record<string, any>;
+    /** Proof linkage or payload */
     proof: Record<string, any>;
 }
 export interface AttestationUpdateRequest {
+    /** Update operation/type */
     type?: string;
+    /** Partial attestation data */
     data?: Record<string, any>;
 }

package/dist/types/auth.d.ts

@@ -1,9 +1,16 @@
 export type UserAccountRegistrationRequest = {
+    /** User's display name */
     name: string;
+    /** Optional user email */
     email?: string;
+    /** Optional user phone number */
     phone?: string;
+    /** Optional password for email login */
     password?: string;
+    /** Send confirmation email after registration */
     sendAccountConfirmation?: boolean;
+    /** Optional collection context for registration */
     collectionId?: string;
+    /** Desired token type returned */
     tokenType?: 'bearer' | 'firebase';
 };

package/dist/types/claimSet.d.ts

@@ -1,18 +1,40 @@
+/**
+ * Reference to a specific claim attached to a code/tag.
+ */
 export interface ClaimCodeRef {
+    /** Identifier of the code (e.g., tag or QR code) */
     codeId: string;
+    /** Identifier of the claim within the claim set */
     claimId: string;
 }
+/**
+ * Request body for updating claim data on a claim set.
+ * Contains arbitrary key/value pairs and a list of code+claim references to update.
+ */
 export interface UpdateClaimDataRequest {
+    /** Arbitrary key/value pairs for the claim data update */
     data: Record<string, any>;
+    /** Array of code+claim references affected by this update */
     codes: ClaimCodeRef[];
 }
+/**
+ * Request body for assigning claims to codes or ranges within a collection.
+ */
 export interface AssignClaimsRequest {
+    /** The claim set ID (required) */
     id: string;
+    /** The collection ID (required) */
     collectionId: string;
+    /** The product ID (required) */
     productId: string;
+    /** Optional batch identifier */
     batchId?: string;
+    /** Optional start index for bulk assignment */
     start?: number;
+    /** Optional end index for bulk assignment */
     end?: number;
+    /** Optional single code identifier for single assignment */
     codeId?: string;
+    /** Optional key/value pairs to set on the claim */
     data?: Record<string, any>;
 }

package/dist/types/collection.d.ts

@@ -2,12 +2,17 @@
  * Represents a Collection object.
  */
 export interface CollectionResponse {
+    /** Unique identifier for the collection */
     id: string;
+    /** Human-readable title of the collection */
     title: string;
+    /** Description of collection */
     description: string;
     /** URL to the collection's larger header/hero image */
     headerImage?: {
+        /** URL to the asset */
         url: string;
+        /** Thumbnail URLs in different sizes */
         thumbnails: {
             x100: string;
             x200: string;
@@ -16,7 +21,9 @@ export interface CollectionResponse {
     };
     /** URL to the collection's logo image */
     logoImage?: {
+        /** URL to the asset */
         url: string;
+        /** Thumbnail URLs in different sizes */
         thumbnails: {
             x100: string;
             x200: string;
@@ -25,15 +32,22 @@ export interface CollectionResponse {
     };
     /** Collection's loader image */
     loaderImage?: {
+        /** Override name for the file */
         overwriteName: string;
+        /** Name of the asset */
         name: string;
+        /** File type/extension */
         type: string;
+        /** URL to the asset */
         url: string;
     };
     /** Array of supported languages */
     languages?: {
+        /** Language code (e.g., "fr", "it", "es") */
         code: string;
+        /** Human-readable language name (e.g., "French", "Italian") */
         lang: string;
+        /** Whether this language is supported */
         supported: boolean;
     }[];
     /** User roles mapping with user IDs as keys and role names as values */

package/dist/types/comms.d.ts

@@ -2,22 +2,29 @@
  * Target subject for notifications (product, collection, etc.)
  */
 export interface NotificationSubjectTarget {
+    /** Type of target entity */
     type: 'product' | 'collection' | 'user' | 'batch' | 'proof';
+    /** ID of the target entity */
     id: string;
 }
 /**
  * Push notification template content
  */
 export interface PushNotificationTemplate {
+    /** Notification title */
     title: string;
+    /** Notification body text */
     body: string;
+    /** Optional icon URL for the notification */
     icon?: string;
 }
 /**
  * Email notification template content
  */
 export interface EmailNotificationTemplate {
+    /** Email subject line */
     subject: string;
+    /** Email body content (plain text or HTML) */
     body: string;
 }
 /**
@@ -25,8 +32,11 @@ export interface EmailNotificationTemplate {
  */
 export interface WalletUpdateTemplate {
     textModulesData?: Array<{
+        /** Module ID */
         id: string;
+        /** Module header text */
         header: string;
+        /** Module body text */
         body: string;
     }>;
 }
@@ -34,39 +44,58 @@ export interface WalletUpdateTemplate {
  * Notification template containing different delivery methods
  */
 export interface NotificationTemplate {
+    /** Push notification content */
     push?: PushNotificationTemplate;
+    /** Email notification content */
     email?: EmailNotificationTemplate;
+    /** Wallet pass update content */
     walletUpdate?: WalletUpdateTemplate;
 }
 /**
  * Request payload for sending notifications
  */
 export interface SendNotificationRequest {
+    /** Target subjects that should receive the notification */
     subjectTargets: NotificationSubjectTarget[];
+    /** Severity level of the notification */
     severity: 'low' | 'normal' | 'important' | 'critical';
+    /** Delivery channel mode preference */
     mode: 'preferred' | 'all';
+    /** Specific channels to use for delivery */
     channels: ("push" | "email" | "wallet")[];
+    /** Notification content templates for different delivery methods */
     template: NotificationTemplate;
 }
 /**
  * Response from sending notifications
  */
 export interface SendNotificationResponse {
+    /** Whether the request was accepted */
     ok: boolean;
+    /** Unique ID for this notification */
     notificationId: string;
+    /** Basic counts for contacts and attempts */
     counts: {
         contacts: number;
         attempts: number;
     };
+    /** Detailed status for the notification */
     status: {
         notification: {
+            /** The notification ID (repeated for convenience) */
             notificationId: string;
+            /** Current processing state */
             state: 'queued' | 'sent' | 'failed' | 'confirmed' | string;
+            /** Targets this notification refers to */
             subjectTargets: NotificationSubjectTarget[];
+            /** Severity of this notification */
             severity: 'low' | 'normal' | 'important' | 'critical' | string;
+            /** Optional channel overrides used when sending */
             channelsOverride: Record<string, any>;
+            /** The effective template used */
             template: NotificationTemplate;
         };
+        /** Totals across all contacts */
         totals: {
             queued: number;
             sent: number;

package/dist/types/contact.d.ts

@@ -0,0 +1,41 @@
+export type ContactCustomFields = Record<string, any>;
+export interface ContactResponse {
+    contactId: string;
+    orgId: string;
+    firstName: string | null;
+    lastName: string | null;
+    displayName: string | null;
+    company: string | null;
+    email: string | null;
+    phone: string | null;
+    emails?: string[];
+    phones?: string[];
+    customFields: ContactCustomFields;
+    createdAt: string;
+    updatedAt: string;
+    deletedAt: string | null;
+    erasedAt: string | null;
+}
+export interface ContactCreateRequest {
+    firstName?: string | null;
+    lastName?: string | null;
+    displayName?: string | null;
+    company?: string | null;
+    email?: string | null;
+    phone?: string | null;
+    customFields?: ContactCustomFields;
+}
+export interface ContactUpdateRequest {
+    firstName?: string | null;
+    lastName?: string | null;
+    displayName?: string | null;
+    company?: string | null;
+    email?: string | null;
+    phone?: string | null;
+    customFields?: ContactCustomFields;
+}
+export interface ContactListResponse {
+    items: ContactResponse[];
+    limit: number;
+    offset: number;
+}

package/dist/types/contact.js

@@ -0,0 +1 @@
+export {};

package/dist/types/index.d.ts

@@ -10,3 +10,4 @@ export * from "./claimSet";
 export * from "./auth";
 export * from "./comms";
 export * from "./nfc";
+export * from "./contact";

package/dist/types/index.js

@@ -12,3 +12,4 @@ export * from "./claimSet";
 export * from "./auth";
 export * from "./comms";
 export * from "./nfc";
+export * from "./contact";

package/dist/types/product.d.ts

@@ -2,15 +2,23 @@
  * Represents a Product Item object.
  */
 export interface ProductResponse {
+    /** Unique identifier for the product */
     id: string;
+    /** Name of the product */
     name: string;
+    /** Unique identifier for the product's collection */
     collectionId: string;
+    /** Detailed description of the product */
     description: string;
+    /** A product GTIN (Global Trade Item Number) */
     gtin?: string;
+    /** An optional product type from the standard smartlinks types */
     type?: string;
     /** Hero image asset object */
     heroImage: {
+        /** URL to the asset */
         url: string;
+        /** Thumbnail URLs in different sizes */
         thumbnails: {
             x100: string;
             x200: string;

package/dist/types/proof.d.ts

@@ -2,13 +2,22 @@
  * Represents a Proof object.
  */
 export interface ProofResponse {
+    /** Unique identifier for the collection */
     collectionId: string;
+    /** Creation timestamp */
     createdAt: string;
+    /** Unique identifier for the proof */
     id: string;
+    /** Unique identifier for the product */
     productId: string;
+    /** Unique identifier for the token */
     tokenId: string;
+    /** Unique identifier for the user */
     userId: string;
-    claimable: boolean;
-    transient: boolean;
+    /** Is this proof available to be claimed */
+    claimable?: boolean;
+    /** Is this proof transient */
+    transient?: boolean;
+    /** Arbitrary key-value pairs for proof values */
     values: Record<string, any>;
 }

package/package.json

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