@proveanything/smartlinks 1.8.11 → 1.9.0

package/dist/types/facets.d.ts

@@ -0,0 +1,126 @@
+import type { JsonValue, ProductQueryRequest } from "./product";
+export interface FacetDefinition {
+    id?: string;
+    orgId?: string;
+    collectionId?: string | null;
+    key: string;
+    name: string;
+    description?: string | null;
+    cardinality?: "single" | "multi";
+    kind?: "system" | "custom";
+    hierarchical?: boolean;
+    reserved?: boolean;
+    enabled?: boolean;
+    sortOrder?: number | null;
+    config?: Record<string, JsonValue>;
+    createdAt?: string;
+    updatedAt?: string;
+    deletedAt?: string | null;
+    values?: FacetValue[];
+}
+export interface FacetValue {
+    id?: string;
+    orgId?: string;
+    collectionId?: string | null;
+    facetDefinitionId?: string;
+    facetKey: string;
+    key: string;
+    slug?: string | null;
+    name: string;
+    shortName?: string | null;
+    description?: string | null;
+    color?: string | null;
+    icon?: string | null;
+    image?: Record<string, JsonValue> | null;
+    metadata?: Record<string, JsonValue>;
+    sortOrder?: number | null;
+    parentValueId?: string | null;
+    parentValueKey?: string | null;
+    enabled?: boolean;
+    createdAt?: string;
+    updatedAt?: string;
+    deletedAt?: string | null;
+    count?: number;
+}
+export interface FacetDefinitionWriteInput {
+    key?: string;
+    name: string;
+    description?: string | null;
+    cardinality?: "single" | "multi";
+    kind?: "system" | "custom";
+    hierarchical?: boolean;
+    reserved?: boolean;
+    enabled?: boolean;
+    sortOrder?: number | null;
+    config?: Record<string, JsonValue>;
+}
+export interface FacetValueWriteInput {
+    key?: string;
+    slug?: string | null;
+    name: string;
+    shortName?: string | null;
+    description?: string | null;
+    color?: string | null;
+    icon?: string | null;
+    image?: Record<string, JsonValue> | null;
+    metadata?: Record<string, JsonValue>;
+    sortOrder?: number | null;
+    parentValueKey?: string | null;
+    enabled?: boolean;
+}
+export interface FacetListResponse {
+    items: FacetDefinition[];
+}
+export interface FacetValueListResponse {
+    facet: FacetDefinition;
+    items: FacetValue[];
+}
+export interface FacetValueResponse {
+    facet: FacetDefinition;
+    item: FacetValue;
+}
+export interface FacetQueryRequest {
+    facetKeys?: string[];
+    includeEmpty?: boolean;
+    includeDeleted?: boolean;
+    query?: ProductQueryRequest["query"] & {
+        facetEquals?: Record<string, JsonValue | JsonValue[]>;
+    };
+}
+export interface FacetBucket {
+    facetKey: string;
+    valueKey: string;
+    name?: string;
+    count: number;
+}
+export interface FacetQueryResponse {
+    items: Array<{
+        facet: FacetDefinition;
+        values: FacetValue[];
+    }>;
+    buckets: FacetBucket[];
+    meta?: {
+        source?: "postgres";
+        matchedProducts?: number;
+    };
+}
+export interface FacetListParams {
+    includeValues?: boolean;
+    includeDeleted?: boolean;
+    kind?: "system" | "custom";
+    reserved?: boolean;
+}
+export interface PublicFacetListParams {
+    includeValues?: boolean;
+}
+export interface FacetGetParams {
+    includeValues?: boolean;
+    includeDeleted?: boolean;
+}
+export interface FacetValueListParams {
+    includeDeleted?: boolean;
+}
+export interface FacetValueGetParams {
+    includeDeleted?: boolean;
+}
+export type FacetValueDefinition = FacetValue;

package/dist/types/facets.js

@@ -0,0 +1 @@
+export {};

package/dist/types/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./collection";
+export * from "./facets";
 export * from "./product";
 export * from "./proof";
 export * from "./appConfiguration";
@@ -30,3 +31,4 @@ export * from "./iframeResponder";
 export * from "./ai";
 export * from "./appManifest";
 export * from "./appObjects";
+export * from "./loyalty";

package/dist/types/index.js

@@ -1,6 +1,7 @@
 // src/types/index.ts
 // Re-export all type modules so consumers can import types directly
 export * from "./collection";
+export * from "./facets";
 export * from "./product";
 export * from "./proof";
 export * from "./appConfiguration";
@@ -32,3 +33,4 @@ export * from "./iframeResponder";
 export * from "./ai";
 export * from "./appManifest";
 export * from "./appObjects";
+export * from "./loyalty";

package/dist/types/loyalty.d.ts

@@ -0,0 +1,145 @@
+export type DataBlock = Record<string, unknown>;
+export interface LoyaltyScheme {
+    id: string;
+    orgId: string;
+    collectionId: string;
+    name: string;
+    /** Open string — e.g. "points" | "stamps" */
+    type: string;
+    active: boolean;
+    createdAt: string;
+    updatedAt: string;
+    deletedAt: string | null;
+    data: DataBlock;
+    /** Admin responses only */
+    owner?: DataBlock;
+    /** Admin responses only */
+    admin?: DataBlock;
+}
+export interface LoyaltyMember {
+    id: string;
+    orgId: string;
+    collectionId: string;
+    schemeId: string;
+    contactId: string;
+    userId: string | null;
+    /** Current redeemable balance */
+    balance: number;
+    /** Total ever earned — never decremented, used for tier calculations */
+    lifetimePoints: number;
+    createdAt: string;
+    updatedAt: string;
+    data: DataBlock;
+    /** Admin responses only */
+    owner?: DataBlock;
+    /** Admin responses only */
+    admin?: DataBlock;
+}
+export interface LoyaltyTransaction {
+    id: string;
+    orgId: string;
+    collectionId: string;
+    schemeId: string;
+    memberId: string;
+    /** Signed: positive = earn, negative = spend/deduct */
+    points: number;
+    reason: string | null;
+    /** Caller-supplied key — prevents double-credit on retries */
+    idempotencyKey: string | null;
+    metadata: DataBlock;
+    createdAt: string;
+}
+export interface LoyaltyEarningRule {
+    id: string;
+    orgId: string;
+    collectionId: string;
+    schemeId: string;
+    /** ID of the Interaction definition that triggers this rule */
+    interactionId: string;
+    /** Points awarded when this rule matches — always server-controlled */
+    points: number;
+    /**
+     * Key-value conditions matched against the interaction event before awarding.
+     * Supports top-level event fields (outcome, scope, status, eventType, etc.)
+     * and dot-path into metadata (e.g. `"metadata.tier": "gold"`).
+     * Empty object = always fires for any event on this interaction.
+     */
+    conditions: Record<string, string>;
+    /** Maximum lifetime triggers per contact. null = unlimited */
+    maxPerContact: number | null;
+    /** Minimum hours between triggers for the same contact. null = no cooldown */
+    cooldownHours: number | null;
+    active: boolean;
+    createdAt: string;
+    updatedAt: string;
+    data: DataBlock;
+}
+/**
+ * Returned by loyalty.getMe() — each active scheme with the caller's
+ * membership embedded. member is null if the caller has never earned
+ * points in that scheme.
+ */
+export interface LoyaltySchemeWithMembership extends Omit<LoyaltyScheme, 'owner' | 'admin'> {
+    member: Omit<LoyaltyMember, 'owner' | 'admin'> | null;
+}
+/** Returned by loyalty.admin.recordTransaction() */
+export interface LoyaltyTransactionResult {
+    member: LoyaltyMember;
+    transaction: LoyaltyTransaction;
+}
+export interface LoyaltyPaginationParams {
+    limit?: number;
+    offset?: number;
+}
+export interface LoyaltyPaginatedResult<T> {
+    items: T[];
+    limit: number;
+    offset: number;
+}
+export interface CreateLoyaltySchemeBody {
+    name: string;
+    type: string;
+    active?: boolean;
+    data?: DataBlock;
+    owner?: DataBlock;
+    admin?: DataBlock;
+}
+export interface UpdateLoyaltySchemeBody {
+    name?: string;
+    type?: string;
+    active?: boolean;
+    data?: DataBlock;
+    owner?: DataBlock;
+    admin?: DataBlock;
+}
+export interface CreateLoyaltyEarningRuleBody {
+    interactionId: string;
+    points: number;
+    conditions?: Record<string, string>;
+    maxPerContact?: number | null;
+    cooldownHours?: number | null;
+    active?: boolean;
+    data?: DataBlock;
+}
+export interface UpdateLoyaltyEarningRuleBody {
+    points?: number;
+    conditions?: Record<string, string>;
+    maxPerContact?: number | null;
+    cooldownHours?: number | null;
+    active?: boolean;
+    data?: DataBlock;
+}
+export interface RecordLoyaltyTransactionBody {
+    /** Non-zero signed integer. Positive = earn, negative = spend/deduct */
+    points: number;
+    reason?: string;
+    /**
+     * Optional caller-supplied key scoped to the scheme.
+     * If a transaction with this key already exists the server returns 409.
+     * Use to safely retry without double-crediting points.
+     */
+    idempotencyKey?: string;
+    metadata?: DataBlock;
+    /** Links the auto-created member to a Firebase UID if not yet associated */
+    userId?: string;
+}

package/dist/types/loyalty.js

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

package/dist/types/product.d.ts

@@ -1,56 +1,169 @@
-/**
- * Product domain model.
- */
-export interface Product {
-    /** Unique identifier for the product */
-    id: string;
-    /** Name of the product */
-    name: string;
-    /** Unique identifier for the product's collection */
+export type JsonPrimitive = string | number | boolean | null;
+export type JsonValue = JsonPrimitive | JsonValue[] | {
+    [key: string]: JsonValue;
+};
+export type ISODateString = string;
+export interface ProductKey {
     collectionId: string;
-    /** Detailed description of the product */
-    description: string;
-    /** A product GTIN (Global Trade Item Number) */
-    gtin?: string;
-    /** An optional product type from the standard smartlinks types */
+    id: string;
+}
+export interface ProductImageThumbnails {
+    x100?: string;
+    x200?: string;
+    x512?: string;
+}
+export interface ProductImage {
+    id?: string;
+    collectionId?: string;
+    productId?: string;
+    site?: string;
+    name?: string;
+    cleanName?: string;
+    assetType?: string;
     type?: string;
-    /**
-     * Hero image asset object.
-     * When creating/updating, you can pass either:
-     * - A full asset object with url and thumbnails
-     * - A string URL - the system will automatically fetch and store the image
-     */
-    heroImage: {
-        /** URL to the asset */
-        url: string;
-        /** Thumbnail URLs in different sizes */
-        thumbnails: {
-            x100: string;
-            x200: string;
-            x512: string;
-        };
+    url?: string;
+    thumbnails?: ProductImageThumbnails;
+    contentType?: string;
+    size?: string | number;
+    hash?: string;
+    createdAt?: ISODateString | null;
+    updatedAt?: ISODateString | null;
+    deletedAt?: ISODateString | null;
+}
+export interface ProductImageUrlInput {
+    url: string;
+}
+export interface AdditionalGtin {
+    gtin: string;
+    owner?: boolean | null;
+}
+export interface ProductFacetValue {
+    id?: string;
+    key: string;
+    slug?: string;
+    name: string;
+    shortName?: string;
+    description?: string;
+    color?: string;
+    icon?: string;
+}
+export interface ProductFacetMap {
+    [facetKey: string]: ProductFacetValue[];
+}
+export interface ProductQueryRequest {
+    query?: {
+        search?: string;
+        status?: string[];
+        category?: string[];
+        type?: string[];
+        schemaType?: string[];
+        tags?: string[];
+        productIds?: string[];
+        sku?: string;
+        gtin?: string;
+        updatedAfter?: ISODateString;
+        updatedBefore?: ISODateString;
+        createdAfter?: ISODateString;
+        createdBefore?: ISODateString;
+        facetEquals?: Record<string, JsonValue>;
     };
-    /** Flexible map of tags with true/false values */
-    tags: {
-        [tagName: string]: boolean;
+    sort?: Array<{
+        field: string;
+        direction: 'asc' | 'desc';
+    }>;
+    page?: {
+        limit?: number;
+        offset?: number;
+        cursor?: string | null;
     };
-    /** Flexible key/value data map */
-    data: {
-        [key: string]: any;
+    includeDeleted?: boolean;
+}
+export interface ProductAdminData extends Record<string, JsonValue | undefined> {
+    allowAutoGenerateClaims?: boolean;
+    lastSerialId?: number;
+}
+export interface Product extends ProductKey {
+    orgId?: string | null;
+    name: string;
+    description?: string | null;
+    gtin?: string | null;
+    ownGtin?: boolean | null;
+    additionalGtins?: AdditionalGtin[];
+    sku?: string | null;
+    schemaType?: string | null;
+    type?: string | null;
+    category?: string | null;
+    label?: string | null;
+    status?: string | null;
+    sortOrder?: number | null;
+    heroImage?: ProductImage | null;
+    facets?: ProductFacetMap;
+    tags?: Record<string, boolean>;
+    data?: Record<string, JsonValue>;
+    admin?: ProductAdminData;
+    extra?: Record<string, JsonValue>;
+    validCollections?: string[];
+    group?: boolean | null;
+    createdAt?: ISODateString | null;
+    updatedAt?: ISODateString | null;
+    deletedAt?: ISODateString | null;
+}
+export interface PublicProduct extends Omit<Product, 'admin'> {
+    admin?: never;
+}
+export interface ProductWriteInput {
+    id?: string;
+    name: string;
+    description?: string | null;
+    gtin?: string | null;
+    ownGtin?: boolean | null;
+    additionalGtins?: AdditionalGtin[];
+    sku?: string | null;
+    schemaType?: string | null;
+    type?: string | null;
+    category?: string | null;
+    label?: string | null;
+    status?: string | null;
+    sortOrder?: number | null;
+    heroImage?: ProductImage | ProductImageUrlInput | string | null;
+    facets?: ProductFacetMap;
+    tags?: Record<string, boolean>;
+    data?: Record<string, JsonValue>;
+    admin?: ProductAdminData;
+    extra?: Record<string, JsonValue>;
+    validCollections?: string[];
+}
+export interface ProductQueryResponse {
+    items: Product[];
+    page?: {
+        limit?: number;
+        offset?: number;
+        returned?: number;
+        total?: number;
+        hasMore?: boolean;
+        nextCursor?: string | null;
     };
-    /** Admin-only configuration */
-    admin?: {
-        /** Allow users to claim this product without providing a proof ID (overrides collection setting) */
-        allowAutoGenerateClaims?: boolean;
-        /** Last generated serial ID for auto-claim functionality */
-        lastSerialId?: number;
-        [key: string]: any;
+    meta?: {
+        apiVersion?: 'v1';
+        mode?: 'canonical-products' | 'legacy-product-compatibility';
+        source?: 'postgres' | 'firestore' | 'compatibility-layer';
+        queryMode?: 'canonical' | 'compatibility';
+        unsupportedFilters?: string[];
+        supportedSortFields?: string[];
     };
 }
+export interface ProductClaimLookupInput extends ProductKey {
+    claimId: string;
+}
+export interface ProductClaimCreateInput extends ProductKey {
+    claimId: string;
+    email?: string;
+    name?: string;
+    emailConfirmation?: boolean;
+    data?: Record<string, JsonValue>;
+    options?: Record<string, JsonValue>;
+}
+export type ProductClaimCreateRequestBody = Omit<ProductClaimCreateInput, 'collectionId' | 'id'>;
 export type ProductResponse = Product;
-export type ProductCreateRequest = Omit<Product, 'id' | 'collectionId'> & {
-    heroImage?: Product['heroImage'] | string;
-};
-export type ProductUpdateRequest = Partial<Omit<Product, 'id' | 'collectionId'>> & {
-    heroImage?: Product['heroImage'] | string;
-};
+export type ProductCreateRequest = ProductWriteInput;
+export type ProductUpdateRequest = Partial<Omit<ProductWriteInput, 'id'>>;

package/dist/utils/paths.js

@@ -60,6 +60,7 @@
  * ```
  */
 export function buildPortalPath(params) {
+    var _a, _b;
     const { collection, product, productId, batch, batchId, variant, proof, queryParams = {}, pathOnly = false } = params;
     // Extract values from collection
     const shortId = collection.shortId;
@@ -70,9 +71,9 @@ export function buildPortalPath(params) {
     let extractedProductId;
     if (product) {
         extractedProductId = product.id;
-        gtin = product.gtin;
+        gtin = (_a = product.gtin) !== null && _a !== void 0 ? _a : undefined;
         // ownGtin is a critical product setting - only read from product, never override
-        ownGtin = 'ownGtin' in product ? product.ownGtin : undefined;
+        ownGtin = 'ownGtin' in product ? (_b = product.ownGtin) !== null && _b !== void 0 ? _b : undefined : undefined;
     }
     else if (productId) {
         extractedProductId = productId;