@fgv/ts-res 5.0.0-16 → 5.0.0-17

package/lib/packlets/zip-archive/zipArchiveCreator.js

@@ -0,0 +1,194 @@
+"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.ZipArchiveCreator = void 0;
+const fflate_1 = require("fflate");
+const ts_utils_1 = require("@fgv/ts-utils");
+const zipArchiveFormat_1 = require("./zipArchiveFormat");
+/**
+ * ZIP archive creator using fflate for universal compatibility
+ * @public
+ */
+class ZipArchiveCreator {
+    /**
+     * Create a ZIP archive buffer from a supplied buffer
+     * @param options - Input paths and configuration
+     * @param onProgress - Optional progress callback
+     * @returns Result containing ZIP buffer and manifest
+     */
+    async createFromBuffer(options, onProgress) {
+        try {
+            onProgress === null || onProgress === void 0 ? void 0 : onProgress('creating-zip', 0, 'Starting ZIP archive creation');
+            const files = {};
+            const manifest = {
+                timestamp: new Date().toISOString()
+            };
+            const { value: inputItem, message: inputItemError } = this._getInputFileTreeItem(options);
+            if (inputItemError !== undefined) {
+                return (0, ts_utils_1.fail)(inputItemError);
+            }
+            if (inputItem !== undefined) {
+                onProgress === null || onProgress === void 0 ? void 0 : onProgress('reading-file', 10, `Processing input: ${inputItem.absolutePath}`);
+                if (inputItem.type === 'directory') {
+                    // Add entire directory recursively, preserving structure
+                    const archivePath = `input/${inputItem.name}`;
+                    const addDirResult = await this._addDirectoryTreeToZip(files, inputItem, archivePath, onProgress);
+                    /* c8 ignore next 3 - defense in depth against internal error */
+                    if (addDirResult.isFailure()) {
+                        return (0, ts_utils_1.fail)(addDirResult.message);
+                    }
+                    manifest.input = {
+                        type: 'directory',
+                        originalPath: inputItem.absolutePath,
+                        archivePath
+                    };
+                }
+                else if (inputItem.type === 'file') {
+                    // Add single file
+                    const archivePath = `input/${inputItem.name}`;
+                    const addFileResult = await this._addFileTreeItemToZip(files, inputItem, archivePath);
+                    /* c8 ignore next 3 - defense in depth against internal error */
+                    if (addFileResult.isFailure()) {
+                        return (0, ts_utils_1.fail)(addFileResult.message);
+                    }
+                    manifest.input = {
+                        type: 'file',
+                        originalPath: inputItem.absolutePath,
+                        archivePath
+                    };
+                }
+            }
+            const { value: configItem, message: configItemError } = this._getConfigFileTreeItem(options);
+            if (configItemError !== undefined) {
+                return (0, ts_utils_1.fail)(configItemError);
+            }
+            if (configItem !== undefined) {
+                onProgress === null || onProgress === void 0 ? void 0 : onProgress('reading-file', 40, `Processing config: ${configItem.absolutePath}`);
+                const archivePath = `config/${configItem.name}`;
+                const addConfigResult = await this._addFileTreeItemToZip(files, configItem, archivePath);
+                /* c8 ignore next 3 - defense in depth against internal error */
+                if (addConfigResult.isFailure()) {
+                    return (0, ts_utils_1.fail)(addConfigResult.message);
+                }
+                // Update manifest with config info
+                manifest.config = {
+                    type: 'file',
+                    originalPath: configItem.absolutePath,
+                    archivePath
+                };
+            }
+            // Add manifest to ZIP
+            onProgress === null || onProgress === void 0 ? void 0 : onProgress('creating-zip', 70, 'Adding manifest');
+            const manifestJson = JSON.stringify(manifest, null, 2);
+            files['manifest.json'] = new TextEncoder().encode(manifestJson);
+            // Create ZIP buffer using fflate
+            onProgress === null || onProgress === void 0 ? void 0 : onProgress('creating-zip', 80, 'Compressing files');
+            const zipBuffer = (0, fflate_1.zipSync)(files, { level: 6 });
+            const result = {
+                zipBuffer,
+                manifest,
+                size: zipBuffer.length
+            };
+            onProgress === null || onProgress === void 0 ? void 0 : onProgress('creating-zip', 100, 'ZIP archive buffer created');
+            return (0, ts_utils_1.succeed)(result);
+            /* c8 ignore next 3 - defense in depth against internal error */
+        }
+        catch (error) {
+            return (0, ts_utils_1.fail)(`Failed to create ZIP archive: ${error instanceof Error ? error.message : String(error)}`);
+        }
+    }
+    /**
+     * Add a single FileTree item to the ZIP archive
+     * @param files - ZIP files collection
+     * @param fileItem - FileTree file item to add
+     * @param archivePath - Path within the archive
+     * @returns Result indicating success or failure
+     */
+    async _addFileTreeItemToZip(files, fileItem, archivePath) {
+        return fileItem.getRawContents().onSuccess((content) => {
+            const contentBuffer = new TextEncoder().encode(content);
+            files[(0, zipArchiveFormat_1.normalizePath)(archivePath)] = contentBuffer;
+            return (0, ts_utils_1.succeed)(undefined);
+        });
+    }
+    /**
+     * Add a directory recursively to the ZIP archive using FileTree
+     * @param files - ZIP files collection
+     * @param directoryItem - FileTree directory item to add
+     * @param archivePrefix - Prefix path within the archive
+     * @param onProgress - Optional progress callback
+     * @returns Result indicating success or failure
+     */
+    async _addDirectoryTreeToZip(files, directoryItem, archivePrefix, onProgress) {
+        const childrenResult = directoryItem.getChildren();
+        /* c8 ignore next 3 - defense in depth against internal error */
+        if (childrenResult.isFailure()) {
+            return (0, ts_utils_1.fail)(`Failed to read directory ${directoryItem.absolutePath}: ${childrenResult.message}`);
+        }
+        for (const child of childrenResult.value) {
+            const itemArchivePath = (0, zipArchiveFormat_1.normalizePath)(`${archivePrefix}/${child.name}`);
+            if (child.type === 'directory') {
+                // Recursively add subdirectory
+                const addDirResult = await this._addDirectoryTreeToZip(files, child, itemArchivePath, onProgress);
+                /* c8 ignore next 3 - defense in depth against internal error */
+                if (addDirResult.isFailure()) {
+                    return (0, ts_utils_1.fail)(addDirResult.message);
+                }
+            }
+            else if (child.type === 'file') {
+                // Add file
+                const addFileResult = await this._addFileTreeItemToZip(files, child, itemArchivePath);
+                /* c8 ignore next 3 - defense in depth against internal error */
+                if (addFileResult.isFailure()) {
+                    return (0, ts_utils_1.fail)(addFileResult.message);
+                }
+                onProgress === null || onProgress === void 0 ? void 0 : onProgress('reading-file', 0, `Added file: ${itemArchivePath}`);
+            }
+        }
+        return (0, ts_utils_1.succeed)(undefined);
+    }
+    _getInputFileTreeItem(options) {
+        if ('inputPath' in options && options.inputPath !== undefined) {
+            return ts_utils_1.FileTree.forFilesystem()
+                .withErrorFormat((msg) => `Failed to create file tree: ${msg}`)
+                .onSuccess((fileTree) => fileTree.getItem(options.inputPath).withErrorFormat((msg) => `Failed to get item: ${msg}`));
+        }
+        else if ('inputItem' in options) {
+            return (0, ts_utils_1.succeed)(options.inputItem);
+        }
+        return (0, ts_utils_1.succeed)(undefined);
+    }
+    _getConfigFileTreeItem(options) {
+        if ('configPath' in options && options.configPath !== undefined) {
+            return ts_utils_1.FileTree.forFilesystem()
+                .withErrorFormat((msg) => `Failed to create file tree: ${msg}`)
+                .onSuccess((fileTree) => fileTree.getFile(options.configPath).withErrorFormat((msg) => `Failed to get config file: ${msg}`));
+        }
+        else if ('configItem' in options && options.configItem !== undefined) {
+            return (0, ts_utils_1.succeed)(options.configItem);
+        }
+        return (0, ts_utils_1.succeed)(undefined);
+    }
+}
+exports.ZipArchiveCreator = ZipArchiveCreator;
+//# sourceMappingURL=zipArchiveCreator.js.map

package/lib/packlets/zip-archive/zipArchiveFormat.d.ts

@@ -0,0 +1,70 @@
+import { Result } from '@fgv/ts-utils';
+import { Model as ConfigModel } from '../config';
+import * as Json from './json';
+/**
+ * Create a ZIP archive manifest object
+ * @param inputType - Type of input (file or directory)
+ * @param originalPath - Original file/directory path
+ * @param archivePath - Path within the archive
+ * @param configPath - Optional configuration file path
+ * @returns ZIP archive manifest
+ * @public
+ */
+export declare function createZipArchiveManifest(inputType: 'file' | 'directory', originalPath: string, archivePath: string, configPath?: string): Json.IZipArchiveManifest;
+/**
+ * Parse and validate a ZIP archive manifest
+ * @param manifestData - JSON string containing manifest data
+ * @returns Result containing validated manifest
+ * @public
+ */
+export declare function parseZipArchiveManifest(manifestData: string): Result<Json.IZipArchiveManifest>;
+/**
+ * Validate a ZIP archive manifest object
+ * @param manifest - Object to validate as manifest
+ * @returns Result containing validated manifest
+ * @public
+ */
+export declare function validateZipArchiveManifest(manifest: unknown): Result<Json.IZipArchiveManifest>;
+/**
+ * Parse and validate configuration JSON
+ * @param configData - JSON string containing configuration
+ * @returns Result containing validated configuration
+ * @public
+ */
+export declare function parseZipArchiveConfiguration(configData: string): Result<ConfigModel.ISystemConfiguration>;
+/**
+ * Generate a timestamp-based filename for ZIP archives
+ * @param customName - Optional custom name prefix
+ * @returns Generated filename
+ * @public
+ */
+export declare function generateZipArchiveFilename(customName?: string): string;
+/**
+ * Normalize path separators for cross-platform compatibility
+ * @param path - Path to normalize
+ * @returns Normalized path
+ * @public
+ */
+export declare function normalizePath(path: string): string;
+/**
+ * Extract directory name from a file path
+ * @param path - File path
+ * @returns Directory name
+ * @public
+ */
+export declare function getDirectoryName(path: string): string;
+/**
+ * Create a safe filename by removing invalid characters
+ * @param filename - Original filename
+ * @returns Sanitized filename
+ * @public
+ */
+export declare function sanitizeFilename(filename: string): string;
+/**
+ * Validate ZIP file extension
+ * @param filename - Filename to validate
+ * @returns True if filename has .zip extension
+ * @public
+ */
+export declare function isZipFile(filename: string): boolean;
+//# sourceMappingURL=zipArchiveFormat.d.ts.map

package/lib/packlets/zip-archive/zipArchiveFormat.js

@@ -0,0 +1,184 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createZipArchiveManifest = createZipArchiveManifest;
+exports.parseZipArchiveManifest = parseZipArchiveManifest;
+exports.validateZipArchiveManifest = validateZipArchiveManifest;
+exports.parseZipArchiveConfiguration = parseZipArchiveConfiguration;
+exports.generateZipArchiveFilename = generateZipArchiveFilename;
+exports.normalizePath = normalizePath;
+exports.getDirectoryName = getDirectoryName;
+exports.sanitizeFilename = sanitizeFilename;
+exports.isZipFile = isZipFile;
+const ts_utils_1 = require("@fgv/ts-utils");
+const Convert = __importStar(require("./convert"));
+/**
+ * Create a ZIP archive manifest object
+ * @param inputType - Type of input (file or directory)
+ * @param originalPath - Original file/directory path
+ * @param archivePath - Path within the archive
+ * @param configPath - Optional configuration file path
+ * @returns ZIP archive manifest
+ * @public
+ */
+function createZipArchiveManifest(inputType, originalPath, archivePath, configPath) {
+    const manifest = {
+        timestamp: new Date().toISOString(),
+        input: {
+            type: inputType,
+            originalPath,
+            archivePath
+        }
+    };
+    if (configPath) {
+        manifest.config = {
+            type: 'file',
+            originalPath: configPath,
+            archivePath: 'config.json'
+        };
+    }
+    return manifest;
+}
+/**
+ * Parse and validate a ZIP archive manifest
+ * @param manifestData - JSON string containing manifest data
+ * @returns Result containing validated manifest
+ * @public
+ */
+function parseZipArchiveManifest(manifestData) {
+    return (0, ts_utils_1.captureResult)(() => {
+        const parsed = JSON.parse(manifestData);
+        return parsed;
+    })
+        .onSuccess((parsed) => Convert.zipArchiveManifest.validate(parsed))
+        .withErrorFormat((e) => `Failed to parse ZIP archive manifest: ${e}`);
+}
+/**
+ * Validate a ZIP archive manifest object
+ * @param manifest - Object to validate as manifest
+ * @returns Result containing validated manifest
+ * @public
+ */
+function validateZipArchiveManifest(manifest) {
+    return Convert.zipArchiveManifest.validate(manifest);
+}
+/**
+ * Parse and validate configuration JSON
+ * @param configData - JSON string containing configuration
+ * @returns Result containing validated configuration
+ * @public
+ */
+function parseZipArchiveConfiguration(configData) {
+    return (0, ts_utils_1.captureResult)(() => {
+        const parsed = JSON.parse(configData);
+        return parsed;
+    })
+        .onSuccess((parsed) => Convert.systemConfiguration.validate(parsed))
+        .withErrorFormat((e) => `Failed to parse ZIP archive configuration: ${e}`);
+}
+/**
+ * Generate a timestamp-based filename for ZIP archives
+ * @param customName - Optional custom name prefix
+ * @returns Generated filename
+ * @public
+ */
+function generateZipArchiveFilename(customName) {
+    const timestamp = new Date().toISOString().replace(/[:.]/g, '-').replace('T', '_').slice(0, -5);
+    return customName ? `${customName}-${timestamp}.zip` : `ts-res-archive-${timestamp}.zip`;
+}
+/**
+ * Normalize path separators for cross-platform compatibility
+ * @param path - Path to normalize
+ * @returns Normalized path
+ * @public
+ */
+function normalizePath(path) {
+    return path.replace(/\\/g, '/').replace(/\/+/g, '/');
+}
+/**
+ * Extract directory name from a file path
+ * @param path - File path
+ * @returns Directory name
+ * @public
+ */
+function getDirectoryName(path) {
+    const normalized = normalizePath(path);
+    const parts = normalized.split('/');
+    return parts[parts.length - 1] || 'archive';
+}
+/**
+ * Create a safe filename by removing invalid characters
+ * @param filename - Original filename
+ * @returns Sanitized filename
+ * @public
+ */
+function sanitizeFilename(filename) {
+    return filename
+        .replace(/[<>:"/\\|?*]/g, '_')
+        .replace(/\s+/g, '_')
+        .replace(/_+/g, '_')
+        .trim();
+}
+/**
+ * Validate ZIP file extension
+ * @param filename - Filename to validate
+ * @returns True if filename has .zip extension
+ * @public
+ */
+function isZipFile(filename) {
+    return filename.toLowerCase().endsWith('.zip');
+}
+//# sourceMappingURL=zipArchiveFormat.js.map

package/lib/packlets/zip-archive/zipArchiveLoader.d.ts

@@ -0,0 +1,70 @@
+import { Result } from '@fgv/ts-utils';
+import type { IZipArchiveLoadOptions, IZipArchiveLoadResult, ZipArchiveProgressCallback } from './types';
+/**
+ * ZIP archive loader extending ts-extras foundation
+ * @public
+ */
+export declare class ZipArchiveLoader {
+    /**
+     * Load ZIP archive from File object (Browser)
+     * @param file - File object from file input
+     * @param options - Loading options
+     * @param onProgress - Optional progress callback
+     * @returns Result containing loaded archive data
+     */
+    loadFromFile(file: File, options?: IZipArchiveLoadOptions, onProgress?: ZipArchiveProgressCallback): Promise<Result<IZipArchiveLoadResult>>;
+    /**
+     * Load ZIP archive from ArrayBuffer (Universal)
+     * @param buffer - ZIP data buffer
+     * @param options - Loading options
+     * @param onProgress - Optional progress callback
+     * @returns Result containing loaded archive data
+     */
+    loadFromBuffer(buffer: ArrayBuffer, options?: IZipArchiveLoadOptions, onProgress?: ZipArchiveProgressCallback): Promise<Result<IZipArchiveLoadResult>>;
+    /**
+     * Load manifest from ZIP using ZipFileTreeAccessors
+     * @param zipAccessors - ZIP file tree accessors
+     * @returns Result containing parsed manifest
+     */
+    private _loadManifestFromAccessors;
+    /**
+     * Load configuration from ZIP using ZipFileTreeAccessors
+     * @param zipAccessors - ZIP file tree accessors
+     * @param manifest - Parsed manifest (may be undefined)
+     * @param options - Loading options
+     * @returns Result containing parsed configuration
+     */
+    private _loadConfigurationFromAccessors;
+    /**
+     * Extract files and directory structure from ZIP
+     * @param zipAccessors - ZIP file tree accessors
+     * @param onProgress - Optional progress callback
+     * @returns Result containing files and directory structure
+     */
+    private _extractFilesFromAccessors;
+    /**
+     * Recursively process file tree items
+     * @param zipAccessors - ZIP file tree accessors
+     * @param currentPath - Current directory path
+     * @param items - Items to process
+     * @param files - Files collection
+     * @param directories - Directories collection
+     * @param onProgress - Optional progress callback
+     * @param processed - Processing counter
+     */
+    private _processFileTreeItems;
+    /**
+     * Build directory structure from files
+     * @param files - Extracted files
+     * @param directories - Directories map
+     * @returns Root directory structure or null
+     */
+    private _buildDirectoryStructure;
+    /**
+     * Get file MIME type based on extension
+     * @param filename - Filename
+     * @returns MIME type
+     */
+    private _getFileType;
+}
+//# sourceMappingURL=zipArchiveLoader.d.ts.map