@fgv/ts-web-extras 5.1.0-2 → 5.1.0-21

package/docs/@fgv/namespaces/CryptoUtils/classes/BrowserHashProvider.md

@@ -1,63 +0,0 @@
-[**@fgv/ts-web-extras**](../../../../README.md)
-
-***
-
-[@fgv/ts-web-extras](../../../../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
-
-### Constructor
-
-> **new BrowserHashProvider**(): `BrowserHashProvider`
-
-#### Returns
-
-`BrowserHashProvider`
-
-## Methods
-
-### hashParts()
-
-> `static` **hashParts**(`parts`, `algorithm`, `separator`): `Promise`\<[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`string`\>\>
-
-Hash multiple strings concatenated with a separator.
-
-#### Parameters
-
-| Parameter | Type | Default value | Description |
-| ------ | ------ | ------ | ------ |
-| `parts` | `string`[] | `undefined` | Array of strings to concatenate and hash |
-| `algorithm` | `string` | `'SHA-256'` | The hash algorithm to use |
-| `separator` | `string` | '\|' | Separator to use between parts (default: '|') |
-
-#### Returns
-
-`Promise`\<[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`string`\>\>
-
-Promise resolving to the hex-encoded hash
-
-***
-
-### hashString()
-
-> `static` **hashString**(`data`, `algorithm`): `Promise`\<[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`string`\>\>
-
-Hash a string using the specified algorithm.
-
-#### Parameters
-
-| Parameter | Type | Default value | Description |
-| ------ | ------ | ------ | ------ |
-| `data` | `string` | `undefined` | The string to hash |
-| `algorithm` | `string` | `'SHA-256'` | The hash algorithm to use |
-
-#### Returns
-
-`Promise`\<[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`string`\>\>
-
-Promise resolving to the hex-encoded hash

package/docs/@fgv/namespaces/CryptoUtils/functions/createBrowserCryptoProvider.md

@@ -1,18 +0,0 @@
-[**@fgv/ts-web-extras**](../../../../README.md)
-
-***
-
-[@fgv/ts-web-extras](../../../../README.md) / [CryptoUtils](../README.md) / createBrowserCryptoProvider
-
-# Function: createBrowserCryptoProvider()
-
-> **createBrowserCryptoProvider**(): [`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<[`BrowserCryptoProvider`](../classes/BrowserCryptoProvider.md)\>
-
-Creates a [BrowserCryptoProvider](../classes/BrowserCryptoProvider.md) if Web
-Crypto API is available.
-
-## Returns
-
-[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<[`BrowserCryptoProvider`](../classes/BrowserCryptoProvider.md)\>
-
-`Success` with provider, or `Failure` if not available

package/docs/@fgv/namespaces/FileTreeHelpers/README.md

@@ -1,19 +0,0 @@
-[**@fgv/ts-web-extras**](../../../README.md)
-
-***
-
-[@fgv/ts-web-extras](../../../README.md) / FileTreeHelpers
-
-# FileTreeHelpers
-
-## Variables
-
-- [defaultFileApiTreeInitParams](variables/defaultFileApiTreeInitParams.md)
-
-## Functions
-
-- [extractFileListMetadata](functions/extractFileListMetadata.md)
-- [extractFileMetadata](functions/extractFileMetadata.md)
-- [fromDirectoryUpload](functions/fromDirectoryUpload.md)
-- [fromFileList](functions/fromFileList.md)
-- [getOriginalFile](functions/getOriginalFile.md)

package/docs/@fgv/namespaces/FileTreeHelpers/functions/extractFileListMetadata.md

@@ -1,23 +0,0 @@
-[**@fgv/ts-web-extras**](../../../../README.md)
-
-***
-
-[@fgv/ts-web-extras](../../../../README.md) / [FileTreeHelpers](../README.md) / extractFileListMetadata
-
-# Function: extractFileListMetadata()
-
-> **extractFileListMetadata**(`fileList`): [`IFileMetadata`](../../../../interfaces/IFileMetadata.md)[]
-
-Helper function to extract metadata from a `FileList`.
-
-## Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `fileList` | `FileList` | The `FileList` to extract metadata from |
-
-## Returns
-
-[`IFileMetadata`](../../../../interfaces/IFileMetadata.md)[]
-
-Array of [file metadata](../../../../interfaces/IFileMetadata.md) objects

package/docs/@fgv/namespaces/FileTreeHelpers/functions/extractFileMetadata.md

@@ -1,23 +0,0 @@
-[**@fgv/ts-web-extras**](../../../../README.md)
-
-***
-
-[@fgv/ts-web-extras](../../../../README.md) / [FileTreeHelpers](../README.md) / extractFileMetadata
-
-# Function: extractFileMetadata()
-
-> **extractFileMetadata**(`file`): [`IFileMetadata`](../../../../interfaces/IFileMetadata.md)
-
-Helper function to extract metadata from a `File`.
-
-## Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `file` | `File` | The File to extract metadata from |
-
-## Returns
-
-[`IFileMetadata`](../../../../interfaces/IFileMetadata.md)
-
-[file metadata](../../../../interfaces/IFileMetadata.md) object

package/docs/@fgv/namespaces/FileTreeHelpers/functions/fromDirectoryUpload.md

@@ -1,33 +0,0 @@
-[**@fgv/ts-web-extras**](../../../../README.md)
-
-***
-
-[@fgv/ts-web-extras](../../../../README.md) / [FileTreeHelpers](../README.md) / fromDirectoryUpload
-
-# Function: fromDirectoryUpload()
-
-> **fromDirectoryUpload**(`fileList`, `params?`): `Promise`\<[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<[`FileTree_2`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`string`\>\>\>
-
-Helper function to create a new FileTree instance
-from a directory upload with webkitRelativePath support.
-
-## Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `fileList` | `FileList` | FileList from a directory upload (input with webkitdirectory) |
-| `params?` | [`IFileTreeInitParams`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`string`\> | Optional `IFileTreeInitParams` for the file tree. |
-
-## Returns
-
-`Promise`\<[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<[`FileTree_2`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`string`\>\>\>
-
-Promise resolving to a successful Result with the new FileTree instance
-if successful, or a failed Result with an error message otherwise
-
-## Remarks
-
-The content type of the files is always `string` and the default
-accept contentType function (`FileTree.FileItem.defaultAcceptContentType`) is
-is used, so content type is derived from the mime type of the file, when
-available.

package/docs/@fgv/namespaces/FileTreeHelpers/functions/fromFileList.md

@@ -1,33 +0,0 @@
-[**@fgv/ts-web-extras**](../../../../README.md)
-
-***
-
-[@fgv/ts-web-extras](../../../../README.md) / [FileTreeHelpers](../README.md) / fromFileList
-
-# Function: fromFileList()
-
-> **fromFileList**(`fileList`, `params?`): `Promise`\<[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<[`FileTree_2`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`string`\>\>\>
-
-Helper function to create a new FileTree instance
-from a browser FileList (e.g., from input[type="file"]).
-
-## Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `fileList` | `FileList` | FileList from a file input element |
-| `params?` | [`IFileTreeInitParams`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`string`\> | Optional `IFileTreeInitParams` for the file tree. |
-
-## Returns
-
-`Promise`\<[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<[`FileTree_2`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`string`\>\>\>
-
-Promise resolving to a successful Result with the new FileTree instance
-if successful, or a failed Result with an error message otherwise
-
-## Remarks
-
-The content type of the files is always `string` and the default
-accept contentType function (`FileTree.FileItem.defaultAcceptContentType`) is
-used, so content type is derived from the mime type of the file, when
-available.

package/docs/@fgv/namespaces/FileTreeHelpers/functions/getOriginalFile.md

@@ -1,25 +0,0 @@
-[**@fgv/ts-web-extras**](../../../../README.md)
-
-***
-
-[@fgv/ts-web-extras](../../../../README.md) / [FileTreeHelpers](../README.md) / getOriginalFile
-
-# Function: getOriginalFile()
-
-> **getOriginalFile**(`fileList`, `path`): [`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`File`\>
-
-Helper function to get the original File object from a FileList by path.
-
-## Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `fileList` | `FileList` | The original FileList |
-| `path` | `string` | The path to the file |
-
-## Returns
-
-[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`File`\>
-
-A successful Result with the File object if found,
-or a failed Result with an error message otherwise

package/docs/@fgv/namespaces/FileTreeHelpers/variables/defaultFileApiTreeInitParams.md

@@ -1,11 +0,0 @@
-[**@fgv/ts-web-extras**](../../../../README.md)
-
-***
-
-[@fgv/ts-web-extras](../../../../README.md) / [FileTreeHelpers](../README.md) / defaultFileApiTreeInitParams
-
-# Variable: defaultFileApiTreeInitParams
-
-> `const` **defaultFileApiTreeInitParams**: [`FileTree.IFileTreeInitParams`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`string`\>
-
-Default initialization parameters for a `FileTree` using [FileApiTreeAccessors](../../../../classes/FileApiTreeAccessors.md).

package/docs/README.md

@@ -1,78 +0,0 @@
-**@fgv/ts-web-extras**
-
-***
-
-# @fgv/ts-web-extras
-
-Browser-compatible utilities and FileTree implementations.
-
-This library provides browser-compatible alternatives to Node.js-specific functionality,
-including Web Crypto API-based hashing, File API-based file tree implementations,
-and URL parameter parsing utilities.
-All exports are designed to be tree-shakeable for optimal bundle size.
-
-## Namespaces
-
-- [CryptoUtils](@fgv/namespaces/CryptoUtils/README.md)
-- [FileTreeHelpers](@fgv/namespaces/FileTreeHelpers/README.md)
-
-## Classes
-
-- [DirectoryHandleStore](classes/DirectoryHandleStore.md)
-- [FileApiTreeAccessors](classes/FileApiTreeAccessors.md)
-- [FileSystemAccessTreeAccessors](classes/FileSystemAccessTreeAccessors.md)
-- [HttpTreeAccessors](classes/HttpTreeAccessors.md)
-- [LocalStorageTreeAccessors](classes/LocalStorageTreeAccessors.md)
-
-## Interfaces
-
-- [FilePickerAcceptType](interfaces/FilePickerAcceptType.md)
-- [FileSystemCreateWritableOptions](interfaces/FileSystemCreateWritableOptions.md)
-- [FileSystemDirectoryHandle](interfaces/FileSystemDirectoryHandle.md)
-- [FileSystemFileHandle](interfaces/FileSystemFileHandle.md)
-- [FileSystemGetDirectoryOptions](interfaces/FileSystemGetDirectoryOptions.md)
-- [FileSystemGetFileOptions](interfaces/FileSystemGetFileOptions.md)
-- [FileSystemHandle](interfaces/FileSystemHandle.md)
-- [FileSystemHandlePermissionDescriptor](interfaces/FileSystemHandlePermissionDescriptor.md)
-- [FileSystemRemoveOptions](interfaces/FileSystemRemoveOptions.md)
-- [FileSystemWritableFileStream](interfaces/FileSystemWritableFileStream.md)
-- [IDirectoryHandleTreeInitializer](interfaces/IDirectoryHandleTreeInitializer.md)
-- [IFileHandleTreeInitializer](interfaces/IFileHandleTreeInitializer.md)
-- [IFileListTreeInitializer](interfaces/IFileListTreeInitializer.md)
-- [IFileMetadata](interfaces/IFileMetadata.md)
-- [IFileSystemAccessTreeParams](interfaces/IFileSystemAccessTreeParams.md)
-- [IFsAccessApis](interfaces/IFsAccessApis.md)
-- [IHttpTreeParams](interfaces/IHttpTreeParams.md)
-- [ILocalStorageTreeParams](interfaces/ILocalStorageTreeParams.md)
-- [IUrlConfigOptions](interfaces/IUrlConfigOptions.md)
-- [ShowDirectoryPickerOptions](interfaces/ShowDirectoryPickerOptions.md)
-- [ShowOpenFilePickerOptions](interfaces/ShowOpenFilePickerOptions.md)
-- [ShowSaveFilePickerOptions](interfaces/ShowSaveFilePickerOptions.md)
-
-## Type Aliases
-
-- [TreeInitializer](type-aliases/TreeInitializer.md)
-- [WellKnownDirectory](type-aliases/WellKnownDirectory.md)
-- [WindowWithFsAccess](type-aliases/WindowWithFsAccess.md)
-
-## Variables
-
-- [DEFAULT\_DIRECTORY\_HANDLE\_DB](variables/DEFAULT_DIRECTORY_HANDLE_DB.md)
-- [DEFAULT\_DIRECTORY\_HANDLE\_STORE](variables/DEFAULT_DIRECTORY_HANDLE_STORE.md)
-
-## Functions
-
-- [exportAsJson](functions/exportAsJson.md)
-- [exportUsingFileSystemAPI](functions/exportUsingFileSystemAPI.md)
-- [extractDirectoryPath](functions/extractDirectoryPath.md)
-- [isDirectoryHandle](functions/isDirectoryHandle.md)
-- [isFileHandle](functions/isFileHandle.md)
-- [isFilePath](functions/isFilePath.md)
-- [parseContextFilter](functions/parseContextFilter.md)
-- [parseQualifierDefaults](functions/parseQualifierDefaults.md)
-- [parseResourceTypes](functions/parseResourceTypes.md)
-- [parseUrlParameters](functions/parseUrlParameters.md)
-- [safeShowDirectoryPicker](functions/safeShowDirectoryPicker.md)
-- [safeShowOpenFilePicker](functions/safeShowOpenFilePicker.md)
-- [safeShowSaveFilePicker](functions/safeShowSaveFilePicker.md)
-- [supportsFileSystemAccess](functions/supportsFileSystemAccess.md)

package/docs/classes/DirectoryHandleStore.md

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