From 62d095343249d677291dd4fb3a504746e77146b8 Mon Sep 17 00:00:00 2001 From: Frederik Prijck Date: Mon, 24 Jul 2023 13:34:32 +0200 Subject: [PATCH] Release v2.3.0 (#248) --- CHANGELOG.md | 9 ++ docs/classes/User.html | 42 ++++----- docs/functions/authGuard.html | 2 +- docs/functions/createAuth0.html | 2 +- docs/functions/createAuthGuard.html | 4 +- docs/functions/useAuth0.html | 2 +- docs/interfaces/AppState.html | 4 +- docs/interfaces/Auth0PluginOptions.html | 6 +- docs/interfaces/Auth0VueClient.html | 28 +++--- docs/interfaces/Auth0VueClientOptions.html | 38 ++++----- docs/interfaces/AuthGuardOptions.html | 6 +- docs/interfaces/AuthorizationParams.html | 15 ++-- docs/interfaces/GetTokenSilentlyOptions.html | 10 +-- docs/interfaces/GetTokenWithPopupOptions.html | 6 +- docs/interfaces/IdToken.html | 85 ++++++++++--------- docs/interfaces/LogoutOptions.html | 15 ++-- docs/interfaces/LogoutUrlOptions.html | 6 +- docs/interfaces/PopupConfigOptions.html | 6 +- docs/interfaces/PopupLoginOptions.html | 4 +- docs/interfaces/RedirectLoginOptions.html | 21 +++-- docs/types/CacheLocation.html | 2 +- docs/variables/AUTH0_INJECTION_KEY.html | 2 +- package-lock.json | 4 +- package.json | 2 +- src/version.ts | 2 +- 25 files changed, 174 insertions(+), 149 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c421b82a..8557d947 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,14 @@ # Change Log +## [v2.3.0](https://github.com/auth0/auth0-vue/tree/v2.3.0) (2023-07-24) +[Full Changelog](https://github.com/auth0/auth0-vue/compare/v2.2.1...v2.3.0) + +**Added** +- Support Organization Name [\#242](https://github.com/auth0/auth0-vue/pull/242) ([frederikprijck](https://github.com/frederikprijck)) + +**Changed** +- Avoid using readonly for public exposed reactive properties [\#243](https://github.com/auth0/auth0-vue/pull/243) ([frederikprijck](https://github.com/frederikprijck)) + ## [v2.2.1](https://github.com/auth0/auth0-vue/tree/v2.2.1) (2023-07-07) [Full Changelog](https://github.com/auth0/auth0-vue/compare/v2.2.0...v2.2.1) diff --git a/docs/classes/User.html b/docs/classes/User.html index a864b279..1ccd8ca1 100644 --- a/docs/classes/User.html +++ b/docs/classes/User.html @@ -23,7 +23,7 @@

Hierarchy

Indexable

[key: string]: any
+
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:546
    • @@ -70,102 +70,102 @@

    Properties

    Optional address

    address?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:564

    • Optional birthdate

    birthdate?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:559

    • Optional email

    email?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:556

    • Optional email_verified

    email_verified?: boolean
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:557

    • Optional family_name

    family_name?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:549

    • Optional gender

    gender?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:558

    • Optional given_name

    given_name?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:548

    • Optional locale

    locale?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:561

    • Optional middle_name

    middle_name?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:550

    • Optional name

    name?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:547

    • Optional nickname

    nickname?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:551

    • Optional phone_number

    phone_number?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:562

    • Optional phone_number_verified

    phone_number_verified?: boolean
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:563

    • Optional picture

    picture?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:554

    • Optional preferred_username

    preferred_username?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:552

    • Optional profile

    profile?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:553

    • Optional sub

    sub?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:566

    • Optional updated_at

    updated_at?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:565

    • Optional website

    website?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:555

    • Optional zoneinfo

    zoneinfo?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:560
    • diff --git a/docs/functions/authGuard.html b/docs/functions/authGuard.html index 157deb0c..24e45ad5 100644 --- a/docs/functions/authGuard.html +++ b/docs/functions/authGuard.html @@ -26,7 +26,7 @@

    Parameters

    to: RouteLocation

    Returns Promise<boolean>

    +
  • Defined in src/guard.ts:86
    • diff --git a/docs/functions/createAuth0.html b/docs/functions/createAuth0.html index 2da3e769..cf5de865 100644 --- a/docs/functions/createAuth0.html +++ b/docs/functions/createAuth0.html @@ -36,7 +36,7 @@
    Optional pluginOptions:

    Returns Auth0Plugin

    +
  • Defined in src/index.ts:28
    • diff --git a/docs/functions/createAuthGuard.html b/docs/functions/createAuthGuard.html index 444da349..e5c8c610 100644 --- a/docs/functions/createAuthGuard.html +++ b/docs/functions/createAuthGuard.html @@ -39,7 +39,7 @@

    Parameters

    to: RouteLocation

    Returns Promise<boolean>

    +
  • Defined in src/guard.ts:56
  • @@ -62,7 +62,7 @@

    Parameters

    to: RouteLocation

    • Returns Promise<boolean>

    +
  • Defined in src/guard.ts:64
    • diff --git a/docs/functions/useAuth0.html b/docs/functions/useAuth0.html index 6f9e104c..80654ee3 100644 --- a/docs/functions/useAuth0.html +++ b/docs/functions/useAuth0.html @@ -25,7 +25,7 @@

    Returns

    An instance of Auth0VueClient

    Returns Auth0VueClient

    +
  • Defined in src/index.ts:40
    • diff --git a/docs/interfaces/AppState.html b/docs/interfaces/AppState.html index b6cef3a3..4f0e4a20 100644 --- a/docs/interfaces/AppState.html +++ b/docs/interfaces/AppState.html @@ -23,7 +23,7 @@

    Hierarchy

    Indexable

    [key: string]: any
    +
  • Defined in src/interfaces/app-state.ts:2
    • @@ -42,7 +42,7 @@

    Optional

    +
  • Defined in src/interfaces/app-state.ts:7
    • diff --git a/docs/interfaces/Auth0PluginOptions.html b/docs/interfaces/Auth0PluginOptions.html index 36b9f076..d6b196e7 100644 --- a/docs/interfaces/Auth0PluginOptions.html +++ b/docs/interfaces/Auth0PluginOptions.html @@ -23,7 +23,7 @@

    Hierarchy

    • Auth0PluginOptions
    +
  • Defined in src/interfaces/auth0-plugin-options.ts:4
    • @@ -43,7 +43,7 @@

    Optional/

    +
  • Defined in src/interfaces/auth0-plugin-options.ts:29

    • Optional skipRedirectCallback

    skipRedirectCallback?: boolean
    @@ -57,7 +57,7 @@

    Optional

    +
  • Defined in src/interfaces/auth0-plugin-options.ts:23
    • diff --git a/docs/interfaces/Auth0VueClient.html b/docs/interfaces/Auth0VueClient.html index f3df0182..2f4fe8e4 100644 --- a/docs/interfaces/Auth0VueClient.html +++ b/docs/interfaces/Auth0VueClient.html @@ -20,7 +20,7 @@

    Hierarchy

    • Auth0VueClient
    +
  • Defined in src/interfaces/auth0-vue-client.ts:19
    • @@ -52,35 +52,35 @@

    error

    Contains an error that occured in the SDK

    +
  • Defined in src/interfaces/auth0-vue-client.ts:43

    • idTokenClaims

    idTokenClaims: Ref<undefined | IdToken>

    Contains all claims from the id_token if available.

    +
  • Defined in src/interfaces/auth0-vue-client.ts:38

    • isAuthenticated

    isAuthenticated: Ref<boolean>

    The authentication state, true if the user is authenticated, false if not.

    +
  • Defined in src/interfaces/auth0-vue-client.ts:28

    • isLoading

    isLoading: Ref<boolean>

    The loading state of the SDK, true if the SDK is still processing the PKCE flow, false if the SDK has finished processing the PKCE flow.

    +
  • Defined in src/interfaces/auth0-vue-client.ts:23

    • user

    user: Ref<undefined | User>

    Contains the information of the user if available.

    +
  • Defined in src/interfaces/auth0-vue-client.ts:33

    • Methods

    @@ -104,7 +104,7 @@

    Parameters

    Optional options: GetTokenSilentlyOptions

    Returns Promise<void>

    +
  • Defined in src/interfaces/auth0-vue-client.ts:112

    • getAccessTokenSilently

    Returns Promise<GetTokenSilentlyVerboseResponse>

    +
  • Defined in src/interfaces/auth0-vue-client.ts:119

  • Fetches a new access token and returns it.

    @@ -131,7 +131,7 @@

    Parameters

    Optional options: GetTokenSilentlyOptions

    • Returns Promise<string>

    +
  • Defined in src/interfaces/auth0-vue-client.ts:128

    • getAccessTokenWithPopup

    Returns Promise<undefined | string>

    +
  • Defined in src/interfaces/auth0-vue-client.ts:142

    • handleRedirectCallback

    Returns Promise<RedirectLoginResult<AppState>>

    +
  • Defined in src/interfaces/auth0-vue-client.ts:95

    • loginWithPopup

    Returns Promise<void>

    +
  • Defined in src/interfaces/auth0-vue-client.ts:68

    • loginWithRedirect

    Returns Promise<void>

    +
  • Defined in src/interfaces/auth0-vue-client.ts:84

    • logout

    Returns Promise<void>

    +
  • Defined in src/interfaces/auth0-vue-client.ts:165
    • diff --git a/docs/interfaces/Auth0VueClientOptions.html b/docs/interfaces/Auth0VueClientOptions.html index 01e0d471..49ae7847 100644 --- a/docs/interfaces/Auth0VueClientOptions.html +++ b/docs/interfaces/Auth0VueClientOptions.html @@ -25,7 +25,7 @@

    Hierarchy

    • Auth0VueClientOptions
    +
  • Defined in src/interfaces/auth0-vue-client-options.ts:12
    • @@ -73,7 +73,7 @@
    name: : string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:176

    • Optional authorizationParams

    authorizationParams?: AuthorizationParams
    @@ -82,7 +82,7 @@

    Optional

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:101

    • Optional authorizeTimeoutInSeconds

    authorizeTimeoutInSeconds?: number
    @@ -91,7 +91,7 @@

    Optional

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:167

    • Optional cache

    cache?: ICache
    @@ -99,7 +99,7 @@

    Optional

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:134

    • Optional cacheLocation

    cacheLocation?: CacheLocation
    @@ -109,7 +109,7 @@

    Optional

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:130

    • clientId

    clientId: string
    @@ -117,7 +117,7 @@

    clientId

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:117

    • Optional cookieDomain

    cookieDomain?: string
    @@ -130,7 +130,7 @@

    Optional

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:220

    • domain

    domain: string
    @@ -140,7 +140,7 @@

    domain

    Inherited from Auth0ClientOptions.domain

      -
    • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:106

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:109

    • Optional httpTimeoutInSeconds

    httpTimeoutInSeconds?: number
    @@ -148,7 +148,7 @@

    Optional

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:171

    • Optional issuer

    issuer?: string
    @@ -156,7 +156,7 @@

    Optional

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:113

    • Optional leeway

    leeway?: number
    @@ -166,7 +166,7 @@

    Optional

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:123

    • Optional legacySameSiteCookie

    legacySameSiteCookie?: boolean
    @@ -179,7 +179,7 @@

    Optional

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:191

    • Optional nowProvider

    nowProvider?: (() => number | Promise<number>)
    @@ -196,7 +196,7 @@

    Type declaration

    Returns number | Promise<number>

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:233

    • Optional sessionCheckExpiryDays

    sessionCheckExpiryDays?: number
    @@ -205,7 +205,7 @@

    Optional

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:208

    • Optional useCookiesForTransactions

    useCookiesForTransactions?: boolean
    @@ -218,7 +218,7 @@

    Notes

    You might want to enable this if you rely on your users being a

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:203

    • Optional useFormData

    useFormData?: boolean
    @@ -228,7 +228,7 @@

    Optional

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:227

    • Optional useRefreshTokens

    useRefreshTokens?: boolean
    @@ -238,7 +238,7 @@

    Optional

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:141

    • Optional useRefreshTokensFallback

    useRefreshTokensFallback?: boolean
    @@ -254,7 +254,7 @@

    Example

    let
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:162
    • diff --git a/docs/interfaces/AuthGuardOptions.html b/docs/interfaces/AuthGuardOptions.html index bdc4313b..dffe7f7f 100644 --- a/docs/interfaces/AuthGuardOptions.html +++ b/docs/interfaces/AuthGuardOptions.html @@ -23,7 +23,7 @@

    Hierarchy

    • AuthGuardOptions
    +
  • Defined in src/guard.ts:40
    • @@ -42,14 +42,14 @@

    Optional

    The vue application

    +
  • Defined in src/guard.ts:44

    • Optional redirectLoginOptions

    redirectLoginOptions?: RedirectLoginOptions<any>

    Route specific options to use when being redirected to Auth0

    +
  • Defined in src/guard.ts:49
    • diff --git a/docs/interfaces/AuthorizationParams.html b/docs/interfaces/AuthorizationParams.html index 483d7359..01042773 100644 --- a/docs/interfaces/AuthorizationParams.html +++ b/docs/interfaces/AuthorizationParams.html @@ -94,7 +94,7 @@

    Optional

    The Id of an invitation to accept. This is available from the user invitation URL that is given when participating in a user invitation flow.

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:81

    • Optional login_hint

    login_hint?: string
    @@ -117,12 +117,15 @@

    Optional

    Optional organization

    organization?: string
    -

    The Id of an organization to log in to.

    -

    This will specify an organization parameter in your user's login request and will add a step to validate -the org_id claim in your user's ID Token.

    +

    The organization to log in to.

    +

    This will specify an organization parameter in your user's login request.

    +
      +
    • If you provide an Organization ID (a string with the prefix org_), it will be validated against the org_id claim of your user's ID Token. The validation is case-sensitive.
      • +
    • If you provide an Organization Name (a string without the prefix org_), it will be validated against the org_name claim of your user's ID Token. The validation is case-insensitive.
      • +
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:77

    • Optional prompt

    prompt?: "none" | "login" | "consent" | "select_account"
    @@ -145,7 +148,7 @@

    Optional

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:89

    • Optional scope

    scope?: string
    diff --git a/docs/interfaces/GetTokenSilentlyOptions.html b/docs/interfaces/GetTokenSilentlyOptions.html index 068ac071..53687e2d 100644 --- a/docs/interfaces/GetTokenSilentlyOptions.html +++ b/docs/interfaces/GetTokenSilentlyOptions.html @@ -20,7 +20,7 @@

    Hierarchy

    • GetTokenSilentlyOptions
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:315
    • @@ -63,7 +63,7 @@
    Optional scope

    The scope that was used in the authentication request

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:326

    • Optional cacheMode

    cacheMode?: "off" | "on" | "cache-only"
    @@ -73,7 +73,7 @@

    Optionalon, where it both reads from the cache and sends a request to Auth0 as needed.

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:322

    • Optional detailedResponse

    detailedResponse?: boolean
    @@ -82,7 +82,7 @@

    OptionalThe default is false.

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:360

    • Optional timeoutInSeconds

    timeoutInSeconds?: number
    @@ -90,7 +90,7 @@

    Optional

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:353
    • diff --git a/docs/interfaces/GetTokenWithPopupOptions.html b/docs/interfaces/GetTokenWithPopupOptions.html index 9579ebfc..7ae0d906 100644 --- a/docs/interfaces/GetTokenWithPopupOptions.html +++ b/docs/interfaces/GetTokenWithPopupOptions.html @@ -22,7 +22,7 @@

    Hierarchy

    • GetTokenWithPopupOptions
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:362
    • @@ -43,7 +43,7 @@

    Optional

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:101

    • Optional cacheMode

    cacheMode?: "off" | "on" | "cache-only"
    @@ -52,7 +52,7 @@

    Optionalon, where it both reads from the cache and sends a request to Auth0 as needed.

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:368
    • diff --git a/docs/interfaces/IdToken.html b/docs/interfaces/IdToken.html index 26a8545f..d5da033a 100644 --- a/docs/interfaces/IdToken.html +++ b/docs/interfaces/IdToken.html @@ -23,7 +23,7 @@

    Hierarchy

    Indexable

    [key: string]: any
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:505
    • @@ -58,6 +58,7 @@

    Properties

    nickname? nonce? org_id? +org_name? phone_number? phone_number_verified? picture? @@ -75,187 +76,192 @@

    Properties

    __raw

    __raw: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:506

    • Optional acr

    acr?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:537

    • Optional address

    address?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:524

    • Optional amr

    -
    amr?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:538

    • Optional at_hash

    at_hash?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:535

    • Optional aud

    aud?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:527

    • Optional auth_time

    auth_time?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:534

    • Optional azp

    azp?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:532

    • Optional birthdate

    birthdate?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:519

    • Optional c_hash

    c_hash?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:536

    • Optional cnf

    cnf?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:540

    • Optional email

    email?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:516

    • Optional email_verified

    email_verified?: boolean
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:517

    • Optional exp

    exp?: number
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:528

    • Optional family_name

    family_name?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:509

    • Optional gender

    gender?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:518

    • Optional given_name

    given_name?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:508

    • Optional iat

    iat?: number
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:530

    • Optional iss

    iss?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:526

    • Optional jti

    jti?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:531

    • Optional locale

    locale?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:521

    • Optional middle_name

    middle_name?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:510

    • Optional name

    name?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:507

    • Optional nbf

    nbf?: number
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:529

    • Optional nickname

    nickname?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:511

    • Optional nonce

    nonce?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:533

    • Optional org_id

    org_id?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:542
    • +
    +

    Optional org_name

    +
    org_name?: string

    Optional phone_number

    phone_number?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:522

    • Optional phone_number_verified

    phone_number_verified?: boolean
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:523

    • Optional picture

    picture?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:514

    • Optional preferred_username

    preferred_username?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:512

    • Optional profile

    profile?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:513

    • Optional sid

    sid?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:541

    • Optional sub_jwk

    sub_jwk?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:539

    • Optional updated_at

    updated_at?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:525

    • Optional website

    website?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:515

    • Optional zoneinfo

    zoneinfo?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:520
    • @@ -307,6 +313,7 @@

    nickname?
  • nonce?
  • org_id?
    • +
  • org_name?
  • phone_number?
  • phone_number_verified?
  • picture?
    • diff --git a/docs/interfaces/LogoutOptions.html b/docs/interfaces/LogoutOptions.html index 64e0e330..e6191b3b 100644 --- a/docs/interfaces/LogoutOptions.html +++ b/docs/interfaces/LogoutOptions.html @@ -22,7 +22,7 @@

    Hierarchy

    • LogoutOptions
    +
  • Defined in src/interfaces/auth0-vue-client-options.ts:14
    • @@ -46,7 +46,7 @@

    Optional

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:380

    • Optional logoutParams

    logoutParams?: {
        federated?: boolean;
        returnTo?: string;
        [key: string]: any;
    }
    @@ -78,19 +78,22 @@
    Optional returnTo
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:385

    • Optional openUrl

    -
    openUrl?: false | ((url: string) => Promise<void>)
    +
    openUrl?: false | ((url: string) => void | Promise<void>)

    Used to control the redirect and not rely on the SDK to do the actual redirect.

    Set to false to disable the redirect, or provide a function to handle the actual redirect yourself.

    -

    Example

    await auth0.logout({
      async openUrl(url) {
        window.location.replace(url);
      }
    });
+
    Example
    await auth0.logout({
      openUrl(url) {
        window.location.replace(url);
      }
    });
+
    
+
+
    Example
    import { Browser } from '@capacitor/browser';

    await auth0.logout({
      async openUrl(url) {
        await Browser.open({ url });
      }
    });
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:446
    • diff --git a/docs/interfaces/LogoutUrlOptions.html b/docs/interfaces/LogoutUrlOptions.html index 7fba6be4..2fdf21ca 100644 --- a/docs/interfaces/LogoutUrlOptions.html +++ b/docs/interfaces/LogoutUrlOptions.html @@ -20,7 +20,7 @@

    Hierarchy

    • LogoutUrlOptions
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:370
    • @@ -42,7 +42,7 @@

    OptionalRead more about how redirecting after logout works

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:380

    • Optional logoutParams

    logoutParams?: {
        federated?: boolean;
        returnTo?: string;
        [key: string]: any;
    }
    @@ -73,7 +73,7 @@
    Optional returnToRead more about how redirecting after logout works

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:385
    • diff --git a/docs/interfaces/PopupConfigOptions.html b/docs/interfaces/PopupConfigOptions.html index 33446ffd..e67a8db4 100644 --- a/docs/interfaces/PopupConfigOptions.html +++ b/docs/interfaces/PopupConfigOptions.html @@ -20,7 +20,7 @@

    Hierarchy

    • PopupConfigOptions
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:302
    • @@ -41,7 +41,7 @@

    Optional

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:313

    • Optional timeoutInSeconds

    timeoutInSeconds?: number
    @@ -49,7 +49,7 @@

    Optional

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:307
    • diff --git a/docs/interfaces/PopupLoginOptions.html b/docs/interfaces/PopupLoginOptions.html index 4f237259..47abb568 100644 --- a/docs/interfaces/PopupLoginOptions.html +++ b/docs/interfaces/PopupLoginOptions.html @@ -24,7 +24,7 @@

    Hierarchy

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:300
    • @@ -44,7 +44,7 @@

    Optional

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:101
    • diff --git a/docs/interfaces/RedirectLoginOptions.html b/docs/interfaces/RedirectLoginOptions.html index 11768e31..017f04e2 100644 --- a/docs/interfaces/RedirectLoginOptions.html +++ b/docs/interfaces/RedirectLoginOptions.html @@ -27,7 +27,7 @@

    Hierarchy

    • RedirectLoginOptions
    +
  • Defined in src/interfaces/auth0-vue-client-options.ts:15
    • @@ -49,7 +49,7 @@

    Optional

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:256

    • Optional authorizationParams

    authorizationParams?: AuthorizationParams
    @@ -58,7 +58,7 @@

    Optional

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:101

    • Optional fragment

    fragment?: string
    @@ -66,20 +66,23 @@

    Optional

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:260

    • Optional openUrl

    -
    openUrl?: ((url: string) => Promise<void>)
    +
    openUrl?: ((url: string) => void | Promise<void>)

    Type declaration

      • -
      • (url: string): Promise<void>
        • +
      • (url: string): void | Promise<void>

      • Used to control the redirect and not rely on the SDK to do the actual redirect.

        -

        Example

        const client = new Auth0Client({
          async openUrl(url) {
            window.location.replace(url);
          }
        });
+
        Example
        const client = new Auth0Client({
          openUrl(url) {
            window.location.replace(url);
          }
        });
+
        
+
+
        Example
        import { Browser } from '@capacitor/browser';

        const client = new Auth0Client({
          async openUrl(url) {
            await Browser.open({ url });
          }
        });
        @@ -87,10 +90,10 @@

        Parameters

        • url: string
        -

        Returns Promise<void>

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:292
    • diff --git a/docs/types/CacheLocation.html b/docs/types/CacheLocation.html index 8a884231..99ada298 100644 --- a/docs/types/CacheLocation.html +++ b/docs/types/CacheLocation.html @@ -19,7 +19,7 @@

    Type alias CacheLocation

    The possible locations where tokens can be stored

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:238
    • diff --git a/docs/variables/AUTH0_INJECTION_KEY.html b/docs/variables/AUTH0_INJECTION_KEY.html index 8661b577..64300e9b 100644 --- a/docs/variables/AUTH0_INJECTION_KEY.html +++ b/docs/variables/AUTH0_INJECTION_KEY.html @@ -21,7 +21,7 @@

    Variable AUTH0_INJECTION_KEYConst

    +
  • Defined in src/token.ts:16
    • diff --git a/package-lock.json b/package-lock.json index 22a6c7b6..d02c02f1 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@auth0/auth0-vue", - "version": "2.2.1", + "version": "2.3.0", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "@auth0/auth0-vue", - "version": "2.2.1", + "version": "2.3.0", "license": "MIT", "dependencies": { "@auth0/auth0-spa-js": "^2.1.1", diff --git a/package.json b/package.json index 4834bcab..1923c09c 100644 --- a/package.json +++ b/package.json @@ -3,7 +3,7 @@ "name": "@auth0/auth0-vue", "description": "Auth0 SDK for Vue Applications using Authorization Code Grant Flow with PKCE", "license": "MIT", - "version": "2.2.1", + "version": "2.3.0", "main": "dist/lib/auth0-vue.cjs.js", "types": "dist/typings/index.d.ts", "module": "dist/auth0-vue.production.esm.js", diff --git a/src/version.ts b/src/version.ts index cd473caa..bcc8dc69 100644 --- a/src/version.ts +++ b/src/version.ts @@ -1 +1 @@ -export default '2.2.1'; +export default '2.3.0';