@bytexbyte/berify-analytics-api 2.2.4 → 2.2.6

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

@@ -0,0 +1,20 @@
+import BxBApi from '@bytexbyte/bxb-api';
+import { ScanReportRequest, ScanReportResponse } from './type';
+import { User } from '../ScanChart/type';
+declare class BerifyReportApi extends BxBApi {
+    constructor({ host, secretKey, secret }: {
+        host: string;
+        secretKey?: string;
+        secret?: string;
+    });
+    /**
+     * 生成掃描報告
+     * Generate scan report with customizable date range
+     *
+     * @param user - User information for authorization
+     * @param form - Report request parameters
+     * @returns Promise<ScanReportResponse>
+     */
+    generateScanReport(user: User, form: ScanReportRequest): Promise<ScanReportResponse>;
+}
+export default BerifyReportApi;

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

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const bxb_api_1 = require("@bytexbyte/bxb-api");
+class BerifyReportApi extends bxb_api_1.default {
+    constructor({ host, secretKey, secret }) {
+        super({
+            host,
+            moduleName: 'reports',
+            secretKey: secretKey ?? 'secretKey',
+            secret: secret ?? 'secret'
+        });
+    }
+    /**
+     * 生成掃描報告
+     * Generate scan report with customizable date range
+     *
+     * @param user - User information for authorization
+     * @param form - Report request parameters
+     * @returns Promise<ScanReportResponse>
+     */
+    async generateScanReport(user, form) {
+        const response = await this.bxbFetch({
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json'
+            },
+            body: JSON.stringify({ user, ...form })
+        }, '');
+        return response.json();
+    }
+}
+exports.default = BerifyReportApi;

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

@@ -0,0 +1,89 @@
+/**
+ * Report API Type Definitions
+ * 掃描報告 API 接口定義
+ */
+export type ScanReportRequest = {
+    companyId: string;
+    startDate?: string;
+    endDate?: string;
+    includeCharts?: boolean;
+    includePdf?: boolean;
+    useOpenAI?: boolean;
+    digitalTopN?: number;
+    format?: 'json' | 'pdf';
+};
+export type DailyCount = {
+    date: string;
+    count: number;
+};
+export type TopItem = {
+    id: string;
+    name?: string;
+    count: number;
+};
+export type LocationStats = {
+    location: string;
+    country?: string;
+    region?: string;
+    locality?: string;
+    count: number;
+};
+export type PromoDetail = {
+    title?: string;
+    description?: string;
+    link?: string;
+    imageUrl?: string;
+};
+export type ProductDetail = {
+    id: string;
+    name?: string;
+    description?: string;
+    detail?: string;
+    promo?: PromoDetail;
+};
+export type DigitalCustomizationDetail = {
+    id: string;
+    name?: string;
+    count: number;
+    shopLink?: string;
+    exploreLink?: string;
+    successText?: string;
+    product?: ProductDetail;
+};
+export type ScanReportStats = {
+    companyId: string;
+    companyName?: string;
+    startDate: string;
+    endDate: string;
+    totalScans: number;
+    uniqueUsers: number;
+    dailyCounts: DailyCount[];
+    topTags: TopItem[];
+    topTokens: TopItem[];
+    topBatches: TopItem[];
+    topLocations: LocationStats[];
+    topDigitalCustomizations: DigitalCustomizationDetail[];
+    unknownLocationScans: number;
+};
+export type ChartData = {
+    dailyTrend?: string;
+    topLocations?: string;
+};
+export type ScanReportResult = ScanReportStats & {
+    charts?: ChartData;
+    pdfUrl?: string;
+};
+export type ScanReportResponse = {
+    status: 'ok' | 'error';
+    data?: {
+        downloadUrl?: string | null;
+    };
+    error?: string;
+};
+export type ReportAggregationOptions = {
+    companyId: string;
+    startDate: Date;
+    endDate: Date;
+    digitalTopN?: number;
+    includeGeoData?: boolean;
+};

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

@@ -0,0 +1,6 @@
+"use strict";
+/**
+ * Report API Type Definitions
+ * 掃描報告 API 接口定義
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -29,9 +29,9 @@ export interface Scan {
     createdAt: Date;
     tagId: string;
     generalUserId: string;
-    isVisitedPromo: Boolean;
-    isVisitedShop: Boolean;
-    isVisitedExplore: Boolean;
+    isVisitedPromo: boolean;
+    isVisitedShop: boolean;
+    isVisitedExplore: boolean;
     exploreLink?: string;
     digitalCustomizationId: string;
     promoLink?: string;
@@ -50,3 +50,11 @@ export type DataWithDate = {
     date: string;
     value: number;
 };
+export type AtlasSyncOperation = 'insert' | 'update' | 'replace';
+export interface VisitFlagSyncPayload {
+    id: string;
+    operation?: AtlasSyncOperation;
+    isVisitedPromo?: boolean;
+    isVisitedShop?: boolean;
+    isVisitedExplore?: boolean;
+}

package/package.json

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