@bytexbyte/berify-analytics-api 1.5.2 → 1.6.0

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@bytexbyte/berify-analytics-api",
-  "version": "1.5.2",
+  "version": "1.6.0",
   "description": "api",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
+  "main": "lib/berifyAnalyticsApi/index.js",
+  "types": "lib/berifyAnalyticsApi/index.d.ts",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "build": "tsc",

package/lib/Heatmap/index.d.ts

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

package/lib/Heatmap/index.js

@@ -1,105 +0,0 @@
-"use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (g && (g = 0, op[0] && (_ = 0)), _) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-var bxb_api_1 = require("@bytexbyte/bxb-api");
-var BerifyHeatMapApi = /** @class */ (function (_super) {
-    __extends(BerifyHeatMapApi, _super);
-    function BerifyHeatMapApi(_a) {
-        var host = _a.host, secretKey = _a.secretKey, secret = _a.secret;
-        return _super.call(this, {
-            host: host,
-            moduleName: 'heatmap',
-            secretKey: secretKey !== null && secretKey !== void 0 ? secretKey : 'secretKey',
-            secret: secret !== null && secret !== void 0 ? secret : 'secret'
-        }) || this;
-    }
-    BerifyHeatMapApi.prototype.getHeatmap = function (form) {
-        return __awaiter(this, void 0, void 0, function () {
-            var response;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.bxbFetch({
-                            method: 'POST',
-                            headers: {
-                                'Content-Type': 'application/json'
-                            },
-                            body: JSON.stringify(form)
-                        })];
-                    case 1:
-                        response = _a.sent();
-                        return [2 /*return*/, response.json()];
-                }
-            });
-        });
-    };
-    BerifyHeatMapApi.prototype.getLastUpdatedAt = function () {
-        return __awaiter(this, void 0, void 0, function () {
-            var response;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.bxbFetch({
-                            method: 'GET',
-                            headers: {
-                                'Content-Type': 'application/json'
-                            }
-                        })];
-                    case 1:
-                        response = _a.sent();
-                        return [2 /*return*/, response.json()];
-                }
-            });
-        });
-    };
-    return BerifyHeatMapApi;
-}(bxb_api_1.default));
-exports.default = BerifyHeatMapApi;

package/lib/Heatmap/type.d.ts

@@ -1,33 +0,0 @@
-import { Decimal } from "@prisma/client/runtime/library";
-export type HeatmapApi = (form: HeatmapRequest) => Promise<HeatmapResponse>;
-declare enum TimeInterval {
-    All = "All Time",
-    LastHour = "Last hour",
-    LastDay = "Last day",
-    LastWeek = "Last week",
-    LastMonth = "Last month"
-}
-export type HeatmapRequest = {
-    userId: string;
-    companyId?: number;
-    tagTokenId?: string;
-    batchId?: string;
-    collectionRuleId?: number;
-    timeInterval: TimeInterval;
-};
-export type HeatmapResult = {
-    id: number;
-    latitude: Decimal | null;
-    longitude: Decimal | null;
-}[];
-export type HeatmapResponse = {
-    status: 'ok' | 'error';
-    data?: HeatmapResult;
-    error?: string;
-};
-export type LastUpdatedAtResponse = {
-    status: 'ok' | 'error';
-    data?: Date;
-    error?: string;
-};
-export {};

package/lib/Heatmap/type.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var TimeInterval;
-(function (TimeInterval) {
-    TimeInterval["All"] = "All Time";
-    TimeInterval["LastHour"] = "Last hour";
-    TimeInterval["LastDay"] = "Last day";
-    TimeInterval["LastWeek"] = "Last week";
-    TimeInterval["LastMonth"] = "Last month";
-})(TimeInterval || (TimeInterval = {}));

package/lib/ScanChart/index.d.ts

@@ -1,16 +0,0 @@
-import BxBApi from '@bytexbyte/bxb-api';
-import { ScanReportRequest, ScanReportResponse, UserReportRequest, UserReportResponse, ScanRateResponse, ScanRateByTimeRequest, ScanRateByTimeResponse, User, BatchScanDataRequest, BatchScanDataResponse, LeaderBoardResponse, LeaderBoardRequest } from './type';
-declare class BerifyScanChartApi extends BxBApi {
-    constructor({ host, secretKey, secret }: {
-        host: string;
-        secretKey?: string;
-        secret?: string;
-    });
-    getScanReport(user: User, form: ScanReportRequest): Promise<ScanReportResponse>;
-    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>;
-    getLeaderBoard(user: User, form: LeaderBoardRequest): Promise<LeaderBoardResponse>;
-}
-export default BerifyScanChartApi;

package/lib/ScanChart/index.js

@@ -1,182 +0,0 @@
-"use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (g && (g = 0, op[0] && (_ = 0)), _) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-var bxb_api_1 = require("@bytexbyte/bxb-api");
-var BerifyScanChartApi = /** @class */ (function (_super) {
-    __extends(BerifyScanChartApi, _super);
-    function BerifyScanChartApi(_a) {
-        var host = _a.host, secretKey = _a.secretKey, secret = _a.secret;
-        return _super.call(this, {
-            host: host,
-            moduleName: 'scan-chart',
-            secretKey: secretKey !== null && secretKey !== void 0 ? secretKey : 'secretKey',
-            secret: secret !== null && secret !== void 0 ? secret : 'secret'
-        }) || this;
-    }
-    BerifyScanChartApi.prototype.getScanReport = function (user, form) {
-        return __awaiter(this, void 0, void 0, function () {
-            var response;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.bxbFetch({
-                            method: 'POST',
-                            headers: {
-                                'Content-Type': 'application/json'
-                            },
-                            body: JSON.stringify({ user: user, form: form })
-                        }, 'scan-report')];
-                    case 1:
-                        response = _a.sent();
-                        return [2 /*return*/, response.json()];
-                }
-            });
-        });
-    };
-    BerifyScanChartApi.prototype.getUserReport = function (user, form) {
-        return __awaiter(this, void 0, void 0, function () {
-            var response;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.bxbFetch({
-                            method: 'POST',
-                            headers: {
-                                'Content-Type': 'application/json'
-                            },
-                            body: JSON.stringify({ user: user, form: form })
-                        }, 'user-report')];
-                    case 1:
-                        response = _a.sent();
-                        return [2 /*return*/, response.json()];
-                }
-            });
-        });
-    };
-    BerifyScanChartApi.prototype.getScanRateAll = function (user, form) {
-        return __awaiter(this, void 0, void 0, function () {
-            var response;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.bxbFetch({
-                            method: 'POST',
-                            headers: {
-                                'Content-Type': 'application/json'
-                            },
-                            body: JSON.stringify({ user: user, form: form })
-                        }, 'scan-rate-all')];
-                    case 1:
-                        response = _a.sent();
-                        return [2 /*return*/, response.json()];
-                }
-            });
-        });
-    };
-    BerifyScanChartApi.prototype.getScanRateByTime = function (user, form) {
-        return __awaiter(this, void 0, void 0, function () {
-            var response;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.bxbFetch({
-                            method: 'POST',
-                            headers: {
-                                'Content-Type': 'application/json'
-                            },
-                            body: JSON.stringify({ user: user, form: form })
-                        }, 'scan-rate-by-time')];
-                    case 1:
-                        response = _a.sent();
-                        return [2 /*return*/, response.json()];
-                }
-            });
-        });
-    };
-    BerifyScanChartApi.prototype.getBatchScanData = function (form) {
-        return __awaiter(this, void 0, void 0, function () {
-            var response;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.bxbFetch({
-                            method: 'POST',
-                            headers: {
-                                'Content-Type': 'application/json'
-                            },
-                            body: JSON.stringify({ form: form })
-                        }, 'batch-scan-data')];
-                    case 1:
-                        response = _a.sent();
-                        return [2 /*return*/, response.json()];
-                }
-            });
-        });
-    };
-    BerifyScanChartApi.prototype.getLeaderBoard = function (user, form) {
-        return __awaiter(this, void 0, void 0, function () {
-            var response;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.bxbFetch({
-                            method: 'POST',
-                            headers: {
-                                'Content-Type': 'application/json'
-                            },
-                            body: JSON.stringify({ user: user, form: form })
-                        }, 'leaderBoard')];
-                    case 1:
-                        response = _a.sent();
-                        return [2 /*return*/, response.json()];
-                }
-            });
-        });
-    };
-    return BerifyScanChartApi;
-}(bxb_api_1.default));
-exports.default = BerifyScanChartApi;

package/lib/ScanChart/type.d.ts

@@ -1,143 +0,0 @@
-export type ScanReportRequest = {
-    tagTokenId?: string;
-    batchId?: string;
-    companyId?: number;
-};
-export type ScanReportResult = {
-    anonymous: number;
-    unique: number;
-    returning: number;
-    total: number;
-};
-export type ScanReportResponse = {
-    status: 'ok' | 'error';
-    data?: ScanReportResult;
-    error?: string;
-};
-export type UserReportRequest = {
-    tagTokenId?: string;
-    batchId?: string;
-    companyId?: number;
-};
-export type UserReportResult = {
-    appClip: number;
-    appUser: number;
-    registeredAppUser: number;
-    total: number;
-};
-export type UserReportResponse = {
-    status: 'ok' | 'error';
-    data?: UserReportResult;
-    error?: string;
-};
-export type ScanRateResponse = {
-    status: 'ok' | 'error';
-    data?: {
-        month: string;
-        scanCounts: number;
-    }[];
-    error?: string;
-};
-export declare enum TimeInterval {
-    All = "All Time",
-    LastHour = "Last hour",
-    LastDay = "Last day",
-    LastWeek = "Last week",
-    LastMonth = "Last month"
-}
-export type ScanRateByTimeRequest = {
-    batchId?: string;
-    companyId?: number;
-    tagTokenId?: string;
-    time: TimeInterval;
-};
-export type ScanRateByTimeResponse = {
-    status: 'ok' | 'error';
-    data?: {
-        scanCounts: number;
-        date?: Date;
-        year?: string;
-        month?: string;
-        day?: string;
-        hour?: string;
-        minute?: string;
-    }[];
-    error?: string;
-};
-export type CompanyRoleType = 'super' | 'admin' | 'marketing' | 'supplier' | 'seo' | 'associate';
-export type User = {
-    id: string;
-    companyId: number;
-    companyRole: CompanyRoleType;
-};
-export type ScanRateType = {
-    date?: Date;
-    year?: string;
-    month?: string;
-    day?: string;
-    hour?: string;
-    minute?: string;
-    scanCounts: number;
-};
-export type BatchScanDataRequest = {
-    batchId: string;
-    page: string;
-    pageSize: string;
-    sort: 'lastScanned' | 'totalScan' | 'uniqueCount';
-    order: 'asc' | 'desc';
-    gtRedeemStatus?: 'redeemed' | 'not_redeemed' | 'none';
-    search?: string;
-};
-export type BlockChainStatusType = 'transferred' | 'minted' | 'queued' | 'transferring' | 'fail';
-export type BatchScanDataResult = {
-    tagTokenId: string;
-    totalScan: number;
-    uniqueCount: number;
-    lastScanned: Date;
-    goldenTicketPrize: {
-        id: number;
-        tagTokenId: string;
-        goldenTicketPrizeId: number;
-    };
-    goldenTicketRedeem: {
-        id: number;
-        tagTokenId: string;
-        goldenTicketRedeemId: number;
-    };
-    tagNft: {
-        id: number;
-        tagTokenId: string;
-        blockchainStatus: BlockChainStatusType;
-        updatedAt: Date;
-    };
-};
-export type BatchScanDataResponse = {
-    status: 'ok' | 'error';
-    data?: BatchScanDataResult[];
-    error?: string;
-    currentPage: number;
-    totalPages: number;
-    pageSize: number;
-    totalItems: number;
-};
-export type LeaderBoardRequest = {
-    tagTokenId?: string;
-    batchId?: string;
-    companyId?: number;
-    page?: number;
-    pageSize?: number;
-};
-export type LeaderBoardResult = {
-    position: number;
-    batchId: string;
-    batchName: string;
-    totalScans: number;
-}[];
-export type LeaderBoardResponse = {
-    status: 'ok' | 'error';
-    data?: {
-        data: LeaderBoardResult;
-        totalDatasNumber: number;
-    };
-    error?: string;
-};

package/lib/ScanChart/type.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TimeInterval = void 0;
-var TimeInterval;
-(function (TimeInterval) {
-    TimeInterval["All"] = "All Time";
-    TimeInterval["LastHour"] = "Last hour";
-    TimeInterval["LastDay"] = "Last day";
-    TimeInterval["LastWeek"] = "Last week";
-    TimeInterval["LastMonth"] = "Last month";
-})(TimeInterval = exports.TimeInterval || (exports.TimeInterval = {}));

package/lib/config.d.ts

@@ -1 +0,0 @@
-export declare const AnalyticsApiSecret = "Analytics-Api-Secret";

package/lib/config.js

@@ -1,4 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AnalyticsApiSecret = void 0;
-exports.AnalyticsApiSecret = 'Analytics-Api-Secret';

package/lib/index.d.ts

@@ -1,15 +0,0 @@
-import BerifyHeatMapApi from "./Heatmap";
-import BerifyScanChartApi from "./ScanChart";
-declare class BerifyAnalyticsApi {
-    host: string;
-    secretKey?: string;
-    secret?: string;
-    heatmap: BerifyHeatMapApi;
-    scanChart: BerifyScanChartApi;
-    constructor({ host, secretKey, secret }: {
-        host: string;
-        secretKey?: string;
-        secret?: string;
-    });
-}
-export default BerifyAnalyticsApi;

package/lib/index.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var Heatmap_1 = require("./Heatmap");
-var ScanChart_1 = require("./ScanChart");
-var BerifyAnalyticsApi = /** @class */ (function () {
-    function BerifyAnalyticsApi(_a) {
-        var host = _a.host, secretKey = _a.secretKey, secret = _a.secret;
-        this.host = host;
-        this.secretKey = secretKey;
-        this.secret = secret;
-        this.heatmap = new Heatmap_1.default({ host: host, secretKey: secretKey, secret: secret });
-        this.scanChart = new ScanChart_1.default({ host: host, secretKey: secretKey, secret: secret });
-    }
-    return BerifyAnalyticsApi;
-}());
-exports.default = BerifyAnalyticsApi;