@fgv/ts-web-extras 5.0.2 → 5.1.0-0

package/docs/ts-web-extras.cryptoutils.browsercryptoprovider.derivekey.md

@@ -0,0 +1,88 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@fgv/ts-web-extras](./ts-web-extras.md) &gt; [CryptoUtils](./ts-web-extras.cryptoutils.md) &gt; [BrowserCryptoProvider](./ts-web-extras.cryptoutils.browsercryptoprovider.md) &gt; [deriveKey](./ts-web-extras.cryptoutils.browsercryptoprovider.derivekey.md)
+
+## CryptoUtils.BrowserCryptoProvider.deriveKey() method
+
+Derives a key from a password using PBKDF2.
+
+**Signature:**
+
+```typescript
+deriveKey(password: string, salt: Uint8Array, iterations: number): Promise<Result<Uint8Array>>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+password
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+Password string
+
+
+</td></tr>
+<tr><td>
+
+salt
+
+
+</td><td>
+
+Uint8Array
+
+
+</td><td>
+
+Salt bytes (should be at least 16 bytes)
+
+
+</td></tr>
+<tr><td>
+
+iterations
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+Number of iterations (recommend 100000+)
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;Result&lt;Uint8Array&gt;&gt;
+
+Success with derived 32-byte key, or Failure with error
+

package/docs/ts-web-extras.cryptoutils.browsercryptoprovider.encrypt.md

@@ -0,0 +1,72 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@fgv/ts-web-extras](./ts-web-extras.md) &gt; [CryptoUtils](./ts-web-extras.cryptoutils.md) &gt; [BrowserCryptoProvider](./ts-web-extras.cryptoutils.browsercryptoprovider.md) &gt; [encrypt](./ts-web-extras.cryptoutils.browsercryptoprovider.encrypt.md)
+
+## CryptoUtils.BrowserCryptoProvider.encrypt() method
+
+Encrypts plaintext using AES-256-GCM.
+
+**Signature:**
+
+```typescript
+encrypt(plaintext: string, key: Uint8Array): Promise<Result<IEncryptionResult>>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+plaintext
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+UTF-8 string to encrypt
+
+
+</td></tr>
+<tr><td>
+
+key
+
+
+</td><td>
+
+Uint8Array
+
+
+</td><td>
+
+32-byte encryption key
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;Result&lt;IEncryptionResult&gt;&gt;
+
+`Success` with encryption result, or `Failure` with an error.
+

package/docs/ts-web-extras.cryptoutils.browsercryptoprovider.frombase64.md

@@ -0,0 +1,56 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@fgv/ts-web-extras](./ts-web-extras.md) &gt; [CryptoUtils](./ts-web-extras.cryptoutils.md) &gt; [BrowserCryptoProvider](./ts-web-extras.cryptoutils.browsercryptoprovider.md) &gt; [fromBase64](./ts-web-extras.cryptoutils.browsercryptoprovider.frombase64.md)
+
+## CryptoUtils.BrowserCryptoProvider.fromBase64() method
+
+Decodes base64 string to binary data.
+
+**Signature:**
+
+```typescript
+fromBase64(base64: string): Result<Uint8Array>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+base64
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+Base64-encoded string
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+Result&lt;Uint8Array&gt;
+
+Success with decoded bytes, or Failure if invalid base64
+

package/docs/ts-web-extras.cryptoutils.browsercryptoprovider.generatekey.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@fgv/ts-web-extras](./ts-web-extras.md) &gt; [CryptoUtils](./ts-web-extras.cryptoutils.md) &gt; [BrowserCryptoProvider](./ts-web-extras.cryptoutils.browsercryptoprovider.md) &gt; [generateKey](./ts-web-extras.cryptoutils.browsercryptoprovider.generatekey.md)
+
+## CryptoUtils.BrowserCryptoProvider.generateKey() method
+
+Generates a random 32-byte key suitable for AES-256.
+
+**Signature:**
+
+```typescript
+generateKey(): Promise<Result<Uint8Array>>;
+```
+**Returns:**
+
+Promise&lt;Result&lt;Uint8Array&gt;&gt;
+
+Success with generated key, or Failure with error
+

package/docs/ts-web-extras.cryptoutils.browsercryptoprovider.generaterandombytes.md

@@ -0,0 +1,56 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@fgv/ts-web-extras](./ts-web-extras.md) &gt; [CryptoUtils](./ts-web-extras.cryptoutils.md) &gt; [BrowserCryptoProvider](./ts-web-extras.cryptoutils.browsercryptoprovider.md) &gt; [generateRandomBytes](./ts-web-extras.cryptoutils.browsercryptoprovider.generaterandombytes.md)
+
+## CryptoUtils.BrowserCryptoProvider.generateRandomBytes() method
+
+Generates cryptographically secure random bytes.
+
+**Signature:**
+
+```typescript
+generateRandomBytes(length: number): Result<Uint8Array>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+length
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+Number of bytes to generate
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+Result&lt;Uint8Array&gt;
+
+Success with random bytes, or Failure with error
+

package/docs/ts-web-extras.cryptoutils.browsercryptoprovider.md

@@ -0,0 +1,169 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@fgv/ts-web-extras](./ts-web-extras.md) &gt; [CryptoUtils](./ts-web-extras.cryptoutils.md) &gt; [BrowserCryptoProvider](./ts-web-extras.cryptoutils.browsercryptoprovider.md)
+
+## CryptoUtils.BrowserCryptoProvider class
+
+Browser implementation of `ICryptoProvider` using the Web Crypto API. Uses AES-256-GCM for authenticated encryption.
+
+Note: This provider requires a browser environment with Web Crypto API support. In Node.js 15+, Web Crypto is available via globalThis.crypto or require('crypto').webcrypto.
+
+**Signature:**
+
+```typescript
+export declare class BrowserCryptoProvider implements ICryptoProvider 
+```
+**Implements:** ICryptoProvider
+
+## Constructors
+
+<table><thead><tr><th>
+
+Constructor
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)(cryptoApi)](./ts-web-extras.cryptoutils.browsercryptoprovider._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Creates a new [BrowserCryptoProvider](./ts-web-extras.cryptoutils.browsercryptoprovider.md)<!-- -->.
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[decrypt(encryptedData, key, iv, authTag)](./ts-web-extras.cryptoutils.browsercryptoprovider.decrypt.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Decrypts ciphertext using AES-256-GCM.
+
+
+</td></tr>
+<tr><td>
+
+[deriveKey(password, salt, iterations)](./ts-web-extras.cryptoutils.browsercryptoprovider.derivekey.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Derives a key from a password using PBKDF2.
+
+
+</td></tr>
+<tr><td>
+
+[encrypt(plaintext, key)](./ts-web-extras.cryptoutils.browsercryptoprovider.encrypt.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Encrypts plaintext using AES-256-GCM.
+
+
+</td></tr>
+<tr><td>
+
+[fromBase64(base64)](./ts-web-extras.cryptoutils.browsercryptoprovider.frombase64.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Decodes base64 string to binary data.
+
+
+</td></tr>
+<tr><td>
+
+[generateKey()](./ts-web-extras.cryptoutils.browsercryptoprovider.generatekey.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Generates a random 32-byte key suitable for AES-256.
+
+
+</td></tr>
+<tr><td>
+
+[generateRandomBytes(length)](./ts-web-extras.cryptoutils.browsercryptoprovider.generaterandombytes.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Generates cryptographically secure random bytes.
+
+
+</td></tr>
+<tr><td>
+
+[toBase64(data)](./ts-web-extras.cryptoutils.browsercryptoprovider.tobase64.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Encodes binary data to base64 string.
+
+
+</td></tr>
+</tbody></table>
+

package/docs/ts-web-extras.cryptoutils.browsercryptoprovider.tobase64.md

@@ -0,0 +1,56 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@fgv/ts-web-extras](./ts-web-extras.md) &gt; [CryptoUtils](./ts-web-extras.cryptoutils.md) &gt; [BrowserCryptoProvider](./ts-web-extras.cryptoutils.browsercryptoprovider.md) &gt; [toBase64](./ts-web-extras.cryptoutils.browsercryptoprovider.tobase64.md)
+
+## CryptoUtils.BrowserCryptoProvider.toBase64() method
+
+Encodes binary data to base64 string.
+
+**Signature:**
+
+```typescript
+toBase64(data: Uint8Array): string;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+data
+
+
+</td><td>
+
+Uint8Array
+
+
+</td><td>
+
+Binary data to encode
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+string
+
+Base64-encoded string
+

package/docs/{ts-web-extras.browserhashprovider.hashparts.md → ts-web-extras.cryptoutils.browserhashprovider.hashparts.md}

@@ -1,8 +1,8 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@fgv/ts-web-extras](./ts-web-extras.md) &gt; [BrowserHashProvider](./ts-web-extras.browserhashprovider.md) &gt; [hashParts](./ts-web-extras.browserhashprovider.hashparts.md)
+[Home](./index.md) &gt; [@fgv/ts-web-extras](./ts-web-extras.md) &gt; [CryptoUtils](./ts-web-extras.cryptoutils.md) &gt; [BrowserHashProvider](./ts-web-extras.cryptoutils.browserhashprovider.md) &gt; [hashParts](./ts-web-extras.cryptoutils.browserhashprovider.hashparts.md)
 
-## BrowserHashProvider.hashParts() method
+## CryptoUtils.BrowserHashProvider.hashParts() method
 
 Hash multiple strings concatenated with a separator.
 

package/docs/{ts-web-extras.browserhashprovider.hashstring.md → ts-web-extras.cryptoutils.browserhashprovider.hashstring.md}

@@ -1,8 +1,8 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@fgv/ts-web-extras](./ts-web-extras.md) &gt; [BrowserHashProvider](./ts-web-extras.browserhashprovider.md) &gt; [hashString](./ts-web-extras.browserhashprovider.hashstring.md)
+[Home](./index.md) &gt; [@fgv/ts-web-extras](./ts-web-extras.md) &gt; [CryptoUtils](./ts-web-extras.cryptoutils.md) &gt; [BrowserHashProvider](./ts-web-extras.cryptoutils.browserhashprovider.md) &gt; [hashString](./ts-web-extras.cryptoutils.browserhashprovider.hashstring.md)
 
-## BrowserHashProvider.hashString() method
+## CryptoUtils.BrowserHashProvider.hashString() method
 
 Hash a string using the specified algorithm.
 

package/docs/{ts-web-extras.browserhashprovider.md → ts-web-extras.cryptoutils.browserhashprovider.md}

@@ -1,8 +1,8 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@fgv/ts-web-extras](./ts-web-extras.md) &gt; [BrowserHashProvider](./ts-web-extras.browserhashprovider.md)
+[Home](./index.md) &gt; [@fgv/ts-web-extras](./ts-web-extras.md) &gt; [CryptoUtils](./ts-web-extras.cryptoutils.md) &gt; [BrowserHashProvider](./ts-web-extras.cryptoutils.browserhashprovider.md)
 
-## BrowserHashProvider class
+## CryptoUtils.BrowserHashProvider class
 
 Browser-compatible hash provider using the Web Crypto API. Supports common hash algorithms available in browsers.
 
@@ -32,7 +32,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[hashParts(parts, algorithm, separator)](./ts-web-extras.browserhashprovider.hashparts.md)
+[hashParts(parts, algorithm, separator)](./ts-web-extras.cryptoutils.browserhashprovider.hashparts.md)
 
 
 </td><td>
@@ -48,7 +48,7 @@ Hash multiple strings concatenated with a separator.
 </td></tr>
 <tr><td>
 
-[hashString(data, algorithm)](./ts-web-extras.browserhashprovider.hashstring.md)
+[hashString(data, algorithm)](./ts-web-extras.cryptoutils.browserhashprovider.hashstring.md)
 
 
 </td><td>

package/docs/ts-web-extras.cryptoutils.createbrowsercryptoprovider.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@fgv/ts-web-extras](./ts-web-extras.md) &gt; [CryptoUtils](./ts-web-extras.cryptoutils.md) &gt; [createBrowserCryptoProvider](./ts-web-extras.cryptoutils.createbrowsercryptoprovider.md)
+
+## CryptoUtils.createBrowserCryptoProvider() function
+
+Creates a [BrowserCryptoProvider](./ts-web-extras.cryptoutils.browsercryptoprovider.md) if Web Crypto API is available.
+
+**Signature:**
+
+```typescript
+export declare function createBrowserCryptoProvider(): Result<BrowserCryptoProvider>;
+```
+**Returns:**
+
+Result&lt;[BrowserCryptoProvider](./ts-web-extras.cryptoutils.browsercryptoprovider.md)<!-- -->&gt;
+
+`Success` with provider, or `Failure` if not available
+

package/docs/ts-web-extras.cryptoutils.md

@@ -0,0 +1,71 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@fgv/ts-web-extras](./ts-web-extras.md) &gt; [CryptoUtils](./ts-web-extras.cryptoutils.md)
+
+## CryptoUtils namespace
+
+## Classes
+
+<table><thead><tr><th>
+
+Class
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[BrowserCryptoProvider](./ts-web-extras.cryptoutils.browsercryptoprovider.md)
+
+
+</td><td>
+
+Browser implementation of `ICryptoProvider` using the Web Crypto API. Uses AES-256-GCM for authenticated encryption.
+
+Note: This provider requires a browser environment with Web Crypto API support. In Node.js 15+, Web Crypto is available via globalThis.crypto or require('crypto').webcrypto.
+
+
+</td></tr>
+<tr><td>
+
+[BrowserHashProvider](./ts-web-extras.cryptoutils.browserhashprovider.md)
+
+
+</td><td>
+
+Browser-compatible hash provider using the Web Crypto API. Supports common hash algorithms available in browsers.
+
+
+</td></tr>
+</tbody></table>
+
+## Functions
+
+<table><thead><tr><th>
+
+Function
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[createBrowserCryptoProvider()](./ts-web-extras.cryptoutils.createbrowsercryptoprovider.md)
+
+
+</td><td>
+
+Creates a [BrowserCryptoProvider](./ts-web-extras.cryptoutils.browsercryptoprovider.md) if Web Crypto API is available.
+
+
+</td></tr>
+</tbody></table>
+