@univerjs/telemetry 0.21.1 → 0.22.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +28 -8
  2. package/package.json +14 -8
package/README.md CHANGED
@@ -1,16 +1,36 @@
1
1
  # @univerjs/telemetry
2
2
 
3
- [![npm version](https://img.shields.io/npm/v/@univerjs/telemetry)](https://npmjs.org/packages/@univerjs/telemetry)
4
- [![license](https://img.shields.io/npm/l/@univerjs/telemetry)](https://img.shields.io/npm/l/@univerjs/telemetry)
3
+ [![npm version](https://img.shields.io/npm/v/@univerjs/telemetry?style=flat-square)](https://npmjs.com/package/@univerjs/telemetry)
4
+ [![license](https://img.shields.io/npm/l/@univerjs/telemetry?style=flat-square)](https://npmjs.com/package/@univerjs/telemetry)
5
+ [![downloads](https://img.shields.io/npm/dm/@univerjs/telemetry?style=flat-square)](https://npmjs.com/package/@univerjs/telemetry)
5
6
 
6
- ## Introduction
7
+ `@univerjs/telemetry` defines the telemetry service interface used by Univer packages. Applications can implement and register this service to collect usage or diagnostic events.
7
8
 
8
- 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.
9
+ ## Package Overview
9
10
 
10
- ## Usage
11
+ | Package | UMD global | CSS | Locales | Facade entry |
12
+ | --- | --- | :---: | :---: | :---: |
13
+ | `@univerjs/telemetry` | `UniverTelemetry` | No | No | No |
11
14
 
12
- ### Installation
15
+ ## Installation
13
16
 
14
- ```shell
15
- npm i @univerjs/telemetry
17
+ ```sh
18
+ pnpm add @univerjs/telemetry
19
+ # or
20
+ npm install @univerjs/telemetry
16
21
  ```
22
+
23
+ Keep all `@univerjs/*` packages on the same version.
24
+
25
+ ## Usage
26
+
27
+ ```ts
28
+ import { ITelemetryService } from '@univerjs/telemetry';
29
+ ```
30
+
31
+ ## Resources
32
+
33
+ - [Documentation](https://docs.univer.ai)
34
+ - [NPM package](https://npmjs.com/package/@univerjs/telemetry)
35
+ - [GitHub repository](https://github.com/dream-num/univer)
36
+
package/package.json CHANGED
@@ -1,9 +1,9 @@
1
1
  {
2
2
  "name": "@univerjs/telemetry",
3
- "version": "0.21.1",
3
+ "version": "0.22.0",
4
4
  "private": false,
5
- "description": "",
6
- "author": "DreamNum <developer@univer.ai>",
5
+ "description": "Telemetry service interface for Univer packages.",
6
+ "author": "DreamNum Co., Ltd. <developer@univer.ai>",
7
7
  "funding": {
8
8
  "type": "opencollective",
9
9
  "url": "https://opencollective.com/univer"
@@ -16,7 +16,13 @@
16
16
  "bugs": {
17
17
  "url": "https://github.com/dream-num/univer/issues"
18
18
  },
19
- "keywords": [],
19
+ "keywords": [
20
+ "univer",
21
+ "telemetry",
22
+ "analytics",
23
+ "events",
24
+ "service"
25
+ ],
20
26
  "exports": {
21
27
  ".": {
22
28
  "import": "./lib/es/index.js",
@@ -42,12 +48,12 @@
42
48
  "lib"
43
49
  ],
44
50
  "dependencies": {
45
- "@univerjs/core": "0.21.1"
51
+ "@univerjs/core": "0.22.0"
46
52
  },
47
53
  "devDependencies": {
48
- "typescript": "^6.0.2",
49
- "vitest": "^4.1.4",
50
- "@univerjs-infra/shared": "0.21.1"
54
+ "typescript": "^6.0.3",
55
+ "vitest": "^4.1.5",
56
+ "@univerjs-infra/shared": "0.22.0"
51
57
  },
52
58
  "scripts": {
53
59
  "test": "vitest run",