Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions main/.mintignore
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
_metadata.json

# TypeDoc JSON consumed by Mintlify's SDK reference generator.
sdk-artifacts/
14 changes: 14 additions & 0 deletions main/config/nav.en.json
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,20 @@
"$ref": "./navigation/universal-components.json"
}
]
},
{
"tab": "SDK Reference",
"icon": "book",
"$ref": "./navigation/generated/spa-js-reference.en.json"
},
{
"tab": "SDK Reference (generated)",
"hidden": true,
"sdk": {
"format": "typedoc",
"source": "sdk-artifacts/auth0-spa-js.json",
"directory": "docs/sdk/typescript"
}
}
]
}
207 changes: 207 additions & 0 deletions main/config/navigation/generated/spa-js-reference.en.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,207 @@
{
"pages": [
{
"group": "Getting Started",
"pages": [
"docs/sdk/typescript/functions/createAuth0Client"
]
},
{
"group": "Clients",
"pages": [
"docs/sdk/typescript/classes/Auth0Client",
"docs/sdk/typescript/classes/Fetcher",
"docs/sdk/typescript/classes/MfaApiClient",
"docs/sdk/typescript/classes/MyAccountApiClient",
"docs/sdk/typescript/classes/PasskeyApiClient"
]
},
{
"group": "Reference",
"pages": [
{
"group": "Configuration",
"pages": [
"docs/sdk/typescript/interfaces/Auth0ClientOptions",
"docs/sdk/typescript/interfaces/AuthorizationParams",
"docs/sdk/typescript/interfaces/ClientAuthorizationParams",
"docs/sdk/typescript/interfaces/ClientConfiguration",
"docs/sdk/typescript/types/CacheLocation",
"docs/sdk/typescript/types/InteractiveErrorHandler",
"docs/sdk/typescript/types/RefreshTokenMode",
"docs/sdk/typescript/variables/RefreshTokenMode"
]
},
{
"group": "Login & Logout",
"pages": [
"docs/sdk/typescript/interfaces/LogoutOptions",
"docs/sdk/typescript/interfaces/LogoutUrlOptions",
"docs/sdk/typescript/interfaces/PopupConfigOptions",
"docs/sdk/typescript/interfaces/PopupLoginOptions",
"docs/sdk/typescript/interfaces/RedirectConnectAccountOptions",
"docs/sdk/typescript/interfaces/RedirectLoginOptions",
"docs/sdk/typescript/interfaces/RedirectLoginResult",
"docs/sdk/typescript/types/ConnectAccountRedirectResult"
]
},
{
"group": "Tokens & Users",
"pages": [
"docs/sdk/typescript/classes/User",
"docs/sdk/typescript/interfaces/ActClaim",
"docs/sdk/typescript/interfaces/GetTokenSilentlyOptions",
"docs/sdk/typescript/interfaces/GetTokenWithPopupOptions",
"docs/sdk/typescript/interfaces/IdToken",
"docs/sdk/typescript/interfaces/RevokeRefreshTokenOptions",
"docs/sdk/typescript/types/CustomFetchMinimalOutput",
"docs/sdk/typescript/types/CustomTokenExchangeOptions",
"docs/sdk/typescript/types/FetcherConfig",
"docs/sdk/typescript/types/GetTokenSilentlyVerboseResponse",
"docs/sdk/typescript/types/TokenEndpointResponse"
]
},
{
"group": "Multi-Factor Authentication",
"pages": [
"docs/sdk/typescript/interfaces/Authenticator",
"docs/sdk/typescript/interfaces/ChallengeAuthenticatorParams",
"docs/sdk/typescript/interfaces/ChallengeResponse",
"docs/sdk/typescript/interfaces/EnrollEmailParams",
"docs/sdk/typescript/interfaces/EnrollOtpParams",
"docs/sdk/typescript/interfaces/EnrollPushParams",
"docs/sdk/typescript/interfaces/EnrollSmsParams",
"docs/sdk/typescript/interfaces/EnrollVoiceParams",
"docs/sdk/typescript/interfaces/EnrollmentFactor",
"docs/sdk/typescript/interfaces/OobEnrollmentResponse",
"docs/sdk/typescript/interfaces/OtpEnrollmentResponse",
"docs/sdk/typescript/interfaces/VerifyParams",
"docs/sdk/typescript/types/AuthenticatorType",
"docs/sdk/typescript/types/EnrollParams",
"docs/sdk/typescript/types/EnrollmentResponse",
"docs/sdk/typescript/types/MfaFactorType",
"docs/sdk/typescript/types/MfaGrantType",
"docs/sdk/typescript/types/OobChannel"
]
},
{
"group": "Passkeys",
"pages": [
"docs/sdk/typescript/interfaces/PasskeyCreationOptions",
"docs/sdk/typescript/interfaces/PasskeyCredentialResponse",
"docs/sdk/typescript/interfaces/PasskeyErrorResponse",
"docs/sdk/typescript/interfaces/PasskeyLoginChallengeOptions",
"docs/sdk/typescript/interfaces/PasskeyLoginChallengeResponse",
"docs/sdk/typescript/interfaces/PasskeyRequestOptions",
"docs/sdk/typescript/interfaces/PasskeySignupChallengeResponse",
"docs/sdk/typescript/types/PasskeyGetTokenOptions",
"docs/sdk/typescript/types/PasskeyLoginChallenge",
"docs/sdk/typescript/types/PasskeyLoginOptions",
"docs/sdk/typescript/types/PasskeySignupChallenge",
"docs/sdk/typescript/types/PasskeySignupChallengeOptions",
"docs/sdk/typescript/types/PasskeySignupOptions"
]
},
{
"group": "My Account",
"pages": [
"docs/sdk/typescript/interfaces/CompleteRequest",
"docs/sdk/typescript/interfaces/CompleteResponse",
"docs/sdk/typescript/interfaces/ConnectRequest",
"docs/sdk/typescript/interfaces/ConnectResponse",
"docs/sdk/typescript/interfaces/EmailAuthenticationMethod",
"docs/sdk/typescript/interfaces/EmailEnrollmentChallengeOptions",
"docs/sdk/typescript/interfaces/EmailEnrollmentChallengeResponse",
"docs/sdk/typescript/interfaces/EmailEnrollmentVerifyOptions",
"docs/sdk/typescript/interfaces/ErrorResponse",
"docs/sdk/typescript/interfaces/Factor",
"docs/sdk/typescript/interfaces/PasskeyAuthenticationMethod",
"docs/sdk/typescript/interfaces/PasskeyEnrollmentChallengeOptions",
"docs/sdk/typescript/interfaces/PasskeyEnrollmentChallengeResponse",
"docs/sdk/typescript/interfaces/PasskeyEnrollmentVerifyOptions",
"docs/sdk/typescript/interfaces/PasswordAuthenticationMethod",
"docs/sdk/typescript/interfaces/PasswordEnrollmentChallengeOptions",
"docs/sdk/typescript/interfaces/PasswordEnrollmentChallengeResponse",
"docs/sdk/typescript/interfaces/PasswordEnrollmentVerifyOptions",
"docs/sdk/typescript/interfaces/PasswordPolicy",
"docs/sdk/typescript/interfaces/PhoneAuthenticationMethod",
"docs/sdk/typescript/interfaces/PhoneEnrollmentChallengeOptions",
"docs/sdk/typescript/interfaces/PhoneEnrollmentChallengeResponse",
"docs/sdk/typescript/interfaces/PhoneEnrollmentVerifyOptions",
"docs/sdk/typescript/interfaces/PushNotificationAuthenticationMethod",
"docs/sdk/typescript/interfaces/PushNotificationEnrollmentChallengeOptions",
"docs/sdk/typescript/interfaces/PushNotificationEnrollmentChallengeResponse",
"docs/sdk/typescript/interfaces/PushNotificationEnrollmentVerifyOptions",
"docs/sdk/typescript/interfaces/RecoveryCodeAuthenticationMethod",
"docs/sdk/typescript/interfaces/RecoveryCodeEnrollmentChallengeOptions",
"docs/sdk/typescript/interfaces/RecoveryCodeEnrollmentChallengeResponse",
"docs/sdk/typescript/interfaces/RecoveryCodeEnrollmentVerifyOptions",
"docs/sdk/typescript/interfaces/TotpAuthenticationMethod",
"docs/sdk/typescript/interfaces/TotpEnrollmentChallengeOptions",
"docs/sdk/typescript/interfaces/TotpEnrollmentChallengeResponse",
"docs/sdk/typescript/interfaces/TotpEnrollmentVerifyOptions",
"docs/sdk/typescript/interfaces/UpdateAuthenticationMethodRequest",
"docs/sdk/typescript/interfaces/WebAuthnPlatformAuthenticationMethod",
"docs/sdk/typescript/interfaces/WebAuthnRoamingAuthenticationMethod",
"docs/sdk/typescript/types/AuthenticationMethod",
"docs/sdk/typescript/types/AuthenticationMethodType",
"docs/sdk/typescript/types/EnrollmentChallengeOptions",
"docs/sdk/typescript/types/EnrollmentChallengeResponse",
"docs/sdk/typescript/types/EnrollmentVerifyOptions"
]
},
{
"group": "Errors",
"pages": [
"docs/sdk/typescript/classes/AuthenticationError",
"docs/sdk/typescript/classes/ConnectError",
"docs/sdk/typescript/classes/GenericError",
"docs/sdk/typescript/classes/InvalidConfigurationError",
"docs/sdk/typescript/classes/MfaChallengeError",
"docs/sdk/typescript/classes/MfaEnrollmentError",
"docs/sdk/typescript/classes/MfaEnrollmentFactorsError",
"docs/sdk/typescript/classes/MfaError",
"docs/sdk/typescript/classes/MfaListAuthenticatorsError",
"docs/sdk/typescript/classes/MfaRequiredError",
"docs/sdk/typescript/classes/MfaVerifyError",
"docs/sdk/typescript/classes/MissingRefreshTokenError",
"docs/sdk/typescript/classes/MissingScopesError",
"docs/sdk/typescript/classes/MyAccountApiError",
"docs/sdk/typescript/classes/PasskeyChallengeError",
"docs/sdk/typescript/classes/PasskeyError",
"docs/sdk/typescript/classes/PasskeyGetTokenError",
"docs/sdk/typescript/classes/PasskeyRegisterError",
"docs/sdk/typescript/classes/PopupCancelledError",
"docs/sdk/typescript/classes/PopupOpenError",
"docs/sdk/typescript/classes/PopupTimeoutError",
"docs/sdk/typescript/classes/TimeoutError",
"docs/sdk/typescript/classes/UseDpopNonceError",
"docs/sdk/typescript/interfaces/MfaRequirements"
]
},
{
"group": "Caching",
"pages": [
"docs/sdk/typescript/classes/CacheKey",
"docs/sdk/typescript/classes/InMemoryCache",
"docs/sdk/typescript/classes/LocalStorageCache",
"docs/sdk/typescript/interfaces/DecodedToken",
"docs/sdk/typescript/interfaces/ICache",
"docs/sdk/typescript/types/CacheEntry",
"docs/sdk/typescript/types/CacheKeyData",
"docs/sdk/typescript/types/Cacheable",
"docs/sdk/typescript/types/KeyManifestEntry",
"docs/sdk/typescript/types/MaybePromise",
"docs/sdk/typescript/types/WrappedCacheEntry"
]
},
{
"group": "Other Types",
"pages": [
"docs/sdk/typescript/enums/ResponseType"
]
}
]
}
]
}
Loading