@kitr/kit-realtime 0.5.0 → 0.7.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 +1 -1
  2. package/package.json +42 -4
package/README.md CHANGED
@@ -6,6 +6,6 @@
6
6
  pnpm dlx @kitr/kitr new my-app --kit realtime
7
7
  ```
8
8
 
9
- Read the guide at https://kitr.dev/docs/cli.
9
+ Read the guide at https://kitr.dev/kits/realtime.
10
10
 
11
11
  Part of [kitr](https://kitr.dev), the TypeScript framework where everything is an add-on. MIT licensed.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@kitr/kit-realtime",
3
- "version": "0.5.0",
3
+ "version": "0.7.0",
4
4
  "description": "kitr new --kit realtime: A chat room: typed WebSocket channels that feed the query cache, a messages controller, rooms in the URL.",
5
5
  "kitr": {
6
6
  "name": "realtime",
@@ -9,7 +9,45 @@
9
9
  "category": "kits",
10
10
  "runsOn": "both",
11
11
  "kind": "kit",
12
- "setup": "./kitr"
12
+ "setup": "./kitr",
13
+ "kit": {
14
+ "base": "fullstack",
15
+ "audience": "Anyone building chat, live dashboards or collaboration, where every screen updates at once.",
16
+ "highlights": [
17
+ {
18
+ "title": "A chat room",
19
+ "text": "Rooms live in the URL, and messages reach every open tab as they are sent."
20
+ },
21
+ {
22
+ "title": "A typed channel",
23
+ "text": "`app/channels/chat.ts` defines the messages once for the server and the client."
24
+ },
25
+ {
26
+ "title": "Pick the transport",
27
+ "text": "WebSocket by default, or Socket.IO or server-sent events in `config/realtime.ts`."
28
+ },
29
+ {
30
+ "title": "Tested end to end",
31
+ "text": "`test/messages.test.ts` sends a message through the API."
32
+ }
33
+ ],
34
+ "example": "examples/realtime",
35
+ "entry": "app/pages/chat.tsx",
36
+ "run": [
37
+ [
38
+ "kitr dev",
39
+ "The chat and its API; open two tabs to see messages arrive"
40
+ ],
41
+ [
42
+ "kitr build",
43
+ "Both platforms, ready for `kitr start`"
44
+ ],
45
+ [
46
+ "npm test",
47
+ "Vitest, starting with the messages test"
48
+ ]
49
+ ]
50
+ }
13
51
  },
14
52
  "type": "module",
15
53
  "license": "MIT",
@@ -18,7 +56,7 @@
18
56
  "url": "git+https://github.com/kitrjs/kitr.git",
19
57
  "directory": "packages/kit-realtime"
20
58
  },
21
- "homepage": "https://kitr.dev/docs/cli",
59
+ "homepage": "https://kitr.dev/kits/realtime",
22
60
  "bugs": "https://github.com/kitrjs/kitr/issues",
23
61
  "publishConfig": {
24
62
  "access": "public"
@@ -40,7 +78,7 @@
40
78
  "kitr-kit"
41
79
  ],
42
80
  "dependencies": {
43
- "@kitr/core": "0.5.0"
81
+ "@kitr/core": "0.7.0"
44
82
  },
45
83
  "devDependencies": {
46
84
  "tsdown": "^0.23.7",