Deploying to gh-pages from @ ec4a55a 🚀

opentdf · Jan 16, 2025 · c61e1e4 · c61e1e4
1 parent c564cc7
commit c61e1e4
Show file tree

Hide file tree

Showing 47 changed files with 229 additions and 104 deletions.
diff --git a/assets/search.js b/assets/search.js
diff --git a/classes/AuthProviders.OIDCClientCredentialsProvider.html b/classes/AuthProviders.OIDCClientCredentialsProvider.html
@@ -25,7 +25,7 @@ <h4>Implements</h4>
 <ul class="tsd-hierarchy">
 <li><a href="../types/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/6ca50e6/lib/src/auth/oidc-clientcredentials-provider.ts#L5">src/auth/oidc-clientcredentials-provider.ts:5</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/opentdf/web-sdk/blob/ec4a55a/lib/src/auth/oidc-clientcredentials-provider.ts#L5">src/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/6ca50e6/lib/src/auth/oidc-clientcredentials-provider.ts#L8">src/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/ec4a55a/lib/src/auth/oidc-clientcredentials-provider.ts#L8">src/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/6ca50e6/lib/src/auth/oidc-clientcredentials-provider.ts#L6">src/auth/oidc-clientcredentials-provider.ts:6</a></li></ul></aside></section></section>
+<li>Defined in <a href="https://github.com/opentdf/web-sdk/blob/ec4a55a/lib/src/auth/oidc-clientcredentials-provider.ts#L6">src/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/6ca50e6/lib/src/auth/oidc-clientcredentials-provider.ts#L25">src/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/ec4a55a/lib/src/auth/oidc-clientcredentials-provider.ts#L25">src/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="HttpRequest.html"
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="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/6ca50e6/lib/src/auth/oidc-clientcredentials-provider.ts#L29">src/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/ec4a55a/lib/src/auth/oidc-clientcredentials-provider.ts#L29">src/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">
@@ -162,6 +162,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
 <li><a href="../types/Source.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Source</span></a></li>
 <li><a href="../types/SplitStep.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Split<wbr/>Step</span></a></li>
 <li><a href="../variables/clientType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-32"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)"></path></g></svg><span>client<wbr/>Type</span></a></li>
+<li><a href="../variables/tdfSpecVersion.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>tdf<wbr/>Spec<wbr/>Version</span></a></li>
 <li><a href="../variables/version.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>version</span></a></li>
 <li><a href="../functions/attributeFQNsAsValues.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>attributeFQNs<wbr/>As<wbr/>Values</span></a></li>
 <li><a href="../functions/fromBrowserFile.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>from<wbr/>Browser<wbr/>File</span></a></li>

diff --git a/classes/AuthProviders.OIDCExternalJwtProvider.html b/classes/AuthProviders.OIDCExternalJwtProvider.html
@@ -25,7 +25,7 @@ <h4>Implements</h4>
 <ul class="tsd-hierarchy">
 <li><a href="../types/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/6ca50e6/lib/src/auth/oidc-externaljwt-provider.ts#L5">src/auth/oidc-externaljwt-provider.ts:5</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/opentdf/web-sdk/blob/ec4a55a/lib/src/auth/oidc-externaljwt-provider.ts#L5">src/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/6ca50e6/lib/src/auth/oidc-externaljwt-provider.ts#L9">src/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/ec4a55a/lib/src/auth/oidc-externaljwt-provider.ts#L9">src/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/6ca50e6/lib/src/auth/oidc-externaljwt-provider.ts#L7">src/auth/oidc-externaljwt-provider.ts:7</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/opentdf/web-sdk/blob/ec4a55a/lib/src/auth/oidc-externaljwt-provider.ts#L7">src/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/6ca50e6/lib/src/auth/oidc-externaljwt-provider.ts#L6">src/auth/oidc-externaljwt-provider.ts:6</a></li></ul></aside></section></section>
+<li>Defined in <a href="https://github.com/opentdf/web-sdk/blob/ec4a55a/lib/src/auth/oidc-externaljwt-provider.ts#L6">src/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/6ca50e6/lib/src/auth/oidc-externaljwt-provider.ts#L28">src/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/ec4a55a/lib/src/auth/oidc-externaljwt-provider.ts#L28">src/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="HttpRequest.html"
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="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/6ca50e6/lib/src/auth/oidc-externaljwt-provider.ts#L32">src/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/ec4a55a/lib/src/auth/oidc-externaljwt-provider.ts#L32">src/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">
@@ -169,6 +169,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
 <li><a href="../types/Source.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Source</span></a></li>
 <li><a href="../types/SplitStep.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Split<wbr/>Step</span></a></li>
 <li><a href="../variables/clientType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-32"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)"></path></g></svg><span>client<wbr/>Type</span></a></li>
+<li><a href="../variables/tdfSpecVersion.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>tdf<wbr/>Spec<wbr/>Version</span></a></li>
 <li><a href="../variables/version.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>version</span></a></li>
 <li><a href="../functions/attributeFQNsAsValues.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>attributeFQNs<wbr/>As<wbr/>Values</span></a></li>
 <li><a href="../functions/fromBrowserFile.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>from<wbr/>Browser<wbr/>File</span></a></li>