@plugjs/zip 0.2.0

package/README.md

@@ -0,0 +1,7 @@
+Zip File Plugin for the PlugJS Build System
+===========================================
+
+Prototype build system from [Juit GmbH](https://www.juit.com/)
+
+* [Copyright Notice](https://github.com/plugjs/plug/blob/main/NOTICE.md)
+* [License](https://github.com/plugjs/plug/blob/main/LICENSE.md)

package/dist/index.cjs

@@ -0,0 +1,7 @@
+"use strict";
+
+// index.ts
+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");
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +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;",
+  "names": []
+}

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+declare module '@plugjs/plug' {
+    interface Pipe {
+        /**
+         * Archive all input {@link Files} into a _Zip_.
+         *
+         * @param filename The output zip file name.
+         */
+        zip(filename: string): Pipe;
+    }
+}
+export {};

package/dist/index.mjs

@@ -0,0 +1,15 @@
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __commonJS = (cb, mod) => function __require() {
+  return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
+};
+
+// index.ts
+import { installForking } from "@plugjs/plug/fork";
+import { requireResolve } from "@plugjs/plug/paths";
+var require_src = __commonJS({
+  "index.ts"() {
+    installForking("zip", requireResolve(import.meta.url, "./zip"), "Zip");
+  }
+});
+export default require_src();
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

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

package/dist/zip.cjs

@@ -0,0 +1,59 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+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);
+
+// zip.ts
+var zip_exports = {};
+__export(zip_exports, {
+  Zip: () => Zip
+});
+module.exports = __toCommonJS(zip_exports);
+var import_node_fs = require("node:fs");
+var import_plug = require("@plugjs/plug");
+var import_paths = require("@plugjs/plug/paths");
+var import_yazl = require("yazl");
+var Zip = class {
+  constructor(_filename) {
+    this._filename = _filename;
+    (0, import_plug.assert)(_filename, "No filename specified for ZIP file");
+  }
+  pipe(files, context) {
+    const filename = context.resolve(this._filename);
+    const zipfile = new import_yazl.ZipFile();
+    const zipstream = (0, import_node_fs.createWriteStream)(filename);
+    zipfile.outputStream.pipe(zipstream);
+    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);
+    }
+    const directory = (0, import_paths.getAbsoluteParent)(filename);
+    const output = import_plug.Files.builder(directory).add(filename).build();
+    zipfile.end();
+    return new Promise((resolve, reject) => {
+      zipstream.on("close", () => resolve(output));
+      zipfile.on("error", (error) => reject(error));
+      zipstream.on("error", (error) => reject(error));
+    });
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Zip
+});
+//# sourceMappingURL=zip.cjs.map

package/dist/zip.cjs.map

@@ -0,0 +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,SAAS;AACxD,eAAW,CAAE,UAAU,QAAS,KAAK,MAAM,aAAa,GAAG;AACzD,cAAQ,IAAI,MAAM,mBAAe,gBAAG,QAAQ,GAAG;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;",
+  "names": []
+}

package/dist/zip.d.ts

@@ -0,0 +1,16 @@
+/// <reference path="index.d.ts" />
+/// <reference types="node" />
+import { Files } from '@plugjs/plug';
+import type { Context, PipeParameters, Plug } from '@plugjs/plug/pipe';
+import type EventEmitter from 'node:events';
+declare module 'yazl' {
+    interface ZipFile extends EventEmitter {
+        on(event: 'error', listener: (err: Error) => void): this;
+    }
+}
+/** Writes some info about the current {@link Files} being passed around. */
+export declare class Zip implements Plug<Files> {
+    private readonly _filename;
+    constructor(...args: PipeParameters<'zip'>);
+    pipe(files: Files, context: Context): Promise<Files>;
+}

package/dist/zip.mjs

@@ -0,0 +1,34 @@
+// zip.ts
+import { createWriteStream } from "node:fs";
+import { $p, $ylw, assert, Files } from "@plugjs/plug";
+import { getAbsoluteParent } from "@plugjs/plug/paths";
+import { ZipFile } from "yazl";
+var Zip = class {
+  constructor(_filename) {
+    this._filename = _filename;
+    assert(_filename, "No filename specified for ZIP file");
+  }
+  pipe(files, context) {
+    const filename = context.resolve(this._filename);
+    const zipfile = new ZipFile();
+    const zipstream = createWriteStream(filename);
+    zipfile.outputStream.pipe(zipstream);
+    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);
+    }
+    const directory = getAbsoluteParent(filename);
+    const output = Files.builder(directory).add(filename).build();
+    zipfile.end();
+    return new Promise((resolve, reject) => {
+      zipstream.on("close", () => resolve(output));
+      zipfile.on("error", (error) => reject(error));
+      zipstream.on("error", (error) => reject(error));
+    });
+  }
+};
+export {
+  Zip
+};
+//# sourceMappingURL=zip.mjs.map

package/dist/zip.mjs.map

@@ -0,0 +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,SAAS;AACxD,eAAW,CAAE,UAAU,QAAS,KAAK,MAAM,aAAa,GAAG;AACzD,cAAQ,IAAI,MAAM,eAAe,GAAG,QAAQ,GAAG;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;",
+  "names": []
+}

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@plugjs/zip",
+  "version": "0.2.0",
+  "type": "commonjs",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.cjs"
+      },
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.mjs"
+      }
+    },
+    "./zip": {
+      "require": {
+        "types": "./dist/zip.d.ts",
+        "default": "./dist/zip.cjs"
+      },
+      "import": {
+        "types": "./dist/zip.d.ts",
+        "default": "./dist/zip.mjs"
+      }
+    }
+  },
+  "author": "Juit Developers <developers@juit.com>",
+  "license": "Apache-2.0",
+  "dependencies": {
+    "yazl": "^2.5.1"
+  },
+  "devDependencies": {
+    "@types/yauzl": "^2.10.0",
+    "@types/yazl": "^2.4.2",
+    "yauzl": "^2.10.0"
+  },
+  "peerDependencies": {
+    "@plugjs/plug": "0.2.0"
+  },
+  "files": [
+    "*.md",
+    "dist/",
+    "src/"
+  ]
+}

package/src/index.ts

@@ -0,0 +1,15 @@
+import { installForking } from '@plugjs/plug/fork'
+import { requireResolve } from '@plugjs/plug/paths'
+
+declare module '@plugjs/plug' {
+  export interface Pipe {
+    /**
+     * Archive all input {@link Files} into a _Zip_.
+     *
+     * @param filename The output zip file name.
+     */
+    zip(filename: string): Pipe
+  }
+}
+
+installForking('zip', requireResolve(__fileurl, './zip'), 'Zip')

package/src/zip.ts

@@ -0,0 +1,57 @@
+// Reference ourselves, so that the constructor's parameters are correct
+/// <reference path="./index.ts" />
+
+import { createWriteStream } from 'node:fs'
+
+import { $p, $ylw, assert, Files } from '@plugjs/plug'
+import { getAbsoluteParent } from '@plugjs/plug/paths'
+import { ZipFile } from 'yazl'
+
+import type { Context, PipeParameters, Plug } from '@plugjs/plug/pipe'
+import type EventEmitter from 'node:events'
+
+
+// The "yazl" types don't define "ZipFile" as an "EventEmitter"
+declare module 'yazl' {
+  interface ZipFile extends EventEmitter {
+    on(event: 'error', listener: (err: Error) => void): this;
+  }
+}
+
+/** 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) {
+    assert(_filename, 'No filename specified for ZIP file')
+  }
+
+  pipe(files: Files, context: Context): Promise<Files> {
+    const filename = context.resolve(this._filename)
+
+    /* Create a new ZipFile piping to a WriteStream */
+    const zipfile = new ZipFile()
+    const zipstream = createWriteStream(filename)
+    zipfile.outputStream.pipe(zipstream)
+
+    /* Add all unique files to the zip */
+    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)
+    }
+
+    /* All files are added, just compute our return */
+    const directory = getAbsoluteParent(filename)
+    const output = Files.builder(directory).add(filename).build()
+    zipfile.end()
+
+    /* When done, resolve or reject! */
+    return new Promise((resolve, reject) => {
+      zipstream.on('close', () => resolve(output))
+      /* coverage ignore next */
+      zipfile.on('error', (error) => reject(error))
+      /* coverage ignore next */
+      zipstream.on('error', (error) => reject(error))
+    })
+  }
+}