@veltdev/ace-crdt 1.0.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 (17) hide show
  1. package/README.md +56 -0
  2. package/cjs/index.js +1610 -0
  3. package/cjs/index.js.map +1 -0
  4. package/esm/index.js +1583 -0
  5. package/esm/index.js.map +1 -0
  6. package/esm/types/content.d.ts +13 -0
  7. package/esm/types/content.d.ts.map +1 -0
  8. package/esm/types/index.d.ts +5 -0
  9. package/esm/types/index.d.ts.map +1 -0
  10. package/esm/types/manager.d.ts +113 -0
  11. package/esm/types/manager.d.ts.map +1 -0
  12. package/esm/types/types.d.ts +118 -0
  13. package/esm/types/types.d.ts.map +1 -0
  14. package/esm/types/utils.d.ts +6 -0
  15. package/esm/types/utils.d.ts.map +1 -0
  16. package/index.d.ts +238 -0
  17. package/package.json +37 -0
package/README.md ADDED
@@ -0,0 +1,56 @@
1
+ # Velt Ace CRDT Core Library
2
+
3
+ With Velt Ace CRDT Core Library, you can add powerful multiplayer editing and state synchronization features to any JavaScript application using Ace. Works with Angular, Vue, Svelte, Solid, and Vanilla JS.
4
+
5
+ The library provides **framework-agnostic realtime primitives**:
6
+
7
+ - Universal API for managing shared state and providers
8
+ - Fully-managed on a scalable realtime backend
9
+ - Powered by Yjs for industry-standard conflict resolution
10
+
11
+ **Features include:**
12
+
13
+ - **Multiplayer Editing** with real-time synchronization
14
+ - **Collaboration** with presence and cursors
15
+ - **Conflict Resolution** ensuring document consistency across all clients
16
+ - **Offline Support** with automatic synchronization upon reconnection
17
+ - **Cross-Framework Support** (Angular, Vue, Svelte, Solid, Vanilla JS)
18
+ - ... and so much more
19
+
20
+ ## Installation
21
+
22
+ ```bash
23
+ npm install @veltdev/ace-crdt @veltdev/crdt ace-builds @veltdev/client yjs y-protocols
24
+ ```
25
+
26
+ ## Documentation
27
+
28
+ * Read the [documentation](https://docs.velt.dev/realtime-collaboration/crdt/setup) for setup guides and API references.
29
+
30
+ ## Use cases
31
+
32
+ The Ace CRDT library is used to power:
33
+
34
+ * Collaborative editing tools
35
+ * Real-time document workspaces
36
+ * Internal wikis and knowledge bases
37
+ * Shared meeting notes and agendas
38
+ * Any shared, mutable environment
39
+
40
+ ## Resources
41
+
42
+ * Explore [multiplayer editing](https://velt.dev/libraries) to see features like collaborative text, whiteboards, and data grids.
43
+ * [Sample Apps](https://velt.dev/examples): Check out example implementations for various use cases.
44
+
45
+ ## Releases
46
+
47
+ * See the [latest changes](https://docs.velt.dev/release-notes/).
48
+
49
+ ## Security
50
+
51
+ * Velt is SOC2 Type 2 and HIPAA compliant. [Learn more](https://velt.dev/security)
52
+
53
+ ## Community
54
+
55
+ * [X](https://x.com/veltjs): To receive updates, announcements,
56
+ and general Velt tips.