@gamention/pulse-shared 0.1.0 → 0.1.1
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.
- package/README.md +31 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# @gamention/pulse-shared
|
|
2
|
+
|
|
3
|
+
Shared TypeScript types, constants, and WebSocket protocol definitions for **Pulse** — a real-time collaboration SDK.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @gamention/pulse-shared
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
> You typically don't need to install this directly. It's included as a dependency of `@gamention/pulse-core` and `@gamention/pulse-elements`.
|
|
12
|
+
|
|
13
|
+
## What's Inside
|
|
14
|
+
|
|
15
|
+
- **Types** — `Thread`, `Comment`, `PinPosition`, `Attachment`, `PresenceUser`, `Notification`, `Reaction`, etc.
|
|
16
|
+
- **Protocol** — Full WebSocket message definitions (`ClientMessage` / `ServerMessage` unions)
|
|
17
|
+
- **Constants** — Cursor throttle, presence heartbeat, reconnect delays, user colors
|
|
18
|
+
|
|
19
|
+
## Usage
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import type { Thread, Comment, PinPosition, Attachment } from '@gamention/pulse-shared';
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Documentation
|
|
26
|
+
|
|
27
|
+
Full docs at **[pulse.hire.rest/docs](https://pulse.hire.rest/docs)**
|
|
28
|
+
|
|
29
|
+
## License
|
|
30
|
+
|
|
31
|
+
MIT
|
package/package.json
CHANGED