@proveanything/smartlinks 1.15.23 → 1.16.0

package/dist/openapi.yaml

@@ -41,6 +41,7 @@ tags:
   - name: journeys
   - name: journeysAnalytics
   - name: location
+  - name: lots
   - name: loyalty
   - name: nfc
   - name: order
@@ -4825,6 +4826,208 @@ paths:
           description: Unauthorized
         404:
           description: Not found
+  /admin/collection/{collectionId}/lots/by-number/{lotNumber}:
+    get:
+      tags:
+        - lots
+      summary: Look up a lot by its number (case-insensitive) — used by scan/resolver flows.
+      operationId: lots_getByNumber
+      security:
+        - bearerAuth: []
+      parameters:
+        - name: collectionId
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: lotNumber
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Lot"
+        400:
+          description: Bad request
+        401:
+          description: Unauthorized
+        404:
+          description: Not found
+  /admin/collection/{collectionId}/lots/{lotId}:
+    get:
+      tags:
+        - lots
+      summary: Get the full lot record.
+      operationId: lots_get
+      security:
+        - bearerAuth: []
+      parameters:
+        - name: collectionId
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: lotId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Lot"
+        400:
+          description: Bad request
+        401:
+          description: Unauthorized
+        404:
+          description: Not found
+    put:
+      tags:
+        - lots
+      summary: Update a lot.
+      operationId: lots_update
+      security:
+        - bearerAuth: []
+      parameters:
+        - name: collectionId
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: lotId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Lot"
+        400:
+          description: Bad request
+        401:
+          description: Unauthorized
+        404:
+          description: Not found
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/LotUpdateInput"
+  /admin/collection/{collectionId}/lots/{lotId}/products{opts}:
+    get:
+      tags:
+        - lots
+      summary: Paginated member product summaries.
+      operationId: lots_listProducts
+      security:
+        - bearerAuth: []
+      parameters:
+        - name: collectionId
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: lotId
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: opts
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ListLotProductsResponse"
+        400:
+          description: Bad request
+        401:
+          description: Unauthorized
+        404:
+          description: Not found
+  /admin/collection/{collectionId}/lots/{lotId}/resolve:
+    post:
+      tags:
+        - lots
+      summary: Re-resolve members from the current selector; returns the lot + a member diff.
+      operationId: lots_resolve
+      security:
+        - bearerAuth: []
+      parameters:
+        - name: collectionId
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: lotId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ResolveLotResponse"
+        400:
+          description: Bad request
+        401:
+          description: Unauthorized
+        404:
+          description: Not found
+  /admin/collection/{collectionId}/lots{params}:
+    get:
+      tags:
+        - lots
+      summary: "List lots (summary rows; `payload`/`productIds` omitted)."
+      operationId: lots_list
+      security:
+        - bearerAuth: []
+      parameters:
+        - name: collectionId
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: params
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ListLotsResponse"
+        400:
+          description: Bad request
+        401:
+          description: Unauthorized
+        404:
+          description: Not found
   /admin/collection/{collectionId}/loyaltyScheme:
     get:
       tags:
@@ -11549,6 +11752,135 @@ paths:
           description: Unauthorized
         404:
           description: Not found
+  /public/collection/{collectionId}/lots/by-number/{lotNumber}:
+    get:
+      tags:
+        - lots
+      summary: lots.publicGetByNumber
+      operationId: lots_publicGetByNumber
+      security: []
+      parameters:
+        - name: collectionId
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: lotNumber
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Lot"
+        400:
+          description: Bad request
+        401:
+          description: Unauthorized
+        404:
+          description: Not found
+  /public/collection/{collectionId}/lots/{lotId}:
+    get:
+      tags:
+        - lots
+      summary: lots.publicGet
+      operationId: lots_publicGet
+      security: []
+      parameters:
+        - name: collectionId
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: lotId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Lot"
+        400:
+          description: Bad request
+        401:
+          description: Unauthorized
+        404:
+          description: Not found
+  /public/collection/{collectionId}/lots/{lotId}/products{opts}:
+    get:
+      tags:
+        - lots
+      summary: lots.publicListProducts
+      operationId: lots_publicListProducts
+      security: []
+      parameters:
+        - name: collectionId
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: lotId
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: opts
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ListLotProductsResponse"
+        400:
+          description: Bad request
+        401:
+          description: Unauthorized
+        404:
+          description: Not found
+  /public/collection/{collectionId}/lots{params}:
+    get:
+      tags:
+        - lots
+      summary: lots.publicList
+      operationId: lots_publicList
+      security: []
+      parameters:
+        - name: collectionId
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: params
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ListLotsResponse"
+        400:
+          description: Bad request
+        401:
+          description: Unauthorized
+        404:
+          description: Not found
   /public/collection/{collectionId}/loyaltyScheme:
     get:
       tags:
@@ -23355,6 +23687,174 @@ components:
       required:
         - items
         - count
+    LotPayload:
+      type: object
+      properties:
+        manufacturedAt:
+          type: string
+        expiresAt:
+          type: string
+        location:
+          type: string
+        custom:
+          type: object
+          additionalProperties: true
+    Lot:
+      type: object
+      properties:
+        id:
+          type: string
+        collectionId:
+          type: string
+        lotNumber:
+          type: string
+        name:
+          type: string
+        description:
+          type: string
+        status:
+          $ref: "#/components/schemas/LotStatus"
+        selector:
+          $ref: "#/components/schemas/LotSelector"
+        payload:
+          $ref: "#/components/schemas/LotPayload"
+        destination:
+          type: object
+          additionalProperties: true
+        productCount:
+          type: number
+        productIds:
+          type: array
+          items:
+            type: string
+        resolvedAt:
+          type: string
+        createdBy:
+          type: string
+        updatedBy:
+          type: string
+        createdAt:
+          type: string
+        updatedAt:
+          type: string
+      required:
+        - id
+        - collectionId
+        - lotNumber
+        - status
+        - selector
+        - productCount
+        - createdAt
+        - updatedAt
+    LotCreateInput:
+      type: object
+      properties:
+        lotNumber:
+          type: string
+        name:
+          type: string
+        description:
+          type: string
+        selector:
+          $ref: "#/components/schemas/LotSelector"
+        payload:
+          $ref: "#/components/schemas/LotPayload"
+        destination:
+          type: object
+          additionalProperties: true
+        status:
+          $ref: "#/components/schemas/LotStatus"
+        id:
+          type: string
+      required:
+        - lotNumber
+    ListLotsParams:
+      type: object
+      properties:
+        status:
+          $ref: "#/components/schemas/LotStatus"
+        search:
+          type: string
+        productId:
+          type: string
+    ListLotsResponse:
+      type: object
+      properties:
+        lots:
+          type: array
+          items:
+            $ref: "#/components/schemas/Lot"
+      required:
+        - lots
+    LotMemberDiff:
+      type: object
+      properties:
+        added:
+          type: array
+          items:
+            type: object
+            additionalProperties: true
+      required:
+        - added
+    ResolveLotResponse:
+      type: object
+      properties:
+        lot:
+          type: object
+          additionalProperties: true
+      required:
+        - lot
+    LotProductSummary:
+      type: object
+      properties:
+        id:
+          type: object
+          additionalProperties: true
+      required:
+        - id
+    ListLotProductsResponse:
+      type: object
+      properties:
+        products:
+          type: array
+          items:
+            $ref: "#/components/schemas/LotProductSummary"
+        total:
+          type: number
+        page:
+          type: number
+        limit:
+          type: number
+      required:
+        - products
+        - total
+        - page
+        - limit
+    LotResolutionResult:
+      type: object
+      properties:
+        match:
+          type: string
+          enum:
+            - batch
+            - lot
+            - product
+            - none
+        productId:
+          type: string
+        batchId:
+          type: string
+        lotId:
+          type: string
+        ai10:
+          type: string
+        destination: {}
+      required:
+        - match
+        - productId
+        - batchId
+        - lotId
+        - ai10
     LoyaltyScheme:
       type: object
       properties:
@@ -25050,6 +25550,12 @@ components:
           type: string
         userId:
           type: string
+        batchId:
+          type: string
+        variantId:
+          type: string
+        lotId:
+          type: string
         claimable:
           type: boolean
         virtual:
@@ -25340,6 +25846,29 @@ components:
           type: string
       required:
         - interactionId
+    OwnershipAttributePredicate:
+      type: object
+      properties:
+        path:
+          type: string
+        operator:
+          $ref: "#/components/schemas/OwnershipAttributeOperator"
+        value:
+          type: object
+          additionalProperties: true
+      required:
+        - path
+        - operator
+    OwnershipFacetSelector:
+      type: object
+      properties:
+        key:
+          type: string
+        value:
+          type: string
+      required:
+        - key
+        - value
     SegmentRecord:
       type: object
       properties:
@@ -25445,6 +25974,25 @@ components:
         - limit
         - offset
         - total
+    CustomFieldOperator:
+      type: string
+      enum:
+        - equals
+        - exists
+        - gt
+        - gte
+        - lt
+        - lte
+        - before
+        - after
+        - within_days
+        - older_than_days
+        - "s JSON. Numeric ops (gt/gte/lt/lte) compare as a number. export type OwnershipAttributeOperator = "
+        - " | "
+        - " | "
+        - " | "
+        - " | "
+        - " | "
     Tag:
       type: object
       properties:

package/dist/types/lots.d.ts

@@ -0,0 +1,95 @@
+export type LotStatus = 'open' | 'closed' | 'recalled' | 'archived';
+/** How a lot's member products are resolved. */
+export type LotSelector = {
+    mode: 'facets';
+    rules: Array<{
+        key: string;
+        values: string[];
+    }>;
+} | {
+    mode: 'products';
+    productIds: string[];
+};
+/** Shared lot data (single source of truth — not copied to batches). */
+export interface LotPayload {
+    manufacturedAt?: string | null;
+    expiresAt?: string | null;
+    location?: string | null;
+    custom?: Record<string, any>;
+    [key: string]: any;
+}
+export interface Lot {
+    id: string;
+    collectionId: string;
+    /** Human / GS1 AI(10) identifier, ≤20 chars, unique per collection (case-insensitive). */
+    lotNumber: string;
+    name?: string | null;
+    description?: string | null;
+    status: LotStatus;
+    selector: LotSelector;
+    /** Omitted on list summaries. */
+    payload?: LotPayload;
+    /** Optional lot-level redirect/destination; wins over the product's destination on a lot hit. */
+    destination?: Record<string, any> | null;
+    productCount: number;
+    /** Materialised member product ids. Omitted on list summaries. */
+    productIds?: string[];
+    resolvedAt?: string | null;
+    createdBy?: string | null;
+    updatedBy?: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface LotCreateInput {
+    lotNumber: string;
+    name?: string;
+    description?: string;
+    selector?: LotSelector;
+    payload?: LotPayload;
+    destination?: Record<string, any> | null;
+    status?: LotStatus;
+    /** Optional client-supplied id; the server generates one otherwise. */
+    id?: string;
+}
+export type LotUpdateInput = Partial<LotCreateInput>;
+export interface ListLotsParams {
+    status?: LotStatus;
+    search?: string;
+    /** Reverse lookup — lots containing this product id. */
+    productId?: string;
+}
+export interface ListLotsResponse {
+    lots: Lot[];
+}
+/** Member changes returned by resolve/update-with-selector-change. */
+export interface LotMemberDiff {
+    added: string[];
+    removed: string[];
+}
+export interface ResolveLotResponse {
+    lot: Lot;
+    diff: LotMemberDiff;
+}
+export interface LotProductSummary {
+    id: string;
+    name?: string;
+    gtin?: string | null;
+}
+export interface ListLotProductsResponse {
+    products: LotProductSummary[];
+    total: number;
+    page: number;
+    limit: number;
+}
+/**
+ * Typed result of GS1 AI(10) resolution. The server decides batch-vs-lot based on
+ * the collection's flags (batch first — unique to one product — then lot).
+ */
+export interface LotResolutionResult {
+    match: 'batch' | 'lot' | 'product' | 'none';
+    productId: string;
+    batchId: string | null;
+    lotId: string | null;
+    ai10: string | null;
+    destination?: any;
+}

package/dist/types/lots.js

@@ -0,0 +1,7 @@
+// src/types/lots.ts
+//
+// A Lot is a collection-scoped production grouping that spans one or more products
+// (SKUs). Unlike a batch (a single production run of a single product), a lot is a
+// first-class entity with a selector (how members are matched), a materialised
+// product list, and a shared payload. Lots are never fanned out into batches.
+export {};

package/dist/types/proof.d.ts

@@ -28,6 +28,12 @@ export interface Proof {
     tokenId: string;
     /** Unique identifier for the user */
     userId: string;
+    /** Batch (single production run of this product) this item belongs to, if any. */
+    batchId?: string | null;
+    /** Variant (product definition) this item belongs to, if any. */
+    variantId?: string | null;
+    /** Lot (cross-product production grouping) this item belongs to, if any. Separate from `batchId`. */
+    lotId?: string | null;
     /** Is this proof available to be claimed */
     claimable?: boolean;
     /** Is this proof virtual */