React SDK reference
Every public export from @akin-travel/partner-sdk (the React/Next.js SDK), extracted from JSDoc on the source. When a JSDoc comment changes, this file is regenerated at build time. Building on another stack? See Using the API.
Configuration
resolveConfig
Function
Resolve full config from partial user config
DEFAULT_CONFIG
Constant
Default configuration values All sensitive values are read from environment variables
STAGING_CONFIG
Constant
Staging configuration
DEV_CONFIG
Constant
Development configuration
AkinSDKConfig
Type
Configuration for the Akin Partner SDK.
Extends core’s framework-agnostic CoreAkinSDKConfig (partnerId,
apiKey, apiUrl, firebase, gipTenantId, environment, debug, verifyCallbackUrl)
with the React-binding-only i18n / currency concerns core does not own.
Client
createAkinClient
Function
Create an Apollo Client configured for partner SDK usage.
Delegates to core’s createAkinClient. The partner-SDK resolveConfig
(env-var driven apiUrl, i18n/currency passthrough) runs first and the
already-resolved apiUrl is handed to core so its environment-URL defaults
don’t override the binding’s env-var resolution.
gql
Export
setTokenProvider
Function
Set the GIP token provider for authenticated requests. Called internally by AkinAuthProvider.
clearTokenCache
Function
Clear the token cache (call on logout).
The provider wires these in by default; exported for advanced/custom hosts.
LocalStorageAdapter
Export
WebAuthnAuthenticator
Export
createWebFirebaseAuthClient
Export
WebFirebaseAuthClient
Type
WebFirebaseConfig
Type
consumers can type their own adapter implementations against the SDK.
StorageAdapter
Type
Authenticator
Type
FirebaseAuthClient
Type
AkinEnvironment
Type
FirebaseConfig
Type
Provider and hooks
AkinProvider
Export
useAkinAuth
Export
useSDK
Export
useAkinLoyalty
Export
I18nProvider
Export
useI18n
Export
useOptionalI18n
Export
DEFAULT_TRANSLATIONS
Export
DEFAULT_LOCALES
Export
CurrencyProvider
Export
useCurrency
Export
useOptionalCurrency
Export
Headless auth components
LoginForm
Export
SignupForm
Export
MagicLinkForm
Export
Auth guards
RequireAuth
Export
RequireGuest
Export
Auth types
AkinUser
Type
AkinMember
Type
AuthState
Type
AuthActions
Type
AuthContextValue
Type
SignUpData
Type
PasswordlessSignUpData
Type
LoginFormRenderProps
Type
SignupFormRenderProps
Type
MagicLinkFormRenderProps
Type
RequireAuthProps
Type
RequireAuthRenderProps
Type
RequireGuestProps
Type
RequireGuestRenderProps
Type
Headless loyalty components
TierCard
Export
TierProgress
Export
TransactionList
Export
PointsDisplay
Export
TierRequirementsTable
Export
SimpleTierCards
Export
LoyaltyCard
Export
UpcomingStays
Export
PreviousStays
Export
TierBenefits
Export
Loyalty types
TierConfig
Type
TierProgressType
Type
LoyaltyTransaction
Type
MemberTierHistory
Type
TransactionType
Type
TierChangeReason
Type
LoyaltyState
Type
LoyaltyActions
Type
LoyaltyContextValue
Type
TierCardRenderProps
Type
TierProgressRenderProps
Type
TransactionListRenderProps
Type
TierRequirement
Type
RequirementValueType
Type
RequirementOperator
Type
TierRequirementsTableRenderProps
Type
SimpleTierCardsRenderProps
Type
TierBenefit
Type
TierBenefitGroup
Type
TierBenefitsRenderProps
Type
BookingStatus
Type
MemberStay
Type
LoyaltyCardRenderProps
Type
UpcomingStaysRenderProps
Type
PreviousStaysRenderProps
Type
Tier Label Utilities
TIER_LABELS
Export
PARTNER_LABELS
Export
KEY_PRIORITY
Export
getLabel
Export
extractRequirementKeys
Export
Headless i18n components
LanguageSelector
Export
i18n types
LocaleCode
Type
LanguageOption
Type
TranslationDictionary
Type
Translations
Type
I18nConfig
Type
I18nState
Type
I18nActions
Type
I18nContextValue
Type
LanguageSelectorRenderProps
Type
LanguageSelectorProps
Type
Headless currency components
CurrencySelector
Export
Currency utilities
DEFAULT_CURRENCIES
Export
DEFAULT_EXCHANGE_RATES
Export
getCurrencyOption
Export
getCurrencySymbol
Export
formatCurrencyAmount
Export
convertCurrency
Export
Currency types
CurrencyCode
Type
CurrencyOption
Type
ExchangeRates
Type
CurrencyConfig
Type
CurrencyState
Type
CurrencyActions
Type
CurrencyContextValue
Type
CurrencySelectorRenderProps
Type
CurrencySelectorProps
Type
Headless account components
AccountInfoSection
Export
NotificationPreferencesSection
Export
PasskeySection
Export
Account hooks
useAccountForm
Export
Account GraphQL operations
UPDATE_MEMBER
Export
PASSKEY_REGISTRATION_OPTIONS
Export
PASSKEY_REGISTER
Export
MY_PASSKEYS
Export
PASSKEY_DELETE
Export
Account types
ProfileFormData
Type
NotificationPreferences
Type
PasskeyCredential
Type
AccountInfoRenderProps
Type
NotificationPreferencesRenderProps
Type
PasskeySectionRenderProps
Type
AccountPageRenderProps
Type
AccountInfoSectionProps
Type
NotificationPreferencesSectionProps
Type
PasskeySectionProps
Type
Headless header components
HeaderMenu
Export
UserAvatar
Export
LanguageAccordion
Export
CurrencyAccordion
Export
Header types
HeaderUserInfo
Type
MenuItem
Type
HeaderMenuRenderProps
Type
UserAvatarRenderProps
Type
LanguageAccordionRenderProps
Type
CurrencyAccordionRenderProps
Type
HeaderMenuProps
Type
UserAvatarProps
Type
LanguageAccordionProps
Type
CurrencyAccordionProps
Type
Phone input with country code selector
PhoneInput
Export
isValidPhoneNumber
Export
parsePhoneNumber
Export
getCountryCallingCode
Export
PhoneInputProps
Type
Country
Type
PhoneValue
Type
Preference constants for onboarding
PERK_PREFERENCES
Constant
Perk preferences - what rewards interest the member
VIBE_PREFERENCES
Constant
Vibe preferences - what atmosphere the member prefers
LOCATION_PREFERENCES
Constant
Location preferences - what types of places the member loves
PreferenceOption
Type
Preference options for loyalty onboarding