@proveanything/smartlinks 1.1.2 → 1.1.4

package/API_SUMMARY.md

@@ -1,6 +1,6 @@
 # Smartlinks API Summary
 
-Version: 1.1.2  |  Generated: 2025-12-18T22:42:25.982Z
+Version: 1.1.4  |  Generated: 2025-12-21T18:19:46.355Z
 
 This is a concise summary of all available API functions and types.
 
@@ -39,6 +39,7 @@ The Smartlinks SDK is organized into the following namespaces:
 - **nfc** - Claim and validate NFC tags; perform tag lookups.
 - **proof** - Create, update, claim, and list product proofs (digital certificates).
 - **claimSet** - Manage claim sets and tag assignments; queries, reports, and updates.
+- **qr** - Lookup short codes to resolve collection/product/proof context.
 
 — AI & Utilities —
 - **ai** - Generate content and images, search photos, chat, upload files, and cache.
@@ -344,22 +345,15 @@ interface AttestationUpdateRequest {
 
 ### auth
 
-**UserAccountRegistrationRequest** (type)
+**UserAccountRegistrationRequest** (interface)
 ```typescript
-type UserAccountRegistrationRequest = {
-  /** User's display name */
+interface UserAccountRegistrationRequest {
   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'
 }
 ```
@@ -609,9 +603,9 @@ interface AssignClaimsRequest {
 
 ### collection
 
-**CollectionResponse** (interface)
+**Collection** (interface)
 ```typescript
-interface CollectionResponse {
+interface Collection {
   id: string
   title: string
   description: string
@@ -652,6 +646,12 @@ interface CollectionResponse {
 }
 ```
 
+**CollectionResponse** = `Collection`
+
+**CollectionCreateRequest** = `Omit<Collection, 'id' | 'shortId'>`
+
+**CollectionUpdateRequest** = `Partial<Omit<Collection, 'id' | 'shortId'>>`
+
 ### common
 
 **IdField** = `'userId' | 'contactId'`
@@ -1063,9 +1063,9 @@ interface NfcClaimTagRequest {
 
 ### product
 
-**ProductResponse** (interface)
+**Product** (interface)
 ```typescript
-interface ProductResponse {
+interface Product {
   id: string
   name: string
   collectionId: string
@@ -1089,15 +1089,17 @@ interface ProductResponse {
 }
 ```
 
-**ProductCreateRequest** = `Omit<ProductResponse, 'id' | 'collectionId'>`
+**ProductResponse** = `Product`
+
+**ProductCreateRequest** = `Omit<Product, 'id' | 'collectionId'>`
 
-**ProductUpdateRequest** = `Partial<Omit<ProductResponse, 'id' | 'collectionId'>>`
+**ProductUpdateRequest** = `Partial<Omit<Product, 'id' | 'collectionId'>>`
 
 ### proof
 
-**ProofResponse** (interface)
+**Proof** (interface)
 ```typescript
-interface ProofResponse {
+interface Proof {
   collectionId: string
   createdAt: string
   id: string
@@ -1110,6 +1112,33 @@ interface ProofResponse {
 }
 ```
 
+**ProofCreateRequest** (interface)
+```typescript
+interface ProofCreateRequest {
+  values: Record<string, any>
+  claimable?: boolean
+  transient?: boolean
+}
+```
+
+**ProofResponse** = `Proof`
+
+**ProofUpdateRequest** = `Partial<ProofCreateRequest>`
+
+**ProofClaimRequest** = `Record<string, any>`
+
+### qr
+
+**QrShortCodeLookupResponse** (interface)
+```typescript
+interface QrShortCodeLookupResponse {
+  collectionId?: string
+  productId?: string
+  proofId?: string
+  code: string
+}
+```
+
 ### segments
 
 **SegmentRecord** (interface)
@@ -1699,10 +1728,10 @@ Retrieve a specific settings group for a collection (public endpoint).
 **updateSettings**(collectionId: string, settingGroup: string, settings: any) → `Promise<any>`
 Update a specific settings group for a collection (admin endpoint).
 
-**create**(data: any) → `Promise<CollectionResponse>`
+**create**(data: CollectionCreateRequest) → `Promise<CollectionResponse>`
 Create a new collection (admin only).
 
-**update**(collectionId: string, data: any) → `Promise<CollectionResponse>`
+**update**(collectionId: string, data: CollectionUpdateRequest) → `Promise<CollectionResponse>`
 Update a collection (admin only).
 
 **remove**(collectionId: string) → `Promise<void>`
@@ -1890,19 +1919,19 @@ List all Proofs for a Collection.
 
 **create**(collectionId: string,
     productId: string,
-    values: any) → `Promise<ProofResponse>`
+    values: ProofCreateRequest) → `Promise<ProofResponse>`
 Create a proof for a product (admin only). POST /admin/collection/:collectionId/product/:productId/proof
 
 **update**(collectionId: string,
     productId: string,
     proofId: string,
-    values: any) → `Promise<ProofResponse>`
+    values: ProofUpdateRequest) → `Promise<ProofResponse>`
 Update a proof for a product (admin only). PUT /admin/collection/:collectionId/product/:productId/proof/:proofId
 
 **claim**(collectionId: string,
     productId: string,
     proofId: string,
-    values: any) → `Promise<ProofResponse>`
+    values: ProofClaimRequest) → `Promise<ProofResponse>`
 Claim a proof for a product. PUT /public/collection/:collectionId/product/:productId/proof/:proofId
 
 **remove**(collectionId: string,
@@ -1928,6 +1957,11 @@ Find proofs for a product (admin only). POST /admin/collection/:collectionId/pro
     batchId: string) → `Promise<ProofResponse[]>`
 Get proofs for a batch (admin only). GET /admin/collection/:collectionId/product/:productId/batch/:batchId/proof
 
+### qr
+
+**lookupShortCode**(shortId: string, code: string) → `Promise<QrShortCodeLookupResponse>`
+Resolve a short code to related resource identifiers. GET /public/lookupShortCode/:shortId/:code
+
 ### segments
 
 **create**(collectionId: string,

package/dist/api/collection.d.ts

@@ -1,4 +1,4 @@
-import { CollectionResponse } from "../types/collection";
+import { CollectionResponse, CollectionCreateRequest, CollectionUpdateRequest } from "../types/collection";
 export declare namespace collection {
     /**
      * Retrieves a single Collection by its ID.
@@ -42,7 +42,7 @@ export declare namespace collection {
      * @returns Promise resolving to a CollectionResponse object
      * @throws ErrorResponse if the request fails
      */
-    function create(data: any): Promise<CollectionResponse>;
+    function create(data: CollectionCreateRequest): Promise<CollectionResponse>;
     /**
      * Update a collection (admin only).
      * @param collectionId – Identifier of the collection
@@ -50,7 +50,7 @@ export declare namespace collection {
      * @returns Promise resolving to a CollectionResponse object
      * @throws ErrorResponse if the request fails
      */
-    function update(collectionId: string, data: any): Promise<CollectionResponse>;
+    function update(collectionId: string, data: CollectionUpdateRequest): Promise<CollectionResponse>;
     /**
      * Delete a collection (admin only).
      * @param collectionId – Identifier of the collection

package/dist/api/index.d.ts

@@ -20,4 +20,5 @@ export { actions } from "./actions";
 export { broadcasts } from "./broadcasts";
 export { segments } from "./segments";
 export { journeys } from "./journeys";
+export { qr } from "./qr";
 export type { AIGenerateContentRequest, AIGenerateImageRequest, AISearchPhotosRequest, AISearchPhotosPhoto } from "./ai";

package/dist/api/index.js

@@ -22,3 +22,4 @@ export { actions } from "./actions";
 export { broadcasts } from "./broadcasts";
 export { segments } from "./segments";
 export { journeys } from "./journeys";
+export { qr } from "./qr";

package/dist/api/proof.d.ts

@@ -1,4 +1,4 @@
-import { ProofResponse } from "../types/proof";
+import { ProofResponse, ProofCreateRequest, ProofUpdateRequest, ProofClaimRequest } from "../types/proof";
 export declare namespace proof {
     /**
      * Retrieves a single Proof by Collection ID, Product ID, and Proof ID.
@@ -13,17 +13,17 @@ export declare namespace proof {
      * Create a proof for a product (admin only).
      * POST /admin/collection/:collectionId/product/:productId/proof
      */
-    function create(collectionId: string, productId: string, values: any): Promise<ProofResponse>;
+    function create(collectionId: string, productId: string, values: ProofCreateRequest): Promise<ProofResponse>;
     /**
      * Update a proof for a product (admin only).
      * PUT /admin/collection/:collectionId/product/:productId/proof/:proofId
      */
-    function update(collectionId: string, productId: string, proofId: string, values: any): Promise<ProofResponse>;
+    function update(collectionId: string, productId: string, proofId: string, values: ProofUpdateRequest): Promise<ProofResponse>;
     /**
      * Claim a proof for a product.
      * PUT /public/collection/:collectionId/product/:productId/proof/:proofId
      */
-    function claim(collectionId: string, productId: string, proofId: string, values: any): Promise<ProofResponse>;
+    function claim(collectionId: string, productId: string, proofId: string, values: ProofClaimRequest): Promise<ProofResponse>;
     /**
      * Delete a proof for a product (admin only).
      * DELETE /admin/collection/:collectionId/product/:productId/proof/:proofId

package/dist/api/qr.d.ts

@@ -0,0 +1,15 @@
+import type { QrShortCodeLookupResponse } from "../types/qr";
+/**
+ * QR namespace for public short code lookups.
+ */
+export declare namespace qr {
+    /**
+     * Resolve a short code to related resource identifiers.
+     * GET /public/lookupShortCode/:shortId/:code
+     *
+     * @param shortId - The short code identifier namespace
+     * @param code - The actual code to look up
+     * @returns Mapping with optional `collectionId`, `productId`, `proofId` and the `code`
+     */
+    function lookupShortCode(shortId: string, code: string): Promise<QrShortCodeLookupResponse>;
+}

package/dist/api/qr.js

@@ -0,0 +1,22 @@
+// src/api/qr.ts
+// QR / Short code lookup API
+import { request } from "../http";
+/**
+ * QR namespace for public short code lookups.
+ */
+export var qr;
+(function (qr) {
+    /**
+     * Resolve a short code to related resource identifiers.
+     * GET /public/lookupShortCode/:shortId/:code
+     *
+     * @param shortId - The short code identifier namespace
+     * @param code - The actual code to look up
+     * @returns Mapping with optional `collectionId`, `productId`, `proofId` and the `code`
+     */
+    async function lookupShortCode(shortId, code) {
+        const path = `/public/lookupShortCode/${encodeURIComponent(shortId)}/${encodeURIComponent(code)}`;
+        return request(path);
+    }
+    qr.lookupShortCode = lookupShortCode;
+})(qr || (qr = {}));

package/dist/index.d.ts

@@ -4,9 +4,12 @@ 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";
+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 { AttestationResponse, AttestationCreateRequest, AttestationUpdateRequest, } from "./types/attestation";
 export type { BatchResponse, BatchCreateRequest, BatchUpdateRequest, } from "./types/batch";
 export type { VariantResponse, VariantCreateRequest, VariantUpdateRequest, } from "./types/variant";
 export type { AppConfigOptions } from "./api/appConfiguration";
-export type { ProductCreateRequest, ProductUpdateRequest, } from "./types/product";
+export type { ProductCreateRequest, ProductUpdateRequest, Product, } from "./types/product";
+export type { Collection, CollectionResponse, CollectionCreateRequest, CollectionUpdateRequest, } from "./types/collection";
+export type { Proof, ProofResponse, ProofCreateRequest, ProofUpdateRequest, ProofClaimRequest, } from "./types/proof";
+export type { QrShortCodeLookupResponse, } from "./types/qr";

package/dist/types/auth.d.ts

@@ -1,4 +1,4 @@
-export type UserAccountRegistrationRequest = {
+export interface UserAccountRegistrationRequest {
     /** User's display name */
     name: string;
     /** Optional user email */
@@ -13,4 +13,4 @@ export type UserAccountRegistrationRequest = {
     collectionId?: string;
     /** Desired token type returned */
     tokenType?: 'bearer' | 'firebase';
-};
+}

package/dist/types/collection.d.ts

@@ -1,7 +1,7 @@
 /**
  * Represents a Collection object.
  */
-export interface CollectionResponse {
+export interface Collection {
     /** Unique identifier for the collection */
     id: string;
     /** Human-readable title of the collection */
@@ -63,3 +63,6 @@ export interface CollectionResponse {
     /** if dark mode is enabled for this collection */
     dark?: boolean;
 }
+export type CollectionResponse = Collection;
+export type CollectionCreateRequest = Omit<Collection, 'id' | 'shortId'>;
+export type CollectionUpdateRequest = Partial<Omit<Collection, 'id' | 'shortId'>>;

package/dist/types/index.d.ts

@@ -16,3 +16,4 @@ export * from "./broadcasts";
 export * from "./segments";
 export * from "./common";
 export * from "./journeys";
+export * from "./qr";

package/dist/types/index.js

@@ -18,3 +18,4 @@ export * from "./broadcasts";
 export * from "./segments";
 export * from "./common";
 export * from "./journeys";
+export * from "./qr";

package/dist/types/product.d.ts

@@ -1,7 +1,7 @@
 /**
- * Represents a Product Item object.
+ * Product domain model.
  */
-export interface ProductResponse {
+export interface Product {
     /** Unique identifier for the product */
     id: string;
     /** Name of the product */
@@ -34,5 +34,6 @@ export interface ProductResponse {
         [key: string]: any;
     };
 }
-export type ProductCreateRequest = Omit<ProductResponse, 'id' | 'collectionId'>;
-export type ProductUpdateRequest = Partial<Omit<ProductResponse, 'id' | 'collectionId'>>;
+export type ProductResponse = Product;
+export type ProductCreateRequest = Omit<Product, 'id' | 'collectionId'>;
+export type ProductUpdateRequest = Partial<Omit<Product, 'id' | 'collectionId'>>;

package/dist/types/proof.d.ts

@@ -1,7 +1,7 @@
 /**
  * Represents a Proof object.
  */
-export interface ProofResponse {
+export interface Proof {
     /** Unique identifier for the collection */
     collectionId: string;
     /** Creation timestamp */
@@ -21,3 +21,11 @@ export interface ProofResponse {
     /** Arbitrary key-value pairs for proof values */
     values: Record<string, any>;
 }
+export type ProofResponse = Proof;
+export interface ProofCreateRequest {
+    values: Record<string, any>;
+    claimable?: boolean;
+    transient?: boolean;
+}
+export type ProofUpdateRequest = Partial<ProofCreateRequest>;
+export type ProofClaimRequest = Record<string, any>;

package/dist/types/qr.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Response for public short code lookup.
+ * Resolves the short code to related resource identifiers.
+ */
+export interface QrShortCodeLookupResponse {
+    /** The collection ID, if applicable */
+    collectionId?: string;
+    /** The product ID, if applicable */
+    productId?: string;
+    /** The proof ID, if applicable */
+    proofId?: string;
+    /** The resolved code string */
+    code: string;
+}

package/dist/types/qr.js

@@ -0,0 +1,2 @@
+// src/types/qr.ts
+export {};

package/package.json

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