@pluv/io 0.2.2 → 0.2.3

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 (4) hide show
  1. package/.turbo/turbo-build.log +4 -4
  2. package/CHANGELOG.md +10 -0
  3. package/README.md +16 -9
  4. package/package.json +3 -3
package/.turbo/turbo-build.log CHANGED
@@ -1,5 +1,5 @@
1
1
 
2
- > @pluv/io@0.2.2 build /home/runner/work/pluv/pluv/packages/io
2
+ > @pluv/io@0.2.3 build /home/runner/work/pluv/pluv/packages/io
3
3
  > tsup src/index.ts --format esm,cjs --dts
4
4
 
5
5
  CLI Building entry: src/index.ts
@@ -9,9 +9,9 @@
9
9
  ESM Build start
10
10
  CJS Build start
11
11
  ESM dist/index.mjs 26.79 KB
12
- ESM ⚡️ Build success in 104ms
12
+ ESM ⚡️ Build success in 115ms
13
13
  CJS dist/index.js 28.59 KB
14
- CJS ⚡️ Build success in 106ms
14
+ CJS ⚡️ Build success in 116ms
15
15
  DTS Build start
16
- DTS ⚡️ Build success in 2852ms
16
+ DTS ⚡️ Build success in 2500ms
17
17
  DTS dist/index.d.ts 12.86 KB
package/CHANGELOG.md CHANGED
@@ -1,5 +1,15 @@
1
1
  # @pluv/io
2
2
 
3
+ ## 0.2.3
4
+
5
+ ### Patch Changes
6
+
7
+ - 95b5ef8: breaking: update PluvRoom.broadcast api
8
+ - e23fbbe: update demo gif in README
9
+ - Updated dependencies [6858682]
10
+ - @pluv/crdt-yjs@0.2.0
11
+ - @pluv/types@0.1.2
12
+
3
13
  ## 0.2.2
4
14
 
5
15
  ### Patch Changes
package/README.md CHANGED
@@ -19,13 +19,19 @@
19
19
  <a href="https://github.com/pluv-io/pluv/blob/master/LICENSE">
20
20
  <img alt="GitHub" src="https://img.shields.io/github/license/pluv-io/pluv" alt="License MIT" />
21
21
  </a>
22
- <img src="https://badgen.net/badge/-/TypeScript?icon=typescript&label&labelColor=blue&color=555555" alt="TypeScript">
23
22
  <a href="https://commitizen.github.io/cz-cli/">
24
23
  <img src="https://img.shields.io/badge/commitizen-friendly-brightgreen.svg" alt="Commitizen friendly" />
25
24
  </a>
26
25
  <img src="https://img.shields.io/badge/website-coming%20soon!-blue" alt="Website coming soon!" />
27
26
  </p>
28
27
 
28
+ <p align="center">
29
+ <img src="https://badgen.net/badge/-/TypeScript?icon=typescript&label&labelColor=blue&color=555555" alt="TypeScript">
30
+ <a href="https://openbase.com/js/@pluv/io?utm_source=embedded&amp;utm_medium=badge&amp;utm_campaign=rate-badge">
31
+ <img src="https://badges.openbase.com/js/featured/@pluv/io.svg?token=FdWfpo90mCUb7InAjDG0KeXM/uH+KdHK3us2pNRgWf0=" alt="Featured on Openbase" />
32
+ </a>
33
+ </p>
34
+
29
35
  <p align="center">
30
36
  <a href="#intro">Intro</a> •
31
37
  <a href="#usage">Usage</a> •
@@ -34,7 +40,9 @@
34
40
  <a href="#license">License</a>
35
41
  </p>
36
42
 
37
- <img src="https://github.com/pluv-io/pluv/blob/master/assets/demo-events.gif?raw=true" alt="Demo" />
43
+ <p align="center">
44
+ <img src="https://github.com/pluv-io/pluv/blob/master/assets/demo-events.gif?raw=true" alt="Demo" />
45
+ </p>
38
46
 
39
47
  ## Intro
40
48
 
@@ -45,14 +53,13 @@ Pluv.IO allows you to build real-time collaborate features with a fully end-to-e
45
53
  So you can do this:
46
54
 
47
55
  ```tsx
56
+ const broadcast = usePluvBroadcast();
57
+
48
58
  usePluvEvent("RECEIVE_MESSAGE", ({ data }) => {
49
59
  setMessages([...messages, data.message]);
50
60
  });
51
61
 
52
- usePluvBroadcast({
53
- type: "SEND_MESSAGE",
54
- data: { message: "Hello world!" },
55
- });
62
+ broadcast("SEND_MESSAGE", { message: "Hello world!" });
56
63
  ```
57
64
 
58
65
  And this:
@@ -116,9 +123,9 @@ And more. With **E2E type-safety**, **great intellisense** and the **[yjs](https
116
123
  - ✅ [Map](https://docs.yjs.dev/api/shared-types/y.map)
117
124
  - ✅ [Array](https://docs.yjs.dev/api/shared-types/y.array)
118
125
  - ✅ [Text](https://docs.yjs.dev/api/shared-types/y.text)
119
- - ⬜ [XmlFragment](https://docs.yjs.dev/api/shared-types/y.xmlfragment)
120
- - ⬜ [XmlElement](https://docs.yjs.dev/api/shared-types/y.xmlelement)
121
- - ⬜ [XmlText](https://docs.yjs.dev/api/shared-types/y.xmltext)
126
+ - ✅ [XmlFragment](https://docs.yjs.dev/api/shared-types/y.xmlfragment)
127
+ - ✅ [XmlElement](https://docs.yjs.dev/api/shared-types/y.xmlelement)
128
+ - ✅ [XmlText](https://docs.yjs.dev/api/shared-types/y.xmltext)
122
129
  - ⬜ Studio (admin & developer panel)
123
130
 
124
131
  ### Runtimes
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pluv/io",
3
- "version": "0.2.2",
3
+ "version": "0.2.3",
4
4
  "description": "@pluv/io server-side websocket manager",
5
5
  "author": "leedavidcs",
6
6
  "license": "MIT",
@@ -21,7 +21,7 @@
21
21
  "chalk": "^4.1.2",
22
22
  "jose": "^4.11.2",
23
23
  "wonka": "^6.1.2",
24
- "@pluv/crdt-yjs": "^0.1.3",
24
+ "@pluv/crdt-yjs": "^0.2.0",
25
25
  "@pluv/types": "^0.1.2"
26
26
  },
27
27
  "peerDependencies": {
@@ -32,7 +32,7 @@
32
32
  "typescript": "^4.9.4",
33
33
  "yjs": "^13.5.44",
34
34
  "@pluv/tsconfig": "^0.1.2",
35
- "eslint-config-pluv": "^0.1.2"
35
+ "eslint-config-pluv": "^0.1.3"
36
36
  },
37
37
  "scripts": {
38
38
  "build": "tsup src/index.ts --format esm,cjs --dts",