occam-open-cli 5.0.100 → 5.0.102

package/bin/abbreviations.js

@@ -1,13 +1,15 @@
 "use strict";
 
-const { HELP_OPTION, VERSION_OPTION, LOG_LEVEL_OPTION } = require("./options");
+const { HELP_OPTION, DRY_RUN_OPTION, VERSION_OPTION, LOG_LEVEL_OPTION } = require("./options");
 
 const h = HELP_OPTION,
+      d = DRY_RUN_OPTION,
       v = VERSION_OPTION,
       l = LOG_LEVEL_OPTION
 
 module.exports = {
   h,
+  d,
   v,
   l
 };

package/bin/action/clone.js

@@ -7,7 +7,7 @@ const cloneOperation = require("../operation/clone"),
 const { executeOperations } = require("../utilities/operation"),
       { SUCCESSFUL_CLONE_MESSAGE, FAILED_CLONE_MESSAGE } = require("../messages");
 
-function clone(argument) {
+function cloneAction(argument) {
   const releaseName = argument,  ///
         operations = [
           releaseNamePromptOperation,
@@ -30,4 +30,4 @@ function clone(argument) {
   }, context);
 }
 
-module.exports = clone;
+module.exports = cloneAction;

package/bin/action/createAccount.js

@@ -8,7 +8,7 @@ const createAccountOperation = require("../operation/createAccount"),
 
 const { executeOperations } = require("../utilities/operation");
 
-function createAccount(argument) {
+function createAccountAction(argument) {
   const emailAddress = argument,  ///
         username = null,
         password = null,
@@ -34,4 +34,4 @@ function createAccount(argument) {
   }, context);
 }
 
-module.exports = createAccount;
+module.exports = createAccountAction;

package/bin/action/deprecate.js

@@ -8,7 +8,7 @@ const deprecateOperation = require("../operation/deprecate"),
 const { executeOperations } = require("../utilities/operation"),
       { FAILED_DEPRECATE_MESSAGE, SUCCESSFUL_DEPRECATE_MESSAGE } = require("../messages");
 
-function deprecate(argument) {
+function deprecateAction(argument) {
   const releaseName = argument,  ///
         password = null,
         operations = [
@@ -34,4 +34,4 @@ function deprecate(argument) {
   }, context);
 }
 
-module.exports = deprecate;
+module.exports = deprecateAction;

package/bin/action/help.js

@@ -1,6 +1,6 @@
 "use strict";
 
-function help() {
+function helpAction() {
   console.log(`Usage: 
   
   open [<command>] [<argument>]
@@ -47,4 +47,4 @@ Please see the readme file on GitHub:
   process.exit();
 }
 
-module.exports = help;
+module.exports = helpAction;

package/bin/action/initialise.js

@@ -3,7 +3,7 @@
 const { checkConfigurationFileExists, createConfigurationFile } = require("../configuration"),
       { FAILED_INITIALISE_MESSAGE, SUCCESSFUL_INITIALISE_MESSAGE } = require("../messages");
 
-function initialise() {
+function initialiseAction() {
   let success;
 
   const configurationFileExists = checkConfigurationFileExists();
@@ -25,4 +25,4 @@ function initialise() {
   process.exit();
 }
 
-module.exports = initialise;
+module.exports = initialiseAction;

package/bin/action/open.js

@@ -2,7 +2,7 @@
 
 const { OPEN_MESSAGE } = require("../messages");
 
-function open(argument) {
+function openAction(argument) {
   const message = OPEN_MESSAGE;
 
   console.log(message);
@@ -10,4 +10,4 @@ function open(argument) {
   process.exit();
 }
 
-module.exports = open;
+module.exports = openAction;

package/bin/action/publish.js

@@ -1,29 +1,28 @@
 "use strict";
 
 const publishOperation = require("../operation/publish"),
+      zipReleaseOperation = require("../operation/zipRelease"),
       loadReleaseOperation = require("../operation/loadRelease"),
       updateVersionOperation = require("../operation/updateVersion"),
-      deflateReleaseOperation = require("../operation/deflateRelease"),
       getIdentityTokenOperation = require("../operation/getIdentityToken"),
       releaseNamePromptOperation = require("../operation/prompt/releaseName");
 
 const { DOUBLE_DASH } = require("../constants"),
-      { DEFAULT_LOG_LEVEL } = require("../defaults"),
       { executeOperations } = require("../utilities/operation"),
       { FAILED_PUBLISH_MESSAGE, SUCCESSFUL_PUBLISH_MESSAGE } = require("../messages");
 
-function publish(argument, options) {
-  const { logLevel = DEFAULT_LOG_LEVEL } = options,
-        releaseName = argument, ///
+function publishAction(argument, dryRun, logLevel) {
+  const releaseName = argument, ///
         operations = [
           getIdentityTokenOperation,
           releaseNamePromptOperation,
           loadReleaseOperation,
-          deflateReleaseOperation,
+          zipReleaseOperation,
           publishOperation,
           updateVersionOperation
         ],
         context = {
+          dryRun,
           logLevel,
           releaseName
         };
@@ -31,8 +30,8 @@ function publish(argument, options) {
   executeOperations(operations, (completed) => {
     const { success, version, messages } = context,
           message = success ?
-            SUCCESSFUL_PUBLISH_MESSAGE :
-              FAILED_PUBLISH_MESSAGE,
+                      SUCCESSFUL_PUBLISH_MESSAGE :
+                        FAILED_PUBLISH_MESSAGE,
           messagesLength = messages.length;
 
     if (messagesLength > 0) {
@@ -57,4 +56,4 @@ function publish(argument, options) {
   }, context);
 }
 
-module.exports = publish;
+module.exports = publishAction;

package/bin/action/resetPassword.js

@@ -5,7 +5,7 @@ const resetPasswordOperation = require("../operation/resetPassword"),
 
 const { executeOperations } = require("../utilities/operation");
 
-function resetPassword(argument) {
+function resetPasswordAction(argument) {
   const emailAddress = argument, ///
         operations = [
           emailAddressPromptOperation,
@@ -24,4 +24,4 @@ function resetPassword(argument) {
   }, context);
 }
 
-module.exports = resetPassword;
+module.exports = resetPasswordAction;

package/bin/action/setOptions.js

@@ -7,7 +7,7 @@ const setOptionsOperation = require("../operation/setOptions"),
 const { executeOperations } = require("../utilities/operation"),
       { FAILED_SET_OPTIONS_MESSAGE, SUCCESSFUL_SET_OPTIONS_MESSAGE } = require("../messages");
 
-function setOptions() {
+function setOptionsAction() {
   const operations = [
           useSSHPromptOperation,
           gitHubHostNamePromptOperation,
@@ -27,4 +27,4 @@ function setOptions() {
   }, context);
 }
 
-module.exports = setOptions;
+module.exports = setOptionsAction;

package/bin/action/signIn.js

@@ -7,7 +7,7 @@ const signInOperation = require("../operation/signIn"),
 
 const { executeOperations } = require("../utilities/operation");
 
-function signIn(argument) {
+function signInAction(argument) {
   const emailAddressOrUsername = argument,  ///
         password = null,
         operations = [
@@ -30,4 +30,4 @@ function signIn(argument) {
   }, context);
 }
 
-module.exports = signIn;
+module.exports = signInAction;

package/bin/action/signOut.js

@@ -3,7 +3,7 @@
 const { SIGN_OUT_MESSAGE } = require("../messages"),
       { removeIdentityToken } = require("../configuration");
 
-function signOut() {
+function signOutAction() {
   const message = SIGN_OUT_MESSAGE;
 
   removeIdentityToken();
@@ -13,4 +13,4 @@ function signOut() {
   process.exit();
 }
 
-module.exports = signOut;
+module.exports = signOutAction;

package/bin/action/version.js

@@ -3,7 +3,7 @@
 const { OPEN_CLI } = require("../constants"),
       { getPackageVersion } = require("../utilities/packageJSON");
 
-function version() {
+function versionAction() {
   const packageVersion = getPackageVersion(),
         version = packageVersion; ///
 
@@ -12,4 +12,4 @@ function version() {
   process.exit();
 }
 
-module.exports = version;
+module.exports = versionAction;

package/bin/actions.js

@@ -1,19 +1,19 @@
 "use strict";
 
-const help = require("./action/help"),
-      open = require("./action/open"),
-      clone = require("./action/clone"),
-      signIn = require("./action/signIn"),
-      signOut = require("./action/signOut"),
-      version = require("./action/version"),
-      publish = require("./action/publish"),
-      deprecate = require("./action/deprecate"),
-      initialise = require("./action/initialise"),
-      setOptions = require("./action/setOptions"),
-      createAccount = require("./action/createAccount"),
-      resetPassword = require("./action/resetPassword");
+const helpAction = require("./action/help"),
+      openAction = require("./action/open"),
+      cloneAction = require("./action/clone"),
+      signInAction = require("./action/signIn"),
+      signOutAction = require("./action/signOut"),
+      versionAction = require("./action/version"),
+      publishAction = require("./action/publish"),
+      deprecateAction = require("./action/deprecate"),
+      initialiseAction = require("./action/initialise"),
+      setOptionsAction = require("./action/setOptions"),
+      createAccountAction = require("./action/createAccount"),
+      resetPasswordAction = require("./action/resetPassword");
 
-const { HELP_OPTION, VERSION_OPTION } = require("./options"),
+const { DEFAULT_HELP, DEFAULT_DRY_RUN, DEFAULT_VERSION, DEFAULT_LOG_LEVEL } = require("./defaults"),
       { HELP_COMMAND,
         CLONE_COMMAND,
         VERSION_COMMAND,
@@ -29,30 +29,32 @@ const { HELP_OPTION, VERSION_OPTION } = require("./options"),
 
 function actions(command, argument, options) {
   const commandMissing = (command === null),
-        helpOptionPresent = options.hasOwnProperty(HELP_OPTION),
-        versionOptionPresent = options.hasOwnProperty(VERSION_OPTION);
+        { help = DEFAULT_HELP,
+          dryRun = DEFAULT_DRY_RUN,
+          version = DEFAULT_VERSION,
+          logLevel = DEFAULT_LOG_LEVEL } = options;
 
   if (false) {
     ///
-  } else if (versionOptionPresent) {
-    command = VERSION_COMMAND;
-  } else if (commandMissing || helpOptionPresent) {
+  } else if (help || commandMissing) {
     command = HELP_COMMAND;
+  } else if (version) {
+    command = VERSION_COMMAND;
   }
 
   switch (command) {
-    case HELP_COMMAND : help(); break;
-    case CLONE_COMMAND : clone(argument); break;
-    case VERSION_COMMAND : version(); break;
-    case INSTALL_COMMAND : open(argument); break;
-    case PUBLISH_COMMAND : publish(argument, options); break;
-    case SIGN_IN_COMMAND : signIn(argument); break;
-    case SIGN_OUT_COMMAND : signOut(); break;
-    case DEPRECATE_COMMAND : deprecate(argument); break;
-    case INITIALISE_COMMAND : initialise(); break;
-    case SET_OPTIONS_COMMAND : setOptions(); break;
-    case CREATE_ACCOUNT_COMMAND : createAccount(argument); break;
-    case RESET_PASSWORD_COMMAND : resetPassword(argument); break;
+    case HELP_COMMAND : helpAction(); break;
+    case CLONE_COMMAND : cloneAction(argument); break;
+    case VERSION_COMMAND : versionAction(); break;
+    case INSTALL_COMMAND : openAction(argument); break;
+    case PUBLISH_COMMAND : publishAction(argument, dryRun, logLevel); break;
+    case SIGN_IN_COMMAND : signInAction(argument); break;
+    case SIGN_OUT_COMMAND : signOutAction(); break;
+    case DEPRECATE_COMMAND : deprecateAction(argument); break;
+    case INITIALISE_COMMAND : initialiseAction(); break;
+    case SET_OPTIONS_COMMAND : setOptionsAction(); break;
+    case CREATE_ACCOUNT_COMMAND : createAccountAction(argument); break;
+    case RESET_PASSWORD_COMMAND : resetPasswordAction(argument); break;
 
     default :
       argument = command;  ///

package/bin/constants.js

@@ -9,6 +9,7 @@ const END = "end",
       DOUBLE_DASH = "--",
       DOUBLE_SPACE = "  ",
       EMPTY_STRING = "",
+      RELEASE_JSON = "release.json",
       PACKAGE_JSON = "package.json";
 
 module.exports = {
@@ -21,5 +22,6 @@ module.exports = {
   DOUBLE_DASH,
   DOUBLE_SPACE,
   EMPTY_STRING,
+  RELEASE_JSON,
   PACKAGE_JSON
 };

package/bin/defaults.js

@@ -4,12 +4,18 @@ const { levels } = require("necessary");
 
 const { INFO_LEVEL } = levels;
 
-const DEFAULT_HOST = "https://openmathematics.org",
+const DEFAULT_HELP = false,
+      DEFAULT_HOST = "https://openmathematics.org",
+      DEFAULT_DRY_RUN = false,
+      DEFAULT_VERSION = false,
       DEFAULT_LOG_LEVEL = INFO_LEVEL,
       DEFAULT_GITHUB_HOST_NAME = "github.com";
 
 module.exports = {
+  DEFAULT_HELP,
   DEFAULT_HOST,
+  DEFAULT_DRY_RUN,
+  DEFAULT_VERSION,
   DEFAULT_LOG_LEVEL,
   DEFAULT_GITHUB_HOST_NAME
 };

package/bin/operation/publish.js

@@ -5,12 +5,13 @@ const post = require("../post");
 const { PUBLISH_API_URI } = require("../uris");
 
 function publishOperation(proceed, abort, context) {
-  const { logLevel, releaseName, identityToken, deflatedRelease } = context,
+  const { dryRun, logLevel, releaseName, identityToken, zippedRelease } = context,
         uri = `${PUBLISH_API_URI}/${releaseName}`,
         json = {
+          dryRun,
           logLevel,
           identityToken,
-          deflatedRelease
+          zippedRelease
         };
 
   post(uri, json, (json) => {

package/bin/operation/zipRelease.js

@@ -0,0 +1,36 @@
+"use strict";
+
+const JSZip = require("jszip");
+
+const { encodings } = require("necessary");
+
+const { RELEASE_JSON } = require("../constants");
+
+const { BASE64_ENCODING } = encodings;
+
+function zipReleaseOperation(proceed, abort, context) {
+  const { release } = context,
+        type = BASE64_ENCODING,  ///
+        jsZip = new JSZip(),
+        releaseJSON = release.toJSON(),
+        releaseJSONString = JSON.stringify(releaseJSON),
+        name = RELEASE_JSON,
+        content = releaseJSONString,  ///
+        options = {
+          type
+        };
+
+  jsZip.file(name, content);
+
+  jsZip.generateAsync(options)
+    .catch(abort)
+    .then((zippedRelease) => {
+      Object.assign(context, {
+        zippedRelease
+      });
+
+      proceed();
+    });
+}
+
+module.exports = zipReleaseOperation;

package/bin/options.js

@@ -2,10 +2,12 @@
 
 const HELP_OPTION = "help",
       VERSION_OPTION = "version",
+      DRY_RUN_OPTION = "dry-run",
       LOG_LEVEL_OPTION = "log-level";
 
 module.exports = {
   HELP_OPTION,
   VERSION_OPTION,
+  DRY_RUN_OPTION,
   LOG_LEVEL_OPTION
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "occam-open-cli",
   "author": "James Smith",
-  "version": "5.0.100",
+  "version": "5.0.102",
   "license": "MIT, Anti-996",
   "homepage": "https://github.com/djalbat/occam-open-cli",
   "description": "Occam's command line package management tool.",
@@ -11,8 +11,9 @@
   },
   "dependencies": {
     "argumentative": "^2.0.21",
+    "jszip": "^3.10.1",
     "necessary": "^11.1.4",
-    "occam-file-system": "^5.0.72"
+    "occam-file-system": "^5.0.73"
   },
   "scripts": {},
   "bin": {

package/bin/operation/deflateRelease.js

@@ -1,33 +0,0 @@
-"use strict";
-
-const { encodings } = require("necessary");
-
-const { deflate } = require("zlib");
-
-const { BASE64_ENCODING } = encodings;
-
-function deflateReleaseOperation(proceed, abort, context) {
-  const { release } = context,
-        releaseJSON = release.toJSON(),
-        releaseJSONString = JSON.stringify(releaseJSON);
-
-  deflate(releaseJSONString, (error, buffer) => {
-    if (error) {
-      abort();
-
-      return;
-    }
-
-    const encoding = BASE64_ENCODING,
-          deflatedReleaseJSONString = buffer.toString(encoding),
-          deflatedRelease = deflatedReleaseJSONString;  ///
-
-    Object.assign(context, {
-      deflatedRelease
-    });
-
-    proceed();
-  });
-}
-
-module.exports = deflateReleaseOperation;