Skip to content

Build your own AI office with Univer Office SDK. Bring editing, calculation, collaboration, and file processing into your product for people and AI agents. Built on an extensible open-source core.

chore: update telemetry package info

Wenzhao Hu5ce60a58d4c1
diff --git a/packages/telemetry/README.md b/packages/telemetry/README.md
index 47c356e207..1be368da14 100644
--- a/packages/telemetry/README.md
+++ b/packages/telemetry/README.md
@@ -5,7 +5,7 @@
## Introduction
-> TODO: Introduction
+This plugin provides interface `ITelemetry` to track telemetry data. The first-party plugins of Univer would dependent on this interface. If you want to track telemetry data, you can implement this interface and register it to `Univer`'s injector.
## Usage
diff --git a/packages/telemetry/package.json b/packages/telemetry/package.json
index c962df377e..1d273dc719 100644
--- a/packages/telemetry/package.json
+++ b/packages/telemetry/package.json
@@ -1,6 +1,6 @@
{
"name": "@univerjs/telemetry",
- "version": "0.2.1",
+ "version": "0.2.11",
"private": true,
"description": "",
"author": "DreamNum <[email protected]>",
diff --git a/packages/telemetry/src/services/telemetry-service.ts b/packages/telemetry/src/services/telemetry-service.ts
index d4c5d7061b..f2abbb94c7 100644
--- a/packages/telemetry/src/services/telemetry-service.ts
+++ b/packages/telemetry/src/services/telemetry-service.ts
@@ -16,26 +16,9 @@
import { createIdentifier } from '@univerjs/core';
-// Enum for telemetry event names
-export enum TelemetryEventNames {
- /** space */
- space_sheet_create = 'space_sheet_create',
- space_sheet_upload = 'space_sheet_upload',
- /** unit */
- unit_header_sheet_upload = 'unit_header_sheet_upload',
- unit_header_sheet_create = 'unit_header_sheet_create',
- unit_header_sheet_print = 'unit_header_sheet_print',
- unit_header_sheet_download = 'unit_header_sheet_download',
- unit_header_sheet_share_click = 'unit_header_sheet_share_click',
- /** sheet */
- sheet_ai_completion_config = 'ai_completion_config',
- sheet_ai_completion_requesting = 'ai_completion_requesting',
-
- sheet_render_cost = 'sheet_render_timecost',
- performance_function_time_cost = 'performance_function_time_cost',
-};
-
-// Base interface for telemetry service
+/**
+ * Univer telemetry service interface. You should implement this interface to track telemetry data.
+ */
export interface ITelemetryService {
identify: (id: string, params?: Record<string, any>) => void;
capture: (eventName: string, params?: Record<string, any>) => void;
@@ -49,4 +32,7 @@ export interface ITelemetryService {
onPageView: (url: string) => void;
};
+/**
+ * Univer telemetry service identifier.
+ */
export const ITelemetryService = createIdentifier<ITelemetryService>('telemetry.service');