@proveanything/smartlinks 1.7.9 → 1.8.0

package/dist/api/auth.d.ts

@@ -1,4 +1,5 @@
-import type { UserAccountRegistrationRequest } from "../types/auth";
+import type { UserAccountRegistrationRequest, AccountInfoResponse, AuthLocation, AuthLocationCacheOptions } from "../types/auth";
+export type { AccountInfoResponse, AuthLocation, AuthLocationCacheOptions } from "../types/auth";
 export type LoginResponse = {
     id: string;
     name: string;
@@ -13,40 +14,6 @@ export type VerifyTokenResponse = {
     email?: string;
     account?: Record<string, any>;
 };
-export type AccountInfoResponse = {
-    accessType: string;
-    analyticsCode: string;
-    analyticsId: string;
-    auth_time: number;
-    baseCollectionId: string;
-    clientType: string;
-    email: string;
-    email_verified: boolean;
-    features: {
-        actionLogger: boolean;
-        adminCollections: boolean;
-        adminApps: boolean;
-        apiKeys: boolean;
-        adminUsers: boolean;
-        [key: string]: boolean;
-    };
-    iat: number;
-    id: string;
-    iss: string;
-    location: string | null;
-    name: string;
-    picture: string;
-    sites: {
-        [siteName: string]: boolean;
-    };
-    sub: string;
-    uid: string;
-    userId: string;
-    contactId: string;
-    whitelabel: {
-        [key: string]: any;
-    };
-};
 export declare namespace auth {
     /**
      * Login with email and password.
@@ -89,10 +56,31 @@ export declare namespace auth {
     }): Promise<{
         bearerToken: string;
     }>;
+    /**
+     * Gets a best-effort coarse location for the current anonymous caller.
+     *
+     * This endpoint is typically IP-derived and is useful when the user is not
+     * logged in but you still want country/location context for content rules,
+     * analytics enrichment, or regional defaults.
+     *
+     * Returns fields such as `country`, `latitude`, `longitude`, and `area`
+     * when available.
+     *
+     * By default the result is cached in session storage for 30 minutes so apps
+     * can reuse coarse location context without repeatedly hitting the endpoint.
+     */
+    function getLocation(options?: AuthLocationCacheOptions): Promise<AuthLocation>;
+    /**
+     * Clears the cached anonymous auth location, if present.
+     */
+    function clearCachedLocation(storageKey?: string): void;
     /**
      * Gets current account information for the logged in user.
      * Returns user, owner, account, and location objects.
      *
+     * When the caller is authenticated, prefer `account.location` from this
+     * response. For anonymous callers, use `auth.getLocation()` instead.
+     *
      * Short-circuits immediately (no network request) when the SDK has no
      * bearer token or API key set — the server would return 401 anyway.
      * Throws a `SmartlinksApiError` with `statusCode 401` and

package/dist/api/auth.js

@@ -1,5 +1,69 @@
 import { post, request, setBearerToken, getApiHeaders, hasAuthCredentials, isProxyEnabled } from "../http";
 import { SmartlinksApiError } from "../types/error";
+const DEFAULT_AUTH_LOCATION_CACHE_KEY = 'smartlinks.auth.location';
+const DEFAULT_AUTH_LOCATION_TTL_MS = 30 * 60 * 1000;
+let inMemoryAuthLocationCache = null;
+function getSessionStorage() {
+    try {
+        if (typeof sessionStorage !== 'undefined')
+            return sessionStorage;
+    }
+    catch (_a) {
+    }
+    return undefined;
+}
+function readCachedLocation(storageKey) {
+    const now = Date.now();
+    if (inMemoryAuthLocationCache && inMemoryAuthLocationCache.expiresAt > now) {
+        return inMemoryAuthLocationCache.value;
+    }
+    const storage = getSessionStorage();
+    if (!storage)
+        return null;
+    try {
+        const raw = storage.getItem(storageKey);
+        if (!raw)
+            return null;
+        const cached = JSON.parse(raw);
+        if (!(cached === null || cached === void 0 ? void 0 : cached.value) || typeof cached.expiresAt !== 'number') {
+            storage.removeItem(storageKey);
+            return null;
+        }
+        if (cached.expiresAt <= now) {
+            storage.removeItem(storageKey);
+            return null;
+        }
+        inMemoryAuthLocationCache = cached;
+        return cached.value;
+    }
+    catch (_a) {
+        return null;
+    }
+}
+function writeCachedLocation(storageKey, value, ttlMs) {
+    const cached = {
+        value,
+        expiresAt: Date.now() + ttlMs,
+    };
+    inMemoryAuthLocationCache = cached;
+    const storage = getSessionStorage();
+    if (!storage)
+        return;
+    try {
+        storage.setItem(storageKey, JSON.stringify(cached));
+    }
+    catch (_a) {
+    }
+}
+function clearCachedLocationInternal(storageKey) {
+    inMemoryAuthLocationCache = null;
+    const storage = getSessionStorage();
+    try {
+        storage === null || storage === void 0 ? void 0 : storage.removeItem(storageKey);
+    }
+    catch (_a) {
+    }
+}
 /*
   user: Record<string, any>
   owner: Record<string, any>
@@ -82,10 +146,50 @@ export var auth;
         return post("/admin/auth/getUserToken", body);
     }
     auth.getUserToken = getUserToken;
+    /**
+     * Gets a best-effort coarse location for the current anonymous caller.
+     *
+     * This endpoint is typically IP-derived and is useful when the user is not
+     * logged in but you still want country/location context for content rules,
+     * analytics enrichment, or regional defaults.
+     *
+     * Returns fields such as `country`, `latitude`, `longitude`, and `area`
+     * when available.
+     *
+     * By default the result is cached in session storage for 30 minutes so apps
+     * can reuse coarse location context without repeatedly hitting the endpoint.
+     */
+    async function getLocation(options = {}) {
+        var _a, _b, _c;
+        const cache = (_a = options.cache) !== null && _a !== void 0 ? _a : 'session';
+        const ttlMs = (_b = options.ttlMs) !== null && _b !== void 0 ? _b : DEFAULT_AUTH_LOCATION_TTL_MS;
+        const storageKey = (_c = options.storageKey) !== null && _c !== void 0 ? _c : DEFAULT_AUTH_LOCATION_CACHE_KEY;
+        if (cache === 'session' && !options.forceRefresh) {
+            const cached = readCachedLocation(storageKey);
+            if (cached)
+                return cached;
+        }
+        const location = await request("/public/auth/location");
+        if (cache === 'session') {
+            writeCachedLocation(storageKey, location, ttlMs);
+        }
+        return location;
+    }
+    auth.getLocation = getLocation;
+    /**
+     * Clears the cached anonymous auth location, if present.
+     */
+    function clearCachedLocation(storageKey = DEFAULT_AUTH_LOCATION_CACHE_KEY) {
+        clearCachedLocationInternal(storageKey);
+    }
+    auth.clearCachedLocation = clearCachedLocation;
     /**
      * Gets current account information for the logged in user.
      * Returns user, owner, account, and location objects.
      *
+     * When the caller is authenticated, prefer `account.location` from this
+     * response. For anonymous callers, use `auth.getLocation()` instead.
+     *
      * Short-circuits immediately (no network request) when the SDK has no
      * bearer token or API key set — the server would return 401 anyway.
      * Throws a `SmartlinksApiError` with `statusCode 401` and

package/dist/api/index.d.ts

@@ -24,6 +24,7 @@ export { journeysAnalytics } from "./journeysAnalytics";
 export { qr } from "./qr";
 export { template } from "./template";
 export { interactions } from "./interactions";
+export { analytics } from "./analytics";
 export { location } from "./location";
 export * as realtime from "./realtime";
 export { tags } from "./tags";

package/dist/api/index.js

@@ -26,6 +26,7 @@ export { journeysAnalytics } from "./journeysAnalytics";
 export { qr } from "./qr";
 export { template } from "./template";
 export { interactions } from "./interactions";
+export { analytics } from "./analytics";
 export { location } from "./location";
 import * as realtime_1 from "./realtime";
 export { realtime_1 as realtime };

package/dist/api/order.d.ts

@@ -252,13 +252,22 @@ export declare namespace order {
      *   includeItems: true
      * })
      *
-     * // Find orders containing a specific product batch
+    * // Find orders containing a specific product batch
      * const batchOrders = await order.query('coll_123', {
      *   query: {
-     *     item: {
-     *       productId: 'prod_789',
-     *       batchId: 'BATCH-2024-001'
-     *     }
+    *     productId: 'prod_789',
+    *     batchId: 'BATCH-2024-001'
+    *   },
+    *   includeItems: true
+    * })
+    *
+    * // Find an order containing one of several specific items
+    * const matched = await order.query('coll_123', {
+    *   query: {
+    *     items: [
+    *       { itemType: 'tag', itemId: 'TAG001' },
+    *       { itemType: 'serial', itemId: 'SN12345' }
+    *     ]
      *   },
      *   includeItems: true
      * })

package/dist/api/order.js

@@ -287,9 +287,11 @@ export var order;
     }
     order.lookup = lookup;
     function validateOrderQuery(data) {
-        var _a;
-        if (((_a = data.query) === null || _a === void 0 ? void 0 : _a.item) && !data.query.item.productId) {
-            throw new Error('query.item.productId is required when using item-level order filters');
+        const query = data.query;
+        if (!query)
+            return;
+        if ((query.batchId || query.variantId) && !query.productId) {
+            throw new Error('query.productId is required when using query.batchId or query.variantId');
         }
     }
     /**
@@ -325,13 +327,22 @@ export var order;
      *   includeItems: true
      * })
      *
-     * // Find orders containing a specific product batch
+    * // Find orders containing a specific product batch
      * const batchOrders = await order.query('coll_123', {
      *   query: {
-     *     item: {
-     *       productId: 'prod_789',
-     *       batchId: 'BATCH-2024-001'
-     *     }
+    *     productId: 'prod_789',
+    *     batchId: 'BATCH-2024-001'
+    *   },
+    *   includeItems: true
+    * })
+    *
+    * // Find an order containing one of several specific items
+    * const matched = await order.query('coll_123', {
+    *   query: {
+    *     items: [
+    *       { itemType: 'tag', itemId: 'TAG001' },
+    *       { itemType: 'serial', itemId: 'SN12345' }
+    *     ]
      *   },
      *   includeItems: true
      * })