@plugjs/zip 0.5.7 → 0.5.9

package/dist/index.cjs

@@ -1,6 +1,21 @@
 "use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // index.ts
+var src_exports = {};
+module.exports = __toCommonJS(src_exports);
 var import_fork = require("@plugjs/plug/fork");
 var import_paths = require("@plugjs/plug/paths");
 (0, import_fork.installForking)("zip", (0, import_paths.requireResolve)(__filename, "./zip"), "Zip");

package/dist/index.cjs.map

@@ -1,6 +1,6 @@
 {
   "version": 3,
   "sources": ["../src/index.ts"],
-  "mappings": ";;;AAAA,kBAA+B;AAC/B,mBAA+B;AAAA,IAa/B,4BAAe,WAAO,6BAAe,YAAW,OAAO,GAAG,KAAK;",
+  "mappings": ";;;;;;;;;;;;;;;;AAAA;AAAA;AAAA,kBAA+B;AAC/B,mBAA+B;AAAA,IAiC/B,4BAAe,WAAO,6BAAe,YAAW,OAAO,GAAG,KAAK;",
   "names": []
 }

package/dist/index.d.ts

@@ -1,11 +1,28 @@
+/** Options for zipping files */
+export interface ZipOptions {
+    /** Force the modified timestamp for all files in the _ZIP archive_ */
+    mtime?: Date;
+    /** Force the mode for all files in the _ZIP archive_ */
+    mode?: number;
+    /** Compress all files in the _ZIP archive_ (default: `true`) */
+    compress?: boolean;
+    /** Force the `ZIP-64` format for all files in the _ZIP archive_ (default: `false`) */
+    forceZip64Format?: boolean;
+}
 declare module '@plugjs/plug' {
     interface Pipe {
         /**
-         * Archive all input {@link Files} into a _Zip_.
+         * Archive all input {@link Files} into a _ZIP archive_.
          *
-         * @param filename The output zip file name.
+         * @param filename - The output _ZIP archive_ file name.
          */
         zip(filename: string): Pipe;
+        /**
+         * Archive all input {@link Files} into a _ZIP archive_.
+         *
+         * @param filename - The output _ZIP archive_ file name.
+         * @param options - Options for zipping the archive.
+         */
+        zip(filename: string, options: ZipOptions): Pipe;
     }
 }
-export {};

package/dist/index.mjs.map

@@ -1,6 +1,6 @@
 {
   "version": 3,
   "sources": ["../src/index.ts"],
-  "mappings": ";AAAA,SAAS,sBAAsB;AAC/B,SAAS,sBAAsB;AAa/B,eAAe,OAAO,eAAe,iBAAW,OAAO,GAAG,KAAK;",
+  "mappings": ";AAAA,SAAS,sBAAsB;AAC/B,SAAS,sBAAsB;AAiC/B,eAAe,OAAO,eAAe,iBAAW,OAAO,GAAG,KAAK;",
   "names": []
 }

package/dist/zip.cjs

@@ -28,8 +28,9 @@ var import_plug = require("@plugjs/plug");
 var import_paths = require("@plugjs/plug/paths");
 var import_yazl = require("yazl");
 var Zip = class {
-  constructor(_filename) {
+  constructor(_filename, _options = {}) {
     this._filename = _filename;
+    this._options = _options;
     (0, import_plug.assert)(_filename, "No filename specified for ZIP file");
   }
   pipe(files, context) {
@@ -40,7 +41,7 @@ var Zip = class {
     context.log.info(`Packaging ${(0, import_plug.$ylw)(files.length)} files`);
     for (const [relative, absolute] of files.pathMappings()) {
       context.log.debug(`Adding file ${(0, import_plug.$p)(absolute)}`);
-      zipfile.addFile(absolute, relative);
+      zipfile.addFile(absolute, relative, this._options);
     }
     const directory = (0, import_paths.getAbsoluteParent)(filename);
     const output = import_plug.Files.builder(directory).add(filename).build();

package/dist/zip.cjs.map

@@ -1,6 +1,6 @@
 {
   "version": 3,
   "sources": ["../src/zip.ts"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAGA,qBAAkC;AAElC,kBAAwC;AACxC,mBAAkC;AAClC,kBAAwB;AAcjB,IAAM,MAAN,MAAiC;AAAA,EAEtC,YAA6B,WAAmB;AAAnB;AAC3B,4BAAO,WAAW,oCAAoC;AAAA,EACxD;AAAA,EAEA,KAAK,OAAc,SAAkC;AACnD,UAAM,WAAW,QAAQ,QAAQ,KAAK,SAAS;AAG/C,UAAM,UAAU,IAAI,oBAAQ;AAC5B,UAAM,gBAAY,kCAAkB,QAAQ;AAC5C,YAAQ,aAAa,KAAK,SAAS;AAGnC,YAAQ,IAAI,KAAK,iBAAa,kBAAK,MAAM,MAAM,CAAC,QAAQ;AACxD,eAAW,CAAE,UAAU,QAAS,KAAK,MAAM,aAAa,GAAG;AACzD,cAAQ,IAAI,MAAM,mBAAe,gBAAG,QAAQ,CAAC,EAAE;AAC/C,cAAQ,QAAQ,UAAU,QAAQ;AAAA,IACpC;AAGA,UAAM,gBAAY,gCAAkB,QAAQ;AAC5C,UAAM,SAAS,kBAAM,QAAQ,SAAS,EAAE,IAAI,QAAQ,EAAE,MAAM;AAC5D,YAAQ,IAAI;AAGZ,WAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,gBAAU,GAAG,SAAS,MAAM,QAAQ,MAAM,CAAC;AAE3C,cAAQ,GAAG,SAAS,CAAC,UAAU,OAAO,KAAK,CAAC;AAE5C,gBAAU,GAAG,SAAS,CAAC,UAAU,OAAO,KAAK,CAAC;AAAA,IAChD,CAAC;AAAA,EACH;AACF;",
+  "mappings": ";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAGA,qBAAkC;AAElC,kBAAwC;AACxC,mBAAkC;AAClC,kBAAwB;AAejB,IAAM,MAAN,MAAiC;AAAA,EAEtC,YACqB,WACA,WAAuB,CAAC,GAC3C;AAFmB;AACA;AAEnB,4BAAO,WAAW,oCAAoC;AAAA,EACxD;AAAA,EAEA,KAAK,OAAc,SAAkC;AACnD,UAAM,WAAW,QAAQ,QAAQ,KAAK,SAAS;AAG/C,UAAM,UAAU,IAAI,oBAAQ;AAC5B,UAAM,gBAAY,kCAAkB,QAAQ;AAC5C,YAAQ,aAAa,KAAK,SAAS;AAGnC,YAAQ,IAAI,KAAK,iBAAa,kBAAK,MAAM,MAAM,CAAC,QAAQ;AACxD,eAAW,CAAE,UAAU,QAAS,KAAK,MAAM,aAAa,GAAG;AACzD,cAAQ,IAAI,MAAM,mBAAe,gBAAG,QAAQ,CAAC,EAAE;AAC/C,cAAQ,QAAQ,UAAU,UAAU,KAAK,QAAQ;AAAA,IACnD;AAGA,UAAM,gBAAY,gCAAkB,QAAQ;AAC5C,UAAM,SAAS,kBAAM,QAAQ,SAAS,EAAE,IAAI,QAAQ,EAAE,MAAM;AAC5D,YAAQ,IAAI;AAGZ,WAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,gBAAU,GAAG,SAAS,MAAM,QAAQ,MAAM,CAAC;AAE3C,cAAQ,GAAG,SAAS,CAAC,UAAU,OAAO,KAAK,CAAC;AAE5C,gBAAU,GAAG,SAAS,CAAC,UAAU,OAAO,KAAK,CAAC;AAAA,IAChD,CAAC;AAAA,EACH;AACF;",
   "names": []
 }

package/dist/zip.d.ts

@@ -11,6 +11,7 @@ declare module 'yazl' {
 /** Writes some info about the current {@link Files} being passed around. */
 export declare class Zip implements Plug<Files> {
     private readonly _filename;
+    private readonly _options;
     constructor(...args: PipeParameters<'zip'>);
     pipe(files: Files, context: Context): Promise<Files>;
 }

package/dist/zip.mjs

@@ -4,8 +4,9 @@ import { $p, $ylw, assert, Files } from "@plugjs/plug";
 import { getAbsoluteParent } from "@plugjs/plug/paths";
 import { ZipFile } from "yazl";
 var Zip = class {
-  constructor(_filename) {
+  constructor(_filename, _options = {}) {
     this._filename = _filename;
+    this._options = _options;
     assert(_filename, "No filename specified for ZIP file");
   }
   pipe(files, context) {
@@ -16,7 +17,7 @@ var Zip = class {
     context.log.info(`Packaging ${$ylw(files.length)} files`);
     for (const [relative, absolute] of files.pathMappings()) {
       context.log.debug(`Adding file ${$p(absolute)}`);
-      zipfile.addFile(absolute, relative);
+      zipfile.addFile(absolute, relative, this._options);
     }
     const directory = getAbsoluteParent(filename);
     const output = Files.builder(directory).add(filename).build();

package/dist/zip.mjs.map

@@ -1,6 +1,6 @@
 {
   "version": 3,
   "sources": ["../src/zip.ts"],
-  "mappings": ";AAGA,SAAS,yBAAyB;AAElC,SAAS,IAAI,MAAM,QAAQ,aAAa;AACxC,SAAS,yBAAyB;AAClC,SAAS,eAAe;AAcjB,IAAM,MAAN,MAAiC;AAAA,EAEtC,YAA6B,WAAmB;AAAnB;AAC3B,WAAO,WAAW,oCAAoC;AAAA,EACxD;AAAA,EAEA,KAAK,OAAc,SAAkC;AACnD,UAAM,WAAW,QAAQ,QAAQ,KAAK,SAAS;AAG/C,UAAM,UAAU,IAAI,QAAQ;AAC5B,UAAM,YAAY,kBAAkB,QAAQ;AAC5C,YAAQ,aAAa,KAAK,SAAS;AAGnC,YAAQ,IAAI,KAAK,aAAa,KAAK,MAAM,MAAM,CAAC,QAAQ;AACxD,eAAW,CAAE,UAAU,QAAS,KAAK,MAAM,aAAa,GAAG;AACzD,cAAQ,IAAI,MAAM,eAAe,GAAG,QAAQ,CAAC,EAAE;AAC/C,cAAQ,QAAQ,UAAU,QAAQ;AAAA,IACpC;AAGA,UAAM,YAAY,kBAAkB,QAAQ;AAC5C,UAAM,SAAS,MAAM,QAAQ,SAAS,EAAE,IAAI,QAAQ,EAAE,MAAM;AAC5D,YAAQ,IAAI;AAGZ,WAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,gBAAU,GAAG,SAAS,MAAM,QAAQ,MAAM,CAAC;AAE3C,cAAQ,GAAG,SAAS,CAAC,UAAU,OAAO,KAAK,CAAC;AAE5C,gBAAU,GAAG,SAAS,CAAC,UAAU,OAAO,KAAK,CAAC;AAAA,IAChD,CAAC;AAAA,EACH;AACF;",
+  "mappings": ";AAGA,SAAS,yBAAyB;AAElC,SAAS,IAAI,MAAM,QAAQ,aAAa;AACxC,SAAS,yBAAyB;AAClC,SAAS,eAAe;AAejB,IAAM,MAAN,MAAiC;AAAA,EAEtC,YACqB,WACA,WAAuB,CAAC,GAC3C;AAFmB;AACA;AAEnB,WAAO,WAAW,oCAAoC;AAAA,EACxD;AAAA,EAEA,KAAK,OAAc,SAAkC;AACnD,UAAM,WAAW,QAAQ,QAAQ,KAAK,SAAS;AAG/C,UAAM,UAAU,IAAI,QAAQ;AAC5B,UAAM,YAAY,kBAAkB,QAAQ;AAC5C,YAAQ,aAAa,KAAK,SAAS;AAGnC,YAAQ,IAAI,KAAK,aAAa,KAAK,MAAM,MAAM,CAAC,QAAQ;AACxD,eAAW,CAAE,UAAU,QAAS,KAAK,MAAM,aAAa,GAAG;AACzD,cAAQ,IAAI,MAAM,eAAe,GAAG,QAAQ,CAAC,EAAE;AAC/C,cAAQ,QAAQ,UAAU,UAAU,KAAK,QAAQ;AAAA,IACnD;AAGA,UAAM,YAAY,kBAAkB,QAAQ;AAC5C,UAAM,SAAS,MAAM,QAAQ,SAAS,EAAE,IAAI,QAAQ,EAAE,MAAM;AAC5D,YAAQ,IAAI;AAGZ,WAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,gBAAU,GAAG,SAAS,MAAM,QAAQ,MAAM,CAAC;AAE3C,cAAQ,GAAG,SAAS,CAAC,UAAU,OAAO,KAAK,CAAC;AAE5C,gBAAU,GAAG,SAAS,CAAC,UAAU,OAAO,KAAK,CAAC;AAAA,IAChD,CAAC;AAAA,EACH;AACF;",
   "names": []
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plugjs/zip",
-  "version": "0.5.7",
+  "version": "0.5.9",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
@@ -33,12 +33,12 @@
     "yazl": "^2.5.1"
   },
   "devDependencies": {
-    "@types/yauzl": "^2.10.1",
-    "@types/yazl": "^2.4.3",
+    "@types/yauzl": "^2.10.2",
+    "@types/yazl": "^2.4.4",
     "yauzl": "^2.10.0"
   },
   "peerDependencies": {
-    "@plugjs/plug": "0.5.7"
+    "@plugjs/plug": "0.5.9"
   },
   "files": [
     "*.md",

package/src/index.ts

@@ -1,14 +1,34 @@
 import { installForking } from '@plugjs/plug/fork'
 import { requireResolve } from '@plugjs/plug/paths'
 
+/** Options for zipping files */
+export interface ZipOptions {
+  /** Force the modified timestamp for all files in the _ZIP archive_ */
+  mtime?: Date;
+  /** Force the mode for all files in the _ZIP archive_ */
+  mode?: number;
+  /** Compress all files in the _ZIP archive_ (default: `true`) */
+  compress?: boolean;
+  /** Force the `ZIP-64` format for all files in the _ZIP archive_ (default: `false`) */
+  forceZip64Format?: boolean;
+}
+
 declare module '@plugjs/plug' {
   export interface Pipe {
     /**
-     * Archive all input {@link Files} into a _Zip_.
+     * Archive all input {@link Files} into a _ZIP archive_.
      *
-     * @param filename The output zip file name.
+     * @param filename - The output _ZIP archive_ file name.
      */
     zip(filename: string): Pipe
+
+    /**
+     * Archive all input {@link Files} into a _ZIP archive_.
+     *
+     * @param filename - The output _ZIP archive_ file name.
+     * @param options - Options for zipping the archive.
+     */
+    zip(filename: string, options: ZipOptions): Pipe
   }
 }
 

package/src/zip.ts

@@ -9,6 +9,7 @@ import { ZipFile } from 'yazl'
 
 import type { Context, PipeParameters, Plug } from '@plugjs/plug/pipe'
 import type EventEmitter from 'node:events'
+import type { ZipOptions } from '.'
 
 
 // The "yazl" types don't define "ZipFile" as an "EventEmitter"
@@ -21,7 +22,10 @@ declare module 'yazl' {
 /** Writes some info about the current {@link Files} being passed around. */
 export class Zip implements Plug<Files> {
   constructor(...args: PipeParameters<'zip'>)
-  constructor(private readonly _filename: string) {
+  constructor(
+      private readonly _filename: string,
+      private readonly _options: ZipOptions = {},
+  ) {
     assert(_filename, 'No filename specified for ZIP file')
   }
 
@@ -37,7 +41,7 @@ export class Zip implements Plug<Files> {
     context.log.info(`Packaging ${$ylw(files.length)} files`)
     for (const [ relative, absolute ] of files.pathMappings()) {
       context.log.debug(`Adding file ${$p(absolute)}`)
-      zipfile.addFile(absolute, relative)
+      zipfile.addFile(absolute, relative, this._options)
     }
 
     /* All files are added, just compute our return */