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

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

@@ -1,286 +0,0 @@
-<!-- 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; [IUrlConfigOptions](./ts-web-extras.iurlconfigoptions.md)
-
-## IUrlConfigOptions interface
-
-Configuration options that can be passed via URL parameters
-
-**Signature:**
-
-```typescript
-export interface IUrlConfigOptions 
-```
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[config?](./ts-web-extras.iurlconfigoptions.config.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-_(Optional)_ Configuration name or path
-
-
-</td></tr>
-<tr><td>
-
-[configStartDir?](./ts-web-extras.iurlconfigoptions.configstartdir.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-_(Optional)_ Starting directory for config file picker (derived from config path)
-
-
-</td></tr>
-<tr><td>
-
-[contextFilter?](./ts-web-extras.iurlconfigoptions.contextfilter.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-_(Optional)_ Context filter token (pipe-separated)
-
-
-</td></tr>
-<tr><td>
-
-[input?](./ts-web-extras.iurlconfigoptions.input.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-_(Optional)_ Input file path
-
-
-</td></tr>
-<tr><td>
-
-[inputStartDir?](./ts-web-extras.iurlconfigoptions.inputstartdir.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-_(Optional)_ Starting directory for input file picker (derived from input path)
-
-
-</td></tr>
-<tr><td>
-
-[interactive?](./ts-web-extras.iurlconfigoptions.interactive.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-_(Optional)_ Whether to launch in interactive mode
-
-
-</td></tr>
-<tr><td>
-
-[loadZip?](./ts-web-extras.iurlconfigoptions.loadzip.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-_(Optional)_ Whether to use ZIP loading mode
-
-
-</td></tr>
-<tr><td>
-
-[maxDistance?](./ts-web-extras.iurlconfigoptions.maxdistance.md)
-
-
-</td><td>
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-_(Optional)_ Maximum distance for language matching
-
-
-</td></tr>
-<tr><td>
-
-[qualifierDefaults?](./ts-web-extras.iurlconfigoptions.qualifierdefaults.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-_(Optional)_ Qualifier defaults token (pipe-separated)
-
-
-</td></tr>
-<tr><td>
-
-[reduceQualifiers?](./ts-web-extras.iurlconfigoptions.reducequalifiers.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-_(Optional)_ Whether to reduce qualifiers
-
-
-</td></tr>
-<tr><td>
-
-[resourceTypes?](./ts-web-extras.iurlconfigoptions.resourcetypes.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-_(Optional)_ Resource types filter (comma-separated)
-
-
-</td></tr>
-<tr><td>
-
-[zipFile?](./ts-web-extras.iurlconfigoptions.zipfile.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-_(Optional)_ Name of ZIP file to load from Downloads (filename only)
-
-
-</td></tr>
-<tr><td>
-
-[zipPath?](./ts-web-extras.iurlconfigoptions.zippath.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-_(Optional)_ Path to ZIP file to load (for CLI-generated ZIPs)
-
-
-</td></tr>
-</tbody></table>
-

package/docs/ts-web-extras.iurlconfigoptions.qualifierdefaults.md

@@ -1,13 +0,0 @@
-<!-- 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; [IUrlConfigOptions](./ts-web-extras.iurlconfigoptions.md) &gt; [qualifierDefaults](./ts-web-extras.iurlconfigoptions.qualifierdefaults.md)
-
-## IUrlConfigOptions.qualifierDefaults property
-
-Qualifier defaults token (pipe-separated)
-
-**Signature:**
-
-```typescript
-qualifierDefaults?: string;
-```

package/docs/ts-web-extras.iurlconfigoptions.reducequalifiers.md

@@ -1,13 +0,0 @@
-<!-- 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; [IUrlConfigOptions](./ts-web-extras.iurlconfigoptions.md) &gt; [reduceQualifiers](./ts-web-extras.iurlconfigoptions.reducequalifiers.md)
-
-## IUrlConfigOptions.reduceQualifiers property
-
-Whether to reduce qualifiers
-
-**Signature:**
-
-```typescript
-reduceQualifiers?: boolean;
-```

package/docs/ts-web-extras.iurlconfigoptions.resourcetypes.md

@@ -1,13 +0,0 @@
-<!-- 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; [IUrlConfigOptions](./ts-web-extras.iurlconfigoptions.md) &gt; [resourceTypes](./ts-web-extras.iurlconfigoptions.resourcetypes.md)
-
-## IUrlConfigOptions.resourceTypes property
-
-Resource types filter (comma-separated)
-
-**Signature:**
-
-```typescript
-resourceTypes?: string;
-```

package/docs/ts-web-extras.iurlconfigoptions.zipfile.md

@@ -1,13 +0,0 @@
-<!-- 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; [IUrlConfigOptions](./ts-web-extras.iurlconfigoptions.md) &gt; [zipFile](./ts-web-extras.iurlconfigoptions.zipfile.md)
-
-## IUrlConfigOptions.zipFile property
-
-Name of ZIP file to load from Downloads (filename only)
-
-**Signature:**
-
-```typescript
-zipFile?: string;
-```

package/docs/ts-web-extras.iurlconfigoptions.zippath.md

@@ -1,13 +0,0 @@
-<!-- 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; [IUrlConfigOptions](./ts-web-extras.iurlconfigoptions.md) &gt; [zipPath](./ts-web-extras.iurlconfigoptions.zippath.md)
-
-## IUrlConfigOptions.zipPath property
-
-Path to ZIP file to load (for CLI-generated ZIPs)
-
-**Signature:**
-
-```typescript
-zipPath?: string;
-```

package/docs/ts-web-extras.localstoragetreeaccessors.fileismutable.md

@@ -1,56 +0,0 @@
-<!-- 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; [LocalStorageTreeAccessors](./ts-web-extras.localstoragetreeaccessors.md) &gt; [fileIsMutable](./ts-web-extras.localstoragetreeaccessors.fileismutable.md)
-
-## LocalStorageTreeAccessors.fileIsMutable() method
-
-Check if a file is mutable and return persistence detail.
-
-**Signature:**
-
-```typescript
-fileIsMutable(path: string): DetailedResult<boolean, FileTree.SaveDetail>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-path
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-File path to check
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-DetailedResult&lt;boolean, FileTree.SaveDetail&gt;
-
-DetailedResult with mutability status and 'persistent' detail if mutable
-

package/docs/ts-web-extras.localstoragetreeaccessors.fromstorage.md

@@ -1,56 +0,0 @@
-<!-- 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; [LocalStorageTreeAccessors](./ts-web-extras.localstoragetreeaccessors.md) &gt; [fromStorage](./ts-web-extras.localstoragetreeaccessors.fromstorage.md)
-
-## LocalStorageTreeAccessors.fromStorage() method
-
-Create LocalStorageTreeAccessors from browser localStorage. Loads all collections from the configured storage keys.
-
-**Signature:**
-
-```typescript
-static fromStorage<TCT extends string = string>(params: ILocalStorageTreeParams<TCT>): Result<LocalStorageTreeAccessors<TCT>>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-params
-
-
-</td><td>
-
-[ILocalStorageTreeParams](./ts-web-extras.ilocalstoragetreeparams.md)<!-- -->&lt;TCT&gt;
-
-
-</td><td>
-
-Configuration including path-to-key mappings
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Result&lt;[LocalStorageTreeAccessors](./ts-web-extras.localstoragetreeaccessors.md)<!-- -->&lt;TCT&gt;&gt;
-
-Result containing the accessors or an error
-

package/docs/ts-web-extras.localstoragetreeaccessors.getdirtypaths.md

@@ -1,19 +0,0 @@
-<!-- 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; [LocalStorageTreeAccessors](./ts-web-extras.localstoragetreeaccessors.md) &gt; [getDirtyPaths](./ts-web-extras.localstoragetreeaccessors.getdirtypaths.md)
-
-## LocalStorageTreeAccessors.getDirtyPaths() method
-
-Get list of file paths with unsaved changes.
-
-**Signature:**
-
-```typescript
-getDirtyPaths(): string[];
-```
-**Returns:**
-
-string\[\]
-
-Array of dirty file paths
-

package/docs/ts-web-extras.localstoragetreeaccessors.isdirty.md

@@ -1,19 +0,0 @@
-<!-- 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; [LocalStorageTreeAccessors](./ts-web-extras.localstoragetreeaccessors.md) &gt; [isDirty](./ts-web-extras.localstoragetreeaccessors.isdirty.md)
-
-## LocalStorageTreeAccessors.isDirty() method
-
-Check if there are unsaved changes.
-
-**Signature:**
-
-```typescript
-isDirty(): boolean;
-```
-**Returns:**
-
-boolean
-
-True if there are dirty files
-

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

@@ -1,131 +0,0 @@
-<!-- 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; [LocalStorageTreeAccessors](./ts-web-extras.localstoragetreeaccessors.md)
-
-## LocalStorageTreeAccessors class
-
-Browser localStorage-backed file tree accessors with persistence support.
-
-Maps filesystem-like directory paths to localStorage keys, where each key stores multiple collections as a JSON object. This provides a general-purpose implementation for browser-based file tree persistence without requiring File System Access API.
-
-Storage format per key: `{ "collection-id": { ...collectionData }, ... }` File paths map as: `/data/ingredients/collection-id.json` → stored in key for `/data/ingredients`
-
-**Signature:**
-
-```typescript
-export declare class LocalStorageTreeAccessors<TCT extends string = string> extends FileTree.InMemoryTreeAccessors<TCT> implements FileTree.IPersistentFileTreeAccessors<TCT> 
-```
-**Extends:** FileTree.InMemoryTreeAccessors&lt;TCT&gt;
-
-**Implements:** FileTree.IPersistentFileTreeAccessors&lt;TCT&gt;
-
-## Remarks
-
-The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `LocalStorageTreeAccessors` class.
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[fileIsMutable(path)](./ts-web-extras.localstoragetreeaccessors.fileismutable.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Check if a file is mutable and return persistence detail.
-
-
-</td></tr>
-<tr><td>
-
-[fromStorage(params)](./ts-web-extras.localstoragetreeaccessors.fromstorage.md)
-
-
-</td><td>
-
-`static`
-
-
-</td><td>
-
-Create LocalStorageTreeAccessors from browser localStorage. Loads all collections from the configured storage keys.
-
-
-</td></tr>
-<tr><td>
-
-[getDirtyPaths()](./ts-web-extras.localstoragetreeaccessors.getdirtypaths.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Get list of file paths with unsaved changes.
-
-
-</td></tr>
-<tr><td>
-
-[isDirty()](./ts-web-extras.localstoragetreeaccessors.isdirty.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Check if there are unsaved changes.
-
-
-</td></tr>
-<tr><td>
-
-[saveFileContents(path, contents)](./ts-web-extras.localstoragetreeaccessors.savefilecontents.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Save file contents. Marks file as dirty and optionally auto-syncs.
-
-
-</td></tr>
-<tr><td>
-
-[syncToDisk()](./ts-web-extras.localstoragetreeaccessors.synctodisk.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Sync all dirty files to localStorage.
-
-
-</td></tr>
-</tbody></table>
-

package/docs/ts-web-extras.localstoragetreeaccessors.savefilecontents.md

@@ -1,72 +0,0 @@
-<!-- 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; [LocalStorageTreeAccessors](./ts-web-extras.localstoragetreeaccessors.md) &gt; [saveFileContents](./ts-web-extras.localstoragetreeaccessors.savefilecontents.md)
-
-## LocalStorageTreeAccessors.saveFileContents() method
-
-Save file contents. Marks file as dirty and optionally auto-syncs.
-
-**Signature:**
-
-```typescript
-saveFileContents(path: string, contents: string): Result<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>
-
-File path
-
-
-</td></tr>
-<tr><td>
-
-contents
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-New file contents
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Result&lt;string&gt;
-
-Result with the saved contents or error
-