@ohbug/core 2.0.0 → 2.0.3

package/dist/index.mjs

@@ -1,471 +1,5 @@
-var __defProp = Object.defineProperty;
-var __getOwnPropSymbols = Object.getOwnPropertySymbols;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __propIsEnum = Object.prototype.propertyIsEnumerable;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __spreadValues = (a, b) => {
-  for (var prop in b || (b = {}))
-    if (__hasOwnProp.call(b, prop))
-      __defNormalProp(a, prop, b[prop]);
-  if (__getOwnPropSymbols)
-    for (var prop of __getOwnPropSymbols(b)) {
-      if (__propIsEnum.call(b, prop))
-        __defNormalProp(a, prop, b[prop]);
-    }
-  return a;
-};
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-
-// src/client.ts
-import { isObject as isObject3, isString as isString3 } from "@ohbug/utils";
-
-// src/config.ts
-import { isFunction, isNumber, isObject, isString, logger } from "@ohbug/utils";
-var schema = {
-  apiKey: {
-    defaultValue: void 0,
-    message: "is required",
-    validate: (value) => Boolean(value) && isString(value)
-  },
-  appVersion: {
-    defaultValue: void 0,
-    message: "should be a string",
-    validate: (value) => value === void 0 || isString(value)
-  },
-  appType: {
-    defaultValue: void 0,
-    message: "should be a string",
-    validate: (value) => value === void 0 || isString(value)
-  },
-  releaseStage: {
-    defaultValue: "production",
-    message: "should be a string",
-    validate: (value) => value === void 0 || isString(value)
-  },
-  endpoint: {
-    defaultValue: "http://localhost:6660",
-    message: "should be a string",
-    validate: (value) => value === void 0 || isString(value)
-  },
-  maxActions: {
-    defaultValue: 30,
-    message: "should be a number between 0 and 100",
-    validate: (value) => value === void 0 || isNumber(value) && value >= 1 && value <= 100
-  },
-  created: {
-    defaultValue: (event) => event,
-    message: "should be a function",
-    validate: (value) => value === void 0 || isFunction(value)
-  },
-  notified: {
-    defaultValue: () => {
-    },
-    message: "should be a function",
-    validate: (value) => value === void 0 || isFunction(value)
-  },
-  logger: {
-    defaultValue: logger,
-    message: "should be null or an object with methods { log, info, warn, error }",
-    validate: (value) => value === void 0 || value && ["log", "info", "warn", "error"].reduce((accumulator, method) => accumulator && typeof value[method] === "function", true)
-  },
-  user: {
-    defaultValue: void 0,
-    message: "should be an object and have up to 6 attributes",
-    validate: (value) => value === void 0 || isObject(value) && Object.keys(value).length <= 6
-  },
-  metaData: {
-    defaultValue: void 0,
-    message: "should be an object",
-    validate: (value) => value === void 0 || isObject(value)
-  }
-};
-
-// src/event.ts
-import { isFunction as isFunction2, isObject as isObject2, isString as isString2 } from "@ohbug/utils";
-
-// src/action.ts
-var Action = class {
-  type;
-  timestamp;
-  message;
-  data;
-  constructor(message, data, type, timestamp) {
-    this.type = type;
-    this.timestamp = timestamp || new Date().toISOString();
-    this.message = message;
-    this.data = data;
-  }
-};
-
-// src/lib/getErrorMessage.ts
-function getConfigErrorMessage(errors, config) {
-  return new Error(`Invalid configuration
-${Object.keys(errors).map((key) => {
-    return `- ${key} ${errors[key]}, got ${JSON.stringify(config[key])}`;
-  }).join("\n")}
-      `);
-}
-function getErrorMessage(message, data) {
-  return new Error(`Invalid data
-- ${message}, got ${JSON.stringify(data)}`);
-}
-
-// src/lib/metaData.ts
-function addMetaData(map, section, data) {
-  if (!section)
-    return;
-  map[section] = data;
-}
-function getMetaData(map, section) {
-  if (map[section])
-    return map[section];
-  return void 0;
-}
-function deleteMetaData(map, section) {
-  if (map[section])
-    return delete map[section];
-  return void 0;
-}
-
-// src/event.ts
-var Event = class {
-  apiKey;
-  appVersion;
-  appType;
-  timestamp;
-  category;
-  type;
-  sdk;
-  device;
-  detail;
-  user;
-  actions;
-  metaData;
-  releaseStage;
-  __client;
-  constructor(values, client) {
-    const {
-      apiKey,
-      appVersion,
-      appType,
-      releaseStage,
-      timestamp,
-      category,
-      type,
-      sdk,
-      detail,
-      device,
-      user,
-      actions,
-      metaData
-    } = values;
-    this.apiKey = apiKey;
-    this.appVersion = appVersion;
-    this.appType = appType;
-    this.releaseStage = releaseStage;
-    this.timestamp = timestamp;
-    this.category = category;
-    this.type = type;
-    this.sdk = sdk;
-    this.detail = detail;
-    this.device = device;
-    this.user = user;
-    this.actions = actions;
-    this.metaData = metaData != null ? metaData : {};
-    this.__client = client;
-  }
-  get __isOhbugEvent() {
-    return true;
-  }
-  addAction(message, data, type, timestamp) {
-    var _a, _b;
-    const actions = this.actions;
-    const targetMessage = isString2(message) ? message : "";
-    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();
-    actions.push(action);
-  }
-  getUser() {
-    return this.user;
-  }
-  setUser(user) {
-    var _a;
-    if (isObject2(user) && Object.keys(user).length <= 6) {
-      this.user = __spreadValues(__spreadValues({}, this.user), user);
-      return this.getUser();
-    }
-    (_a = this.__client) == null ? void 0 : _a.__logger.error(getErrorMessage("setUser should be an object and have up to 6 attributes", user));
-    return void 0;
-  }
-  addMetaData(section, data) {
-    return addMetaData(this.metaData, section, data);
-  }
-  getMetaData(section) {
-    return getMetaData(this.metaData, section);
-  }
-  deleteMetaData(section) {
-    return deleteMetaData(this.metaData, section);
-  }
-  toJSON() {
-    const {
-      apiKey,
-      appVersion,
-      appType,
-      timestamp,
-      category,
-      type,
-      sdk,
-      device,
-      detail,
-      user,
-      actions,
-      metaData,
-      releaseStage
-    } = this;
-    return {
-      apiKey,
-      appVersion,
-      appType,
-      timestamp,
-      category,
-      type,
-      sdk,
-      device,
-      detail,
-      user,
-      actions,
-      metaData,
-      releaseStage
-    };
-  }
-};
-function createEvent(values, client) {
-  const { apiKey, appVersion, appType, releaseStage } = client.__config;
-  const timestamp = new Date().toISOString();
-  const device = client.__device(client);
-  let category;
-  let type;
-  let detail;
-  if (isObject2(values) && Object.prototype.hasOwnProperty.call(values, "type") && Object.prototype.hasOwnProperty.call(values, "detail")) {
-    category = values.category || "error";
-    type = values.type;
-    detail = values.detail;
-  } else {
-    category = "error";
-    type = "unknownError";
-    detail = values;
-  }
-  return new Event({
-    apiKey,
-    appVersion,
-    appType,
-    timestamp,
-    category,
-    type,
-    sdk: client.__sdk,
-    device,
-    user: client.__user,
-    detail,
-    actions: client.__actions,
-    metaData: client.__metaData,
-    releaseStage
-  }, client);
-}
-function handleEventCreated(event, client) {
-  const funcs = [
-    client.__config.created,
-    ...client.__extensions.map(({ created }) => created)
-  ].filter((v) => isFunction2(v));
-  if (funcs.length === 0)
-    return event;
-  return funcs.reduce((previous, current) => {
-    if (previous && isFunction2(current))
-      return current(previous, client);
-    return null;
-  }, event);
-}
-function isEvent(eventLike) {
-  return Boolean(eventLike == null ? void 0 : eventLike.__isOhbugEvent);
-}
-
-// src/notify.ts
-import { isFunction as isFunction3 } from "@ohbug/utils";
-function handleNotified(event, client) {
-  const funcs = [
-    client.__config.notified,
-    ...client.__extensions.filter(({ notified }) => isFunction3(notified)).map(({ notified }) => notified)
-  ];
-  funcs.forEach((func) => func == null ? void 0 : func(event, client));
-}
-async function notify(event, client) {
-  try {
-    let result = null;
-    if (event) {
-      result = await client.__notifier(event);
-      handleNotified(event, client);
-    }
-    return result;
-  } catch (e) {
-    client.__logger.error(e);
-  }
-}
-
-// src/lib/verifyConfig.ts
-function verifyConfig(config, schema2) {
-  const keys = Object.keys(schema2);
-  return keys.reduce((accumulator, key) => {
-    const configValue = config[key];
-    const { defaultValue, message, validate } = schema2[key];
-    if (configValue !== void 0) {
-      const valid = validate(configValue);
-      if (valid) {
-        accumulator.config[key] = configValue;
-      } else {
-        accumulator.config[key] = defaultValue;
-        accumulator.errors[key] = message;
-      }
-    } else {
-      accumulator.config[key] = defaultValue;
-    }
-    return accumulator;
-  }, {
-    config: {},
-    errors: {}
-  });
-}
-
-// src/client.ts
-var Client = class Client2 {
-  __sdk;
-  __config;
-  __logger;
-  __device;
-  __notifier;
-  __extensions;
-  __actions;
-  __user;
-  __metaData;
-  constructor({
-    sdk,
-    config: baseConfig,
-    schema: schema2 = schema,
-    device,
-    notifier
-  }) {
-    const { config, errors } = verifyConfig(baseConfig, schema2);
-    this.__sdk = sdk;
-    this.__config = config;
-    this.__logger = config.logger;
-    this.__device = device;
-    this.__notifier = notifier;
-    this.__extensions = [];
-    this.__actions = [];
-    this.__user = config.user;
-    this.__metaData = {};
-    if (isObject3(config.metaData)) {
-      Object.keys(config.metaData).forEach((key) => {
-        this.addMetaData(key, config.metaData[key]);
-      });
-    }
-    if (Object.keys(errors).length)
-      this.__logger.warn(getConfigErrorMessage(errors, baseConfig));
-  }
-  use(extension) {
-    var _a;
-    this.__extensions.push(extension);
-    (_a = extension.setup) == null ? void 0 : _a.call(extension, this);
-    return this;
-  }
-  createEvent(value) {
-    const event = createEvent(value, this);
-    return handleEventCreated(event, this);
-  }
-  notify(eventLike, beforeNotify) {
-    let event;
-    if (Boolean(eventLike) && !isEvent(eventLike))
-      event = this.createEvent(eventLike);
-    else
-      event = eventLike;
-    if (beforeNotify)
-      event = beforeNotify(event);
-    return notify(event, this);
-  }
-  addAction(message, data, type, timestamp) {
-    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();
-    actions.push(action);
-  }
-  getUser() {
-    return this.__user;
-  }
-  setUser(user) {
-    if (isObject3(user) && Object.keys(user).length <= 6) {
-      this.__user = __spreadValues(__spreadValues({}, this.__user), user);
-      return this.getUser();
-    }
-    this.__logger.warn(getErrorMessage("setUser should be an object and have up to 6 attributes", user));
-    return void 0;
-  }
-  addMetaData(section, data) {
-    return addMetaData(this.__metaData, section, data);
-  }
-  getMetaData(section) {
-    return getMetaData(this.__metaData, section);
-  }
-  deleteMetaData(section) {
-    return deleteMetaData(this.__metaData, section);
-  }
-};
-
-// src/extension.ts
-function defineExtension(extension) {
-  return extension;
-}
-function createExtensionUI(extensionUI) {
-  return extensionUI;
-}
-
-// src/types.ts
-var types_exports = {};
-__export(types_exports, {
-  EventTypes: () => EventTypes
-});
-var EventTypes = /* @__PURE__ */ ((EventTypes2) => {
-  EventTypes2["UNCAUGHT_ERROR"] = "uncaughtError";
-  EventTypes2["RESOURCE_ERROR"] = "resourceError";
-  EventTypes2["UNHANDLEDREJECTION_ERROR"] = "unhandledrejectionError";
-  EventTypes2["AJAX_ERROR"] = "ajaxError";
-  EventTypes2["FETCH_ERROR"] = "fetchError";
-  EventTypes2["WEBSOCKET_ERROR"] = "websocketError";
-  EventTypes2["UNKNOWN_ERROR"] = "unknownError";
-  EventTypes2["MESSAGE"] = "message";
-  EventTypes2["FEEDBACK"] = "feedback";
-  EventTypes2["VIEW"] = "view";
-  EventTypes2["REACT"] = "react";
-  EventTypes2["VUE"] = "vue";
-  EventTypes2["ANGULAR"] = "angular";
-  EventTypes2["MINIAPP_ERROR"] = "miniappError";
-  EventTypes2["MINIAPP_UNHANDLEDREJECTION_ERROR"] = "miniappUnhandledrejectionError";
-  EventTypes2["MINIAPP_PAGENOTFOUND_ERROR"] = "miniappPagenotfoundError";
-  EventTypes2["MINIAPP_MEMORYWARNING_ERROR"] = "miniappMemorywarningError";
-  return EventTypes2;
-})(EventTypes || {});
-export {
-  Client,
-  EventTypes,
-  createExtensionUI,
-  defineExtension,
-  isEvent,
-  types_exports as types
-};
+var $=Object.defineProperty;var A=Object.getOwnPropertySymbols;var B=Object.prototype.hasOwnProperty,H=Object.prototype.propertyIsEnumerable;var S=(e,t,n)=>t in e?$(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n,b=(e,t)=>{for(var n in t||(t={}))B.call(t,n)&&S(e,n,t[n]);if(A)for(var n of A(t))H.call(t,n)&&S(e,n,t[n]);return e};import{isObject as G,isString as F}from"@ohbug/utils";import{isFunction as U,isNumber as q,isObject as v,isString as p,logger as X}from"@ohbug/utils";var N={apiKey:{defaultValue:void 0,message:"is required",validate:e=>Boolean(e)&&p(e)},appVersion:{defaultValue:void 0,message:"should be a string",validate:e=>e===void 0||p(e)},appType:{defaultValue:void 0,message:"should be a string",validate:e=>e===void 0||p(e)},releaseStage:{defaultValue:"production",message:"should be a string",validate:e=>e===void 0||p(e)},endpoint:{defaultValue:"http://localhost:6660",message:"should be a string",validate:e=>e===void 0||p(e)},maxActions:{defaultValue:30,message:"should be a number between 0 and 100",validate:e=>e===void 0||q(e)&&e>=1&&e<=100},onEvent:{defaultValue:e=>e,message:"should be a function",validate:e=>e===void 0||U(e)},onNotify:{defaultValue:()=>{},message:"should be a function",validate:e=>e===void 0||U(e)},logger:{defaultValue:X,message:"should be null or an object with methods { log, info, warn, error }",validate:e=>e===void 0||e&&["log","info","warn","error"].reduce((t,n)=>t&&typeof e[n]=="function",!0)},user:{defaultValue:void 0,message:"should be an object and have up to 6 attributes",validate:e=>e===void 0||v(e)&&Object.keys(e).length<=6},metadata:{defaultValue:void 0,message:"should be an object",validate:e=>e===void 0||v(e)}};import{isFunction as W,isObject as j,isString as w}from"@ohbug/utils";var O=class{type;timestamp;message;data;constructor(t,n,r,i){this.type=r,this.timestamp=i||new Date().toISOString(),this.message=t,this.data=n}};function V(e,t){return new Error(`Invalid configuration
+${Object.keys(e).map(n=>`- ${n} ${e[n]}, got ${JSON.stringify(t[n])}`).join(`
+`)}
+      `)}function m(e,t){return new Error(`Invalid data
+- ${e}, got ${JSON.stringify(t)}`)}function _(e,t,n){!t||(e[t]=n)}function y(e,t){if(e[t])return e[t]}function E(e,t){if(e[t])return delete e[t]}var D=class{apiKey;appVersion;appType;timestamp;category;type;sdk;device;detail;user;actions;metadata;releaseStage;__client;constructor(t,n){let{apiKey:r,appVersion:i,appType:o,releaseStage:a,timestamp:u,category:g,type:h,sdk:d,detail:c,device:C,user:M,actions:J,metadata:R}=t;this.apiKey=r,this.appVersion=i,this.appType=o,this.releaseStage=a,this.timestamp=u,this.category=g,this.type=h,this.sdk=d,this.detail=c,this.device=C,this.user=M,this.actions=J,this.metadata=R!=null?R:{},this.__client=n}get __isOhbugEvent(){return!0}addAction(t,n,r,i){var d,c;let o=this.actions,a=w(t)?t:"",u=n||{},g=w(r)?r:"",h=new O(a,u,g,i);o.length>=((c=(d=this.__client)==null?void 0:d.__config.maxActions)!=null?c:30)&&o.shift(),o.push(h)}getUser(){return this.user}setUser(t){var n;if(j(t)&&Object.keys(t).length<=6)return this.user=b(b({},this.user),t),this.getUser();(n=this.__client)==null||n.__logger.error(m("setUser should be an object and have up to 6 attributes",t))}addMetadata(t,n){return _(this.metadata,t,n)}getMetadata(t){return y(this.metadata,t)}deleteMetadata(t){return E(this.metadata,t)}toJSON(){let{apiKey:t,appVersion:n,appType:r,timestamp:i,category:o,type:a,sdk:u,device:g,detail:h,user:d,actions:c,metadata:C,releaseStage:M}=this;return{apiKey:t,appVersion:n,appType:r,timestamp:i,category:o,type:a,sdk:u,device:g,detail:h,user:d,actions:c,metadata:C,releaseStage:M}}};function I(e,t){let{apiKey:n,appVersion:r,appType:i,releaseStage:o}=t.__config,a=new Date().toISOString(),u=t.__device(t),g,h,d;return j(e)&&Object.prototype.hasOwnProperty.call(e,"type")&&Object.prototype.hasOwnProperty.call(e,"detail")?(g=e.category||"error",h=e.type,d=e.detail):(g="error",h="unknownError",d=e),new D({apiKey:n,appVersion:r,appType:i,timestamp:a,category:g,type:h,sdk:t.__sdk,device:u,user:t.__user,detail:d,actions:t.__actions,metadata:t.__metadata,releaseStage:o},t)}function k(e,t){let n=[t.__config.onEvent,...t.__extensions.map(({onEvent:r})=>r)].filter(r=>W(r));return n.length===0?e:n.reduce((r,i)=>r&&W(i)?i(r,t):null,e)}function x(e){return Boolean(e==null?void 0:e.__isOhbugEvent)}import{isFunction as Y}from"@ohbug/utils";function z(e,t){[t.__config.onNotify,...t.__extensions.filter(({onNotify:r})=>Y(r)).map(({onNotify:r})=>r)].forEach(r=>r==null?void 0:r(e,t))}async function P(e,t){try{let n=null;return e&&(n=await t.__notifier(e),z(e,t)),n}catch(n){t.__logger.error(n)}}function K(e,t){return Object.keys(t).reduce((r,i)=>{let o=e[i],{defaultValue:a,message:u,validate:g}=t[i];return o!==void 0?g(o)?r.config[i]=o:(r.config[i]=a,r.errors[i]=u):r.config[i]=a,r},{config:{},errors:{}})}var _t=class{__sdk;__config;__logger;__device;__notifier;__extensions;__actions;__user;__metadata;constructor({sdk:t,config:n,schema:r=N,device:i,notifier:o}){let{config:a,errors:u}=K(n,r);this.__sdk=t,this.__config=a,this.__logger=a.logger,this.__device=i,this.__notifier=o,this.__extensions=[],this.__actions=[],this.__user=a.user,this.__metadata={},G(a.metadata)&&Object.keys(a.metadata).forEach(g=>{this.addMetadata(g,a.metadata[g])}),Object.keys(u).length&&this.__logger.warn(V(u,n))}use(t){var n;return this.__extensions.push(t),(n=t.setup)==null||n.call(t,this),this}createEvent(t){let n=I(t,this);return k(n,this)}notify(t,n){let r;return Boolean(t)&&!x(t)?r=this.createEvent(t):r=t,n&&(r=n(r)),P(r,this)}addAction(t,n,r,i){let o=this.__actions,a=F(t)?t:"",u=n||{},g=F(r)?r:"",h=new O(a,u,g,i);o.length>=this.__config.maxActions&&o.shift(),o.push(h)}getUser(){return this.__user}setUser(t){if(G(t)&&Object.keys(t).length<=6)return this.__user=b(b({},this.__user),t),this.getUser();this.__logger.warn(m("setUser should be an object and have up to 6 attributes",t))}addMetadata(t,n){return _(this.__metadata,t,n)}getMetadata(t){return y(this.__metadata,t)}deleteMetadata(t){return E(this.__metadata,t)}};function Ct(e){return e}function Mt(e){return e}var Q=(s=>(s.UNCAUGHT_ERROR="uncaughtError",s.RESOURCE_ERROR="resourceError",s.UNHANDLEDREJECTION_ERROR="unhandledrejectionError",s.AJAX_ERROR="ajaxError",s.FETCH_ERROR="fetchError",s.WEBSOCKET_ERROR="websocketError",s.UNKNOWN_ERROR="unknownError",s.MESSAGE="message",s.FEEDBACK="feedback",s.VIEW="view",s.REACT="react",s.VUE="vue",s.ANGULAR="angular",s.MINIAPP_ERROR="miniappError",s.MINIAPP_UNHANDLEDREJECTION_ERROR="miniappUnhandledrejectionError",s.MINIAPP_PAGENOTFOUND_ERROR="miniappPagenotfoundError",s.MINIAPP_MEMORYWARNING_ERROR="miniappMemorywarningError",s))(Q||{});export{_t as Client,Q as EventTypes,Mt as createExtensionUI,Ct as defineExtension,x as isEvent};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ohbug/core",
-  "version": "2.0.0",
+  "version": "2.0.3",
   "description": "Responsible for managing Ohbug's workflow",
   "license": "Apache-2.0",
   "author": "chenyueban <jasonchan0527@gmail.com>",
@@ -23,16 +23,15 @@
     }
   },
   "files": [
-    "dist",
-    "src"
+    "dist"
   ],
   "sideEffects": false,
   "publishConfig": {
     "access": "public"
   },
   "dependencies": {
-    "@ohbug/types": "2.0.0",
-    "@ohbug/utils": "2.0.0"
+    "@ohbug/types": "2.0.3",
+    "@ohbug/utils": "2.0.3"
   },
   "scripts": {
     "build": "tsup",

package/src/action.ts

@@ -1,23 +0,0 @@
-import type { OhbugAction } from '@ohbug/types'
-
-export class Action implements OhbugAction {
-  readonly type: string
-
-  readonly timestamp: string
-
-  readonly message: string
-
-  readonly data: Record<string, any>
-
-  constructor(
-    message: string,
-    data: Record<string, any>,
-    type: string,
-    timestamp?: string,
-  ) {
-    this.type = type
-    this.timestamp = timestamp || new Date().toISOString()
-    this.message = message
-    this.data = data
-  }
-}