@proveanything/smartlinks 1.3.19 → 1.3.21

package/dist/types/crate.d.ts

@@ -0,0 +1,79 @@
+/**
+ * Crate Management Types
+ *
+ * Types for managing crates (containers for tags/products).
+ */
+/**
+ * Item within a crate.
+ */
+export interface CrateItem {
+    id: string;
+    codeId: string;
+    batchId?: string;
+    productId?: string;
+    claimId?: string;
+    productName?: string;
+    productGtin?: string;
+    productImage?: string;
+    data?: Record<string, any>;
+}
+/**
+ * Represents a crate containing items.
+ */
+export interface Crate {
+    id: string;
+    items?: CrateItem[];
+    deleted?: boolean;
+    deletedAt?: string | null;
+}
+/**
+ * Query parameters for listing crates.
+ */
+export interface ListCratesRequest {
+    limit?: number;
+    startAfter?: string;
+    includeDeleted?: boolean;
+}
+/**
+ * Response from listing crates.
+ */
+export interface ListCratesResponse {
+    items: Crate[];
+    hasMore: boolean;
+    lastId: string | null;
+}
+/**
+ * Response from getting a single crate.
+ */
+export interface GetCrateResponse extends Crate {
+}
+/**
+ * Request to create a crate.
+ */
+export interface CreateCrateRequest {
+    items?: CrateItem[];
+    [key: string]: any;
+}
+/**
+ * Response from creating a crate.
+ */
+export interface CreateCrateResponse extends Crate {
+}
+/**
+ * Request to update a crate.
+ */
+export interface UpdateCrateRequest {
+    items?: CrateItem[];
+    [key: string]: any;
+}
+/**
+ * Response from updating a crate.
+ */
+export interface UpdateCrateResponse extends Crate {
+}
+/**
+ * Response from deleting a crate.
+ */
+export interface DeleteCrateResponse {
+    success: boolean;
+}

package/dist/types/crate.js

@@ -0,0 +1,6 @@
+/**
+ * Crate Management Types
+ *
+ * Types for managing crates (containers for tags/products).
+ */
+export {};

package/dist/types/index.d.ts

@@ -24,4 +24,5 @@ export * from "./jobs";
 export * from "./realtime";
 export * from "./tags";
 export * from "./order";
+export * from "./crate";
 export * from "./iframeResponder";

package/dist/types/index.js

@@ -26,4 +26,5 @@ export * from "./jobs";
 export * from "./realtime";
 export * from "./tags";
 export * from "./order";
+export * from "./crate";
 export * from "./iframeResponder";

package/dist/types/order.d.ts

@@ -12,8 +12,23 @@ export interface OrderItem {
     orderId: string;
     itemType: 'tag' | 'proof' | 'serial';
     itemId: string;
+    collectionId?: string;
+    productId?: string;
+    variantId?: string | null;
+    batchId?: string | null;
     metadata: Record<string, any>;
     createdAt: string;
+    order?: OrderSummary;
+}
+/**
+ * Summary of order details (included with items when requested).
+ */
+export interface OrderSummary {
+    id: string;
+    orderRef?: string;
+    status: string;
+    customerId?: string;
+    createdAt: string;
 }
 /**
  * Represents an order containing multiple items.
@@ -241,6 +256,55 @@ export interface LookupByProductResponse {
     limit: number;
     offset: number;
 }
+/**
+ * Query parameters for finding orders by batch/product/variant.
+ */
+export interface FindOrdersByAttributeParams {
+    limit?: number;
+    offset?: number;
+    includeItems?: boolean;
+}
+/**
+ * Response from finding orders by batch/product/variant.
+ */
+export interface FindOrdersByAttributeResponse {
+    orders: Order[];
+    limit: number;
+    offset: number;
+}
+/**
+ * Query parameters for finding items by batch/product/variant.
+ */
+export interface FindItemsByAttributeParams {
+    limit?: number;
+    offset?: number;
+    includeOrder?: boolean;
+}
+/**
+ * Response from finding items by batch/product/variant.
+ */
+export interface FindItemsByAttributeResponse {
+    items: OrderItem[];
+    count: number;
+    limit: number;
+    offset: number;
+}
+/**
+ * Query parameters for getting order IDs by attribute.
+ */
+export interface GetOrderIdsParams {
+    limit?: number;
+    offset?: number;
+}
+/**
+ * Response from getting order IDs by attribute.
+ */
+export interface GetOrderIdsResponse {
+    orderIds: string[];
+    count: number;
+    attribute: 'batchId' | 'productId' | 'variantId';
+    value: string;
+}
 /**
  * Summary of scans for a single tag.
  */

package/docs/API_SUMMARY.md

@@ -1,6 +1,6 @@
 # Smartlinks API Summary
 
-Version: 1.3.19  |  Generated: 2026-02-08T09:16:59.107Z
+Version: 1.3.21  |  Generated: 2026-02-09T12:29:22.158Z
 
 This is a concise summary of all available API functions and types.
 
@@ -625,11 +625,66 @@ interface AuthKitConfig {
 
 ### batch
 
-**BatchResponse** = `any`
+**FirebaseTimestamp** (interface)
+```typescript
+interface FirebaseTimestamp {
+  seconds: number                 // Unix timestamp in seconds
+  nanoseconds?: number            // Nanoseconds component
+}
+```
+
+**BatchResponse** (interface)
+```typescript
+interface BatchResponse {
+  id: string                      // Batch ID
+  name?: string                   // Batch name
+  expiryDate?: FirebaseTimestamp | string  // Firebase timestamp or ISO 8601 date
+  productId?: string              // Product ID (for collection-level searches)
+  collectionId?: string           // Collection ID
+  [key: string]: any              // Additional batch fields
+}
+```
+
+**BatchCreateRequest** (interface)
+```typescript
+interface BatchCreateRequest {
+  id: string                      // Batch ID
+  name?: string                   // Batch name
+  expiryDate?: FirebaseTimestamp | string  // Firebase timestamp or ISO 8601 date
+  [key: string]: any              // Additional batch fields
+}
+```
+
+**BatchUpdateRequest** (interface)
+```typescript
+interface BatchUpdateRequest {
+  name?: string                   // Batch name
+  expiryDate?: FirebaseTimestamp | string  // Firebase timestamp or ISO 8601 date
+  [key: string]: any              // Additional batch fields
+}
+```
 
-**BatchCreateRequest** = `any`
+**SearchBatchesRequest** (interface)
+```typescript
+interface SearchBatchesRequest {
+  search?: string                 // Search term (batch ID or name)
+  productId?: string              // Filter by specific product
+  limit?: number                  // Max results (default: 100)
+}
+```
 
-**BatchUpdateRequest** = `any`
+**BatchTag** (interface)
+```typescript
+interface BatchTag {
+  code: string                    // Code/tag ID
+  claimSetId: string              // Claim set ID
+  collectionId?: string           // Collection ID
+  productId?: string              // Associated product ID
+  batchId?: string                // Batch ID
+  tagId?: string                  // Tag identifier
+  index?: number                  // Position in claim set
+}
+```
 
 ### broadcasts
 
@@ -1493,6 +1548,74 @@ interface ContactSchema {
 
 **FieldType** = ``
 
+### crate
+
+**CrateItem** (interface)
+```typescript
+interface CrateItem {
+  id: string                      // Item ID (tag ID)
+  codeId: string                  // Code identifier
+  batchId?: string                // Batch identifier
+  productId?: string              // Product identifier
+  claimId?: string                // Claim identifier
+  productName?: string            // Product name
+  productGtin?: string            // Product GTIN
+  productImage?: string           // Product image URL
+  data?: Record<string, any>      // Additional item data
+}
+```
+
+**Crate** (interface)
+```typescript
+interface Crate {
+  id: string                      // Crate ID
+  items?: CrateItem[]             // Array of items in the crate
+  deleted?: boolean               // Whether the crate is soft-deleted
+  deletedAt?: string | null       // ISO 8601 timestamp when deleted
+}
+```
+
+**ListCratesRequest** (interface)
+```typescript
+interface ListCratesRequest {
+  limit?: number                  // Number of results per page (default: 100, max: 100)
+  startAfter?: string             // Crate ID to start after for pagination
+  includeDeleted?: boolean        // Include soft-deleted crates (default: false)
+}
+```
+
+**ListCratesResponse** (interface)
+```typescript
+interface ListCratesResponse {
+  items: Crate[]                  // Array of crates
+  hasMore: boolean                // Whether more results are available
+  lastId: string | null           // ID of last crate (use as startAfter for next page)
+}
+```
+
+**CreateCrateRequest** (interface)
+```typescript
+interface CreateCrateRequest {
+  items?: CrateItem[]             // Initial items for the crate
+  [key: string]: any              // Additional fields
+}
+```
+
+**UpdateCrateRequest** (interface)
+```typescript
+interface UpdateCrateRequest {
+  items?: CrateItem[]             // Updated items
+  [key: string]: any              // Additional fields
+}
+```
+
+**DeleteCrateResponse** (interface)
+```typescript
+interface DeleteCrateResponse {
+  success: boolean
+}
+```
+
 ### error
 
 **ErrorResponse** (interface)
@@ -2171,8 +2294,24 @@ interface OrderItem {
   orderId: string                   // Parent order ID
   itemType: 'tag' | 'proof' | 'serial' // Type of item
   itemId: string                    // The tag ID, proof ID, or serial number
+  collectionId?: string             // Collection ID
+  productId?: string                // Product ID
+  variantId?: string | null         // Variant ID
+  batchId?: string | null           // Batch ID
   metadata: Record<string, any>     // Item-specific metadata
   createdAt: string                 // ISO 8601 timestamp
+  order?: OrderSummary              // Optional order summary (when includeOrder=true)
+}
+```
+
+**OrderSummary** (interface)
+```typescript
+interface OrderSummary {
+  id: string                        // Order ID
+  orderRef?: string                 // Order reference
+  status: string                    // Order status
+  customerId?: string               // Customer ID
+  createdAt: string                 // ISO 8601 timestamp
 }
 ```
 
@@ -2395,6 +2534,61 @@ interface LookupByProductResponse {
 }
 ```
 
+**FindOrdersByAttributeParams** (interface)
+```typescript
+interface FindOrdersByAttributeParams {
+  limit?: number                    // Max results (default: 100)
+  offset?: number                   // Pagination offset (default: 0)
+  includeItems?: boolean            // Include items array (default: false)
+}
+```
+
+**FindOrdersByAttributeResponse** (interface)
+```typescript
+interface FindOrdersByAttributeResponse {
+  orders: Order[]
+  limit: number
+  offset: number
+}
+```
+
+**FindItemsByAttributeParams** (interface)
+```typescript
+interface FindItemsByAttributeParams {
+  limit?: number                    // Max results (default: 100)
+  offset?: number                   // Pagination offset (default: 0)
+  includeOrder?: boolean            // Include order summary (default: false)
+}
+```
+
+**FindItemsByAttributeResponse** (interface)
+```typescript
+interface FindItemsByAttributeResponse {
+  items: OrderItem[]
+  count: number
+  limit: number
+  offset: number
+}
+```
+
+**GetOrderIdsParams** (interface)
+```typescript
+interface GetOrderIdsParams {
+  limit?: number                    // Max results (default: 1000)
+  offset?: number                   // Pagination offset (default: 0)
+}
+```
+
+**GetOrderIdsResponse** (interface)
+```typescript
+interface GetOrderIdsResponse {
+  orderIds: string[]
+  count: number
+  attribute: 'batchId' | 'productId' | 'variantId'
+  value: string
+}
+```
+
 **TagScanSummary** (interface)
 ```typescript
 interface TagScanSummary {
@@ -3875,6 +4069,19 @@ Get serial numbers for a batch (admin only).
     codeId: string) → `Promise<any>`
 Look up a serial number by code for a batch (admin only).
 
+**searchInCollection**(collectionId: string,
+    params?: SearchBatchesRequest) → `Promise<BatchResponse[]>`
+Search for batches across all products in a collection. Allows searching by batch ID or name, with optional product filtering. ```typescript // Search for batches containing "2024" const batches = await batch.searchInCollection('coll_123', { search: 'BATCH-2024', limit: 50 }) // Filter batches for a specific product const productBatches = await batch.searchInCollection('coll_123', { productId: 'prod_abc', limit: 100 }) // Get all batches in collection const allBatches = await batch.searchInCollection('coll_123') // Check for expired batches batches.forEach(batch => { if (batch.expiryDate?.seconds) { const expiryDate = new Date(batch.expiryDate.seconds * 1000) if (expiryDate < new Date()) { console.log(`Batch ${batch.id} is expired`) } } }) ```
+
+**findInCollection**(collectionId: string,
+    batchId: string) → `Promise<BatchResponse>`
+Find a specific batch by ID across all products in a collection. Returns the batch along with the productId it belongs to. ```typescript // Find which product contains a specific batch const batch = await batch.findInCollection('coll_123', 'BATCH-2024-001') console.log(`Batch found in product: ${batch.productId}`) console.log(`Expires: ${batch.expiryDate}`) ```
+
+**getBatchTags**(collectionId: string,
+    batchId: string,
+    claimSetId?: string) → `Promise<BatchTag[]>`
+Get all tags/codes assigned to a specific batch. Shows which claim set codes have been assigned to this batch. ```typescript // Get all tags assigned to a batch const tags = await batch.getBatchTags('coll_123', 'BATCH-2024-001') console.log(`Batch has ${tags.length} tags assigned`) tags.forEach(tag => { console.log(`Code: ${tag.code}, ClaimSet: ${tag.claimSetId}, TagID: ${tag.tagId}`) }) // Get tags from a specific claim set const claimSetTags = await batch.getBatchTags('coll_123', 'BATCH-2024-001', '000001') ```
+
 ### broadcasts
 
 **create**(collectionId: string,
@@ -4123,20 +4330,26 @@ Public: Get contact update schema for a collection Fetches the public contact sc
 
 ### crate
 
-**get**(collectionId: string, crateId: string) → `Promise<any>`
-Get a single crate by ID for a collection (admin only).
+**list**(collectionId: string,
+    params?: ListCratesRequest) → `Promise<ListCratesResponse>`
+List crates for a collection with pagination support. Returns crates in pages, with support for soft-deleted crates. ```typescript // Get first page const page1 = await crate.list('coll_123', { limit: 100 }) console.log(`Found ${page1.items.length} crates`) // Get next page if (page1.hasMore) { const page2 = await crate.list('coll_123', { limit: 100, startAfter: page1.lastId }) } // Include soft-deleted crates const withDeleted = await crate.list('coll_123', { includeDeleted: true }) ```
 
-**list**(collectionId: string) → `Promise<any[]>`
-List all crates for a collection (admin only).
+**get**(collectionId: string,
+    crateId: string) → `Promise<GetCrateResponse>`
+Get a single crate by ID for a collection (admin only). ```typescript const crate = await crate.get('coll_123', 'crate_abc123') console.log(`Crate has ${crate.items?.length ?? 0} items`) ```
 
-**create**(collectionId: string, data: any) → `Promise<any>`
-Create a new crate for a collection (admin only).
+**create**(collectionId: string,
+    data: CreateCrateRequest) → `Promise<CreateCrateResponse>`
+Create a new crate for a collection (admin only). ```typescript const newCrate = await crate.create('coll_123', { items: [ { id: 'tag_001', codeId: 'ABC123', productId: 'prod_1', productName: 'Product Name' } ] }) console.log(`Created crate ${newCrate.id}`) ```
 
-**update**(collectionId: string, crateId: string, data: any) → `Promise<any>`
-Update a crate for a collection (admin only).
+**update**(collectionId: string,
+    crateId: string,
+    data: UpdateCrateRequest) → `Promise<UpdateCrateResponse>`
+Update a crate for a collection (admin only). ```typescript const updated = await crate.update('coll_123', 'crate_abc123', { items: [ { id: 'tag_002', codeId: 'XYZ789', productId: 'prod_2' } ] }) ```
 
-**remove**(collectionId: string, crateId: string) → `Promise<void>`
-Delete a crate for a collection (admin only).
+**remove**(collectionId: string,
+    crateId: string) → `Promise<DeleteCrateResponse>`
+Delete a crate for a collection (admin only). This performs a soft delete. ```typescript await crate.remove('coll_123', 'crate_abc123') ```
 
 ### form
 
@@ -4370,6 +4583,42 @@ Get analytics summary for multiple orders at once. Efficient way to retrieve sca
     params?: SummaryRequest) → `Promise<CollectionSummaryResponse>`
 Get collection-wide analytics summary across all orders. Returns daily scan counts and admin activity overview. ```typescript // Get all-time collection summary const summary = await order.getCollectionSummary('coll_123') console.log(`Admin activity count: ${summary.adminActivity.count}`) console.log('Scans by day:') summary.scansByDay.forEach(day => { console.log(`  ${day.date}: ${day.scanCount} scans`) }) // Get summary for last 30 days const recentSummary = await order.getCollectionSummary('coll_123', { from: '2026-01-08T00:00:00Z', to: '2026-02-08T00:00:00Z' }) ```
 
+**findByBatch**(collectionId: string,
+    batchId: string,
+    params?: FindOrdersByAttributeParams) → `Promise<FindOrdersByAttributeResponse>`
+Find all orders containing items from a specific batch. Uses indexed queries for fast lookups across order items. ```typescript // Find orders with items from a specific batch const { orders } = await order.findByBatch('coll_123', 'BATCH-2024-001', { includeItems: true, limit: 50 }) // Get unique customers who received this batch const customers = [...new Set(orders.map(o => o.customerId).filter(Boolean))] console.log(`Batch delivered to ${customers.length} customers`) ```
+
+**findOrdersByProduct**(collectionId: string,
+    productId: string,
+    params?: FindOrdersByAttributeParams) → `Promise<FindOrdersByAttributeResponse>`
+Find all orders containing items from a specific product. Uses indexed queries for fast lookups across order items. ```typescript // Find all orders containing a product const { orders, limit, offset } = await order.findOrdersByProduct('coll_123', 'prod_789', { limit: 100 }) console.log(`Product appears in ${orders.length} orders`) ```
+
+**findByVariant**(collectionId: string,
+    variantId: string,
+    params?: FindOrdersByAttributeParams) → `Promise<FindOrdersByAttributeResponse>`
+Find all orders containing items from a specific variant. Uses indexed queries for fast lookups across order items. ```typescript // Find orders with a specific variant const { orders } = await order.findByVariant('coll_123', 'var_456', { includeItems: true }) console.log(`Variant ${variantId} in ${orders.length} orders`) ```
+
+**findItemsByBatch**(collectionId: string,
+    batchId: string,
+    params?: FindItemsByAttributeParams) → `Promise<FindItemsByAttributeResponse>`
+Get individual order items (not full orders) for a specific batch. Returns all matching items with optional order summary. ```typescript // Get items from a batch with order info const { items, count } = await order.findItemsByBatch('coll_123', 'BATCH-2024-001', { includeOrder: true, limit: 100 }) // Group by order status const byStatus = items.reduce((acc, item) => { const status = item.order?.status || 'unknown' acc[status] = (acc[status] || 0) + 1 return acc }, {}) ```
+
+**findItemsByProduct**(collectionId: string,
+    productId: string,
+    params?: FindItemsByAttributeParams) → `Promise<FindItemsByAttributeResponse>`
+Get individual order items for a specific product. Returns all matching items with optional order summary. ```typescript // Get all items for a product const { items } = await order.findItemsByProduct('coll_123', 'prod_789', { includeOrder: true }) console.log(`Product delivered in ${items.length} order items`) ```
+
+**findItemsByVariant**(collectionId: string,
+    variantId: string,
+    params?: FindItemsByAttributeParams) → `Promise<FindItemsByAttributeResponse>`
+Get individual order items for a specific variant. Returns all matching items with optional order summary. ```typescript // Get variant items with order details const { items, count } = await order.findItemsByVariant('coll_123', 'var_456', { includeOrder: true, limit: 50 }) ```
+
+**getOrderIdsByAttribute**(collectionId: string,
+    attribute: 'batchId' | 'productId' | 'variantId',
+    value: string,
+    params?: GetOrderIdsParams) → `Promise<GetOrderIdsResponse>`
+Get unique order IDs containing items matching the specified attribute. Lightweight query that only returns order IDs, not full order objects. ```typescript // Get order IDs for a batch (fast count) const { orderIds, count } = await order.getOrderIdsByAttribute( 'coll_123', 'batchId', 'BATCH-2024-001' ) console.log(`Batch appears in ${count} orders`) // Get order IDs for a product const productOrders = await order.getOrderIdsByAttribute( 'coll_123', 'productId', 'prod_789', { limit: 500 } ) ```
+
 ### product
 
 **get**(collectionId: string,

package/package.json

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