@bytexbyte/berify-analytics-api 2.0.2 → 2.1.0

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

@@ -1,5 +1,5 @@
 import BxBApi from '@bytexbyte/bxb-api';
-import { HeatmapRequest, HeatmapResponse, LastUpdatedAtResponse } from './type';
+import { HeatmapRequest, HeatmapResponse, LastUpdatedAtResponse, ReskinHeatmapRequest } from './type';
 declare class BerifyHeatMapApi extends BxBApi {
     constructor({ host, secretKey, secret }: {
         host: string;
@@ -8,5 +8,6 @@ declare class BerifyHeatMapApi extends BxBApi {
     });
     getHeatmap(form: HeatmapRequest): Promise<HeatmapResponse>;
     getLastUpdatedAt(): Promise<LastUpdatedAtResponse>;
+    getHeatmapByDateRange(form: ReskinHeatmapRequest): Promise<HeatmapResponse>;
 }
 export default BerifyHeatMapApi;

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

@@ -28,5 +28,15 @@ class BerifyHeatMapApi extends bxb_api_1.default {
         });
         return response.json();
     }
+    async getHeatmapByDateRange(form) {
+        const response = await this.bxbFetch({
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json'
+            },
+            body: JSON.stringify(form)
+        }, 'date-range');
+        return response.json();
+    }
 }
 exports.default = BerifyHeatMapApi;

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

@@ -15,6 +15,15 @@ export type HeatmapRequest = {
     collectionRuleId?: string;
     timeInterval: TimeInterval;
 };
+export type ReskinHeatmapRequest = {
+    userId: string;
+    companyId?: number;
+    tagTokenId?: string;
+    batchId?: string;
+    collectionRuleId?: number;
+    startDate: Date;
+    endDate: Date;
+};
 export type HeatmapResult = {
     id: string;
     latitude: Decimal | null;

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

@@ -0,0 +1,81 @@
+import BxBApi from '@bytexbyte/bxb-api';
+import { DataWithDate } from '../../../interfaces';
+import { AgeResult, DeviceTypeResult, GenderResult, HeatmapResult, ReskinChartRequest, User } from './type';
+declare class BerifyReskinApi extends BxBApi {
+    constructor({ host, secretKey, secret }: {
+        host: string;
+        secretKey?: string;
+        secret?: string;
+    });
+    getScanCount(user: User, form: ReskinChartRequest): Promise<{
+        data: number;
+    } | {
+        error: 'session not found' | 'user not found' | 'startDate and endDate are required' | 'Permission denied' | 'Internal Server Error';
+    }>;
+    getNewUserCount(user: User, form: ReskinChartRequest): Promise<{
+        data: number;
+    } | {
+        error: 'session not found' | 'user not found' | 'startDate and endDate are required' | 'Permission denied' | 'Internal Server Error';
+    }>;
+    getUniqueScanCount(user: User, form: ReskinChartRequest): Promise<{
+        data: number;
+    } | {
+        error: 'session not found' | 'user not found' | 'startDate and endDate are required' | 'Permission denied' | 'Internal Server Error';
+    }>;
+    getSessionDurationAvg(user: User, form: ReskinChartRequest): Promise<{
+        data: number;
+    } | {
+        error: 'session not found' | 'user not found' | 'startDate and endDate are required' | 'Permission denied' | 'Internal Server Error';
+    }>;
+    getPromoModalOpenCount(user: User, form: ReskinChartRequest): Promise<{
+        data: number;
+    } | {
+        error: 'session not found' | 'user not found' | 'startDate and endDate are required' | 'Permission denied' | 'Internal Server Error';
+    }>;
+    getCommunityModalOpenCount(user: User, form: ReskinChartRequest): Promise<{
+        data: number;
+    } | {
+        error: 'session not found' | 'user not found' | 'startDate and endDate are required' | 'Permission denied' | 'Internal Server Error';
+    }>;
+    getBounceRate(user: User, form: ReskinChartRequest): Promise<{
+        data: number;
+    } | {
+        error: 'session not found' | 'user not found' | 'startDate and endDate are required' | 'Permission denied' | 'Internal Server Error';
+    }>;
+    getExperienceEngagement(user: User, form: ReskinChartRequest): Promise<{
+        data: number;
+    } | {
+        error: 'session not found' | 'user not found' | 'startDate and endDate are required' | 'Permission denied' | 'Internal Server Error';
+    }>;
+    getGenderBreakdown(user: User, form: ReskinChartRequest): Promise<{
+        data: GenderResult;
+    } | {
+        error: 'session not found' | 'user not found' | 'startDate and endDate are required' | 'Permission denied' | 'Internal Server Error';
+    }>;
+    getAgeDistribution(user: User, form: ReskinChartRequest): Promise<{
+        data: AgeResult;
+    } | {
+        error: 'session not found' | 'user not found' | 'startDate and endDate are required' | 'Permission denied' | 'Internal Server Error';
+    }>;
+    getDeviceType(user: User, form: ReskinChartRequest): Promise<{
+        data: DeviceTypeResult;
+    } | {
+        error: 'session not found' | 'user not found' | 'startDate and endDate are required' | 'Permission denied' | 'Internal Server Error';
+    }>;
+    getHeatmap(user: User, form: ReskinChartRequest): Promise<{
+        data: HeatmapResult;
+    } | {
+        error: 'session not found' | 'user not found' | 'startDate and endDate are required' | 'Permission denied' | 'Internal Server Error';
+    }>;
+    getDailyScanCount(user: User, form: ReskinChartRequest): Promise<{
+        data: DataWithDate[];
+    } | {
+        error: 'session not found' | 'user not found' | 'startDate and endDate are required' | 'Permission denied' | 'Internal Server Error';
+    }>;
+    getActiveTime(user: User, form: ReskinChartRequest): Promise<{
+        data: number[];
+    } | {
+        error: 'session not found' | 'user not found' | 'startDate and endDate are required' | 'Permission denied' | 'Internal Server Error';
+    }>;
+}
+export default BerifyReskinApi;

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

@@ -0,0 +1,153 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const bxb_api_1 = require("@bytexbyte/bxb-api");
+class BerifyReskinApi extends bxb_api_1.default {
+    constructor({ host, secretKey, secret }) {
+        super({
+            host, moduleName: 'reskin',
+            secretKey: secretKey ?? 'secretKey',
+            secret: secret ?? 'secret'
+        });
+    }
+    async getScanCount(user, form) {
+        const response = await this.bxbFetch({
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json'
+            },
+            body: JSON.stringify({ user, form })
+        }, 'scan-count');
+        return response.json();
+    }
+    async getNewUserCount(user, form) {
+        const response = await this.bxbFetch({
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json'
+            },
+            body: JSON.stringify({ user, form })
+        }, 'new-user-count');
+        return response.json();
+    }
+    async getUniqueScanCount(user, form) {
+        const response = await this.bxbFetch({
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json'
+            },
+            body: JSON.stringify({ user, form })
+        }, 'unique-scan-count');
+        return response.json();
+    }
+    async getSessionDurationAvg(user, form) {
+        const response = await this.bxbFetch({
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json'
+            },
+            body: JSON.stringify({ user, form })
+        }, 'session-duration-avg');
+        return response.json();
+    }
+    async getPromoModalOpenCount(user, form) {
+        const response = await this.bxbFetch({
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json'
+            },
+            body: JSON.stringify({ user, form })
+        }, 'promo-modal-open-count');
+        return response.json();
+    }
+    async getCommunityModalOpenCount(user, form) {
+        const response = await this.bxbFetch({
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json'
+            },
+            body: JSON.stringify({ user, form })
+        }, 'community-modal-open-count');
+        return response.json();
+    }
+    async getBounceRate(user, form) {
+        const response = await this.bxbFetch({
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json'
+            },
+            body: JSON.stringify({ user, form })
+        }, 'bounce-rate');
+        return response.json();
+    }
+    async getExperienceEngagement(user, form) {
+        const response = await this.bxbFetch({
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json'
+            },
+            body: JSON.stringify({ user, form })
+        }, 'experience-engagement');
+        return response.json();
+    }
+    async getGenderBreakdown(user, form) {
+        const response = await this.bxbFetch({
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json'
+            },
+            body: JSON.stringify({ user, form })
+        }, 'gender-breakdown');
+        return response.json();
+    }
+    async getAgeDistribution(user, form) {
+        const response = await this.bxbFetch({
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json'
+            },
+            body: JSON.stringify({ user, form })
+        }, 'age-distribution');
+        return response.json();
+    }
+    async getDeviceType(user, form) {
+        const response = await this.bxbFetch({
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json'
+            },
+            body: JSON.stringify({ user, form })
+        }, 'device-type');
+        return response.json();
+    }
+    async getHeatmap(user, form) {
+        const response = await this.bxbFetch({
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json'
+            },
+            body: JSON.stringify({ user, form })
+        }, 'heatmap');
+        return response.json();
+    }
+    async getDailyScanCount(user, form) {
+        const response = await this.bxbFetch({
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json'
+            },
+            body: JSON.stringify({ user, form })
+        }, 'daily-scan-count');
+        return response.json();
+    }
+    async getActiveTime(user, form) {
+        const response = await this.bxbFetch({
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json'
+            },
+            body: JSON.stringify({ user, form })
+        }, 'active-time');
+        return response.json();
+    }
+}
+exports.default = BerifyReskinApi;

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

@@ -0,0 +1,40 @@
+import { Decimal } from "@prisma/client/runtime/library";
+export type CompanyRoleType = 'super' | 'admin' | 'marketing' | 'supplier' | 'seo' | 'associate';
+export type User = {
+    id: string;
+    companyId: string;
+    companyRole: CompanyRoleType;
+};
+export interface ReskinChartRequest {
+    startDate: string;
+    endDate: string;
+    batchId?: string;
+    companyId?: string;
+    country?: string;
+    state?: string;
+    city?: string;
+}
+export type GenderResult = {
+    male: number;
+    female: number;
+    unknown: number;
+};
+export type AgeResult = {
+    '18-24': number;
+    '25-34': number;
+    '35-44': number;
+    '45-54': number;
+    '55-64': number;
+    '65+': number;
+    unknown: number;
+};
+export type DeviceTypeResult = {
+    iOS: number;
+    Android: number;
+    Web: number;
+};
+export type HeatmapResult = {
+    id: string;
+    latitude: Decimal | null;
+    longitude: Decimal | null;
+}[];

package/lib/berifyAnalyticsApi/src/Reskin/type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,4 +1,5 @@
 import BerifyHeatMapApi from "./Heatmap";
+import BerifyReskinApi from "./Reskin";
 import BerifyScanChartApi from "./ScanChart";
 declare class BerifyAnalyticsApi {
     host: string;
@@ -6,6 +7,7 @@ declare class BerifyAnalyticsApi {
     secret?: string;
     heatmap: BerifyHeatMapApi;
     scanChart: BerifyScanChartApi;
+    reskin: BerifyReskinApi;
     constructor({ host, secretKey, secret }: {
         host: string;
         secretKey?: string;

package/lib/berifyAnalyticsApi/src/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const Heatmap_1 = require("./Heatmap");
+const Reskin_1 = require("./Reskin");
 const ScanChart_1 = require("./ScanChart");
 class BerifyAnalyticsApi {
     constructor({ host, secretKey, secret }) {
@@ -9,6 +10,7 @@ class BerifyAnalyticsApi {
         this.secret = secret;
         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 });
     }
 }
 exports.default = BerifyAnalyticsApi;

package/lib/interfaces/index.d.ts

@@ -31,6 +31,7 @@ export interface Scan {
     generalUserId: string;
     type: ScanType;
     tag: {
+        tokenId: string;
         batchId: string;
         batch: {
             companyId: string;
@@ -38,3 +39,7 @@ export interface Scan {
         };
     };
 }
+export type DataWithDate = {
+    date: string;
+    value: number;
+};

package/package.json

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