@cubid/comms
v0.1.0
Published
Signed-in messaging profile helpers for Cubid Passport notification channels and preferences.
Readme
@cubid/comms
Signed-in messaging profile helpers for Cubid Passport notification channels and preferences.
Use @cubid/comms when a Passport-authenticated user needs to manage
Cubid-owned notification channels, verification steps, or messaging
preferences without exposing raw destinations or provider internals to the app.
Choose this package instead of:
@cubid/corefor Passport-user profile management surfaces@cubid/browserfor hosted browser flows@cubid/reactfor React-specific UI composition
Use @cubid/core later for server-authenticated dapp notification send and
status helpers. Those APIs stay separate from signed-in user channel
management.
Install
pnpm add @cubid/commsRegistry availability
- npm-only
API reference
- Root package matrix: /Users/botmaster/src/cubid/cubid-sdk-v2/README.md
- Machine-readable API reference: /Users/botmaster/src/cubid/cubid-sdk-v2/docs/reference/api/comms.json
Current scope
This first package slice defines the signed-in Passport-user client boundary for future flexible messaging helpers.
Current helpers:
createCubidCommsClient(...)client.channels.list()client.channels.startVerification(...)client.channels.completeVerification(...)client.channels.update(...)client.preferences.list()client.preferences.update(...)getActiveNotificationCategoryGrants(...)hasNotificationCategoryGrant(...)
The channel helpers expose only redacted metadata:
- channel id and type
- provider key
- label
- masked display hint
- verification and lifecycle status flags
- timestamps
Allow Page notification grants are modeled only as category permission state. This package does not wrap the hosted Allow Page grant routes directly and does not treat grants as access to channels or raw destinations.
This package intentionally does not add:
- dapp-authenticated notification send helpers
- hosted Allow Page grant wrappers
- raw email addresses, Telegram identifiers, ciphertext, or provider secrets
Those behaviors remain deferred to later roadmap slices.
