@stage5/lumine 0.1.2 → 0.1.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.
- package/package.json +1 -1
- package/sdk/BUILD_SDK_INDEX.md +21 -5
package/package.json
CHANGED
package/sdk/BUILD_SDK_INDEX.md
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# Build SDK Index
|
|
2
2
|
|
|
3
|
-
Version: 1.
|
|
4
|
-
Updated: 2026-05-
|
|
5
|
-
Generated: 2026-05-
|
|
3
|
+
Version: 1.24.0
|
|
4
|
+
Updated: 2026-05-26
|
|
5
|
+
Generated: 2026-05-26T10:20:06.718Z
|
|
6
6
|
|
|
7
7
|
## Notes
|
|
8
8
|
- This SDK is injected into Build iframes via the Build preview/runtime.
|
|
@@ -21,7 +21,7 @@ Generated: 2026-05-26T08:23:45.901Z
|
|
|
21
21
|
- Twinkle.ai.chat history entries must use { role, content }; map local message.text fields to content before passing history.
|
|
22
22
|
|
|
23
23
|
## Token Scopes
|
|
24
|
-
files:read, user:read, users:read, dailyReflections:read, content:read, sharedDb:read, sharedDb:write, privateDb:read, privateDb:write, files:write, chat:read, chat:write, notifications:read, notifications:write, reminders:read, reminders:write
|
|
24
|
+
files:read, user:read, users:read, dailyReflections:read, content:read, sharedDb:read, sharedDb:write, privateDb:read, privateDb:write, files:write, chat:read, chat:write, notifications:read, notifications:write, notifications:emit, reminders:read, reminders:write
|
|
25
25
|
|
|
26
26
|
## Namespaces
|
|
27
27
|
|
|
@@ -78,12 +78,28 @@ files:read, user:read, users:read, dailyReflections:read, content:read, sharedDb
|
|
|
78
78
|
|
|
79
79
|
### Twinkle.notifications
|
|
80
80
|
- getLaunchTarget() | scopes: none
|
|
81
|
-
- Returns: { notificationId, buildId, eventKey, eventLabel, target } | null
|
|
81
|
+
- Returns: { notificationId, buildId, eventKey, eventLabel, target, payload? } | null
|
|
82
82
|
- Read the current notification launch target, if the app was opened from a Build notification.
|
|
83
83
|
- onLaunchTarget(listener, { immediate } = {}) | scopes: none
|
|
84
84
|
- Returns: unsubscribe()
|
|
85
85
|
- Listen for notification launch targets while the Build app is already open.
|
|
86
86
|
- Example: const off = Twinkle.notifications.onLaunchTarget((launchTarget) => focusEntry(launchTarget?.target?.focus?.entryId));
|
|
87
|
+
- async getSubscription(channelKey, { targetKey }) | scopes: notifications:read
|
|
88
|
+
- Returns: { subscription }
|
|
89
|
+
- Read whether the current viewer is subscribed to an app-defined notification channel target.
|
|
90
|
+
- Example: const { subscription } = await Twinkle.notifications.getSubscription('room.message', { targetKey: 'room:lobby' });
|
|
91
|
+
- async subscribe(channelKey, { targetKey, launchTarget }) | scopes: notifications:write
|
|
92
|
+
- Returns: { subscription }
|
|
93
|
+
- Subscribe the current viewer to an app-defined notification channel target.
|
|
94
|
+
- Example: await Twinkle.notifications.subscribe('room.message', { targetKey: 'room:lobby', launchTarget: { view: 'room', roomId: 'lobby' } });
|
|
95
|
+
- async unsubscribe(channelKey, { targetKey }) | scopes: notifications:write
|
|
96
|
+
- Returns: { subscription: null }
|
|
97
|
+
- Unsubscribe the current viewer from an app-defined notification channel target.
|
|
98
|
+
- Example: await Twinkle.notifications.unsubscribe('room.message', { targetKey: 'room:lobby' });
|
|
99
|
+
- async notifySubscribers(channelKey, { targetKey, eventKey, label, summary, launchTarget, payload }) | scopes: notifications:emit
|
|
100
|
+
- Returns: { sent }
|
|
101
|
+
- Notify viewers who opted into an app-defined channel target, without requiring a sharedDb write.
|
|
102
|
+
- Example: await Twinkle.notifications.notifySubscribers('room.message', { targetKey: 'room:lobby', eventKey: 'room.message.created', label: 'Room messages', summary: 'posted in Lobby', launchTarget: { view: 'room', roomId: 'lobby', messageId } });
|
|
87
103
|
- async getSubjectUpdateSubscription(subjectId) | scopes: notifications:read
|
|
88
104
|
- Returns: { subscription }
|
|
89
105
|
- Read whether the current viewer is subscribed to Build notifications for updates to a subject.
|