@fgv/ts-extras 5.0.2 → 5.1.0-0

package/dist/packlets/zip-file-tree/zipFileTreeAccessors.js

@@ -20,7 +20,7 @@
  * SOFTWARE.
  */
 import { unzipSync, unzip } from 'fflate';
-import { succeed, fail, captureResult } from '@fgv/ts-utils';
+import { succeed, fail, captureResult, failWithDetail, Success } from '@fgv/ts-utils';
 /**
  * Implementation of `FileTree.IFileTreeFileItem` for files in a ZIP archive.
  * @public
@@ -58,6 +58,30 @@ export class ZipFileItem {
         this.extension = accessors.getExtension(zipFilePath);
         this.baseName = accessors.getBaseName(zipFilePath, this.extension);
     }
+    /**
+     * Returns a boolean indicating whether this file can be saved.
+     */
+    getIsMutable() {
+        return this._accessors.fileIsMutable(this.absolutePath);
+    }
+    /**
+     * Sets the contents of the file as parsed JSON.
+     * @param json - The JSON to set as the contents of the file.
+     * @returns A Result indicating success or failure.
+     */
+    setContents(json) {
+        return captureResult(() => JSON.stringify(json, null, 2)).onSuccess((contents) => this.setRawContents(contents).onSuccess(() => Success.with(json)));
+    }
+    /**
+     * Sets the contents of the file as a string.
+     * @param contents - The string to set as the contents of the file.
+     * @returns A Result indicating success or failure.
+     */
+    setRawContents(contents) {
+        return this.getIsMutable().asResult.onSuccess(() => 
+        /* c8 ignore next - unreachable: ZIP files are always read-only */
+        this._accessors.saveFileContents(this.absolutePath, contents));
+    }
     /**
      * Sets the content type of the file.
      * @param contentType - The content type of the file.
@@ -177,7 +201,7 @@ export class ZipFileTreeAccessors {
                         resolve(succeed(new ZipFileTreeAccessors(files, normalizedParams)));
                     }
                 });
-                /* c8 ignore next 6 - defensive coding: fflate reports errors via callback, not exceptions */
+                /* c8 ignore next 5 - defensive coding: fflate reports errors via callback, not exceptions */
             }
             catch (error) {
                 resolve(fail(`Failed to load ZIP archive: ${error instanceof Error ? error.message : String(error)}`));
@@ -238,6 +262,23 @@ export class ZipFileTreeAccessors {
             this._itemCache.set(absolutePath, item);
         });
     }
+    /**
+     * Returns a boolean indicating whether this file can be saved.
+     * @param path - The path of the file.
+     * @returns A `DetailedResult` indicating success or failure.
+     */
+    fileIsMutable(__path) {
+        return failWithDetail('ZIP files are read-only', 'not-supported');
+    }
+    /**
+     * Saves the contents of a file.
+     * @param path - The path of the file.
+     * @param contents - The contents of the file.
+     * @returns A `Result` indicating success or failure.
+     */
+    saveFileContents(__path, __contents) {
+        return failWithDetail('ZIP files are read-only', 'not-supported');
+    }
     /**
      * Resolves paths to an absolute path.
      */

package/dist/packlets/zip-file-tree/zipFileTreeWriter.js

@@ -0,0 +1,40 @@
+/*
+ * Copyright (c) 2026 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.
+ */
+import { zipSync, strToU8 } from 'fflate';
+import { captureResult } from '@fgv/ts-utils';
+/**
+ * Creates a zip file from an array of text files.
+ * @public
+ */
+export function createZipFromTextFiles(files, options) {
+    return captureResult(() => {
+        var _a;
+        const out = {};
+        for (const f of files) {
+            const normalizedPath = f.path.replace(/^\/+/, '');
+            out[normalizedPath] = strToU8(f.contents);
+        }
+        return zipSync(out, { level: (_a = options === null || options === void 0 ? void 0 : options.level) !== null && _a !== void 0 ? _a : 6 });
+        /* c8 ignore next - defensive: zipSync only throws on internal library errors */
+    }).withErrorFormat((e) => `Failed to create zip: ${e}`);
+}
+//# sourceMappingURL=zipFileTreeWriter.js.map