Release v2.4.0

auth0 · Dec 2, 2024 · 76df97e · 76df97e
1 parent 3173ef3
commit 76df97e
Show file tree

Hide file tree

Showing 18 changed files with 60 additions and 37 deletions.
diff --git a/.version b/.version
@@ -1 +1 @@
-v2.3.3
+v2.4.0
diff --git 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
diff --git a/docs/assets/search.js b/docs/assets/search.js
diff --git a/docs/functions/authGuard.html b/docs/functions/authGuard.html
diff --git a/docs/functions/createAuth0.html b/docs/functions/createAuth0.html
diff --git a/docs/functions/createAuthGuard.html b/docs/functions/createAuthGuard.html
diff --git a/docs/functions/useAuth0.html b/docs/functions/useAuth0.html
diff --git a/docs/interfaces/AppState.html b/docs/interfaces/AppState.html
diff --git a/docs/interfaces/Auth0PluginOptions.html b/docs/interfaces/Auth0PluginOptions.html
diff --git a/docs/interfaces/Auth0VueClient.html b/docs/interfaces/Auth0VueClient.html
diff --git a/docs/interfaces/Auth0VueClientOptions.html b/docs/interfaces/Auth0VueClientOptions.html
diff --git a/docs/interfaces/AuthGuardOptions.html b/docs/interfaces/AuthGuardOptions.html
diff --git a/docs/interfaces/LogoutOptions.html b/docs/interfaces/LogoutOptions.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>LogoutOptions | @auth0/auth0-vue</title><meta name="description" content="Documentation for @auth0/auth0-vue"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@auth0/auth0-vue</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@auth0/auth0-vue</a></li><li><a href="LogoutOptions.html">LogoutOptions</a></li></ul><h1>Interface LogoutOptions</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">LogoutOptions </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="LogoutOptions.html#clientId">clientId</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="LogoutOptions.html#logoutParams">logoutParams</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span>        </span><span class="tsd-kind-property">federated</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>        </span><span class="tsd-kind-property">returnTo</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>        </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="LogoutOptions.html#openUrl">openUrl</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">url</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type ">Omit</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">SPALogoutOptions</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;onRedirect&quot;</span><span class="tsd-signature-symbol">&gt;</span><ul class="tsd-hierarchy"><li><span class="target">LogoutOptions</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/auth0/auth0-vue/blob/aeaeec4/src/interfaces/auth0-vue-client-options.ts#L14">src/interfaces/auth0-vue-client-options.ts:14</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="LogoutOptions.html#clientId" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>client<wbr/>Id?</span></a>
+<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>LogoutOptions | @auth0/auth0-vue</title><meta name="description" content="Documentation for @auth0/auth0-vue"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@auth0/auth0-vue</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@auth0/auth0-vue</a></li><li><a href="LogoutOptions.html">LogoutOptions</a></li></ul><h1>Interface LogoutOptions</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">LogoutOptions </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="LogoutOptions.html#clientId">clientId</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="LogoutOptions.html#logoutParams">logoutParams</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span>        </span><span class="tsd-kind-property">federated</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>        </span><span class="tsd-kind-property">returnTo</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>        </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="LogoutOptions.html#openUrl">openUrl</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">url</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type ">Omit</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">SPALogoutOptions</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;onRedirect&quot;</span><span class="tsd-signature-symbol">&gt;</span><ul class="tsd-hierarchy"><li><span class="target">LogoutOptions</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/auth0/auth0-vue/blob/3173ef3/src/interfaces/auth0-vue-client-options.ts#L14">src/interfaces/auth0-vue-client-options.ts:14</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="LogoutOptions.html#clientId" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>client<wbr/>Id?</span></a>
 <a href="LogoutOptions.html#logoutParams" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>logout<wbr/>Params?</span></a>
 <a href="LogoutOptions.html#openUrl" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>open<wbr/>Url?</span></a>
 </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="clientId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>client<wbr/>Id</span><a href="#clientId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">client<wbr/>Id</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The <code>clientId</code> of your application.</p>