@proveanything/smartlinks 1.7.9 → 1.8.0

package/dist/types/analytics.d.ts

@@ -0,0 +1,307 @@
+/**
+ * Collection analytics types.
+ *
+ * Separate from the `interactions` namespace. These types cover generic web
+ * analytics, click tracking, and tag scan analytics for collection dashboards.
+ */
+export type AnalyticsSource = 'events' | 'tag';
+export type AnalyticsEventType = string;
+export type AnalyticsGranularity = 'hour' | 'day' | 'week' | 'month';
+export type AnalyticsMetric = 'count' | 'uniqueSessions' | 'uniqueVisitors';
+export type AnalyticsSortOrder = 'asc' | 'desc';
+export type AnalyticsDeviceType = 'mobile' | 'tablet' | 'desktop' | 'unknown';
+export type AnalyticsStorageMode = 'local' | 'session' | false;
+export interface AnalyticsLocation {
+    country?: string;
+    latitude?: number;
+    longitude?: number;
+    area?: number;
+    [key: string]: any;
+}
+export interface AnalyticsStandardMetadataFields {
+    visitorId?: string;
+    referrer?: string;
+    referrerHost?: string;
+    utmSource?: string;
+    utmMedium?: string;
+    utmCampaign?: string;
+    utmContent?: string;
+    utmTerm?: string;
+    entryType?: string;
+    group?: string;
+    tag?: string;
+    campaign?: string;
+    placement?: string;
+    linkGroup?: string;
+    linkPlacement?: string;
+    linkPosition?: string | number;
+    linkTitle?: string;
+    destinationDomain?: string;
+    pagePath?: string;
+    pageId?: string;
+    qrCodeId?: string;
+    scanMethod?: string;
+}
+export interface CollectionAnalyticsEvent extends AnalyticsStandardMetadataFields {
+    sessionId?: string;
+    eventType: AnalyticsEventType;
+    collectionId: string;
+    productId?: string;
+    proofId?: string;
+    batchId?: string;
+    variantId?: string;
+    appId?: string;
+    destinationAppId?: string;
+    linkId?: string;
+    deviceType?: string;
+    href?: string;
+    path?: string;
+    isExternal?: boolean;
+    location?: AnalyticsLocation;
+    metadata?: Record<string, any>;
+}
+export interface TagAnalyticsEvent extends AnalyticsStandardMetadataFields {
+    sessionId?: string;
+    eventType: AnalyticsEventType;
+    collectionId: string;
+    productId?: string;
+    proofId?: string;
+    batchId?: string;
+    variantId?: string;
+    codeId?: string;
+    claimId?: string;
+    deviceType?: string;
+    path?: string;
+    location?: AnalyticsLocation;
+    isAdmin?: boolean;
+    metadata?: Record<string, any>;
+}
+export interface AnalyticsTrackOptions {
+    preferBeacon?: boolean;
+}
+export interface AnalyticsBrowserConfig {
+    sessionStorageKey?: string;
+    sessionIdFactory?: () => string;
+    visitorId?: string;
+    visitorStorage?: AnalyticsStorageMode;
+    visitorStorageKey?: string;
+    visitorIdFactory?: () => string;
+    autoCaptureCampaignParams?: boolean;
+    campaignParamMap?: Partial<Record<keyof AnalyticsStandardMetadataFields, string | string[]>>;
+    defaultCollectionEvent?: Partial<CollectionAnalyticsEvent>;
+    defaultTagEvent?: Partial<TagAnalyticsEvent>;
+    getCollectionDefaults?: () => Partial<CollectionAnalyticsEvent> | undefined;
+    getTagDefaults?: () => Partial<TagAnalyticsEvent> | undefined;
+    getLocation?: () => AnalyticsLocation | null | undefined;
+}
+export interface AnalyticsGeolocationCaptureOptions extends PositionOptions {
+    includeCoordinates?: boolean;
+    includeAccuracyArea?: boolean;
+}
+export interface AnalyticsLinkClickInput extends Partial<CollectionAnalyticsEvent> {
+    href: string;
+    linkId?: string;
+    destinationAppId?: string;
+    path?: string;
+    isExternal?: boolean;
+    linkTitle?: string;
+}
+export interface AnalyticsVisitorIdOptions {
+    persist?: boolean;
+    storage?: AnalyticsStorageMode;
+    storageKey?: string;
+}
+export interface AnalyticsPageViewBindingOptions {
+    trackInitialPageView?: boolean;
+    includeHashChanges?: boolean;
+    event?: Partial<CollectionAnalyticsEvent>;
+    trackOptions?: AnalyticsTrackOptions;
+    getEvent?: (path: string) => Partial<CollectionAnalyticsEvent> | null | undefined;
+}
+export interface AnalyticsLinkBindingOptions {
+    root?: Document | HTMLElement;
+    selector?: string;
+    trackInternal?: boolean;
+    event?: Partial<CollectionAnalyticsEvent>;
+    trackOptions?: AnalyticsTrackOptions;
+    getEvent?: (anchor: HTMLAnchorElement, event: MouseEvent) => Partial<CollectionAnalyticsEvent> | null | undefined;
+}
+export interface AnalyticsClassicReportRequest extends AnalyticsFilterRequest {
+    metric?: AnalyticsMetric;
+    limit?: number;
+}
+export interface AnalyticsTrackResult {
+    queued: boolean;
+    transport: 'beacon' | 'fetch' | 'unavailable';
+}
+export interface AnalyticsFilterRequest {
+    source?: AnalyticsSource;
+    from?: string;
+    to?: string;
+    eventType?: string;
+    eventTypes?: string[];
+    productId?: string;
+    productIds?: string[];
+    proofId?: string;
+    proofIds?: string[];
+    batchId?: string;
+    batchIds?: string[];
+    variantId?: string;
+    variantIds?: string[];
+    sessionId?: string;
+    sessionIds?: string[];
+    country?: string;
+    countries?: string[];
+    metadata?: Record<string, any>;
+    appId?: string;
+    appIds?: string[];
+    destinationAppId?: string;
+    destinationAppIds?: string[];
+    linkId?: string;
+    linkIds?: string[];
+    href?: string;
+    path?: string;
+    hrefContains?: string;
+    pathContains?: string;
+    isExternal?: boolean;
+    codeId?: string;
+    codeIds?: string[];
+    claimId?: string;
+    claimIds?: string[];
+    isAdmin?: boolean;
+    hasLocation?: boolean;
+}
+export interface AnalyticsSummaryRequest extends AnalyticsFilterRequest {
+    source: AnalyticsSource;
+}
+export interface AnalyticsSummaryData {
+    totalEvents?: number;
+    uniqueSessions?: number;
+    uniqueVisitors?: number;
+    uniqueCountries?: number;
+    uniqueLinks?: number;
+    externalEvents?: number;
+    internalEvents?: number;
+    firstEventAt?: string | null;
+    lastEventAt?: string | null;
+    uniqueCodes?: number;
+    uniqueClaims?: number;
+    adminEvents?: number;
+    customerEvents?: number;
+    locationEvents?: number;
+    [key: string]: any;
+}
+export interface AnalyticsSummaryResponse {
+    source: AnalyticsSource;
+    summary: AnalyticsSummaryData;
+}
+export interface AnalyticsTimeseriesRequest extends AnalyticsFilterRequest {
+    source: AnalyticsSource;
+    granularity: AnalyticsGranularity;
+    metric: AnalyticsMetric;
+}
+export interface AnalyticsTimeseriesRow {
+    period: string;
+    count: number;
+    uniqueSessions?: number;
+    uniqueVisitors?: number;
+    value: number;
+    [key: string]: any;
+}
+export interface AnalyticsTimeseriesResponse {
+    source: AnalyticsSource;
+    granularity: AnalyticsGranularity;
+    metric: AnalyticsMetric;
+    rows: AnalyticsTimeseriesRow[];
+}
+export type EventAnalyticsDimension = 'eventType' | 'country' | 'linkId' | 'href' | 'path' | 'appId' | 'destinationAppId' | 'deviceType' | 'isExternal' | 'productId' | 'proofId' | 'batchId' | 'variantId' | 'sessionId' | 'metadata';
+export type TagAnalyticsDimension = 'eventType' | 'country' | 'codeId' | 'claimId' | 'proofId' | 'productId' | 'batchId' | 'variantId' | 'deviceType' | 'sessionId' | 'isAdmin' | 'location' | 'metadata';
+export interface AnalyticsBreakdownRequest extends AnalyticsFilterRequest {
+    source: AnalyticsSource;
+    dimension: EventAnalyticsDimension | TagAnalyticsDimension;
+    metric?: AnalyticsMetric;
+    metadataKey?: string;
+    limit?: number;
+}
+export interface AnalyticsBreakdownRow {
+    dimensionValue: string | number | boolean | null;
+    count: number;
+    uniqueSessions?: number;
+    uniqueVisitors?: number;
+    value: number;
+    [key: string]: any;
+}
+export interface AnalyticsBreakdownResponse {
+    source: AnalyticsSource;
+    dimension: string;
+    metric: AnalyticsMetric;
+    rows: AnalyticsBreakdownRow[];
+}
+export interface AnalyticsEventsRequest extends AnalyticsFilterRequest {
+    source: AnalyticsSource;
+    limit?: number;
+    offset?: number;
+    sort?: AnalyticsSortOrder;
+}
+export interface AnalyticsEventsResponse {
+    source: AnalyticsSource;
+    limit: number;
+    offset: number;
+    sort: 'ASC' | 'DESC';
+    count: number;
+    rows: Array<Record<string, any>>;
+}
+export interface LegacyAnalyticsRequest {
+    collection?: string;
+    collectionId?: string;
+    productId?: string;
+    appId?: string;
+    startDate?: string;
+    endDate?: string;
+    location?: string;
+    tagId?: string;
+    qrCodeUrl?: string;
+    [key: string]: any;
+}
+export interface AnalyticsDashboardMetrics {
+    [key: string]: string | number | null;
+}
+export interface AnalyticsDashboardCharts {
+    [key: string]: any[];
+}
+export interface AnalyticsDashboardResponse {
+    metrics: AnalyticsDashboardMetrics;
+    charts: AnalyticsDashboardCharts;
+    locationData: any[];
+}
+export interface AnalyticsProductsRow {
+    productId: string;
+    totalEvents: number;
+}
+export interface AnalyticsProductsResponse {
+    products: string[];
+    rows: AnalyticsProductsRow[];
+}
+export interface AnalyticsQrCodeRow {
+    href: string;
+    visits: number;
+    displayName: string;
+    code: string;
+}
+export type AnalyticsQrCodesResponse = AnalyticsQrCodeRow[];
+export interface AnalyticsTagRow {
+    tagId: string;
+    claimId: string;
+    codeId: string;
+    displayName: string;
+    scans: number;
+    activeDays: number;
+}
+export interface AnalyticsTagsResponse {
+    tags: AnalyticsTagRow[];
+}
+export interface AnalyticsWeeklyRequest extends LegacyAnalyticsRequest {
+    group?: 'count' | 'unique';
+}
+export interface AnalyticsCountryRequest extends LegacyAnalyticsRequest {
+}

package/dist/types/analytics.js

@@ -1,3 +1,9 @@
-"use strict";
 // Deprecated: types moved to ./actions.ts and ./broadcasts.ts
 // This file is intentionally left empty to avoid duplicate exports.
+/**
+ * Collection analytics types.
+ *
+ * Separate from the `interactions` namespace. These types cover generic web
+ * analytics, click tracking, and tag scan analytics for collection dashboards.
+ */
+export {};

package/dist/types/auth.d.ts

@@ -14,3 +14,70 @@ export interface UserAccountRegistrationRequest {
     /** Desired token type returned */
     tokenType?: 'bearer' | 'firebase';
 }
+export interface AuthLocation {
+    latitude?: number;
+    longitude?: number;
+    area?: number;
+    country?: string;
+    [key: string]: any;
+}
+export interface AuthLocationCacheOptions {
+    cache?: 'session' | false;
+    ttlMs?: number;
+    storageKey?: string;
+    forceRefresh?: boolean;
+}
+export interface AccountFirebaseInfo {
+    identities?: Record<string, string[]>;
+    sign_in_provider?: string;
+    [key: string]: any;
+}
+export interface AccountClientInfo {
+    createdAt?: string;
+    createdVia?: string;
+    [key: string]: any;
+}
+export interface AccountFeatureFlags {
+    actionLogger?: boolean;
+    apiKeys?: boolean;
+    analytics?: boolean;
+    webhooks?: boolean;
+    creating?: boolean;
+    helpDocs?: boolean;
+    certificateTemplates?: boolean;
+    contentLibrary?: boolean;
+    devScanner?: boolean;
+    appScanner?: boolean;
+    [key: string]: boolean | undefined;
+}
+export interface AccountInfoResponse {
+    id: string;
+    uid: string;
+    userId: string;
+    user_id?: string;
+    sub: string;
+    name: string;
+    email: string;
+    email_verified: boolean;
+    picture?: string | null;
+    iss: string;
+    aud?: string;
+    auth_time: number;
+    iat: number;
+    exp?: number;
+    firebase?: AccountFirebaseInfo;
+    accessType?: string;
+    clientType?: string;
+    analyticsCode?: string;
+    analyticsId?: string;
+    baseCollectionId?: string;
+    collectionGroup?: string;
+    contactId?: string;
+    features: AccountFeatureFlags;
+    adminCollections?: string[];
+    clients?: Record<string, AccountClientInfo>;
+    sites?: Record<string, boolean>;
+    whitelabel?: Record<string, any>;
+    location?: AuthLocation | null;
+    [key: string]: any;
+}

package/dist/types/index.d.ts

@@ -19,6 +19,7 @@ export * from "./journeysAnalytics";
 export * from "./qr";
 export * from "./template";
 export * from "./interaction";
+export * from "./analytics";
 export * from "./location";
 export * from "./jobs";
 export * from "./realtime";

package/dist/types/index.js

@@ -21,6 +21,7 @@ export * from "./journeysAnalytics";
 export * from "./qr";
 export * from "./template";
 export * from "./interaction";
+export * from "./analytics";
 export * from "./location";
 export * from "./jobs";
 export * from "./realtime";

package/dist/types/order.d.ts

@@ -175,38 +175,35 @@ export interface GetOrderItemsResponse {
     limit: number;
     offset: number;
 }
-/**
- * Item-level filters for advanced order querying.
- * Batch and variant identifiers are only meaningful within a product.
- */
-export interface QueryOrderItemFilter {
-    productId: string;
-    batchId?: string;
-    variantId?: string;
-}
-/**
- * Order-level and item-level filters for advanced order querying.
- */
-export interface QueryOrdersFilter {
-    status?: string;
-    orderRef?: string;
-    customerId?: string;
-    createdAfter?: string;
-    createdBefore?: string;
-    updatedAfter?: string;
-    updatedBefore?: string;
-    minItemCount?: number;
-    maxItemCount?: number;
-    metadata?: Record<string, any>;
-    item?: QueryOrderItemFilter;
-    sortBy?: string;
-    sortOrder?: 'asc' | 'desc';
-}
 /**
  * Request for advanced order querying.
  */
 export interface QueryOrdersRequest {
-    query?: QueryOrdersFilter;
+    query?: {
+        status?: string;
+        orderRef?: string;
+        customerId?: string;
+        createdAfter?: string;
+        createdBefore?: string;
+        updatedAfter?: string;
+        updatedBefore?: string;
+        minItemCount?: number;
+        maxItemCount?: number;
+        productId?: string;
+        batchId?: string;
+        variantId?: string;
+        itemType?: 'tag' | 'proof' | 'serial';
+        itemId?: string;
+        itemCollectionId?: string;
+        itemMetadata?: Record<string, any>;
+        items?: Array<{
+            itemType: 'tag' | 'proof' | 'serial';
+            itemId: string;
+        }>;
+        metadata?: Record<string, any>;
+        sortBy?: string;
+        sortOrder?: 'asc' | 'desc';
+    };
     limit?: number;
     offset?: number;
     includeItems?: boolean;