Skip to content

Commit

Permalink
Deploying to gh-pages from @ 040cc60 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
dmihalcik-virtru committed Dec 10, 2024
1 parent 3a00618 commit b710f37
Show file tree
Hide file tree
Showing 23 changed files with 110 additions and 314 deletions.
2 changes: 1 addition & 1 deletion assets/search.js

Large diffs are not rendered by default.

145 changes: 0 additions & 145 deletions classes/AuthProviders.AppIdAuthProvider.html

This file was deleted.

19 changes: 9 additions & 10 deletions classes/AuthProviders.HttpRequest.html
Original file line number Diff line number Diff line change
Expand Up @@ -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/ab40664/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/040cc60/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">
Expand All @@ -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/ab40664/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/040cc60/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">unknown</span></div><aside class="tsd-sources">
<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/ab40664/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/040cc60/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/ab40664/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/040cc60/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/ab40664/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/040cc60/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/ab40664/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/040cc60/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/ab40664/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/040cc60/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">
Expand Down Expand Up @@ -112,8 +112,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<details class="tsd-index-accordion" open data-key="AuthProviders"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg><a href="../modules/AuthProviders.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>Auth<wbr/>Providers</span></a></summary>
<div class="tsd-accordion-details">
<ul class="tsd-nested-navigation">
<li><a href="AuthProviders.AppIdAuthProvider.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>App<wbr/>Id<wbr/>Auth<wbr/>Provider</span></a></li>
<li><a href="AuthProviders.HttpRequest.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Http<wbr/>Request</span></a></li>
<li><a href="AuthProviders.HttpRequest.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>Http<wbr/>Request</span></a></li>
<li><a href="AuthProviders.OIDCClientCredentialsProvider.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>OIDCClient<wbr/>Credentials<wbr/>Provider</span></a></li>
<li><a href="AuthProviders.OIDCExternalJwtProvider.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>OIDCExternal<wbr/>Jwt<wbr/>Provider</span></a></li>
<li><a href="AuthProviders.OIDCRefreshTokenProvider.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>OIDCRefresh<wbr/>Token<wbr/>Provider</span></a></li>
Expand Down
13 changes: 6 additions & 7 deletions classes/AuthProviders.OIDCClientCredentialsProvider.html
Original file line number Diff line number Diff line change
Expand Up @@ -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/ab40664/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/040cc60/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">
Expand Down Expand Up @@ -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/ab40664/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/040cc60/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/ab40664/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/040cc60/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>
Expand All @@ -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/ab40664/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/040cc60/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">
Expand All @@ -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/ab40664/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/040cc60/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">
Expand Down Expand Up @@ -126,8 +126,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<details class="tsd-index-accordion" open data-key="AuthProviders"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg><a href="../modules/AuthProviders.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>Auth<wbr/>Providers</span></a></summary>
<div class="tsd-accordion-details">
<ul class="tsd-nested-navigation">
<li><a href="AuthProviders.AppIdAuthProvider.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>App<wbr/>Id<wbr/>Auth<wbr/>Provider</span></a></li>
<li><a href="AuthProviders.HttpRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Http<wbr/>Request</span></a></li>
<li><a href="AuthProviders.HttpRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>Http<wbr/>Request</span></a></li>
<li><a href="AuthProviders.OIDCClientCredentialsProvider.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>OIDCClient<wbr/>Credentials<wbr/>Provider</span></a></li>
<li><a href="AuthProviders.OIDCExternalJwtProvider.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>OIDCExternal<wbr/>Jwt<wbr/>Provider</span></a></li>
<li><a href="AuthProviders.OIDCRefreshTokenProvider.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>OIDCRefresh<wbr/>Token<wbr/>Provider</span></a></li>
Expand Down
Loading

0 comments on commit b710f37

Please sign in to comment.