@proveanything/smartlinks 1.0.55 → 1.0.56

package/API_SUMMARY.md

@@ -1,6 +1,6 @@
 # Smartlinks API Summary
 
-Version: 1.0.55  |  Generated: 2025-12-01T16:15:00.313Z
+Version: 1.0.56  |  Generated: 2025-12-10T12:13:56.087Z
 
 This is a concise summary of all available API functions and types.
 
@@ -320,30 +320,30 @@ interface AuthKitConfig {
 **ClaimCodeRef** (interface)
 ```typescript
 interface ClaimCodeRef {
-  codeId: string
-  claimId: string
+  codeId: string // Identifier of the code (e.g., tag or QR code)
+  claimId: string // Identifier of the claim within the claim set
 }
 ```
 
 **UpdateClaimDataRequest** (interface)
 ```typescript
 interface UpdateClaimDataRequest {
-  data: Record<string, any>
-  codes: ClaimCodeRef[]
+  data: Record<string, any> // Arbitrary key/value pairs for the claim data update
+  codes: ClaimCodeRef[] // Array of code+claim references affected by this update
 }
 ```
 
 **AssignClaimsRequest** (interface)
 ```typescript
 interface AssignClaimsRequest {
-  id: string
-  collectionId: string
-  productId: string
-  batchId?: string
-  start?: number
-  end?: number
-  codeId?: string
-  data?: Record<string, any>
+  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
 }
 ```
 
@@ -488,6 +488,65 @@ interface ErrorResponse {
 }
 ```
 
+### nfc
+
+**NfcTagInfo** (interface)
+```typescript
+interface NfcTagInfo {
+  id: string
+  tagId: string
+  claimSetId: string
+  collectionId?: string
+  productId?: string
+  batchId?: string
+  variantId?: string
+  proofId?: string
+  index?: number
+  data?: Record<string, any>
+}
+```
+
+**NfcValidateRequest** (interface)
+```typescript
+interface NfcValidateRequest {
+  claimSetId: string
+  codeId: string
+  mirror?: string
+  userId?: string
+}
+```
+
+**NfcValidateResponse** (interface)
+```typescript
+interface NfcValidateResponse {
+  claimSetId: string
+  codeId: string
+  tagId: string
+  index?: number
+  isAdmin: boolean
+  path?: string
+  collectionId?:  string
+  collection?:  Record<string, any>
+  count: number,
+  previousCount: number
+  data?: Record<string, any>
+  productId?:  string
+  product?:  Record<string, any>
+  batchId?:  string
+  variantId?:  string
+  proofId?:  string
+}
+```
+
+**NfcClaimTagRequest** (interface)
+```typescript
+interface NfcClaimTagRequest {
+  claimSetId: string
+  codeId: string
+  data: Record<string, any>
+}
+```
+
 ### product
 
 **ProductResponse** (interface)
@@ -531,6 +590,8 @@ interface ProofResponse {
   productId: string
   tokenId: string
   userId: string
+  claimable: boolean
+  transient: boolean
   values: Record<string, any>
 }
 ```

package/dist/api/nfc.d.ts

@@ -1,7 +1,18 @@
+import type { NfcValidateRequest, NfcValidateResponse, NfcTagInfo, NfcClaimTagRequest } from "../types/nfc";
 export declare const nfc: {
     /**
      * Claim an NFC tag (public).
      * POST /api/va/public/nfc/claimTag
      */
-    claimTag<T = any>(data: any): Promise<T>;
+    claimTag(data: NfcClaimTagRequest): Promise<NfcTagInfo>;
+    /**
+     * Validate an NFC tag payload (public).
+     * POST /public/nfc/validate
+     */
+    validate(data: NfcValidateRequest): Promise<NfcValidateResponse>;
+    /**
+     * Lookup a tag by its ID (public).
+     * GET /public/nfc/findByTag/:tagId
+     */
+    lookupTag(tagId: string): Promise<NfcTagInfo[]>;
 };

package/dist/api/nfc.js

@@ -1,5 +1,5 @@
 // src/api/nfc.ts
-import { post } from "../http";
+import { post, request } from "../http";
 export const nfc = {
     /**
      * Claim an NFC tag (public).
@@ -8,4 +8,18 @@ export const nfc = {
     async claimTag(data) {
         return post("/public/nfc/claimTag", data);
     },
+    /**
+     * Validate an NFC tag payload (public).
+     * POST /public/nfc/validate
+     */
+    async validate(data) {
+        return post("/public/nfc/validate", data);
+    },
+    /**
+     * Lookup a tag by its ID (public).
+     * GET /public/nfc/findByTag/:tagId
+     */
+    async lookupTag(tagId) {
+        return request(`/public/nfc/findByTag/${encodeURIComponent(tagId)}`);
+    },
 };

package/dist/types/claimSet.d.ts

@@ -2,9 +2,7 @@
  * 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;
 }
 /**
@@ -12,29 +10,19 @@ export interface ClaimCodeRef {
  * 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/index.d.ts

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

package/dist/types/index.js

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

package/dist/types/nfc.d.ts

@@ -0,0 +1,41 @@
+export interface NfcTagInfo {
+    id: string;
+    tagId: string;
+    claimSetId: string;
+    collectionId?: string;
+    productId?: string;
+    batchId?: string;
+    variantId?: string;
+    proofId?: string;
+    index?: number;
+    data?: Record<string, any>;
+}
+export interface NfcValidateRequest {
+    claimSetId: string;
+    codeId: string;
+    mirror?: string;
+    userId?: string;
+}
+export interface NfcValidateResponse {
+    claimSetId: string;
+    codeId: string;
+    tagId: string;
+    index?: number;
+    isAdmin: boolean;
+    path?: string;
+    collectionId?: string;
+    collection?: Record<string, any>;
+    count: number;
+    previousCount: number;
+    data?: Record<string, any>;
+    productId?: string;
+    product?: Record<string, any>;
+    batchId?: string;
+    variantId?: string;
+    proofId?: string;
+}
+export interface NfcClaimTagRequest {
+    claimSetId: string;
+    codeId: string;
+    data: Record<string, any>;
+}

package/dist/types/nfc.js

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

package/dist/types/proof.d.ts

@@ -14,6 +14,10 @@ export interface ProofResponse {
     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.55",
+  "version": "1.0.56",
   "description": "Official JavaScript/TypeScript SDK for the Smartlinks API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",