npm - @fgv/ts-web-extras - Versions diffs - 5.1.0-19 → 5.1.0-20 - Mend

@fgv/ts-web-extras 5.1.0-19 → 5.1.0-20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (393) hide show

package/docs/CryptoUtils/classes/BrowserCryptoProvider.generateKeyPair.md DELETED Viewed

@@ -1,25 +0,0 @@
-[Home](../../README.md) > [CryptoUtils](../README.md) > [BrowserCryptoProvider](./BrowserCryptoProvider.md) > generateKeyPair
-## BrowserCryptoProvider.generateKeyPair() method
-Generates a new asymmetric keypair via Web Crypto.
-**Signature:**
-```typescript
-generateKeyPair(algorithm: KeyPairAlgorithm, extractable: boolean): Promise<Result<CryptoKeyPair>>;
-```
-**Parameters:**
-<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
-<tbody>
-<tr><td>algorithm</td><td>KeyPairAlgorithm</td><td>The algorithm to use.</td></tr>
-<tr><td>extractable</td><td>boolean</td><td>Whether the resulting keys may be exported.</td></tr>
-</tbody></table>
-**Returns:**
-Promise&lt;Result&lt;CryptoKeyPair&gt;&gt;
-`Success` with the generated `CryptoKeyPair`, or `Failure` with an error.

package/docs/CryptoUtils/classes/BrowserCryptoProvider.generateRandomBytes.md DELETED Viewed

@@ -1,24 +0,0 @@
-[Home](../../README.md) > [CryptoUtils](../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/CryptoUtils/classes/BrowserCryptoProvider.importPublicKeyJwk.md DELETED Viewed

@@ -1,25 +0,0 @@
-[Home](../../README.md) > [CryptoUtils](../README.md) > [BrowserCryptoProvider](./BrowserCryptoProvider.md) > importPublicKeyJwk
-## BrowserCryptoProvider.importPublicKeyJwk() method
-Imports a public-key JWK as a `CryptoKey` for the requested algorithm.
-**Signature:**
-```typescript
-importPublicKeyJwk(jwk: JsonWebKey, algorithm: KeyPairAlgorithm): Promise<Result<CryptoKey>>;
-```
-**Parameters:**
-<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
-<tbody>
-<tr><td>jwk</td><td>JsonWebKey</td><td>The JSON Web Key produced by a prior export.</td></tr>
-<tr><td>algorithm</td><td>KeyPairAlgorithm</td><td>The algorithm the key was generated for.</td></tr>
-</tbody></table>
-**Returns:**
-Promise&lt;Result&lt;CryptoKey&gt;&gt;
-`Success` with the imported public `CryptoKey`, or `Failure` with an error.

package/docs/CryptoUtils/classes/BrowserCryptoProvider.md DELETED Viewed

@@ -1,231 +0,0 @@
-[Home](../../README.md) > [CryptoUtils](../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>
-[sha256(data)](./BrowserCryptoProvider.sha256.md)
-</td><td>
-</td><td>
-Computes a SHA-256 hash of the given data.
-</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>
-<tr><td>
-[generateKeyPair(algorithm, extractable)](./BrowserCryptoProvider.generateKeyPair.md)
-</td><td>
-</td><td>
-Generates a new asymmetric keypair via Web Crypto.
-</td></tr>
-<tr><td>
-[exportPublicKeyJwk(publicKey)](./BrowserCryptoProvider.exportPublicKeyJwk.md)
-</td><td>
-</td><td>
-Exports a public `CryptoKey` as a JSON Web Key.
-</td></tr>
-<tr><td>
-[importPublicKeyJwk(jwk, algorithm)](./BrowserCryptoProvider.importPublicKeyJwk.md)
-</td><td>
-</td><td>
-Imports a public-key JWK as a `CryptoKey` for the requested algorithm.
-</td></tr>
-<tr><td>
-[wrapBytes(plaintext, recipientPublicKey, options)](./BrowserCryptoProvider.wrapBytes.md)
-</td><td>
-</td><td>
-Wraps `plaintext` for the holder of `recipientPublicKey` using
-ECIES (ECDH P-256 + HKDF-SHA256 + AES-GCM-256).
-</td></tr>
-<tr><td>
-[unwrapBytes(wrapped, recipientPrivateKey, options)](./BrowserCryptoProvider.unwrapBytes.md)
-</td><td>
-</td><td>
-Unwraps a payload produced by `wrapBytes` using the recipient's private
-key.
-</td></tr>
-</tbody></table>

package/docs/CryptoUtils/classes/BrowserCryptoProvider.sha256.md DELETED Viewed

@@ -1,24 +0,0 @@
-[Home](../../README.md) > [CryptoUtils](../README.md) > [BrowserCryptoProvider](./BrowserCryptoProvider.md) > sha256
-## BrowserCryptoProvider.sha256() method
-Computes a SHA-256 hash of the given data.
-**Signature:**
-```typescript
-sha256(data: 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>UTF-8 string to hash</td></tr>
-</tbody></table>
-**Returns:**
-Promise&lt;Result&lt;string&gt;&gt;
-`Success` with hex-encoded hash string, or `Failure` with an error.

package/docs/CryptoUtils/classes/BrowserCryptoProvider.toBase64.md DELETED Viewed

@@ -1,24 +0,0 @@
-[Home](../../README.md) > [CryptoUtils](../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/CryptoUtils/classes/BrowserCryptoProvider.unwrapBytes.md DELETED Viewed

@@ -1,27 +0,0 @@
-[Home](../../README.md) > [CryptoUtils](../README.md) > [BrowserCryptoProvider](./BrowserCryptoProvider.md) > unwrapBytes
-## BrowserCryptoProvider.unwrapBytes() method
-Unwraps a payload produced by `wrapBytes` using the recipient's private
-key. See CryptoUtils.ICryptoProvider.unwrapBytes | ICryptoProvider.unwrapBytes.
-**Signature:**
-```typescript
-unwrapBytes(wrapped: IWrappedBytes, recipientPrivateKey: CryptoKey, options: IWrapBytesOptions): Promise<Result<Uint8Array<ArrayBufferLike>>>;
-```
-**Parameters:**
-<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
-<tbody>
-<tr><td>wrapped</td><td>IWrappedBytes</td><td>The wrapped payload.</td></tr>
-<tr><td>recipientPrivateKey</td><td>CryptoKey</td><td>The recipient's ECDH P-256 private `CryptoKey`.</td></tr>
-<tr><td>options</td><td>IWrapBytesOptions</td><td>HKDF salt and info matching the wrap call.</td></tr>
-</tbody></table>
-**Returns:**
-Promise&lt;Result&lt;Uint8Array&lt;ArrayBufferLike&gt;&gt;&gt;
-`Success` with the original `plaintext`, or `Failure` with an error.

package/docs/CryptoUtils/classes/BrowserCryptoProvider.wrapBytes.md DELETED Viewed

@@ -1,28 +0,0 @@
-[Home](../../README.md) > [CryptoUtils](../README.md) > [BrowserCryptoProvider](./BrowserCryptoProvider.md) > wrapBytes
-## BrowserCryptoProvider.wrapBytes() method
-Wraps `plaintext` for the holder of `recipientPublicKey` using
-ECIES (ECDH P-256 + HKDF-SHA256 + AES-GCM-256). See
-CryptoUtils.ICryptoProvider.wrapBytes | ICryptoProvider.wrapBytes.
-**Signature:**
-```typescript
-wrapBytes(plaintext: Uint8Array, recipientPublicKey: CryptoKey, options: IWrapBytesOptions): Promise<Result<IWrappedBytes>>;
-```
-**Parameters:**
-<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
-<tbody>
-<tr><td>plaintext</td><td>Uint8Array</td><td>The bytes to wrap.</td></tr>
-<tr><td>recipientPublicKey</td><td>CryptoKey</td><td>The recipient's ECDH P-256 public `CryptoKey`.</td></tr>
-<tr><td>options</td><td>IWrapBytesOptions</td><td>HKDF salt and info; see CryptoUtils.IWrapBytesOptions | IWrapBytesOptions.</td></tr>
-</tbody></table>
-**Returns:**
-Promise&lt;Result&lt;IWrappedBytes&gt;&gt;
-`Success` with the wrapped payload, or `Failure` with an error.

package/docs/CryptoUtils/classes/BrowserHashProvider.hashParts.md DELETED Viewed

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

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

@@ -1,81 +0,0 @@
-[Home](../../README.md) > [CryptoUtils](../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/CryptoUtils/functions/createBrowserCryptoProvider.md DELETED Viewed

@@ -1,12 +0,0 @@
-[Home](../../README.md) > [CryptoUtils](../README.md) > createBrowserCryptoProvider
-# Function: createBrowserCryptoProvider
-Creates a CryptoUtils.BrowserCryptoProvider | BrowserCryptoProvider if Web
-Crypto API is available.
-## Signature
-```typescript
-function createBrowserCryptoProvider(): Result<BrowserCryptoProvider>
-```

package/docs/FileTreeHelpers/README.md DELETED Viewed

@@ -1,85 +0,0 @@
-[Home](../README.md) > FileTreeHelpers
-# Namespace: FileTreeHelpers
-## Functions
-<table><thead><tr><th>
-Name
-</th><th>
-Description
-</th></tr></thead>
-<tbody>
-<tr><td>
-[fromFileList](./functions/fromFileList.md)
-</td><td>
-Helper function to create a new FileTree instance
-</td></tr>
-<tr><td>
-[fromDirectoryUpload](./functions/fromDirectoryUpload.md)
-</td><td>
-Helper function to create a new FileTree instance
-</td></tr>
-<tr><td>
-[getOriginalFile](./functions/getOriginalFile.md)
-</td><td>
-Helper function to get the original File object from a FileList by path.
-</td></tr>
-<tr><td>
-[extractFileListMetadata](./functions/extractFileListMetadata.md)
-</td><td>
-Helper function to extract metadata from a `FileList`.
-</td></tr>
-<tr><td>
-[extractFileMetadata](./functions/extractFileMetadata.md)
-</td><td>
-Helper function to extract metadata from a `File`.
-</td></tr>
-</tbody></table>
-## Variables
-<table><thead><tr><th>
-Name
-</th><th>
-Description
-</th></tr></thead>
-<tbody>
-<tr><td>
-[defaultFileApiTreeInitParams](./variables/defaultFileApiTreeInitParams.md)
-</td><td>
-Default initialization parameters for a `FileTree` using FileApiTreeAccessors.
-</td></tr>
-</tbody></table>

package/docs/FileTreeHelpers/functions/extractFileListMetadata.md DELETED Viewed

@@ -1,11 +0,0 @@
-[Home](../../README.md) > [FileTreeHelpers](../README.md) > extractFileListMetadata
-# Function: extractFileListMetadata
-Helper function to extract metadata from a `FileList`.
-## Signature
-```typescript
-function extractFileListMetadata(fileList: FileList): IFileMetadata[]
-```

package/docs/FileTreeHelpers/functions/extractFileMetadata.md DELETED Viewed

@@ -1,11 +0,0 @@
-[Home](../../README.md) > [FileTreeHelpers](../README.md) > extractFileMetadata
-# Function: extractFileMetadata
-Helper function to extract metadata from a `File`.
-## Signature
-```typescript
-function extractFileMetadata(file: File): IFileMetadata
-```

package/docs/FileTreeHelpers/functions/fromDirectoryUpload.md DELETED Viewed

@@ -1,12 +0,0 @@
-[Home](../../README.md) > [FileTreeHelpers](../README.md) > fromDirectoryUpload
-# Function: fromDirectoryUpload
-Helper function to create a new FileTree instance
-from a directory upload with webkitRelativePath support.
-## Signature
-```typescript
-function fromDirectoryUpload(fileList: FileList, params: IFileTreeInitParams<string>): Promise<Result<FileTree_2<string>>>
-```