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

package/docs/ts-web-extras.fileapitreeaccessors.createfromlocalstorage.md

@@ -0,0 +1,74 @@
+<!-- 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; [FileApiTreeAccessors](./ts-web-extras.fileapitreeaccessors.md) &gt; [createFromLocalStorage](./ts-web-extras.fileapitreeaccessors.createfromlocalstorage.md)
+
+## FileApiTreeAccessors.createFromLocalStorage() method
+
+Create a persistent FileTree from browser localStorage. Changes to files can be synced back to localStorage.
+
+**Signature:**
+
+```typescript
+static createFromLocalStorage<TCT extends string = string>(params: ILocalStorageTreeParams<TCT>): Result<FileTree.FileTree<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 and optional autoSync
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+Result&lt;FileTree.FileTree&lt;TCT&gt;&gt;
+
+Result containing a FileTree with persistence capability
+
+## Remarks
+
+- Works in all browsers with localStorage support - Maps directory paths to localStorage keys - Each key stores multiple collections as JSON - Files are automatically discovered from storage
+
+## Example
+
+
+```typescript
+const tree = FileApiTreeAccessors.createFromLocalStorage({
+  pathToKeyMap: {
+    '/data/ingredients': 'myapp:ingredients:v1',
+    '/data/fillings': 'myapp:fillings:v1'
+  },
+  mutable: true,
+  autoSync: false
+});
+```
+

package/docs/ts-web-extras.fileapitreeaccessors.createpersistent.md

@@ -0,0 +1,76 @@
+<!-- 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; [FileApiTreeAccessors](./ts-web-extras.fileapitreeaccessors.md) &gt; [createPersistent](./ts-web-extras.fileapitreeaccessors.createpersistent.md)
+
+## FileApiTreeAccessors.createPersistent() method
+
+Create a persistent FileTree from a File System Access API directory handle. Changes to files can be synced back to disk.
+
+**Signature:**
+
+```typescript
+static createPersistent<TCT extends string = string>(dirHandle: FileSystemDirectoryHandle, params?: IFileSystemAccessTreeParams<TCT>): Promise<Result<FileTree.FileTree<TCT>>>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+dirHandle
+
+
+</td><td>
+
+[FileSystemDirectoryHandle](./ts-web-extras.filesystemdirectoryhandle_2.md)
+
+
+</td><td>
+
+FileSystemDirectoryHandle to load files from
+
+
+</td></tr>
+<tr><td>
+
+params
+
+
+</td><td>
+
+[IFileSystemAccessTreeParams](./ts-web-extras.ifilesystemaccesstreeparams.md)<!-- -->&lt;TCT&gt;
+
+
+</td><td>
+
+_(Optional)_ Optional parameters including autoSync and permission settings
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;Result&lt;FileTree.FileTree&lt;TCT&gt;&gt;&gt;
+
+Promise resolving to a FileTree with persistence capability
+
+## Remarks
+
+- Only works in browsers supporting File System Access API (Chrome, Edge, Opera) - Requires 'readwrite' permission on the directory handle - Falls back to read-only mode if permissions unavailable (unless requireWritePermission is true)
+

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

@@ -45,6 +45,38 @@ Description
 Create FileTree from various file sources using TreeInitializer array.
 
 
+</td></tr>
+<tr><td>
+
+[createFromLocalStorage(params)](./ts-web-extras.fileapitreeaccessors.createfromlocalstorage.md)
+
+
+</td><td>
+
+`static`
+
+
+</td><td>
+
+Create a persistent FileTree from browser localStorage. Changes to files can be synced back to localStorage.
+
+
+</td></tr>
+<tr><td>
+
+[createPersistent(dirHandle, params)](./ts-web-extras.fileapitreeaccessors.createpersistent.md)
+
+
+</td><td>
+
+`static`
+
+
+</td><td>
+
+Create a persistent FileTree from a File System Access API directory handle. Changes to files can be synced back to disk.
+
+
 </td></tr>
 <tr><td>
 

package/docs/ts-web-extras.filesystemaccesstreeaccessors._constructor_.md

@@ -0,0 +1,114 @@
+<!-- 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; [FileSystemAccessTreeAccessors](./ts-web-extras.filesystemaccesstreeaccessors.md) &gt; [(constructor)](./ts-web-extras.filesystemaccesstreeaccessors._constructor_.md)
+
+## FileSystemAccessTreeAccessors.(constructor)
+
+Protected constructor for FileSystemAccessTreeAccessors.
+
+**Signature:**
+
+```typescript
+protected constructor(files: FileTree.IInMemoryFile<TCT>[], rootDir: FileSystemDirectoryHandle, handles: Map<string, FileSystemFileHandle>, params: IFileSystemAccessTreeParams<TCT> | undefined, hasWritePermission: boolean);
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+files
+
+
+</td><td>
+
+FileTree.IInMemoryFile&lt;TCT&gt;\[\]
+
+
+</td><td>
+
+An array of in-memory files to include in the tree.
+
+
+</td></tr>
+<tr><td>
+
+rootDir
+
+
+</td><td>
+
+[FileSystemDirectoryHandle](./ts-web-extras.filesystemdirectoryhandle_2.md)
+
+
+</td><td>
+
+The root directory handle.
+
+
+</td></tr>
+<tr><td>
+
+handles
+
+
+</td><td>
+
+Map&lt;string, [FileSystemFileHandle](./ts-web-extras.filesystemfilehandle_2.md)<!-- -->&gt;
+
+
+</td><td>
+
+Map of file paths to their handles.
+
+
+</td></tr>
+<tr><td>
+
+params
+
+
+</td><td>
+
+[IFileSystemAccessTreeParams](./ts-web-extras.ifilesystemaccesstreeparams.md)<!-- -->&lt;TCT&gt; \| undefined
+
+
+</td><td>
+
+Optional params for the tree.
+
+
+</td></tr>
+<tr><td>
+
+hasWritePermission
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Whether write permission was granted.
+
+
+</td></tr>
+</tbody></table>
+

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

@@ -0,0 +1,52 @@
+<!-- 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; [FileSystemAccessTreeAccessors](./ts-web-extras.filesystemaccesstreeaccessors.md) &gt; [fileIsMutable](./ts-web-extras.filesystemaccesstreeaccessors.fileismutable.md)
+
+## FileSystemAccessTreeAccessors.fileIsMutable() method
+
+Implements `FileTree.IMutableFileTreeAccessors.fileIsMutable`
+
+**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>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+DetailedResult&lt;boolean, FileTree.SaveDetail&gt;
+

package/docs/ts-web-extras.filesystemaccesstreeaccessors.fromdirectoryhandle.md

@@ -0,0 +1,72 @@
+<!-- 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; [FileSystemAccessTreeAccessors](./ts-web-extras.filesystemaccesstreeaccessors.md) &gt; [fromDirectoryHandle](./ts-web-extras.filesystemaccesstreeaccessors.fromdirectoryhandle.md)
+
+## FileSystemAccessTreeAccessors.fromDirectoryHandle() method
+
+Creates a new FileSystemAccessTreeAccessors instance from a directory handle.
+
+**Signature:**
+
+```typescript
+static fromDirectoryHandle<TCT extends string = string>(dirHandle: FileSystemDirectoryHandle, params?: IFileSystemAccessTreeParams<TCT>): Promise<Result<FileSystemAccessTreeAccessors<TCT>>>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+dirHandle
+
+
+</td><td>
+
+[FileSystemDirectoryHandle](./ts-web-extras.filesystemdirectoryhandle_2.md)
+
+
+</td><td>
+
+The FileSystemDirectoryHandle to load files from.
+
+
+</td></tr>
+<tr><td>
+
+params
+
+
+</td><td>
+
+[IFileSystemAccessTreeParams](./ts-web-extras.ifilesystemaccesstreeparams.md)<!-- -->&lt;TCT&gt;
+
+
+</td><td>
+
+_(Optional)_ Optional parameters including autoSync and permission settings.
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;Result&lt;[FileSystemAccessTreeAccessors](./ts-web-extras.filesystemaccesstreeaccessors.md)<!-- -->&lt;TCT&gt;&gt;&gt;
+
+Promise resolving to a FileSystemAccessTreeAccessors instance.
+

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

@@ -0,0 +1,17 @@
+<!-- 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; [FileSystemAccessTreeAccessors](./ts-web-extras.filesystemaccesstreeaccessors.md) &gt; [getDirtyPaths](./ts-web-extras.filesystemaccesstreeaccessors.getdirtypaths.md)
+
+## FileSystemAccessTreeAccessors.getDirtyPaths() method
+
+Implements `FileTree.IPersistentFileTreeAccessors.getDirtyPaths`
+
+**Signature:**
+
+```typescript
+getDirtyPaths(): string[];
+```
+**Returns:**
+
+string\[\]
+

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

@@ -0,0 +1,17 @@
+<!-- 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; [FileSystemAccessTreeAccessors](./ts-web-extras.filesystemaccesstreeaccessors.md) &gt; [isDirty](./ts-web-extras.filesystemaccesstreeaccessors.isdirty.md)
+
+## FileSystemAccessTreeAccessors.isDirty() method
+
+Implements `FileTree.IPersistentFileTreeAccessors.isDirty`
+
+**Signature:**
+
+```typescript
+isDirty(): boolean;
+```
+**Returns:**
+
+boolean
+

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

@@ -0,0 +1,159 @@
+<!-- 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; [FileSystemAccessTreeAccessors](./ts-web-extras.filesystemaccesstreeaccessors.md)
+
+## FileSystemAccessTreeAccessors class
+
+Implementation of `FileTree.IPersistentFileTreeAccessors` that uses the File System Access API to provide persistent file editing in browsers.
+
+**Signature:**
+
+```typescript
+export declare class FileSystemAccessTreeAccessors<TCT extends string = string> extends FileTree.InMemoryTreeAccessors<TCT> implements FileTree.IPersistentFileTreeAccessors<TCT> 
+```
+**Extends:** FileTree.InMemoryTreeAccessors&lt;TCT&gt;
+
+**Implements:** FileTree.IPersistentFileTreeAccessors&lt;TCT&gt;
+
+## Constructors
+
+<table><thead><tr><th>
+
+Constructor
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)(files, rootDir, handles, params, hasWritePermission)](./ts-web-extras.filesystemaccesstreeaccessors._constructor_.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+Protected constructor for FileSystemAccessTreeAccessors.
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[fileIsMutable(path)](./ts-web-extras.filesystemaccesstreeaccessors.fileismutable.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Implements `FileTree.IMutableFileTreeAccessors.fileIsMutable`
+
+
+</td></tr>
+<tr><td>
+
+[fromDirectoryHandle(dirHandle, params)](./ts-web-extras.filesystemaccesstreeaccessors.fromdirectoryhandle.md)
+
+
+</td><td>
+
+`static`
+
+
+</td><td>
+
+Creates a new FileSystemAccessTreeAccessors instance from a directory handle.
+
+
+</td></tr>
+<tr><td>
+
+[getDirtyPaths()](./ts-web-extras.filesystemaccesstreeaccessors.getdirtypaths.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Implements `FileTree.IPersistentFileTreeAccessors.getDirtyPaths`
+
+
+</td></tr>
+<tr><td>
+
+[isDirty()](./ts-web-extras.filesystemaccesstreeaccessors.isdirty.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Implements `FileTree.IPersistentFileTreeAccessors.isDirty`
+
+
+</td></tr>
+<tr><td>
+
+[saveFileContents(path, contents)](./ts-web-extras.filesystemaccesstreeaccessors.savefilecontents.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Implements `FileTree.IMutableFileTreeAccessors.saveFileContents`
+
+
+</td></tr>
+<tr><td>
+
+[syncToDisk()](./ts-web-extras.filesystemaccesstreeaccessors.synctodisk.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Implements `FileTree.IPersistentFileTreeAccessors.syncToDisk`
+
+
+</td></tr>
+</tbody></table>
+

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

@@ -0,0 +1,66 @@
+<!-- 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; [FileSystemAccessTreeAccessors](./ts-web-extras.filesystemaccesstreeaccessors.md) &gt; [saveFileContents](./ts-web-extras.filesystemaccesstreeaccessors.savefilecontents.md)
+
+## FileSystemAccessTreeAccessors.saveFileContents() method
+
+Implements `FileTree.IMutableFileTreeAccessors.saveFileContents`
+
+**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>
+
+
+</td></tr>
+<tr><td>
+
+contents
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+Result&lt;string&gt;
+

package/docs/ts-web-extras.filesystemaccesstreeaccessors.synctodisk.md

@@ -0,0 +1,17 @@
+<!-- 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; [FileSystemAccessTreeAccessors](./ts-web-extras.filesystemaccesstreeaccessors.md) &gt; [syncToDisk](./ts-web-extras.filesystemaccesstreeaccessors.synctodisk.md)
+
+## FileSystemAccessTreeAccessors.syncToDisk() method
+
+Implements `FileTree.IPersistentFileTreeAccessors.syncToDisk`
+
+**Signature:**
+
+```typescript
+syncToDisk(): Promise<Result<void>>;
+```
+**Returns:**
+
+Promise&lt;Result&lt;void&gt;&gt;
+