@fgv/ts-web-extras 5.1.0-3 → 5.1.0-5

package/docs/classes/BrowserCryptoProvider.generateRandomBytes.md

@@ -0,0 +1,24 @@
+[Home](../README.md) > [BrowserCryptoProvider](./BrowserCryptoProvider.md) > generateRandomBytes
+
+## BrowserCryptoProvider.generateRandomBytes() method
+
+Generates cryptographically secure random bytes.
+
+**Signature:**
+
+```typescript
+generateRandomBytes(length: number): Result<Uint8Array<ArrayBufferLike>>;
+```
+
+**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&lt;ArrayBufferLike&gt;&gt;
+
+Success with random bytes, or Failure with error

package/docs/classes/BrowserCryptoProvider.md

@@ -0,0 +1,151 @@
+[Home](../README.md) > BrowserCryptoProvider
+
+# Class: BrowserCryptoProvider
+
+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.
+
+**Implements:** `ICryptoProvider`
+
+## Constructors
+
+<table><thead><tr><th>
+
+Constructor
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+`constructor(cryptoApi)`
+
+</td><td>
+
+
+
+</td><td>
+
+Creates a new CryptoUtils.BrowserCryptoProvider | BrowserCryptoProvider.
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[encrypt(plaintext, key)](./BrowserCryptoProvider.encrypt.md)
+
+</td><td>
+
+
+
+</td><td>
+
+Encrypts plaintext using AES-256-GCM.
+
+</td></tr>
+<tr><td>
+
+[decrypt(encryptedData, key, iv, authTag)](./BrowserCryptoProvider.decrypt.md)
+
+</td><td>
+
+
+
+</td><td>
+
+Decrypts ciphertext using AES-256-GCM.
+
+</td></tr>
+<tr><td>
+
+[generateKey()](./BrowserCryptoProvider.generateKey.md)
+
+</td><td>
+
+
+
+</td><td>
+
+Generates a random 32-byte key suitable for AES-256.
+
+</td></tr>
+<tr><td>
+
+[deriveKey(password, salt, iterations)](./BrowserCryptoProvider.deriveKey.md)
+
+</td><td>
+
+
+
+</td><td>
+
+Derives a key from a password using PBKDF2.
+
+</td></tr>
+<tr><td>
+
+[generateRandomBytes(length)](./BrowserCryptoProvider.generateRandomBytes.md)
+
+</td><td>
+
+
+
+</td><td>
+
+Generates cryptographically secure random bytes.
+
+</td></tr>
+<tr><td>
+
+[toBase64(data)](./BrowserCryptoProvider.toBase64.md)
+
+</td><td>
+
+
+
+</td><td>
+
+Encodes binary data to base64 string.
+
+</td></tr>
+<tr><td>
+
+[fromBase64(base64)](./BrowserCryptoProvider.fromBase64.md)
+
+</td><td>
+
+
+
+</td><td>
+
+Decodes base64 string to binary data.
+
+</td></tr>
+</tbody></table>

package/docs/classes/BrowserCryptoProvider.toBase64.md

@@ -0,0 +1,24 @@
+[Home](../README.md) > [BrowserCryptoProvider](./BrowserCryptoProvider.md) > toBase64
+
+## 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/classes/BrowserHashProvider.hashParts.md

@@ -0,0 +1,26 @@
+[Home](../README.md) > [BrowserHashProvider](./BrowserHashProvider.md) > hashParts
+
+## 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>The hash algorithm to use</td></tr>
+<tr><td>separator</td><td>string</td><td>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/classes/BrowserHashProvider.hashString.md

@@ -0,0 +1,25 @@
+[Home](../README.md) > [BrowserHashProvider](./BrowserHashProvider.md) > hashString
+
+## 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>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/classes/BrowserHashProvider.md

@@ -0,0 +1,81 @@
+[Home](../README.md) > BrowserHashProvider
+
+# Class: BrowserHashProvider
+
+Browser-compatible hash provider using the Web Crypto API.
+Supports common hash algorithms available in browsers.
+
+## Constructors
+
+<table><thead><tr><th>
+
+Constructor
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+`constructor()`
+
+</td><td>
+
+
+
+</td><td>
+
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[hashString(data, algorithm)](./BrowserHashProvider.hashString.md)
+
+</td><td>
+
+`static`
+
+</td><td>
+
+Hash a string using the specified algorithm.
+
+</td></tr>
+<tr><td>
+
+[hashParts(parts, algorithm, separator)](./BrowserHashProvider.hashParts.md)
+
+</td><td>
+
+`static`
+
+</td><td>
+
+Hash multiple strings concatenated with a separator.
+
+</td></tr>
+</tbody></table>

package/docs/classes/DirectoryHandleStore.getAll.md

@@ -0,0 +1,17 @@
+[Home](../README.md) > [DirectoryHandleStore](./DirectoryHandleStore.md) > getAll
+
+## DirectoryHandleStore.getAll() method
+
+Returns all stored handles as label/handle pairs.
+
+**Signature:**
+
+```typescript
+getAll(): Promise<Result<{ label: string; handle: FileSystemDirectoryHandle }[]>>;
+```
+
+**Returns:**
+
+Promise&lt;Result&lt;{ label: string; handle: [FileSystemDirectoryHandle](../interfaces/FileSystemDirectoryHandle.md) }[]&gt;&gt;
+
+Success with array of entries, or Failure

package/docs/classes/DirectoryHandleStore.getAllLabels.md

@@ -0,0 +1,17 @@
+[Home](../README.md) > [DirectoryHandleStore](./DirectoryHandleStore.md) > getAllLabels
+
+## DirectoryHandleStore.getAllLabels() method
+
+Returns all stored labels (keys).
+
+**Signature:**
+
+```typescript
+getAllLabels(): Promise<Result<string[]>>;
+```
+
+**Returns:**
+
+Promise&lt;Result&lt;string[]&gt;&gt;
+
+Success with array of labels, or Failure

package/docs/classes/DirectoryHandleStore.load.md

@@ -0,0 +1,24 @@
+[Home](../README.md) > [DirectoryHandleStore](./DirectoryHandleStore.md) > load
+
+## DirectoryHandleStore.load() method
+
+Retrieves a directory handle by label.
+
+**Signature:**
+
+```typescript
+load(label: string): Promise<Result<FileSystemDirectoryHandle | undefined>>;
+```
+
+**Parameters:**
+
+<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
+<tbody>
+<tr><td>label</td><td>string</td><td>Key to look up</td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;Result&lt;[FileSystemDirectoryHandle](../interfaces/FileSystemDirectoryHandle.md) | undefined&gt;&gt;
+
+Success with handle (or undefined if not found), or Failure on error

package/docs/classes/DirectoryHandleStore.md

@@ -1,116 +1,120 @@
-[**@fgv/ts-web-extras**](../README.md)
-
-***
-
-[@fgv/ts-web-extras](../README.md) / DirectoryHandleStore
+[Home](../README.md) > DirectoryHandleStore
 
 # Class: DirectoryHandleStore
 
-Manages persistence of [FileSystemDirectoryHandle](../interfaces/FileSystemDirectoryHandle.md) objects in IndexedDB.
+Manages persistence of FileSystemDirectoryHandle objects in IndexedDB.
 Keyed by a label (typically the directory name).
 
 ## Constructors
 
-### Constructor
+<table><thead><tr><th>
+
+Constructor
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+`constructor(dbName, storeName)`
+
+</td><td>
+
 
-> **new DirectoryHandleStore**(`dbName`, `storeName`): `DirectoryHandleStore`
 
-#### Parameters
+</td><td>
 
-| Parameter | Type | Default value |
-| ------ | ------ | ------ |
-| `dbName` | `string` | `DEFAULT_DIRECTORY_HANDLE_DB` |
-| `storeName` | `string` | `DEFAULT_DIRECTORY_HANDLE_STORE` |
 
-#### Returns
 
-`DirectoryHandleStore`
+</td></tr>
+</tbody></table>
 
 ## Methods
 
-### getAll()
+<table><thead><tr><th>
 
-> **getAll**(): `Promise`\<[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`object`[]\>\>
+Method
 
-Returns all stored handles as label/handle pairs.
+</th><th>
 
-#### Returns
+Modifiers
 
-`Promise`\<[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`object`[]\>\>
+</th><th>
 
-Success with array of entries, or Failure
+Description
 
-***
+</th></tr></thead>
+<tbody>
+<tr><td>
 
-### getAllLabels()
+[save(label, handle)](./DirectoryHandleStore.save.md)
 
-> **getAllLabels**(): `Promise`\<[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`string`[]\>\>
+</td><td>
 
-Returns all stored labels (keys).
 
-#### Returns
 
-`Promise`\<[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`string`[]\>\>
+</td><td>
 
-Success with array of labels, or Failure
+Saves a directory handle to IndexedDB under the given label.
 
-***
+</td></tr>
+<tr><td>
 
-### load()
+[load(label)](./DirectoryHandleStore.load.md)
+
+</td><td>
 
-> **load**(`label`): `Promise`\<[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<[`FileSystemDirectoryHandle`](../interfaces/FileSystemDirectoryHandle.md) \| `undefined`\>\>
 
-Retrieves a directory handle by label.
 
-#### Parameters
+</td><td>
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `label` | `string` | Key to look up |
+Retrieves a directory handle by label.
 
-#### Returns
+</td></tr>
+<tr><td>
 
-`Promise`\<[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<[`FileSystemDirectoryHandle`](../interfaces/FileSystemDirectoryHandle.md) \| `undefined`\>\>
+[remove(label)](./DirectoryHandleStore.remove.md)
 
-Success with handle (or undefined if not found), or Failure on error
+</td><td>
 
-***
 
-### remove()
 
-> **remove**(`label`): `Promise`\<[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`void`\>\>
+</td><td>
 
 Removes a directory handle from IndexedDB.
 
-#### Parameters
+</td></tr>
+<tr><td>
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `label` | `string` | Key to remove |
+[getAllLabels()](./DirectoryHandleStore.getAllLabels.md)
 
-#### Returns
+</td><td>
 
-`Promise`\<[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`void`\>\>
 
-Success or Failure
 
-***
+</td><td>
 
-### save()
+Returns all stored labels (keys).
 
-> **save**(`label`, `handle`): `Promise`\<[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`void`\>\>
+</td></tr>
+<tr><td>
 
-Saves a directory handle to IndexedDB under the given label.
+[getAll()](./DirectoryHandleStore.getAll.md)
 
-#### Parameters
+</td><td>
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `label` | `string` | Key to store the handle under (typically dirHandle.name) |
-| `handle` | [`FileSystemDirectoryHandle`](../interfaces/FileSystemDirectoryHandle.md) | The FileSystemDirectoryHandle to persist |
 
-#### Returns
 
-`Promise`\<[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`void`\>\>
+</td><td>
+
+Returns all stored handles as label/handle pairs.
 
-Success or Failure
+</td></tr>
+</tbody></table>

package/docs/classes/DirectoryHandleStore.remove.md

@@ -0,0 +1,24 @@
+[Home](../README.md) > [DirectoryHandleStore](./DirectoryHandleStore.md) > remove
+
+## DirectoryHandleStore.remove() method
+
+Removes a directory handle from IndexedDB.
+
+**Signature:**
+
+```typescript
+remove(label: string): Promise<Result<void>>;
+```
+
+**Parameters:**
+
+<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
+<tbody>
+<tr><td>label</td><td>string</td><td>Key to remove</td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;Result&lt;void&gt;&gt;
+
+Success or Failure

package/docs/classes/DirectoryHandleStore.save.md

@@ -0,0 +1,25 @@
+[Home](../README.md) > [DirectoryHandleStore](./DirectoryHandleStore.md) > save
+
+## DirectoryHandleStore.save() method
+
+Saves a directory handle to IndexedDB under the given label.
+
+**Signature:**
+
+```typescript
+save(label: string, handle: FileSystemDirectoryHandle): Promise<Result<void>>;
+```
+
+**Parameters:**
+
+<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
+<tbody>
+<tr><td>label</td><td>string</td><td>Key to store the handle under (typically dirHandle.name)</td></tr>
+<tr><td>handle</td><td>FileSystemDirectoryHandle</td><td>The FileSystemDirectoryHandle to persist</td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;Result&lt;void&gt;&gt;
+
+Success or Failure

package/docs/classes/FileApiTreeAccessors.create.md

@@ -0,0 +1,25 @@
+[Home](../README.md) > [FileApiTreeAccessors](./FileApiTreeAccessors.md) > create
+
+## FileApiTreeAccessors.create() method
+
+Create FileTree from various file sources using TreeInitializer array.
+
+**Signature:**
+
+```typescript
+static create(initializers: TreeInitializer[], params?: IFileTreeInitParams<TCT>): Promise<Result<FileTree_2<TCT>>>;
+```
+
+**Parameters:**
+
+<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
+<tbody>
+<tr><td>initializers</td><td>TreeInitializer[]</td><td>Array of TreeInitializer objects specifying file sources</td></tr>
+<tr><td>params</td><td>IFileTreeInitParams&lt;TCT&gt;</td><td>Optional `IFileTreeInitParams` for the file tree.</td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;Result&lt;FileTree_2&lt;TCT&gt;&gt;&gt;
+
+Promise resolving to a FileTree with all content pre-loaded

package/docs/classes/FileApiTreeAccessors.createFromHttp.md

@@ -0,0 +1,24 @@
+[Home](../README.md) > [FileApiTreeAccessors](./FileApiTreeAccessors.md) > createFromHttp
+
+## FileApiTreeAccessors.createFromHttp() method
+
+Create a persistent FileTree from an HTTP storage service.
+
+**Signature:**
+
+```typescript
+static createFromHttp(params: IHttpTreeParams<TCT>): Promise<Result<FileTree_2<TCT>>>;
+```
+
+**Parameters:**
+
+<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
+<tbody>
+<tr><td>params</td><td>IHttpTreeParams&lt;TCT&gt;</td><td>Configuration including API base URL, namespace, and optional autoSync</td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;Result&lt;FileTree_2&lt;TCT&gt;&gt;&gt;
+
+Promise resolving to a FileTree with persistence capability