@ohbug/extension-uuid 1.0.12 → 2.0.0

package/README.md

@@ -2,12 +2,11 @@
 
 [![npm](https://img.shields.io/npm/v/@ohbug/extension-uuid.svg?style=flat-square)](https://www.npmjs.com/package/@ohbug/extension-uuid)
 [![npm bundle size](https://img.shields.io/bundlephobia/min/@ohbug/extension-uuid?style=flat-square)](https://bundlephobia.com/result?p=@ohbug/extension-uuid)
-[![Code style](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
 
 ## Installation
 
 ```
-yarn add @ohbug/extension-uuid
+pnpm instal @ohbug/extension-uuid
 ```
 
 ## Usage
@@ -16,6 +15,6 @@ yarn add @ohbug/extension-uuid
 import Ohbug from '@ohbug/browser'
 import OhbugExtensionUUID from '@ohbug/extension-uuid'
 
-const client = Ohbug.init({ apiKey: 'YOUR_API_KEY' })
+const client = Ohbug.setup({ apiKey: 'YOUR_API_KEY' })
 client.use(OhbugExtensionUUID)
 ```

package/dist/index.d.ts

@@ -1,2 +1,166 @@
-export { extension as default } from './extension';
-//# sourceMappingURL=index.d.ts.map
+interface OhbugAction {
+  type: string
+  timestamp: string
+  message?: string
+  data?: Record<string, any>
+}
+
+interface OhbugDevice {
+  // browser
+  language?: string
+  userAgent?: string
+  title?: string
+  url?: string
+
+  [key: string]: any
+}
+
+type OhbugGetDevice = (client?: OhbugClient) => OhbugDevice
+
+interface OhbugUser {
+  uuid?: string
+  ip_address?: string
+  id?: number | string
+  name?: string
+  email?: string
+  [key: string]: any
+}
+
+type OhbugMetaData = Record<string, any>
+
+type OhbugReleaseStage = 'development' | 'production' | string
+type OhbugCategory =
+  | 'error'
+  | 'message'
+  | 'feedback'
+  | 'view'
+  | 'performance'
+  | 'other'
+interface OhbugSDK {
+  platform: string
+  version: string
+}
+
+interface OhbugEvent<D> {
+  apiKey: string
+  appVersion?: string
+  appType?: string
+  releaseStage?: OhbugReleaseStage
+  timestamp: string
+  category?: OhbugCategory
+  type: string
+  sdk: OhbugSDK
+
+  detail: D
+  device: OhbugDevice
+  user?: OhbugUser
+  actions?: OhbugAction[]
+  metaData?: OhbugMetaData
+}
+interface OhbugEventWithMethods<D> extends OhbugEvent<D> {
+  addAction: (
+    message: string,
+    data: Record<string, any>,
+    type: string,
+    timestamp?: string
+  ) => void
+  getUser: () => OhbugUser | undefined
+  setUser: (user: OhbugUser) => OhbugUser | undefined
+  addMetaData: (section: string, data: any) => any
+  getMetaData: (section: string) => any
+  deleteMetaData: (section: string) => any
+}
+
+interface OhbugCreateEvent<D> {
+  category?: OhbugCategory
+  type: string
+  detail: D
+}
+
+interface OhbugExtension {
+  name: string
+  setup?: (client: OhbugClient, ...args: any[]) => void
+  created?: <D = any>(
+    event: OhbugEventWithMethods<D>,
+    client: OhbugClient
+  ) => OhbugEventWithMethods<D> | null
+  notified?: <D = any>(
+    event: OhbugEventWithMethods<D>,
+    client: OhbugClient
+  ) => void
+}
+
+interface OhbugLoggerConfig {
+  log: (...args: any[]) => void
+  info: (...args: any[]) => void
+  warn: (...args: any[]) => void
+  error: (...args: any[]) => void
+}
+
+interface OhbugConfig {
+  // base
+  apiKey: string
+  appVersion?: string
+  appType?: string
+  releaseStage?: OhbugReleaseStage
+  endpoint?: string
+  maxActions?: number
+  // hooks
+  created?: <D = any>(
+    event: OhbugEventWithMethods<D>,
+    client: OhbugClient
+  ) => OhbugEventWithMethods<D> | null
+  notified?: <D = any>(
+    event: OhbugEventWithMethods<D>,
+    client: OhbugClient
+  ) => void
+  // data
+  user?: OhbugUser
+  metaData?: OhbugMetaData
+  // utils
+  logger?: OhbugLoggerConfig
+}
+
+type OhbugNotifier = <D = any>(
+  event: OhbugEventWithMethods<D>
+) => Promise<any> | any
+
+interface OhbugClient {
+  readonly __sdk: OhbugSDK
+  readonly __config: OhbugConfig
+  readonly __logger: OhbugLoggerConfig
+  readonly __device: OhbugGetDevice
+  readonly __notifier: OhbugNotifier
+
+  readonly __extensions: OhbugExtension[]
+
+  readonly __actions: OhbugAction[]
+  __user: OhbugUser
+  readonly __metaData: OhbugMetaData
+
+  use: (extension: OhbugExtension) => OhbugClient
+  createEvent: <D = any>(
+    value: OhbugCreateEvent<D>
+  ) => OhbugEventWithMethods<D> | null
+  notify: <D = any>(
+    eventLike: any,
+    beforeNotify?: (
+      event: OhbugEventWithMethods<D> | null
+    ) => OhbugEventWithMethods<D> | null
+  ) => Promise<any | null>
+  addAction: (
+    message: string,
+    data: Record<string, any>,
+    type: string,
+    timestamp?: string
+  ) => void
+  getUser: () => OhbugUser | undefined
+  setUser: (user: OhbugUser) => OhbugUser | undefined
+  addMetaData: (section: string, data: any) => any
+  getMetaData: (section: string) => any
+  deleteMetaData: (section: string) => any
+}
+
+declare const extension: OhbugExtension;
+
+export { extension as default };

package/dist/index.js

@@ -0,0 +1,102 @@
+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 key2 of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key2) && key2 !== except)
+        __defProp(to, key2, { get: () => from[key2], enumerable: !(desc = __getOwnPropDesc(from, key2)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  default: () => src_default
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/extension.ts
+var import_core = require("@ohbug/core");
+
+// src/uuid.ts
+var import_uuid = require("uuid");
+var import_utils = require("@ohbug/utils");
+
+// src/cookie.ts
+var docCookies = {
+  getItem(sKey) {
+    return decodeURIComponent(document.cookie.replace(new RegExp(`(?:(?:^|.*;)\\s*${encodeURIComponent(sKey).replace(/[-.+*]/g, "\\$&")}\\s*\\=\\s*([^;]*).*$)|^.*$`), "$1")) || null;
+  },
+  setItem(sKey, sValue, vEnd, sPath, sDomain, bSecure) {
+    if (!sKey || /^(?:expires|max\-age|path|domain|secure)$/i.test(sKey))
+      return false;
+    let sExpires = "";
+    if (vEnd) {
+      switch (vEnd.constructor) {
+        case Number:
+          sExpires = vEnd === Infinity ? "; expires=Fri, 31 Dec 9999 23:59:59 GMT" : `; max-age=${vEnd}`;
+          break;
+        case String:
+          sExpires = `; expires=${vEnd}`;
+          break;
+        case Date:
+          sExpires = `; expires=${vEnd.toUTCString()}`;
+          break;
+        default:
+          break;
+      }
+    }
+    const value = `${encodeURIComponent(sKey)}=${encodeURIComponent(sValue)}${sExpires}${sDomain ? `; domain=${sDomain}` : ""}${sPath ? `; path=${sPath}` : ""}${bSecure ? "; secure" : ""}`;
+    document.cookie = value;
+    return value;
+  },
+  removeItem(sKey, sPath, sDomain) {
+    if (!sKey || !this.getItem(sKey))
+      return false;
+    document.cookie = `${encodeURIComponent(sKey)}=; expires=Thu, 01 Jan 1970 00:00:00 GMT${sDomain ? `; domain=${sDomain}` : ""}${sPath ? `; path=${sPath}` : ""}`;
+    return true;
+  }
+};
+
+// src/uuid.ts
+var key = "OhbugUUID";
+function getUUID() {
+  if ((0, import_utils.isBrowser)()) {
+    const UUID = docCookies.getItem(key);
+    if (!UUID) {
+      const extraTime = 60 * 30 * 24 * 3600 * 1e3;
+      const endTime = new Date();
+      endTime.setTime(endTime.getTime() + extraTime);
+      const uuid = (0, import_uuid.v4)();
+      docCookies.setItem(key, uuid, endTime);
+      return uuid;
+    }
+    return UUID;
+  }
+  if ((0, import_utils.isNode)())
+    return (0, import_uuid.v4)();
+  return "";
+}
+
+// src/extension.ts
+var extension = (0, import_core.defineExtension)({
+  name: "OhbugExtensionUUID",
+  created: (event) => {
+    const uuid = getUUID();
+    event.setUser({ uuid });
+    return event;
+  }
+});
+
+// src/index.ts
+var src_default = extension;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {});

package/dist/index.mjs

@@ -0,0 +1,78 @@
+// src/extension.ts
+import { defineExtension } from "@ohbug/core";
+
+// src/uuid.ts
+import { v4 as uuidv4 } from "uuid";
+import { isBrowser, isNode } from "@ohbug/utils";
+
+// src/cookie.ts
+var docCookies = {
+  getItem(sKey) {
+    return decodeURIComponent(document.cookie.replace(new RegExp(`(?:(?:^|.*;)\\s*${encodeURIComponent(sKey).replace(/[-.+*]/g, "\\$&")}\\s*\\=\\s*([^;]*).*$)|^.*$`), "$1")) || null;
+  },
+  setItem(sKey, sValue, vEnd, sPath, sDomain, bSecure) {
+    if (!sKey || /^(?:expires|max\-age|path|domain|secure)$/i.test(sKey))
+      return false;
+    let sExpires = "";
+    if (vEnd) {
+      switch (vEnd.constructor) {
+        case Number:
+          sExpires = vEnd === Infinity ? "; expires=Fri, 31 Dec 9999 23:59:59 GMT" : `; max-age=${vEnd}`;
+          break;
+        case String:
+          sExpires = `; expires=${vEnd}`;
+          break;
+        case Date:
+          sExpires = `; expires=${vEnd.toUTCString()}`;
+          break;
+        default:
+          break;
+      }
+    }
+    const value = `${encodeURIComponent(sKey)}=${encodeURIComponent(sValue)}${sExpires}${sDomain ? `; domain=${sDomain}` : ""}${sPath ? `; path=${sPath}` : ""}${bSecure ? "; secure" : ""}`;
+    document.cookie = value;
+    return value;
+  },
+  removeItem(sKey, sPath, sDomain) {
+    if (!sKey || !this.getItem(sKey))
+      return false;
+    document.cookie = `${encodeURIComponent(sKey)}=; expires=Thu, 01 Jan 1970 00:00:00 GMT${sDomain ? `; domain=${sDomain}` : ""}${sPath ? `; path=${sPath}` : ""}`;
+    return true;
+  }
+};
+
+// src/uuid.ts
+var key = "OhbugUUID";
+function getUUID() {
+  if (isBrowser()) {
+    const UUID = docCookies.getItem(key);
+    if (!UUID) {
+      const extraTime = 60 * 30 * 24 * 3600 * 1e3;
+      const endTime = new Date();
+      endTime.setTime(endTime.getTime() + extraTime);
+      const uuid = uuidv4();
+      docCookies.setItem(key, uuid, endTime);
+      return uuid;
+    }
+    return UUID;
+  }
+  if (isNode())
+    return uuidv4();
+  return "";
+}
+
+// src/extension.ts
+var extension = defineExtension({
+  name: "OhbugExtensionUUID",
+  created: (event) => {
+    const uuid = getUUID();
+    event.setUser({ uuid });
+    return event;
+  }
+});
+
+// src/index.ts
+var src_default = extension;
+export {
+  src_default as default
+};

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@ohbug/extension-uuid",
-  "version": "1.0.12",
+  "version": "2.0.0",
   "description": "Ohbug extension to add uuid",
+  "license": "Apache-2.0",
   "author": "chenyueban <jasonchan0527@gmail.com>",
   "homepage": "https://github.com/ohbug-org/ohbug",
   "bugs": {
@@ -11,32 +12,35 @@
     "type": "git",
     "url": "https://github.com/ohbug-org/ohbug"
   },
-  "license": "Apache-2.0",
-  "main": "dist/ohbug-extension-uuid.cjs.js",
-  "module": "dist/ohbug-extension-uuid.esm.js",
-  "unpkg": "dist/ohbug-extension-uuid.umd.js",
-  "jsdelivr": "dist/ohbug-extension-uuid.umd.js",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs",
+      "types": "./dist/index.d.ts"
+    }
+  },
   "files": [
-    "dist"
+    "dist",
+    "src"
   ],
+  "sideEffects": false,
   "dependencies": {
-    "@ohbug/core": "^1.1.5",
-    "@ohbug/utils": "^1.0.12",
+    "@ohbug/core": "2.0.0",
+    "@ohbug/utils": "2.0.0",
     "uuid": "^8.3.2"
   },
   "devDependencies": {
     "@types/uuid": "^8.0.0"
   },
-  "buildOptions": {
-    "name": "OhbugExtensionUUID",
-    "formats": [
-      "esm",
-      "umd",
-      "cjs"
-    ]
-  },
   "publishConfig": {
     "access": "public"
-  }
-}
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch"
+  },
+  "readme": "# `@ohbug/extension-uuid`\n\n[![npm](https://img.shields.io/npm/v/@ohbug/extension-uuid.svg?style=flat-square)](https://www.npmjs.com/package/@ohbug/extension-uuid)\n[![npm bundle size](https://img.shields.io/bundlephobia/min/@ohbug/extension-uuid?style=flat-square)](https://bundlephobia.com/result?p=@ohbug/extension-uuid)\n\n## Installation\n\n```\npnpm instal @ohbug/extension-uuid\n```\n\n## Usage\n\n```javascript\nimport Ohbug from '@ohbug/browser'\nimport OhbugExtensionUUID from '@ohbug/extension-uuid'\n\nconst client = Ohbug.setup({ apiKey: 'YOUR_API_KEY' })\nclient.use(OhbugExtensionUUID)\n```\n"
+}

package/src/cookie.ts

@@ -0,0 +1,60 @@
+// https://developer.mozilla.org/zh-CN/docs/Web/API/Document/cookie
+export const docCookies = {
+  getItem(sKey: string): string | null {
+    return (
+      decodeURIComponent(document.cookie.replace(
+        new RegExp(`(?:(?:^|.*;)\\s*${encodeURIComponent(sKey).replace(
+          /[-.+*]/g,
+          '\\$&',
+        )}\\s*\\=\\s*([^;]*).*$)|^.*$`),
+        '$1',
+      )) || null
+    )
+  },
+  setItem(
+    sKey: string,
+    sValue: string,
+    vEnd?: number | string | Date,
+    sPath?: string,
+    sDomain?: string,
+    bSecure?: boolean,
+  ): string | false {
+    if (!sKey || /^(?:expires|max\-age|path|domain|secure)$/i.test(sKey))
+      return false
+
+    let sExpires = ''
+    if (vEnd) {
+      switch (vEnd.constructor) {
+        case Number:
+          sExpires
+            = vEnd === Infinity
+              ? '; expires=Fri, 31 Dec 9999 23:59:59 GMT'
+              : `; max-age=${vEnd}`
+          break
+        case String:
+          sExpires = `; expires=${vEnd}`
+          break
+        case Date:
+          sExpires = `; expires=${(vEnd as Date).toUTCString()}`
+          break
+        default:
+          break
+      }
+    }
+    const value = `${encodeURIComponent(sKey)}=${encodeURIComponent(sValue)}${sExpires}${sDomain ? `; domain=${sDomain}` : ''}${
+      sPath ? `; path=${sPath}` : ''
+    }${bSecure ? '; secure' : ''}`
+    document.cookie = value
+
+    return value
+  },
+  removeItem(sKey: string, sPath?: string, sDomain?: string) {
+    if (!sKey || !this.getItem(sKey))
+      return false
+
+    document.cookie = `${encodeURIComponent(sKey)}=; expires=Thu, 01 Jan 1970 00:00:00 GMT${
+      sDomain ? `; domain=${sDomain}` : ''
+    }${sPath ? `; path=${sPath}` : ''}`
+    return true
+  },
+}

package/src/extension.ts

@@ -0,0 +1,11 @@
+import { defineExtension } from '@ohbug/core'
+import { getUUID } from './uuid'
+
+export const extension = defineExtension({
+  name: 'OhbugExtensionUUID',
+  created: (event) => {
+    const uuid = getUUID()
+    event.setUser({ uuid })
+    return event
+  },
+})

package/src/index.ts

@@ -0,0 +1,3 @@
+import { extension } from './extension'
+
+export default extension

package/src/uuid.ts

@@ -0,0 +1,24 @@
+import { v4 as uuidv4 } from 'uuid'
+import { isBrowser, isNode } from '@ohbug/utils'
+import { docCookies } from './cookie'
+
+const key = 'OhbugUUID'
+
+export function getUUID(): string {
+  if (isBrowser()) {
+    const UUID = docCookies.getItem(key)
+    if (!UUID) {
+      const extraTime = 60 * 30 * 24 * 3600 * 1000 // 30天后过期
+      const endTime = new Date()
+      endTime.setTime(endTime.getTime() + extraTime)
+      const uuid = uuidv4()
+      docCookies.setItem(key, uuid, endTime)
+      return uuid
+    }
+    return UUID
+  }
+  if (isNode())
+    return uuidv4()
+
+  return ''
+}

package/dist/cookie.d.ts

@@ -1,6 +0,0 @@
-export declare const docCookies: {
-    getItem(sKey: string): string | null;
-    setItem(sKey: string, sValue: string, vEnd?: string | number | Date | undefined, sPath?: string | undefined, sDomain?: string | undefined, bSecure?: boolean | undefined): string | false;
-    removeItem(sKey: string, sPath?: string | undefined, sDomain?: string | undefined): boolean;
-};
-//# sourceMappingURL=cookie.d.ts.map

package/dist/cookie.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"cookie.d.ts","sourceRoot":"","sources":["../src/cookie.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,UAAU;kBACP,MAAM,GAAG,MAAM,GAAG,IAAI;kBAgB5B,MAAM,UACJ,MAAM,uIAKb,MAAM,GAAG,KAAK;qBAiCA,MAAM;CAWxB,CAAA"}

package/dist/extension.d.ts

@@ -1,2 +0,0 @@
-export declare const extension: import("@ohbug/types").OhbugExtension<any>;
-//# sourceMappingURL=extension.d.ts.map

package/dist/extension.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"extension.d.ts","sourceRoot":"","sources":["../src/extension.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,SAAS,4CASpB,CAAA"}

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,IAAI,OAAO,EAAE,MAAM,aAAa,CAAA"}