@tachybase/module-instrumentation 1.2.6 → 1.2.8

package/dist/client/schemas/createHistoryConfig.d.ts

@@ -0,0 +1,2 @@
+import { ISchema } from '@tachybase/schema';
+export declare const createHistoryConfig: ISchema;

package/dist/client/schemas/schemaHistoryConfigs.d.ts

@@ -0,0 +1,2 @@
+import { ISchema } from '@tachybase/schema';
+export declare const schemaHistoryConfigs: ISchema;

package/dist/client/schemas/schemaStatisticsDetails.d.ts

@@ -0,0 +1,2 @@
+import { ISchema } from '@tachybase/schema';
+export declare const schemaStatisticsQuery: ISchema;

package/dist/client/schemas/updateHistoryConfig.d.ts

@@ -0,0 +1,2 @@
+import { ISchema } from '@tachybase/schema';
+export declare const updateHistoryConfig: ISchema;

package/dist/client/statisticsHistorical.d.ts

@@ -0,0 +1 @@
+export declare const statisticsHistoricalPane: () => import("react/jsx-runtime").JSX.Element;

package/dist/externalVersion.js

@@ -1,12 +1,14 @@
 module.exports = {
-  "@tachybase/client": "1.2.6",
-  "antd": "5.22.5",
   "react": "18.3.1",
+  "@tachybase/client": "1.2.8",
+  "@tachybase/components": "1.2.8",
+  "@tachybase/schema": "1.2.8",
+  "antd": "5.22.5",
+  "@ant-design/icons": "6.0.0",
   "lodash": "4.17.21",
-  "@tachybase/database": "1.2.6",
-  "@tachybase/actions": "1.2.6",
-  "@tachybase/server": "1.2.6",
-  "@tachybase/schema": "1.2.6",
-  "@tachybase/utils": "1.2.6",
-  "dayjs": "1.11.13"
+  "@tachybase/database": "1.2.8",
+  "@tachybase/actions": "1.2.8",
+  "@tachybase/server": "1.2.8",
+  "dayjs": "1.11.13",
+  "@tachybase/utils": "1.2.8"
 };

package/dist/locale/zh-CN.json

@@ -1,19 +1,45 @@
 {
   "Action": "API操作",
+  "Add condition": "添加条件",
+  "After": "在此之后",
+  "All": "全部",
   "All users": "总用户数",
+  "Any": "任意",
   "Api audit": "启用日志",
+  "Before": "在此之前",
+  "Conditions": "条件",
   "Custom Instrumentation": "自定义埋点",
+  "Instrumentation filter": "埋点筛选",
   "Instrumentation key": "埋点键",
   "Instrumentation log": "埋点日志",
   "Instrumentation type": "埋点类型",
   "Instrumentation values": "值",
+  "Meet": "满足",
+  "Meta": "元数据",
+  "On": "在某天",
+  "On today": "今日",
   "Other users": "其他用户",
+  "Payload": "自定义数据",
+  "RangeDays": "近N天",
+  "Refresh": "刷新",
   "Resource name": "API资源",
   "Server tracking configuration": "后端埋点配置",
+  "Statistics Historical": "历史数据分析",
+  "Statistics details": "日志查询",
   "Statistics options": "数据来源",
   "Statistics title": "数据标题",
+  "Time filter": "时间筛选",
   "Today active": "今日活跃",
   "Total Users": "总用户",
   "Tracking options": "埋点配置",
-  "Tracking statistics": "埋点分析"
+  "Tracking statistics": "埋点分析",
+  "equals": "等于",
+  "exists": "存在",
+  "greater than": "大于",
+  "greater than or equal": "大于等于",
+  "includes": "包含",
+  "is null": "为空",
+  "less than": "小于",
+  "less than or equal": "小于等于",
+  "not equals": "不等于"
 }

package/dist/server/actions/tracking-controller.d.ts

@@ -2,4 +2,5 @@ import { Context } from '@tachybase/actions';
 export declare class TrackingController {
     create(ctx: Context, next: () => Promise<any>): Promise<any>;
     list(ctx: Context, next: () => Promise<any>): Promise<any>;
+    query(ctx: Context, next: () => Promise<any>): Promise<any>;
 }

package/dist/server/actions/tracking-controller.js

@@ -67,9 +67,10 @@ __export(tracking_controller_exports, {
 module.exports = __toCommonJS(tracking_controller_exports);
 var import_utils = require("@tachybase/utils");
 var import_getActiveUser = require("../hooks/getActiveUser");
+var import_getQueryResult = require("../hooks/getQueryResult");
 var import_getStatistics = require("../hooks/getStatistics");
-var _list_dec, _create_dec, _TrackingController_decorators, _init;
-_TrackingController_decorators = [(0, import_utils.Controller)("instrumentation")], _create_dec = [(0, import_utils.Action)("create", { acl: "public" })], _list_dec = [(0, import_utils.Action)("list", { acl: "private" })];
+var _query_dec, _list_dec, _create_dec, _TrackingController_decorators, _init;
+_TrackingController_decorators = [(0, import_utils.Controller)("instrumentation")], _create_dec = [(0, import_utils.Action)("create", { acl: "public" })], _list_dec = [(0, import_utils.Action)("list", { acl: "private" })], _query_dec = [(0, import_utils.Action)("query", { acl: "private" })];
 class TrackingController {
   constructor() {
     __runInitializers(_init, 5, this);
@@ -99,22 +100,47 @@ class TrackingController {
     return next();
   }
   async list(ctx, next) {
-    var _a;
+    var _a, _b, _c;
     const userCount = await ctx.db.getRepository("users").count();
     const ActiveUsers = await (0, import_getActiveUser.getDailyActiveUser)(ctx);
     const allData = await ctx.db.getRepository("trackingEvents").find();
     const configs = await ctx.db.getRepository("statisticsConfig").find();
+    const historyConfigs = await ctx.db.getRepository("trackingHistoryOptions").find();
     let customData = {};
     let customDataByTime = {};
     for (const config of configs) {
-      if ((_a = config.statisticsOptions) == null ? void 0 : _a.timeGroup) {
-        const grouped = (0, import_getStatistics.groupDataByTime)(allData, config.statisticsOptions);
-        customDataByTime[config.title] = grouped;
+      if ((_a = config.statisticsOptions) == null ? void 0 : _a.collection) {
+        try {
+          const collectionName = config.statisticsOptions.collection.trim();
+          if (!collectionName) {
+            throw new Error("Collection name is empty or invalid.");
+          }
+          const collectionFilter = config.statisticsOptions.collectionFilter;
+          if (collectionFilter && typeof collectionFilter !== "object") {
+            throw new Error("Collection filter is invalid. It must be an object.");
+          }
+          const count = await ctx.db.getRepository(collectionName).count({
+            filter: collectionFilter || {}
+          });
+          customData[config.title] = count;
+        } catch (error) {
+          console.error(
+            `Error fetching count for collection "${(_b = config.statisticsOptions) == null ? void 0 : _b.collection}":`,
+            error.message
+          );
+          customData[config.title] = 0;
+        }
       } else {
         const count = (0, import_getStatistics.countDataByEventFrequency)(allData, config.statisticsOptions);
         customData[config.title] = count;
       }
     }
+    for (const historyConfig of historyConfigs) {
+      if ((_c = historyConfig.historyOptions) == null ? void 0 : _c.timeGroup) {
+        const grouped = (0, import_getStatistics.groupDataByTime)(allData, historyConfig.historyOptions);
+        customDataByTime[historyConfig.title] = grouped;
+      }
+    }
     const result = {
       users: { ...ActiveUsers, userCount },
       customData,
@@ -123,10 +149,18 @@ class TrackingController {
     ctx.body = result;
     return next();
   }
+  async query(ctx, next) {
+    const { values: configs } = ctx.action.params;
+    const allData = await ctx.db.getRepository("trackingEvents").find();
+    const queryResult = (0, import_getQueryResult.getDataByEventFrequency)(allData, configs);
+    ctx.body = queryResult;
+    return next();
+  }
 }
 _init = __decoratorStart(null);
 __decorateElement(_init, 1, "create", _create_dec, TrackingController);
 __decorateElement(_init, 1, "list", _list_dec, TrackingController);
+__decorateElement(_init, 1, "query", _query_dec, TrackingController);
 TrackingController = __decorateElement(_init, 0, "TrackingController", _TrackingController_decorators, TrackingController);
 __runInitializers(_init, 1, TrackingController);
 // Annotate the CommonJS export names for ESM import in node:

package/dist/server/collections/history_config.d.ts

@@ -0,0 +1,3 @@
+import { CollectionOptions } from '@tachybase/database';
+declare const _default: CollectionOptions;
+export default _default;

package/dist/server/collections/history_config.js

@@ -0,0 +1,44 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var history_config_exports = {};
+__export(history_config_exports, {
+  default: () => history_config_default
+});
+module.exports = __toCommonJS(history_config_exports);
+var history_config_default = {
+  dumpRules: {
+    group: "log"
+  },
+  name: "trackingHistoryOptions",
+  createdBy: false,
+  updatedBy: false,
+  updatedAt: false,
+  createdAt: false,
+  shared: true,
+  model: "CollectionModel",
+  fields: [
+    {
+      type: "string",
+      name: "title"
+    },
+    {
+      type: "jsonb",
+      name: "historyOptions"
+    }
+  ]
+};

package/dist/server/hooks/afterAction.js

@@ -22,7 +22,7 @@ __export(afterAction_exports, {
 module.exports = __toCommonJS(afterAction_exports);
 var import_filterMatch = require("./filterMatch");
 async function handleOtherAction(ctx, next, whiteList) {
-  var _a, _b, _c, _d, _e, _f, _g;
+  var _a, _b, _c, _d, _e, _f, _g, _h, _i;
   const { actionName, resourceName, params } = ctx.action;
   const data = ((_a = ctx.response) == null ? void 0 : _a.body) || null;
   const repo = ctx.db.getRepository("trackingEvents");
@@ -63,10 +63,12 @@ async function handleOtherAction(ctx, next, whiteList) {
     const currentRecordId = ((_e = ctx.body) == null ? void 0 : _e[collection == null ? void 0 : collection.filterTargetKey]) || null;
     const currentUserId = ((_g = (_f = ctx.auth) == null ? void 0 : _f.user) == null ? void 0 : _g.id) || null;
     const currentTime = (/* @__PURE__ */ new Date()).toISOString();
+    const currentUserDevice = ((_i = (_h = ctx.req) == null ? void 0 : _h.headers) == null ? void 0 : _i["user-agent"]) || null;
     const baseValues = {};
     if (configKeys.meta.includes("userId")) baseValues.userId = currentUserId;
     if (configKeys.meta.includes("recordId")) baseValues.recordId = currentRecordId;
     if (configKeys.meta.includes("createdAt")) baseValues.createdAt = currentTime;
+    if (configKeys.meta.includes("user-agent")) baseValues.userAgent = currentUserDevice;
     const nestedValuesMap = findValuesByKeys({ params, data }, configKeys.payload);
     const finalValues = {
       meta: baseValues,

package/dist/server/hooks/getQueryResult.d.ts

@@ -0,0 +1,13 @@
+type FilterConfig = {
+    key: string | string[];
+    filterValues?: Record<string, any>;
+    timeFilter?: {
+        after?: string;
+        before?: string;
+        on?: string;
+        today?: true;
+        rangeDays?: number;
+    };
+};
+export declare function getDataByEventFrequency(data: any[], config: FilterConfig): any;
+export {};

package/dist/server/hooks/getQueryResult.js

@@ -0,0 +1,88 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var getQueryResult_exports = {};
+__export(getQueryResult_exports, {
+  getDataByEventFrequency: () => getDataByEventFrequency
+});
+module.exports = __toCommonJS(getQueryResult_exports);
+var import_dayjs = __toESM(require("dayjs"));
+var import_filterMatch = require("./filterMatch");
+function isSameDay(date1, date2) {
+  return date1.getFullYear() === date2.getFullYear() && date1.getMonth() === date2.getMonth() && date1.getDate() === date2.getDate();
+}
+function getDataByEventFrequency(data, config) {
+  const { key: filterKey, filterValues = {}, timeFilter } = config;
+  const matchKey = (itemKey) => {
+    if (Array.isArray(filterKey)) return filterKey.includes(itemKey);
+    return itemKey === filterKey;
+  };
+  const matchesTime = (item) => {
+    if (!timeFilter) return true;
+    const raw = item.createdAt;
+    if (!raw) return false;
+    const time = new Date(raw);
+    if (isNaN(time.getTime())) return false;
+    const now = /* @__PURE__ */ new Date();
+    if (timeFilter.rangeDays !== void 0) {
+      const start = (0, import_dayjs.default)().subtract(timeFilter.rangeDays - 1, "day").startOf("day").toDate();
+      const end = (0, import_dayjs.default)().endOf("day").toDate();
+      return time >= start && time <= end;
+    }
+    if (timeFilter.today) {
+      return isSameDay(time, /* @__PURE__ */ new Date());
+    }
+    if (timeFilter.on) {
+      const target = new Date(timeFilter.on);
+      if (isNaN(target.getTime())) return false;
+      return isSameDay(time, target);
+    }
+    if (timeFilter.after) {
+      const after = new Date(timeFilter.after);
+      if (isNaN(after.getTime())) return false;
+      if (time < after) return false;
+    }
+    if (timeFilter.before) {
+      const before = new Date(timeFilter.before);
+      if (isNaN(before.getTime())) return false;
+      if (time > before) return false;
+    }
+    return true;
+  };
+  const groupMap = [];
+  for (const item of data) {
+    if (!matchKey(item.key)) continue;
+    if (!(0, import_filterMatch.filterMatch)(item.values, filterValues)) continue;
+    if (!matchesTime(item)) continue;
+    groupMap.push(item);
+  }
+  return groupMap;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  getDataByEventFrequency
+});

package/dist/server/hooks/getStatistics.js

@@ -32,6 +32,7 @@ __export(getStatistics_exports, {
 });
 module.exports = __toCommonJS(getStatistics_exports);
 var import_dayjs = __toESM(require("dayjs"));
+var import_filterMatch = require("./filterMatch");
 function getValueByPath(obj, path) {
   return path.split(".").reduce((acc, key) => acc == null ? void 0 : acc[key], obj);
 }
@@ -45,9 +46,6 @@ function countDataByEventFrequency(data, config) {
     if (Array.isArray(filterKey)) return filterKey.includes(itemKey);
     return itemKey === filterKey;
   };
-  const matchesValues = (values) => {
-    return Object.entries(filterValues).every(([k, v]) => values[k] === v);
-  };
   const matchesTime = (item) => {
     if (!timeFilter) return true;
     const raw = item.createdAt;
@@ -83,7 +81,7 @@ function countDataByEventFrequency(data, config) {
   const groupMap = {};
   for (const item of data) {
     if (!matchKey(item.key)) continue;
-    if (!matchesValues(item.values)) continue;
+    if (!(0, import_filterMatch.filterMatch)(item.values, filterValues)) continue;
     if (!matchesTime(item)) continue;
     const key = dedupBy ? getValueByPath(item.values, dedupBy) : "__no_dedup__";
     if (!key) continue;

package/dist/server/plugin.js

@@ -96,7 +96,7 @@ class ModuleInstrumentationServer extends (_a = import_server.Plugin) {
             resourceName: "auth",
             action: "signIn",
             trackingOptions: {
-              meta: ["userId", "recordId", "createdAt"],
+              meta: ["userId", "recordId", "createdAt", "user-agent"],
               filter: {
                 $and: [
                   {
@@ -108,7 +108,7 @@ class ModuleInstrumentationServer extends (_a = import_server.Plugin) {
                   }
                 ]
               },
-              payload: ["errors", "account"]
+              payload: ["errors", "account", "phone"]
             }
           }
         });
@@ -136,7 +136,7 @@ class ModuleInstrumentationServer extends (_a = import_server.Plugin) {
       this.addServerTrackingListener();
     }
     this.app.acl.allow("instrumentation", "create", "public");
-    this.app.acl.allow("instrumentation", "list", "loggedIn");
+    this.app.acl.allow("instrumentation", ["list", "query"], "loggedIn");
     this.app.acl.registerSnippet({
       name: `pm.system-services.custom-instrumentation.clientTracking`,
       actions: ["trackingEvents:*"]
@@ -149,6 +149,14 @@ class ModuleInstrumentationServer extends (_a = import_server.Plugin) {
       name: `pm.system-services.custom-instrumentation.trackingStatistics`,
       actions: ["statisticsConfig:*"]
     });
+    this.app.acl.registerSnippet({
+      name: `pm.system-services.custom-instrumentation.statisticsDetails`,
+      actions: ["instrumentation:*"]
+    });
+    this.app.acl.registerSnippet({
+      name: `pm.system-services.custom-instrumentation.statisticsHistorical`,
+      actions: ["trackingHistoryOptions:*"]
+    });
   }
 }
 _init = __decoratorStart(_a);

package/package.json

@@ -1,26 +1,28 @@
 {
   "name": "@tachybase/module-instrumentation",
   "displayName": "Custom instrumentation",
-  "version": "1.2.6",
+  "version": "1.2.8",
   "description": "A module for tracking and instrumentation in Tachybase.",
   "keywords": [
     "Logging and monitoring"
   ],
   "main": "dist/server/index.js",
   "devDependencies": {
+    "@ant-design/icons": "^6.0.0",
     "@antv/g2": "^5.3.0",
     "antd": "5.22.5",
     "dayjs": "1.11.13",
     "lodash": "^4.17.21"
   },
   "peerDependencies": {
-    "@tachybase/actions": "1.2.6",
-    "@tachybase/client": "1.2.6",
-    "@tachybase/database": "1.2.6",
-    "@tachybase/schema": "1.2.6",
-    "@tachybase/test": "1.2.6",
-    "@tachybase/utils": "1.2.6",
-    "@tachybase/server": "1.2.6"
+    "@tachybase/actions": "1.2.8",
+    "@tachybase/client": "1.2.8",
+    "@tachybase/components": "1.2.8",
+    "@tachybase/database": "1.2.8",
+    "@tachybase/schema": "1.2.8",
+    "@tachybase/test": "1.2.8",
+    "@tachybase/utils": "1.2.8",
+    "@tachybase/server": "1.2.8"
   },
   "description.zh-CN": "Tachybase 应用的追踪和埋点模块",
   "displayName.zh-CN": "埋点追踪"