@zowe/db2-for-zowe-cli 6.1.16 → 6.1.17

package/README.md

@@ -163,6 +163,35 @@ After the uninstallation process completes successfully, the product no longer c
 
 ## Troubleshooting
 
+### The `ibm_db` module is not installed
+
+**Error message**: The `zowe plugins install` command fails, and the `Error Details` of the failure contain the following text:
+```
+IBM® Db2® Plug-in for Zowe CLI was installed, but its required 'ibm_db' module could not be loaded.
+Db2 commands will fail until the installation of 'ibm_db' is completed.
+```
+
+The plug-in itself is installed and registered with Zowe CLI when this failure occurs. Only the `ibm_db` module is incomplete, so you do not need to reinstall the plug-in.
+
+**Cause**: The plug-in delivers `ibm_db` as a bundled dependency, so that the plug-in can be installed without access to a public npm registry. However, `ibm_db` is a native module. Its own npm install script must download the IBM Db2 ODBC CLI driver and build the binding for your platform. npm does not run the lifecycle scripts of a bundled dependency, so that install script does not run when the plug-in is installed. The `--allow-scripts` option of `zowe plugins install` does not change that behavior, because npm skips the scripts of bundled dependencies even when scripts are allowed.
+
+**Action**: Run the `ibm_db` install script yourself. The error message contains the full path to the `ibm_db` directory on your system, which is normally the following path:
+
+```
+<zowe home>/plugins/installed/node_modules/@zowe/db2-for-zowe-cli/node_modules/ibm_db
+```
+
+Change to that directory and run its install script:
+
+```bash
+cd "<zowe home>/plugins/installed/node_modules/@zowe/db2-for-zowe-cli/node_modules/ibm_db"
+npm run install
+```
+
+If npm is not available, run the same script directly with `node installer/driverInstall.js`. You must run the script from the `ibm_db` directory, because `ibm_db` installs the CLI driver relative to the current directory.
+
+The script downloads the CLI driver from `https://public.dhe.ibm.com`, so the system needs network access to that site. If the system already has a Db2 client, a Db2 server, or a copy of the CLI driver, set the `IBM_DB_HOME` environment variable to that directory before you run the script to skip the download. For more `ibm_db` installation options, see the `README.md` file in the `ibm_db` directory.
+
 ### Node.js version incompatible with plug-in
 
 **Error message**:

package/lib/Db2PluginLifeCycle.d.ts

@@ -0,0 +1,80 @@
+import { AbstractPluginLifeCycle } from "@zowe/imperative";
+/**
+ * Life cycle actions for the Db2 plug-in.
+ *
+ * The plug-in delivers the native `ibm_db` module as a bundled dependency.
+ * NPM does not run the lifecycle scripts of bundled dependencies (and as of
+ * NPM v12 it does not run them even when scripts are allowed), so the driver
+ * install script that `ibm_db` relies on never runs during a plug-in install.
+ * We use the post-install hook to detect that condition and to tell the user
+ * how to complete the installation themselves.
+ *
+ * @export
+ * @class Db2PluginLifeCycle
+ */
+declare class Db2PluginLifeCycle extends AbstractPluginLifeCycle {
+    /**
+     * The name of the native module that Db2 commands require.
+     * @type {string}
+     * @static
+     * @memberof Db2PluginLifeCycle
+     */
+    static readonly NATIVE_MODULE_NM: string;
+    /**
+     * A horizontal rule used to make the reported steps stand out among the
+     * other messages that are displayed while a plug-in is installed.
+     * @type {string}
+     * @static
+     * @memberof Db2PluginLifeCycle
+     */
+    private static readonly DIVIDER;
+    /**
+     * Confirm that the bundled native module can be loaded after the plug-in
+     * has been installed. When it cannot be loaded, report the steps that the
+     * user must perform to finish the installation.
+     *
+     * @throws {ImperativeError}
+     *      When the native module cannot be loaded. The message contains the
+     *      steps that complete the installation.
+     * @memberof Db2PluginLifeCycle
+     */
+    postInstall(): void;
+    /**
+     * The Db2 plug-in makes no changes outside of its own installation
+     * directory, so nothing must be reverted before it is uninstalled.
+     *
+     * @memberof Db2PluginLifeCycle
+     */
+    preUninstall(): void;
+    /**
+     * Attempt to load the native module that Db2 commands require.
+     *
+     * @private
+     * @static
+     * @throws When the native module has not been completely installed.
+     * @memberof Db2PluginLifeCycle
+     */
+    private static loadNativeModule;
+    /**
+     * Form the message that tells the user how to finish the installation of
+     * the native module that this plug-in bundles.
+     *
+     * @private
+     * @static
+     * @param {string} reason The reason that the native module could not be loaded.
+     * @returns {string} The multi-line message to report to the user.
+     * @memberof Db2PluginLifeCycle
+     */
+    private static formIncompleteInstallMsg;
+    /**
+     * Find the directory into which the native module was installed, so that
+     * we can show the user exactly where to run its install script.
+     *
+     * @private
+     * @static
+     * @returns {string} The path to the directory of the native module.
+     * @memberof Db2PluginLifeCycle
+     */
+    private static findNativeModuleDir;
+}
+export = Db2PluginLifeCycle;

package/lib/Db2PluginLifeCycle.js

@@ -0,0 +1,154 @@
+"use strict";
+/*
+* This program and the accompanying materials are made available under the terms of the *
+* Eclipse Public License v2.0 which accompanies this distribution, and is available at *
+* https://www.eclipse.org/legal/epl-v20.html                                      *
+*                                                                                 *
+* SPDX-License-Identifier: EPL-2.0                                                *
+*                                                                                 *
+* Copyright Contributors to the Zowe Project.                                     *
+*                                                                                 *
+*/
+const path = require("path");
+const imperative_1 = require("@zowe/imperative");
+const Constants_1 = require("./Constants");
+/**
+ * Life cycle actions for the Db2 plug-in.
+ *
+ * The plug-in delivers the native `ibm_db` module as a bundled dependency.
+ * NPM does not run the lifecycle scripts of bundled dependencies (and as of
+ * NPM v12 it does not run them even when scripts are allowed), so the driver
+ * install script that `ibm_db` relies on never runs during a plug-in install.
+ * We use the post-install hook to detect that condition and to tell the user
+ * how to complete the installation themselves.
+ *
+ * @export
+ * @class Db2PluginLifeCycle
+ */
+class Db2PluginLifeCycle extends imperative_1.AbstractPluginLifeCycle {
+    /**
+     * Confirm that the bundled native module can be loaded after the plug-in
+     * has been installed. When it cannot be loaded, report the steps that the
+     * user must perform to finish the installation.
+     *
+     * @throws {ImperativeError}
+     *      When the native module cannot be loaded. The message contains the
+     *      steps that complete the installation.
+     * @memberof Db2PluginLifeCycle
+     */
+    postInstall() {
+        var _a;
+        const impLogger = imperative_1.Logger.getImperativeLogger();
+        try {
+            Db2PluginLifeCycle.loadNativeModule();
+            impLogger.debug(`The '${Db2PluginLifeCycle.NATIVE_MODULE_NM}' module was loaded successfully ` +
+                `after the installation of ${Constants_1.Constants.DISPLAY_NAME}.`);
+        }
+        catch (err) {
+            const warningMsg = Db2PluginLifeCycle.formIncompleteInstallMsg((_a = err === null || err === void 0 ? void 0 : err.message) !== null && _a !== void 0 ? _a : err);
+            impLogger.warn(warningMsg);
+            throw new imperative_1.ImperativeError({ msg: warningMsg });
+        }
+    }
+    /**
+     * The Db2 plug-in makes no changes outside of its own installation
+     * directory, so nothing must be reverted before it is uninstalled.
+     *
+     * @memberof Db2PluginLifeCycle
+     */
+    preUninstall() {
+        // nothing to do
+    }
+    /**
+     * Attempt to load the native module that Db2 commands require.
+     *
+     * @private
+     * @static
+     * @throws When the native module has not been completely installed.
+     * @memberof Db2PluginLifeCycle
+     */
+    static loadNativeModule() {
+        require(Db2PluginLifeCycle.NATIVE_MODULE_NM);
+    }
+    /**
+     * Form the message that tells the user how to finish the installation of
+     * the native module that this plug-in bundles.
+     *
+     * @private
+     * @static
+     * @param {string} reason The reason that the native module could not be loaded.
+     * @returns {string} The multi-line message to report to the user.
+     * @memberof Db2PluginLifeCycle
+     */
+    static formIncompleteInstallMsg(reason) {
+        const nativeMod = Db2PluginLifeCycle.NATIVE_MODULE_NM;
+        const nativeModDir = Db2PluginLifeCycle.findNativeModuleDir();
+        return `\n${Db2PluginLifeCycle.DIVIDER}\n` +
+            `${Constants_1.Constants.DISPLAY_NAME} was installed, but its required '${nativeMod}' module could not be loaded.\n` +
+            `Db2 commands will fail until the installation of '${nativeMod}' is completed.\n` +
+            `\n` +
+            `Reason = ${reason}\n` +
+            `\n` +
+            `The plug-in delivers '${nativeMod}' as a bundled dependency, so that the plug-in can be installed\n` +
+            `without access to a public NPM registry. However, '${nativeMod}' is a native module. Its own NPM install\n` +
+            `script must download the IBM Db2 ODBC CLI driver and build the binding for your platform. NPM does\n` +
+            `not run the lifecycle scripts of a bundled dependency, so that install script did not run on this\n` +
+            `system. The '--allow-scripts' option of 'plugins install' does not change that behavior, because\n` +
+            `NPM skips the scripts of bundled dependencies even when scripts are allowed.\n` +
+            `\n` +
+            `To finish the installation, run that install script yourself:\n` +
+            `\n` +
+            `    cd "${nativeModDir}"\n` +
+            `    npm run install\n` +
+            `\n` +
+            `You must run the script from the directory shown above, because '${nativeMod}' installs the CLI driver\n` +
+            `relative to the current directory.\n` +
+            `\n` +
+            `The script downloads the CLI driver from https://public.dhe.ibm.com, so the system needs network\n` +
+            `access to that site. If this system already has a Db2 client, a Db2 server, or a copy of the CLI\n` +
+            `driver, set the IBM_DB_HOME environment variable to that directory before you run the script to\n` +
+            `skip the download.\n` +
+            `\n` +
+            `See ${path.join(nativeModDir, "README.md")} for more '${nativeMod}' installation options.\n` +
+            `${Db2PluginLifeCycle.DIVIDER}\n`;
+    }
+    /**
+     * Find the directory into which the native module was installed, so that
+     * we can show the user exactly where to run its install script.
+     *
+     * @private
+     * @static
+     * @returns {string} The path to the directory of the native module.
+     * @memberof Db2PluginLifeCycle
+     */
+    static findNativeModuleDir() {
+        const nativeMod = Db2PluginLifeCycle.NATIVE_MODULE_NM;
+        try {
+            /* The module cannot be loaded, but its package.json can still be
+             * resolved, which reflects wherever NPM placed the module.
+             */
+            return path.dirname(require.resolve(`${nativeMod}/package.json`));
+        }
+        catch (err) {
+            // fall back to the location that a bundled dependency normally occupies
+            return path.resolve(__dirname, "..", "node_modules", nativeMod);
+        }
+    }
+}
+/**
+ * The name of the native module that Db2 commands require.
+ * @type {string}
+ * @static
+ * @memberof Db2PluginLifeCycle
+ */
+Db2PluginLifeCycle.NATIVE_MODULE_NM = "ibm_db";
+/**
+ * A horizontal rule used to make the reported steps stand out among the
+ * other messages that are displayed while a plug-in is installed.
+ * @type {string}
+ * @static
+ * @memberof Db2PluginLifeCycle
+ */
+Db2PluginLifeCycle.DIVIDER = "____________________________________________________________________________________________________";
+module.exports = Db2PluginLifeCycle;
+//# sourceMappingURL=Db2PluginLifeCycle.js.map

package/lib/Db2PluginLifeCycle.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Db2PluginLifeCycle.js","sourceRoot":"","sources":["../src/Db2PluginLifeCycle.ts"],"names":[],"mappings":";AAAA;;;;;;;;;EASE;AAEF,6BAA6B;AAC7B,iDAAoF;AACpF,2CAAwC;AAExC;;;;;;;;;;;;GAYG;AACH,MAAM,kBAAmB,SAAQ,oCAAuB;IAmBpD;;;;;;;;;OASG;IACI,WAAW;;QACd,MAAM,SAAS,GAAG,mBAAM,CAAC,mBAAmB,EAAE,CAAC;QAC/C,IAAI,CAAC;YACD,kBAAkB,CAAC,gBAAgB,EAAE,CAAC;YACtC,SAAS,CAAC,KAAK,CAAC,QAAQ,kBAAkB,CAAC,gBAAgB,mCAAmC;gBAC1F,6BAA6B,qBAAS,CAAC,YAAY,GAAG,CACzD,CAAC;QACN,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,MAAM,UAAU,GAAG,kBAAkB,CAAC,wBAAwB,CAAC,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,OAAO,mCAAI,GAAG,CAAC,CAAC;YACpF,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YAC3B,MAAM,IAAI,4BAAe,CAAC,EAAC,GAAG,EAAE,UAAU,EAAC,CAAC,CAAC;QACjD,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,YAAY;QACf,gBAAgB;IACpB,CAAC;IAED;;;;;;;OAOG;IACK,MAAM,CAAC,gBAAgB;QAC3B,OAAO,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;;;;OASG;IACK,MAAM,CAAC,wBAAwB,CAAC,MAAc;QAClD,MAAM,SAAS,GAAG,kBAAkB,CAAC,gBAAgB,CAAC;QACtD,MAAM,YAAY,GAAG,kBAAkB,CAAC,mBAAmB,EAAE,CAAC;QAE9D,OAAO,KAAK,kBAAkB,CAAC,OAAO,IAAI;YACtC,GAAG,qBAAS,CAAC,YAAY,qCAAqC,SAAS,iCAAiC;YACxG,qDAAqD,SAAS,mBAAmB;YACjF,IAAI;YACJ,YAAY,MAAM,IAAI;YACtB,IAAI;YACJ,yBAAyB,SAAS,mEAAmE;YACrG,sDAAsD,SAAS,6CAA6C;YAC5G,sGAAsG;YACtG,qGAAqG;YACrG,oGAAoG;YACpG,gFAAgF;YAChF,IAAI;YACJ,iEAAiE;YACjE,IAAI;YACJ,WAAW,YAAY,KAAK;YAC5B,uBAAuB;YACvB,IAAI;YACJ,oEAAoE,SAAS,6BAA6B;YAC1G,sCAAsC;YACtC,IAAI;YACJ,oGAAoG;YACpG,oGAAoG;YACpG,mGAAmG;YACnG,sBAAsB;YACtB,IAAI;YACJ,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,WAAW,CAAC,cAAc,SAAS,2BAA2B;YAC7F,GAAG,kBAAkB,CAAC,OAAO,IAAI,CAAC;IAC1C,CAAC;IAED;;;;;;;;OAQG;IACK,MAAM,CAAC,mBAAmB;QAC9B,MAAM,SAAS,GAAG,kBAAkB,CAAC,gBAAgB,CAAC;QACtD,IAAI,CAAC;YACD;;eAEG;YACH,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,SAAS,eAAe,CAAC,CAAC,CAAC;QACtE,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,wEAAwE;YACxE,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,IAAI,EAAE,cAAc,EAAE,SAAS,CAAC,CAAC;QACpE,CAAC;IACL,CAAC;;AAhID;;;;;GAKG;AACoB,mCAAgB,GAAW,QAAQ,CAAC;AAE3D;;;;;;GAMG;AACqB,0BAAO,GAC3B,sGAAsG,CAAC;AAmH/G,iBAAS,kBAAkB,CAAC"}

package/lib/imperative.js

@@ -15,6 +15,7 @@ const config = {
     commandModuleGlobs: ["**/cli/*/*.definition!(.d).*s"],
     rootCommandDescription: Constants_1.Constants.DESCRIPTION,
     productDisplayName: Constants_1.Constants.DISPLAY_NAME,
+    pluginLifeCycle: "lib/Db2PluginLifeCycle.js",
     profiles: [
         {
             type: "db2",

package/lib/imperative.js.map

@@ -1 +1 @@
-{"version":3,"file":"imperative.js","sourceRoot":"","sources":["../src/imperative.ts"],"names":[],"mappings":";AAAA;;;;;;;;;EASE;AAGF,2CAAwC;AAExC,MAAM,MAAM,GAAsB;IAC9B,IAAI,EAAE,qBAAS,CAAC,SAAS;IACzB,kBAAkB,EAAE,CAAC,+BAA+B,CAAC;IACrD,sBAAsB,EAAE,qBAAS,CAAC,WAAW;IAC7C,kBAAkB,EAAE,qBAAS,CAAC,YAAY;IAC1C,QAAQ,EAAE;QACN;YACI,IAAI,EAAE,KAAK;YACX,MAAM,EAAE;gBACJ,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,aAAa;gBACpB,WAAW,EAAE,wDAAwD;gBACrE,UAAU,EAAE;oBACR,IAAI,EAAE;wBACF,IAAI,EAAE,QAAQ;wBACd,gBAAgB,EAAE;4BACd,IAAI,EAAE,MAAM;4BACZ,OAAO,EAAE,CAAC,GAAG,CAAC;4BACd,WAAW,EAAE,0BAA0B;4BACvC,IAAI,EAAE,QAAQ;yBACjB;qBACJ;oBACD,IAAI,EAAE;wBACF,IAAI,EAAE,QAAQ;wBACd,gBAAgB,EAAE;4BACd,IAAI,EAAE,MAAM;4BACZ,OAAO,EAAE,CAAC,GAAG,CAAC;4BACd,WAAW,EAAE,4BAA4B;4BACzC,IAAI,EAAE,QAAQ;yBACjB;wBACD,iBAAiB,EAAE,IAAI;qBAC1B;oBACD,IAAI,EAAE;wBACF,IAAI,EAAE,QAAQ;wBACd,MAAM,EAAE,IAAI;wBACZ,gBAAgB,EAAE;4BACd,IAAI,EAAE,MAAM;4BACZ,OAAO,EAAE,CAAC,GAAG,CAAC;4BACd,WAAW,EAAE,oDAAoD;4BACjE,IAAI,EAAE,QAAQ;yBACjB;qBACJ;oBACD,QAAQ,EAAE;wBACN,IAAI,EAAE,QAAQ;wBACd,MAAM,EAAE,IAAI;wBACZ,gBAAgB,EAAE;4BACd,IAAI,EAAE,UAAU;4BAChB,OAAO,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC;4BACvB,WAAW,EAAE,wDAAwD;4BACrE,IAAI,EAAE,QAAQ;yBACjB;qBACJ;oBACD,QAAQ,EAAE;wBACN,IAAI,EAAE,QAAQ;wBACd,gBAAgB,EAAE;4BACd,IAAI,EAAE,UAAU;4BAChB,OAAO,EAAE,CAAC,GAAG,CAAC;4BACd,WAAW,EAAE,0BAA0B;4BACvC,IAAI,EAAE,QAAQ;yBACjB;wBACD,iBAAiB,EAAE,IAAI;qBAC1B;oBACD,OAAO,EAAE;wBACL,IAAI,EAAE,QAAQ;wBACd,gBAAgB,EAAE;4BACd,IAAI,EAAE,UAAU;4BAChB,OAAO,EAAE,CAAC,GAAG,CAAC;4BACd,WAAW,EAAE,sCAAsC;4BACnD,IAAI,EAAE,QAAQ;yBACjB;qBACJ;iBACJ;aACJ;SACJ;KACJ;CACJ,CAAC;AAEF,iBAAS,MAAM,CAAC"}
+{"version":3,"file":"imperative.js","sourceRoot":"","sources":["../src/imperative.ts"],"names":[],"mappings":";AAAA;;;;;;;;;EASE;AAGF,2CAAwC;AAExC,MAAM,MAAM,GAAsB;IAC9B,IAAI,EAAE,qBAAS,CAAC,SAAS;IACzB,kBAAkB,EAAE,CAAC,+BAA+B,CAAC;IACrD,sBAAsB,EAAE,qBAAS,CAAC,WAAW;IAC7C,kBAAkB,EAAE,qBAAS,CAAC,YAAY;IAC1C,eAAe,EAAE,2BAA2B;IAC5C,QAAQ,EAAE;QACN;YACI,IAAI,EAAE,KAAK;YACX,MAAM,EAAE;gBACJ,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,aAAa;gBACpB,WAAW,EAAE,wDAAwD;gBACrE,UAAU,EAAE;oBACR,IAAI,EAAE;wBACF,IAAI,EAAE,QAAQ;wBACd,gBAAgB,EAAE;4BACd,IAAI,EAAE,MAAM;4BACZ,OAAO,EAAE,CAAC,GAAG,CAAC;4BACd,WAAW,EAAE,0BAA0B;4BACvC,IAAI,EAAE,QAAQ;yBACjB;qBACJ;oBACD,IAAI,EAAE;wBACF,IAAI,EAAE,QAAQ;wBACd,gBAAgB,EAAE;4BACd,IAAI,EAAE,MAAM;4BACZ,OAAO,EAAE,CAAC,GAAG,CAAC;4BACd,WAAW,EAAE,4BAA4B;4BACzC,IAAI,EAAE,QAAQ;yBACjB;wBACD,iBAAiB,EAAE,IAAI;qBAC1B;oBACD,IAAI,EAAE;wBACF,IAAI,EAAE,QAAQ;wBACd,MAAM,EAAE,IAAI;wBACZ,gBAAgB,EAAE;4BACd,IAAI,EAAE,MAAM;4BACZ,OAAO,EAAE,CAAC,GAAG,CAAC;4BACd,WAAW,EAAE,oDAAoD;4BACjE,IAAI,EAAE,QAAQ;yBACjB;qBACJ;oBACD,QAAQ,EAAE;wBACN,IAAI,EAAE,QAAQ;wBACd,MAAM,EAAE,IAAI;wBACZ,gBAAgB,EAAE;4BACd,IAAI,EAAE,UAAU;4BAChB,OAAO,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC;4BACvB,WAAW,EAAE,wDAAwD;4BACrE,IAAI,EAAE,QAAQ;yBACjB;qBACJ;oBACD,QAAQ,EAAE;wBACN,IAAI,EAAE,QAAQ;wBACd,gBAAgB,EAAE;4BACd,IAAI,EAAE,UAAU;4BAChB,OAAO,EAAE,CAAC,GAAG,CAAC;4BACd,WAAW,EAAE,0BAA0B;4BACvC,IAAI,EAAE,QAAQ;yBACjB;wBACD,iBAAiB,EAAE,IAAI;qBAC1B;oBACD,OAAO,EAAE;wBACL,IAAI,EAAE,QAAQ;wBACd,gBAAgB,EAAE;4BACd,IAAI,EAAE,UAAU;4BAChB,OAAO,EAAE,CAAC,GAAG,CAAC;4BACd,WAAW,EAAE,sCAAsC;4BACnD,IAAI,EAAE,QAAQ;yBACjB;qBACJ;iBACJ;aACJ;SACJ;KACJ;CACJ,CAAC;AAEF,iBAAS,MAAM,CAAC"}

package/node_modules/adm-zip/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2012 Another-D-Mention Software and other contributors
+
+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.

package/node_modules/adm-zip/README.md

@@ -0,0 +1,90 @@
+# ADM-ZIP for NodeJS
+
+ADM-ZIP is a pure JavaScript implementation for zip data compression for [NodeJS](https://nodejs.org/).
+
+<a href="https://github.com/cthackers/adm-zip/actions/workflows/ci.yml">
+  <img src="https://github.com/cthackers/adm-zip/actions/workflows/ci.yml/badge.svg" alt="Build Status">
+</a>
+
+# Installation
+
+With [npm](https://www.npmjs.com/) do:
+
+    $ npm install adm-zip
+
+**Electron** file system support described below.
+
+## What is it good for?
+
+The library allows you to:
+
+-   decompress zip files directly to disk or in memory buffers
+-   compress files and store them to disk in .zip format or in compressed buffers
+-   update content of/add new/delete files from an existing .zip
+
+# Dependencies
+
+There are no other nodeJS libraries that ADM-ZIP is dependent of
+
+# Examples
+
+## Basic usage
+
+```javascript
+var AdmZip = require("adm-zip");
+
+// reading archives
+var zip = new AdmZip("./my_file.zip");
+var password = "1234567890";
+var zipEntries = zip.getEntries(); // an array of ZipEntry records - add password parameter if entries are password protected
+
+zipEntries.forEach(function (zipEntry) {
+    console.log(zipEntry.toString()); // outputs zip entries information
+    if (zipEntry.entryName == "my_file.txt") {
+        console.log(zipEntry.getData().toString("utf8"));
+    }
+});
+// outputs the content of some_folder/my_file.txt
+console.log(zip.readAsText("some_folder/my_file.txt"));
+// extracts the specified file to the specified location
+zip.extractEntryTo(/*entry name*/ "some_folder/my_file.txt", /*target path*/ "/home/me/tempfolder", /*maintainEntryPath*/ false, /*overwrite*/ true);
+// extracts everything
+zip.extractAllTo(/*target path*/ "/home/me/zipcontent/", /*overwrite*/ true);
+
+// creating archives
+var zip = new AdmZip();
+
+// add file directly
+var content = "inner content of the file";
+zip.addFile("test.txt", Buffer.from(content, "utf8"), "entry comment goes here");
+// add local file
+zip.addLocalFile("/home/me/some_picture.png");
+// get everything as a buffer
+var willSendthis = zip.toBuffer();
+// or write everything to disk
+zip.writeZip(/*target file name*/ "/home/me/files.zip");
+
+// ... more examples in the wiki
+```
+
+For more detailed information please check out the [wiki](https://github.com/cthackers/adm-zip/wiki).
+
+## Electron original-fs
+
+ADM-ZIP has supported electron **original-fs** for years without any user interractions but it causes problem with bundlers like rollup etc. For continuing support **original-fs** or any other custom file system module. There is possible specify your module by **fs** option in ADM-ZIP constructor.
+
+Example:
+
+```javascript
+const AdmZip = require("adm-zip");
+const OriginalFs = require("original-fs");
+
+// reading archives
+const zip = new AdmZip("./my_file.zip", { fs: OriginalFs });
+.
+.
+.
+```
+## Security
+
+Please report security vulnerabilities privately. See [SECURITY.md](./SECURITY.md).