From 3e4d45b5fad0fd290654f27a272762d359242786 Mon Sep 17 00:00:00 2001 From: biscoe916 Date: Fri, 15 Nov 2024 20:47:34 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20opentdf/?= =?UTF-8?q?web-sdk@beb3c0644683549b0c6eaf6858b27c6222512e35=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- classes/AuthProviders.AppIdAuthProvider.html | 6 +- classes/AuthProviders.HttpRequest.html | 14 ++-- ...oviders.OIDCClientCredentialsProvider.html | 10 +-- ...AuthProviders.OIDCExternalJwtProvider.html | 12 ++-- ...uthProviders.OIDCRefreshTokenProvider.html | 12 ++-- classes/NanoTDFClient.html | 46 ++++++------- classes/NanoTDFDatasetClient.html | 64 +++++++++---------- .../AuthProviders.clientAuthProvider.html | 2 +- ...uthProviders.clientSecretAuthProvider.html | 2 +- .../AuthProviders.externalAuthProvider.html | 2 +- functions/AuthProviders.isAuthProvider.html | 2 +- .../AuthProviders.refreshAuthProvider.html | 2 +- functions/AuthProviders.reqSignature.html | 2 +- functions/AuthProviders.withHeaders.html | 2 +- functions/attributeFQNsAsValues.html | 2 +- modules/AuthProviders.html | 2 +- types/AuthProviders.AuthProvider.html | 6 +- types/AuthProviders.HttpMethod.html | 2 +- types/DatasetConfig.html | 2 +- types/EncryptOptions.html | 2 +- variables/clientType.html | 2 +- variables/version.html | 2 +- 22 files changed, 99 insertions(+), 99 deletions(-) diff --git a/classes/AuthProviders.AppIdAuthProvider.html b/classes/AuthProviders.AppIdAuthProvider.html index 3a2e1b5f..cc3358c2 100644 --- a/classes/AuthProviders.AppIdAuthProvider.html +++ b/classes/AuthProviders.AppIdAuthProvider.html @@ -38,7 +38,7 @@

Hierarchy

+
  • Defined in auth/auth.ts:130
    • @@ -70,7 +70,7 @@

    Abstract

    Returns string

    +
  • Defined in auth/auth.ts:138

    • Abstract withCreds

    +
  • Defined in auth/auth.ts:136
    • diff --git a/classes/AuthProviders.HttpRequest.html b/classes/AuthProviders.HttpRequest.html index 19a04253..06efc6cf 100644 --- a/classes/AuthProviders.HttpRequest.html +++ b/classes/AuthProviders.HttpRequest.html @@ -25,7 +25,7 @@

    Hierarchy

    • HttpRequest
    +
  • Defined in auth/auth.ts:17
    • @@ -52,34 +52,34 @@

    constructor

    Returns HttpRequest

    +
  • Defined in auth/auth.ts:28

    • Properties

    Optional body

    body?: unknown
    +
  • Defined in auth/auth.ts:26

    • headers

    headers: Record<string, string>
    +
  • Defined in auth/auth.ts:18

    • method

    method: HttpMethod
    +
  • Defined in auth/auth.ts:20

    • Optional params

    params?: object
    +
  • Defined in auth/auth.ts:22

    • url

    url: string
    +
  • Defined in auth/auth.ts:24
    • diff --git a/classes/AuthProviders.OIDCClientCredentialsProvider.html b/classes/AuthProviders.OIDCClientCredentialsProvider.html index 756b3567..022ede42 100644 --- a/classes/AuthProviders.OIDCClientCredentialsProvider.html +++ b/classes/AuthProviders.OIDCClientCredentialsProvider.html @@ -25,7 +25,7 @@

    Implements

    +
  • Defined in auth/oidc-clientcredentials-provider.ts:5
    • @@ -58,14 +58,14 @@

    Parameters

    __namedParameters: Partial<ClientSecretCredentials> & Omit<ClientSecretCredentials, "exchange">

    Returns OIDCClientCredentialsProvider

    +
  • Defined in auth/oidc-clientcredentials-provider.ts:8

    • Properties

    oidcAuth

    oidcAuth: AccessToken
    +
  • Defined in auth/oidc-clientcredentials-provider.ts:6

    • Methods

    @@ -81,7 +81,7 @@
    signingKey: Returns Promise<void>
    +
  • Defined in auth/oidc-clientcredentials-provider.ts:25

    • withCreds

    +
  • Defined in auth/oidc-clientcredentials-provider.ts:29
    • diff --git a/classes/AuthProviders.OIDCExternalJwtProvider.html b/classes/AuthProviders.OIDCExternalJwtProvider.html index 1440a69a..a554ac9c 100644 --- a/classes/AuthProviders.OIDCExternalJwtProvider.html +++ b/classes/AuthProviders.OIDCExternalJwtProvider.html @@ -25,7 +25,7 @@

    Implements

    +
  • Defined in auth/oidc-externaljwt-provider.ts:5
    • @@ -59,19 +59,19 @@

    Parameters

    __namedParameters: Partial<ExternalJwtCredentials> & Omit<ExternalJwtCredentials, "exchange">

    Returns OIDCExternalJwtProvider

    +
  • Defined in auth/oidc-externaljwt-provider.ts:9

    • Properties

    Optional externalJwt

    externalJwt?: string
    +
  • Defined in auth/oidc-externaljwt-provider.ts:7

    • oidcAuth

    oidcAuth: AccessToken
    +
  • Defined in auth/oidc-externaljwt-provider.ts:6

    • Methods

    @@ -87,7 +87,7 @@
    signingKey: Returns Promise<void>
    +
  • Defined in auth/oidc-externaljwt-provider.ts:28

    • withCreds

    +
  • Defined in auth/oidc-externaljwt-provider.ts:32
    • diff --git a/classes/AuthProviders.OIDCRefreshTokenProvider.html b/classes/AuthProviders.OIDCRefreshTokenProvider.html index 7c653e0b..8fe7ee65 100644 --- a/classes/AuthProviders.OIDCRefreshTokenProvider.html +++ b/classes/AuthProviders.OIDCRefreshTokenProvider.html @@ -25,7 +25,7 @@

    Implements

    +
  • Defined in auth/oidc-refreshtoken-provider.ts:5
    • @@ -59,19 +59,19 @@

    Parameters

    __namedParameters: Partial<RefreshTokenCredentials> & Omit<RefreshTokenCredentials, "exchange">

    Returns OIDCRefreshTokenProvider

    +
  • Defined in auth/oidc-refreshtoken-provider.ts:9

    • Properties

    oidcAuth

    oidcAuth: AccessToken
    +
  • Defined in auth/oidc-refreshtoken-provider.ts:6

    • Optional refreshToken

    refreshToken?: string
    +
  • Defined in auth/oidc-refreshtoken-provider.ts:7

    • Methods

    @@ -87,7 +87,7 @@
    signingKey: Returns Promise<void>
    +
  • Defined in auth/oidc-refreshtoken-provider.ts:27

    • withCreds

    +
  • Defined in auth/oidc-refreshtoken-provider.ts:31
    • diff --git a/classes/NanoTDFClient.html b/classes/NanoTDFClient.html index 187df032..c0873caf 100644 --- a/classes/NanoTDFClient.html +++ b/classes/NanoTDFClient.html @@ -29,7 +29,7 @@

    Hierarchy

    • NanoTDFClient
    +
  • Defined in index.ts:56
    • @@ -93,7 +93,7 @@

    Returns

    +
  • Defined in nanotdf/Client.ts:125

    • Properties

    @@ -101,91 +101,91 @@

    allowedKasesallowedKases: OriginAllowList

    +
  • Defined in nanotdf/Client.ts:103

    • Readonly authProvider

    authProvider: AuthProvider
    +
  • Defined in nanotdf/Client.ts:110

    • dataAttributes

    dataAttributes: string[] = []
    +
  • Defined in nanotdf/Client.ts:113

    • dissems

    dissems: string[] = []
    +
  • Defined in nanotdf/Client.ts:112

    • Readonly dpopEnabled

    dpopEnabled: boolean
    +
  • Defined in nanotdf/Client.ts:111

    • Protected ephemeralKeyPair

    ephemeralKeyPair: Promise<CryptoKeyPair>
    +
  • Defined in nanotdf/Client.ts:114

    • Protected Optional iv

    iv?: number
    +
  • Defined in nanotdf/Client.ts:116

    • Optional kasPubKey

    kasPubKey?: KasPublicKeyInfo
    +
  • Defined in nanotdf/Client.ts:109

    • Protected kasUrl

    kasUrl: string
    +
  • Defined in nanotdf/Client.ts:108

    • Protected requestSignerKeyPair

    requestSignerKeyPair: Promise<CryptoKeyPair>
    +
  • Defined in nanotdf/Client.ts:115

    • Static Readonly INITIAL_RELEASE_IV_SIZE

    INITIAL_RELEASE_IV_SIZE: 3 = 3
    +
  • Defined in nanotdf/Client.ts:100

    • Static Readonly IV_SIZE

    IV_SIZE: 12 = 12
    +
  • Defined in nanotdf/Client.ts:101

    • Static Readonly KAS_PROTOCOL

    KAS_PROTOCOL: "kas" = 'kas'
    +
  • Defined in nanotdf/Client.ts:98

    • Static Readonly KEY_ACCESS_REMOTE

    KEY_ACCESS_REMOTE: "remote" = 'remote'
    +
  • Defined in nanotdf/Client.ts:97

    • Static Readonly SDK_INITIAL_RELEASE

    SDK_INITIAL_RELEASE: "0.0.0" = '0.0.0'
    +
  • Defined in nanotdf/Client.ts:99

    • Methods

    @@ -207,7 +207,7 @@

    Returns void

    +
  • Defined in nanotdf/Client.ts:184

    • decrypt

      @@ -227,7 +227,7 @@
      ciphertext: Returns Promise<ArrayBuffer>
    +
  • Defined in index.ts:64

    • decryptLegacyTDF

      @@ -247,7 +247,7 @@
      ciphertext: Returns Promise<ArrayBuffer>
    +
  • Defined in index.ts:96

    • encrypt

      @@ -274,7 +274,7 @@

      Returns Promise<

      Throws

      If the initialization vector is not a number.

    +
  • Defined in index.ts:126

    • fetchOIDCToken

    +
  • Defined in nanotdf/Client.ts:199

    • rewrapKey

    +
  • Defined in nanotdf/Client.ts:217
    • diff --git a/classes/NanoTDFDatasetClient.html b/classes/NanoTDFDatasetClient.html index 15f3b782..aa722fb5 100644 --- a/classes/NanoTDFDatasetClient.html +++ b/classes/NanoTDFDatasetClient.html @@ -29,7 +29,7 @@

    Hierarchy

    • NanoTDFDatasetClient
    +
  • Defined in index.ts:217
    • @@ -96,7 +96,7 @@

    Returns

    +
  • Defined in index.ts:242

    • Properties

    @@ -104,131 +104,131 @@

    allowedKasesallowedKases: OriginAllowList

    +
  • Defined in nanotdf/Client.ts:103

    • Readonly authProvider

    authProvider: AuthProvider
    +
  • Defined in nanotdf/Client.ts:110

    • Private Optional cachedEphemeralKey

    cachedEphemeralKey?: Uint8Array
    +
  • Defined in index.ts:224

    • Private Optional cachedHeader

    cachedHeader?: default
    +
  • Defined in index.ts:227

    • dataAttributes

    dataAttributes: string[] = []
    +
  • Defined in nanotdf/Client.ts:113

    • dissems

    dissems: string[] = []
    +
  • Defined in nanotdf/Client.ts:112

    • Readonly dpopEnabled

    dpopEnabled: boolean
    +
  • Defined in nanotdf/Client.ts:111

    • Private ecdsaBinding

    ecdsaBinding: boolean
    +
  • Defined in index.ts:228

    • Protected ephemeralKeyPair

    ephemeralKeyPair: Promise<CryptoKeyPair>
    +
  • Defined in nanotdf/Client.ts:114

    • Protected Optional iv

    iv?: number
    +
  • Defined in nanotdf/Client.ts:116

    • Optional kasPubKey

    kasPubKey?: KasPublicKeyInfo
    +
  • Defined in nanotdf/Client.ts:109

    • Protected kasUrl

    kasUrl: string
    +
  • Defined in nanotdf/Client.ts:108

    • Private keyIterationCount

    keyIterationCount: number
    +
  • Defined in index.ts:223

    • Private maxKeyIteration

    maxKeyIteration: number
    +
  • Defined in index.ts:222

    • Protected requestSignerKeyPair

    requestSignerKeyPair: Promise<CryptoKeyPair>
    +
  • Defined in nanotdf/Client.ts:115

    • Private Optional symmetricKey

    symmetricKey?: CryptoKey
    +
  • Defined in index.ts:226

    • Private Optional unwrappedKey

    unwrappedKey?: CryptoKey
    +
  • Defined in index.ts:225

    • Static Readonly INITIAL_RELEASE_IV_SIZE

    INITIAL_RELEASE_IV_SIZE: 3 = 3
    +
  • Defined in nanotdf/Client.ts:100

    • Static Readonly IV_SIZE

    IV_SIZE: 12 = 12
    +
  • Defined in nanotdf/Client.ts:101

    • Static Readonly KAS_PROTOCOL

    KAS_PROTOCOL: "kas" = 'kas'
    +
  • Defined in nanotdf/Client.ts:98

    • Static Readonly KEY_ACCESS_REMOTE

    KEY_ACCESS_REMOTE: "remote" = 'remote'
    +
  • Defined in nanotdf/Client.ts:97

    • Static Readonly NTDF_MAX_KEY_ITERATIONS

    NTDF_MAX_KEY_ITERATIONS: 8388606 = 8388606
    +
  • Defined in index.ts:220

    • Static Readonly SDK_INITIAL_RELEASE

    SDK_INITIAL_RELEASE: "0.0.0" = '0.0.0'
    +
  • Defined in nanotdf/Client.ts:99

    • Methods

    @@ -250,7 +250,7 @@

    Returns void

    +
  • Defined in nanotdf/Client.ts:184

    • decrypt

    +
  • Defined in index.ts:353

    • encrypt

    +
  • Defined in index.ts:264

    • fetchOIDCToken

    +
  • Defined in nanotdf/Client.ts:199

    • generateIV

    +
  • Defined in index.ts:400

    • rewrapAndDecrypt

    Returns Promise<ArrayBuffer>

    +
  • Defined in index.ts:376

    • rewrapKey

    +
  • Defined in nanotdf/Client.ts:217
    • diff --git a/functions/AuthProviders.clientAuthProvider.html b/functions/AuthProviders.clientAuthProvider.html index 87a0ab25..e6f98a94 100644 --- a/functions/AuthProviders.clientAuthProvider.html +++ b/functions/AuthProviders.clientAuthProvider.html @@ -34,7 +34,7 @@

    Returns Promise<

    +
  • Defined in auth/providers.ts:97
    • diff --git a/functions/AuthProviders.clientSecretAuthProvider.html b/functions/AuthProviders.clientSecretAuthProvider.html index f046a6b6..ce982b99 100644 --- a/functions/AuthProviders.clientSecretAuthProvider.html +++ b/functions/AuthProviders.clientSecretAuthProvider.html @@ -40,7 +40,7 @@
    clientConfig: Returns Promise<OIDCClientCredentialsProvider>
    +
  • Defined in auth/providers.ts:32
    • diff --git a/functions/AuthProviders.externalAuthProvider.html b/functions/AuthProviders.externalAuthProvider.html index d56aa4a1..e1945a5d 100644 --- a/functions/AuthProviders.externalAuthProvider.html +++ b/functions/AuthProviders.externalAuthProvider.html @@ -39,7 +39,7 @@
    clientConfig: Returns Promise<OIDCExternalJwtProvider>
    +
  • Defined in auth/providers.ts:58
    • diff --git a/functions/AuthProviders.isAuthProvider.html b/functions/AuthProviders.isAuthProvider.html index f5876214..adcd0d9e 100644 --- a/functions/AuthProviders.isAuthProvider.html +++ b/functions/AuthProviders.isAuthProvider.html @@ -27,7 +27,7 @@

    Parameters

    Optional a: unknown

    Returns a is AuthProvider

    +
  • Defined in auth/auth.ts:106
    • diff --git a/functions/AuthProviders.refreshAuthProvider.html b/functions/AuthProviders.refreshAuthProvider.html index 77948c5a..c8e25189 100644 --- a/functions/AuthProviders.refreshAuthProvider.html +++ b/functions/AuthProviders.refreshAuthProvider.html @@ -38,7 +38,7 @@
    clientConfig: Returns Promise<OIDCRefreshTokenProvider>
    +
  • Defined in auth/providers.ts:82
    • diff --git a/functions/AuthProviders.reqSignature.html b/functions/AuthProviders.reqSignature.html index 1e0dd78b..353444a2 100644 --- a/functions/AuthProviders.reqSignature.html +++ b/functions/AuthProviders.reqSignature.html @@ -41,7 +41,7 @@

    Returns Promise<

    +
  • Defined in auth/auth.ts:61
    • diff --git a/functions/AuthProviders.withHeaders.html b/functions/AuthProviders.withHeaders.html index 9feff9bc..cf17b8ad 100644 --- a/functions/AuthProviders.withHeaders.html +++ b/functions/AuthProviders.withHeaders.html @@ -40,7 +40,7 @@

    Returns

    +
  • Defined in auth/auth.ts:43
    • diff --git a/functions/attributeFQNsAsValues.html b/functions/attributeFQNsAsValues.html index cbe724bd..572fbd9c 100644 --- a/functions/attributeFQNsAsValues.html +++ b/functions/attributeFQNsAsValues.html @@ -30,7 +30,7 @@
    authProvider: Rest ...fqns: string[]

    Returns Promise<Value[]>

    +
  • Defined in policy/api.ts:6
    • diff --git a/modules/AuthProviders.html b/modules/AuthProviders.html index c6d7e5e1..dbccc401 100644 --- a/modules/AuthProviders.html +++ b/modules/AuthProviders.html @@ -21,7 +21,7 @@

    Namespace AuthProviders

    +
  • Defined in auth/providers.ts:1

    • Index

    diff --git a/types/AuthProviders.AuthProvider.html b/types/AuthProviders.AuthProvider.html index ae57335e..92d2cc24 100644 --- a/types/AuthProviders.AuthProvider.html +++ b/types/AuthProviders.AuthProvider.html @@ -50,7 +50,7 @@
    Optional Returns Promise<void>
    +
  • Defined in auth/auth.ts:96
  • withCreds:function
    • +
  • Defined in auth/auth.ts:103
    • +
  • Defined in auth/auth.ts:83
    • diff --git a/types/AuthProviders.HttpMethod.html b/types/AuthProviders.HttpMethod.html index 0f764fb8..22e9f5f4 100644 --- a/types/AuthProviders.HttpMethod.html +++ b/types/AuthProviders.HttpMethod.html @@ -18,7 +18,7 @@

    Type alias HttpMethod

    HttpMethod: "GET" | "HEAD" | "POST" | "PUT" | "DELETE" | "CONNECT" | "OPTIONS" | "TRACE" | "PATCH"
    +
  • Defined in auth/auth.ts:3
    • diff --git a/types/DatasetConfig.html b/types/DatasetConfig.html index 7fbfea08..2d075504 100644 --- a/types/DatasetConfig.html +++ b/types/DatasetConfig.html @@ -22,7 +22,7 @@

    Type declaration

  • Optional maxKeyIterations?: number
    • +
  • Defined in index.ts:188
    • diff --git a/types/EncryptOptions.html b/types/EncryptOptions.html index d634ae62..f9637268 100644 --- a/types/EncryptOptions.html +++ b/types/EncryptOptions.html @@ -22,7 +22,7 @@

    Type declaration

  • ecdsaBinding: boolean
    • +
  • Defined in index.ts:19
    • diff --git a/variables/clientType.html b/variables/clientType.html index c5f4ba43..7692df72 100644 --- a/variables/clientType.html +++ b/variables/clientType.html @@ -20,7 +20,7 @@

    Variable clientTypeConst

    +
  • Defined in version.ts:9
    • diff --git a/variables/version.html b/variables/version.html index af025202..9133679f 100644 --- a/variables/version.html +++ b/variables/version.html @@ -20,7 +20,7 @@

    Variable versionConst

    +
  • Defined in version.ts:4