rrweb - npm Package Compare versions

Comparing version 1.0.0-beta.2 to 1.0.0

package.json

 {
   "name": "rrweb",
-  "version": "1.0.0-beta.2",
+  "version": "1.0.0",
   "description": "record and replay the web",
@@ -5,0 +5,0 @@ "scripts": {

README.md

@@ -10,10 +10,8 @@ <p align="center">
 
-**[🚀 Try storyteller, a no-code interactive tutorial builder build with rrweb](https://storyteller.webzard.io/?utm_source=rrweb&utm_medium=github)**
-
 **[The new adventure of the rrweb community](http://www.myriptide.com/rrweb-community/)**
 
-[![Build Status](https://travis-ci.org/rrweb-io/rrweb.svg?branch=master)](https://travis-ci.org/rrweb-io/rrweb)
-[![Join the chat at https://gitter.im/rrweb-io/rrweb](https://badges.gitter.im/rrweb-io/rrweb.svg)](https://gitter.im/rrweb-io/rrweb?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![Join the chat at slack](https://img.shields.io/badge/[e-mail]?logo=slack)](https://join.slack.com/t/rrweb/shared_invite/zt-siwoc6hx-uWay3s2wyG8t5GpZVb8rWg)
 ![total gzip size](https://img.badgesize.io/https://cdn.jsdelivr.net/npm/rrweb@latest/dist/rrweb.min.js?compression=gzip&label=total%20gzip%20size)
 ![recorder gzip size](https://img.badgesize.io/https://cdn.jsdelivr.net/npm/rrweb@latest/dist/record/rrweb-record.min.js?compression=gzip&label=recorder%20gzip%20size)
+[![](https://data.jsdelivr.com/v1/package/npm/rrweb/badge)](https://www.jsdelivr.com/package/npm/rrweb)
 
@@ -26,4 +24,2 @@ [中文文档](./README.zh_CN.md)
 
-**Currently, rrweb has already solved many difficult problems in recording and replaying, but the data structure may still be changed before the release of Version 1.0. So please be cautious to use rrweb in the production environment.**
-
 ## Guide
@@ -33,3 +29,3 @@
 
-[**Recipes**](./docs/recipes/index.md)
+[**🍳 Recipes 🍳**](./docs/recipes/index.md)
 
@@ -46,14 +42,11 @@ ## Project Structure
 
-- rrweb
-  - handle cross-domain request errors
-  - record in web worker
-  - implement transmission data compression
-  - verify recording in mobile browser
-- rrweb-player
-  - implement efficient progress bar drag and drop control
-  - add full screen mode
-- extensions
-  - hijack the console API and record corresponding events
-  - hijack Ajax/fetch API and record request events
-  - use TraceKit to log exception events
+- rrdom: an ad-hoc DOM for rrweb session data [#419](https://github.com/rrweb-io/rrweb/issues/419)
+- storage engine: do deduplication on a large number of rrweb sessions
+- more end-to-end tests
+- compact mutation data in common patterns
+- provide plugins via the new plugin API, including:
+  - XHR plugin
+  - fetch plugin
+  - GraphQL plugin
+  - ...
 
@@ -82,2 +75,49 @@ ## Internal Design
 
+## Core Team Members
+
+<table>
+  <tr>
+    <td align="center">
+      <a href="https://github.com/Yuyz0112">
+        <img
+          src="https://avatars.githubusercontent.com/u/13651389?s=100"
+          width="100px;"
+          alt=""
+        />
+        <br /><sub><b>Yuyz0112</b></sub>
+      </a>
+    </td>
+    <td align="center">
+      <a href="https://github.com/Mark-Fenng">
+        <img
+          src="https://avatars.githubusercontent.com/u/27533910?s=100"
+          width="100px;"
+          alt=""
+        />
+        <br /><sub><b>Mark-Fenng</b></sub>
+      </a>
+    </td>
+    <td align="center">
+      <a href="https://github.com/eoghanmurray">
+        <img
+          src="https://avatars.githubusercontent.com/u/156780?s=100"
+          width="100px;"
+          alt=""
+        />
+        <br /><sub><b>eoghanmurray</b></sub>
+      </a>
+    </td>
+    <td align="center">
+      <a href="https://github.com/Juice10">
+        <img
+          src="https://avatars.githubusercontent.com/u/4106?s=100"
+          width="100px;"
+          alt=""
+        />
+        <br /><sub><b>Juice10</b></sub>
+      </a>
+    </td>
+  </tr>
+</table>
+
 ## Who's using rrweb
@@ -84,0 +124,0 @@

README.zh_CN.md

@@ -10,10 +10,8 @@ <p align="center">
 
-**[🚀 Storyteller, 基于 rrweb 开发的无代码交互式教程编辑器](https://storyteller.webzard.io/?utm_source=rrweb&utm_medium=github)**
-
 **[rrweb 社区新的征程](http://www.myriptide.com/rrweb-community-cn/)**
 
-[![Build Status](https://travis-ci.org/rrweb-io/rrweb.svg?branch=master)](https://travis-ci.org/rrweb-io/rrweb)
-[![Join the chat at https://gitter.im/rrweb-io/rrweb](https://badges.gitter.im/rrweb-io/rrweb.svg)](https://gitter.im/rrweb-io/rrweb?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![Join the chat at slack](https://img.shields.io/badge/[e-mail]?logo=slack)](https://join.slack.com/t/rrweb/shared_invite/zt-siwoc6hx-uWay3s2wyG8t5GpZVb8rWg)
 ![total gzip size](https://img.badgesize.io/https://cdn.jsdelivr.net/npm/rrweb@latest/dist/rrweb.min.js?compression=gzip&label=total%20gzip%20size)
 ![recorder gzip size](https://img.badgesize.io/https://cdn.jsdelivr.net/npm/rrweb@latest/dist/record/rrweb-record.min.js?compression=gzip&label=recorder%20gzip%20size)
+[![](https://data.jsdelivr.com/v1/package/npm/rrweb/badge)](https://www.jsdelivr.com/package/npm/rrweb)
 
@@ -24,4 +22,2 @@ > 我已开通 Github Sponsor， 您可以通过赞助的形式帮助 rrweb 的开发。
 
-**目前 rrweb 已经解决了许多录制与回放中的难点问题，但在 1.0 版本 release 之前数据结构仍有可能发生变化，请谨慎用于生产环境中。**
-
 ## 指南
@@ -31,3 +27,3 @@
 
-[**场景示例**](./docs/recipes/index.zh_CN.md)
+[**🍳 场景示例 🍳**](./docs/recipes/index.zh_CN.md)
 
@@ -44,17 +40,11 @@ ## 项目结构
 
-- rrweb
-  - 处理跨域请求错误
-  - 转移至 web worker 中执行
-  - 实现传输数据压缩
-  - 验证移动端录制效果
-- rrweb-player
-  - 实现高效的进度条拖拽功能
-  - 增加全屏模式
-- extensions
-  - 劫持 console API，记录对应的事件
-  - 劫持 Ajax/fetch API，记录请求事件
-  - 封装 TraceKit，记录异常事件
-- 测试
-  - 补充更多单元测试
-  - 随机在更多网站上运行集成测试
+- rrdom: rrweb 数据专用的 DOM 实现 [#419](https://github.com/rrweb-io/rrweb/issues/419)
+- storage engine: 对大规模 rrweb 数据进行去重
+- 更多的 E2E 测试
+- 在常见场景下对 mutation 数据进行压缩
+- 基于新的插件 API 提供更多插件，包括:
+  - XHR 插件
+  - fetch 插件
+  - GraphQL 插件
+  - ...
 
@@ -83,2 +73,49 @@ ## Internal Design
 
+## Core Team Members
+
+<table>
+  <tr>
+    <td align="center">
+      <a href="https://github.com/Yuyz0112">
+        <img
+          src="https://avatars.githubusercontent.com/u/13651389?s=100"
+          width="100px;"
+          alt=""
+        />
+        <br /><sub><b>Yuyz0112</b></sub>
+      </a>
+    </td>
+    <td align="center">
+      <a href="https://github.com/Mark-Fenng">
+        <img
+          src="https://avatars.githubusercontent.com/u/27533910?s=100"
+          width="100px;"
+          alt=""
+        />
+        <br /><sub><b>Mark-Fenng</b></sub>
+      </a>
+    </td>
+    <td align="center">
+      <a href="https://github.com/eoghanmurray">
+        <img
+          src="https://avatars.githubusercontent.com/u/156780?s=100"
+          width="100px;"
+          alt=""
+        />
+        <br /><sub><b>eoghanmurray</b></sub>
+      </a>
+    </td>
+    <td align="center">
+      <a href="https://github.com/Juice10">
+        <img
+          src="https://avatars.githubusercontent.com/u/4106?s=100"
+          width="100px;"
+          alt=""
+        />
+        <br /><sub><b>Juice10</b></sub>
+      </a>
+    </td>
+  </tr>
+</table>
+
 ## Who's using rrweb
@@ -85,0 +122,0 @@

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

4528974

increased by0.05%

Number of package files

103

increased by0.98%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

125

increased by47.06%

No dependency changes