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

package/docs/interfaces/IHttpTreeParams.md

@@ -0,0 +1,182 @@
+[Home](../README.md) > IHttpTreeParams
+
+# Interface: IHttpTreeParams
+
+Configuration for creating HTTP-backed tree accessors.
+
+**Extends:** `IFileTreeInitParams<TCT>`
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[baseUrl](./IHttpTreeParams.baseUrl.md)
+
+</td><td>
+
+`readonly`
+
+</td><td>
+
+string
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[namespace](./IHttpTreeParams.namespace.md)
+
+</td><td>
+
+`readonly`
+
+</td><td>
+
+string
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[autoSync](./IHttpTreeParams.autoSync.md)
+
+</td><td>
+
+`readonly`
+
+</td><td>
+
+boolean
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[fetchImpl](./IHttpTreeParams.fetchImpl.md)
+
+</td><td>
+
+`readonly`
+
+</td><td>
+
+{ (input: RequestInfo | URL, init?: RequestInit): Promise&lt;Response&gt;; (input: string | Request | URL, init?: RequestInit): Promise&lt;Response&gt; }
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[userId](./IHttpTreeParams.userId.md)
+
+</td><td>
+
+`readonly`
+
+</td><td>
+
+string
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[logger](./IHttpTreeParams.logger.md)
+
+</td><td>
+
+`readonly`
+
+</td><td>
+
+LogReporter&lt;unknown, unknown&gt;
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[prefix](./IHttpTreeParams.prefix.md)
+
+</td><td>
+
+
+
+</td><td>
+
+string
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[inferContentType](./IHttpTreeParams.inferContentType.md)
+
+</td><td>
+
+
+
+</td><td>
+
+ContentTypeFactory&lt;TCT&gt;
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[mutable](./IHttpTreeParams.mutable.md)
+
+</td><td>
+
+
+
+</td><td>
+
+boolean | IFilterSpec
+
+</td><td>
+
+Controls mutability of the file tree.
+
+</td></tr>
+</tbody></table>

package/docs/interfaces/IHttpTreeParams.namespace.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [IHttpTreeParams](./IHttpTreeParams.md) > namespace
+
+## IHttpTreeParams.namespace property
+
+**Signature:**
+
+```typescript
+readonly namespace: string;
+```

package/docs/interfaces/IHttpTreeParams.userId.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [IHttpTreeParams](./IHttpTreeParams.md) > userId
+
+## IHttpTreeParams.userId property
+
+**Signature:**
+
+```typescript
+readonly userId: string;
+```

package/docs/interfaces/ILocalStorageTreeParams.autoSync.md

@@ -0,0 +1,12 @@
+[Home](../README.md) > [ILocalStorageTreeParams](./ILocalStorageTreeParams.md) > autoSync
+
+## ILocalStorageTreeParams.autoSync property
+
+If true, automatically sync changes to localStorage on every modification.
+If false (default), changes are only synced when syncToDisk() is called.
+
+**Signature:**
+
+```typescript
+autoSync: boolean;
+```

package/docs/interfaces/ILocalStorageTreeParams.md

@@ -0,0 +1,131 @@
+[Home](../README.md) > ILocalStorageTreeParams
+
+# Interface: ILocalStorageTreeParams
+
+Configuration for LocalStorageTreeAccessors.
+
+**Extends:** `IFileTreeInitParams<TCT>`
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[pathToKeyMap](./ILocalStorageTreeParams.pathToKeyMap.md)
+
+</td><td>
+
+
+
+</td><td>
+
+Record&lt;string, string&gt;
+
+</td><td>
+
+Map of directory path prefixes to localStorage keys.
+
+</td></tr>
+<tr><td>
+
+[storage](./ILocalStorageTreeParams.storage.md)
+
+</td><td>
+
+
+
+</td><td>
+
+Storage
+
+</td><td>
+
+Storage instance to use.
+
+</td></tr>
+<tr><td>
+
+[autoSync](./ILocalStorageTreeParams.autoSync.md)
+
+</td><td>
+
+
+
+</td><td>
+
+boolean
+
+</td><td>
+
+If true, automatically sync changes to localStorage on every modification.
+
+</td></tr>
+<tr><td>
+
+[prefix](./ILocalStorageTreeParams.prefix.md)
+
+</td><td>
+
+
+
+</td><td>
+
+string
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[inferContentType](./ILocalStorageTreeParams.inferContentType.md)
+
+</td><td>
+
+
+
+</td><td>
+
+ContentTypeFactory&lt;TCT&gt;
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[mutable](./ILocalStorageTreeParams.mutable.md)
+
+</td><td>
+
+
+
+</td><td>
+
+boolean | IFilterSpec
+
+</td><td>
+
+Controls mutability of the file tree.
+
+</td></tr>
+</tbody></table>

package/docs/interfaces/ILocalStorageTreeParams.pathToKeyMap.md

@@ -0,0 +1,13 @@
+[Home](../README.md) > [ILocalStorageTreeParams](./ILocalStorageTreeParams.md) > pathToKeyMap
+
+## ILocalStorageTreeParams.pathToKeyMap property
+
+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' }
+
+**Signature:**
+
+```typescript
+pathToKeyMap: Record<string, string>;
+```

package/docs/interfaces/ILocalStorageTreeParams.storage.md

@@ -0,0 +1,12 @@
+[Home](../README.md) > [ILocalStorageTreeParams](./ILocalStorageTreeParams.md) > storage
+
+## ILocalStorageTreeParams.storage property
+
+Storage instance to use. Defaults to window.localStorage.
+Can be overridden for testing with mock storage.
+
+**Signature:**
+
+```typescript
+storage: Storage;
+```

package/docs/interfaces/IUrlConfigOptions.config.md

@@ -0,0 +1,11 @@
+[Home](../README.md) > [IUrlConfigOptions](./IUrlConfigOptions.md) > config
+
+## IUrlConfigOptions.config property
+
+Configuration name or path
+
+**Signature:**
+
+```typescript
+config: string;
+```

package/docs/interfaces/IUrlConfigOptions.configStartDir.md

@@ -0,0 +1,11 @@
+[Home](../README.md) > [IUrlConfigOptions](./IUrlConfigOptions.md) > configStartDir
+
+## IUrlConfigOptions.configStartDir property
+
+Starting directory for config file picker (derived from config path)
+
+**Signature:**
+
+```typescript
+configStartDir: string;
+```

package/docs/interfaces/IUrlConfigOptions.contextFilter.md

@@ -0,0 +1,11 @@
+[Home](../README.md) > [IUrlConfigOptions](./IUrlConfigOptions.md) > contextFilter
+
+## IUrlConfigOptions.contextFilter property
+
+Context filter token (pipe-separated)
+
+**Signature:**
+
+```typescript
+contextFilter: string;
+```

package/docs/interfaces/IUrlConfigOptions.input.md

@@ -0,0 +1,11 @@
+[Home](../README.md) > [IUrlConfigOptions](./IUrlConfigOptions.md) > input
+
+## IUrlConfigOptions.input property
+
+Input file path
+
+**Signature:**
+
+```typescript
+input: string;
+```

package/docs/interfaces/IUrlConfigOptions.inputStartDir.md

@@ -0,0 +1,11 @@
+[Home](../README.md) > [IUrlConfigOptions](./IUrlConfigOptions.md) > inputStartDir
+
+## IUrlConfigOptions.inputStartDir property
+
+Starting directory for input file picker (derived from input path)
+
+**Signature:**
+
+```typescript
+inputStartDir: string;
+```

package/docs/interfaces/IUrlConfigOptions.interactive.md

@@ -0,0 +1,11 @@
+[Home](../README.md) > [IUrlConfigOptions](./IUrlConfigOptions.md) > interactive
+
+## IUrlConfigOptions.interactive property
+
+Whether to launch in interactive mode
+
+**Signature:**
+
+```typescript
+interactive: boolean;
+```

package/docs/interfaces/IUrlConfigOptions.loadZip.md

@@ -0,0 +1,11 @@
+[Home](../README.md) > [IUrlConfigOptions](./IUrlConfigOptions.md) > loadZip
+
+## IUrlConfigOptions.loadZip property
+
+Whether to use ZIP loading mode
+
+**Signature:**
+
+```typescript
+loadZip: boolean;
+```

package/docs/interfaces/IUrlConfigOptions.maxDistance.md

@@ -0,0 +1,11 @@
+[Home](../README.md) > [IUrlConfigOptions](./IUrlConfigOptions.md) > maxDistance
+
+## IUrlConfigOptions.maxDistance property
+
+Maximum distance for language matching
+
+**Signature:**
+
+```typescript
+maxDistance: number;
+```

package/docs/interfaces/IUrlConfigOptions.md

@@ -0,0 +1,248 @@
+[Home](../README.md) > IUrlConfigOptions
+
+# Interface: IUrlConfigOptions
+
+Configuration options that can be passed via URL parameters
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[input](./IUrlConfigOptions.input.md)
+
+</td><td>
+
+
+
+</td><td>
+
+string
+
+</td><td>
+
+Input file path
+
+</td></tr>
+<tr><td>
+
+[config](./IUrlConfigOptions.config.md)
+
+</td><td>
+
+
+
+</td><td>
+
+string
+
+</td><td>
+
+Configuration name or path
+
+</td></tr>
+<tr><td>
+
+[contextFilter](./IUrlConfigOptions.contextFilter.md)
+
+</td><td>
+
+
+
+</td><td>
+
+string
+
+</td><td>
+
+Context filter token (pipe-separated)
+
+</td></tr>
+<tr><td>
+
+[qualifierDefaults](./IUrlConfigOptions.qualifierDefaults.md)
+
+</td><td>
+
+
+
+</td><td>
+
+string
+
+</td><td>
+
+Qualifier defaults token (pipe-separated)
+
+</td></tr>
+<tr><td>
+
+[resourceTypes](./IUrlConfigOptions.resourceTypes.md)
+
+</td><td>
+
+
+
+</td><td>
+
+string
+
+</td><td>
+
+Resource types filter (comma-separated)
+
+</td></tr>
+<tr><td>
+
+[maxDistance](./IUrlConfigOptions.maxDistance.md)
+
+</td><td>
+
+
+
+</td><td>
+
+number
+
+</td><td>
+
+Maximum distance for language matching
+
+</td></tr>
+<tr><td>
+
+[reduceQualifiers](./IUrlConfigOptions.reduceQualifiers.md)
+
+</td><td>
+
+
+
+</td><td>
+
+boolean
+
+</td><td>
+
+Whether to reduce qualifiers
+
+</td></tr>
+<tr><td>
+
+[interactive](./IUrlConfigOptions.interactive.md)
+
+</td><td>
+
+
+
+</td><td>
+
+boolean
+
+</td><td>
+
+Whether to launch in interactive mode
+
+</td></tr>
+<tr><td>
+
+[inputStartDir](./IUrlConfigOptions.inputStartDir.md)
+
+</td><td>
+
+
+
+</td><td>
+
+string
+
+</td><td>
+
+Starting directory for input file picker (derived from input path)
+
+</td></tr>
+<tr><td>
+
+[configStartDir](./IUrlConfigOptions.configStartDir.md)
+
+</td><td>
+
+
+
+</td><td>
+
+string
+
+</td><td>
+
+Starting directory for config file picker (derived from config path)
+
+</td></tr>
+<tr><td>
+
+[loadZip](./IUrlConfigOptions.loadZip.md)
+
+</td><td>
+
+
+
+</td><td>
+
+boolean
+
+</td><td>
+
+Whether to use ZIP loading mode
+
+</td></tr>
+<tr><td>
+
+[zipPath](./IUrlConfigOptions.zipPath.md)
+
+</td><td>
+
+
+
+</td><td>
+
+string
+
+</td><td>
+
+Path to ZIP file to load (for CLI-generated ZIPs)
+
+</td></tr>
+<tr><td>
+
+[zipFile](./IUrlConfigOptions.zipFile.md)
+
+</td><td>
+
+
+
+</td><td>
+
+string
+
+</td><td>
+
+Name of ZIP file to load from Downloads (filename only)
+
+</td></tr>
+</tbody></table>