authhero 5.8.1 → 5.9.1

package/dist/types/generated/locale-types.d.ts

@@ -0,0 +1,690 @@
+export type Locale = "cs" | "da" | "en" | "fi" | "it" | "nb" | "pl" | "sv";
+export interface CommonScreen {
+    alertListTitle: () => string;
+    backText: () => string;
+    cancelText: () => string;
+    closeText: () => string;
+    contactSupportText: () => string;
+    continueText: () => string;
+    copyrightText: (vars: {
+        companyName: string;
+        currentYear: string;
+    }) => string;
+    errorText: () => string;
+    hidePasswordText: () => string;
+    loadingText: () => string;
+    orText: () => string;
+    privacyPolicyText: () => string;
+    showPasswordText: () => string;
+    termsOfServiceText: () => string;
+    termsShortText: () => string;
+    tryAgainText: () => string;
+}
+export interface ConsentScreen {
+    buttonText: () => string;
+    cancelButtonText: () => string;
+    description: (vars: {
+        clientName: string;
+    }) => string;
+    pageTitle: (vars: {
+        clientName: string;
+    }) => string;
+    scopesTitle: (vars: {
+        clientName: string;
+    }) => string;
+    title: (vars: {
+        clientName: string;
+    }) => string;
+}
+export interface DeviceFlowScreen {
+    buttonText: () => string;
+    codePlaceholder: () => string;
+    description: () => string;
+    "expired-code": () => string;
+    "invalid-code": () => string;
+    pageTitle: (vars: {
+        clientName: string;
+    }) => string;
+    title: () => string;
+}
+export interface EmailOtpChallengeScreen {
+    buttonText: () => string;
+    codeLabel: () => string;
+    codePlaceholder: () => string;
+    defaultDescription: () => string;
+    description: (vars: {
+        email: string;
+    }) => string;
+    "invalid-code": () => string;
+    noCode: () => string;
+    pageTitle: (vars: {
+        clientName: string;
+    }) => string;
+    resendText: () => string;
+    sessionExpired: () => string;
+    title: () => string;
+    unexpectedError: () => string;
+}
+export interface EmailVerificationScreen {
+    description: (vars: {
+        email: string;
+    }) => string;
+    pageTitle: (vars: {
+        clientName: string;
+    }) => string;
+    resendText: () => string;
+    successDescription: () => string;
+    successTitle: () => string;
+    title: () => string;
+}
+export interface InvitationScreen {
+    acceptButtonText: () => string;
+    description: (vars: {
+        clientName: string;
+        inviterName: string;
+        organizationName: string;
+    }) => string;
+    pageTitle: (vars: {
+        clientName: string;
+    }) => string;
+    title: () => string;
+}
+export interface LoginScreen {
+    alertListTitle: () => string;
+    buttonText: () => string;
+    description: (vars: {
+        clientName: string;
+    }) => string;
+    editEmailText: () => string;
+    emailPlaceholder: () => string;
+    enterACodeBtn: () => string;
+    federatedConnectionButtonText: (vars: {
+        connectionName: string;
+    }) => string;
+    footerLinkText: () => string;
+    footerText: () => string;
+    forgotPasswordText: () => string;
+    hidePasswordText: () => string;
+    invalidEmail: () => string;
+    invalidIdentifier: () => string;
+    invitationDescription: (vars: {
+        clientName: string;
+        companyName: string;
+        inviterName: string;
+    }) => string;
+    invitationTitle: () => string;
+    logoAltText: (vars: {
+        companyName: string;
+    }) => string;
+    "no-email": () => string;
+    "no-password": () => string;
+    pageTitle: (vars: {
+        clientName: string;
+    }) => string;
+    passwordLoginNotAvailable: () => string;
+    passwordPlaceholder: () => string;
+    phonePlaceholder: () => string;
+    separatorText: () => string;
+    sessionExpired: () => string;
+    showPasswordText: () => string;
+    signupActionLinkText: () => string;
+    signupActionText: () => string;
+    title: () => string;
+    tooManyFailedLogins: () => string;
+    unverifiedEmail: () => string;
+    userAccountDoesNotExist: () => string;
+    usernamePlaceholder: () => string;
+    usernameTooLong: (vars: {
+        max: string;
+    }) => string;
+    usernameTooShort: (vars: {
+        min: string;
+    }) => string;
+    passkeyButtonText: () => string;
+    wrongCredentials: () => string;
+}
+export interface LoginIdScreen {
+    alertListTitle: () => string;
+    "auth0-users-validation": () => string;
+    "authentication-failure": () => string;
+    buttonText: () => string;
+    "captcha-client-failure": (vars: {
+        errorCode: string;
+    }) => string;
+    "captcha-validation-failure": () => string;
+    captchaCodePlaceholder: () => string;
+    "custom-script-error-code": () => string;
+    description: (vars: {
+        clientName: string;
+    }) => string;
+    editEmailText: () => string;
+    emailPlaceholder: () => string;
+    federatedConnectionButtonText: (vars: {
+        connectionName: string;
+    }) => string;
+    footerLinkText: () => string;
+    footerText: () => string;
+    forgotPasswordText: () => string;
+    hidePasswordText: () => string;
+    "invalid-captcha": () => string;
+    "invalid-code": () => string;
+    "invalid-connection": () => string;
+    "invalid-email-format": () => string;
+    "invalid-email-phone": () => string;
+    "invalid-email-phone-username": () => string;
+    "invalid-email-username": () => string;
+    "invalid-expired-code": () => string;
+    "invalid-login-id": () => string;
+    "invalid-phone-username": () => string;
+    "invalid-recaptcha": () => string;
+    "invalid-username": (vars: {
+        characters: string;
+        max: string;
+        min: string;
+    }) => string;
+    invitationDescription: (vars: {
+        clientName: string;
+        companyName: string;
+        inviterName: string;
+    }) => string;
+    invitationTitle: () => string;
+    "ip-blocked": () => string;
+    logoAltText: (vars: {
+        companyName: string;
+    }) => string;
+    "no-db-connection": () => string;
+    "no-email": () => string;
+    "no-email-phone": () => string;
+    "no-email-phone-username": () => string;
+    "no-email-username": () => string;
+    "no-password": () => string;
+    "no-phone": () => string;
+    "no-phone-username": () => string;
+    "no-username": () => string;
+    pageTitle: (vars: {
+        clientName: string;
+    }) => string;
+    "password-breached": () => string;
+    passwordPlaceholder: () => string;
+    phoneOrEmailPlaceholder: () => string;
+    phoneOrUsernameOrEmailPlaceholder: () => string;
+    phoneOrUsernamePlaceholder: () => string;
+    phonePlaceholder: () => string;
+    "same-user-login": () => string;
+    selectCountryCode: (vars: {
+        countryCode: string;
+        countryName: string;
+        countryPrefix: string;
+    }) => string;
+    separatorText: () => string;
+    sessionExpired: () => string;
+    showPasswordText: () => string;
+    signupActionLinkText: () => string;
+    signupActionText: () => string;
+    termsAndConditionsTemplate: (vars: {
+        termsAndConditionsUrl: string;
+    }) => string;
+    title: () => string;
+    "user-blocked": () => string;
+    userAccountDoesNotExist: () => string;
+    usernameOnlyPlaceholder: () => string;
+    usernameOrEmailPlaceholder: () => string;
+    usernamePlaceholder: () => string;
+    usernameTooLong: (vars: {
+        max: string;
+    }) => string;
+    usernameTooShort: (vars: {
+        min: string;
+    }) => string;
+    "wrong-credentials": () => string;
+    "wrong-email-credentials": () => string;
+    "wrong-email-phone-credentials": () => string;
+    "wrong-email-phone-username-credentials": () => string;
+    "wrong-email-username-credentials": () => string;
+    "wrong-phone-credentials": () => string;
+    "wrong-phone-username-credentials": () => string;
+    passkeyButtonText: () => string;
+    "wrong-username-credentials": () => string;
+}
+export interface LoginPasswordScreen {
+    buttonText: () => string;
+    description: (vars: {
+        clientName: string;
+    }) => string;
+    forgotPasswordText: () => string;
+    hidePasswordText: () => string;
+    "no-password": () => string;
+    pageTitle: (vars: {
+        clientName: string;
+    }) => string;
+    "password-breached": () => string;
+    passwordPlaceholder: () => string;
+    showPasswordText: () => string;
+    signingInAs: (vars: {
+        email: string;
+    }) => string;
+    title: () => string;
+    unverifiedEmail: () => string;
+    "user-blocked": () => string;
+    "wrong-credentials": () => string;
+}
+export interface LoginPasswordlessScreen {
+    authMethodEmail: () => string;
+    authMethodEmailOrPhone: () => string;
+    authMethodPhone: () => string;
+    description: (vars: {
+        authMethod: string;
+    }) => string;
+    emailOrPhonePlaceholder: () => string;
+    emailPlaceholder: () => string;
+    invalidEmail: () => string;
+    invalidIdentifier: () => string;
+    invalidPhone: () => string;
+    noEmail: () => string;
+    noPhone: () => string;
+    phonePlaceholder: () => string;
+    sessionExpired: () => string;
+    title: () => string;
+    userAccountDoesNotExist: () => string;
+}
+export interface MagicLinkSentScreen {
+    defaultDescription: () => string;
+    description: (vars: {
+        username: string;
+    }) => string;
+    resendText: () => string;
+    spamText: () => string;
+    title: () => string;
+}
+export interface MfaScreen {
+    backupCodeText: () => string;
+    description: () => string;
+    pageTitle: (vars: {
+        clientName: string;
+    }) => string;
+    title: () => string;
+}
+export interface MfaEmailScreen {
+    buttonText: () => string;
+    codePlaceholder: () => string;
+    description: (vars: {
+        email: string;
+    }) => string;
+    "invalid-code": () => string;
+    pageTitle: (vars: {
+        clientName: string;
+    }) => string;
+    resendText: () => string;
+    title: () => string;
+}
+export interface MfaOtpScreen {
+    buttonText: () => string;
+    codePlaceholder: () => string;
+    description: () => string;
+    "invalid-code": () => string;
+    pageTitle: (vars: {
+        clientName: string;
+    }) => string;
+    title: () => string;
+}
+export interface MfaOtpMfaTotpEnrollmentScreen {
+    title: () => string;
+    description: () => string;
+    secretLabel: () => string;
+    codePlaceholder: () => string;
+    continueButtonText: () => string;
+    "invalid-code": () => string;
+    "transaction-not-found": () => string;
+    unexpectedError: () => string;
+    pageTitle: (vars: {
+        clientName: string;
+    }) => string;
+    enrollmentComplete: () => string;
+}
+export interface MfaOtpMfaTotpChallengeScreen {
+    title: () => string;
+    description: () => string;
+    codePlaceholder: () => string;
+    continueButtonText: () => string;
+    "invalid-code": () => string;
+    "transaction-not-found": () => string;
+    unexpectedError: () => string;
+    pageTitle: (vars: {
+        clientName: string;
+    }) => string;
+}
+export interface MfaPhoneMfaPhoneChallengeScreen {
+    pageTitle: (vars: {
+        clientName: string;
+    }) => string;
+    title: () => string;
+    description: (vars: {
+        phoneNumber: string;
+    }) => string;
+    continueButtonText: () => string;
+    changePhoneText: () => string;
+    smsButtonText: () => string;
+    voiceButtonText: () => string;
+    chooseMessageTypeText: () => string;
+    pickAuthenticatorText: () => string;
+    logoAltText: (vars: {
+        companyName: string;
+    }) => string;
+    codePlaceholder: () => string;
+    "send-sms-failed": () => string;
+    "send-voice-failed": () => string;
+    "invalid-phone-format": () => string;
+    "invalid-phone": () => string;
+    "too-many-sms": () => string;
+    "too-many-voice": () => string;
+    "transaction-not-found": () => string;
+    "no-phone": () => string;
+    noCode: () => string;
+    invalidCode: () => string;
+    unexpectedError: () => string;
+    resendSuccess: () => string;
+    enrollmentComplete: () => string;
+}
+export interface MfaPhoneMfaPhoneEnrollmentScreen {
+    pageTitle: (vars: {
+        clientName: string;
+    }) => string;
+    title: () => string;
+    description: () => string;
+    continueButtonText: () => string;
+    smsButtonText: () => string;
+    voiceButtonText: () => string;
+    chooseMessageTypeText: () => string;
+    pickAuthenticatorText: () => string;
+    placeholder: () => string;
+    logoAltText: (vars: {
+        companyName: string;
+    }) => string;
+    selectCountryCode: (vars: {
+        countryCode: string;
+        countryName: string;
+        countryPrefix: string;
+    }) => string;
+    "send-sms-failed": () => string;
+    "send-voice-failed": () => string;
+    "sms-authenticator-error": () => string;
+    "invalid-phone-format": () => string;
+    "invalid-phone": () => string;
+    "too-many-sms": () => string;
+    "too-many-voice": () => string;
+    "transaction-not-found": () => string;
+    "no-phone": () => string;
+    "phone-is-too-short": () => string;
+    "phone-is-too-long": () => string;
+}
+export interface MfaLoginOptionsScreen {
+    pageTitle: (vars: {
+        clientName: string;
+    }) => string;
+    title: () => string;
+    description: () => string;
+    authenticatorAppLabel: () => string;
+    authenticatorAppDescription: () => string;
+    smsLabel: () => string;
+    smsDescription: () => string;
+    passkeyLabel: () => string;
+    passkeyDescription: () => string;
+}
+export interface MfaPushScreen {
+    description: () => string;
+    pageTitle: (vars: {
+        clientName: string;
+    }) => string;
+    resendText: () => string;
+    title: () => string;
+    useCodeText: () => string;
+}
+export interface MfaRecoveryCodeScreen {
+    buttonText: () => string;
+    codePlaceholder: () => string;
+    description: () => string;
+    "invalid-code": () => string;
+    pageTitle: (vars: {
+        clientName: string;
+    }) => string;
+    title: () => string;
+}
+export interface MfaVoiceScreen {
+    buttonText: () => string;
+    codePlaceholder: () => string;
+    description: (vars: {
+        phoneNumber: string;
+    }) => string;
+    "invalid-code": () => string;
+    pageTitle: (vars: {
+        clientName: string;
+    }) => string;
+    title: () => string;
+}
+export interface MfaWebauthnScreen {
+    buttonText: () => string;
+    description: () => string;
+    pageTitle: (vars: {
+        clientName: string;
+    }) => string;
+    title: () => string;
+}
+export interface PasskeysPasskeyEnrollmentNudgeScreen {
+    title: () => string;
+    description: () => string;
+    enrollButtonText: () => string;
+    snoozeButtonText: () => string;
+    optOutLinkText: () => string;
+    pageTitle: (vars: {
+        clientName: string;
+    }) => string;
+}
+export interface PasskeysPasskeyEnrollmentScreen {
+    title: () => string;
+    description: () => string;
+    errorMessage: () => string;
+    cancelLinkText: () => string;
+    retryButtonText: () => string;
+    enrollmentComplete: () => string;
+    pageTitle: (vars: {
+        clientName: string;
+    }) => string;
+}
+export interface PasskeysPasskeyChallengeScreen {
+    title: () => string;
+    description: () => string;
+    errorMessage: () => string;
+    cancelLinkText: () => string;
+    retryButtonText: () => string;
+    pageTitle: (vars: {
+        clientName: string;
+    }) => string;
+}
+export interface OrganizationsScreen {
+    description: () => string;
+    pageTitle: (vars: {
+        clientName: string;
+    }) => string;
+    searchPlaceholder: () => string;
+    title: () => string;
+}
+export interface ResetPasswordScreen {
+    backToLoginText: () => string;
+    buttonText: () => string;
+    codeExpired: () => string;
+    confirmPasswordLabel: () => string;
+    confirmPasswordPlaceholder: () => string;
+    description: () => string;
+    emailPlaceholder: () => string;
+    failed: () => string;
+    "invalid-email-format": () => string;
+    "no-email": () => string;
+    pageTitle: (vars: {
+        clientName: string;
+    }) => string;
+    passwordLabel: () => string;
+    passwordPlaceholder: () => string;
+    passwordTooWeak: () => string;
+    passwordsDidntMatch: () => string;
+    successDescription: () => string;
+    successTitle: () => string;
+    title: () => string;
+    "user-not-found": () => string;
+}
+export interface ResetPasswordResetPasswordCodeScreen {
+    backToLoginText: () => string;
+    buttonText: () => string;
+    codeLabel: () => string;
+    codePlaceholder: () => string;
+    confirmPasswordLabel: () => string;
+    confirmPasswordPlaceholder: () => string;
+    defaultDescription: () => string;
+    description: (vars: {
+        email: string;
+    }) => string;
+    failed: () => string;
+    invalidCode: () => string;
+    noCode: () => string;
+    pageTitle: (vars: {
+        clientName: string;
+    }) => string;
+    passwordLabel: () => string;
+    passwordPlaceholder: () => string;
+    passwordTooWeak: () => string;
+    passwordsDidntMatch: () => string;
+    resendFailed: () => string;
+    resendSuccess: () => string;
+    resendText: () => string;
+    sessionExpired: () => string;
+    title: () => string;
+}
+export interface SignupScreen {
+    buttonText: () => string;
+    confirmPasswordPlaceholder: () => string;
+    description: () => string;
+    "email-already-exists": () => string;
+    emailPlaceholder: () => string;
+    federatedConnectionButtonText: (vars: {
+        connectionName: string;
+    }) => string;
+    hidePasswordText: () => string;
+    "invalid-email-format": () => string;
+    loginActionLinkText: () => string;
+    loginActionText: () => string;
+    "no-email": () => string;
+    "no-password": () => string;
+    "no-username": () => string;
+    pageTitle: (vars: {
+        clientName: string;
+    }) => string;
+    passwordPlaceholder: () => string;
+    passwordsDidntMatch: () => string;
+    phonePlaceholder: () => string;
+    privacyPolicyLinkText: () => string;
+    separatorText: () => string;
+    sessionExpired: () => string;
+    showPasswordText: () => string;
+    termsOfServiceLinkText: () => string;
+    termsText: () => string;
+    title: () => string;
+    "username-already-exists": () => string;
+    usernamePlaceholder: () => string;
+    verifyEmailText: () => string;
+}
+export interface SignupIdScreen {
+    buttonText: () => string;
+    description: () => string;
+    "email-already-exists": () => string;
+    emailPlaceholder: () => string;
+    federatedConnectionButtonText: (vars: {
+        connectionName: string;
+    }) => string;
+    "invalid-email-format": () => string;
+    loginActionLinkText: () => string;
+    loginActionText: () => string;
+    "no-email": () => string;
+    pageTitle: (vars: {
+        clientName: string;
+    }) => string;
+    phonePlaceholder: () => string;
+    separatorText: () => string;
+    title: () => string;
+    usernamePlaceholder: () => string;
+}
+export interface SignupPasswordScreen {
+    buttonText: () => string;
+    description: () => string;
+    hidePasswordText: () => string;
+    "no-password": () => string;
+    pageTitle: (vars: {
+        clientName: string;
+    }) => string;
+    "password-policy-not-met": () => string;
+    "password-too-weak": () => string;
+    passwordPlaceholder: () => string;
+    showPasswordText: () => string;
+    title: () => string;
+}
+export interface SmsOtpChallengeScreen {
+    buttonText: () => string;
+    codeLabel: () => string;
+    codePlaceholder: () => string;
+    defaultDescription: () => string;
+    description: (vars: {
+        username: string;
+    }) => string;
+    "invalid-code": () => string;
+    noCode: () => string;
+    pageTitle: (vars: {
+        clientName: string;
+    }) => string;
+    resendText: () => string;
+    sessionExpired: () => string;
+    title: () => string;
+    unexpectedError: () => string;
+}
+export interface StatusScreen {
+    continueButtonText: () => string;
+    errorTitle: () => string;
+    pageTitle: (vars: {
+        clientName: string;
+    }) => string;
+    successTitle: () => string;
+    title: () => string;
+}
+export interface ScreenMap {
+    "common.common": CommonScreen;
+    "consent.consent": ConsentScreen;
+    "device-flow.device-flow": DeviceFlowScreen;
+    "email-otp-challenge.email-otp-challenge": EmailOtpChallengeScreen;
+    "email-verification.email-verification": EmailVerificationScreen;
+    "invitation.invitation": InvitationScreen;
+    "login.login": LoginScreen;
+    "login-id.login-id": LoginIdScreen;
+    "login-password.login-password": LoginPasswordScreen;
+    "login-passwordless.login-passwordless": LoginPasswordlessScreen;
+    "magic-link-sent.magic-link-sent": MagicLinkSentScreen;
+    "mfa.mfa": MfaScreen;
+    "mfa-email.mfa-email": MfaEmailScreen;
+    "mfa-otp.mfa-otp": MfaOtpScreen;
+    "mfa-otp.mfa-totp-enrollment": MfaOtpMfaTotpEnrollmentScreen;
+    "mfa-otp.mfa-totp-challenge": MfaOtpMfaTotpChallengeScreen;
+    "mfa-phone.mfa-phone-challenge": MfaPhoneMfaPhoneChallengeScreen;
+    "mfa-phone.mfa-phone-enrollment": MfaPhoneMfaPhoneEnrollmentScreen;
+    "mfa-login-options.mfa-login-options": MfaLoginOptionsScreen;
+    "mfa-push.mfa-push": MfaPushScreen;
+    "mfa-recovery-code.mfa-recovery-code": MfaRecoveryCodeScreen;
+    "mfa-voice.mfa-voice": MfaVoiceScreen;
+    "mfa-webauthn.mfa-webauthn": MfaWebauthnScreen;
+    "passkeys.passkey-enrollment-nudge": PasskeysPasskeyEnrollmentNudgeScreen;
+    "passkeys.passkey-enrollment": PasskeysPasskeyEnrollmentScreen;
+    "passkeys.passkey-challenge": PasskeysPasskeyChallengeScreen;
+    "organizations.organizations": OrganizationsScreen;
+    "reset-password.reset-password": ResetPasswordScreen;
+    "reset-password.reset-password-code": ResetPasswordResetPasswordCodeScreen;
+    "signup.signup": SignupScreen;
+    "signup-id.signup-id": SignupIdScreen;
+    "signup-password.signup-password": SignupPasswordScreen;
+    "sms-otp-challenge.sms-otp-challenge": SmsOtpChallengeScreen;
+    "status.status": StatusScreen;
+}

package/dist/types/helpers/cache-wrapper.d.ts

@@ -0,0 +1,23 @@
+import { DataAdapters, CacheAdapter } from "@authhero/adapter-interfaces";
+/**
+ * Configuration options for the cache wrapper
+ */
+export interface CacheOptions {
+    /** Default TTL in seconds for cached items */
+    defaultTtl: number;
+    /** Custom TTLs for specific adapter methods (in seconds) */
+    customTtls?: Record<string, number>;
+    /** Methods to exclude from caching (e.g., ["users:update", "sessions:create"]) */
+    excludeMethods?: string[];
+    /** List of adapter entities to cache (if empty, all entities are cached) */
+    cacheEntities?: string[];
+    /** Cache adapter implementation */
+    cache: CacheAdapter;
+    /** Key prefix to ensure cache isolation (e.g., tenant ID) */
+    keyPrefix?: string;
+}
+/**
+ * Adds caching to data adapter methods using the new CacheAdapter interface
+ * This wraps each method of the data adapter to cache its results based on input parameters
+ */
+export declare function addCaching(data: DataAdapters, options: CacheOptions): DataAdapters;