@proveanything/smartlinks 1.0.56 → 1.0.58

package/API_SUMMARY.md

@@ -1,6 +1,6 @@
 # Smartlinks API Summary
 
-Version: 1.0.56  |  Generated: 2025-12-10T12:13:56.087Z
+Version: 1.0.58  |  Generated: 2025-12-10T12:43:07.554Z
 
 This is a concise summary of all available API functions and types.
 
@@ -108,29 +108,29 @@ interface AssetResponse {
 **AttestationResponse** (interface)
 ```typescript
 interface AttestationResponse {
-  id: string
-  createdAt: string
-  updatedAt: string
-  public: Record<string, any>
-  private: Record<string, any>
-  proof: Record<string, any>
+  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
 }
 ```
 
 **AttestationCreateRequest** (interface)
 ```typescript
 interface AttestationCreateRequest {
-  public: Record<string, any>
-  private: Record<string, any>
-  proof: Record<string, any>
+  public: Record<string, any> // Public attestation payload
+  private: Record<string, any> // Private attestation payload
+  proof: Record<string, any> // Proof linkage or payload
 }
 ```
 
 **AttestationUpdateRequest** (interface)
 ```typescript
 interface AttestationUpdateRequest {
-  type?: string
-  data?: Record<string, any>
+  type?: string // Update operation/type
+  data?: Record<string, any> // Partial attestation data
 }
 ```
 
@@ -139,13 +139,13 @@ interface AttestationUpdateRequest {
 **UserAccountRegistrationRequest** (type)
 ```typescript
 type UserAccountRegistrationRequest = {
-  name: string
-  email?: string
-  phone?: string
-  password?: string
-  sendAccountConfirmation?: boolean
-  collectionId?: string,
-  tokenType?: 'bearer' | 'firebase'
+  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
 }
 ```
 
@@ -352,43 +352,43 @@ interface AssignClaimsRequest {
 **CollectionResponse** (interface)
 ```typescript
 interface CollectionResponse {
-  id: string
-  title: string
-  description: string
+  id: string // Unique identifier for the collection
+  title: string // Human-readable title of the collection
+  description: string // Description of collection
   headerImage?: {
-  url: string
-  thumbnails: {
+  url: string // URL to the asset
+  thumbnails: { // Thumbnail URLs in different sizes
   x100: string
   x200: string
   x512: string
   }
   }
   logoImage?: {
-  url: string
-  thumbnails: {
+  url: string // URL to the asset
+  thumbnails: { // Thumbnail URLs in different sizes
   x100: string
   x200: string
   x512: string
   }
   }
   loaderImage?: {
-  overwriteName: string
-  name: string
-  type: string
-  url: string
+  overwriteName: string // Override name for the file
+  name: string // Name of the asset
+  type: string // File type/extension
+  url: string // URL to the asset
   }
   languages?: {
-  code: string
-  lang: string
-  supported: boolean
+  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
   }[],
   roles: {
   [userId: string]: string
-  }
-  groupTags?: string[]
-  redirectUrl?: string
-  shortId: string,
-  dark?: boolean
+  } // User roles mapping with user IDs as keys and role names as values
+  groupTags?: string[] // Array of group tag names
+  redirectUrl?: string // Whether the collection has a custom domain
+  shortId: string, // The shortId of this collection
+  dark?: boolean // if dark mode is enabled for this collection
 }
 ```
 
@@ -397,25 +397,25 @@ interface CollectionResponse {
 **NotificationSubjectTarget** (interface)
 ```typescript
 interface NotificationSubjectTarget {
-  type: 'product' | 'collection' | 'user' | 'batch' | 'proof'
-  id: string
+  type: 'product' | 'collection' | 'user' | 'batch' | 'proof' // Type of target entity
+  id: string // ID of the target entity
 }
 ```
 
 **PushNotificationTemplate** (interface)
 ```typescript
 interface PushNotificationTemplate {
-  title: string
-  body: string
-  icon?: string
+  title: string // Notification title
+  body: string // Notification body text
+  icon?: string // Optional icon URL for the notification
 }
 ```
 
 **EmailNotificationTemplate** (interface)
 ```typescript
 interface EmailNotificationTemplate {
-  subject: string
-  body: string
+  subject: string // Email subject line
+  body: string // Email body content (plain text or HTML)
 }
 ```
 
@@ -423,9 +423,9 @@ interface EmailNotificationTemplate {
 ```typescript
 interface WalletUpdateTemplate {
   textModulesData?: Array<{
-  id: string
-  header: string
-  body: string
+  id: string // Module ID
+  header: string // Module header text
+  body: string // Module body text
   }>
 }
 ```
@@ -433,42 +433,42 @@ interface WalletUpdateTemplate {
 **NotificationTemplate** (interface)
 ```typescript
 interface NotificationTemplate {
-  push?: PushNotificationTemplate
-  email?: EmailNotificationTemplate
-  walletUpdate?: WalletUpdateTemplate
+  push?: PushNotificationTemplate // Push notification content
+  email?: EmailNotificationTemplate // Email notification content
+  walletUpdate?: WalletUpdateTemplate // Wallet pass update content
 }
 ```
 
 **SendNotificationRequest** (interface)
 ```typescript
 interface SendNotificationRequest {
-  subjectTargets: NotificationSubjectTarget[]
-  severity: 'low' | 'normal' | 'important' | 'critical'
-  mode: 'preferred' | 'all'
-  channels : ("push" | "email" | "wallet")[]
-  template: NotificationTemplate
+  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
 }
 ```
 
 **SendNotificationResponse** (interface)
 ```typescript
 interface SendNotificationResponse {
-  ok: boolean
-  notificationId: string
-  counts: {
+  ok: boolean // Whether the request was accepted
+  notificationId: string // Unique ID for this notification
+  counts: { // Basic counts for contacts and attempts
   contacts: number
   attempts: number
   }
-  status: {
+  status: { // Detailed status for the notification
   notification: {
-  notificationId: string
-  state: 'queued' | 'sent' | 'failed' | 'confirmed' | string
-  subjectTargets: NotificationSubjectTarget[]
-  severity: 'low' | 'normal' | 'important' | 'critical' | string
-  channelsOverride: Record<string, any>
-  template: NotificationTemplate
+  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
   }
-  totals: {
+  totals: { // Totals across all contacts
   queued: number
   sent: number
   failed: number
@@ -552,15 +552,15 @@ interface NfcClaimTagRequest {
 **ProductResponse** (interface)
 ```typescript
 interface ProductResponse {
-  id: string
-  name: string
-  collectionId: string
-  description: string
-  gtin?: string
-  type?: string
+  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
   heroImage: {
-  url: string
-  thumbnails: {
+  url: string // URL to the asset
+  thumbnails: { // Thumbnail URLs in different sizes
   x100: string
   x200: string
   x512: string
@@ -568,10 +568,10 @@ interface ProductResponse {
   }
   tags: {
   [tagName: string]: boolean
-  }
+  } // Flexible map of tags with true/false values
   data: {
   [key: string]: any
-  }
+  } // Flexible key/value data map
 }
 ```
 
@@ -584,15 +584,15 @@ interface ProductResponse {
 **ProofResponse** (interface)
 ```typescript
 interface ProofResponse {
-  collectionId: string
-  createdAt: string
-  id: string
-  productId: string
-  tokenId: string
-  userId: string
-  claimable: boolean
-  transient: boolean
-  values: Record<string, any>
+  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
 }
 ```
 

package/dist/types/claimSet.d.ts

@@ -1,21 +1,11 @@
-/**
- * Reference to a specific claim attached to a code/tag.
- */
 export interface ClaimCodeRef {
     codeId: string;
     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 {
     data: Record<string, any>;
     codes: ClaimCodeRef[];
 }
-/**
- * Request body for assigning claims to codes or ranges within a collection.
- */
 export interface AssignClaimsRequest {
     id: string;
     collectionId: string;

package/dist/types/collection.d.ts

@@ -2,17 +2,12 @@
  * 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;
@@ -21,9 +16,7 @@ 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;
@@ -32,22 +25,15 @@ 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,42 +2,31 @@
  * 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;
 }
 /**
  * Wallet pass update template content
  */
 export interface WalletUpdateTemplate {
-    /** Text modules to update in the wallet pass */
     textModulesData?: Array<{
-        /** Module ID */
         id: string;
-        /** Module header text */
         header: string;
-        /** Module body text */
         body: string;
     }>;
 }
@@ -45,58 +34,39 @@ 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 chanell 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/product.d.ts

@@ -2,23 +2,15 @@
  * 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,22 +2,13 @@
  * 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;
-    /** 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.56",
+  "version": "1.0.58",
   "description": "Official JavaScript/TypeScript SDK for the Smartlinks API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",