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

package/temp/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/docs/index.md

@@ -1,34 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md)
-
-## API Reference
-
-## Packages
-
-<table><thead><tr><th>
-
-Package
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[@fgv/ts-web-extras](./ts-web-extras.md)
-
-
-</td><td>
-
-Browser-compatible utilities and FileTree implementations.
-
-This library provides browser-compatible alternatives to Node.js-specific functionality, including Web Crypto API-based hashing, File API-based file tree implementations, and URL parameter parsing utilities. All exports are designed to be tree-shakeable for optimal bundle size.
-
-
-</td></tr>
-</tbody></table>
-

package/docs/ts-web-extras.cryptoutils.browsercryptoprovider._constructor_.md

@@ -1,50 +0,0 @@
-<!-- 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; [CryptoUtils](./ts-web-extras.cryptoutils.md) &gt; [BrowserCryptoProvider](./ts-web-extras.cryptoutils.browsercryptoprovider.md) &gt; [(constructor)](./ts-web-extras.cryptoutils.browsercryptoprovider._constructor_.md)
-
-## CryptoUtils.BrowserCryptoProvider.(constructor)
-
-Creates a new [BrowserCryptoProvider](./ts-web-extras.cryptoutils.browsercryptoprovider.md)<!-- -->.
-
-**Signature:**
-
-```typescript
-constructor(cryptoApi?: Crypto);
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-cryptoApi
-
-
-</td><td>
-
-Crypto
-
-
-</td><td>
-
-_(Optional)_ Optional Crypto instance (defaults to globalThis.crypto)
-
-
-</td></tr>
-</tbody></table>
-

package/docs/ts-web-extras.cryptoutils.browsercryptoprovider.decrypt.md

@@ -1,104 +0,0 @@
-<!-- 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; [CryptoUtils](./ts-web-extras.cryptoutils.md) &gt; [BrowserCryptoProvider](./ts-web-extras.cryptoutils.browsercryptoprovider.md) &gt; [decrypt](./ts-web-extras.cryptoutils.browsercryptoprovider.decrypt.md)
-
-## CryptoUtils.BrowserCryptoProvider.decrypt() method
-
-Decrypts ciphertext using AES-256-GCM.
-
-**Signature:**
-
-```typescript
-decrypt(encryptedData: Uint8Array, key: Uint8Array, iv: Uint8Array, authTag: Uint8Array): Promise<Result<string>>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-encryptedData
-
-
-</td><td>
-
-Uint8Array
-
-
-</td><td>
-
-Encrypted bytes
-
-
-</td></tr>
-<tr><td>
-
-key
-
-
-</td><td>
-
-Uint8Array
-
-
-</td><td>
-
-32-byte decryption key
-
-
-</td></tr>
-<tr><td>
-
-iv
-
-
-</td><td>
-
-Uint8Array
-
-
-</td><td>
-
-Initialization vector (12 bytes)
-
-
-</td></tr>
-<tr><td>
-
-authTag
-
-
-</td><td>
-
-Uint8Array
-
-
-</td><td>
-
-GCM authentication tag (16 bytes)
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;Result&lt;string&gt;&gt;
-
-`Success` with decrypted UTF-8 string, or `Failure` with an error.
-

package/docs/ts-web-extras.cryptoutils.browsercryptoprovider.derivekey.md

@@ -1,88 +0,0 @@
-<!-- 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; [CryptoUtils](./ts-web-extras.cryptoutils.md) &gt; [BrowserCryptoProvider](./ts-web-extras.cryptoutils.browsercryptoprovider.md) &gt; [deriveKey](./ts-web-extras.cryptoutils.browsercryptoprovider.derivekey.md)
-
-## CryptoUtils.BrowserCryptoProvider.deriveKey() method
-
-Derives a key from a password using PBKDF2.
-
-**Signature:**
-
-```typescript
-deriveKey(password: string, salt: Uint8Array, iterations: number): Promise<Result<Uint8Array>>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-password
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-Password string
-
-
-</td></tr>
-<tr><td>
-
-salt
-
-
-</td><td>
-
-Uint8Array
-
-
-</td><td>
-
-Salt bytes (should be at least 16 bytes)
-
-
-</td></tr>
-<tr><td>
-
-iterations
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-Number of iterations (recommend 100000+)
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;Result&lt;Uint8Array&gt;&gt;
-
-Success with derived 32-byte key, or Failure with error
-

package/docs/ts-web-extras.cryptoutils.browsercryptoprovider.encrypt.md

@@ -1,72 +0,0 @@
-<!-- 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; [CryptoUtils](./ts-web-extras.cryptoutils.md) &gt; [BrowserCryptoProvider](./ts-web-extras.cryptoutils.browsercryptoprovider.md) &gt; [encrypt](./ts-web-extras.cryptoutils.browsercryptoprovider.encrypt.md)
-
-## CryptoUtils.BrowserCryptoProvider.encrypt() method
-
-Encrypts plaintext using AES-256-GCM.
-
-**Signature:**
-
-```typescript
-encrypt(plaintext: string, key: Uint8Array): Promise<Result<IEncryptionResult>>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-plaintext
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-UTF-8 string to encrypt
-
-
-</td></tr>
-<tr><td>
-
-key
-
-
-</td><td>
-
-Uint8Array
-
-
-</td><td>
-
-32-byte encryption key
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;Result&lt;IEncryptionResult&gt;&gt;
-
-`Success` with encryption result, or `Failure` with an error.
-

package/docs/ts-web-extras.cryptoutils.browsercryptoprovider.frombase64.md

@@ -1,56 +0,0 @@
-<!-- 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; [CryptoUtils](./ts-web-extras.cryptoutils.md) &gt; [BrowserCryptoProvider](./ts-web-extras.cryptoutils.browsercryptoprovider.md) &gt; [fromBase64](./ts-web-extras.cryptoutils.browsercryptoprovider.frombase64.md)
-
-## CryptoUtils.BrowserCryptoProvider.fromBase64() method
-
-Decodes base64 string to binary data.
-
-**Signature:**
-
-```typescript
-fromBase64(base64: string): Result<Uint8Array>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-base64
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-Base64-encoded string
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Result&lt;Uint8Array&gt;
-
-Success with decoded bytes, or Failure if invalid base64
-

package/docs/ts-web-extras.cryptoutils.browsercryptoprovider.generatekey.md

@@ -1,19 +0,0 @@
-<!-- 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; [CryptoUtils](./ts-web-extras.cryptoutils.md) &gt; [BrowserCryptoProvider](./ts-web-extras.cryptoutils.browsercryptoprovider.md) &gt; [generateKey](./ts-web-extras.cryptoutils.browsercryptoprovider.generatekey.md)
-
-## CryptoUtils.BrowserCryptoProvider.generateKey() method
-
-Generates a random 32-byte key suitable for AES-256.
-
-**Signature:**
-
-```typescript
-generateKey(): Promise<Result<Uint8Array>>;
-```
-**Returns:**
-
-Promise&lt;Result&lt;Uint8Array&gt;&gt;
-
-Success with generated key, or Failure with error
-

package/docs/ts-web-extras.cryptoutils.browsercryptoprovider.generaterandombytes.md

@@ -1,56 +0,0 @@
-<!-- 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; [CryptoUtils](./ts-web-extras.cryptoutils.md) &gt; [BrowserCryptoProvider](./ts-web-extras.cryptoutils.browsercryptoprovider.md) &gt; [generateRandomBytes](./ts-web-extras.cryptoutils.browsercryptoprovider.generaterandombytes.md)
-
-## CryptoUtils.BrowserCryptoProvider.generateRandomBytes() method
-
-Generates cryptographically secure random bytes.
-
-**Signature:**
-
-```typescript
-generateRandomBytes(length: number): Result<Uint8Array>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-length
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-Number of bytes to generate
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Result&lt;Uint8Array&gt;
-
-Success with random bytes, or Failure with error
-