@knocklabs/cli 0.1.0-rc.3 → 0.1.0

package/dist/lib/marshal/workflow/reader.js

@@ -10,10 +10,12 @@ function _export(target, all) {
 }
 _export(exports, {
     readWorkflowDir: ()=>readWorkflowDir,
+    readAllForCommandTarget: ()=>readAllForCommandTarget,
     checkIfValidExtractedFilePathFormat: ()=>checkIfValidExtractedFilePathFormat,
     readExtractedFileSync: ()=>readExtractedFileSync
 });
 const _nodePath = /*#__PURE__*/ _interopRequireWildcard(require("node:path"));
+const _core = require("@oclif/core");
 const _fsExtra = /*#__PURE__*/ _interopRequireWildcard(require("fs-extra"));
 const _lodash = require("lodash");
 const _error = require("../../helpers/error");
@@ -247,3 +249,63 @@ const readWorkflowDir = async (workflowDirCtx, opts = {})=>{
         []
     ];
 };
+/*
+ * For the given list of workflow directory contexts, read each workflow dir and
+ * return workflow directory data.
+ */ const readWorkflowDirs = async (workflowDirCtxs, opts = {})=>{
+    const workflows = [];
+    const errors = [];
+    for (const workflowDirCtx of workflowDirCtxs){
+        // eslint-disable-next-line no-await-in-loop
+        const [workflow, readErrors] = await readWorkflowDir(workflowDirCtx, opts);
+        if (readErrors.length > 0) {
+            const workflowJsonPath = _nodePath.resolve(workflowDirCtx.abspath, _helpers.WORKFLOW_JSON);
+            const e = new _error.SourceError((0, _error.formatErrors)(readErrors), workflowJsonPath);
+            errors.push(e);
+            continue;
+        }
+        workflows.push({
+            ...workflowDirCtx,
+            content: workflow
+        });
+    }
+    return [
+        workflows,
+        errors
+    ];
+};
+const readAllForCommandTarget = async (target, opts = {})=>{
+    const { type: targetType , context: targetCtx  } = target;
+    if (!targetCtx.exists) {
+        const subject = targetType === "workflowDir" ? "a workflow directory at" : "workflow directories in";
+        return _core.CliUx.ux.error(`Cannot locate ${subject} \`${targetCtx.abspath}\``);
+    }
+    switch(targetType){
+        case "workflowDir":
+            {
+                return readWorkflowDirs([
+                    targetCtx
+                ], opts);
+            }
+        case "workflowsIndexDir":
+            {
+                const dirents = await _fsExtra.readdir(targetCtx.abspath, {
+                    withFileTypes: true
+                });
+                const promises = dirents.map(async (dirent)=>{
+                    const abspath = _nodePath.resolve(targetCtx.abspath, dirent.name);
+                    const workflowDirCtx = {
+                        type: "workflow",
+                        key: dirent.name,
+                        abspath,
+                        exists: await (0, _helpers.isWorkflowDir)(abspath)
+                    };
+                    return workflowDirCtx;
+                });
+                const workflowDirCtxs = (await Promise.all(promises)).filter((workflowDirCtx)=>workflowDirCtx.exists);
+                return readWorkflowDirs(workflowDirCtxs, opts);
+            }
+        default:
+            throw new Error(`Invalid workflow command target: ${target}`);
+    }
+};

package/dist/lib/marshal/workflow/writer.js

@@ -14,6 +14,7 @@ _export(exports, {
     writeWorkflowsIndexDir: ()=>writeWorkflowsIndexDir,
     buildWorkflowDirBundle: ()=>buildWorkflowDirBundle,
     formatExtractedFilePath: ()=>formatExtractedFilePath,
+    pruneWorkflowsIndexDir: ()=>pruneWorkflowsIndexDir,
     toWorkflowJson: ()=>toWorkflowJson
 });
 const _nodePath = /*#__PURE__*/ _interopRequireWildcard(require("node:path"));
@@ -265,10 +266,12 @@ const writeWorkflowDirFromData = async (workflowDirCtx, remoteWorkflow)=>{
     return writeWorkflowDirFromBundle(workflowDirCtx, bundle);
 };
 const writeWorkflowDirFromBundle = async (workflowDirCtx, workflowDirBundle)=>{
+    const backupDirPath = _nodePath.resolve(_const.sandboxDir, (0, _lodash.uniqueId)("backup"));
     try {
-        // TODO(KNO-2794): Just back up the current workflow directory, wipe it,
-        // then write a new directory.
-        await _fsExtra.remove(workflowDirCtx.abspath);
+        if (workflowDirCtx.exists) {
+            await _fsExtra.copy(workflowDirCtx.abspath, backupDirPath);
+            await _fsExtra.emptyDir(workflowDirCtx.abspath);
+        }
         const promises = Object.entries(workflowDirBundle).map(([relpath, fileContent])=>{
             const filePath = _nodePath.resolve(workflowDirCtx.abspath, relpath);
             return relpath === _helpers.WORKFLOW_JSON ? _fsExtra.outputJson(filePath, fileContent, {
@@ -277,10 +280,43 @@ const writeWorkflowDirFromBundle = async (workflowDirCtx, workflowDirBundle)=>{
         });
         await Promise.all(promises);
     } catch (error) {
-        await _fsExtra.remove(workflowDirCtx.abspath);
+        // In case of any error, wipe the target directory that is likely in a bad
+        // state then restore the backup if one existed before.
+        if (workflowDirCtx.exists) {
+            await _fsExtra.emptyDir(workflowDirCtx.abspath);
+            await _fsExtra.copy(backupDirPath, workflowDirCtx.abspath);
+        } else {
+            await _fsExtra.remove(workflowDirCtx.abspath);
+        }
         throw error;
+    } finally{
+        // Always clean up the backup directory in the temp sandbox.
+        await _fsExtra.remove(backupDirPath);
     }
 };
+/*
+ * Prunes the index directory by removing any files, or directories that aren't
+ * workflow dirs found in fetched workflows. We want to preserve any workflow
+ * dirs that are going to be updated with remote workflows, so extracted links
+ * can be respected.
+ */ const pruneWorkflowsIndexDir = async (indexDirCtx, remoteWorkflows)=>{
+    const workflowsByKey = Object.fromEntries(remoteWorkflows.map((w)=>[
+            w.key.toLowerCase(),
+            w
+        ]));
+    const dirents = await _fsExtra.readdir(indexDirCtx.abspath, {
+        withFileTypes: true
+    });
+    const promises = dirents.map(async (dirent)=>{
+        const direntName = dirent.name.toLowerCase();
+        const direntPath = _nodePath.resolve(indexDirCtx.abspath, direntName);
+        if (await (0, _helpers.isWorkflowDir)(direntPath) && workflowsByKey[direntName]) {
+            return;
+        }
+        await _fsExtra.remove(direntPath);
+    });
+    await Promise.all(promises);
+};
 const writeWorkflowsIndexDir = async (indexDirCtx, remoteWorkflows)=>{
     const backupDirPath = _nodePath.resolve(_const.sandboxDir, (0, _lodash.uniqueId)("backup"));
     try {
@@ -288,9 +324,7 @@ const writeWorkflowsIndexDir = async (indexDirCtx, remoteWorkflows)=>{
         // before wiping it clean.
         if (indexDirCtx.exists) {
             await _fsExtra.copy(indexDirCtx.abspath, backupDirPath);
-            // TODO(KNO-2794): Only remove directories that aren't part of the remote
-            // workflows.
-            await _fsExtra.remove(indexDirCtx.abspath);
+            await pruneWorkflowsIndexDir(indexDirCtx, remoteWorkflows);
         }
         // Write given remote workflows into the given workflows directory path.
         const writeWorkflowDirPromises = remoteWorkflows.map(async (workflow)=>{
@@ -307,9 +341,11 @@ const writeWorkflowsIndexDir = async (indexDirCtx, remoteWorkflows)=>{
     } catch (error) {
         // In case of any error, wipe the index directory that is likely in a bad
         // state then restore the backup if one existed before.
-        await _fsExtra.remove(indexDirCtx.abspath);
         if (indexDirCtx.exists) {
+            await _fsExtra.emptyDir(indexDirCtx.abspath);
             await _fsExtra.copy(backupDirPath, indexDirCtx.abspath);
+        } else {
+            await _fsExtra.remove(indexDirCtx.abspath);
         }
         throw error;
     } finally{

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.1.0-rc.3",
+  "version": "0.1.0",
   "commands": {
     "ping": {
       "id": "ping",
@@ -8,6 +8,7 @@
       "pluginName": "@knocklabs/cli",
       "pluginAlias": "@knocklabs/cli",
       "pluginType": "core",
+      "hidden": true,
       "aliases": [],
       "examples": [
         "<%= config.bin %> <%= command.id %>"
@@ -30,6 +31,38 @@
       },
       "args": {}
     },
+    "whoami": {
+      "id": "whoami",
+      "strict": true,
+      "pluginName": "@knocklabs/cli",
+      "pluginAlias": "@knocklabs/cli",
+      "pluginType": "core",
+      "aliases": [],
+      "flags": {
+        "service-token": {
+          "name": "service-token",
+          "type": "option",
+          "summary": "The service token to authenticate with",
+          "required": true,
+          "multiple": false
+        },
+        "api-origin": {
+          "name": "api-origin",
+          "type": "option",
+          "hidden": true,
+          "required": false,
+          "multiple": false
+        },
+        "json": {
+          "name": "json",
+          "type": "boolean",
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "allowNo": false
+        }
+      },
+      "args": {}
+    },
     "commit": {
       "id": "commit",
       "strict": true,
@@ -114,6 +147,54 @@
       },
       "args": {}
     },
+    "translation:get": {
+      "id": "translation:get",
+      "strict": true,
+      "pluginName": "@knocklabs/cli",
+      "pluginAlias": "@knocklabs/cli",
+      "pluginType": "core",
+      "aliases": [],
+      "flags": {
+        "service-token": {
+          "name": "service-token",
+          "type": "option",
+          "summary": "The service token to authenticate with",
+          "required": true,
+          "multiple": false
+        },
+        "api-origin": {
+          "name": "api-origin",
+          "type": "option",
+          "hidden": true,
+          "required": false,
+          "multiple": false
+        },
+        "environment": {
+          "name": "environment",
+          "type": "option",
+          "multiple": false,
+          "default": "development"
+        },
+        "hide-uncommitted-changes": {
+          "name": "hide-uncommitted-changes",
+          "type": "boolean",
+          "allowNo": false
+        },
+        "json": {
+          "name": "json",
+          "type": "boolean",
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "allowNo": false
+        }
+      },
+      "args": {
+        "translationRef": {
+          "name": "translationRef",
+          "required": true
+        }
+      }
+    },
     "translation:list": {
       "id": "translation:list",
       "strict": true,
@@ -224,7 +305,12 @@
           "allowNo": false
         }
       },
-      "args": {}
+      "args": {
+        "translationRef": {
+          "name": "translationRef",
+          "required": false
+        }
+      }
     },
     "translation:push": {
       "id": "translation:push",
@@ -640,6 +726,19 @@
           ],
           "default": "development"
         },
+        "all": {
+          "name": "all",
+          "type": "boolean",
+          "allowNo": false
+        },
+        "workflows-dir": {
+          "name": "workflows-dir",
+          "type": "option",
+          "multiple": false,
+          "dependsOn": [
+            "all"
+          ]
+        },
         "commit": {
           "name": "commit",
           "type": "boolean",
@@ -695,6 +794,19 @@
             "development"
           ],
           "default": "development"
+        },
+        "all": {
+          "name": "all",
+          "type": "boolean",
+          "allowNo": false
+        },
+        "workflows-dir": {
+          "name": "workflows-dir",
+          "type": "option",
+          "multiple": false,
+          "dependsOn": [
+            "all"
+          ]
         }
       },
       "args": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knocklabs/cli",
-  "version": "0.1.0-rc.3",
+  "version": "0.1.0",
   "description": "Knock CLI",
   "author": "@knocklabs",
   "bin": {
@@ -19,13 +19,13 @@
   "dependencies": {
     "@oclif/core": "^1.26.2",
     "@oclif/plugin-help": "^5",
-    "@oclif/plugin-plugins": "^2.4.6",
+    "@oclif/plugin-plugins": "^2.4.7",
     "@prantlf/jsonlint": "^11.7.2",
-    "axios": "^1.3.5",
-    "date-fns": "^2.29.3",
+    "axios": "^1.4.0",
+    "date-fns": "^2.30.0",
     "enquirer": "^2.3.6",
     "fs-extra": "^10.1.0",
-    "liquidjs": "^10.7.0",
+    "liquidjs": "^10.7.1",
     "locale-codes": "^1.3.1",
     "lodash": "^4.17.21",
     "yup": "^0.32.11"
@@ -43,11 +43,11 @@
     "eslint": "^7.32.0",
     "eslint-config-oclif": "^4",
     "eslint-config-oclif-typescript": "^1.0.3",
-    "eslint-config-prettier": "^8.6.0",
+    "eslint-config-prettier": "^8.8.0",
     "eslint-plugin-prettier": "^4.2.1",
     "eslint-plugin-simple-import-sort": "^8.0.0",
     "mocha": "^9",
-    "nock": "^13.3.0",
+    "nock": "^13.3.1",
     "oclif": "^3",
     "prettier": "2.8.8",
     "shx": "^0.3.4",