Release v2.2.0 (#225)

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## [v2.2.0](https://github.com/auth0/auth0-vue/tree/v2.2.0) (2023-04-06)
+[Full Changelog](https://github.com/auth0/auth0-vue/compare/v2.1.0...v2.2.0)
+
+**Added**
+- Gracefully handle errors upon plugin installation [\#224](https://github.com/auth0/auth0-vue/pull/224) ([frederikprijck](https://github.com/frederikprijck))
+
 ## [v2.1.0](https://github.com/auth0/auth0-vue/tree/v2.1.0) (2023-03-10)
 [Full Changelog](https://github.com/auth0/auth0-vue/compare/v2.0.2...v2.1.0)
 

docs/functions/authGuard.html

@@ -26,7 +26,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5>to: <span class="tsd-signature-type">RouteLocation</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/auth0/auth0-vue/blob/d7c1569/src/guard.ts#L86">src/guard.ts:86</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/auth0/auth0-vue/blob/1b517a0/src/guard.ts#L86">src/guard.ts:86</a></li></ul></aside></li></ul></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

docs/functions/createAuth0.html

@@ -36,7 +36,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> pluginOptions: <a href
 </div></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Auth0Plugin</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/auth0/auth0-vue/blob/d7c1569/src/index.ts#L28">src/index.ts:28</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/auth0/auth0-vue/blob/1b517a0/src/index.ts#L28">src/index.ts:28</a></li></ul></aside></li></ul></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

docs/functions/createAuthGuard.html

@@ -39,7 +39,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5>to: <span class="tsd-signature-type">RouteLocation</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/auth0/auth0-vue/blob/d7c1569/src/guard.ts#L56">src/guard.ts:56</a></li></ul></aside></li>
+<li>Defined in <a href="https://github.com/auth0/auth0-vue/blob/1b517a0/src/guard.ts#L56">src/guard.ts:56</a></li></ul></aside></li>
 <li class="tsd-signature tsd-anchor-link" id="createAuthGuard-1">create<wbr/>Auth<wbr/>Guard<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/AuthGuardOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthGuardOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>to<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RouteLocation</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><a href="#createAuthGuard-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
 <li class="tsd-description">
 <div class="tsd-parameters">
@@ -62,7 +62,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5>to: <span class="tsd-signature-type">RouteLocation</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/auth0/auth0-vue/blob/d7c1569/src/guard.ts#L64">src/guard.ts:64</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/auth0/auth0-vue/blob/1b517a0/src/guard.ts#L64">src/guard.ts:64</a></li></ul></aside></li></ul></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

docs/functions/useAuth0.html

@@ -25,7 +25,7 @@ <h3>Returns</h3><p>An instance of Auth0VueClient</p>
 </div>
 <h4 class="tsd-returns-title">Returns <a href="../interfaces/Auth0VueClient.html" class="tsd-signature-type" data-tsd-kind="Interface">Auth0VueClient</a></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/auth0/auth0-vue/blob/d7c1569/src/index.ts#L40">src/index.ts:40</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/auth0/auth0-vue/blob/1b517a0/src/index.ts#L40">src/index.ts:40</a></li></ul></aside></li></ul></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

docs/interfaces/AppState.html

@@ -23,7 +23,7 @@ <h4>Hierarchy</h4>
 <h4 class="tsd-before-signature">Indexable</h4>
 <div class="tsd-signature"><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">any</span></div></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/auth0/auth0-vue/blob/d7c1569/src/interfaces/app-state.ts#L2">src/interfaces/app-state.ts:2</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/auth0/auth0-vue/blob/1b517a0/src/interfaces/app-state.ts#L2">src/interfaces/app-state.ts:2</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">
@@ -42,7 +42,7 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code
 handling the callback from Auth0 (defaults to &#39;/&#39;)</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/auth0/auth0-vue/blob/d7c1569/src/interfaces/app-state.ts#L7">src/interfaces/app-state.ts:7</a></li></ul></aside></section></section></div>
+<li>Defined in <a href="https://github.com/auth0/auth0-vue/blob/1b517a0/src/interfaces/app-state.ts#L7">src/interfaces/app-state.ts:7</a></li></ul></aside></section></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

docs/interfaces/Auth0PluginOptions.html

@@ -23,20 +23,29 @@ <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
 <li><span class="target">Auth0PluginOptions</span></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/auth0/auth0-vue/blob/d7c1569/src/interfaces/auth0-plugin-options.ts#L4">src/interfaces/auth0-plugin-options.ts:4</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/auth0/auth0-vue/blob/1b517a0/src/interfaces/auth0-plugin-options.ts#L4">src/interfaces/auth0-plugin-options.ts:4</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"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-text)"></path></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="Auth0PluginOptions.html#skipRedirectCallback" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>skip<wbr/>Redirect<wbr/>Callback?</span></a>
+<div class="tsd-index-list"><a href="Auth0PluginOptions.html#errorPath" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>error<wbr/>Path?</span></a>
+<a href="Auth0PluginOptions.html#skipRedirectCallback" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>skip<wbr/>Redirect<wbr/>Callback?</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-kind-property tsd-parent-kind-interface"><a id="errorPath" class="tsd-anchor"></a>
+<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>error<wbr/>Path</span><a href="#errorPath" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
+<div class="tsd-signature">error<wbr/>Path<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
+<div class="tsd-comment tsd-typography"><p>Path in your application to redirect to when the Authorization server
+returns an error. Defaults to <code>/</code></p>
+</div><aside class="tsd-sources">
+<ul>
+<li>Defined in <a href="https://github.com/auth0/auth0-vue/blob/1b517a0/src/interfaces/auth0-plugin-options.ts#L29">src/interfaces/auth0-plugin-options.ts:29</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="skipRedirectCallback" class="tsd-anchor"></a>
-<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>skip<wbr/>Redirect<wbr/>Callback</span><a href="#skipRedirectCallback" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
+<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>skip<wbr/>Redirect<wbr/>Callback</span><a href="#skipRedirectCallback" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">skip<wbr/>Redirect<wbr/>Callback<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
 <div class="tsd-comment tsd-typography"><p>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.</p>
 <p>In situations where you are combining our SDK with other libraries that use the same <code>code</code> and <code>state</code> parameters,
@@ -48,7 +57,7 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code
 by any other SDK.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/auth0/auth0-vue/blob/d7c1569/src/interfaces/auth0-plugin-options.ts#L23">src/interfaces/auth0-plugin-options.ts:23</a></li></ul></aside></section></section></div>
+<li>Defined in <a href="https://github.com/auth0/auth0-vue/blob/1b517a0/src/interfaces/auth0-plugin-options.ts#L23">src/interfaces/auth0-plugin-options.ts:23</a></li></ul></aside></section></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
@@ -73,5 +82,6 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.9389
 <ul>
 <li class="current tsd-kind-interface"><a href="Auth0PluginOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg><span>Auth0<wbr/>Plugin<wbr/>Options</span></a>
 <ul>
+<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Auth0PluginOptions.html#errorPath" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>error<wbr/>Path?</a></li>
 <li class="tsd-kind-property tsd-parent-kind-interface"><a href="Auth0PluginOptions.html#skipRedirectCallback" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>skip<wbr/>Redirect<wbr/>Callback?</a></li></ul></li></ul></nav></div></div>
 <div class="overlay"></div><script src="../assets/main.js"></script></body></html>