@fgv/ts-web-extras 5.1.0-3 → 5.1.0-4

package/docs/interfaces/ShowDirectoryPickerOptions.md

@@ -1,8 +1,4 @@
-[**@fgv/ts-web-extras**](../README.md)
-
-***
-
-[@fgv/ts-web-extras](../README.md) / ShowDirectoryPickerOptions
+[Home](../README.md) > ShowDirectoryPickerOptions
 
 # Interface: ShowDirectoryPickerOptions
 
@@ -10,8 +6,73 @@ 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) |
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[id](./ShowDirectoryPickerOptions.id.md)
+
+</td><td>
+
+
+
+</td><td>
+
+string
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[mode](./ShowDirectoryPickerOptions.mode.md)
+
+</td><td>
+
+
+
+</td><td>
+
+"readwrite" | "read"
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[startIn](./ShowDirectoryPickerOptions.startIn.md)
+
+</td><td>
+
+
+
+</td><td>
+
+[FileSystemHandle](FileSystemHandle.md) | [WellKnownDirectory](../type-aliases/WellKnownDirectory.md)
+
+</td><td>
+
+
+
+</td></tr>
+</tbody></table>

package/docs/interfaces/ShowDirectoryPickerOptions.mode.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [ShowDirectoryPickerOptions](./ShowDirectoryPickerOptions.md) > mode
+
+## ShowDirectoryPickerOptions.mode property
+
+**Signature:**
+
+```typescript
+mode: "readwrite" | "read";
+```

package/docs/interfaces/ShowDirectoryPickerOptions.startIn.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [ShowDirectoryPickerOptions](./ShowDirectoryPickerOptions.md) > startIn
+
+## ShowDirectoryPickerOptions.startIn property
+
+**Signature:**
+
+```typescript
+startIn: FileSystemHandle | WellKnownDirectory;
+```

package/docs/interfaces/ShowOpenFilePickerOptions.excludeAcceptAllOption.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [ShowOpenFilePickerOptions](./ShowOpenFilePickerOptions.md) > excludeAcceptAllOption
+
+## ShowOpenFilePickerOptions.excludeAcceptAllOption property
+
+**Signature:**
+
+```typescript
+excludeAcceptAllOption: boolean;
+```

package/docs/interfaces/ShowOpenFilePickerOptions.id.md

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

package/docs/interfaces/ShowOpenFilePickerOptions.md

@@ -1,8 +1,4 @@
-[**@fgv/ts-web-extras**](../README.md)
-
-***
-
-[@fgv/ts-web-extras](../README.md) / ShowOpenFilePickerOptions
+[Home](../README.md) > ShowOpenFilePickerOptions
 
 # Interface: ShowOpenFilePickerOptions
 
@@ -10,10 +6,107 @@ 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)[] |
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[multiple](./ShowOpenFilePickerOptions.multiple.md)
+
+</td><td>
+
+
+
+</td><td>
+
+boolean
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[excludeAcceptAllOption](./ShowOpenFilePickerOptions.excludeAcceptAllOption.md)
+
+</td><td>
+
+
+
+</td><td>
+
+boolean
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[id](./ShowOpenFilePickerOptions.id.md)
+
+</td><td>
+
+
+
+</td><td>
+
+string
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[startIn](./ShowOpenFilePickerOptions.startIn.md)
+
+</td><td>
+
+
+
+</td><td>
+
+[FileSystemHandle](FileSystemHandle.md) | [WellKnownDirectory](../type-aliases/WellKnownDirectory.md)
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[types](./ShowOpenFilePickerOptions.types.md)
+
+</td><td>
+
+
+
+</td><td>
+
+[FilePickerAcceptType](FilePickerAcceptType.md)[]
+
+</td><td>
+
+
+
+</td></tr>
+</tbody></table>

package/docs/interfaces/ShowOpenFilePickerOptions.multiple.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [ShowOpenFilePickerOptions](./ShowOpenFilePickerOptions.md) > multiple
+
+## ShowOpenFilePickerOptions.multiple property
+
+**Signature:**
+
+```typescript
+multiple: boolean;
+```

package/docs/interfaces/ShowOpenFilePickerOptions.startIn.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [ShowOpenFilePickerOptions](./ShowOpenFilePickerOptions.md) > startIn
+
+## ShowOpenFilePickerOptions.startIn property
+
+**Signature:**
+
+```typescript
+startIn: FileSystemHandle | WellKnownDirectory;
+```

package/docs/interfaces/ShowOpenFilePickerOptions.types.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [ShowOpenFilePickerOptions](./ShowOpenFilePickerOptions.md) > types
+
+## ShowOpenFilePickerOptions.types property
+
+**Signature:**
+
+```typescript
+types: FilePickerAcceptType[];
+```

package/docs/interfaces/ShowSaveFilePickerOptions.excludeAcceptAllOption.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [ShowSaveFilePickerOptions](./ShowSaveFilePickerOptions.md) > excludeAcceptAllOption
+
+## ShowSaveFilePickerOptions.excludeAcceptAllOption property
+
+**Signature:**
+
+```typescript
+excludeAcceptAllOption: boolean;
+```

package/docs/interfaces/ShowSaveFilePickerOptions.id.md

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

package/docs/interfaces/ShowSaveFilePickerOptions.md

@@ -1,8 +1,4 @@
-[**@fgv/ts-web-extras**](../README.md)
-
-***
-
-[@fgv/ts-web-extras](../README.md) / ShowSaveFilePickerOptions
+[Home](../README.md) > ShowSaveFilePickerOptions
 
 # Interface: ShowSaveFilePickerOptions
 
@@ -10,10 +6,107 @@ 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)[] |
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[excludeAcceptAllOption](./ShowSaveFilePickerOptions.excludeAcceptAllOption.md)
+
+</td><td>
+
+
+
+</td><td>
+
+boolean
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[id](./ShowSaveFilePickerOptions.id.md)
+
+</td><td>
+
+
+
+</td><td>
+
+string
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[startIn](./ShowSaveFilePickerOptions.startIn.md)
+
+</td><td>
+
+
+
+</td><td>
+
+[FileSystemHandle](FileSystemHandle.md) | [WellKnownDirectory](../type-aliases/WellKnownDirectory.md)
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[suggestedName](./ShowSaveFilePickerOptions.suggestedName.md)
+
+</td><td>
+
+
+
+</td><td>
+
+string
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[types](./ShowSaveFilePickerOptions.types.md)
+
+</td><td>
+
+
+
+</td><td>
+
+[FilePickerAcceptType](FilePickerAcceptType.md)[]
+
+</td><td>
+
+
+
+</td></tr>
+</tbody></table>

package/docs/interfaces/ShowSaveFilePickerOptions.startIn.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [ShowSaveFilePickerOptions](./ShowSaveFilePickerOptions.md) > startIn
+
+## ShowSaveFilePickerOptions.startIn property
+
+**Signature:**
+
+```typescript
+startIn: FileSystemHandle | WellKnownDirectory;
+```

package/docs/interfaces/ShowSaveFilePickerOptions.suggestedName.md

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

package/docs/interfaces/ShowSaveFilePickerOptions.types.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [ShowSaveFilePickerOptions](./ShowSaveFilePickerOptions.md) > types
+
+## ShowSaveFilePickerOptions.types property
+
+**Signature:**
+
+```typescript
+types: FilePickerAcceptType[];
+```

package/docs/type-aliases/TreeInitializer.md

@@ -1,11 +1,11 @@
-[**@fgv/ts-web-extras**](../README.md)
-
-***
-
-[@fgv/ts-web-extras](../README.md) / TreeInitializer
+[Home](../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.
+
+## Type
+
+```typescript
+type TreeInitializer = IFileListTreeInitializer | IFileHandleTreeInitializer | IDirectoryHandleTreeInitializer
+```

package/docs/type-aliases/WellKnownDirectory.md

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

package/docs/type-aliases/WindowWithFsAccess.md

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

package/docs/variables/DEFAULT_DIRECTORY_HANDLE_DB.md

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

package/docs/variables/DEFAULT_DIRECTORY_HANDLE_STORE.md

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

package/docs/variables/defaultFileApiTreeInitParams.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > defaultFileApiTreeInitParams
+
+# Variable: defaultFileApiTreeInitParams
+
+Default initialization parameters for a `FileTree` using FileApiTreeAccessors.
+
+## Type
+
+`FileTree.IFileTreeInitParams<string>`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fgv/ts-web-extras",
-  "version": "5.1.0-3",
+  "version": "5.1.0-4",
   "description": "Browser-compatible utilities and FileTree implementations",
   "main": "lib/index.js",
   "types": "dist/ts-web-extras.d.ts",
@@ -37,27 +37,28 @@
     "typescript": "5.9.3",
     "eslint-plugin-n": "^17.23.1",
     "@rushstack/eslint-config": "4.6.4",
-    "@rushstack/heft": "1.2.6",
+    "@rushstack/heft": "1.2.7",
     "@rushstack/heft-jest-plugin": "1.2.6",
-    "@rushstack/heft-node-rig": "2.11.26",
+    "@rushstack/heft-node-rig": "2.11.27",
     "@types/heft-jest": "1.0.6",
     "eslint-plugin-tsdoc": "~0.5.2",
     "@rushstack/eslint-patch": "1.14.1",
     "@types/react": "~19.2.8",
     "typedoc": "~0.28.16",
     "typedoc-plugin-markdown": "~4.9.0",
-    "@fgv/heft-dual-rig": "5.1.0-3",
-    "@fgv/ts-extras": "5.1.0-3",
-    "@fgv/ts-utils": "5.1.0-3",
-    "@fgv/ts-json-base": "5.1.0-3",
-    "@fgv/ts-utils-jest": "5.1.0-3"
+    "@fgv/heft-dual-rig": "5.1.0-4",
+    "@fgv/typedoc-compact-theme": "5.1.0-4",
+    "@fgv/ts-json-base": "5.1.0-4",
+    "@fgv/ts-utils-jest": "5.1.0-4",
+    "@fgv/ts-utils": "5.1.0-4",
+    "@fgv/ts-extras": "5.1.0-4"
   },
   "peerDependencies": {
     "react": ">=18 <20",
     "react-dom": ">=18 <20",
-    "@fgv/ts-extras": "5.1.0-3",
-    "@fgv/ts-json-base": "5.1.0-3",
-    "@fgv/ts-utils": "5.1.0-3"
+    "@fgv/ts-json-base": "5.1.0-4",
+    "@fgv/ts-extras": "5.1.0-4",
+    "@fgv/ts-utils": "5.1.0-4"
   },
   "exports": {
     ".": {

package/rush-logs/ts-web-extras.build.cache.log

@@ -1,3 +1,3 @@
 Caching build output folders: dist, lib, temp, .rush/temp/operation/build
 Successfully set cache entry.
-Cache key: 61c1d4a91d98f048b475a5bb3e6541c5d27819de
+Cache key: 44b0369e8112f3c6f4248af466a3f35ad626d9d7

package/rush-logs/ts-web-extras.build.log

@@ -2,10 +2,10 @@ Invoking: heft test --clean
  ---- build started ---- 
 [build:typescript] The TypeScript compiler version 5.9.3 is newer than the latest version that was tested with Heft (5.8); it may not work correctly.
 [build:typescript] Using TypeScript version 5.9.3
-[build:api-extractor] Using API Extractor version 7.57.6
+[build:api-extractor] Using API Extractor version 7.57.7
 [build:api-extractor] Analysis will use the bundled TypeScript version 5.8.2
 [build:api-extractor] *** The target project appears to use TypeScript 5.9.3 which is newer than the bundled compiler engine; consider upgrading API Extractor.
- ---- build finished (24.830s) ---- 
+ ---- build finished (24.455s) ---- 
  ---- test started ---- 
 [test:jest] Using Jest version 29.5.0
 [test:jest] 
@@ -14,20 +14,20 @@ Invoking: heft test --clean
 [test:jest] START lib/test/unit/httpTreeAccessors.test.js
 [test:jest] START lib/test/unit/localStorageTreeAccessors.test.js
 [test:jest] START lib/test/unit/fileSystemAccessTreeAccessors.test.js
-[test:jest] PASS lib/test/unit/localStorageTreeAccessors.test.js (duration: 1.749s, 44 passed, 0 failed)
+[test:jest] PASS lib/test/unit/httpTreeAccessors.test.js (duration: 1.937s, 57 passed, 0 failed)
 [test:jest] START lib/test/unit/fileTreeHelpers.test.js
-[test:jest] PASS lib/test/unit/fileApiTreeAccessors.test.js (duration: 2.021s, 65 passed, 0 failed)
+[test:jest] PASS lib/test/unit/fileApiTreeAccessors.test.js (duration: 2.182s, 65 passed, 0 failed)
 [test:jest] START lib/test/unit/fileApiTypes.test.js
-[test:jest] PASS lib/test/unit/httpTreeAccessors.test.js (duration: 2.316s, 57 passed, 0 failed)
+[test:jest] PASS lib/test/unit/localStorageTreeAccessors.test.js (duration: 2.170s, 44 passed, 0 failed)
 [test:jest] START lib/test/unit/urlParams.test.js
-[test:jest] PASS lib/test/unit/fileSystemAccessTreeAccessors.test.js (duration: 1.352s, 44 passed, 0 failed)
+[test:jest] PASS lib/test/unit/fileSystemAccessTreeAccessors.test.js (duration: 1.659s, 44 passed, 0 failed)
 [test:jest] START lib/test/unit/directoryHandleStore.test.js
-[test:jest] PASS lib/test/unit/fileTreeHelpers.test.js (duration: 1.538s, 35 passed, 0 failed)
+[test:jest] PASS lib/test/unit/fileApiTypes.test.js (duration: 1.275s, 36 passed, 0 failed)
 [test:jest] START lib/test/unit/browserHashProvider.test.js
-[test:jest] PASS lib/test/unit/fileApiTypes.test.js (duration: 1.440s, 36 passed, 0 failed)
-[test:jest] PASS lib/test/unit/urlParams.test.js (duration: 1.637s, 60 passed, 0 failed)
-[test:jest] PASS lib/test/unit/directoryHandleStore.test.js (duration: 1.412s, 19 passed, 0 failed)
-[test:jest] PASS lib/test/unit/browserHashProvider.test.js (duration: 1.586s, 15 passed, 0 failed)
+[test:jest] PASS lib/test/unit/fileTreeHelpers.test.js (duration: 1.784s, 35 passed, 0 failed)
+[test:jest] PASS lib/test/unit/directoryHandleStore.test.js (duration: 1.140s, 19 passed, 0 failed)
+[test:jest] PASS lib/test/unit/urlParams.test.js (duration: 1.398s, 60 passed, 0 failed)
+[test:jest] PASS lib/test/unit/browserHashProvider.test.js (duration: 1.392s, 15 passed, 0 failed)
 [test:jest] 
 [test:jest] Tests finished:
 [test:jest]   Successes: 375
@@ -51,5 +51,5 @@ All files                          |     100 |    99.62 |     100 |     100 |
  url-utils                         |     100 |      100 |     100 |     100 |                   
   urlParams.ts                     |     100 |      100 |     100 |     100 |                   
 -----------------------------------|---------|----------|---------|---------|-------------------
- ---- test finished (8.132s) ---- 
--------------------- Finished (32.975s) --------------------
+ ---- test finished (7.763s) ---- 
+-------------------- Finished (32.236s) --------------------