@cowliss/cli 0.5.0 → 0.7.0

package/examples/abandoned-checkout/journeys/abandoned-checkout.ts

@@ -6,13 +6,20 @@ import { defineJourney } from "@cowliss/cli/journeys";
  * recovered, a trait your segments and other journeys can read. Silence
  * spends exactly one reminder email and closes.
  *
+ * `marketing` and no `enrollment`, so one shopper goes through this once,
+ * ever: their second abandoned cart is not nagged about. Add
+ * `enrollment: { cooldown: "30d" }` to reach a repeat abandoner again, a
+ * month after their last reminder.
+ *
  * Example: add it with `cow add example abandoned-checkout`; rename the
  * events and the email to your domain's vocabulary.
  */
 export default defineJourney({
   trigger: { event: "checkout_started" },
-  purpose: "emailMarketing",
-  senderIdentity: "cowliss-default",
+  purpose: "marketing",
+  from: "Acme <checkout@example.com>",
+  description:
+    "Reminds someone who left items in their cart, and stops if they buy.",
   tags: ["demo", "checkout"],
   run: async (event, api) => {
     const purchased = await api.waitForEvent("purchase_completed", {

package/examples/abandoned-checkout/scenarios/abandoned-checkout.timeout.json

@@ -9,8 +9,7 @@
       "activity": "sendEmail",
       "input": {
         "template": "abandoned-checkout",
-        "props": { "firstName": "Ada" },
-        "senderIdentity": "cowliss-default"
+        "props": { "firstName": "Ada" }
       }
     }
   ]

package/examples/activity-decay/journeys/activity-decay.ts

@@ -6,7 +6,15 @@ import { defineJourney } from "@cowliss/cli/journeys";
  * later event restarts the execution, which resets the 30-day silence clock
  * with a fresh, empty journal; 30 days of silence unsets the flag (removed,
  * not set to false, so `exists` predicates stop matching) and the execution
- * completes. The next event starts a new one.
+ * completes.
+ *
+ * Restarting is not finishing, so a user who keeps showing up never counts
+ * as having been through this journey and the loop runs for as long as they
+ * do. The execution that ends after 30 days of silence does count, and with
+ * `marketing` and no `enrollment` that is the end of it: their next event
+ * does not re-flag them. A journey meant to track state for the life of an
+ * account wants to reopen as soon as it closes, which is what
+ * `enrollment: { cooldown: "1s" }` says.
  *
  * `"*"` is activity as it really arrives: whatever names your apps send,
  * page_view and purchase and login alike. It never matches an event Cowliss
@@ -20,8 +28,10 @@ import { defineJourney } from "@cowliss/cli/journeys";
  */
 export default defineJourney({
   trigger: { event: "*" },
-  purpose: "emailMarketing",
-  senderIdentity: "cowliss-default",
+  purpose: "marketing",
+  from: "Acme <hello@example.com>",
+  description:
+    "Keeps track of whether someone has been active in the last 30 days.",
   tags: ["demo", "retention"],
   run: async (_event, api) => {
     await api.traits.set("active_30d", true);

package/examples/cross-app-pitch/journeys/cross-app-pitch.ts

@@ -7,16 +7,21 @@ import { defineJourney } from "@cowliss/cli/journeys";
  * users still on the free plan. This is the portfolio-operator pattern: one
  * org's journeys reacting across its own apps.
  *
+ * `marketing` and no `enrollment`: one pitch per person, however often they
+ * change plan. A pitch is worth making once.
+ *
  * Example: add it with `cow add example cross-app-pitch`; rename the app id,
  * the event, and the email to your own.
  */
 export default defineJourney({
   trigger: { event: "plan_upgraded", appId: "app_b" },
-  purpose: "emailMarketing",
-  // A named identity rather than the default: a pitch for your other product
-  // reads better from a product address than from the one your receipts come
-  // from. Create it under Settings, Domains, sender identities.
-  senderIdentity: "product-news",
+  purpose: "marketing",
+  description:
+    "Tells someone who just upgraded about the other product they can use.",
+  // An address of its own rather than the shared one: a pitch for your other
+  // product reads better from a product address than from the one your
+  // receipts come from. Verify its domain under Settings, Domains first.
+  from: "Product News <product-news@example.com>",
   tags: ["demo", "cross-app"],
   run: async (_event, api) => {
     await api.sleep("1d");

package/examples/cross-app-pitch/scenarios/cross-app-pitch.json

@@ -10,7 +10,7 @@
       "input": {
         "template": "cross-app-pitch",
         "props": { "plan": "pro" },
-        "senderIdentity": "product-news"
+        "from": "Product News <product-news@example.com>"
       }
     }
   ]

package/examples/winback/journeys/winback.ts

@@ -4,15 +4,22 @@ import { defineJourney } from "@cowliss/cli/journeys";
  * Winback: `purchase_completed` starts (or restarts) an execution and marks
  * the profile as having bought recently; every further purchase inside 30
  * days resets the silence clock; after 30 days of silence the flag is unset
- * and one winback email goes out. The next purchase starts a fresh execution.
+ * and one winback email goes out.
+ *
+ * `marketing` and no `enrollment`, so each customer is won back once, ever:
+ * the purchase that answers the email does not start a second execution.
+ * That is the safe default for a mail nobody asked for. To win the same
+ * customer back every time they lapse, say how long to leave between
+ * attempts: `enrollment: { cooldown: "180d" }`.
  *
  * Example: add it with `cow add example winback`; rename the purchase event,
  * the flag trait, and the email to your domain's vocabulary.
  */
 export default defineJourney({
   trigger: { event: "purchase_completed" },
-  purpose: "emailMarketing",
-  senderIdentity: "cowliss-default",
+  purpose: "marketing",
+  from: "Acme <hello@example.com>",
+  description: "Invites a customer back after 30 days without a purchase.",
   tags: ["demo", "retention"],
   run: async (_event, api) => {
     await api.traits.set("purchased_recently", true);

package/examples/winback/scenarios/winback.json

@@ -15,7 +15,7 @@
     { "activity": "unsetTrait", "input": { "key": "purchased_recently" } },
     {
       "activity": "sendEmail",
-      "input": { "template": "winback", "senderIdentity": "cowliss-default" }
+      "input": { "template": "winback" }
     }
   ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cowliss/cli",
-  "version": "0.5.0",
+  "version": "0.7.0",
   "type": "module",
   "bin": {
     "cow": "./dist/index.js"