@cowliss/cli 0.6.0 → 0.8.0

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

@@ -6,12 +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",
+  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/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,7 +28,10 @@ import { defineJourney } from "@cowliss/cli/journeys";
  */
 export default defineJourney({
   trigger: { event: "*" },
-  purpose: "emailMarketing",
+  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/winback/journeys/winback.ts

@@ -4,14 +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",
+  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/package.json

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

package/examples/cross-app-pitch/emails/cross-app-pitch.tsx

@@ -1,77 +0,0 @@
-import type { SendClass, Subject } from "@cowliss/cli/emails";
-import {
-  Body,
-  Container,
-  Head,
-  Heading,
-  Html,
-  Preview,
-  Text,
-} from "@react-email/components";
-import type { CSSProperties, ReactElement } from "react";
-import { z } from "zod";
-
-/**
- * The cross-app-pitch example's one email: someone upgraded in one of your
- * apps, and a day later the other app is worth a mention. The plan name is a
- * prop rather than a hardcoded string, so the same email serves every tier
- * you pitch.
- *
- * Inline styles only, because email clients strip Tailwind and external
- * stylesheets alike. One-click unsubscribe rides in the RFC 8058 headers the
- * send path attaches, not in the body.
- */
-
-export const props = z.object({
-  plan: z.string(),
-});
-
-export const subject: Subject<typeof props> = (p) =>
-  `Your ${p.plan} plan works in our other app too`;
-
-export const sendClass: SendClass = "marketing";
-
-export const tags = ["demo", "cross-app"];
-
-const body: CSSProperties = {
-  backgroundColor: "#f6f6f6",
-  fontFamily: "-apple-system, BlinkMacSystemFont, 'Segoe UI', sans-serif",
-};
-
-const container: CSSProperties = {
-  margin: "0 auto",
-  padding: "32px 24px",
-  maxWidth: "480px",
-  backgroundColor: "#ffffff",
-};
-
-const heading: CSSProperties = {
-  fontSize: "20px",
-  fontWeight: 600,
-  color: "#111111",
-};
-
-const text: CSSProperties = {
-  fontSize: "14px",
-  lineHeight: "22px",
-  color: "#333333",
-};
-
-export default function CrossAppPitch(p: z.infer<typeof props>): ReactElement {
-  return (
-    <Html>
-      <Head />
-      <Preview>One upgrade, two apps</Preview>
-      <Body style={body}>
-        <Container style={container}>
-          <Heading style={heading}>One upgrade, two apps</Heading>
-          <Text style={text}>
-            Thanks for going {p.plan}. The same account already works in our
-            other app, so there is nothing to sign up for: open it and your plan
-            follows you.
-          </Text>
-        </Container>
-      </Body>
-    </Html>
-  );
-}

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

@@ -1,34 +0,0 @@
-import { defineJourney } from "@cowliss/cli/journeys";
-
-/**
- * Cross-app pitch: `plan_upgraded` from one app (the trigger's `appId` field
- * scopes a journey to one app of a multi-app org) starts the execution; after
- * a durable day it re-reads the profile and pitches the other app only to
- * users still on the free plan. This is the portfolio-operator pattern: one
- * org's journeys reacting across its own apps.
- *
- * 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",
-  // 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");
-    // A fresh read, not a snapshot taken at the trigger: the plan may well
-    // have changed during the wait, which is the whole point of waiting.
-    const me = await api.profile.get();
-    if (me.traits.plan !== "free") {
-      return;
-    }
-    await api.send.email({
-      template: "cross-app-pitch",
-      props: { plan: "pro" },
-    });
-  },
-});

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

@@ -1,17 +0,0 @@
-{
-  "user": {
-    "id": "usr_1",
-    "traits": { "email": "ada@example.com", "plan": "free" }
-  },
-  "events": [],
-  "expect": [
-    {
-      "activity": "sendEmail",
-      "input": {
-        "template": "cross-app-pitch",
-        "props": { "plan": "pro" },
-        "from": "Product News <product-news@example.com>"
-      }
-    }
-  ]
-}