@ohbug/core 2.1.1 → 2.2.0

package/dist/index.d.mts

@@ -0,0 +1,29 @@
+import { OhbugClientConstructor, OhbugEventWithMethods, OhbugExtension } from '@ohbug/types';
+
+declare const Client: OhbugClientConstructor;
+
+declare function isEvent(eventLike: any): eventLike is OhbugEventWithMethods<any>;
+
+declare function defineExtension(extension: OhbugExtension): OhbugExtension;
+
+declare const enum EventTypes {
+    UNCAUGHT_ERROR = "uncaughtError",
+    RESOURCE_ERROR = "resourceError",
+    UNHANDLEDREJECTION_ERROR = "unhandledrejectionError",
+    AJAX_ERROR = "ajaxError",
+    FETCH_ERROR = "fetchError",
+    WEBSOCKET_ERROR = "websocketError",
+    UNKNOWN_ERROR = "unknownError",
+    MESSAGE = "message",
+    FEEDBACK = "feedback",
+    VIEW = "view",
+    REACT = "react",
+    VUE = "vue",
+    ANGULAR = "angular",
+    MINIAPP_ERROR = "miniappError",
+    MINIAPP_UNHANDLEDREJECTION_ERROR = "miniappUnhandledrejectionError",
+    MINIAPP_PAGENOTFOUND_ERROR = "miniappPagenotfoundError",
+    MINIAPP_MEMORYWARNING_ERROR = "miniappMemorywarningError"
+}
+
+export { Client, EventTypes, defineExtension, isEvent };

package/dist/index.js

@@ -51,6 +51,7 @@ var import_utils4 = require("@ohbug/utils");
 // src/config.ts
 var import_utils = require("@ohbug/utils");
 var schema = {
+  // base
   apiKey: {
     defaultValue: void 0,
     message: "is required",
@@ -79,8 +80,9 @@ var schema = {
   maxActions: {
     defaultValue: 30,
     message: "should be a number between 0 and 100",
-    validate: (value) => value === void 0 || (0, import_utils.isNumber)(value) && value >= 1 && value <= 100
+    validate: (value) => value === void 0 || (0, import_utils.isNumber)(value) && value >= 0 && value <= 100
   },
+  // hooks
   onEvent: {
     defaultValue: (event) => event,
     message: "should be a function",
@@ -92,6 +94,7 @@ var schema = {
     message: "should be a function",
     validate: (value) => value === void 0 || (0, import_utils.isFunction)(value)
   },
+  // utils
   logger: {
     defaultValue: import_utils.logger,
     message: "should be null or an object with methods { log, info, warn, error }",
@@ -100,6 +103,7 @@ var schema = {
       true
     )
   },
+  // data
   user: {
     defaultValue: void 0,
     message: "should be an object and have up to 6 attributes",
@@ -123,7 +127,7 @@ var Action = class {
     __publicField(this, "message");
     __publicField(this, "data");
     this.type = type;
-    this.timestamp = timestamp || new Date().toISOString();
+    this.timestamp = timestamp || (/* @__PURE__ */ new Date()).toISOString();
     this.message = message;
     this.data = data;
   }
@@ -211,6 +215,17 @@ var Event = class {
   get __isOhbugEvent() {
     return true;
   }
+  /**
+   * Add an action.
+   * Once the threshold is reached, the oldest actions will be deleted.
+   * 新增一个动作。
+   * 一旦达到阈值，最老的 Action 将被删除。
+   *
+   * @param message
+   * @param data
+   * @param type
+   * @param timestamp
+   */
   addAction(message, data, type, timestamp) {
     var _a, _b;
     const actions = this.actions;
@@ -218,14 +233,25 @@ var Event = class {
     const targetData = data || {};
     const targetType = (0, import_utils2.isString)(type) ? type : "";
     const action = new Action(targetMessage, targetData, targetType, timestamp);
-    if (actions.length >= ((_b = (_a = this.__client) == null ? void 0 : _a.__config.maxActions) != null ? _b : 30)) {
-      actions.shift();
+    const maxActions = (_b = (_a = this.__client) == null ? void 0 : _a.__config.maxActions) != null ? _b : 30;
+    if (maxActions > 0) {
+      if (actions.length >= maxActions) {
+        actions.shift();
+      }
+      actions.push(action);
     }
-    actions.push(action);
   }
+  /**
+   * Get current user information
+   * 获取当前的用户信息
+   */
   getUser() {
     return this.user;
   }
+  /**
+   * Set current user information
+   * 设置当前的用户信息
+   */
   setUser(user) {
     var _a;
     if ((0, import_utils2.isObject)(user) && Object.keys(user).length <= 6) {
@@ -238,12 +264,31 @@ var Event = class {
     ));
     return void 0;
   }
+  /**
+   * Add metadata
+   * 新增 metadata
+   *
+   * @param section
+   * @param data
+   */
   addMetadata(section, data) {
     return addMetadata(this.metadata, section, data);
   }
+  /**
+   * Get metadata
+   * 获取 metadata
+   *
+   * @param section
+   */
   getMetadata(section) {
     return getMetadata(this.metadata, section);
   }
+  /**
+   * Delete metadata
+   * 删除 metadata
+   *
+   * @param section
+   */
   deleteMetadata(section) {
     return deleteMetadata(this.metadata, section);
   }
@@ -282,7 +327,7 @@ var Event = class {
 };
 function createEvent(values, client) {
   const { apiKey, appVersion, appType, releaseStage } = client.__config;
-  const timestamp = new Date().toISOString();
+  const timestamp = (/* @__PURE__ */ new Date()).toISOString();
   const device = client.__device(client);
   let category;
   let type;
@@ -390,13 +435,15 @@ var Client = class Client2 {
     config: baseConfig,
     schema: schema2 = schema,
     device,
-    notifier
+    notifier,
+    destroy
   }) {
     __publicField(this, "__sdk");
     __publicField(this, "__config");
     __publicField(this, "__logger");
     __publicField(this, "__device");
     __publicField(this, "__notifier");
+    __publicField(this, "__destroy");
     __publicField(this, "__extensions");
     __publicField(this, "__actions");
     __publicField(this, "__user");
@@ -407,6 +454,7 @@ var Client = class Client2 {
     this.__logger = config.logger;
     this.__device = device;
     this.__notifier = notifier;
+    this.__destroy = destroy;
     this.__extensions = [];
     this.__actions = [];
     this.__user = config.user;
@@ -420,16 +468,47 @@ var Client = class Client2 {
       this.__logger.warn(getConfigErrorMessage(errors, baseConfig));
     }
   }
+  /**
+   * Load extension
+   * 加载扩展
+   *
+   * @param extension
+   */
   use(extension) {
     var _a;
     this.__extensions.push(extension);
     (_a = extension.onSetup) == null ? void 0 : _a.call(extension, this);
     return this;
   }
+  destroy() {
+    var _a;
+    if (this.__destroy) {
+      this.__logger.info(
+        "%c @ohbug/core %c has been destroyed %c",
+        "background:#333; padding: 2px 1px; color: #FFF",
+        "background:#FF6F61; padding: 2px 1px; color: #FFF",
+        "background:transparent"
+      );
+      return (_a = this.__destroy) == null ? void 0 : _a.call(this);
+    }
+  }
+  /**
+   * Create an event, you will get a data body containing device actions and other information
+   * 创建事件，将会得到一个含有 device actions 等信息的数据体
+   *
+   * @param value
+   */
   createEvent(value) {
     const event = createEvent(value, this);
     return handleEventCreated(event, this);
   }
+  /**
+   * Used to trigger the reporting interface
+   * 用于触发上报接口
+   *
+   * @param eventLike
+   * @param beforeNotify
+   */
   notify(eventLike, beforeNotify) {
     let event;
     if (Boolean(eventLike) && !isEvent(eventLike)) {
@@ -441,20 +520,43 @@ var Client = class Client2 {
       event = beforeNotify(event);
     return notify(event, this);
   }
+  /**
+   * Add an action.
+   * Once the threshold is reached, the oldest actions will be deleted.
+   * 新增一个动作。
+   * 一旦达到阈值，最老的 Action 将被删除。
+   *
+   * @param message
+   * @param data
+   * @param type
+   * @param timestamp
+   */
   addAction(message, data, type, timestamp) {
+    var _a;
     const actions = this.__actions;
     const targetMessage = (0, import_utils4.isString)(message) ? message : "";
     const targetData = data || {};
     const targetType = (0, import_utils4.isString)(type) ? type : "";
     const action = new Action(targetMessage, targetData, targetType, timestamp);
-    if (actions.length >= this.__config.maxActions) {
-      actions.shift();
+    const maxActions = (_a = this.__config.maxActions) != null ? _a : 30;
+    if (maxActions > 0) {
+      if (actions.length >= maxActions) {
+        actions.shift();
+      }
+      actions.push(action);
     }
-    actions.push(action);
   }
+  /**
+   * Get current user information
+   * 获取当前的用户信息
+   */
   getUser() {
     return this.__user;
   }
+  /**
+   * Set current user information
+   * 设置当前的用户信息
+   */
   setUser(user) {
     if ((0, import_utils4.isObject)(user) && Object.keys(user).length <= 6) {
       this.__user = __spreadValues(__spreadValues({}, this.__user), user);
@@ -466,12 +568,31 @@ var Client = class Client2 {
     ));
     return void 0;
   }
+  /**
+   * Add metadata
+   * 新增 metadata
+   *
+   * @param section
+   * @param data
+   */
   addMetadata(section, data) {
     return addMetadata(this.__metadata, section, data);
   }
+  /**
+   * Get metadata
+   * 获取 metadata
+   *
+   * @param section
+   */
   getMetadata(section) {
     return getMetadata(this.__metadata, section);
   }
+  /**
+   * Delete metadata
+   * 删除 metadata
+   *
+   * @param section
+   */
   deleteMetadata(section) {
     return deleteMetadata(this.__metadata, section);
   }

package/dist/index.mjs

@@ -25,6 +25,7 @@ import { isObject as isObject3, isString as isString3 } from "@ohbug/utils";
 // src/config.ts
 import { isFunction, isNumber, isObject, isString, logger } from "@ohbug/utils";
 var schema = {
+  // base
   apiKey: {
     defaultValue: void 0,
     message: "is required",
@@ -53,8 +54,9 @@ var schema = {
   maxActions: {
     defaultValue: 30,
     message: "should be a number between 0 and 100",
-    validate: (value) => value === void 0 || isNumber(value) && value >= 1 && value <= 100
+    validate: (value) => value === void 0 || isNumber(value) && value >= 0 && value <= 100
   },
+  // hooks
   onEvent: {
     defaultValue: (event) => event,
     message: "should be a function",
@@ -66,6 +68,7 @@ var schema = {
     message: "should be a function",
     validate: (value) => value === void 0 || isFunction(value)
   },
+  // utils
   logger: {
     defaultValue: logger,
     message: "should be null or an object with methods { log, info, warn, error }",
@@ -74,6 +77,7 @@ var schema = {
       true
     )
   },
+  // data
   user: {
     defaultValue: void 0,
     message: "should be an object and have up to 6 attributes",
@@ -97,7 +101,7 @@ var Action = class {
     __publicField(this, "message");
     __publicField(this, "data");
     this.type = type;
-    this.timestamp = timestamp || new Date().toISOString();
+    this.timestamp = timestamp || (/* @__PURE__ */ new Date()).toISOString();
     this.message = message;
     this.data = data;
   }
@@ -185,6 +189,17 @@ var Event = class {
   get __isOhbugEvent() {
     return true;
   }
+  /**
+   * Add an action.
+   * Once the threshold is reached, the oldest actions will be deleted.
+   * 新增一个动作。
+   * 一旦达到阈值，最老的 Action 将被删除。
+   *
+   * @param message
+   * @param data
+   * @param type
+   * @param timestamp
+   */
   addAction(message, data, type, timestamp) {
     var _a, _b;
     const actions = this.actions;
@@ -192,14 +207,25 @@ var Event = class {
     const targetData = data || {};
     const targetType = isString2(type) ? type : "";
     const action = new Action(targetMessage, targetData, targetType, timestamp);
-    if (actions.length >= ((_b = (_a = this.__client) == null ? void 0 : _a.__config.maxActions) != null ? _b : 30)) {
-      actions.shift();
+    const maxActions = (_b = (_a = this.__client) == null ? void 0 : _a.__config.maxActions) != null ? _b : 30;
+    if (maxActions > 0) {
+      if (actions.length >= maxActions) {
+        actions.shift();
+      }
+      actions.push(action);
     }
-    actions.push(action);
   }
+  /**
+   * Get current user information
+   * 获取当前的用户信息
+   */
   getUser() {
     return this.user;
   }
+  /**
+   * Set current user information
+   * 设置当前的用户信息
+   */
   setUser(user) {
     var _a;
     if (isObject2(user) && Object.keys(user).length <= 6) {
@@ -212,12 +238,31 @@ var Event = class {
     ));
     return void 0;
   }
+  /**
+   * Add metadata
+   * 新增 metadata
+   *
+   * @param section
+   * @param data
+   */
   addMetadata(section, data) {
     return addMetadata(this.metadata, section, data);
   }
+  /**
+   * Get metadata
+   * 获取 metadata
+   *
+   * @param section
+   */
   getMetadata(section) {
     return getMetadata(this.metadata, section);
   }
+  /**
+   * Delete metadata
+   * 删除 metadata
+   *
+   * @param section
+   */
   deleteMetadata(section) {
     return deleteMetadata(this.metadata, section);
   }
@@ -256,7 +301,7 @@ var Event = class {
 };
 function createEvent(values, client) {
   const { apiKey, appVersion, appType, releaseStage } = client.__config;
-  const timestamp = new Date().toISOString();
+  const timestamp = (/* @__PURE__ */ new Date()).toISOString();
   const device = client.__device(client);
   let category;
   let type;
@@ -364,13 +409,15 @@ var Client = class Client2 {
     config: baseConfig,
     schema: schema2 = schema,
     device,
-    notifier
+    notifier,
+    destroy
   }) {
     __publicField(this, "__sdk");
     __publicField(this, "__config");
     __publicField(this, "__logger");
     __publicField(this, "__device");
     __publicField(this, "__notifier");
+    __publicField(this, "__destroy");
     __publicField(this, "__extensions");
     __publicField(this, "__actions");
     __publicField(this, "__user");
@@ -381,6 +428,7 @@ var Client = class Client2 {
     this.__logger = config.logger;
     this.__device = device;
     this.__notifier = notifier;
+    this.__destroy = destroy;
     this.__extensions = [];
     this.__actions = [];
     this.__user = config.user;
@@ -394,16 +442,47 @@ var Client = class Client2 {
       this.__logger.warn(getConfigErrorMessage(errors, baseConfig));
     }
   }
+  /**
+   * Load extension
+   * 加载扩展
+   *
+   * @param extension
+   */
   use(extension) {
     var _a;
     this.__extensions.push(extension);
     (_a = extension.onSetup) == null ? void 0 : _a.call(extension, this);
     return this;
   }
+  destroy() {
+    var _a;
+    if (this.__destroy) {
+      this.__logger.info(
+        "%c @ohbug/core %c has been destroyed %c",
+        "background:#333; padding: 2px 1px; color: #FFF",
+        "background:#FF6F61; padding: 2px 1px; color: #FFF",
+        "background:transparent"
+      );
+      return (_a = this.__destroy) == null ? void 0 : _a.call(this);
+    }
+  }
+  /**
+   * Create an event, you will get a data body containing device actions and other information
+   * 创建事件，将会得到一个含有 device actions 等信息的数据体
+   *
+   * @param value
+   */
   createEvent(value) {
     const event = createEvent(value, this);
     return handleEventCreated(event, this);
   }
+  /**
+   * Used to trigger the reporting interface
+   * 用于触发上报接口
+   *
+   * @param eventLike
+   * @param beforeNotify
+   */
   notify(eventLike, beforeNotify) {
     let event;
     if (Boolean(eventLike) && !isEvent(eventLike)) {
@@ -415,20 +494,43 @@ var Client = class Client2 {
       event = beforeNotify(event);
     return notify(event, this);
   }
+  /**
+   * Add an action.
+   * Once the threshold is reached, the oldest actions will be deleted.
+   * 新增一个动作。
+   * 一旦达到阈值，最老的 Action 将被删除。
+   *
+   * @param message
+   * @param data
+   * @param type
+   * @param timestamp
+   */
   addAction(message, data, type, timestamp) {
+    var _a;
     const actions = this.__actions;
     const targetMessage = isString3(message) ? message : "";
     const targetData = data || {};
     const targetType = isString3(type) ? type : "";
     const action = new Action(targetMessage, targetData, targetType, timestamp);
-    if (actions.length >= this.__config.maxActions) {
-      actions.shift();
+    const maxActions = (_a = this.__config.maxActions) != null ? _a : 30;
+    if (maxActions > 0) {
+      if (actions.length >= maxActions) {
+        actions.shift();
+      }
+      actions.push(action);
     }
-    actions.push(action);
   }
+  /**
+   * Get current user information
+   * 获取当前的用户信息
+   */
   getUser() {
     return this.__user;
   }
+  /**
+   * Set current user information
+   * 设置当前的用户信息
+   */
   setUser(user) {
     if (isObject3(user) && Object.keys(user).length <= 6) {
       this.__user = __spreadValues(__spreadValues({}, this.__user), user);
@@ -440,12 +542,31 @@ var Client = class Client2 {
     ));
     return void 0;
   }
+  /**
+   * Add metadata
+   * 新增 metadata
+   *
+   * @param section
+   * @param data
+   */
   addMetadata(section, data) {
     return addMetadata(this.__metadata, section, data);
   }
+  /**
+   * Get metadata
+   * 获取 metadata
+   *
+   * @param section
+   */
   getMetadata(section) {
     return getMetadata(this.__metadata, section);
   }
+  /**
+   * Delete metadata
+   * 删除 metadata
+   *
+   * @param section
+   */
   deleteMetadata(section) {
     return deleteMetadata(this.__metadata, section);
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ohbug/core",
-  "version": "2.1.1",
+  "version": "2.2.0",
   "description": "Responsible for managing Ohbug's workflow",
   "license": "Apache-2.0",
   "author": "chenyueban <jasonchan0527@gmail.com>",
@@ -30,8 +30,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@ohbug/types": "2.1.1",
-    "@ohbug/utils": "2.0.6"
+    "@ohbug/types": "2.2.0",
+    "@ohbug/utils": "2.0.7"
   },
   "scripts": {
     "build": "tsup",