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

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

@@ -1,169 +0,0 @@
-<!-- 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

@@ -1,56 +0,0 @@
-<!-- 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.cryptoutils.browserhashprovider.hashparts.md

@@ -1,88 +0,0 @@
-<!-- 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; [BrowserHashProvider](./ts-web-extras.cryptoutils.browserhashprovider.md) &gt; [hashParts](./ts-web-extras.cryptoutils.browserhashprovider.hashparts.md)
-
-## CryptoUtils.BrowserHashProvider.hashParts() method
-
-Hash multiple strings concatenated with a separator.
-
-**Signature:**
-
-```typescript
-static hashParts(parts: string[], algorithm?: string, separator?: string): Promise<Result<string>>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-parts
-
-
-</td><td>
-
-string\[\]
-
-
-</td><td>
-
-Array of strings to concatenate and hash
-
-
-</td></tr>
-<tr><td>
-
-algorithm
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-_(Optional)_ The hash algorithm to use
-
-
-</td></tr>
-<tr><td>
-
-separator
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-_(Optional)_ Separator to use between parts (default: '\|')
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;Result&lt;string&gt;&gt;
-
-Promise resolving to the hex-encoded hash
-

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

@@ -1,72 +0,0 @@
-<!-- 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; [BrowserHashProvider](./ts-web-extras.cryptoutils.browserhashprovider.md) &gt; [hashString](./ts-web-extras.cryptoutils.browserhashprovider.hashstring.md)
-
-## CryptoUtils.BrowserHashProvider.hashString() method
-
-Hash a string using the specified algorithm.
-
-**Signature:**
-
-```typescript
-static hashString(data: string, algorithm?: string): Promise<Result<string>>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-data
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-The string to hash
-
-
-</td></tr>
-<tr><td>
-
-algorithm
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-_(Optional)_ The hash algorithm to use
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;Result&lt;string&gt;&gt;
-
-Promise resolving to the hex-encoded hash
-

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

@@ -1,66 +0,0 @@
-<!-- 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; [BrowserHashProvider](./ts-web-extras.cryptoutils.browserhashprovider.md)
-
-## CryptoUtils.BrowserHashProvider class
-
-Browser-compatible hash provider using the Web Crypto API. Supports common hash algorithms available in browsers.
-
-**Signature:**
-
-```typescript
-export declare class BrowserHashProvider 
-```
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[hashParts(parts, algorithm, separator)](./ts-web-extras.cryptoutils.browserhashprovider.hashparts.md)
-
-
-</td><td>
-
-`static`
-
-
-</td><td>
-
-Hash multiple strings concatenated with a separator.
-
-
-</td></tr>
-<tr><td>
-
-[hashString(data, algorithm)](./ts-web-extras.cryptoutils.browserhashprovider.hashstring.md)
-
-
-</td><td>
-
-`static`
-
-
-</td><td>
-
-Hash a string using the specified algorithm.
-
-
-</td></tr>
-</tbody></table>
-

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

@@ -1,19 +0,0 @@
-<!-- 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

@@ -1,71 +0,0 @@
-<!-- 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>
-

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

@@ -1,70 +0,0 @@
-<!-- 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; [exportAsJson](./ts-web-extras.exportasjson.md)
-
-## exportAsJson() function
-
-Export data as JSON file using legacy blob download method. Creates a temporary download link and triggers file download.
-
-**Signature:**
-
-```typescript
-export declare function exportAsJson(data: unknown, filename: string): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-data
-
-
-</td><td>
-
-unknown
-
-
-</td><td>
-
-Data to export as JSON
-
-
-</td></tr>
-<tr><td>
-
-filename
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-Name for the downloaded file
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-

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

@@ -1,104 +0,0 @@
-<!-- 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; [exportUsingFileSystemAPI](./ts-web-extras.exportusingfilesystemapi.md)
-
-## exportUsingFileSystemAPI() function
-
-Export data using File System Access API with fallback to blob download.
-
-**Signature:**
-
-```typescript
-export declare function exportUsingFileSystemAPI(data: unknown, suggestedName: string, description?: string, window?: Window): Promise<boolean>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-data
-
-
-</td><td>
-
-unknown
-
-
-</td><td>
-
-Data to export as JSON
-
-
-</td></tr>
-<tr><td>
-
-suggestedName
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-Suggested filename for the save dialog
-
-
-</td></tr>
-<tr><td>
-
-description
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-_(Optional)_ Description for file type filter (default: 'JSON files')
-
-
-</td></tr>
-<tr><td>
-
-window
-
-
-</td><td>
-
-Window
-
-
-</td><td>
-
-_(Optional)_ Window object for API access (default: globalThis.window)
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;boolean&gt;
-
-Promise resolving to true if saved via File System Access API, false if fallback used
-