@fgv/ts-web-extras 5.0.0

package/docs/ts-web-extras.showsavefilepickeroptions.startin.md

@@ -0,0 +1,11 @@
+<!-- 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; [ShowSaveFilePickerOptions](./ts-web-extras.showsavefilepickeroptions.md) &gt; [startIn](./ts-web-extras.showsavefilepickeroptions.startin.md)
+
+## ShowSaveFilePickerOptions.startIn property
+
+**Signature:**
+
+```typescript
+startIn?: FileSystemHandle | WellKnownDirectory;
+```

package/docs/ts-web-extras.showsavefilepickeroptions.suggestedname.md

@@ -0,0 +1,11 @@
+<!-- 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; [ShowSaveFilePickerOptions](./ts-web-extras.showsavefilepickeroptions.md) &gt; [suggestedName](./ts-web-extras.showsavefilepickeroptions.suggestedname.md)
+
+## ShowSaveFilePickerOptions.suggestedName property
+
+**Signature:**
+
+```typescript
+suggestedName?: string;
+```

package/docs/ts-web-extras.showsavefilepickeroptions.types.md

@@ -0,0 +1,11 @@
+<!-- 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; [ShowSaveFilePickerOptions](./ts-web-extras.showsavefilepickeroptions.md) &gt; [types](./ts-web-extras.showsavefilepickeroptions.types.md)
+
+## ShowSaveFilePickerOptions.types property
+
+**Signature:**
+
+```typescript
+types?: FilePickerAcceptType[];
+```

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

@@ -0,0 +1,56 @@
+<!-- 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; [supportsFileSystemAccess](./ts-web-extras.supportsfilesystemaccess.md)
+
+## supportsFileSystemAccess() function
+
+Type guard to check if the browser supports the File System Access API
+
+**Signature:**
+
+```typescript
+export declare function supportsFileSystemAccess(window: Window): window is WindowWithFsAccess;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+window
+
+
+</td><td>
+
+Window
+
+
+</td><td>
+
+The window object to check
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+window is [WindowWithFsAccess](./ts-web-extras.windowwithfsaccess.md)
+
+True if the window supports File System Access API
+

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

@@ -0,0 +1,15 @@
+<!-- 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; [TreeInitializer](./ts-web-extras.treeinitializer.md)
+
+## TreeInitializer type
+
+Union type for all supported tree initializers.
+
+**Signature:**
+
+```typescript
+export type TreeInitializer = IFileListTreeInitializer | IFileHandleTreeInitializer | IDirectoryHandleTreeInitializer;
+```
+**References:** [IFileListTreeInitializer](./ts-web-extras.ifilelisttreeinitializer.md)<!-- -->, [IFileHandleTreeInitializer](./ts-web-extras.ifilehandletreeinitializer.md)<!-- -->, [IDirectoryHandleTreeInitializer](./ts-web-extras.idirectoryhandletreeinitializer.md)
+

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

@@ -0,0 +1,13 @@
+<!-- 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; [WellKnownDirectory](./ts-web-extras.wellknowndirectory.md)
+
+## WellKnownDirectory type
+
+Well-known directory type
+
+**Signature:**
+
+```typescript
+export type WellKnownDirectory = 'desktop' | 'documents' | 'downloads' | 'music' | 'pictures' | 'videos';
+```

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

@@ -0,0 +1,15 @@
+<!-- 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; [WindowWithFsAccess](./ts-web-extras.windowwithfsaccess.md)
+
+## WindowWithFsAccess type
+
+Window interface extended with File System Access API
+
+**Signature:**
+
+```typescript
+export type WindowWithFsAccess = Window & IFsAccessApis;
+```
+**References:** [IFsAccessApis](./ts-web-extras.ifsaccessapis.md)
+

package/etc/ts-web-extras.api.md

@@ -0,0 +1,310 @@
+## API Report File for "@fgv/ts-web-extras"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { FileTree } from '@fgv/ts-json-base';
+import { Result } from '@fgv/ts-utils';
+
+// @public
+export class BrowserHashProvider {
+    static hashParts(parts: string[], algorithm?: string, separator?: string): Promise<Result<string>>;
+    static hashString(data: string, algorithm?: string): Promise<Result<string>>;
+}
+
+// @public
+const defaultFileApiTreeInitParams: FileTree.IFileTreeInitParams<string>;
+
+// @public
+export function exportAsJson(data: unknown, filename: string): void;
+
+// @public
+export function exportUsingFileSystemAPI(data: unknown, suggestedName: string, description?: string, window?: Window): Promise<boolean>;
+
+// @public
+export function extractDirectoryPath(path: string): string;
+
+// @public
+function extractFileListMetadata(fileList: FileList): Array<IFileMetadata>;
+
+// @public
+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 extractFileMetadata(file: File): IFileMetadata;
+    static fromDirectoryUpload<TCT extends string = string>(fileList: FileList, params?: FileTree.IFileTreeInitParams<TCT>): Promise<Result<FileTree.FileTree<TCT>>>;
+    static fromFileList<TCT extends string = string>(fileList: FileList, params?: FileTree.IFileTreeInitParams<TCT>): Promise<Result<FileTree.FileTree<TCT>>>;
+    static getOriginalFile(fileList: FileList, targetPath: string): Result<File>;
+}
+
+// @public
+export interface FilePickerAcceptType {
+    // (undocumented)
+    accept: Record<string, string | string[]>;
+    // (undocumented)
+    description?: string;
+}
+
+// @public
+interface FileSystemCreateWritableOptions_2 {
+    // (undocumented)
+    keepExistingData?: boolean;
+}
+export { FileSystemCreateWritableOptions_2 as FileSystemCreateWritableOptions }
+
+// @public
+interface FileSystemDirectoryHandle_2 extends FileSystemHandle_2 {
+    // (undocumented)
+    [Symbol.asyncIterator](): AsyncIterableIterator<[string, FileSystemHandle_2]>;
+    // (undocumented)
+    entries(): AsyncIterableIterator<[string, FileSystemHandle_2]>;
+    // (undocumented)
+    getDirectoryHandle(name: string, options?: FileSystemGetDirectoryOptions_2): Promise<FileSystemDirectoryHandle_2>;
+    // (undocumented)
+    getFileHandle(name: string, options?: FileSystemGetFileOptions_2): Promise<FileSystemFileHandle_2>;
+    // (undocumented)
+    keys(): AsyncIterableIterator<string>;
+    // (undocumented)
+    readonly kind: 'directory';
+    // (undocumented)
+    removeEntry(name: string, options?: FileSystemRemoveOptions_2): Promise<void>;
+    // (undocumented)
+    resolve(possibleDescendant: FileSystemHandle_2): Promise<string[] | null>;
+    // (undocumented)
+    values(): AsyncIterableIterator<FileSystemHandle_2>;
+}
+export { FileSystemDirectoryHandle_2 as FileSystemDirectoryHandle }
+
+// @public
+interface FileSystemFileHandle_2 extends FileSystemHandle_2 {
+    // (undocumented)
+    createWritable(options?: FileSystemCreateWritableOptions_2): Promise<FileSystemWritableFileStream_2>;
+    // (undocumented)
+    getFile(): Promise<File>;
+    // (undocumented)
+    readonly kind: 'file';
+}
+export { FileSystemFileHandle_2 as FileSystemFileHandle }
+
+// @public
+interface FileSystemGetDirectoryOptions_2 {
+    // (undocumented)
+    create?: boolean;
+}
+export { FileSystemGetDirectoryOptions_2 as FileSystemGetDirectoryOptions }
+
+// @public
+interface FileSystemGetFileOptions_2 {
+    // (undocumented)
+    create?: boolean;
+}
+export { FileSystemGetFileOptions_2 as FileSystemGetFileOptions }
+
+// @public
+interface FileSystemHandle_2 {
+    // (undocumented)
+    isSameEntry(other: FileSystemHandle_2): Promise<boolean>;
+    // (undocumented)
+    readonly kind: 'file' | 'directory';
+    // (undocumented)
+    readonly name: string;
+    // (undocumented)
+    queryPermission(descriptor?: FileSystemHandlePermissionDescriptor): Promise<PermissionState>;
+    // (undocumented)
+    requestPermission(descriptor?: FileSystemHandlePermissionDescriptor): Promise<PermissionState>;
+}
+export { FileSystemHandle_2 as FileSystemHandle }
+
+// @public
+export interface FileSystemHandlePermissionDescriptor {
+    // (undocumented)
+    mode?: 'read' | 'readwrite';
+}
+
+// @public
+interface FileSystemRemoveOptions_2 {
+    // (undocumented)
+    recursive?: boolean;
+}
+export { FileSystemRemoveOptions_2 as FileSystemRemoveOptions }
+
+// @public
+interface FileSystemWritableFileStream_2 extends WritableStream {
+    // (undocumented)
+    seek(position: number): Promise<void>;
+    // (undocumented)
+    truncate(size: number): Promise<void>;
+    // (undocumented)
+    write(data: BufferSource | Blob | string): Promise<void>;
+}
+export { FileSystemWritableFileStream_2 as FileSystemWritableFileStream }
+
+declare namespace FileTreeHelpers {
+    export {
+        fromFileList,
+        fromDirectoryUpload,
+        getOriginalFile,
+        extractFileListMetadata,
+        extractFileMetadata,
+        defaultFileApiTreeInitParams
+    }
+}
+
+// @public
+function fromDirectoryUpload(fileList: FileList, params?: FileTree.IFileTreeInitParams<string>): Promise<Result<FileTree.FileTree<string>>>;
+
+// @public
+function fromFileList(fileList: FileList, params?: FileTree.IFileTreeInitParams<string>): Promise<Result<FileTree.FileTree<string>>>;
+
+// @public
+function getOriginalFile(fileList: FileList, path: string): Result<File>;
+
+// @public
+export interface IDirectoryHandleTreeInitializer {
+    // (undocumented)
+    readonly dirHandles: FileSystemDirectoryHandle_2[];
+    // (undocumented)
+    readonly nonRecursive?: boolean;
+    // (undocumented)
+    readonly prefix?: string;
+}
+
+// @public
+export interface IFileHandleTreeInitializer {
+    // (undocumented)
+    readonly fileHandles: FileSystemFileHandle_2[];
+    // (undocumented)
+    readonly prefix?: string;
+}
+
+// @public
+export interface IFileListTreeInitializer {
+    // (undocumented)
+    readonly fileList: FileList;
+}
+
+// @public
+export interface IFileMetadata {
+    // (undocumented)
+    lastModified: number;
+    // (undocumented)
+    name: string;
+    // (undocumented)
+    path: string;
+    // (undocumented)
+    size: number;
+    // (undocumented)
+    type: string;
+}
+
+// @public
+export interface IFsAccessApis {
+    // (undocumented)
+    showDirectoryPicker(options?: ShowDirectoryPickerOptions): Promise<FileSystemDirectoryHandle_2>;
+    // (undocumented)
+    showOpenFilePicker(options?: ShowOpenFilePickerOptions): Promise<FileSystemFileHandle_2[]>;
+    // (undocumented)
+    showSaveFilePicker(options?: ShowSaveFilePickerOptions): Promise<FileSystemFileHandle_2>;
+}
+
+// @public
+export function isDirectoryHandle(handle: FileSystemHandle_2): handle is FileSystemDirectoryHandle_2;
+
+// @public
+export function isFileHandle(handle: FileSystemHandle_2): handle is FileSystemFileHandle_2;
+
+// @public
+export function isFilePath(path: string): boolean;
+
+// @public
+export interface IUrlConfigOptions {
+    config?: string;
+    configStartDir?: string;
+    contextFilter?: string;
+    input?: string;
+    inputStartDir?: string;
+    interactive?: boolean;
+    loadZip?: boolean;
+    maxDistance?: number;
+    qualifierDefaults?: string;
+    reduceQualifiers?: boolean;
+    resourceTypes?: string;
+    zipFile?: string;
+    zipPath?: string;
+}
+
+// @public
+export function parseContextFilter(contextFilter: string): Record<string, string>;
+
+// @public
+export function parseQualifierDefaults(qualifierDefaults: string): Record<string, string[]>;
+
+// @public
+export function parseResourceTypes(resourceTypes: string): string[];
+
+// @public
+export function parseUrlParameters(): IUrlConfigOptions;
+
+// @public
+export function safeShowDirectoryPicker(window: Window, options?: ShowDirectoryPickerOptions): Promise<FileSystemDirectoryHandle_2 | null>;
+
+// @public
+export function safeShowOpenFilePicker(window: Window, options?: ShowOpenFilePickerOptions): Promise<FileSystemFileHandle_2[] | null>;
+
+// @public
+export function safeShowSaveFilePicker(window: Window, options?: ShowSaveFilePickerOptions): Promise<FileSystemFileHandle_2 | null>;
+
+// @public
+export interface ShowDirectoryPickerOptions {
+    // (undocumented)
+    id?: string;
+    // (undocumented)
+    mode?: 'read' | 'readwrite';
+    // (undocumented)
+    startIn?: FileSystemHandle_2 | WellKnownDirectory;
+}
+
+// @public
+export interface ShowOpenFilePickerOptions {
+    // (undocumented)
+    excludeAcceptAllOption?: boolean;
+    // (undocumented)
+    id?: string;
+    // (undocumented)
+    multiple?: boolean;
+    // (undocumented)
+    startIn?: FileSystemHandle_2 | WellKnownDirectory;
+    // (undocumented)
+    types?: FilePickerAcceptType[];
+}
+
+// @public
+export interface ShowSaveFilePickerOptions {
+    // (undocumented)
+    excludeAcceptAllOption?: boolean;
+    // (undocumented)
+    id?: string;
+    // (undocumented)
+    startIn?: FileSystemHandle_2 | WellKnownDirectory;
+    // (undocumented)
+    suggestedName?: string;
+    // (undocumented)
+    types?: FilePickerAcceptType[];
+}
+
+// @public
+export function supportsFileSystemAccess(window: Window): window is WindowWithFsAccess;
+
+// @public
+export type TreeInitializer = IFileListTreeInitializer | IFileHandleTreeInitializer | IDirectoryHandleTreeInitializer;
+
+// @public
+export type WellKnownDirectory = 'desktop' | 'documents' | 'downloads' | 'music' | 'pictures' | 'videos';
+
+// @public
+export type WindowWithFsAccess = Window & IFsAccessApis;
+
+```

package/lib/index.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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.
+ *
+ * @packageDocumentation
+ */
+export * from './packlets/crypto';
+export * from './packlets/file-tree';
+export * from './packlets/helpers';
+export * from './packlets/file-api-types';
+export * from './packlets/url-utils';
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAsBA;;;;;;;;;GASG;AAGH,cAAc,mBAAmB,CAAC;AAGlC,cAAc,sBAAsB,CAAC;AAGrC,cAAc,oBAAoB,CAAC;AAGnC,cAAc,2BAA2B,CAAC;AAG1C,cAAc,sBAAsB,CAAC"}

package/lib/index.js

@@ -0,0 +1,58 @@
+"use strict";
+/*
+ * Copyright (c) 2025 Erik Fortune
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * 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.
+ *
+ * @packageDocumentation
+ */
+// Export crypto functionality
+__exportStar(require("./packlets/crypto"), exports);
+// Export file tree functionality
+__exportStar(require("./packlets/file-tree"), exports);
+// Export helper functions
+__exportStar(require("./packlets/helpers"), exports);
+// Export File System Access API types
+__exportStar(require("./packlets/file-api-types"), exports);
+// Export URL utilities
+__exportStar(require("./packlets/url-utils"), exports);
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;;;;;;;;;;;;;;AAEH;;;;;;;;;GASG;AAEH,8BAA8B;AAC9B,oDAAkC;AAElC,iCAAiC;AACjC,uDAAqC;AAErC,0BAA0B;AAC1B,qDAAmC;AAEnC,sCAAsC;AACtC,4DAA0C;AAE1C,uBAAuB;AACvB,uDAAqC","sourcesContent":["/*\n * Copyright (c) 2025 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\n/**\n * Browser-compatible utilities and FileTree implementations.\n *\n * This library provides browser-compatible alternatives to Node.js-specific functionality,\n * including Web Crypto API-based hashing, File API-based file tree implementations,\n * and URL parameter parsing utilities.\n * All exports are designed to be tree-shakeable for optimal bundle size.\n *\n * @packageDocumentation\n */\n\n// Export crypto functionality\nexport * from './packlets/crypto';\n\n// Export file tree functionality\nexport * from './packlets/file-tree';\n\n// Export helper functions\nexport * from './packlets/helpers';\n\n// Export File System Access API types\nexport * from './packlets/file-api-types';\n\n// Export URL utilities\nexport * from './packlets/url-utils';\n"]}

package/lib/packlets/crypto/browserHashProvider.d.ts

@@ -0,0 +1,24 @@
+import { Result } from '@fgv/ts-utils';
+/**
+ * Browser-compatible hash provider using the Web Crypto API.
+ * Supports common hash algorithms available in browsers.
+ * @public
+ */
+export declare class BrowserHashProvider {
+    /**
+     * Hash a string using the specified algorithm.
+     * @param data - The string to hash
+     * @param algorithm - The hash algorithm to use
+     * @returns Promise resolving to the hex-encoded hash
+     */
+    static hashString(data: string, algorithm?: string): Promise<Result<string>>;
+    /**
+     * Hash multiple strings concatenated with a separator.
+     * @param parts - Array of strings to concatenate and hash
+     * @param algorithm - The hash algorithm to use
+     * @param separator - Separator to use between parts (default: '|')
+     * @returns Promise resolving to the hex-encoded hash
+     */
+    static hashParts(parts: string[], algorithm?: string, separator?: string): Promise<Result<string>>;
+}
+//# sourceMappingURL=browserHashProvider.d.ts.map

package/lib/packlets/crypto/browserHashProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"browserHashProvider.d.ts","sourceRoot":"","sources":["../../../src/packlets/crypto/browserHashProvider.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,MAAM,EAAiB,MAAM,eAAe,CAAC;AAEtD;;;;GAIG;AACH,qBAAa,mBAAmB;IAC9B;;;;;OAKG;WACiB,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,GAAE,MAAkB,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAqBpG;;;;;;OAMG;WACiB,SAAS,CAC3B,KAAK,EAAE,MAAM,EAAE,EACf,SAAS,GAAE,MAAkB,EAC7B,SAAS,GAAE,MAAY,GACtB,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;CAI3B"}

package/lib/packlets/crypto/browserHashProvider.js

@@ -0,0 +1,70 @@
+"use strict";
+/*
+ * Copyright (c) 2025 Erik Fortune
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BrowserHashProvider = void 0;
+const ts_utils_1 = require("@fgv/ts-utils");
+/**
+ * Browser-compatible hash provider using the Web Crypto API.
+ * Supports common hash algorithms available in browsers.
+ * @public
+ */
+class BrowserHashProvider {
+    /**
+     * Hash a string using the specified algorithm.
+     * @param data - The string to hash
+     * @param algorithm - The hash algorithm to use
+     * @returns Promise resolving to the hex-encoded hash
+     */
+    static async hashString(data, algorithm = 'SHA-256') {
+        try {
+            /* c8 ignore next 3 - defense in depth */
+            if (!crypto.subtle) {
+                return (0, ts_utils_1.fail)('Web Crypto API not available in this environment');
+            }
+            const encoder = new TextEncoder();
+            const dataBuffer = encoder.encode(data);
+            const hashBuffer = await crypto.subtle.digest(algorithm, dataBuffer);
+            const hashArray = new Uint8Array(hashBuffer);
+            const hashHex = Array.from(hashArray)
+                .map((b) => b.toString(16).padStart(2, '0'))
+                .join('');
+            return (0, ts_utils_1.succeed)(hashHex);
+        }
+        catch (error) {
+            return (0, ts_utils_1.fail)(`Hash computation failed: ${error instanceof Error ? error.message : String(error)}`);
+        }
+    }
+    /**
+     * Hash multiple strings concatenated with a separator.
+     * @param parts - Array of strings to concatenate and hash
+     * @param algorithm - The hash algorithm to use
+     * @param separator - Separator to use between parts (default: '|')
+     * @returns Promise resolving to the hex-encoded hash
+     */
+    static async hashParts(parts, algorithm = 'SHA-256', separator = '|') {
+        const combined = parts.join(separator);
+        return this.hashString(combined, algorithm);
+    }
+}
+exports.BrowserHashProvider = BrowserHashProvider;
+//# sourceMappingURL=browserHashProvider.js.map

package/lib/packlets/crypto/browserHashProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"browserHashProvider.js","sourceRoot":"","sources":["../../../src/packlets/crypto/browserHashProvider.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,4CAAsD;AAEtD;;;;GAIG;AACH,MAAa,mBAAmB;IAC9B;;;;;OAKG;IACI,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,IAAY,EAAE,YAAoB,SAAS;QACxE,IAAI,CAAC;YACH,yCAAyC;YACzC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;gBACnB,OAAO,IAAA,eAAI,EAAC,kDAAkD,CAAC,CAAC;YAClE,CAAC;YAED,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC;YAClC,MAAM,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YACxC,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;YACrE,MAAM,SAAS,GAAG,IAAI,UAAU,CAAC,UAAU,CAAC,CAAC;YAC7C,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC;iBAClC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;iBAC3C,IAAI,CAAC,EAAE,CAAC,CAAC;YAEZ,OAAO,IAAA,kBAAO,EAAC,OAAO,CAAC,CAAC;QAC1B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,IAAA,eAAI,EAAC,4BAA4B,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACpG,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,SAAS,CAC3B,KAAe,EACf,YAAoB,SAAS,EAC7B,YAAoB,GAAG;QAEvB,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACvC,OAAO,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;IAC9C,CAAC;CACF;AA3CD,kDA2CC","sourcesContent":["/*\n * Copyright (c) 2025 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport { Result, succeed, fail } from '@fgv/ts-utils';\n\n/**\n * Browser-compatible hash provider using the Web Crypto API.\n * Supports common hash algorithms available in browsers.\n * @public\n */\nexport class BrowserHashProvider {\n  /**\n   * Hash a string using the specified algorithm.\n   * @param data - The string to hash\n   * @param algorithm - The hash algorithm to use\n   * @returns Promise resolving to the hex-encoded hash\n   */\n  public static async hashString(data: string, algorithm: string = 'SHA-256'): Promise<Result<string>> {\n    try {\n      /* c8 ignore next 3 - defense in depth */\n      if (!crypto.subtle) {\n        return fail('Web Crypto API not available in this environment');\n      }\n\n      const encoder = new TextEncoder();\n      const dataBuffer = encoder.encode(data);\n      const hashBuffer = await crypto.subtle.digest(algorithm, dataBuffer);\n      const hashArray = new Uint8Array(hashBuffer);\n      const hashHex = Array.from(hashArray)\n        .map((b) => b.toString(16).padStart(2, '0'))\n        .join('');\n\n      return succeed(hashHex);\n    } catch (error) {\n      return fail(`Hash computation failed: ${error instanceof Error ? error.message : String(error)}`);\n    }\n  }\n\n  /**\n   * Hash multiple strings concatenated with a separator.\n   * @param parts - Array of strings to concatenate and hash\n   * @param algorithm - The hash algorithm to use\n   * @param separator - Separator to use between parts (default: '|')\n   * @returns Promise resolving to the hex-encoded hash\n   */\n  public static async hashParts(\n    parts: string[],\n    algorithm: string = 'SHA-256',\n    separator: string = '|'\n  ): Promise<Result<string>> {\n    const combined = parts.join(separator);\n    return this.hashString(combined, algorithm);\n  }\n}\n"]}

package/lib/packlets/crypto/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Browser-compatible cryptographic utilities using the Web Crypto API.
+ * @packageDocumentation
+ */
+export * from './browserHashProvider';
+//# sourceMappingURL=index.d.ts.map

package/lib/packlets/crypto/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/packlets/crypto/index.ts"],"names":[],"mappings":"AAsBA;;;GAGG;AAEH,cAAc,uBAAuB,CAAC"}