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

package/docs/interfaces/IUrlConfigOptions.qualifierDefaults.md

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

package/docs/interfaces/IUrlConfigOptions.reduceQualifiers.md

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

package/docs/interfaces/IUrlConfigOptions.resourceTypes.md

@@ -0,0 +1,11 @@
+[Home](../README.md) > [IUrlConfigOptions](./IUrlConfigOptions.md) > resourceTypes
+
+## IUrlConfigOptions.resourceTypes property
+
+Resource types filter (comma-separated)
+
+**Signature:**
+
+```typescript
+resourceTypes: string;
+```

package/docs/interfaces/IUrlConfigOptions.zipFile.md

@@ -0,0 +1,11 @@
+[Home](../README.md) > [IUrlConfigOptions](./IUrlConfigOptions.md) > zipFile
+
+## IUrlConfigOptions.zipFile property
+
+Name of ZIP file to load from Downloads (filename only)
+
+**Signature:**
+
+```typescript
+zipFile: string;
+```

package/docs/interfaces/IUrlConfigOptions.zipPath.md

@@ -0,0 +1,11 @@
+[Home](../README.md) > [IUrlConfigOptions](./IUrlConfigOptions.md) > zipPath
+
+## IUrlConfigOptions.zipPath property
+
+Path to ZIP file to load (for CLI-generated ZIPs)
+
+**Signature:**
+
+```typescript
+zipPath: string;
+```

package/docs/interfaces/ShowDirectoryPickerOptions.id.md

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

package/docs/interfaces/ShowDirectoryPickerOptions.md

@@ -0,0 +1,78 @@
+[Home](../README.md) > ShowDirectoryPickerOptions
+
+# Interface: ShowDirectoryPickerOptions
+
+Directory picker options
+
+## Properties
+
+<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

@@ -0,0 +1,112 @@
+[Home](../README.md) > ShowOpenFilePickerOptions
+
+# Interface: ShowOpenFilePickerOptions
+
+File picker options
+
+## Properties
+
+<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

@@ -0,0 +1,112 @@
+[Home](../README.md) > ShowSaveFilePickerOptions
+
+# Interface: ShowSaveFilePickerOptions
+
+Save file picker options
+
+## Properties
+
+<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

@@ -0,0 +1,11 @@
+[Home](../README.md) > TreeInitializer
+
+# Type Alias: TreeInitializer
+
+Union type for all supported tree initializers.
+
+## Type
+
+```typescript
+type TreeInitializer = IFileListTreeInitializer | IFileHandleTreeInitializer | IDirectoryHandleTreeInitializer
+```

package/docs/type-aliases/WellKnownDirectory.md

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

package/docs/type-aliases/WindowWithFsAccess.md

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

package/docs/variables/DEFAULT_DIRECTORY_HANDLE_DB.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > DEFAULT_DIRECTORY_HANDLE_DB
+
+# Variable: DEFAULT_DIRECTORY_HANDLE_DB
+
+Default IndexedDB database name for directory handles.
+
+## Type
+
+`"chocolate-lab-storage"`

package/docs/variables/DEFAULT_DIRECTORY_HANDLE_STORE.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > DEFAULT_DIRECTORY_HANDLE_STORE
+
+# Variable: DEFAULT_DIRECTORY_HANDLE_STORE
+
+Default IndexedDB store name for directory handles.
+
+## Type
+
+`"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/etc/ts-web-extras.api.md

@@ -7,6 +7,7 @@
 import { CryptoUtils as CryptoUtils_2 } from '@fgv/ts-extras';
 import { DetailedResult } from '@fgv/ts-utils';
 import { FileTree } from '@fgv/ts-json-base';
+import { Logging } from '@fgv/ts-utils';
 import { Result } from '@fgv/ts-utils';
 
 // Warning: (ae-forgotten-export) The symbol "ICryptoProvider" needs to be exported by the entry point index.d.ts
@@ -85,6 +86,7 @@ function extractFileMetadata(file: File): IFileMetadata;
 // @public
 export class FileApiTreeAccessors<TCT extends string = string> {
     static create<TCT extends string = string>(initializers: TreeInitializer[], params?: FileTree.IFileTreeInitParams<TCT>): Promise<Result<FileTree.FileTree<TCT>>>;
+    static createFromHttp<TCT extends string = string>(params: IHttpTreeParams<TCT>): Promise<Result<FileTree.FileTree<TCT>>>;
     static createFromLocalStorage<TCT extends string = string>(params: ILocalStorageTreeParams<TCT>): Result<FileTree.FileTree<TCT>>;
     static createPersistent<TCT extends string = string>(dirHandle: FileSystemDirectoryHandle_2, params?: IFileSystemAccessTreeParams<TCT>): Promise<Result<FileTree.FileTree<TCT>>>;
     static createPersistentFromFile<TCT extends string = string>(fileHandle: FileSystemFileHandle_2, params?: IFileSystemAccessTreeParams<TCT>): Promise<Result<FileTree.FileTree<TCT>>>;
@@ -105,6 +107,7 @@ export interface FilePickerAcceptType {
 // @public
 export class FileSystemAccessTreeAccessors<TCT extends string = string> extends FileTree.InMemoryTreeAccessors<TCT> implements FileTree.IPersistentFileTreeAccessors<TCT> {
     protected constructor(files: FileTree.IInMemoryFile<TCT>[], rootDir: FileSystemDirectoryHandle_2, handles: Map<string, FileSystemFileHandle_2>, params: IFileSystemAccessTreeParams<TCT> | undefined, hasWritePermission: boolean);
+    deleteFile(path: string): Result<boolean>;
     fileIsMutable(path: string): DetailedResult<boolean, FileTree.SaveDetail>;
     static fromDirectoryHandle<TCT extends string = string>(dirHandle: FileSystemDirectoryHandle_2, params?: IFileSystemAccessTreeParams<TCT>): Promise<Result<FileSystemAccessTreeAccessors<TCT>>>;
     static fromFileHandle<TCT extends string = string>(fileHandle: FileSystemFileHandle_2, params?: IFileSystemAccessTreeParams<TCT>): Promise<Result<FileSystemAccessTreeAccessors<TCT>>>;
@@ -228,6 +231,18 @@ function fromFileList(fileList: FileList, params?: FileTree.IFileTreeInitParams<
 // @public
 function getOriginalFile(fileList: FileList, path: string): Result<File>;
 
+// @public
+export class HttpTreeAccessors<TCT extends string = string> extends FileTree.InMemoryTreeAccessors<TCT> implements FileTree.IPersistentFileTreeAccessors<TCT> {
+    // (undocumented)
+    deleteFile(path: string): Result<boolean>;
+    fileIsMutable(path: string): DetailedResult<boolean, FileTree.SaveDetail>;
+    static fromHttp<TCT extends string = string>(params: IHttpTreeParams<TCT>): Promise<Result<HttpTreeAccessors<TCT>>>;
+    getDirtyPaths(): string[];
+    isDirty(): boolean;
+    saveFileContents(path: string, contents: string): Result<string>;
+    syncToDisk(): Promise<Result<void>>;
+}
+
 // @public
 export interface IDirectoryHandleTreeInitializer {
     // (undocumented)
@@ -270,6 +285,7 @@ export interface IFileMetadata {
 export interface IFileSystemAccessTreeParams<TCT extends string = string> extends FileTree.IFileTreeInitParams<TCT> {
     autoSync?: boolean;
     filePath?: string;
+    logger?: Logging.LogReporter<unknown>;
     requireWritePermission?: boolean;
 }
 
@@ -283,6 +299,22 @@ export interface IFsAccessApis {
     showSaveFilePicker(options?: ShowSaveFilePickerOptions): Promise<FileSystemFileHandle_2>;
 }
 
+// @public
+export interface IHttpTreeParams<TCT extends string = string> extends FileTree.IFileTreeInitParams<TCT> {
+    // (undocumented)
+    readonly autoSync?: boolean;
+    // (undocumented)
+    readonly baseUrl: string;
+    // (undocumented)
+    readonly fetchImpl?: typeof fetch;
+    // (undocumented)
+    readonly logger?: Logging.LogReporter<unknown>;
+    // (undocumented)
+    readonly namespace?: string;
+    // (undocumented)
+    readonly userId?: string;
+}
+
 // @public
 export interface ILocalStorageTreeParams<TCT extends string = string> extends FileTree.IFileTreeInitParams<TCT> {
     autoSync?: boolean;
@@ -318,6 +350,7 @@ export interface IUrlConfigOptions {
 
 // @public
 export class LocalStorageTreeAccessors<TCT extends string = string> extends FileTree.InMemoryTreeAccessors<TCT> implements FileTree.IPersistentFileTreeAccessors<TCT> {
+    deleteFile(path: string): Result<boolean>;
     fileIsMutable(path: string): DetailedResult<boolean, FileTree.SaveDetail>;
     static fromStorage<TCT extends string = string>(params: ILocalStorageTreeParams<TCT>): Result<LocalStorageTreeAccessors<TCT>>;
     getDirtyPaths(): string[];

package/lib/packlets/file-tree/fileApiTreeAccessors.d.ts

@@ -2,6 +2,7 @@ import { Result } from '@fgv/ts-utils';
 import { FileTree } from '@fgv/ts-json-base';
 import { FileSystemFileHandle, FileSystemDirectoryHandle } from '../file-api-types';
 import { IFileSystemAccessTreeParams } from './fileSystemAccessTreeAccessors';
+import { IHttpTreeParams } from './httpTreeAccessors';
 import { ILocalStorageTreeParams } from './localStorageTreeAccessors';
 /**
  * Tree initializer for FileList objects (from File API).
@@ -65,6 +66,14 @@ export declare class FileApiTreeAccessors<TCT extends string = string> {
      * @public
      */
     static createPersistent<TCT extends string = string>(dirHandle: FileSystemDirectoryHandle, params?: IFileSystemAccessTreeParams<TCT>): Promise<Result<FileTree.FileTree<TCT>>>;
+    /**
+     * Create a persistent FileTree from an HTTP storage service.
+     *
+     * @param params - Configuration including API base URL, namespace, and optional autoSync
+     * @returns Promise resolving to a FileTree with persistence capability
+     * @public
+     */
+    static createFromHttp<TCT extends string = string>(params: IHttpTreeParams<TCT>): Promise<Result<FileTree.FileTree<TCT>>>;
     /**
      * Create a persistent FileTree from a single File System Access API file handle.
      * The tree contains exactly one file at `/<filename>`.