Deploying to gh-pages from @ 840fd29 🚀

Author: dmihalcik-virtru

classes/AuthProviders.HttpRequest.html

@@ -25,7 +25,7 @@ <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
 <li><span class="target">HttpRequest</span></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/opentdf/web-sdk/blob/a173579/lib/src/auth/auth.ts#L17">auth/auth.ts:17</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/opentdf/web-sdk/blob/840fd29/lib/src/auth/auth.ts#L17">auth/auth.ts:17</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">
@@ -52,34 +52,34 @@ <h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-
 <li class="tsd-description">
 <h4 class="tsd-returns-title">Returns <a href="AuthProviders.HttpRequest.html" class="tsd-signature-type tsd-kind-class">HttpRequest</a></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/opentdf/web-sdk/blob/a173579/lib/src/auth/auth.ts#L28">auth/auth.ts:28</a></li></ul></aside></li></ul></section></section>
+<li>Defined in <a href="https://github.com/opentdf/web-sdk/blob/840fd29/lib/src/auth/auth.ts#L28">auth/auth.ts:28</a></li></ul></aside></li></ul></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Properties</h2>
 <section class="tsd-panel tsd-member"><a id="body" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>body</span><a href="#body" 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">body</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 ">BodyInit</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/opentdf/web-sdk/blob/a173579/lib/src/auth/auth.ts#L26">auth/auth.ts:26</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/opentdf/web-sdk/blob/840fd29/lib/src/auth/auth.ts#L26">auth/auth.ts:26</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="headers" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>headers</span><a href="#headers" 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">headers</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/opentdf/web-sdk/blob/a173579/lib/src/auth/auth.ts#L18">auth/auth.ts:18</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/opentdf/web-sdk/blob/840fd29/lib/src/auth/auth.ts#L18">auth/auth.ts:18</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="method" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>method</span><a href="#method" 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">method</span><span class="tsd-signature-symbol">:</span> <a href="../types/AuthProviders.HttpMethod.html" class="tsd-signature-type tsd-kind-type-alias">HttpMethod</a></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/opentdf/web-sdk/blob/a173579/lib/src/auth/auth.ts#L20">auth/auth.ts:20</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/opentdf/web-sdk/blob/840fd29/lib/src/auth/auth.ts#L20">auth/auth.ts:20</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="params" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>params</span><a href="#params" 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">params</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">object</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/opentdf/web-sdk/blob/a173579/lib/src/auth/auth.ts#L22">auth/auth.ts:22</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/opentdf/web-sdk/blob/840fd29/lib/src/auth/auth.ts#L22">auth/auth.ts:22</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="url" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>url</span><a href="#url" 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">url</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/opentdf/web-sdk/blob/a173579/lib/src/auth/auth.ts#L24">auth/auth.ts:24</a></li></ul></aside></section></section></div>
+<li>Defined in <a href="https://github.com/opentdf/web-sdk/blob/840fd29/lib/src/auth/auth.ts#L24">auth/auth.ts:24</a></li></ul></aside></section></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

classes/AuthProviders.OIDCClientCredentialsProvider.html

@@ -25,7 +25,7 @@ <h4>Implements</h4>
 <ul class="tsd-hierarchy">
 <li><a href="../types/AuthProviders.AuthProvider.html" class="tsd-signature-type tsd-kind-type-alias">AuthProvider</a></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/opentdf/web-sdk/blob/a173579/lib/src/auth/oidc-clientcredentials-provider.ts#L5">auth/oidc-clientcredentials-provider.ts:5</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/opentdf/web-sdk/blob/840fd29/lib/src/auth/oidc-clientcredentials-provider.ts#L5">auth/oidc-clientcredentials-provider.ts:5</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">
@@ -58,14 +58,14 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5><span class="tsd-kind-parameter">__namedParameters</span>: <span class="tsd-signature-type ">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">ClientSecretCredentials</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type ">Omit</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">ClientSecretCredentials</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;exchange&quot;</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="AuthProviders.OIDCClientCredentialsProvider.html" class="tsd-signature-type tsd-kind-class">OIDCClientCredentialsProvider</a></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/opentdf/web-sdk/blob/a173579/lib/src/auth/oidc-clientcredentials-provider.ts#L8">auth/oidc-clientcredentials-provider.ts:8</a></li></ul></aside></li></ul></section></section>
+<li>Defined in <a href="https://github.com/opentdf/web-sdk/blob/840fd29/lib/src/auth/oidc-clientcredentials-provider.ts#L8">auth/oidc-clientcredentials-provider.ts:8</a></li></ul></aside></li></ul></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Properties</h2>
 <section class="tsd-panel tsd-member"><a id="oidcAuth" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>oidc<wbr/>Auth</span><a href="#oidcAuth" 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">oidc<wbr/>Auth</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">AccessToken</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/opentdf/web-sdk/blob/a173579/lib/src/auth/oidc-clientcredentials-provider.ts#L6">auth/oidc-clientcredentials-provider.ts:6</a></li></ul></aside></section></section>
+<li>Defined in <a href="https://github.com/opentdf/web-sdk/blob/840fd29/lib/src/auth/oidc-clientcredentials-provider.ts#L6">auth/oidc-clientcredentials-provider.ts:6</a></li></ul></aside></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Methods</h2>
 <section class="tsd-panel tsd-member"><a id="updateClientPublicKey" class="tsd-anchor"></a>
@@ -81,7 +81,7 @@ <h5><span class="tsd-kind-parameter">signingKey</span>: <span class="tsd-signatu
 <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">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
 <p>Implementation of AuthProvider.updateClientPublicKey</p>
 <ul>
-<li>Defined in <a href="https://github.com/opentdf/web-sdk/blob/a173579/lib/src/auth/oidc-clientcredentials-provider.ts#L25">auth/oidc-clientcredentials-provider.ts:25</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/opentdf/web-sdk/blob/840fd29/lib/src/auth/oidc-clientcredentials-provider.ts#L25">auth/oidc-clientcredentials-provider.ts:25</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member"><a id="withCreds" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>with<wbr/>Creds</span><a href="#withCreds" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <ul class="tsd-signatures">
@@ -95,7 +95,7 @@ <h5><span class="tsd-kind-parameter">httpReq</span>: <a href="AuthProviders.Http
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="AuthProviders.HttpRequest.html" class="tsd-signature-type tsd-kind-class">HttpRequest</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
 <p>Implementation of AuthProvider.withCreds</p>
 <ul>
-<li>Defined in <a href="https://github.com/opentdf/web-sdk/blob/a173579/lib/src/auth/oidc-clientcredentials-provider.ts#L29">auth/oidc-clientcredentials-provider.ts:29</a></li></ul></aside></li></ul></section></section></div>
+<li>Defined in <a href="https://github.com/opentdf/web-sdk/blob/840fd29/lib/src/auth/oidc-clientcredentials-provider.ts#L29">auth/oidc-clientcredentials-provider.ts:29</a></li></ul></aside></li></ul></section></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

classes/AuthProviders.OIDCExternalJwtProvider.html

@@ -25,7 +25,7 @@ <h4>Implements</h4>
 <ul class="tsd-hierarchy">
 <li><a href="../types/AuthProviders.AuthProvider.html" class="tsd-signature-type tsd-kind-type-alias">AuthProvider</a></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/opentdf/web-sdk/blob/a173579/lib/src/auth/oidc-externaljwt-provider.ts#L5">auth/oidc-externaljwt-provider.ts:5</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/opentdf/web-sdk/blob/840fd29/lib/src/auth/oidc-externaljwt-provider.ts#L5">auth/oidc-externaljwt-provider.ts:5</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">
@@ -59,19 +59,19 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5><span class="tsd-kind-parameter">__namedParameters</span>: <span class="tsd-signature-type ">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">ExternalJwtCredentials</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type ">Omit</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">ExternalJwtCredentials</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;exchange&quot;</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="AuthProviders.OIDCExternalJwtProvider.html" class="tsd-signature-type tsd-kind-class">OIDCExternalJwtProvider</a></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/opentdf/web-sdk/blob/a173579/lib/src/auth/oidc-externaljwt-provider.ts#L9">auth/oidc-externaljwt-provider.ts:9</a></li></ul></aside></li></ul></section></section>
+<li>Defined in <a href="https://github.com/opentdf/web-sdk/blob/840fd29/lib/src/auth/oidc-externaljwt-provider.ts#L9">auth/oidc-externaljwt-provider.ts:9</a></li></ul></aside></li></ul></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Properties</h2>
 <section class="tsd-panel tsd-member"><a id="externalJwt" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>external<wbr/>Jwt</span><a href="#externalJwt" 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">external<wbr/>Jwt</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/opentdf/web-sdk/blob/a173579/lib/src/auth/oidc-externaljwt-provider.ts#L7">auth/oidc-externaljwt-provider.ts:7</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/opentdf/web-sdk/blob/840fd29/lib/src/auth/oidc-externaljwt-provider.ts#L7">auth/oidc-externaljwt-provider.ts:7</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="oidcAuth" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>oidc<wbr/>Auth</span><a href="#oidcAuth" 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">oidc<wbr/>Auth</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">AccessToken</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/opentdf/web-sdk/blob/a173579/lib/src/auth/oidc-externaljwt-provider.ts#L6">auth/oidc-externaljwt-provider.ts:6</a></li></ul></aside></section></section>
+<li>Defined in <a href="https://github.com/opentdf/web-sdk/blob/840fd29/lib/src/auth/oidc-externaljwt-provider.ts#L6">auth/oidc-externaljwt-provider.ts:6</a></li></ul></aside></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Methods</h2>
 <section class="tsd-panel tsd-member"><a id="updateClientPublicKey" class="tsd-anchor"></a>
@@ -87,7 +87,7 @@ <h5><span class="tsd-kind-parameter">signingKey</span>: <span class="tsd-signatu
 <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">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
 <p>Implementation of AuthProvider.updateClientPublicKey</p>
 <ul>
-<li>Defined in <a href="https://github.com/opentdf/web-sdk/blob/a173579/lib/src/auth/oidc-externaljwt-provider.ts#L28">auth/oidc-externaljwt-provider.ts:28</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/opentdf/web-sdk/blob/840fd29/lib/src/auth/oidc-externaljwt-provider.ts#L28">auth/oidc-externaljwt-provider.ts:28</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member"><a id="withCreds" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>with<wbr/>Creds</span><a href="#withCreds" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <ul class="tsd-signatures">
@@ -101,7 +101,7 @@ <h5><span class="tsd-kind-parameter">httpReq</span>: <a href="AuthProviders.Http
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="AuthProviders.HttpRequest.html" class="tsd-signature-type tsd-kind-class">HttpRequest</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
 <p>Implementation of AuthProvider.withCreds</p>
 <ul>
-<li>Defined in <a href="https://github.com/opentdf/web-sdk/blob/a173579/lib/src/auth/oidc-externaljwt-provider.ts#L32">auth/oidc-externaljwt-provider.ts:32</a></li></ul></aside></li></ul></section></section></div>
+<li>Defined in <a href="https://github.com/opentdf/web-sdk/blob/840fd29/lib/src/auth/oidc-externaljwt-provider.ts#L32">auth/oidc-externaljwt-provider.ts:32</a></li></ul></aside></li></ul></section></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">