@knocklabs/cli 0.1.0-rc.0 → 0.1.0-rc.1

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

@@ -17,6 +17,7 @@ const _fsExtra = /*#__PURE__*/ _interopRequireWildcard(require("fs-extra"));
 const _lodash = require("lodash");
 const _error = require("../../helpers/error");
 const _json = require("../../helpers/json");
+const _liquid = require("../../helpers/liquid");
 const _object = require("../../helpers/object");
 const _helpers = require("./helpers");
 const _types = require("./types");
@@ -74,25 +75,29 @@ const validateTemplateFilePathFormat = (relpath, workflowDirCtx)=>{
 };
 const readTemplateFile = async (relpath, workflowDirCtx)=>{
     const abspath = _nodePath.resolve(workflowDirCtx.abspath, relpath);
-    switch(true){
-        case abspath.toLowerCase().endsWith(".json"):
-            {
-                const [obj, errors] = await (0, _json.readJson)(abspath);
-                const content = obj && JSON.stringify(obj);
-                return [
-                    content,
-                    errors
-                ];
-            }
-        default:
-            {
-                const content = await _fsExtra.readFile(abspath, "utf8");
-                return [
-                    content,
-                    []
-                ];
-            }
-    }
+    // First read all template files as text content and check for valid liquid
+    // syntax given it is supported across all message templates and formats.
+    const content = await _fsExtra.readFile(abspath, "utf8");
+    const liquidError = (0, _liquid.validateLiquidSyntax)(content);
+    if (liquidError) return [
+        undefined,
+        [
+            liquidError
+        ]
+    ];
+    // If not a json file, we can just return the file content.
+    const isJsonFile = abspath.toLowerCase().endsWith(".json");
+    if (!isJsonFile) return [
+        content,
+        []
+    ];
+    // If json, parse it as json and validate it as such.
+    const [obj, errors] = await (0, _json.readJson)(abspath);
+    const json = obj && JSON.stringify(obj);
+    return [
+        json,
+        errors
+    ];
 };
 /*
  * Validates that a given value is a valid template file path and the file
@@ -100,7 +105,7 @@ const readTemplateFile = async (relpath, workflowDirCtx)=>{
  */ const maybeReadTemplateFile = async (val, workflowDirCtx, extractedFilePaths, pathToFieldStr)=>{
     // Validate the file path format, and that it is unique per workflow.
     if (!validateTemplateFilePathFormat(val, workflowDirCtx) || typeof val !== "string" || val in extractedFilePaths) {
-        const error = new _error.JsonError("must be a relative path string to a unique file within the directory", pathToFieldStr);
+        const error = new _error.JsonDataError("must be a relative path string to a unique file within the directory", pathToFieldStr);
         return [
             undefined,
             error
@@ -112,7 +117,7 @@ const readTemplateFile = async (relpath, workflowDirCtx)=>{
     // Check a file actually exists at the given file path.
     const exists = await validateTemplateFileExists(val, workflowDirCtx);
     if (!exists) {
-        const error = new _error.JsonError("must be a relative path string to a file that exists", pathToFieldStr);
+        const error = new _error.JsonDataError("must be a relative path string to a file that exists", pathToFieldStr);
         return [
             undefined,
             error
@@ -122,7 +127,9 @@ const readTemplateFile = async (relpath, workflowDirCtx)=>{
     // under the same field name but without the @ filepath marker.
     const [content, contentErrors] = await readTemplateFile(val, workflowDirCtx);
     if (contentErrors.length > 0) {
-        const error = new _error.JsonError(`points to a file with invalid content (${val})\n\n` + (0, _error.formatErrors)(contentErrors), pathToFieldStr);
+        const error = new _error.JsonDataError(`points to a file with invalid content (${val})\n\n` + (0, _error.formatErrors)(contentErrors, {
+            indentBy: 2
+        }), pathToFieldStr);
         return [
             undefined,
             error
@@ -145,7 +152,7 @@ const compileTemplateFiles = async (workflowDirCtx, workflowJson)=>{
         ];
     }
     if (!Array.isArray(workflowJson.steps)) {
-        errors.push(new _error.JsonError("must be an array of workflow steps", objPath.to("steps").str));
+        errors.push(new _error.JsonDataError("must be an array of workflow steps", objPath.to("steps").str));
         return [
             workflowJson,
             errors
@@ -157,11 +164,11 @@ const compileTemplateFiles = async (workflowDirCtx, workflowJson)=>{
     for (const [stepIdx, step] of steps.entries()){
         objPath.reset(pathToSteps).push(stepIdx);
         if (!(0, _lodash.isPlainObject)(step)) {
-            errors.push(new _error.JsonError("must be a workflow step object", objPath.str));
+            errors.push(new _error.JsonDataError("must be a workflow step object", objPath.str));
             continue;
         }
         if (step.type === undefined) {
-            errors.push(new _error.JsonError("must have a `type` field", objPath.str));
+            errors.push(new _error.JsonDataError("must have a `type` field", objPath.str));
             continue;
         }
         // Not a channel step, nothing more to do.
@@ -169,11 +176,11 @@ const compileTemplateFiles = async (workflowDirCtx, workflowJson)=>{
             continue;
         }
         if (step.template === undefined) {
-            errors.push(new _error.JsonError("must have a `template` field containing a template object", objPath.str));
+            errors.push(new _error.JsonDataError("must have a `template` field containing a template object", objPath.str));
             continue;
         }
         if (!(0, _lodash.isPlainObject)(step.template)) {
-            errors.push(new _error.JsonError("must be a template object", objPath.to("template").str));
+            errors.push(new _error.JsonDataError("must be a template object", objPath.to("template").str));
             continue;
         }
         // 3. For a given template, look for any extracted template content, read
@@ -207,7 +214,6 @@ const compileTemplateFiles = async (workflowDirCtx, workflowJson)=>{
             (0, _lodash.set)(workflowJson, inlinePathStr, content);
         }
     }
-    // TODO: Consider validating content for liquid syntax too maybe?
     return [
         workflowJson,
         errors

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

@@ -9,14 +9,15 @@ function _export(target, all) {
     });
 }
 _export(exports, {
-    writeWorkflowDir: ()=>writeWorkflowDir,
+    newTemplateFilePath: ()=>newTemplateFilePath,
+    writeWorkflowDirFromData: ()=>writeWorkflowDirFromData,
+    writeWorkflowDirFromBundle: ()=>writeWorkflowDirFromBundle,
     buildWorkflowDirBundle: ()=>buildWorkflowDirBundle,
     toWorkflowJson: ()=>toWorkflowJson
 });
 const _nodePath = /*#__PURE__*/ _interopRequireWildcard(require("node:path"));
 const _fsExtra = /*#__PURE__*/ _interopRequireWildcard(require("fs-extra"));
 const _lodash = require("lodash");
-const _env = require("../../helpers/env");
 const _json = require("../../helpers/json");
 const _object = require("../../helpers/object");
 const _helpers = require("./helpers");
@@ -61,14 +62,7 @@ function _interopRequireWildcard(obj, nodeInterop) {
     }
     return newObj;
 }
-/*
- * For a given workflow step and a template field, return the template file path
- * we can extract out the content to.
- *
- * Note, this is a default "recommended" convention but the template file can
- * be located at any arbitrary path (as long as it is a relative path that is
- * inside the workflow directory and unique to the field)
- */ const newTemplateFilePath = (stepRef, fileName, fileExt)=>_nodePath.join(stepRef, `${fileName}.${fileExt}`).toLowerCase();
+const newTemplateFilePath = (stepRef, fileName, fileExt)=>_nodePath.join(stepRef, `${fileName}.${fileExt}`).toLowerCase();
 /*
  * For a given workflow step and a template field, return the path of object
  * which we can use to check whether the field has been extracted (hence, with
@@ -151,7 +145,12 @@ function _interopRequireWildcard(obj, nodeInterop) {
         ...settingsExtractableFields
     };
 };
-const buildWorkflowDirBundle = (workflowDirCtx, remoteWorkflow, localWorkflow = {})=>{
+/*
+ * Parse a given workflow payload, and extract out any template contents where
+ * necessary and mutate the workflow data accordingly so we end up with a
+ * mapping of file contents by its relative path (aka workflow dir bundle) that
+ * can be written into a file system as individual files.
+ */ const buildWorkflowDirBundle = (workflowDirCtx, remoteWorkflow, localWorkflow = {})=>{
     const bundle = {};
     const mutWorkflow = (0, _lodash.cloneDeep)(remoteWorkflow);
     const localWorkflowStepsByRef = (0, _lodash.keyBy)(localWorkflow.steps || [], "ref");
@@ -190,25 +189,30 @@ const buildWorkflowDirBundle = (workflowDirCtx, remoteWorkflow, localWorkflow =
         _helpers.WORKFLOW_JSON
     ], toWorkflowJson(mutWorkflow));
 };
-const writeWorkflowDir = async (remoteWorkflow, workflowDirCtx)=>{
+const writeWorkflowDirFromData = async (workflowDirCtx, remoteWorkflow)=>{
     // If the workflow directory exists on the file system (i.e. previously
     // pulled before), then read the workflow file to use as a reference.
-    const [localWorkflow] = workflowDirCtx.exists ? await (0, _reader.readWorkflowDir)(workflowDirCtx) : [];
+    // Note, we do not need to compile or validate template files for this.
+    const [localWorkflow] = workflowDirCtx.exists ? await (0, _reader.readWorkflowDir)(workflowDirCtx, {
+        withTemplateFiles: false
+    }) : [];
     const bundle = buildWorkflowDirBundle(workflowDirCtx, remoteWorkflow, localWorkflow);
-    const workflowDirPath = _env.isTestEnv ? _nodePath.join(_env.sandboxDir, remoteWorkflow.key) : workflowDirCtx.abspath;
+    return writeWorkflowDirFromBundle(workflowDirCtx, bundle);
+};
+const writeWorkflowDirFromBundle = async (workflowDirCtx, workflowDirBundle)=>{
     try {
         // TODO(KNO-2794): Should rather clean up any orphaned template files
         // individually after successfully writing the workflow directory.
-        await _fsExtra.remove(workflowDirPath);
-        const promises = Object.entries(bundle).map(([relpath, fileContent])=>{
-            const filePath = _nodePath.join(workflowDirPath, relpath);
+        await _fsExtra.remove(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, {
                 spaces: _json.DOUBLE_SPACES
             }) : _fsExtra.outputFile(filePath, fileContent);
         });
         await Promise.all(promises);
     } catch (error) {
-        await _fsExtra.remove(workflowDirPath);
+        await _fsExtra.remove(workflowDirCtx.abspath);
         throw error;
     }
 };

package/dist/lib/user-config.js

@@ -11,7 +11,7 @@ Object.defineProperty(exports, "default", {
 const _nodePath = /*#__PURE__*/ _interopRequireWildcard(require("node:path"));
 const _fsExtra = /*#__PURE__*/ _interopRequireWildcard(require("fs-extra"));
 const _yup = /*#__PURE__*/ _interopRequireWildcard(require("yup"));
-const _env = require("./helpers/env");
+const _const = require("./helpers/const");
 function _getRequireWildcardCache(nodeInterop) {
     if (typeof WeakMap !== "function") return null;
     var cacheBabelInterop = new WeakMap();
@@ -58,8 +58,8 @@ const userConfigSchema = _yup.object({
 let USER_CONFIG;
 const maybeReadJsonConfig = async (configDir)=>{
     // Don't use a user config file in tests.
-    if (_env.isTestEnv) return null;
-    const pathToJsonConfig = _nodePath.join(configDir, "config.json");
+    if (_const.isTestEnv) return null;
+    const pathToJsonConfig = _nodePath.resolve(configDir, "config.json");
     const exists = await _fsExtra.pathExists(pathToJsonConfig);
     if (!exists) return null;
     return _fsExtra.readJSON(pathToJsonConfig);

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.1.0-rc.0",
+  "version": "0.1.0-rc.1",
   "commands": {
     "ping": {
       "id": "ping",
@@ -16,7 +16,7 @@
         "service-token": {
           "name": "service-token",
           "type": "option",
-          "summary": "service token to authenticate with",
+          "summary": "The service token to authenticate with",
           "required": true,
           "multiple": false
         },
@@ -30,6 +30,141 @@
       },
       "args": {}
     },
+    "commit": {
+      "id": "commit",
+      "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",
+          "summary": "Committing changes applies to the development environment only, use `commit promote` to promote changes to a later environment",
+          "multiple": false,
+          "options": [
+            "development"
+          ],
+          "default": "development"
+        },
+        "commit-message": {
+          "name": "commit-message",
+          "type": "option",
+          "char": "m",
+          "summary": "Use the given value as the commit message",
+          "multiple": false
+        },
+        "force": {
+          "name": "force",
+          "type": "boolean",
+          "allowNo": false
+        }
+      },
+      "args": {}
+    },
+    "commit:promote": {
+      "id": "commit:promote",
+      "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
+        },
+        "to": {
+          "name": "to",
+          "type": "option",
+          "summary": "The destination environment to promote changes from the preceding environment",
+          "required": true,
+          "multiple": false
+        },
+        "force": {
+          "name": "force",
+          "type": "boolean",
+          "allowNo": false
+        }
+      },
+      "args": {}
+    },
+    "workflow:activate": {
+      "id": "workflow:activate",
+      "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",
+          "required": true,
+          "multiple": false
+        },
+        "status": {
+          "name": "status",
+          "type": "option",
+          "multiple": false,
+          "options": [
+            "true",
+            "false"
+          ],
+          "default": true
+        },
+        "force": {
+          "name": "force",
+          "type": "boolean",
+          "allowNo": false
+        }
+      },
+      "args": {
+        "workflowKey": {
+          "name": "workflowKey",
+          "required": true
+        }
+      }
+    },
     "workflow:get": {
       "id": "workflow:get",
       "strict": true,
@@ -41,7 +176,7 @@
         "service-token": {
           "name": "service-token",
           "type": "option",
-          "summary": "service token to authenticate with",
+          "summary": "The service token to authenticate with",
           "required": true,
           "multiple": false
         },
@@ -89,7 +224,7 @@
         "service-token": {
           "name": "service-token",
           "type": "option",
-          "summary": "service token to authenticate with",
+          "summary": "The service token to authenticate with",
           "required": true,
           "multiple": false
         },
@@ -136,6 +271,50 @@
       },
       "args": {}
     },
+    "workflow:new": {
+      "id": "workflow:new",
+      "strict": true,
+      "pluginName": "@knocklabs/cli",
+      "pluginAlias": "@knocklabs/cli",
+      "pluginType": "core",
+      "hidden": true,
+      "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
+        },
+        "steps": {
+          "name": "steps",
+          "type": "option",
+          "multiple": false,
+          "aliases": [
+            "step"
+          ]
+        },
+        "force": {
+          "name": "force",
+          "type": "boolean",
+          "allowNo": false
+        }
+      },
+      "args": {
+        "workflowKey": {
+          "name": "workflowKey",
+          "required": true
+        }
+      }
+    },
     "workflow:pull": {
       "id": "workflow:pull",
       "strict": true,
@@ -147,7 +326,7 @@
         "service-token": {
           "name": "service-token",
           "type": "option",
-          "summary": "service token to authenticate with",
+          "summary": "The service token to authenticate with",
           "required": true,
           "multiple": false
         },
@@ -188,7 +367,63 @@
         "service-token": {
           "name": "service-token",
           "type": "option",
-          "summary": "service token to authenticate with",
+          "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",
+          "summary": "Pushing a workflow is only allowed in the development environment",
+          "multiple": false,
+          "options": [
+            "development"
+          ],
+          "default": "development"
+        },
+        "commit": {
+          "name": "commit",
+          "type": "boolean",
+          "summary": "Push and commit the workflow(s) at the same time",
+          "allowNo": false
+        },
+        "commit-message": {
+          "name": "commit-message",
+          "type": "option",
+          "char": "m",
+          "summary": "Use the given value as the commit message",
+          "multiple": false,
+          "dependsOn": [
+            "commit"
+          ]
+        }
+      },
+      "args": {
+        "workflowKey": {
+          "name": "workflowKey",
+          "required": false
+        }
+      }
+    },
+    "workflow:validate": {
+      "id": "workflow:validate",
+      "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
         },
@@ -202,6 +437,7 @@
         "environment": {
           "name": "environment",
           "type": "option",
+          "summary": "Validating a workflow is only done in the development environment",
           "multiple": false,
           "options": [
             "development"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knocklabs/cli",
-  "version": "0.1.0-rc.0",
+  "version": "0.1.0-rc.1",
   "description": "Knock CLI",
   "author": "@knocklabs",
   "bin": {
@@ -17,26 +17,27 @@
     "/oclif.manifest.json"
   ],
   "dependencies": {
-    "@oclif/core": "^1.26.1",
+    "@oclif/core": "^1.26.2",
     "@oclif/plugin-help": "^5",
-    "@oclif/plugin-plugins": "^2.3.0",
+    "@oclif/plugin-plugins": "^2.3.2",
     "@prantlf/jsonlint": "^11.7.0",
-    "axios": "^1.3.2",
+    "axios": "^1.3.4",
     "date-fns": "^2.29.3",
     "enquirer": "^2.3.6",
     "fs-extra": "^10.1.0",
+    "liquidjs": "^10.5.0",
     "lodash": "^4.17.21",
     "yup": "^0.32.11"
   },
   "devDependencies": {
-    "@oclif/test": "^2.3.0",
-    "@swc/cli": "^0.1.61",
-    "@swc/core": "^1.3.29",
+    "@oclif/test": "^2.3.6",
+    "@swc/cli": "^0.1.62",
+    "@swc/core": "^1.3.36",
     "@swc/helpers": "^0.4.14",
     "@types/chai": "^4",
     "@types/fs-extra": "^9.0.13",
     "@types/mocha": "^9.0.0",
-    "@types/node": "^16.18.11",
+    "@types/node": "^16.18.12",
     "chai": "^4",
     "eslint": "^7.32.0",
     "eslint-config-oclif": "^4",
@@ -47,13 +48,13 @@
     "mocha": "^9",
     "nock": "^13.3.0",
     "oclif": "^3",
-    "prettier": "2.8.3",
+    "prettier": "2.8.4",
     "shx": "^0.3.4",
     "sinon": "^15.0.1",
     "ts-node": "^10.9.1",
     "tsconfig-paths": "^4.1.2",
     "tslib": "^2.5.0",
-    "typescript": "^4.9.4"
+    "typescript": "^4.9.5"
   },
   "oclif": {
     "bin": "knock",