V3 capabilities
V3 capabilities
Every Fliplet JS API available to V3 apps, grouped by capability category. Each entry links to its full API reference. Ambient namespaces (preloaded into every app via fliplet-core) are marked preloaded; everything else is installable via add_dependencies.
Data
Fliplet.Cache(preloaded) — Run async operations once and memoize their results, with optional expiry and background refresh.Fliplet.DataSources— Connect to, query, insert, update, and delete records in Fliplet Data Sources from inside an app. All methods are promise-based.Fliplet.DataSources.Encryption— Automatically encrypt and decrypt selected Data Source columns on-device by registering a private key and column list.Fliplet.Storage and Fliplet.App.Storage(preloaded) — Persist JSON-serializable values to device or browser storage, scoped globally or to the current app.
Identity
Fliplet.Organizations(preloaded) — List the current user’s organizations and fetch audit logs with filters for type, date range, app, and session.Fliplet.Profile(preloaded) — Read and write namespaced user profile attributes (email, name, company, phone) and fetch the device UUID.Fliplet.Security— Persist a per-app structured object to encrypted device storage via the fliplet-security package — for app-local secrets, device tokens, and per-user preferences. Distinct from fliplet-encryption (Da…Fliplet.Session— Read, write, and clear the current user session — including cached offline sessions — for authentication state in Fliplet apps.Fliplet.User(preloaded) — Get and set the current user’s auth token, profile details, and preferences, and sign the user out.Fliplet.User.Biometrics(preloaded) — Check biometric availability and verify users with Face ID, Touch ID, or fingerprint inside native Fliplet apps.
Communications
Fliplet.Chat— Build one-to-one, group, and public-channel chat features. Fliplet.Chat owns the conversations and messages data sources internally — supply only the contacts list (who can chat with whom).Fliplet.Communicate— Send email, SMS, push notifications, and share URLs from a Fliplet app using a single Communicate namespace.Fliplet.Navigator.Notifications(preloaded) — Check notification support, request permission, and send local device notifications from JavaScript.Fliplet.Notifications— Read, send, and schedule in-app and push notifications in Fliplet apps, with support for scopes, read receipts, and badge counts.Fliplet.Socket— Real-time WebSocket connection to the Fliplet API with auto-authentication, server URL discovery, and dev/prod transport fallback via the fliplet-socket package.
Media
Fliplet.Barcode— Generate QR codes and 1D/2D barcodes on screen, and scan them from the device camera, via the fliplet-barcode package.Fliplet.Media— Browse folders, upload and manage files, and download media to devices via the Fliplet Media namespace.Fliplet.Media.Audio— Play, pause, stop, and seek audio files on device or from a URL in Fliplet apps via the Audio namespace.
Native
Fliplet.Native— Cordova-bridge APIs for native Fliplet apps — app management, updates, downloads, locale, notifications, status bar, and lifecycle interactions.Fliplet.Navigator(preloaded) — Detect online/offline state, listen for connectivity changes, and wait for the device to be ready.
Commerce
Fliplet.App.Submissions— Read App Store and Google Play submission metadata for the current Fliplet app — version, status, build numbers — via the fliplet-app-submissions package.Fliplet.Payments— Accept Stripe payments and checkout in Fliplet apps via Fliplet.Payments, with a products data source and webhook-driven order tracking.
Integration
Fliplet.API.request()(preloaded) — Make authenticated HTTP requests to Fliplet APIs with automatic URL construction, caching, offline queueing, and error handling.Fliplet.App.Tokens— Read the list of API tokens that authorise external services and backend integrations to call Fliplet APIs on behalf of an app.
Automation
App Actions V3(preloaded) — Write and run JavaScript code directly on the server or client to perform automations, scheduled tasks and on-demand operations.Fliplet.AI(preloaded) — Build AI features withFliplet.AI— chat, completions, streaming, image generation, transcription, and embeddings via OpenAI or Google Gemini proxies.Fliplet.Hooks(preloaded) — Register callbacks that run before or after key app events (e.g. form submit), with sync or async Promise handlers.
Analytics
fliplet-analytics-spa— Auto page-view tracker for V3 SPA apps. Hooks the History API so every client-side route change emits a pageView — no app code required.Fliplet.Analytics(preloaded) — Enable, disable, and check analytics tracking, and record custom app events and page views from JavaScript.
Observability
fliplet-error-tracking— Auto-loading runtime that captures JavaScript exceptions and unhandled promise rejections and batches them to Fliplet.App.Logs.
Framework
fliplet-runtime— V3 SPA bootstrap that wires Fliplet.Env, Registry, Studio, Navigator, and Locale into the global Fliplet object and manages the page-ready lifecycle.fliplet-service-worker— Background service worker that receives web push notifications, displays them, and marks them read — automatically registered by fliplet-core on web.Fliplet.Env(preloaded) — Read environment variables such asappId,appName,mode, andapiUrlfrom the current runtime.Fliplet.Locale(preloaded) — Translate strings and format dates and numbers in Fliplet components via Fliplet.Locale, the T() shorthand, and translation.json files using i18next.Fliplet.Registry(preloaded) — Store and retrieve runtime values and functions by key so components can share state and helpers.Fliplet.require(preloaded) — Load scripts and stylesheets on demand, and resolve lazy dependencies registered in the app bundle.Fliplet.Studio(preloaded) — Emit events to Fliplet Studio and listen for events from it when building widget interfaces.Fliplet.Widget(preloaded) — Access widget instance IDs, settings, and data, and coordinate save and ready events between widget and interface.
Navigation
Fliplet Router JS API— Fliplet.Router JS API reference for V3 apps. Covers getBasePath, isNative, getHistoryMode (platform-conditional history — path on web, hash on native), getRouteManifest, getRouteConfig, and resolveRo…Fliplet.Navigate(preloaded) — Navigate between app screens, open external URLs, pass query parameters, and handle back, home, and modal navigation via Fliplet.Navigate.Fliplet.Pages and Fliplet.Page(preloaded) — List app screens, get the current screen’s public URL, and build shareable URLs for any screen by ID.
Meta
Fliplet common functions(preloaded) — Utility helpers on the globalFlipletobject:Fliplet.compile()for templating andFliplet.guid()for unique IDs.Fliplet.App(preloaded) — Retrieve the current app’s public slug, build shareable screen URLs, and access app-level settings from JavaScript.Fliplet.Apps(preloaded) — List the Fliplet apps the current user can access, and filter between legacy V1 and modern V2 apps.Fliplet.Encode(preloaded) — Encode strings as base64 and double-encode URL query parameters safely for transport.Fliplet.parseError()(preloaded) — Turn any error response or object into a human-readable message by scanning common error properties.