npm - @fgv/ts-web-extras - Versions diffs - 5.1.0-2 → 5.1.0-4 - Mend

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

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 (272) hide show

package/docs/classes/LocalStorageTreeAccessors.md CHANGED Viewed

@@ -1,10 +1,6 @@
-[**@fgv/ts-web-extras**](../README.md)
+[Home](../README.md) > LocalStorageTreeAccessors
-***
-[@fgv/ts-web-extras](../README.md) / LocalStorageTreeAccessors
-# Class: LocalStorageTreeAccessors\<TCT\>
+# Class: LocalStorageTreeAccessors
 Browser localStorage-backed file tree accessors with persistence support.
@@ -17,504 +13,258 @@ File paths map as: `/data/ingredients/collection-id.yaml` → stored in key for
 Legacy format (v1): `{ "collection-id": { ...parsedJsonObject } }` is auto-migrated on load.
-## Extends
-- [`InMemoryTreeAccessors`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`TCT`\>
-## Type Parameters
+**Extends:** `InMemoryTreeAccessors<TCT>`
-| Type Parameter | Default type |
-| ------ | ------ |
-| `TCT` *extends* `string` | `string` |
-## Implements
-- [`IPersistentFileTreeAccessors`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`TCT`\>
+**Implements:** `IPersistentFileTreeAccessors<TCT>`
 ## Methods
-### createDirectory()
-> **createDirectory**(`dirPath`): [`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`string`\>
-FileTree.IMutableFileTreeAccessors.createDirectory
-#### Parameters
-| Parameter | Type |
-| ------ | ------ |
-| `dirPath` | `string` |
-#### Returns
-[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`string`\>
-#### Implementation of
-`FileTree.IPersistentFileTreeAccessors.createDirectory`
-#### Inherited from
-`FileTree.InMemoryTreeAccessors.createDirectory`
-***
-### deleteDirectory()
-> **deleteDirectory**(`path`): [`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`boolean`\>
-FileTree.IMutableFileTreeAccessors.deleteDirectory
-#### Parameters
-| Parameter | Type |
-| ------ | ------ |
-| `path` | `string` |
-#### Returns
-[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`boolean`\>
-#### Implementation of
-`FileTree.IPersistentFileTreeAccessors.deleteDirectory`
-#### Inherited from
-`FileTree.InMemoryTreeAccessors.deleteDirectory`
-***
+<table><thead><tr><th>
-### deleteFile()
+Method
-> **deleteFile**(`path`): [`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`boolean`\>
+</th><th>
-Delete a file and remove it from localStorage.
-#### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `path` | `string` | File path to delete |
-#### Returns
-[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`boolean`\>
-Result with true if deleted, or error
-#### Implementation of
-`FileTree.IPersistentFileTreeAccessors.deleteFile`
-#### Overrides
-`FileTree.InMemoryTreeAccessors.deleteFile`
-***
-### fileIsMutable()
-> **fileIsMutable**(`path`): [`DetailedResult`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`boolean`, [`SaveDetail`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\>
-Check if a file is mutable and return persistence detail.
-#### Parameters
+Modifiers
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `path` | `string` | File path to check |
+</th><th>
-#### Returns
+Description
-[`DetailedResult`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`boolean`, [`SaveDetail`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\>
+</th></tr></thead>
+<tbody>
+<tr><td>
-DetailedResult with mutability status and 'persistent' detail if mutable
+[fromStorage(params)](./LocalStorageTreeAccessors.fromStorage.md)
-#### Implementation of
+</td><td>
-`FileTree.IPersistentFileTreeAccessors.fileIsMutable`
+`static`
-#### Overrides
+</td><td>
-`FileTree.InMemoryTreeAccessors.fileIsMutable`
-***
+Create LocalStorageTreeAccessors from browser localStorage.
-### getBaseName()
+</td></tr>
+<tr><td>
-> **getBaseName**(`path`, `suffix?`): `string`
+[create(files, prefix)](./LocalStorageTreeAccessors.create.md)
-FileTree.IFileTreeAccessors.getBaseName
+</td><td>
-#### Parameters
+`static`
-| Parameter | Type |
-| ------ | ------ |
-| `path` | `string` |
-| `suffix?` | `string` |
+</td><td>
-#### Returns
+Creates a new FileTree.InMemoryTreeAccessors | InMemoryTreeAccessors instance with the supplied
-`string`
+</td></tr>
+<tr><td>
-#### Implementation of
+[syncToDisk()](./LocalStorageTreeAccessors.syncToDisk.md)
-`FileTree.IPersistentFileTreeAccessors.getBaseName`
+</td><td>
-#### Inherited from
-`FileTree.InMemoryTreeAccessors.getBaseName`
-***
+</td><td>
-### getChildren()
+Sync all dirty files to localStorage.
-> **getChildren**(`path`): [`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<readonly [`FileTreeItem`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`TCT`\>[]\>
+</td></tr>
+<tr><td>
-FileTree.IFileTreeAccessors.getChildren
+[isDirty()](./LocalStorageTreeAccessors.isDirty.md)
-#### Parameters
+</td><td>
-| Parameter | Type |
-| ------ | ------ |
-| `path` | `string` |
-#### Returns
-[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<readonly [`FileTreeItem`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`TCT`\>[]\>
+</td><td>
-#### Implementation of
+Check if there are unsaved changes.
-`FileTree.IPersistentFileTreeAccessors.getChildren`
+</td></tr>
+<tr><td>
-#### Inherited from
+[getDirtyPaths()](./LocalStorageTreeAccessors.getDirtyPaths.md)
-`FileTree.InMemoryTreeAccessors.getChildren`
+</td><td>
-***
-### getDirtyPaths()
-> **getDirtyPaths**(): `string`[]
+</td><td>
 Get list of file paths with unsaved changes.
-#### Returns
-`string`[]
-Array of dirty file paths
-#### Implementation of
-`FileTree.IPersistentFileTreeAccessors.getDirtyPaths`
-***
-### getExtension()
-> **getExtension**(`path`): `string`
-FileTree.IFileTreeAccessors.getExtension
+</td></tr>
+<tr><td>
-#### Parameters
+[deleteFile(path)](./LocalStorageTreeAccessors.deleteFile.md)
-| Parameter | Type |
-| ------ | ------ |
-| `path` | `string` |
+</td><td>
-#### Returns
-`string`
-#### Implementation of
+</td><td>
-`FileTree.IPersistentFileTreeAccessors.getExtension`
-#### Inherited from
-`FileTree.InMemoryTreeAccessors.getExtension`
-***
-### getFileContents()
-> **getFileContents**(`path`): [`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`string`\>
-FileTree.IFileTreeAccessors.getFileContents
-#### Parameters
-| Parameter | Type |
-| ------ | ------ |
-| `path` | `string` |
-#### Returns
-[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`string`\>
-#### Implementation of
-`FileTree.IPersistentFileTreeAccessors.getFileContents`
-#### Inherited from
-`FileTree.InMemoryTreeAccessors.getFileContents`
-***
-### getFileContentType()
-> **getFileContentType**(`path`, `provided?`): [`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`TCT` \| `undefined`\>
-FileTree.IFileTreeAccessors.getFileContentType
-#### Parameters
-| Parameter | Type |
-| ------ | ------ |
-| `path` | `string` |
-| `provided?` | `string` |
-#### Returns
-[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`TCT` \| `undefined`\>
-#### Implementation of
-`FileTree.IPersistentFileTreeAccessors.getFileContentType`
-#### Inherited from
-`FileTree.InMemoryTreeAccessors.getFileContentType`
-***
-### getItem()
-> **getItem**(`itemPath`): [`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<[`FileTreeItem`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`TCT`\>\>
-FileTree.IFileTreeAccessors.getItem
-#### Parameters
-| Parameter | Type |
-| ------ | ------ |
-| `itemPath` | `string` |
-#### Returns
-[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<[`FileTreeItem`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`TCT`\>\>
-#### Implementation of
-`FileTree.IPersistentFileTreeAccessors.getItem`
-#### Inherited from
-`FileTree.InMemoryTreeAccessors.getItem`
-***
-### isDirty()
-> **isDirty**(): `boolean`
-Check if there are unsaved changes.
+Delete a file and remove it from localStorage.
-#### Returns
+</td></tr>
+<tr><td>
-`boolean`
+[saveFileContents(path, contents)](./LocalStorageTreeAccessors.saveFileContents.md)
-True if there are dirty files
+</td><td>
-#### Implementation of
-`FileTree.IPersistentFileTreeAccessors.isDirty`
-***
+</td><td>
-### joinPaths()
+Save file contents.
-> **joinPaths**(...`paths`): `string`
+</td></tr>
+<tr><td>
-FileTree.IFileTreeAccessors.joinPaths
+[fileIsMutable(path)](./LocalStorageTreeAccessors.fileIsMutable.md)
-#### Parameters
+</td><td>
-| Parameter | Type |
-| ------ | ------ |
-| ...`paths` | `string`[] |
-#### Returns
-`string`
+</td><td>
-#### Implementation of
+Check if a file is mutable and return persistence detail.
-`FileTree.IPersistentFileTreeAccessors.joinPaths`
+</td></tr>
+<tr><td>
-#### Inherited from
+[resolveAbsolutePath(paths)](./LocalStorageTreeAccessors.resolveAbsolutePath.md)
-`FileTree.InMemoryTreeAccessors.joinPaths`
+</td><td>
-***
-### resolveAbsolutePath()
-> **resolveAbsolutePath**(...`paths`): `string`
+</td><td>
 FileTree.IFileTreeAccessors.resolveAbsolutePath
-#### Parameters
-| Parameter | Type |
-| ------ | ------ |
-| ...`paths` | `string`[] |
+</td></tr>
+<tr><td>
-#### Returns
+[getExtension(path)](./LocalStorageTreeAccessors.getExtension.md)
-`string`
+</td><td>
-#### Implementation of
-`FileTree.IPersistentFileTreeAccessors.resolveAbsolutePath`
-#### Inherited from
+</td><td>
-`FileTree.InMemoryTreeAccessors.resolveAbsolutePath`
+FileTree.IFileTreeAccessors.getExtension
-***
+</td></tr>
+<tr><td>
-### saveFileContents()
+[getBaseName(path, suffix)](./LocalStorageTreeAccessors.getBaseName.md)
-> **saveFileContents**(`path`, `contents`): [`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`string`\>
+</td><td>
-Save file contents. Marks file as dirty and optionally auto-syncs.
-#### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `path` | `string` | File path |
-| `contents` | `string` | New file contents |
+</td><td>
-#### Returns
+FileTree.IFileTreeAccessors.getBaseName
-[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`string`\>
+</td></tr>
+<tr><td>
-Result with the saved contents or error
+[joinPaths(paths)](./LocalStorageTreeAccessors.joinPaths.md)
-#### Implementation of
+</td><td>
-`FileTree.IPersistentFileTreeAccessors.saveFileContents`
-#### Overrides
-`FileTree.InMemoryTreeAccessors.saveFileContents`
+</td><td>
-***
+FileTree.IFileTreeAccessors.joinPaths
-### syncToDisk()
+</td></tr>
+<tr><td>
-> **syncToDisk**(): `Promise`\<[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`void`\>\>
+[getItem(itemPath)](./LocalStorageTreeAccessors.getItem.md)
-Sync all dirty files to localStorage.
+</td><td>
-#### Returns
-`Promise`\<[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`void`\>\>
-Result indicating success or failure
+</td><td>
-#### Implementation of
+FileTree.IFileTreeAccessors.getItem
-`FileTree.IPersistentFileTreeAccessors.syncToDisk`
+</td></tr>
+<tr><td>
-***
+[getFileContents(path)](./LocalStorageTreeAccessors.getFileContents.md)
-### create()
+</td><td>
-#### Call Signature
-> `static` **create**\<`TCT`\>(`files`, `prefix?`): [`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<[`InMemoryTreeAccessors`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`TCT`\>\>
-Creates a new [InMemoryTreeAccessors](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs) instance with the supplied
-in-memory files.
+</td><td>
-##### Type Parameters
+FileTree.IFileTreeAccessors.getFileContents
-| Type Parameter | Default type |
-| ------ | ------ |
-| `TCT` *extends* `string` | `string` |
+</td></tr>
+<tr><td>
-##### Parameters
+[getFileContentType(path, provided)](./LocalStorageTreeAccessors.getFileContentType.md)
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `files` | [`IInMemoryFile`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`TCT`\>[] | An array of [in-memory files](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs) to include in the tree. |
-| `prefix?` | `string` | Optional prefix for the tree. |
+</td><td>
-##### Returns
-[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<[`InMemoryTreeAccessors`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`TCT`\>\>
-##### Inherited from
+</td><td>
-`FileTree.InMemoryTreeAccessors.create`
+FileTree.IFileTreeAccessors.getFileContentType
-#### Call Signature
+</td></tr>
+<tr><td>
-> `static` **create**\<`TCT`\>(`files`, `params?`): [`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<[`InMemoryTreeAccessors`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`TCT`\>\>
+[getChildren(path)](./LocalStorageTreeAccessors.getChildren.md)
-Creates a new [InMemoryTreeAccessors](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs) instance with the supplied
-in-memory files.
+</td><td>
-##### Type Parameters
-| Type Parameter | Default type |
-| ------ | ------ |
-| `TCT` *extends* `string` | `string` |
-##### Parameters
+</td><td>
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `files` | [`IInMemoryFile`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`TCT`\>[] | An array of [in-memory files](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs) to include in the tree. |
-| `params?` | [`IFileTreeInitParams`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`TCT`\> | Optional params for the tree. |
+FileTree.IFileTreeAccessors.getChildren
-##### Returns
+</td></tr>
+<tr><td>
-[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<[`InMemoryTreeAccessors`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`TCT`\>\>
+[createDirectory(dirPath)](./LocalStorageTreeAccessors.createDirectory.md)
-##### Inherited from
+</td><td>
-`FileTree.InMemoryTreeAccessors.create`
-***
-### fromStorage()
+</td><td>
-> `static` **fromStorage**\<`TCT`\>(`params`): [`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`LocalStorageTreeAccessors`\<`TCT`\>\>
+FileTree.IMutableFileTreeAccessors.createDirectory
-Create LocalStorageTreeAccessors from browser localStorage.
-Loads all collections from the configured storage keys.
+</td></tr>
+<tr><td>
-#### Type Parameters
+[deleteDirectory(path)](./LocalStorageTreeAccessors.deleteDirectory.md)
-| Type Parameter | Default type |
-| ------ | ------ |
-| `TCT` *extends* `string` | `string` |
+</td><td>
-#### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `params` | [`ILocalStorageTreeParams`](../interfaces/ILocalStorageTreeParams.md)\<`TCT`\> | Configuration including path-to-key mappings |
-#### Returns
+</td><td>
-[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`LocalStorageTreeAccessors`\<`TCT`\>\>
+FileTree.IMutableFileTreeAccessors.deleteDirectory
-Result containing the accessors or an error
+</td></tr>
+</tbody></table>

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

@@ -0,0 +1,25 @@
+[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 ADDED Viewed

@@ -0,0 +1,17 @@
+[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 ADDED Viewed

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