@whnz/frontend-experience-core 1.0.0

package/dist/index.d.mts

@@ -0,0 +1,33 @@
+type Env = 'prod' | 'staging' | 'dev';
+type ExperienceEventType = 'fcp' | 'lcp' | 'cls' | 'inp' | 'longtask' | 'route' | 'react-render' | 'js-error' | 'promise-error' | 'react-error' | 'white-screen' | 'css-visibility-error' | 'css-covered' | string;
+interface ExperienceEvent {
+    type: ExperienceEventType;
+    timestamp: number;
+    value?: number;
+    duration?: number;
+    extra?: Record<string, any>;
+}
+interface ExperienceContext {
+    app: string;
+    version: string;
+    env: Env;
+    route: string;
+    userId?: string;
+}
+interface InitCoreOptions {
+    app: string;
+    version: string;
+    env: Env;
+    reporter: (event: ExperienceEvent & ExperienceContext) => void;
+    sampleRate?: number;
+}
+
+declare function initCore(options: InitCoreOptions): void;
+
+declare function report(event: ExperienceEvent): void;
+
+declare function setRoute(route: string): void;
+declare function setUserId(userId: string): void;
+declare function getContext(): ExperienceContext;
+
+export { type Env, type ExperienceContext, type ExperienceEvent, type ExperienceEventType, type InitCoreOptions, getContext, initCore, report, setRoute, setUserId };

package/dist/index.mjs

@@ -0,0 +1,68 @@
+// src/context.ts
+var context = {
+  app: "",
+  version: "",
+  env: "prod",
+  route: "/"
+};
+function initContext(partial) {
+  Object.assign(context, partial);
+}
+function setRoute(route) {
+  context.route = route;
+}
+function setUserId(userId) {
+  context.userId = userId;
+}
+function getContext() {
+  return { ...context };
+}
+
+// src/sampler.ts
+var sampleRate = 1;
+function initSampler(rate = 1) {
+  sampleRate = rate;
+}
+function shouldSample() {
+  if (sampleRate >= 1) return true;
+  return Math.random() < sampleRate;
+}
+
+// src/reporter.ts
+var reporterFn = null;
+function initReporter(fn) {
+  reporterFn = fn;
+}
+function report(event) {
+  if (!reporterFn) return;
+  if (!shouldSample()) return;
+  const payload = {
+    ...event,
+    ...getContext(),
+    timestamp: event.timestamp || Date.now()
+  };
+  try {
+    reporterFn(payload);
+  } catch (e) {
+  }
+}
+
+// src/init.ts
+var inited = false;
+function initCore(options) {
+  var _a;
+  if (inited) return;
+  inited = true;
+  initContext({
+    app: options.app,
+    version: options.version,
+    env: options.env,
+    route: location.pathname
+  });
+  initReporter(options.reporter);
+  initSampler((_a = options.sampleRate) != null ? _a : 1);
+}
+
+export { getContext, initCore, report, setRoute, setUserId };
+//# sourceMappingURL=index.mjs.map
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/context.ts","../src/sampler.ts","../src/reporter.ts","../src/init.ts"],"names":[],"mappings":";AACA,IAAM,OAAA,GAA6B;AAAA,EACjC,GAAA,EAAK,EAAA;AAAA,EACL,OAAA,EAAS,EAAA;AAAA,EACT,GAAA,EAAK,MAAA;AAAA,EACL,KAAA,EAAO;AACT,CAAA;AACO,SAAS,YAAY,OAAA,EAAqC;AAC/D,EAAA,MAAA,CAAO,MAAA,CAAO,SAAS,OAAO,CAAA;AAChC;AACO,SAAS,SAAS,KAAA,EAAe;AACtC,EAAA,OAAA,CAAQ,KAAA,GAAQ,KAAA;AAClB;AACO,SAAS,UAAU,MAAA,EAAgB;AACxC,EAAA,OAAA,CAAQ,MAAA,GAAS,MAAA;AACnB;AACO,SAAS,UAAA,GAAgC;AAC9C,EAAA,OAAO,EAAE,GAAG,OAAA,EAAQ;AACtB;;;AClBA,IAAI,UAAA,GAAa,CAAA;AACV,SAAS,WAAA,CAAY,OAAO,CAAA,EAAG;AACpC,EAAA,UAAA,GAAa,IAAA;AACf;AACO,SAAS,YAAA,GAAwB;AACtC,EAAA,IAAI,UAAA,IAAc,GAAG,OAAO,IAAA;AAC5B,EAAA,OAAO,IAAA,CAAK,QAAO,GAAI,UAAA;AACzB;;;ACJA,IAAI,UAAA,GAA4C,IAAA;AACzC,SAAS,aAAa,EAAA,EAA0B;AACrD,EAAA,UAAA,GAAa,EAAA;AACf;AACO,SAAS,OAAO,KAAA,EAAwB;AAC7C,EAAA,IAAI,CAAC,UAAA,EAAY;AACjB,EAAA,IAAI,CAAC,cAAa,EAAG;AACrB,EAAA,MAAM,OAAA,GAAU;AAAA,IACd,GAAG,KAAA;AAAA,IACH,GAAG,UAAA,EAAW;AAAA,IACd,SAAA,EAAW,KAAA,CAAM,SAAA,IAAa,IAAA,CAAK,GAAA;AAAI,GACzC;AACA,EAAA,IAAI;AACF,IAAA,UAAA,CAAW,OAAO,CAAA;AAAA,EACpB,SAAS,CAAA,EAAG;AAAA,EAEZ;AACF;;;AChBA,IAAI,MAAA,GAAS,KAAA;AACN,SAAS,SAAS,OAAA,EAA0B;AALnD,EAAA,IAAA,EAAA;AAME,EAAA,IAAI,MAAA,EAAQ;AACZ,EAAA,MAAA,GAAS,IAAA;AACT,EAAA,WAAA,CAAY;AAAA,IACV,KAAK,OAAA,CAAQ,GAAA;AAAA,IACb,SAAS,OAAA,CAAQ,OAAA;AAAA,IACjB,KAAK,OAAA,CAAQ,GAAA;AAAA,IACb,OAAO,QAAA,CAAS;AAAA,GACjB,CAAA;AACD,EAAA,YAAA,CAAa,QAAQ,QAAQ,CAAA;AAC7B,EAAA,WAAA,CAAA,CAAY,EAAA,GAAA,OAAA,CAAQ,UAAA,KAAR,IAAA,GAAA,EAAA,GAAsB,CAAC,CAAA;AACrC","file":"index.mjs","sourcesContent":["import { ExperienceContext } from './types';\nconst context: ExperienceContext = {\n  app: '',\n  version: '',\n  env: 'prod',\n  route: '/',\n};\nexport function initContext(partial: Partial<ExperienceContext>) {\n  Object.assign(context, partial);\n}\nexport function setRoute(route: string) {\n  context.route = route;\n}\nexport function setUserId(userId: string) {\n  context.userId = userId;\n}\nexport function getContext(): ExperienceContext {\n  return { ...context };\n}\n","let sampleRate = 1;\nexport function initSampler(rate = 1) {\n  sampleRate = rate;\n}\nexport function shouldSample(): boolean {\n  if (sampleRate >= 1) return true;\n  return Math.random() < sampleRate;\n}\n","import { ExperienceEvent } from './types';\nimport { getContext } from './context';\nimport { shouldSample } from './sampler';\nlet reporterFn: ((event: any) => void) | null = null;\nexport function initReporter(fn: (event: any) => void) {\n  reporterFn = fn;\n}\nexport function report(event: ExperienceEvent) {\n  if (!reporterFn) return;\n  if (!shouldSample()) return;\n  const payload = {\n    ...event,\n    ...getContext(),\n    timestamp: event.timestamp || Date.now(),\n  };\n  try {\n    reporterFn(payload);\n  } catch (e) {\n    // core 永远不能抛异常\n  }\n}\n","import { InitCoreOptions } from './types';\nimport { initContext } from './context';\nimport { initReporter } from './reporter';\nimport { initSampler } from './sampler';\nlet inited = false;\nexport function initCore(options: InitCoreOptions) {\n  if (inited) return;\n  inited = true;\n  initContext({\n    app: options.app,\n    version: options.version,\n    env: options.env,\n    route: location.pathname,\n  });\n  initReporter(options.reporter);\n  initSampler(options.sampleRate ?? 1);\n}\n"]}

package/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "@whnz/frontend-experience-core",
+  "version": "1.0.0",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "sideEffects": false,
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup"
+  }
+}