@knocklabs/cli 1.1.1 → 1.2.2

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

@@ -157,7 +157,7 @@ const scaffoldInAppFeedChannelStep = (refSuffix, channels)=>{
     const scaffoldedStep = {
         ref: stepRef,
         type: _types.StepType.Channel,
-        channel_key: firstChannel ? firstChannel.key : "<IN-APP-FEED CHANNEL KEY>",
+        channel_key: firstChannel ? firstChannel.key : "<IN_APP_FEED CHANNEL KEY>",
         template: {
             action_url: "{{ vars.app_url }}",
             ["markdown_body" + _constisomorphic.FILEPATH_MARKER]: templateFilePath
@@ -239,7 +239,7 @@ const STEP_TAGS = [
     "batch",
     "fetch",
     "email",
-    "in-app-feed",
+    "in_app_feed",
     "sms",
     "push",
     "chat"
@@ -249,7 +249,7 @@ const StepTagChoices = {
     batch: "Batch step",
     fetch: "HTTP Fetch step",
     email: "Email channel step",
-    "in-app-feed": "In-app feed channel step",
+    in_app_feed: "In-app feed channel step",
     sms: "SMS channel step",
     push: "Push channel step",
     chat: "Chat channel step"
@@ -261,13 +261,16 @@ const stepScaffoldFuncs = {
     fetch: scaffoldHttpFetchStep,
     // Channel steps
     email: scaffoldEmailChannelStep,
-    "in-app-feed": scaffoldInAppFeedChannelStep,
+    in_app_feed: scaffoldInAppFeedChannelStep,
     sms: scaffoldSmsChannelStep,
     push: scaffoldPushChannelStep,
     chat: scaffoldChatChannelStep
 };
+// Accept "in-app-feed" for backward compatibility, but normalize to the snake
+// case one as the canonical tag.
+const normalizeStepTag = (tag)=>tag === "in-app-feed" ? "in_app_feed" : tag;
 const parseStepsInput = (input, availableStepTypes)=>{
-    const tags = input.split(",").filter((x)=>x);
+    const tags = input.split(",").filter((x)=>x).map((tag)=>normalizeStepTag(tag));
     const invalidTags = tags.filter((tag)=>!availableStepTypes.includes(tag));
     if (invalidTags.length > 0) {
         return [
@@ -286,7 +289,7 @@ const getAvailableStepTypes = (channelTypes)=>{
         switch(stepTag){
             case "email":
                 return channelTypes.includes("email");
-            case "in-app-feed":
+            case "in_app_feed":
                 return channelTypes.includes("in_app_feed");
             case "sms":
                 return channelTypes.includes("sms");
@@ -310,12 +313,11 @@ const scaffoldWorkflowDirBundle = (attrs, channelsByType)=>{
         const stepCount = ++stepCountByTag[tag];
         switch(tag){
             case "email":
+            case "in_app_feed":
             case "sms":
             case "push":
             case "chat":
                 return stepScaffoldFuncs[tag](stepCount, (0, _lodash.get)(channelsByType, tag, []));
-            case "in-app-feed":
-                return stepScaffoldFuncs[tag](stepCount, (0, _lodash.get)(channelsByType, "in_app_feed", []));
             default:
                 return stepScaffoldFuncs[tag](stepCount);
         }
@@ -348,6 +350,7 @@ function swapChannelReferences(step, channelsByType) {
                 ...step,
                 channel_key: (_channelsByType_email_ = channelsByType.email[0]) === null || _channelsByType_email_ === void 0 ? void 0 : _channelsByType_email_.key
             };
+        case "in_app_feed":
         case "in-app-feed":
         case "knock-in-app-feed":
         case "knock-feed":

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

@@ -24,6 +24,9 @@ _export(exports, {
     get formatStepSummary () {
         return formatStepSummary;
     },
+    get formatTags () {
+        return formatTags;
+    },
     get generateWorkflowTypes () {
         return generateWorkflowTypes;
     },
@@ -106,13 +109,14 @@ const lsWorkflowJson = async (dirPath)=>{
     return exists ? workflowJsonPath : undefined;
 };
 const isWorkflowDir = async (dirPath)=>Boolean(await lsWorkflowJson(dirPath));
-const formatCategories = (workflow, opts = {})=>{
-    const { categories } = workflow;
+const formatCategories = (workflow, opts = {})=>formatStringList(workflow.categories, opts);
+const formatTags = (workflow, opts = {})=>formatStringList(workflow.tags, opts);
+const formatStringList = (items, opts = {})=>{
     const { truncateAfter: limit, emptyDisplay = "" } = opts;
-    if (!categories) return emptyDisplay;
-    const count = categories.length;
-    if (!limit || limit >= count) return categories.join(", ");
-    return (0, _lodash.take)(categories, limit).join(", ") + ` (+ ${count - limit} more)`;
+    if (!items) return emptyDisplay;
+    const count = items.length;
+    if (!limit || limit >= count) return items.join(", ");
+    return (0, _lodash.take)(items, limit).join(", ") + ` (+ ${count - limit} more)`;
 };
 /*
  * Returns a formatted string of workflow steps.

package/dist/lib/resources.js

@@ -9,6 +9,9 @@ function _export(target, all) {
     });
 }
 _export(exports, {
+    get ALLOW_EMPTY_RESOURCE_TYPES () {
+        return ALLOW_EMPTY_RESOURCE_TYPES;
+    },
     get ALL_RESOURCE_TYPES () {
         return ALL_RESOURCE_TYPES;
     },
@@ -16,6 +19,14 @@ _export(exports, {
         return RESOURCE_SUBDIRS;
     }
 });
+const ALLOW_EMPTY_RESOURCE_TYPES = [
+    "partial",
+    "email_layout",
+    "workflow",
+    "message_type",
+    "guide",
+    "translation"
+];
 const ALL_RESOURCE_TYPES = [
     // Audiences can be referenced by workflows, so push them early
     "audience",