npm - @fgv/ts-web-extras - Versions diffs - 5.1.0-19 → 5.1.0-20 - Mend

@fgv/ts-web-extras 5.1.0-19 → 5.1.0-20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (393) hide show

package/docs/classes/HttpTreeAccessors.saveFileContents.md DELETED Viewed

@@ -1,25 +0,0 @@
-[Home](../README.md) > [HttpTreeAccessors](./HttpTreeAccessors.md) > saveFileContents
-## HttpTreeAccessors.saveFileContents() method
-Saves file contents and marks the file as dirty for synchronization.
-**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>The path to the file.</td></tr>
-<tr><td>contents</td><td>string</td><td>The new contents of the file.</td></tr>
-</tbody></table>
-**Returns:**
-Result&lt;string&gt;
-A result indicating success or failure.

package/docs/classes/HttpTreeAccessors.syncToDisk.md DELETED Viewed

@@ -1,22 +0,0 @@
-[Home](../README.md) > [HttpTreeAccessors](./HttpTreeAccessors.md) > syncToDisk
-## HttpTreeAccessors.syncToDisk() method
-Synchronizes all dirty files to the HTTP backend.
-Uses a concurrency guard: if a sync is already in progress, callers
-await the existing operation rather than starting a parallel one.
-This prevents the thundering herd that occurs when autoSync fires
-for every file written during a bulk operation (e.g. restore).
-**Signature:**
-```typescript
-syncToDisk(): Promise<Result<void>>;
-```
-**Returns:**
-Promise&lt;Result&lt;void&gt;&gt;
-A promise that resolves to a result indicating success or failure.

package/docs/classes/LocalStorageTreeAccessors.deleteFile.md DELETED Viewed

@@ -1,24 +0,0 @@
-[Home](../README.md) > [LocalStorageTreeAccessors](./LocalStorageTreeAccessors.md) > deleteFile
-## LocalStorageTreeAccessors.deleteFile() method
-Delete a file and remove it from localStorage.
-**Signature:**
-```typescript
-deleteFile(path: string): Result<boolean>;
-```
-**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 delete</td></tr>
-</tbody></table>
-**Returns:**
-Result&lt;boolean&gt;
-Result with true if deleted, or error

package/docs/classes/LocalStorageTreeAccessors.fileIsMutable.md DELETED Viewed

@@ -1,24 +0,0 @@
-[Home](../README.md) > [LocalStorageTreeAccessors](./LocalStorageTreeAccessors.md) > fileIsMutable
-## LocalStorageTreeAccessors.fileIsMutable() method
-Check if a file is mutable and return persistence detail.
-**Signature:**
-```typescript
-fileIsMutable(path: string): DetailedResult<boolean, 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, SaveDetail&gt;
-DetailedResult with mutability status and 'persistent' detail if mutable

package/docs/classes/LocalStorageTreeAccessors.fromStorage.md DELETED Viewed

@@ -1,25 +0,0 @@
-[Home](../README.md) > [LocalStorageTreeAccessors](./LocalStorageTreeAccessors.md) > fromStorage
-## LocalStorageTreeAccessors.fromStorage() method
-Create LocalStorageTreeAccessors from browser localStorage.
-Loads all collections from the configured storage keys.
-**Signature:**
-```typescript
-static fromStorage(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&lt;TCT&gt;</td><td>Configuration including path-to-key mappings</td></tr>
-</tbody></table>
-**Returns:**
-Result&lt;[LocalStorageTreeAccessors](LocalStorageTreeAccessors.md)&lt;TCT&gt;&gt;
-Result containing the accessors or an error

package/docs/classes/LocalStorageTreeAccessors.getDirtyPaths.md DELETED Viewed

@@ -1,17 +0,0 @@
-[Home](../README.md) > [LocalStorageTreeAccessors](./LocalStorageTreeAccessors.md) > getDirtyPaths
-## LocalStorageTreeAccessors.getDirtyPaths() method
-Get list of file paths with unsaved changes.
-**Signature:**
-```typescript
-getDirtyPaths(): string[];
-```
-**Returns:**
-string[]
-Array of dirty file paths

package/docs/classes/LocalStorageTreeAccessors.isDirty.md DELETED Viewed

@@ -1,17 +0,0 @@
-[Home](../README.md) > [LocalStorageTreeAccessors](./LocalStorageTreeAccessors.md) > isDirty
-## LocalStorageTreeAccessors.isDirty() method
-Check if there are unsaved changes.
-**Signature:**
-```typescript
-isDirty(): boolean;
-```
-**Returns:**
-boolean
-True if there are dirty files

package/docs/classes/LocalStorageTreeAccessors.md DELETED Viewed

@@ -1,270 +0,0 @@
-[Home](../README.md) > LocalStorageTreeAccessors
-# Class: LocalStorageTreeAccessors
-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": "<raw file content>" }`
-File paths map as: `/data/ingredients/collection-id.yaml` → stored in key for `/data/ingredients`
-Legacy format (v1): `{ "collection-id": { ...parsedJsonObject } }` is auto-migrated on load.
-**Extends:** `InMemoryTreeAccessors<TCT>`
-**Implements:** `IPersistentFileTreeAccessors<TCT>`
-## Methods
-<table><thead><tr><th>
-Method
-</th><th>
-Modifiers
-</th><th>
-Description
-</th></tr></thead>
-<tbody>
-<tr><td>
-[fromStorage(params)](./LocalStorageTreeAccessors.fromStorage.md)
-</td><td>
-`static`
-</td><td>
-Create LocalStorageTreeAccessors from browser localStorage.
-</td></tr>
-<tr><td>
-[create(files, prefix)](./LocalStorageTreeAccessors.create.md)
-</td><td>
-`static`
-</td><td>
-Creates a new FileTree.InMemoryTreeAccessors | InMemoryTreeAccessors instance with the supplied
-</td></tr>
-<tr><td>
-[syncToDisk()](./LocalStorageTreeAccessors.syncToDisk.md)
-</td><td>
-</td><td>
-Sync all dirty files to localStorage.
-</td></tr>
-<tr><td>
-[isDirty()](./LocalStorageTreeAccessors.isDirty.md)
-</td><td>
-</td><td>
-Check if there are unsaved changes.
-</td></tr>
-<tr><td>
-[getDirtyPaths()](./LocalStorageTreeAccessors.getDirtyPaths.md)
-</td><td>
-</td><td>
-Get list of file paths with unsaved changes.
-</td></tr>
-<tr><td>
-[deleteFile(path)](./LocalStorageTreeAccessors.deleteFile.md)
-</td><td>
-</td><td>
-Delete a file and remove it from localStorage.
-</td></tr>
-<tr><td>
-[saveFileContents(path, contents)](./LocalStorageTreeAccessors.saveFileContents.md)
-</td><td>
-</td><td>
-Save file contents.
-</td></tr>
-<tr><td>
-[fileIsMutable(path)](./LocalStorageTreeAccessors.fileIsMutable.md)
-</td><td>
-</td><td>
-Check if a file is mutable and return persistence detail.
-</td></tr>
-<tr><td>
-[resolveAbsolutePath(paths)](./LocalStorageTreeAccessors.resolveAbsolutePath.md)
-</td><td>
-</td><td>
-Resolves paths to an absolute path.
-</td></tr>
-<tr><td>
-[getExtension(path)](./LocalStorageTreeAccessors.getExtension.md)
-</td><td>
-</td><td>
-Gets the extension of a path.
-</td></tr>
-<tr><td>
-[getBaseName(path, suffix)](./LocalStorageTreeAccessors.getBaseName.md)
-</td><td>
-</td><td>
-Gets the base name of a path.
-</td></tr>
-<tr><td>
-[joinPaths(paths)](./LocalStorageTreeAccessors.joinPaths.md)
-</td><td>
-</td><td>
-Joins paths together.
-</td></tr>
-<tr><td>
-[getItem(itemPath)](./LocalStorageTreeAccessors.getItem.md)
-</td><td>
-</td><td>
-Gets an item from the file tree.
-</td></tr>
-<tr><td>
-[getFileContents(path)](./LocalStorageTreeAccessors.getFileContents.md)
-</td><td>
-</td><td>
-Gets the contents of a file in the file tree.
-</td></tr>
-<tr><td>
-[getFileContentType(path, provided)](./LocalStorageTreeAccessors.getFileContentType.md)
-</td><td>
-</td><td>
-Gets the content type of a file in the file tree.
-</td></tr>
-<tr><td>
-[getChildren(path)](./LocalStorageTreeAccessors.getChildren.md)
-</td><td>
-</td><td>
-Gets the children of a directory in the file tree.
-</td></tr>
-<tr><td>
-[createDirectory(dirPath)](./LocalStorageTreeAccessors.createDirectory.md)
-</td><td>
-</td><td>
-Creates a directory at the given path, including any missing parent directories.
-</td></tr>
-<tr><td>
-[deleteDirectory(path)](./LocalStorageTreeAccessors.deleteDirectory.md)
-</td><td>
-</td><td>
-Deletes a directory at the given path.
-</td></tr>
-</tbody></table>

package/docs/classes/LocalStorageTreeAccessors.saveFileContents.md DELETED Viewed

@@ -1,25 +0,0 @@
-[Home](../README.md) > [LocalStorageTreeAccessors](./LocalStorageTreeAccessors.md) > saveFileContents
-## 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

package/docs/classes/LocalStorageTreeAccessors.syncToDisk.md DELETED Viewed

@@ -1,17 +0,0 @@
-[Home](../README.md) > [LocalStorageTreeAccessors](./LocalStorageTreeAccessors.md) > syncToDisk
-## LocalStorageTreeAccessors.syncToDisk() method
-Sync all dirty files to localStorage.
-**Signature:**
-```typescript
-syncToDisk(): Promise<Result<void>>;
-```
-**Returns:**
-Promise&lt;Result&lt;void&gt;&gt;
-Result indicating success or failure

package/docs/functions/createBrowserCryptoProvider.md DELETED Viewed

@@ -1,12 +0,0 @@
-[Home](../README.md) > createBrowserCryptoProvider
-# Function: createBrowserCryptoProvider
-Creates a CryptoUtils.BrowserCryptoProvider | BrowserCryptoProvider if Web
-Crypto API is available.
-## Signature
-```typescript
-function createBrowserCryptoProvider(): Result<BrowserCryptoProvider>
-```

package/docs/functions/exportAsJson.md DELETED Viewed

@@ -1,12 +0,0 @@
-[Home](../README.md) > exportAsJson
-# Function: exportAsJson
-Export data as JSON file using legacy blob download method.
-Creates a temporary download link and triggers file download.
-## Signature
-```typescript
-function exportAsJson(data: unknown, filename: string): void
-```

package/docs/functions/exportUsingFileSystemAPI.md DELETED Viewed

@@ -1,11 +0,0 @@
-[Home](../README.md) > exportUsingFileSystemAPI
-# Function: exportUsingFileSystemAPI
-Export data using File System Access API with fallback to blob download.
-## Signature
-```typescript
-function exportUsingFileSystemAPI(data: unknown, suggestedName: string, description: string, window: Window): Promise<boolean>
-```

package/docs/functions/extractDirectoryPath.md DELETED Viewed

@@ -1,13 +0,0 @@
-[Home](../README.md) > extractDirectoryPath
-# Function: extractDirectoryPath
-Extracts the directory path from a file or directory path
-If the path appears to be a directory (no extension), returns it as-is
-If the path appears to be a file, returns the parent directory
-## Signature
-```typescript
-function extractDirectoryPath(path: string): string
-```

package/docs/functions/extractFileListMetadata.md DELETED Viewed

@@ -1,11 +0,0 @@
-[Home](../README.md) > extractFileListMetadata
-# Function: extractFileListMetadata
-Helper function to extract metadata from a `FileList`.
-## Signature
-```typescript
-function extractFileListMetadata(fileList: FileList): IFileMetadata[]
-```

package/docs/functions/extractFileMetadata.md DELETED Viewed

@@ -1,11 +0,0 @@
-[Home](../README.md) > extractFileMetadata
-# Function: extractFileMetadata
-Helper function to extract metadata from a `File`.
-## Signature
-```typescript
-function extractFileMetadata(file: File): IFileMetadata
-```

package/docs/functions/fromDirectoryUpload.md DELETED Viewed

@@ -1,12 +0,0 @@
-[Home](../README.md) > fromDirectoryUpload
-# Function: fromDirectoryUpload
-Helper function to create a new FileTree instance
-from a directory upload with webkitRelativePath support.
-## Signature
-```typescript
-function fromDirectoryUpload(fileList: FileList, params: IFileTreeInitParams<string>): Promise<Result<FileTree_2<string>>>
-```

package/docs/functions/fromFileList.md DELETED Viewed

@@ -1,12 +0,0 @@
-[Home](../README.md) > fromFileList
-# Function: fromFileList
-Helper function to create a new FileTree instance
-from a browser FileList (e.g., from input[type="file"]).
-## Signature
-```typescript
-function fromFileList(fileList: FileList, params: IFileTreeInitParams<string>): Promise<Result<FileTree_2<string>>>
-```

package/docs/functions/getOriginalFile.md DELETED Viewed

@@ -1,11 +0,0 @@
-[Home](../README.md) > getOriginalFile
-# Function: getOriginalFile
-Helper function to get the original File object from a FileList by path.
-## Signature
-```typescript
-function getOriginalFile(fileList: FileList, path: string): Result<File>
-```

package/docs/functions/isDirectoryHandle.md DELETED Viewed

@@ -1,11 +0,0 @@
-[Home](../README.md) > isDirectoryHandle
-# Function: isDirectoryHandle
-Type guard to check if a FileSystemHandle is a directory handle
-## Signature
-```typescript
-function isDirectoryHandle(handle: FileSystemHandle): handle is FileSystemDirectoryHandle
-```

package/docs/functions/isFileHandle.md DELETED Viewed

@@ -1,11 +0,0 @@
-[Home](../README.md) > isFileHandle
-# Function: isFileHandle
-Type guard to check if a FileSystemHandle is a file handle
-## Signature
-```typescript
-function isFileHandle(handle: FileSystemHandle): handle is FileSystemFileHandle
-```

package/docs/functions/isFilePath.md DELETED Viewed

@@ -1,11 +0,0 @@
-[Home](../README.md) > isFilePath
-# Function: isFilePath
-Determines if a path appears to be a file (has extension) or directory
-## Signature
-```typescript
-function isFilePath(path: string): boolean
-```

package/docs/functions/parseContextFilter.md DELETED Viewed

@@ -1,12 +0,0 @@
-[Home](../README.md) > parseContextFilter
-# Function: parseContextFilter
-Converts context filter token to context object
-Example: "language=en-US|territory=US" -\> { language: "en-US", territory: "US" }
-## Signature
-```typescript
-function parseContextFilter(contextFilter: string): Record<string, string>
-```

package/docs/functions/parseQualifierDefaults.md DELETED Viewed

@@ -1,12 +0,0 @@
-[Home](../README.md) > parseQualifierDefaults
-# Function: parseQualifierDefaults
-Converts qualifier defaults token to structured format
-Example: "language=en-US,en-CA|territory=US" -\> { language: ["en-US", "en-CA"], territory: ["US"] }
-## Signature
-```typescript
-function parseQualifierDefaults(qualifierDefaults: string): Record<string, string[]>
-```

package/docs/functions/parseResourceTypes.md DELETED Viewed

@@ -1,12 +0,0 @@
-[Home](../README.md) > parseResourceTypes
-# Function: parseResourceTypes
-Converts resource types string to array
-Example: "json,string" -\> ["json", "string"]
-## Signature
-```typescript
-function parseResourceTypes(resourceTypes: string): string[]
-```

package/docs/functions/parseUrlParameters.md DELETED Viewed

@@ -1,11 +0,0 @@
-[Home](../README.md) > parseUrlParameters
-# Function: parseUrlParameters
-Parses URL parameters and extracts configuration options
-## Signature
-```typescript
-function parseUrlParameters(): IUrlConfigOptions
-```