@fgv/ts-web-extras 5.0.2 → 5.1.0-1

package/docs/interfaces/FileSystemWritableFileStream.md

@@ -0,0 +1,127 @@
+[**@fgv/ts-web-extras**](../README.md)
+
+***
+
+[@fgv/ts-web-extras](../README.md) / FileSystemWritableFileStream
+
+# Interface: FileSystemWritableFileStream
+
+Writable file stream interface
+
+## Extends
+
+- `WritableStream`
+
+## Properties
+
+| Property | Modifier | Type | Description |
+| ------ | ------ | ------ | ------ |
+| <a id="locked"></a> `locked` | `readonly` | `boolean` | The **`locked`** read-only property of the WritableStream interface returns a boolean indicating whether the `WritableStream` is locked to a writer. [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream/locked) |
+
+## Methods
+
+### abort()
+
+> **abort**(`reason?`): `Promise`\<`void`\>
+
+The **`abort()`** method of the WritableStream interface aborts the stream, signaling that the producer can no longer successfully write to the stream and it is to be immediately moved to an error state, with any queued writes discarded.
+
+[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream/abort)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `reason?` | `any` |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Inherited from
+
+`WritableStream.abort`
+
+***
+
+### close()
+
+> **close**(): `Promise`\<`void`\>
+
+The **`close()`** method of the WritableStream interface closes the associated stream.
+
+[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream/close)
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Inherited from
+
+`WritableStream.close`
+
+***
+
+### getWriter()
+
+> **getWriter**(): `WritableStreamDefaultWriter`\<`any`\>
+
+The **`getWriter()`** method of the WritableStream interface returns a new instance of WritableStreamDefaultWriter and locks the stream to that instance.
+
+[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream/getWriter)
+
+#### Returns
+
+`WritableStreamDefaultWriter`\<`any`\>
+
+#### Inherited from
+
+`WritableStream.getWriter`
+
+***
+
+### seek()
+
+> **seek**(`position`): `Promise`\<`void`\>
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `position` | `number` |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### truncate()
+
+> **truncate**(`size`): `Promise`\<`void`\>
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `size` | `number` |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### write()
+
+> **write**(`data`): `Promise`\<`void`\>
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `data` | `string` \| `BufferSource` \| `Blob` |
+
+#### Returns
+
+`Promise`\<`void`\>

package/docs/interfaces/IDirectoryHandleTreeInitializer.md

@@ -0,0 +1,17 @@
+[**@fgv/ts-web-extras**](../README.md)
+
+***
+
+[@fgv/ts-web-extras](../README.md) / IDirectoryHandleTreeInitializer
+
+# Interface: IDirectoryHandleTreeInitializer
+
+Tree initializer for File System Access API directory handles.
+
+## Properties
+
+| Property | Modifier | Type |
+| ------ | ------ | ------ |
+| <a id="dirhandles"></a> `dirHandles` | `readonly` | [`FileSystemDirectoryHandle`](FileSystemDirectoryHandle.md)[] |
+| <a id="nonrecursive"></a> `nonRecursive?` | `readonly` | `boolean` |
+| <a id="prefix"></a> `prefix?` | `readonly` | `string` |

package/docs/interfaces/IFileHandleTreeInitializer.md

@@ -0,0 +1,16 @@
+[**@fgv/ts-web-extras**](../README.md)
+
+***
+
+[@fgv/ts-web-extras](../README.md) / IFileHandleTreeInitializer
+
+# Interface: IFileHandleTreeInitializer
+
+Tree initializer for File System Access API file handles.
+
+## Properties
+
+| Property | Modifier | Type |
+| ------ | ------ | ------ |
+| <a id="filehandles"></a> `fileHandles` | `readonly` | [`FileSystemFileHandle`](FileSystemFileHandle.md)[] |
+| <a id="prefix"></a> `prefix?` | `readonly` | `string` |

package/docs/interfaces/IFileListTreeInitializer.md

@@ -0,0 +1,15 @@
+[**@fgv/ts-web-extras**](../README.md)
+
+***
+
+[@fgv/ts-web-extras](../README.md) / IFileListTreeInitializer
+
+# Interface: IFileListTreeInitializer
+
+Tree initializer for FileList objects (from File API).
+
+## Properties
+
+| Property | Modifier | Type |
+| ------ | ------ | ------ |
+| <a id="filelist"></a> `fileList` | `readonly` | `FileList` |

package/docs/interfaces/IFileMetadata.md

@@ -0,0 +1,19 @@
+[**@fgv/ts-web-extras**](../README.md)
+
+***
+
+[@fgv/ts-web-extras](../README.md) / IFileMetadata
+
+# Interface: IFileMetadata
+
+Interface for file metadata.
+
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="lastmodified"></a> `lastModified` | `number` |
+| <a id="name"></a> `name` | `string` |
+| <a id="path"></a> `path` | `string` |
+| <a id="size"></a> `size` | `number` |
+| <a id="type"></a> `type` | `string` |

package/docs/interfaces/IFileSystemAccessTreeParams.md

@@ -0,0 +1,30 @@
+[**@fgv/ts-web-extras**](../README.md)
+
+***
+
+[@fgv/ts-web-extras](../README.md) / IFileSystemAccessTreeParams
+
+# Interface: IFileSystemAccessTreeParams\<TCT\>
+
+Options for creating persistent file trees.
+
+## Extends
+
+- [`IFileTreeInitParams`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`TCT`\>
+
+## Type Parameters
+
+| Type Parameter | Default type |
+| ------ | ------ |
+| `TCT` *extends* `string` | `string` |
+
+## Properties
+
+| Property | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| <a id="autosync"></a> `autoSync?` | `boolean` | `false` | Automatically sync changes to disk immediately after each save. If false, changes are batched and written on explicit syncToDisk() call. |
+| <a id="filepath"></a> `filePath?` | `string` | `undefined` | Override the path at which the file is stored in the tree (for fromFileHandle). Must be an absolute path (e.g., '/data/confections/common.yaml'). If omitted, defaults to `/<filename>`. |
+| <a id="infercontenttype"></a> `inferContentType?` | [`ContentTypeFactory`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`TCT`\> | `undefined` | - |
+| <a id="mutable"></a> `mutable?` | `boolean` \| [`IFilterSpec`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs) | `undefined` | Controls mutability of the file tree. - `undefined` or `false`: No files are mutable. - `true`: All files are mutable. - `IFilterSpec`: Only files matching the filter are mutable. |
+| <a id="prefix"></a> `prefix?` | `string` | `undefined` | - |
+| <a id="requirewritepermission"></a> `requireWritePermission?` | `boolean` | `true` | Require write permission on the directory handle. If true, fails if write permission cannot be obtained. If false, falls back to read-only mode. |

package/docs/interfaces/IFsAccessApis.md

@@ -0,0 +1,57 @@
+[**@fgv/ts-web-extras**](../README.md)
+
+***
+
+[@fgv/ts-web-extras](../README.md) / IFsAccessApis
+
+# Interface: IFsAccessApis
+
+File System Access API methods available on Window
+
+## Methods
+
+### showDirectoryPicker()
+
+> **showDirectoryPicker**(`options?`): `Promise`\<[`FileSystemDirectoryHandle`](FileSystemDirectoryHandle.md)\>
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `options?` | [`ShowDirectoryPickerOptions`](ShowDirectoryPickerOptions.md) |
+
+#### Returns
+
+`Promise`\<[`FileSystemDirectoryHandle`](FileSystemDirectoryHandle.md)\>
+
+***
+
+### showOpenFilePicker()
+
+> **showOpenFilePicker**(`options?`): `Promise`\<[`FileSystemFileHandle`](FileSystemFileHandle.md)[]\>
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `options?` | [`ShowOpenFilePickerOptions`](ShowOpenFilePickerOptions.md) |
+
+#### Returns
+
+`Promise`\<[`FileSystemFileHandle`](FileSystemFileHandle.md)[]\>
+
+***
+
+### showSaveFilePicker()
+
+> **showSaveFilePicker**(`options?`): `Promise`\<[`FileSystemFileHandle`](FileSystemFileHandle.md)\>
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `options?` | [`ShowSaveFilePickerOptions`](ShowSaveFilePickerOptions.md) |
+
+#### Returns
+
+`Promise`\<[`FileSystemFileHandle`](FileSystemFileHandle.md)\>

package/docs/interfaces/IHttpTreeParams.md

@@ -0,0 +1,32 @@
+[**@fgv/ts-web-extras**](../README.md)
+
+***
+
+[@fgv/ts-web-extras](../README.md) / IHttpTreeParams
+
+# Interface: IHttpTreeParams\<TCT\>
+
+Configuration for creating HTTP-backed tree accessors.
+
+## Extends
+
+- [`IFileTreeInitParams`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`TCT`\>
+
+## Type Parameters
+
+| Type Parameter | Default type |
+| ------ | ------ |
+| `TCT` *extends* `string` | `string` |
+
+## Properties
+
+| Property | Modifier | Type | Description |
+| ------ | ------ | ------ | ------ |
+| <a id="autosync"></a> `autoSync?` | `readonly` | `boolean` | - |
+| <a id="baseurl"></a> `baseUrl` | `readonly` | `string` | - |
+| <a id="fetchimpl"></a> `fetchImpl?` | `readonly` | \{(`input`, `init?`): `Promise`\<`Response`\>; (`input`, `init?`): `Promise`\<`Response`\>; \} | - |
+| <a id="infercontenttype"></a> `inferContentType?` | `public` | [`ContentTypeFactory`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`TCT`\> | - |
+| <a id="mutable"></a> `mutable?` | `public` | `boolean` \| [`IFilterSpec`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs) | Controls mutability of the file tree. - `undefined` or `false`: No files are mutable. - `true`: All files are mutable. - `IFilterSpec`: Only files matching the filter are mutable. |
+| <a id="namespace"></a> `namespace?` | `readonly` | `string` | - |
+| <a id="prefix"></a> `prefix?` | `public` | `string` | - |
+| <a id="userid"></a> `userId?` | `readonly` | `string` | - |

package/docs/interfaces/ILocalStorageTreeParams.md

@@ -0,0 +1,30 @@
+[**@fgv/ts-web-extras**](../README.md)
+
+***
+
+[@fgv/ts-web-extras](../README.md) / ILocalStorageTreeParams
+
+# Interface: ILocalStorageTreeParams\<TCT\>
+
+Configuration for LocalStorageTreeAccessors.
+
+## Extends
+
+- [`IFileTreeInitParams`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`TCT`\>
+
+## Type Parameters
+
+| Type Parameter | Default type |
+| ------ | ------ |
+| `TCT` *extends* `string` | `string` |
+
+## Properties
+
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| <a id="autosync"></a> `autoSync?` | `boolean` | If true, automatically sync changes to localStorage on every modification. If false (default), changes are only synced when syncToDisk() is called. |
+| <a id="infercontenttype"></a> `inferContentType?` | [`ContentTypeFactory`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`TCT`\> | - |
+| <a id="mutable"></a> `mutable?` | `boolean` \| [`IFilterSpec`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs) | Controls mutability of the file tree. - `undefined` or `false`: No files are mutable. - `true`: All files are mutable. - `IFilterSpec`: Only files matching the filter are mutable. |
+| <a id="pathtokeymap"></a> `pathToKeyMap` | `Record`\<`string`, `string`\> | Map of directory path prefixes to localStorage keys. Files under each prefix are stored in the corresponding localStorage key. Example: { '/data/ingredients': 'myapp:ingredients:v1' } |
+| <a id="prefix"></a> `prefix?` | `string` | - |
+| <a id="storage"></a> `storage?` | `Storage` | Storage instance to use. Defaults to window.localStorage. Can be overridden for testing with mock storage. |

package/docs/interfaces/IUrlConfigOptions.md

@@ -0,0 +1,27 @@
+[**@fgv/ts-web-extras**](../README.md)
+
+***
+
+[@fgv/ts-web-extras](../README.md) / IUrlConfigOptions
+
+# Interface: IUrlConfigOptions
+
+Configuration options that can be passed via URL parameters
+
+## Properties
+
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| <a id="config"></a> `config?` | `string` | Configuration name or path |
+| <a id="configstartdir"></a> `configStartDir?` | `string` | Starting directory for config file picker (derived from config path) |
+| <a id="contextfilter"></a> `contextFilter?` | `string` | Context filter token (pipe-separated) |
+| <a id="input"></a> `input?` | `string` | Input file path |
+| <a id="inputstartdir"></a> `inputStartDir?` | `string` | Starting directory for input file picker (derived from input path) |
+| <a id="interactive"></a> `interactive?` | `boolean` | Whether to launch in interactive mode |
+| <a id="loadzip"></a> `loadZip?` | `boolean` | Whether to use ZIP loading mode |
+| <a id="maxdistance"></a> `maxDistance?` | `number` | Maximum distance for language matching |
+| <a id="qualifierdefaults"></a> `qualifierDefaults?` | `string` | Qualifier defaults token (pipe-separated) |
+| <a id="reducequalifiers"></a> `reduceQualifiers?` | `boolean` | Whether to reduce qualifiers |
+| <a id="resourcetypes"></a> `resourceTypes?` | `string` | Resource types filter (comma-separated) |
+| <a id="zipfile"></a> `zipFile?` | `string` | Name of ZIP file to load from Downloads (filename only) |
+| <a id="zippath"></a> `zipPath?` | `string` | Path to ZIP file to load (for CLI-generated ZIPs) |

package/docs/interfaces/ShowDirectoryPickerOptions.md

@@ -0,0 +1,17 @@
+[**@fgv/ts-web-extras**](../README.md)
+
+***
+
+[@fgv/ts-web-extras](../README.md) / ShowDirectoryPickerOptions
+
+# Interface: ShowDirectoryPickerOptions
+
+Directory picker options
+
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="id"></a> `id?` | `string` |
+| <a id="mode"></a> `mode?` | `"readwrite"` \| `"read"` |
+| <a id="startin"></a> `startIn?` | [`FileSystemHandle`](FileSystemHandle.md) \| [`WellKnownDirectory`](../type-aliases/WellKnownDirectory.md) |

package/docs/interfaces/ShowOpenFilePickerOptions.md

@@ -0,0 +1,19 @@
+[**@fgv/ts-web-extras**](../README.md)
+
+***
+
+[@fgv/ts-web-extras](../README.md) / ShowOpenFilePickerOptions
+
+# Interface: ShowOpenFilePickerOptions
+
+File picker options
+
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="excludeacceptalloption"></a> `excludeAcceptAllOption?` | `boolean` |
+| <a id="id"></a> `id?` | `string` |
+| <a id="multiple"></a> `multiple?` | `boolean` |
+| <a id="startin"></a> `startIn?` | [`FileSystemHandle`](FileSystemHandle.md) \| [`WellKnownDirectory`](../type-aliases/WellKnownDirectory.md) |
+| <a id="types"></a> `types?` | [`FilePickerAcceptType`](FilePickerAcceptType.md)[] |

package/docs/interfaces/ShowSaveFilePickerOptions.md

@@ -0,0 +1,19 @@
+[**@fgv/ts-web-extras**](../README.md)
+
+***
+
+[@fgv/ts-web-extras](../README.md) / ShowSaveFilePickerOptions
+
+# Interface: ShowSaveFilePickerOptions
+
+Save file picker options
+
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="excludeacceptalloption"></a> `excludeAcceptAllOption?` | `boolean` |
+| <a id="id"></a> `id?` | `string` |
+| <a id="startin"></a> `startIn?` | [`FileSystemHandle`](FileSystemHandle.md) \| [`WellKnownDirectory`](../type-aliases/WellKnownDirectory.md) |
+| <a id="suggestedname"></a> `suggestedName?` | `string` |
+| <a id="types"></a> `types?` | [`FilePickerAcceptType`](FilePickerAcceptType.md)[] |

package/docs/type-aliases/TreeInitializer.md

@@ -0,0 +1,11 @@
+[**@fgv/ts-web-extras**](../README.md)
+
+***
+
+[@fgv/ts-web-extras](../README.md) / TreeInitializer
+
+# Type Alias: TreeInitializer
+
+> **TreeInitializer** = [`IFileListTreeInitializer`](../interfaces/IFileListTreeInitializer.md) \| [`IFileHandleTreeInitializer`](../interfaces/IFileHandleTreeInitializer.md) \| [`IDirectoryHandleTreeInitializer`](../interfaces/IDirectoryHandleTreeInitializer.md)
+
+Union type for all supported tree initializers.

package/docs/type-aliases/WellKnownDirectory.md

@@ -0,0 +1,11 @@
+[**@fgv/ts-web-extras**](../README.md)
+
+***
+
+[@fgv/ts-web-extras](../README.md) / WellKnownDirectory
+
+# Type Alias: WellKnownDirectory
+
+> **WellKnownDirectory** = `"desktop"` \| `"documents"` \| `"downloads"` \| `"music"` \| `"pictures"` \| `"videos"`
+
+Well-known directory type

package/docs/type-aliases/WindowWithFsAccess.md

@@ -0,0 +1,11 @@
+[**@fgv/ts-web-extras**](../README.md)
+
+***
+
+[@fgv/ts-web-extras](../README.md) / WindowWithFsAccess
+
+# Type Alias: WindowWithFsAccess
+
+> **WindowWithFsAccess** = `Window` & [`IFsAccessApis`](../interfaces/IFsAccessApis.md)
+
+Window interface extended with File System Access API

package/docs/variables/DEFAULT_DIRECTORY_HANDLE_DB.md

@@ -0,0 +1,11 @@
+[**@fgv/ts-web-extras**](../README.md)
+
+***
+
+[@fgv/ts-web-extras](../README.md) / DEFAULT\_DIRECTORY\_HANDLE\_DB
+
+# Variable: DEFAULT\_DIRECTORY\_HANDLE\_DB
+
+> `const` **DEFAULT\_DIRECTORY\_HANDLE\_DB**: `"chocolate-lab-storage"` = `'chocolate-lab-storage'`
+
+Default IndexedDB database name for directory handles.

package/docs/variables/DEFAULT_DIRECTORY_HANDLE_STORE.md

@@ -0,0 +1,11 @@
+[**@fgv/ts-web-extras**](../README.md)
+
+***
+
+[@fgv/ts-web-extras](../README.md) / DEFAULT\_DIRECTORY\_HANDLE\_STORE
+
+# Variable: DEFAULT\_DIRECTORY\_HANDLE\_STORE
+
+> `const` **DEFAULT\_DIRECTORY\_HANDLE\_STORE**: `"directory-handles"` = `'directory-handles'`
+
+Default IndexedDB store name for directory handles.