@seaverse/data-service-sdk 0.8.0 → 0.9.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.
- package/README.md +27 -8
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,17 +2,36 @@
|
|
|
2
2
|
|
|
3
3
|
SeaVerse Data Service SDK for accessing Firestore with secure token management and three-tier permission model.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
---
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
## 🤖 **For LLM: START HERE!**
|
|
8
8
|
|
|
9
|
-
|
|
10
|
-
- ✅ Required fields (`_appId`, `_createdAt`, `_createdBy`)
|
|
11
|
-
- ✅ Correct Firestore paths
|
|
12
|
-
- ✅ Server timestamps
|
|
13
|
-
- ✅ Single import source
|
|
9
|
+
### 🚀 5-Minute Quick Start
|
|
14
10
|
|
|
15
|
-
|
|
11
|
+
**👉 Simplest Way**: Check **[LLM-FIRST.md](./LLM-FIRST.md)** - Complete HTML page examples (copy & paste ready)
|
|
12
|
+
|
|
13
|
+
**⚡ Core API Quick Reference** (Only 4 methods to remember):
|
|
14
|
+
|
|
15
|
+
| What You Want to Do | Use Which API | Code Example |
|
|
16
|
+
|---------------------|---------------|--------------|
|
|
17
|
+
| **Write Public Data** | `helper.addToPublicData()` | `await helper.addToPublicData('posts', {title: 'Hello'})` |
|
|
18
|
+
| **Read Public Data** | `helper.getPublicData()` | `const posts = await helper.getPublicData('posts')` |
|
|
19
|
+
| **Write Private Data** | `helper.addToUserData()` | `await helper.addToUserData('notes', {text: 'Secret'})` |
|
|
20
|
+
| **Read Private Data** | `helper.getUserData()` | `const notes = await helper.getUserData('notes')` |
|
|
21
|
+
|
|
22
|
+
**✨ Key Benefits**:
|
|
23
|
+
- ✅ `helper` automatically handles required fields (`_appId`, `_createdAt`, `_createdBy`)
|
|
24
|
+
- ✅ Automatically uses correct Firestore paths
|
|
25
|
+
- ✅ Automatically uses server timestamps
|
|
26
|
+
- ✅ Single import source (no need to import from multiple packages)
|
|
27
|
+
|
|
28
|
+
**🎯 Quick Links**:
|
|
29
|
+
- **[LLM-FIRST.md](./LLM-FIRST.md)** - Complete HTML examples (todo list, message board)
|
|
30
|
+
- **[LLM-QUICK-START.md](./LLM-QUICK-START.md)** - Code snippets and common mistakes
|
|
31
|
+
|
|
32
|
+
---
|
|
33
|
+
|
|
34
|
+
## 📖 For Developers
|
|
16
35
|
|
|
17
36
|
## Features
|
|
18
37
|
|
package/package.json
CHANGED