@proveanything/smartlinks 1.3.2 → 1.3.3

package/dist/types/contact.d.ts

@@ -129,7 +129,21 @@ export interface CommsState {
     /** Keyed by `_default` or `${type}_${id}` */
     preferences?: Record<string, PreferenceEntry>;
 }
-export type FieldWidget = 'text' | 'email' | 'tel' | 'select' | 'checkbox';
+/**
+ * Operators for conditional field visibility.
+ * Use these to control when a custom field is shown based on another field's value.
+ */
+export type ConditionOperator = 'equals' | 'notEquals' | 'contains' | 'notContains' | 'isEmpty' | 'isNotEmpty' | 'isTrue' | 'isFalse';
+/**
+ * Condition that determines when a field should be visible.
+ * When present, the field only renders if the condition evaluates to true.
+ */
+export interface FieldCondition {
+    dependsOn: string;
+    operator: ConditionOperator;
+    value?: string | string[];
+}
+export type FieldWidget = 'text' | 'email' | 'tel' | 'select' | 'multiselect' | 'checkbox' | 'number' | 'date' | 'url';
 export type FieldType = 'string' | 'url' | 'email' | 'tel' | 'text' | 'select' | 'checkbox' | 'boolean';
 export interface BaseField {
     key: string;
@@ -142,11 +156,17 @@ export interface BaseField {
 }
 export interface CoreField extends BaseField {
 }
+/**
+ * Custom field definition returned by the schema endpoint.
+ */
 export interface CustomField extends BaseField {
     path: string;
     required: boolean;
     order?: number;
     options?: string[];
+    placeholder?: string;
+    description?: string;
+    condition?: FieldCondition;
 }
 export interface ContactSchema {
     version: number;
@@ -158,3 +178,14 @@ export interface ContactSchema {
         customFieldsVersion: number;
     };
 }
+/**
+ * Evaluate whether a field's condition is satisfied.
+ * Returns true if the field should be visible.
+ *
+ * @example
+ * ```typescript
+ * const field = schema.customFields.find(f => f.key === 'city')
+ * const isVisible = evaluateCondition(field.condition, formValues)
+ * ```
+ */
+export declare function evaluateCondition(condition: FieldCondition | undefined, fieldValues: Record<string, any>): boolean;

package/dist/types/contact.js

@@ -1 +1,35 @@
-export {};
+/**
+ * Evaluate whether a field's condition is satisfied.
+ * Returns true if the field should be visible.
+ *
+ * @example
+ * ```typescript
+ * const field = schema.customFields.find(f => f.key === 'city')
+ * const isVisible = evaluateCondition(field.condition, formValues)
+ * ```
+ */
+export function evaluateCondition(condition, fieldValues) {
+    if (!condition)
+        return true; // No condition = always visible
+    const value = fieldValues[condition.dependsOn];
+    switch (condition.operator) {
+        case 'isEmpty':
+            return value == null || value === '' || (Array.isArray(value) && !value.length);
+        case 'isNotEmpty':
+            return value != null && value !== '' && !(Array.isArray(value) && !value.length);
+        case 'isTrue':
+            return value === true;
+        case 'isFalse':
+            return value === false;
+        case 'equals':
+            return value === condition.value;
+        case 'notEquals':
+            return value !== condition.value;
+        case 'contains':
+            return Array.isArray(value) && value.includes(condition.value);
+        case 'notContains':
+            return !Array.isArray(value) || !value.includes(condition.value);
+        default:
+            return true;
+    }
+}

package/dist/types/index.d.ts

@@ -22,3 +22,5 @@ export * from "./interaction";
 export * from "./location";
 export * from "./jobs";
 export * from "./realtime";
+export * from "./tags";
+export * from "./order";

package/dist/types/index.js

@@ -24,3 +24,5 @@ export * from "./interaction";
 export * from "./location";
 export * from "./jobs";
 export * from "./realtime";
+export * from "./tags";
+export * from "./order";

package/dist/types/order.d.ts

@@ -0,0 +1,137 @@
+/**
+ * Order Management Types
+ *
+ * Types for grouping scanned tags, proofs, or serial numbers into orders
+ * with flexible metadata.
+ */
+/**
+ * Represents a single item within an order.
+ */
+export interface OrderItem {
+    id: string;
+    orderId: string;
+    itemType: 'tag' | 'proof' | 'serial';
+    itemId: string;
+    metadata: Record<string, any>;
+    createdAt: string;
+}
+/**
+ * Represents an order containing multiple items.
+ */
+export interface Order {
+    id: string;
+    orgId: string;
+    collectionId: string;
+    orderRef?: string;
+    customerId?: string;
+    status: string;
+    itemCount: number;
+    metadata: Record<string, any>;
+    items: OrderItem[];
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * Request to create a new order with items.
+ */
+export interface CreateOrderRequest {
+    items: Array<{
+        itemType: 'tag' | 'proof' | 'serial';
+        itemId: string;
+        metadata?: Record<string, any>;
+    }>;
+    orderRef?: string;
+    customerId?: string;
+    status?: string;
+    metadata?: Record<string, any>;
+}
+/**
+ * Response from creating an order.
+ */
+export interface CreateOrderResponse extends Order {
+}
+/**
+ * Response from getting a single order.
+ */
+export interface GetOrderResponse extends Order {
+}
+/**
+ * Request to update an existing order.
+ * Items are managed separately via add/remove endpoints.
+ */
+export interface UpdateOrderRequest {
+    orderRef?: string;
+    customerId?: string;
+    status?: string;
+    metadata?: Record<string, any>;
+}
+/**
+ * Response from updating an order.
+ */
+export interface UpdateOrderResponse extends Order {
+}
+/**
+ * Response from deleting an order.
+ */
+export interface DeleteOrderResponse {
+    success: boolean;
+}
+/**
+ * Request parameters for listing orders.
+ */
+export interface ListOrdersRequest {
+    limit?: number;
+    offset?: number;
+    status?: string;
+    orderRef?: string;
+    customerId?: string;
+}
+/**
+ * Response from listing orders.
+ */
+export interface ListOrdersResponse {
+    orders: Order[];
+    limit: number;
+    offset: number;
+}
+/**
+ * Request to add items to an existing order.
+ */
+export interface AddItemsRequest {
+    items: Array<{
+        itemType: 'tag' | 'proof' | 'serial';
+        itemId: string;
+        metadata?: Record<string, any>;
+    }>;
+}
+/**
+ * Response from adding items to an order.
+ */
+export interface AddItemsResponse extends Order {
+}
+/**
+ * Request to remove items from an order.
+ */
+export interface RemoveItemsRequest {
+    itemIds: string[];
+}
+/**
+ * Response from removing items from an order.
+ */
+export interface RemoveItemsResponse extends Order {
+}
+/**
+ * Request to lookup orders by item.
+ */
+export interface LookupOrdersRequest {
+    items: Array<{
+        itemType: 'tag' | 'proof' | 'serial';
+        itemId: string;
+    }>;
+}
+/**
+ * Response from looking up orders by item.
+ */
+export interface LookupOrdersResponse {
+    orders: Order[];
+}

package/dist/types/order.js

@@ -0,0 +1,7 @@
+/**
+ * Order Management Types
+ *
+ * Types for grouping scanned tags, proofs, or serial numbers into orders
+ * with flexible metadata.
+ */
+export {};

package/dist/types/tags.d.ts

@@ -0,0 +1,172 @@
+/**
+ * Tag Management Types
+ *
+ * Types for creating mappings between physical tags (NFC tags, QR codes, etc.)
+ * and digital proofs.
+ */
+/**
+ * Represents a tag mapping in the system.
+ */
+export interface Tag {
+    id: string;
+    orgId: string;
+    tagId: string;
+    collectionId: string;
+    productId: string;
+    variantId?: string | null;
+    batchId?: string | null;
+    proofId: string;
+    metadata: Record<string, any>;
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * Request to create a single tag mapping.
+ * If proofId is not provided, automatically generates a serial number.
+ */
+export interface CreateTagRequest {
+    tagId: string;
+    productId: string;
+    variantId?: string;
+    batchId?: string;
+    proofId?: string;
+    useSerialNumber?: boolean;
+    metadata?: Record<string, any>;
+    force?: boolean;
+}
+/**
+ * Response from creating a single tag.
+ */
+export interface CreateTagResponse extends Tag {
+    wasUpdated?: boolean;
+}
+/**
+ * Request to create multiple tag mappings efficiently.
+ * By default, auto-generates serial numbers for all tags without explicit proofId.
+ */
+export interface CreateTagsBatchRequest {
+    tags: Array<{
+        tagId: string;
+        productId: string;
+        variantId?: string;
+        batchId?: string;
+        proofId?: string;
+        metadata?: Record<string, any>;
+    }>;
+    force?: boolean;
+}
+/**
+ * Response from batch creating tags.
+ */
+export interface CreateTagsBatchResponse {
+    summary: {
+        total: number;
+        created: number;
+        updated: number;
+        failed: number;
+        conflicts: number;
+    };
+    results: {
+        created: Tag[];
+        updated: Tag[];
+        failed: Array<{
+            tagId: string;
+            reason: string;
+            message: string;
+            existingTag?: Tag;
+        }>;
+        conflicts: Array<{
+            tagId: string;
+            reason: string;
+            message: string;
+            existingTag: Tag;
+        }>;
+    };
+}
+/**
+ * Request to update an existing tag mapping.
+ */
+export interface UpdateTagRequest {
+    productId?: string;
+    variantId?: string | null;
+    batchId?: string | null;
+    proofId?: string;
+    metadata?: Record<string, any>;
+}
+/**
+ * Response from updating a tag.
+ */
+export interface UpdateTagResponse extends Tag {
+}
+/**
+ * Response from deleting a tag.
+ */
+export interface DeleteTagResponse {
+    success: boolean;
+}
+/**
+ * Response from getting a single tag.
+ */
+export interface GetTagResponse extends Tag {
+}
+/**
+ * Request parameters for listing tags.
+ */
+export interface ListTagsRequest {
+    limit?: number;
+    offset?: number;
+    productId?: string;
+    variantId?: string;
+    batchId?: string;
+}
+/**
+ * Response from listing tags.
+ */
+export interface ListTagsResponse {
+    tags: Tag[];
+    limit: number;
+    offset: number;
+}
+/**
+ * Request parameters for public tag lookup.
+ */
+export interface PublicGetTagRequest {
+    embed?: string;
+}
+/**
+ * Response from public tag lookup with optional embedded data.
+ */
+export interface PublicGetTagResponse {
+    tag: Tag;
+    collection?: any;
+    product?: any;
+    proof?: any;
+}
+/**
+ * Request to lookup multiple tags in a single request.
+ */
+export interface PublicBatchLookupRequest {
+    tagIds: string[];
+    embed?: string;
+}
+/**
+ * Response from batch lookup with deduplicated related data.
+ */
+export interface PublicBatchLookupResponse {
+    tags: Record<string, Tag>;
+    collections?: Record<string, any>;
+    products?: Record<string, any>;
+    proofs?: Record<string, any>;
+}
+/**
+ * Query parameters for public batch lookup (GET).
+ */
+export interface PublicBatchLookupQueryRequest {
+    tagIds: string;
+    embed?: string;
+}
+/**
+ * Response from public batch lookup (GET).
+ */
+export interface PublicBatchLookupQueryResponse extends PublicBatchLookupResponse {
+}

package/dist/types/tags.js

@@ -0,0 +1,7 @@
+/**
+ * Tag Management Types
+ *
+ * Types for creating mappings between physical tags (NFC tags, QR codes, etc.)
+ * and digital proofs.
+ */
+export {};