From 76df97e09531c07ff8823516a6c163949b672185 Mon Sep 17 00:00:00 2001 From: Tushar Pandey Date: Mon, 2 Dec 2024 12:01:39 +0530 Subject: [PATCH] Release v2.4.0 --- .version | 2 +- CHANGELOG.md | 23 ++++++++++++++++++ docs/assets/navigation.js | 2 +- docs/assets/search.js | 2 +- 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 | 2 +- docs/interfaces/AuthGuardOptions.html | 6 ++--- docs/interfaces/LogoutOptions.html | 2 +- docs/interfaces/RedirectLoginOptions.html | 2 +- docs/variables/AUTH0_INJECTION_KEY.html | 2 +- package-lock.json | 4 ++-- package.json | 2 +- 18 files changed, 60 insertions(+), 37 deletions(-) diff --git a/.version b/.version index 79515b37..fa49670c 100644 --- a/.version +++ b/.version @@ -1 +1 @@ -v2.3.3 \ No newline at end of file +v2.4.0 \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 04a10270..7e77bd67 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,28 @@ # Change Log +## [v2.4.0](https://github.com/auth0/auth0-vue/tree/v2.4.0) (2024-12-02) +[Full Changelog](https://github.com/auth0/auth0-vue/compare/v2.3.3...v2.4.0) + +**Added** +- added RL workflow [\#428](https://github.com/auth0/auth0-vue/pull/428) ([tusharpandey13](https://github.com/tusharpandey13)) + +**Changed** +- ci: changed pull_request_target to pull_request and removed the authorize step [\#420](https://github.com/auth0/auth0-vue/pull/420) ([desusai7](https://github.com/desusai7)) +- Update codeowner file with new GitHub team name [\#416](https://github.com/auth0/auth0-vue/pull/416) ([stevenwong-okta](https://github.com/stevenwong-okta)) +- Bump vue from 3.3.12 to 3.3.13 [\#348](https://github.com/auth0/auth0-vue/pull/348) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Bump vue from 3.3.11 to 3.3.12 [\#347](https://github.com/auth0/auth0-vue/pull/347) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Bump eslint from 8.55.0 to 8.56.0 [\#346](https://github.com/auth0/auth0-vue/pull/346) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Bump browserstack-cypress-cli from 1.27.0 to 1.28.0 [\#342](https://github.com/auth0/auth0-vue/pull/342) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Bump github/codeql-action from 2 to 3 [\#343](https://github.com/auth0/auth0-vue/pull/343) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Bump rollup-plugin-visualizer from 5.10.0 to 5.11.0 [\#338](https://github.com/auth0/auth0-vue/pull/338) ([dependabot[bot]](https://github.com/apps/dependabot)) + +**Fixed** +- chore: use declare module 'vue' to fix type issues [\#419](https://github.com/auth0/auth0-vue/pull/419) ([andreasgangso](https://github.com/andreasgangso)) +- Update automated release process to latest version [\#344](https://github.com/auth0/auth0-vue/pull/344) ([frederikprijck](https://github.com/frederikprijck)) +- Use outputs for capturing release-notes [\#341](https://github.com/auth0/auth0-vue/pull/341) ([frederikprijck](https://github.com/frederikprijck)) +- Ensure tag-exists action works as intended [\#340](https://github.com/auth0/auth0-vue/pull/340) ([frederikprijck](https://github.com/frederikprijck)) +- Align release process by supporting release-directory [\#339](https://github.com/auth0/auth0-vue/pull/339) ([frederikprijck](https://github.com/frederikprijck)) + ## [v2.3.3](https://github.com/auth0/auth0-vue/tree/v2.3.3) (2023-12-11) [Full Changelog](https://github.com/auth0/auth0-vue/compare/v2.3.2...v2.3.3) diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js index ce83bf6a..b0eb21d8 100644 --- a/docs/assets/navigation.js +++ b/docs/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAE6WVW0/CMBiG/8uuUWAKKndkIThFIAIaYwypW9kaSrv0YETjf7cbgR26U8Ztv2fP+3U9vf8aAn4LY2DY5AnuKNtbwPGh0TICIHw17GDAOeTtVPnSFzusmC0irjHomretA6d4wd0LxC+UEzICsPHXOiVMqAPwQlAGPFiQoiHNklYcMl0ejjbzDYNgIYBINIyIojbAUdpjMa02e/2kQAq/M8fSQ2QWCEQJz1dpWKX0RUILI0hEsfCE1JdVNpklq9RjCZhbZU1CVULK0A8IyTlgYFfszHCattb6j6FY0i0kC4TVlPG+bCIF7HnBr0j4cxrIoE5yFm4WbWeOaCLIzjmatbVu1GO+91BrJp5Qj8rSjZsiyvbXAVwxXG2LoWZdR+tkUbJBXlmYjp0Rpzovv4Y0qlnYM3QRg46ozMsDy9Yn2n7hUxGSsVHsAyVLFTOWzt1Nt2fWaj7SgE8Mc/1hobl7uFred9b29GFkLe3ZdP04eotTvgBDoV5dXzqWzrwyE1JwvEBj1UYSJ/qZ7VMxLehfJwQOg+oVi273PEWiXEtS2EsGKZFJXtzOsaZ9/vEPTqagcNMIAAA=" \ No newline at end of file +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAE6WVXU/CMBSG/0uvwQEKKneEEJwiEAGNMYbU7cAaSru0ZwY0/nezEWDfW8bt3mfPe7Z23ccvQdgh6RJTPMNWqn2fWg6QGnEpOqRLLE61Bm1E4isHt5zUyIYJm3SbrbvagSNdgtquM12HHYISlJO/2qlhJC3KZygVXUNGSwKp1rTQoJJy/2o1X891Z0gxNDATCGpFLdDGMYyqW+1OWOCh05hyb83ExEUmhU5XJbBC6asHfc5AYLbwhJSXFQ4ZJ4vUQ48qu8gahoqEUrEf6pNTqug22xnjEtpS6z8EnMsNiBnjIJDv8x4kg72s+I2hM5Wu55ZpjsPVqs3YJxoqMlM+zdJaO5gx3XvIqolHci293I0bIfL21wFcKF5sO0PVpg7WqS/Fiq3zypLYBXUjWXAMJahqZS9gMwUWFvalgXnrE2w//1fhk2cj7l3QRiSMWRr3t812q9TwgYZ+cUj1+0F1d28xf2gszfHjoD83J+Pl0+D93PJNFfP12kjBop3XrZCUHg/Qs2rlCSt4mcYpjAo6NyGBpYAiBKd7miIUl5JkzhJDcmSezh7nmCVu//wHTqagcNMIAAA=" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js index cb213d80..0d3eb924 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE7VZ227jNhD9F/nV62go39+CYNGmDXaDJt2iMAyDKzMxa1kSdMk2MPzvS1KWNJRJWa7Tp0DWOXM7w6HI7J0k+pE688Xe2fJw7czHw74T0h1z5o6fMJqx2zzbuE7fyZNA/PaSh37GozC9QW8Hm2wXCIgf0DRlwprjHPoGg3lqtVa+ajXlkcrU7Z/Pv7qr+y+/fb57vv/6ZfX7578rq2804fR7wNIbA6rVARmNaw9x/JSJDCuzPMxY8kJ9aff4rtUYuKROPaPJK8vO2upVOGSy78Q0YWGGg7LELEv4GOSvPPwaq8IaPZ6guueRbnn8B1vzhPnZHQ2C79TfXuCjZ+Fbsj1NxxIWS5IoeaTZ5pJYMOk/BHBS+G85uwu4ZNqCqBDdC87Th4iuefja0WgPE1qyqoO1OpY4AeC+aLh1d/dN2jVBiLGQdPV8xF6V8/o52rLwLqB8Z186zYwbpGsCUC3Z1XEJvtAhcYfTymEQid7+i2ebxyjO466eT1gfEkI5Fy6OAhGvCWRDw3XAOk+3RjRW9jUh+Rvmb59YmorZ0zWQBuca92IruvWFn1R1+BMPBDZ47xqIlf1xIV3cuXb6lS0c5Zf0bYG+1KV1wzm32TeBnT+CHlSoLeY1QGez5Sp5iNq/VEy4rh+b9ffpLzlN6v3L9AWrEO2GRyOvjn+1yt5j1tFkr/ljxTbr34Q3E/lfgvoEx7A+kY8IrJaBtghAO5W+2faKcabjMab7txaNrXPkxGCvANuXsBamxWHScR2YI7Cwu4a07AsXa/avM987byxR28XcIQNvMBPEF86CtTwYFrEKs9FuJ00tj+++Cc9RIhEF5EYc6xZu33MHY9dbLvuLkqFeqB8UDMQTmGCgwUQbLogJRjSYJ548E8zTYEPxNDTBhhpsJJ5GJthIg43F09gEG2uwiXiamGATDTYVT1MTbKrBhCiLmQk208srqw1GHaAhhFLCLIWuBciag1EN0OUAWXYwCgK6IiArD0ZNQBcFZPHBKAvouoCsPxiVAV0akBKAURzQ1QGpAhj1AV0gkEKAUSLQNSJSCGLUiOgaESkEMWpEGutFLRjzitE1IlII4vXJaDCcDXWkrhGRQhCjRkTXiEghyMhoU9eIjO1IXSMihSBGNYmuEZFCEKOaRNeISCGIUU2ia+S51ip5hUZqforBKU6598UcFZOw3IT3zuo4XEWux3G/d0Qt5vtD3xGZir+HeqjKJ+lCbSqIO0XcmZ2TFhdVNdGreZ6NJj8MBf4fpnbj1Za9a66R5zYLsbodicrdpzaA0h61GXjLmX+8NanJKO9pJ7IhALFs6hSgxcpr8XmCmGPEnJxjmlxPkAFbAuqclpbntJoMiAw278W3Fy1uU2uuW1Pds8zTvIco7KGFf7x1QPGiZgNbtylWrO7aaiZK1JanOK9RdV7L5Hktrc6QyD3qFbDVWjfzQxz74uLYh+zMkB3bWisO+eWHl18d8pEZ1DtgW+Z8reLwj1dGiI2WHdjWHU+pfsWG+KgBwNYBPA3KG8KaibK3Ja/uW8y1Q40Dtsap6El1XYMsoHEBtnlRHpxRx6J8iS3fgmZapnjI2apdRqvCNxlB7U+8Yr57tlDk9Xdb96DmsfVO+R+CmoSKb6t9np7OCjQebdOxuFJFFMwxksSmGPOYBTwUoMXycPgJrNV8i2EaAAA="; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE7VZYW+jOBD9L+5Xb4tNSJN8q6rVXe+q3era29MJRZEX3MQXCghM96oo/31lE2BMbEouvU9Vy3szb+aNjXF3qMh+lGgR7tBWpDFaTCcYpeyFowWKCs4kv6nkxkMYVUWCFui5SiMpsrS8Ak8vN/IlQRhFCStLXqIFQntsCViVzmjNo8FQPm1D3fz59Ku3uvvy2+fbp7uvX1a/f/67jfrKCsG+J7y8sqAGE9Bg2mXI80fJJG/DilTy4plFKu7h2WAw4tGudMmKNZfvxrpocSAkRjkreCqhKIdm1cKHpFqL9GuuG2vNeIQaX0e5FfkfPBYFj+QtS5LvLNqekOPCwXdUe1yOQxYviqx4YHJzihZI+g8Cjhr/reK3iVBMl4gWMb7horzPWCzS9cigF5AwUFUn1plY4XgqRcQkj8en79POEVGVvBib+YA9q+b4Kdvy9DZh4sW9dPoV90jnCNAjOTZxAz4xIfUmszZhkq1F+peQm4csr/KxmY9YHyKh2RdOVgGI5wjZsDRO+OjdrafGyT5HUrTh0faRl6XI0rFCepxz0q+5vIkiXpZ6wh9FwlOZvI0V4mR/nKSTJ9dNP3OEs+qUua3Rp6Z0vnDee9n3gaMPQfda6kB4AzA6bLNK7rPhk4oNN/aw2Z1Pf6lYEQ+eYDViOHAQ+J3+1Uq+5XxkyIv+H1u23f8+vF/I/yLqEznI+kQ/QlhnAxswgI1qfX/sNeOdiYeY8Wctljv3kaOAFzXYvYQNmY6Exch1YFfgYI+VtMRIpDH/Fy126JUX+nWxQPTSv5wjjJ4FT2L1YVhrxSjKXl5UqOXh2TceyaxQiBpy5SEcetj3Lqeev1zisGHoB/oPGkYQDokNRgwYRTikNhg1YD7CoW+D+QZsgnA4scEmBixAOAxssMCATREOpzbY1IBdIxxe22DXBmyGcDizwWYGbI5wOLfB5mZ7VbeJ1QfSM0I7YbfC9IKonhOrG8S0g6i2E6shxHSEqM4TqyfENIWo5hOrLcT0haj+E6szxLSGKAuI1RxiukOUC8TqDzENIsoIYrWImB5RZQS1ekRNj6gyglo9or31oheMfcWYHlFlBPUxDS4n84mJND2iyghq9YiaHlFlBA2sMU2P6NSNND2iyghqdZOaHlFlBLW6SU2PqDKCWt2kpke+5+ySX3uk989XXkge39X7aBi2L+EdWh02Vxo02/0O0QAtdnuM6FT93HebqvpNpdAvFcCdAe7czSnri6qO6Hc830VTB8OVSP/h+m282vI3IzXIPBQh17cjWfP26QKAsoOhAK8Vjw63Jh0Z1D0bRbYIoASUQAairOvjCWBOAfP6PaYt9TUI4CpAf6eVzXdaRyaATFzZ67MXq29TO67XUb13mcd1T4DsiYN/uHUAesGwEde0aVau79o6JijUVeeaS6a/16T6Xivbb0iQHswKcfXaDPNDyE1ef/aBOHMQx7XW6o/85uAVtR/5IAyYHeJa5iLWOqLDlRFgg2VHXOtOlMy8YgN8MADENQGiTJobwo4JqncVr+9b7L0Dg0Ncg9PSi/a6BkQA2wVx7RfNhzOYWFAvddVb02zLFG5yrm43arV8WxAw/tSv93ffJUVdfw9NDxge1+w0/yHoSKD5rt5X5fFeAbZH1+5YX6kCCuRYSUuMcpHzRKQcLcLlfv8TrNV8i2EaAAA="; \ No newline at end of file diff --git a/docs/functions/authGuard.html b/docs/functions/authGuard.html index 9ced8079..f64b6381 100644 --- a/docs/functions/authGuard.html +++ b/docs/functions/authGuard.html @@ -1 +1 @@ -authGuard | @auth0/auth0-vue

Function authGuard

  • authGuard(to): Promise<boolean>

  • Parameters

    • to: RouteLocation

    Returns Promise<boolean>

Settings

Member Visibility

Theme

\ No newline at end of file +authGuard | @auth0/auth0-vue

Function authGuard

  • authGuard(to): Promise<boolean>

  • Parameters

    • to: RouteLocation

    Returns Promise<boolean>

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/createAuth0.html b/docs/functions/createAuth0.html index ffeb05f3..1fdc01d3 100644 --- a/docs/functions/createAuth0.html +++ b/docs/functions/createAuth0.html @@ -2,4 +2,4 @@

Parameters

Returns Auth0Plugin

An instance of Auth0Plugin

-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/createAuthGuard.html b/docs/functions/createAuthGuard.html index 121c0a4a..34cc09de 100644 --- a/docs/functions/createAuthGuard.html +++ b/docs/functions/createAuthGuard.html @@ -1,3 +1,3 @@ createAuthGuard | @auth0/auth0-vue

Function createAuthGuard

  • createAuthGuard(app?): ((to) => Promise<boolean>)

  • Parameters

    • Optional app: App<any>

      The vue application

      -

    Returns ((to) => Promise<boolean>)

      • (to): Promise<boolean>

      • Parameters

        • to: RouteLocation

        Returns Promise<boolean>

  • createAuthGuard(options?): ((to) => Promise<boolean>)

  • Parameters

    • Optional options: AuthGuardOptions

      The options used when creating an AuthGuard.

      -

    Returns ((to) => Promise<boolean>)

      • (to): Promise<boolean>

      • Parameters

        • to: RouteLocation

        Returns Promise<boolean>

Settings

Member Visibility

Theme

\ No newline at end of file +

Returns ((to) => Promise<boolean>)

  • createAuthGuard(options?): ((to) => Promise<boolean>)

  • Parameters

    • Optional options: AuthGuardOptions

      The options used when creating an AuthGuard.

      +

    Returns ((to) => Promise<boolean>)

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/useAuth0.html b/docs/functions/useAuth0.html index a64d691b..6f90501e 100644 --- a/docs/functions/useAuth0.html +++ b/docs/functions/useAuth0.html @@ -1,3 +1,3 @@ useAuth0 | @auth0/auth0-vue

    Function useAuth0

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/interfaces/AppState.html b/docs/interfaces/AppState.html index 7a7fa64b..85a3cda4 100644 --- a/docs/interfaces/AppState.html +++ b/docs/interfaces/AppState.html @@ -1,5 +1,5 @@ AppState | @auth0/auth0-vue

    Interface AppState

    interface AppState {
        target?: string;
        [key: string]: any;
    }

    Indexable

    [key: string]: any

    Any custom parameter to be stored in appState

    -

    Properties

    target? +

    Properties

    target?

    Properties

    Optional target

    target?: string

    Target path the app gets routed to after handling the callback from Auth0 (defaults to '/')

    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/docs/interfaces/Auth0PluginOptions.html b/docs/interfaces/Auth0PluginOptions.html index d19cfe9c..da807759 100644 --- a/docs/interfaces/Auth0PluginOptions.html +++ b/docs/interfaces/Auth0PluginOptions.html @@ -1,9 +1,9 @@ Auth0PluginOptions | @auth0/auth0-vue

    Interface Auth0PluginOptions

    Additional Configuration for the Auth0 Vue plugin

    -
    interface Auth0PluginOptions {
        errorPath?: string;
        skipRedirectCallback?: boolean;
    }

    Properties

    errorPath? +
    interface Auth0PluginOptions {
        errorPath?: string;
        skipRedirectCallback?: boolean;
    }

    Properties

    errorPath? skipRedirectCallback?

    Properties

    Optional errorPath

    errorPath?: string

    Path in your application to redirect to when the Authorization server returns an error. Defaults to /

    -

    Optional skipRedirectCallback

    skipRedirectCallback?: boolean

    By default, if the page URL has code and state parameters, the SDK will assume it should handle it and attempt to exchange the code for a token.

    +

    Optional skipRedirectCallback

    skipRedirectCallback?: boolean

    By default, if the page URL has code and state parameters, the SDK will assume it should handle it and attempt to exchange the code for a token.

    In situations where you are combining our SDK with other libraries that use the same code and state parameters, you will need to ensure our SDK can differentiate between requests it should and should not handle.

    In these cases you can instruct the client to ignore certain URLs by setting skipRedirectCallback.

    @@ -11,4 +11,4 @@

    Note: In the above example, /other-callback is an existing route, with a code (or error in case when something went wrong) and state, that will be handled by any other SDK.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/docs/interfaces/Auth0VueClient.html b/docs/interfaces/Auth0VueClient.html index ef4179d0..ea993e62 100644 --- a/docs/interfaces/Auth0VueClient.html +++ b/docs/interfaces/Auth0VueClient.html @@ -1,4 +1,4 @@ -Auth0VueClient | @auth0/auth0-vue

    Interface Auth0VueClient

    interface Auth0VueClient {
        error: Ref<any>;
        idTokenClaims: Ref<undefined | IdToken>;
        isAuthenticated: Ref<boolean>;
        isLoading: Ref<boolean>;
        user: Ref<undefined | User>;
        checkSession(options?): Promise<void>;
        getAccessTokenSilently(options): Promise<GetTokenSilentlyVerboseResponse>;
        getAccessTokenSilently(options?): Promise<string>;
        getAccessTokenWithPopup(options?, config?): Promise<undefined | string>;
        handleRedirectCallback(url?): Promise<RedirectLoginResult<AppState>>;
        loginWithPopup(options?, config?): Promise<void>;
        loginWithRedirect(options?): Promise<void>;
        logout(options?): Promise<void>;
    }

    Properties

    error +Auth0VueClient | @auth0/auth0-vue

    Interface Auth0VueClient

    interface Auth0VueClient {
        error: Ref<any>;
        idTokenClaims: Ref<undefined | IdToken>;
        isAuthenticated: Ref<boolean>;
        isLoading: Ref<boolean>;
        user: Ref<undefined | User>;
        checkSession(options?): Promise<void>;
        getAccessTokenSilently(options): Promise<GetTokenSilentlyVerboseResponse>;
        getAccessTokenSilently(options?): Promise<string>;
        getAccessTokenWithPopup(options?, config?): Promise<undefined | string>;
        handleRedirectCallback(url?): Promise<RedirectLoginResult<AppState>>;
        loginWithPopup(options?, config?): Promise<void>;
        loginWithRedirect(options?): Promise<void>;
        logout(options?): Promise<void>;
    }

    Properties

    error idTokenClaims isAuthenticated isLoading @@ -11,11 +11,11 @@ loginWithRedirect logout

    Properties

    error

    error: Ref<any>

    Contains an error that occured in the SDK

    -

    idTokenClaims

    idTokenClaims: Ref<undefined | IdToken>

    Contains all claims from the id_token if available.

    -

    isAuthenticated

    isAuthenticated: Ref<boolean>

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

    -

    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.

    -

    user

    user: Ref<undefined | User>

    Contains the information of the user if available.

    -

    Methods

    checkSession

    idTokenClaims

    idTokenClaims: Ref<undefined | IdToken>

    Contains all claims from the id_token if available.

    +

    isAuthenticated

    isAuthenticated: Ref<boolean>

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

    +

    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.

    +

    user

    user: Ref<undefined | User>

    Contains the information of the user if available.

    +

    Methods

    checkSession

    • checkSession(options?): Promise<void>
    • await checkSession();

      Check if the user is logged in using getTokenSilently. The difference with getTokenSilently is that this doesn't return a token, but it will @@ -23,21 +23,21 @@

      This method also heeds the auth0.{clientId}.is.authenticated cookie, as an optimization to prevent calling Auth0 unnecessarily. If the cookie is not present because there was no previous login (or it has expired) then tokens will not be refreshed.

      -

      Parameters

      Returns Promise<void>

    getAccessTokenSilently

    getAccessTokenWithPopup

    getAccessTokenSilently

    getAccessTokenWithPopup

    • getAccessTokenWithPopup(options?, config?): Promise<undefined | string>
    • const token = await getTokenWithPopup(options);

      Opens a popup with the /authorize URL using the parameters provided as arguments. Random and secure state and nonce parameters will be auto-generated. If the response is successful, results will be valid according to their expiration times.

      -

      Parameters

      Returns Promise<undefined | string>

    handleRedirectCallback

    handleRedirectCallback

    • handleRedirectCallback(url?): Promise<RedirectLoginResult<AppState>>

    • After the browser redirects back to the callback page, call handleRedirectCallback to handle success and error responses from Auth0. If the response is successful, results will be valid according to their expiration times.

      Note: The Auth0-Vue SDK handles this for you, unless you set skipRedirectCallback to true. In that case, be sure to explicitly call handleRedirectCallback yourself.

      -

      Parameters

      • Optional url: string

      Returns Promise<RedirectLoginResult<AppState>>

    loginWithPopup

    • loginWithPopup(options?, config?): Promise<void>
    • try {
       await loginWithPopup(options);
      } catch(e) {
       if (e instanceof PopupCancelledError) {
         // Popup was closed before login completed
       }
      }
+

      Parameters

      • Optional url: string

      Returns Promise<RedirectLoginResult<AppState>>

    loginWithPopup

    • loginWithPopup(options?, config?): Promise<void>
    • try {
       await loginWithPopup(options);
      } catch(e) {
       if (e instanceof PopupCancelledError) {
         // Popup was closed before login completed
       }
      }

      Opens a popup with the /authorize URL using the parameters provided as arguments. Random and secure state and nonce @@ -46,12 +46,12 @@

      IMPORTANT: This method has to be called from an event handler that was started by the user like a button click, for example, otherwise the popup will be blocked in most browsers.

      -

      Parameters

      Returns Promise<void>

    loginWithRedirect

    loginWithRedirect

    • loginWithRedirect(options?): Promise<void>
    • await loginWithRedirect(options);

      Performs a redirect to /authorize using the parameters provided as arguments. Random and secure state and nonce parameters will be auto-generated.

      -

      Parameters

      Returns Promise<void>

    logout

    logout

    • logout(options?): Promise<void>
    • logout();

      Clears the application session and performs a redirect to /v2/logout, using the parameters provided as arguments, to clear the Auth0 session.

      @@ -61,4 +61,4 @@ It is invalid to set both the federated and localOnly options to true, and an error will be thrown if you do. Read more about how Logout works at Auth0.

      -

      Parameters

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Parameters

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/docs/interfaces/Auth0VueClientOptions.html b/docs/interfaces/Auth0VueClientOptions.html index 4766c826..6a38378d 100644 --- a/docs/interfaces/Auth0VueClientOptions.html +++ b/docs/interfaces/Auth0VueClientOptions.html @@ -1,5 +1,5 @@ Auth0VueClientOptions | @auth0/auth0-vue

    Interface Auth0VueClientOptions

    Configuration for the Auth0 Vue Client

    -
    interface Auth0VueClientOptions {
        auth0Client?: {
            env?: {
                [key: string]: string;
            };
            name: string;
            version: string;
        };
        authorizationParams?: AuthorizationParams;
        authorizeTimeoutInSeconds?: number;
        cache?: ICache;
        cacheLocation?: CacheLocation;
        clientId: string;
        cookieDomain?: string;
        domain: string;
        httpTimeoutInSeconds?: number;
        issuer?: string;
        leeway?: number;
        legacySameSiteCookie?: boolean;
        nowProvider?: (() => number | Promise<number>);
        sessionCheckExpiryDays?: number;
        useCookiesForTransactions?: boolean;
        useFormData?: boolean;
        useRefreshTokens?: boolean;
        useRefreshTokensFallback?: boolean;
        workerUrl?: string;
    }

    Hierarchy

    • Auth0ClientOptions
      • Auth0VueClientOptions

    Properties

    auth0Client? +
    interface Auth0VueClientOptions {
        auth0Client?: {
            env?: {
                [key: string]: string;
            };
            name: string;
            version: string;
        };
        authorizationParams?: AuthorizationParams;
        authorizeTimeoutInSeconds?: number;
        cache?: ICache;
        cacheLocation?: CacheLocation;
        clientId: string;
        cookieDomain?: string;
        domain: string;
        httpTimeoutInSeconds?: number;
        issuer?: string;
        leeway?: number;
        legacySameSiteCookie?: boolean;
        nowProvider?: (() => number | Promise<number>);
        sessionCheckExpiryDays?: number;
        useCookiesForTransactions?: boolean;
        useFormData?: boolean;
        useRefreshTokens?: boolean;
        useRefreshTokensFallback?: boolean;
        workerUrl?: string;
    }

    Hierarchy

    • Auth0ClientOptions
      • Auth0VueClientOptions

    Properties

    auth0Client? authorizationParams? authorizeTimeoutInSeconds? cache? diff --git a/docs/interfaces/AuthGuardOptions.html b/docs/interfaces/AuthGuardOptions.html index e3193da8..ccb92eb8 100644 --- a/docs/interfaces/AuthGuardOptions.html +++ b/docs/interfaces/AuthGuardOptions.html @@ -1,6 +1,6 @@ AuthGuardOptions | @auth0/auth0-vue

    Interface AuthGuardOptions

    The options used when creating an AuthGuard.

    -
    interface AuthGuardOptions {
        app?: App<any>;
        redirectLoginOptions?: RedirectLoginOptions<any>;
    }

    Properties

    app? +
    interface AuthGuardOptions {
        app?: App<any>;
        redirectLoginOptions?: RedirectLoginOptions<any>;
    }

    Properties

    app? redirectLoginOptions?

    Properties

    Optional app

    app?: App<any>

    The vue application

    -

    Optional redirectLoginOptions

    redirectLoginOptions?: RedirectLoginOptions<any>

    Route specific options to use when being redirected to Auth0

    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Optional redirectLoginOptions

    redirectLoginOptions?: RedirectLoginOptions<any>

    Route specific options to use when being redirected to Auth0

    +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/docs/interfaces/LogoutOptions.html b/docs/interfaces/LogoutOptions.html index c839fd7b..ffcbc5f7 100644 --- a/docs/interfaces/LogoutOptions.html +++ b/docs/interfaces/LogoutOptions.html @@ -1,4 +1,4 @@ -LogoutOptions | @auth0/auth0-vue

    Interface LogoutOptions

    interface LogoutOptions {
        clientId?: null | string;
        logoutParams?: {
            federated?: boolean;
            returnTo?: string;
            [key: string]: any;
        };
        openUrl?: false | ((url) => void | Promise<void>);
    }

    Hierarchy

    • Omit<SPALogoutOptions, "onRedirect">
      • LogoutOptions

    Properties

    clientId? +LogoutOptions | @auth0/auth0-vue

    Interface LogoutOptions

    interface LogoutOptions {
        clientId?: null | string;
        logoutParams?: {
            federated?: boolean;
            returnTo?: string;
            [key: string]: any;
        };
        openUrl?: false | ((url) => void | Promise<void>);
    }

    Hierarchy

    • Omit<SPALogoutOptions, "onRedirect">
      • LogoutOptions

    Properties

    clientId? logoutParams? openUrl?

    Properties

    Optional clientId

    clientId?: null | string

    The clientId of your application.

    diff --git a/docs/interfaces/RedirectLoginOptions.html b/docs/interfaces/RedirectLoginOptions.html index e1e3fce4..6b63608e 100644 --- a/docs/interfaces/RedirectLoginOptions.html +++ b/docs/interfaces/RedirectLoginOptions.html @@ -1,4 +1,4 @@ -RedirectLoginOptions | @auth0/auth0-vue

    Interface RedirectLoginOptions<TAppState>

    interface RedirectLoginOptions {
        appState?: TAppState;
        authorizationParams?: AuthorizationParams;
        fragment?: string;
        openUrl?: ((url) => void | Promise<void>);
    }

    Type Parameters

    Hierarchy

    • Omit<SPARedirectLoginOptions<TAppState>, "onRedirect">
      • RedirectLoginOptions

    Properties

    appState? +RedirectLoginOptions | @auth0/auth0-vue

    Interface RedirectLoginOptions<TAppState>

    interface RedirectLoginOptions {
        appState?: TAppState;
        authorizationParams?: AuthorizationParams;
        fragment?: string;
        openUrl?: ((url) => void | Promise<void>);
    }

    Type Parameters

    Hierarchy

    • Omit<SPARedirectLoginOptions<TAppState>, "onRedirect">
      • RedirectLoginOptions

    Properties

    appState? authorizationParams? fragment? openUrl? diff --git a/docs/variables/AUTH0_INJECTION_KEY.html b/docs/variables/AUTH0_INJECTION_KEY.html index 62b5f1c4..c6356e2c 100644 --- a/docs/variables/AUTH0_INJECTION_KEY.html +++ b/docs/variables/AUTH0_INJECTION_KEY.html @@ -1,4 +1,4 @@ AUTH0_INJECTION_KEY | @auth0/auth0-vue

    Variable AUTH0_INJECTION_KEYConst

    AUTH0_INJECTION_KEY: InjectionKey<Auth0VueClient> = ...

    Injection token used to provide the Auth0VueClient instance. Can be used to pass to inject()

    inject(AUTH0_INJECTION_KEY)
    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/package-lock.json b/package-lock.json index b219eb02..f0d36653 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@auth0/auth0-vue", - "version": "2.3.3", + "version": "2.4.0", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "@auth0/auth0-vue", - "version": "2.3.3", + "version": "2.4.0", "license": "MIT", "dependencies": { "@auth0/auth0-spa-js": "^2.1.3", diff --git a/package.json b/package.json index 099f85ce..ef6886b5 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.3.3", + "version": "2.4.0", "main": "dist/lib/auth0-vue.cjs.js", "types": "dist/typings/index.d.ts", "module": "dist/auth0-vue.production.esm.js",