@fgv/ts-web-extras 5.0.0

package/docs/ts-web-extras.browserhashprovider.hashstring.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; [BrowserHashProvider](./ts-web-extras.browserhashprovider.md) &gt; [hashString](./ts-web-extras.browserhashprovider.hashstring.md)
+
+## 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.browserhashprovider.md

@@ -0,0 +1,66 @@
+<!-- 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)
+
+## 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.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.browserhashprovider.hashstring.md)
+
+
+</td><td>
+
+`static`
+
+
+</td><td>
+
+Hash a string using the specified algorithm.
+
+
+</td></tr>
+</tbody></table>
+

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

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

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

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

@@ -0,0 +1,52 @@
+<!-- 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; [extractDirectoryPath](./ts-web-extras.extractdirectorypath.md)
+
+## extractDirectoryPath() function
+
+Extracts the directory path from a file or directory path If the path appears to be a directory (no extension), returns it as-is If the path appears to be a file, returns the parent directory
+
+**Signature:**
+
+```typescript
+export declare function extractDirectoryPath(path: string): string;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+path
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+string
+

package/docs/ts-web-extras.fileapitreeaccessors.create.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; [FileApiTreeAccessors](./ts-web-extras.fileapitreeaccessors.md) &gt; [create](./ts-web-extras.fileapitreeaccessors.create.md)
+
+## FileApiTreeAccessors.create() method
+
+Create FileTree from various file sources using TreeInitializer array.
+
+**Signature:**
+
+```typescript
+static create<TCT extends string = string>(initializers: TreeInitializer[], params?: FileTree.IFileTreeInitParams<TCT>): Promise<Result<FileTree.FileTree<TCT>>>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+initializers
+
+
+</td><td>
+
+[TreeInitializer](./ts-web-extras.treeinitializer.md)<!-- -->\[\]
+
+
+</td><td>
+
+Array of TreeInitializer objects specifying file sources
+
+
+</td></tr>
+<tr><td>
+
+params
+
+
+</td><td>
+
+FileTree.IFileTreeInitParams&lt;TCT&gt;
+
+
+</td><td>
+
+_(Optional)_ Optional `IFileTreeInitParams` for the file tree.
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;Result&lt;FileTree.FileTree&lt;TCT&gt;&gt;&gt;
+
+Promise resolving to a FileTree with all content pre-loaded
+

package/docs/ts-web-extras.fileapitreeaccessors.extractfilemetadata.md

@@ -0,0 +1,54 @@
+<!-- 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; [FileApiTreeAccessors](./ts-web-extras.fileapitreeaccessors.md) &gt; [extractFileMetadata](./ts-web-extras.fileapitreeaccessors.extractfilemetadata.md)
+
+## FileApiTreeAccessors.extractFileMetadata() method
+
+Extract file metadata from a File.
+
+**Signature:**
+
+```typescript
+static extractFileMetadata(file: File): IFileMetadata;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+file
+
+
+</td><td>
+
+File
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+[IFileMetadata](./ts-web-extras.ifilemetadata.md)
+
+The [file metadata](./ts-web-extras.ifilemetadata.md)
+

package/docs/ts-web-extras.fileapitreeaccessors.fromdirectoryupload.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; [FileApiTreeAccessors](./ts-web-extras.fileapitreeaccessors.md) &gt; [fromDirectoryUpload](./ts-web-extras.fileapitreeaccessors.fromdirectoryupload.md)
+
+## FileApiTreeAccessors.fromDirectoryUpload() method
+
+Create FileTree from directory upload with webkitRelativePath.
+
+**Signature:**
+
+```typescript
+static fromDirectoryUpload<TCT extends string = string>(fileList: FileList, params?: FileTree.IFileTreeInitParams<TCT>): Promise<Result<FileTree.FileTree<TCT>>>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+fileList
+
+
+</td><td>
+
+FileList
+
+
+</td><td>
+
+FileList from a directory upload (input with webkitdirectory)
+
+
+</td></tr>
+<tr><td>
+
+params
+
+
+</td><td>
+
+FileTree.IFileTreeInitParams&lt;TCT&gt;
+
+
+</td><td>
+
+_(Optional)_ Optional `IFileTreeInitParams` for the file tree.
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;Result&lt;FileTree.FileTree&lt;TCT&gt;&gt;&gt;
+
+Promise resolving to a FileTree with all content pre-loaded
+

package/docs/ts-web-extras.fileapitreeaccessors.fromfilelist.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; [FileApiTreeAccessors](./ts-web-extras.fileapitreeaccessors.md) &gt; [fromFileList](./ts-web-extras.fileapitreeaccessors.fromfilelist.md)
+
+## FileApiTreeAccessors.fromFileList() method
+
+Create FileTree from FileList (e.g., from input\[type="file"\]).
+
+**Signature:**
+
+```typescript
+static fromFileList<TCT extends string = string>(fileList: FileList, params?: FileTree.IFileTreeInitParams<TCT>): Promise<Result<FileTree.FileTree<TCT>>>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+fileList
+
+
+</td><td>
+
+FileList
+
+
+</td><td>
+
+FileList from a file input element
+
+
+</td></tr>
+<tr><td>
+
+params
+
+
+</td><td>
+
+FileTree.IFileTreeInitParams&lt;TCT&gt;
+
+
+</td><td>
+
+_(Optional)_ Optional `IFileTreeInitParams` for the file tree.
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;Result&lt;FileTree.FileTree&lt;TCT&gt;&gt;&gt;
+
+Promise resolving to a FileTree with all content pre-loaded
+

package/docs/ts-web-extras.fileapitreeaccessors.getoriginalfile.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; [FileApiTreeAccessors](./ts-web-extras.fileapitreeaccessors.md) &gt; [getOriginalFile](./ts-web-extras.fileapitreeaccessors.getoriginalfile.md)
+
+## FileApiTreeAccessors.getOriginalFile() method
+
+Get the File object for a specific path from the original FileList. This is useful for accessing the original File API object for operations like getting file metadata, MIME type, etc.
+
+**Signature:**
+
+```typescript
+static getOriginalFile(fileList: FileList, targetPath: string): Result<File>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+fileList
+
+
+</td><td>
+
+FileList
+
+
+</td><td>
+
+The original FileList
+
+
+</td></tr>
+<tr><td>
+
+targetPath
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The path to find
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+Result&lt;File&gt;
+
+Result containing the File object if found
+