@bytexbyte/berify-analytics-api 2.2.7 → 2.2.8

package/lib/berifyAnalyticsApi/src/Heatmap/type.d.ts

@@ -7,6 +7,12 @@ declare enum TimeInterval {
     LastWeek = "Last week",
     LastMonth = "Last month"
 }
+export type HeatmapBounds = {
+    minLat: number;
+    maxLat: number;
+    minLng: number;
+    maxLng: number;
+};
 export type HeatmapRequest = {
     userId: string;
     companyId?: string;
@@ -15,7 +21,13 @@ export type HeatmapRequest = {
     collectionRuleId?: string;
     timeInterval: TimeInterval;
     scanTypes?: ScanType[] | ScanType;
-    zoom?: number;
+    /** Map viewport; scans outside it are not aggregated. Omitted means worldwide. */
+    bounds?: HeatmapBounds;
+    /** Explicit window; overrides timeInterval so the client owns its presets. */
+    from?: string | Date;
+    to?: string | Date;
+    /** 'compact' returns [lat, lng, count] tuples instead of objects. */
+    format?: 'objects' | 'compact';
 };
 export type ReskinHeatmapRequest = {
     userId: string;
@@ -26,17 +38,31 @@ export type ReskinHeatmapRequest = {
     startDate: Date;
     endDate: Date;
 };
-export type HeatmapCell = {
-    h3: string;
+/** One scan, at the place it happened. Sent while the viewport holds few enough. */
+export type HeatmapPoint = {
     count: number;
     lat: number;
     lng: number;
 };
-export type HeatmapResult = HeatmapCell[];
+/** A bucket of scans at the centre of its h3 cell, for views too broad to send raw. */
+export type HeatmapCell = HeatmapPoint & {
+    h3: string;
+};
+export type HeatmapMode = 'points' | 'cells';
+export type HeatmapResult = HeatmapPoint[] | HeatmapCell[] | HeatmapTuple[];
+export type HeatmapTuple = [lat: number, lng: number, count: number];
 export type HeatmapMeta = {
-    resolution: number;
+    /** Which shape `data` is in — see HeatmapRequest.format. */
+    encoding: 'objects' | 'compact';
+    /** 'points' means data is raw scans; 'cells' means it is h3 buckets. */
+    mode: HeatmapMode;
+    /** h3 resolution of the buckets, null in 'points' mode. */
+    resolution: number | null;
+    /** Scans matching the filter, before anything geographic is applied. */
     totalPoints: number;
     cellCount: number;
+    /** Scans with no usable coordinates — they cannot appear at any zoom. */
+    withoutLocation: number;
 };
 export type HeatmapResponse = {
     status: 'ok' | 'error';

package/lib/berifyAnalyticsApi/src/Report/index.js

@@ -7,7 +7,7 @@ class BerifyReportApi extends bxb_api_1.default {
             host,
             moduleName: 'reports',
             secretKey: secretKey ?? 'secretKey',
-            secret: secret ?? 'secret'
+            secret: secret ?? 'secret',
         });
     }
     /**
@@ -22,9 +22,9 @@ class BerifyReportApi extends bxb_api_1.default {
         const response = await this.bxbFetch({
             method: 'POST',
             headers: {
-                'Content-Type': 'application/json'
+                'Content-Type': 'application/json',
             },
-            body: JSON.stringify({ user, ...form })
+            body: JSON.stringify({ user, ...form }),
         }, '');
         return response.json();
     }

package/lib/berifyAnalyticsApi/src/ScanChart/index.d.ts

@@ -10,7 +10,7 @@ declare class BerifyScanChartApi extends BxBApi {
     getUserReport(user: User, form: UserReportRequest): Promise<UserReportResponse>;
     getScanRateAll(user: User, form: UserReportRequest): Promise<ScanRateResponse>;
     getScanRateByTime(user: User, form: ScanRateByTimeRequest): Promise<ScanRateByTimeResponse>;
-    getBatchScanData(form: BatchScanDataRequest): Promise<BatchScanDataResponse>;
+    getBatchScanData(user: User, form: BatchScanDataRequest): Promise<BatchScanDataResponse>;
     getLeaderBoard(user: User, form: LeaderBoardRequest): Promise<LeaderBoardResponse>;
     getTagScanHistory(form: TagSearchRequest): Promise<TagScanResponse>;
     exportBatchScannedUsers(user: User, form: BatchScannedUsersExportRequest): Promise<BatchScannedUsersExportResponse>;

package/lib/berifyAnalyticsApi/src/ScanChart/index.js

@@ -50,13 +50,13 @@ class BerifyScanChartApi extends bxb_api_1.default {
         }, 'scan-rate-by-time');
         return response.json();
     }
-    async getBatchScanData(form) {
+    async getBatchScanData(user, form) {
         const response = await this.bxbFetch({
             method: 'POST',
             headers: {
                 'Content-Type': 'application/json',
             },
-            body: JSON.stringify({ form }),
+            body: JSON.stringify({ user, form }),
         }, 'batch-scan-data');
         return response.json();
     }

package/lib/berifyAnalyticsApi/src/index.d.ts

@@ -1,6 +1,7 @@
 import BerifyHeatMapApi from './Heatmap';
 import BerifyReskinApi from './Reskin';
 import BerifyScanChartApi from './ScanChart';
+import BerifyReportApi from './Report';
 declare class BerifyAnalyticsApi {
     host: string;
     secretKey?: string;
@@ -8,6 +9,7 @@ declare class BerifyAnalyticsApi {
     heatmap: BerifyHeatMapApi;
     scanChart: BerifyScanChartApi;
     reskin: BerifyReskinApi;
+    report: BerifyReportApi;
     constructor({ host, secretKey, secret }: {
         host: string;
         secretKey?: string;

package/lib/berifyAnalyticsApi/src/index.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const Heatmap_1 = require("./Heatmap");
 const Reskin_1 = require("./Reskin");
 const ScanChart_1 = require("./ScanChart");
+const Report_1 = require("./Report");
 class BerifyAnalyticsApi {
     constructor({ host, secretKey, secret }) {
         this.host = host;
@@ -11,6 +12,7 @@ class BerifyAnalyticsApi {
         this.heatmap = new Heatmap_1.default({ host, secretKey, secret });
         this.scanChart = new ScanChart_1.default({ host, secretKey, secret });
         this.reskin = new Reskin_1.default({ host, secretKey, secret });
+        this.report = new Report_1.default({ host, secretKey, secret });
     }
 }
 exports.default = BerifyAnalyticsApi;

package/lib/interfaces/index.d.ts

@@ -28,6 +28,7 @@ export interface Scan {
     location: string | null;
     createdAt: Date;
     tagId: string;
+    batchId: string | null;
     generalUserId: string;
     isVisitedPromo: boolean;
     isVisitedShop: boolean;
@@ -39,12 +40,12 @@ export interface Scan {
     type: ScanType;
     tag: {
         tokenId: string;
-        batchId: string;
-        batch: {
-            companyId: string;
-            name: string;
-        };
+        batchId?: string | null;
     };
+    batch: {
+        companyId: string;
+        name: string;
+    } | null;
 }
 export type DataWithDate = {
     date: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bytexbyte/berify-analytics-api",
-  "version": "2.2.7",
+  "version": "2.2.8",
   "description": "api",
   "main": "lib/berifyAnalyticsApi/src/index.js",
   "types": "lib/berifyAnalyticsApi/src/index.d.ts",