SDK Guides
In-depth guides for building with the @proveanything/smartlinks SDK
Core Features
AI & Chat Completions
Chat completions, RAG product assistants, voice integration, and podcast generation.
Communications & Broadcasts
Transactional sends, multi-channel broadcasts, consent management, push registration, and analytics.
Widget System
Embeddable React components for SmartLinks apps with cross-app navigation and theming.
Containers
Full public app experience packaged as embeddable React components.
Mobile Admin Container
In-the-field operator/admin surface optimised for mobile, shipped as a separate bundle.
Real-Time Messaging
Ably real-time messaging for live chat, polls, presence, and collaborative features.
Forms
Platform-managed form definitions and submissions, plus the React forms package.
Executor Model
How the SmartLinks executor evaluates and runs configured app behaviour.
Native Capability Facade
Thin contract layer between microapps and host device capabilities (Capacitor, PWA, browser).
Data & Storage
App Objects: Cases, Threads & Records
Three generic app-scoped object types with JSONB zones, visibility levels, and flexible schemas.
App Records Pattern
Canonical guide for microapps storing per-product, per-variant, per-batch, or rule-targeted data.
App Data Storage
User-specific and collection/product-scoped data storage patterns.
Caching Strategy
Multi-tier caching system with in-memory, sessionStorage, and IndexedDB layers.
Attestations
Postgres-backed, append-only fact log with polymorphic subjects and hash-chain integrity.
Product Facets SDK
Simple SDK-facing reference for the product facet API.
Product Features
Proof Claiming Methods
NFC tags, serial numbers, virtual proofs, and auto-generated claims for product registration.
Container Tracking
Physical or logical groupings with hierarchical nesting, item membership, and attestation history.
Loyalty: Points, Members & Rules
Build loyalty programmes on any collection with earning rules, balances, and transaction history.
Interactions: Event Tracking
Structured business events and outcomes that drive journeys, dashboards, and aggregated results.
Collection Analytics
Build collection analytics dashboards and fire-and-forget tracking with the SDK.
Analytics Metadata Conventions
Recommended standard analytics keys and conventions for custom dimensions.
Auth Kit
End-user authentication flows: email/password, magic links, OAuth, phone OTP, profiles.
Deep Link Discovery
Register and discover navigable states for portal menus, AI orchestrators, and other apps.
Utility Functions
Portal URL building, condition validation, and common helper functions.
UI Utilities
Shared UI helpers and primitives for SmartLinks apps.
Integration
Liquid Templates
Dynamic content rendering with Liquid templating for emails, notifications, and personalised content.
iframe Responder
Parent-side iframe communication with API proxying, auth sync, and deep linking.
iframe Streaming Parent Changes
Parent-side changes for AI streaming when an embedded SmartLinks app runs in iframe proxy mode.
Theme System
Dynamic theming via URL parameters and postMessage for iframe apps.
Theme Default Colors
Default HSL color values for light and dark mode themes.
Internationalization (i18n)
URL-based language selection, static translations, dynamic overrides, and widget support.
Translations
Managing translation strings and language assets across SmartLinks apps.