DOM Package Overview
What the Tiquo DOM Package provides
Tiquo Example DOM Package Project
Explore a live example of the DOM Package in a customer-facing application.
tiquo-co/dom-package-example
Review the source code for the Tiquo DOM Package example project.
The Tiquo DOM Package (@tiquo/dom-package) is a headless JavaScript SDK for browser-based Tiquo integrations. It provides customer authentication, first-party website analytics, customer data helpers, custom service catalogs, customer-flow and membership embeds, locked service-booking embeds, session management, and WebView token handoff.
Headless means that the SDK supplies authentication, data, and integration methods rather than finished page components. Your application owns forms, cards, navigation, loading states, errors, and profile pages. Tiquo supplies its own transactional interface only inside hosted customer-flow, service-booking, and membership iframes.
Use the DOM Package when you control the JavaScript build for your website or app and want a typed SDK that works directly with the Customer API.
New integrations should import Tiquo as the main SDK class. Specialist exports such as TiquoAnalytics and TiquoPhone are available for analytics-only setups and phone number utilities, while TiquoAuth remains as a backwards-compatible alias for older authentication integrations.
What it provides
| Area | Description |
|---|---|
| Setup | Install the package, get a public key, and initialize the SDK |
| Customer Authentication | Sign customers in with an email OTP flow |
| Website Analytics | Track first-party pageviews, custom events, and known-customer activity |
| Customer Data | Fetch and update the customer profile, preferences, and company memberships |
| Enquiries | Create enquiries from your own forms and list a signed-in customer's enquiries |
| Orders and Bookings | List orders and bookings, cancel or reschedule bookings, and fetch receipts and booking tickets |
| Pass Balances | Show how many Access Passes and Guest Passes the signed-in customer has left |
| Marketing Signup | Collect newsletter and SMS opt-ins without login from a custom form |
| Business Policies | Retrieve and display saved business policies using stable policy IDs |
| Service Catalogs and Locked Booking | Load a customer flow's services, build custom catalog and detail pages, and embed booking for one selected service |
| Embeds and Memberships | Embed customer flows and public membership signup, pass signed-in sessions securely, and understand membership listing behavior |
| Session Management | Handle auth state changes, logout, token refresh, multi-tab sync, and cleanup |
| Framework Integration | Connect the headless SDK to React or another reactive UI framework |
| Utilities and Errors | Normalize international phone numbers and handle typed SDK errors |
| WebView Integration | Pass native app tokens into a WebView-hosted page |
| Dashboard Configuration | Configure public keys, website domains, OTP sender details, and session behavior |
| Consent and Security | Set analytics consent modes and understand domain protection and token handling |
DOM Package, Hosted Package, and hosted iframes
These are related integration layers, but they are not interchangeable:
| Layer | How it is added | What it provides |
|---|---|---|
| DOM Package | Install @tiquo/dom-package from npm and call typed JavaScript methods | Headless authentication, data, analytics, token, catalog, and embed helpers for applications with a build step |
| Hosted Package | Add the Tiquo hosted script and data-tiquo-* HTML attributes | Declarative authentication and customer-data behavior for Webflow and other site builders |
| Hosted customer flow | Add a Tiquo iframe directly or create it with a DOM or Hosted Package embed helper | Tiquo's transactional UI for booking or membership signup |
Seeing a Tiquo iframe on a page does not mean the page uses the Hosted Package. Both packages can create and authenticate the same hosted flows, but the npm SDK and hosted script are separate delivery methods with different public APIs.
Method index
| Area | Main DOM Package methods |
|---|---|
| Authentication | sendOTP(), verifyOTP(), getUser(), isAuthenticated(), logout() |
| Customer data | updateProfile(), getProfileFields(), uploadProfilePhoto(), getCompanies(), getCompanyColleagues() |
| Enquiries | createEnquiry(), getEnquiries() |
| Orders and bookings | getOrders(), getBookings(), getUpcomingBookings(), cancelBooking(), getBookingRescheduleOptions(), rescheduleBooking(), getReceipt(), downloadReceipt(), downloadBookingTicket(), addBookingToCalendar() |
| Wallet cards | getWalletCardLinks() |
| Guest invitations | getGuestFlows(), getGuestFlow(), createGuestInvitations(), getGuestInvitation(), getGuestInvitations() (sent invitations with history), acceptGuestInvitation(), getGuestPasses() (lists live invitations) |
| Pass balances | getPassBalances() (counts Access Passes and Guest Passes) |
| Marketing signup | subscribeToMarketing() |
| Business policies | getPolicies(), getPolicy(), displayPolicy() |
| Service catalogs | getFlowServices(), getFlowService(), getFlowAvailability() |
| Embeds | embedCustomerFlow(), embedServiceBooking(), embedMembership(), getIframeToken() |
| Saved cards | embedCardForm(), embedPaymentMethods(), getPaymentMethods(), setDefaultPaymentMethod(), removePaymentMethod() |
| Sessions and external tokens | onAuthStateChange(), getAccessToken(), getRefreshToken(), initWithTokens(), destroy() |
| Analytics | tiquo.analytics, TiquoAnalytics, setConsent(), getConsent() |
| Utilities | TiquoPhone, TiquoAuthError |
From version 1.14.0, getMemberships() returns the signed-in customer's memberships and the organization's public plans, including read-only memberships from a connected system such as HubSpot (isExternal: true). See Listing memberships and plans. From version 1.18.0, getPermissions() and hasPermission(name) return the membership permissions the customer holds. From version 1.19.0, the consent option, setConsent() and getConsent() control analytics consent, and version 1.20.0 adds cookieless analytics. Version 1.22.0 adds booking and order links, event names, descriptions and prices to bookings, the receipt number and VAT summary to receipts, and downloadReceipt(). Version 1.23.0 adds getProfileFields(), and version 1.24.0 adds addBookingToCalendar().