@pluv/io 0.2.1 → 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 +5 -5
  2. package/CHANGELOG.md +19 -0
  3. package/README.md +23 -15
  4. package/package.json +7 -7
package/.turbo/turbo-build.log CHANGED
@@ -1,5 +1,5 @@
1
1
 
2
- > @pluv/io@0.2.1 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
@@ -8,10 +8,10 @@
8
8
  CLI Target: es6
9
9
  ESM Build start
10
10
  CJS Build start
11
- CJS dist/index.js 28.59 KB
12
- CJS ⚡️ Build success in 95ms
13
11
  ESM dist/index.mjs 26.79 KB
14
- ESM ⚡️ Build success in 96ms
12
+ ESM ⚡️ Build success in 115ms
13
+ CJS dist/index.js 28.59 KB
14
+ CJS ⚡️ Build success in 116ms
15
15
  DTS Build start
16
- DTS ⚡️ Build success in 2778ms
16
+ DTS ⚡️ Build success in 2500ms
17
17
  DTS dist/index.d.ts 12.86 KB
package/CHANGELOG.md CHANGED
@@ -1,5 +1,24 @@
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
+
13
+ ## 0.2.2
14
+
15
+ ### Patch Changes
16
+
17
+ - fe80d7b: added preview disclaimer about breaking changes in the readme
18
+ - Updated dependencies [fe80d7b]
19
+ - @pluv/crdt-yjs@0.1.3
20
+ - @pluv/types@0.1.2
21
+
3
22
  ## 0.2.1
4
23
 
5
24
  ### Patch Changes
package/README.md CHANGED
@@ -1,3 +1,6 @@
1
+ > **Disclaimer:**
2
+ > This package is currently in preview and may have breaking changes between versions. Please wait for a `v1.0.0` stable release before using this in production.
3
+
1
4
  <h1 align="center">
2
5
  <br>
3
6
  <img src="https://github.com/pluv-io/pluv/blob/master/assets/pluv-icon-192x192.png?raw=true" alt="Pluv.IO" width="180" style="border-radius:16px">
@@ -16,11 +19,17 @@
16
19
  <a href="https://github.com/pluv-io/pluv/blob/master/LICENSE">
17
20
  <img alt="GitHub" src="https://img.shields.io/github/license/pluv-io/pluv" alt="License MIT" />
18
21
  </a>
19
- <img src="https://badgen.net/badge/-/TypeScript?icon=typescript&label&labelColor=blue&color=555555" alt="TypeScript">
20
22
  <a href="https://commitizen.github.io/cz-cli/">
21
23
  <img src="https://img.shields.io/badge/commitizen-friendly-brightgreen.svg" alt="Commitizen friendly" />
22
24
  </a>
23
- <img src="https://img.shields.io/badge/docs-coming%20soon!-blue" alt="Docs coming soon!" />
25
+ <img src="https://img.shields.io/badge/website-coming%20soon!-blue" alt="Website coming soon!" />
26
+ </p>
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>
24
33
  </p>
25
34
 
26
35
  <p align="center">
@@ -31,27 +40,26 @@
31
40
  <a href="#license">License</a>
32
41
  </p>
33
42
 
34
- <img src="https://github.com/pluv-io/pluv/blob/master/assets/demo-events.gif?raw=true" alt="Demo" />
35
-
36
- <h3 align="center">Documentation Website coming soon!</h3>
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>
37
46
 
38
47
  ## Intro
39
48
 
40
49
  Pluv.IO allows you to build real-time collaborate features with a fully end-to-end type-safe api.
41
50
 
42
- ### Why
51
+ ### Why?
43
52
 
44
53
  So you can do this:
45
54
 
46
55
  ```tsx
56
+ const broadcast = usePluvBroadcast();
57
+
47
58
  usePluvEvent("RECEIVE_MESSAGE", ({ data }) => {
48
59
  setMessages([...messages, data.message]);
49
60
  });
50
61
 
51
- usePluvBroadcast({
52
- type: "SEND_MESSAGE",
53
- data: { message: "Hello world!" },
54
- });
62
+ broadcast("SEND_MESSAGE", { message: "Hello world!" });
55
63
  ```
56
64
 
57
65
  And this:
@@ -101,7 +109,7 @@ return (
101
109
  );
102
110
  ```
103
111
 
104
- And more. With great **E2E type-safety**, **intellisense** and the **[yjs](https://docs.yjs.dev/) ecosystem**.
112
+ And more. With **E2E type-safety**, **great intellisense** and the **[yjs](https://docs.yjs.dev/) ecosystem**.
105
113
 
106
114
  ### Features
107
115
 
@@ -115,9 +123,9 @@ And more. With great **E2E type-safety**, **intellisense** and the **[yjs](https
115
123
  - ✅ [Map](https://docs.yjs.dev/api/shared-types/y.map)
116
124
  - ✅ [Array](https://docs.yjs.dev/api/shared-types/y.array)
117
125
  - ✅ [Text](https://docs.yjs.dev/api/shared-types/y.text)
118
- - ⬜ [XmlFragment](https://docs.yjs.dev/api/shared-types/y.xmlfragment)
119
- - ⬜ [XmlElement](https://docs.yjs.dev/api/shared-types/y.xmlelement)
120
- - ⬜ [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)
121
129
  - ⬜ Studio (admin & developer panel)
122
130
 
123
131
  ### Runtimes
@@ -142,7 +150,7 @@ And more. With great **E2E type-safety**, **intellisense** and the **[yjs](https
142
150
 
143
151
  Before diving into documentation, check out usage instructions for your selected platform:
144
152
 
145
- > **Note**
153
+ > **Note:**
146
154
  > `@pluv/io`, `@pluv/client`, `@pluv/crdt-yjs` and `@pluv/react` all require [yjs](https://docs.yjs.dev/) as a peer dependency.
147
155
 
148
156
  ### Platforms
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pluv/io",
3
- "version": "0.2.1",
3
+ "version": "0.2.3",
4
4
  "description": "@pluv/io server-side websocket manager",
5
5
  "author": "leedavidcs",
6
6
  "license": "MIT",
@@ -18,21 +18,21 @@
18
18
  },
19
19
  "dependencies": {
20
20
  "@panva/hkdf": "^1.0.2",
21
- "@pluv/crdt-yjs": "^0.1.2",
22
- "@pluv/types": "^0.1.1",
23
21
  "chalk": "^4.1.2",
24
22
  "jose": "^4.11.2",
25
- "wonka": "^6.1.2"
23
+ "wonka": "^6.1.2",
24
+ "@pluv/crdt-yjs": "^0.2.0",
25
+ "@pluv/types": "^0.1.2"
26
26
  },
27
27
  "peerDependencies": {
28
28
  "yjs": "^13.0.0"
29
29
  },
30
30
  "devDependencies": {
31
- "@pluv/tsconfig": "^0.1.1",
32
- "eslint-config-pluv": "^0.1.1",
33
31
  "tsup": "^6.5.0",
34
32
  "typescript": "^4.9.4",
35
- "yjs": "^13.5.44"
33
+ "yjs": "^13.5.44",
34
+ "@pluv/tsconfig": "^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",