npm - @cowliss/cli - Versions diffs - 0.1.0 - Mend

@cowliss/cli 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (31) hide show

package/LICENSE +21 -0
package/README.md +105 -0
package/dist/guest/constants-OZrYz4I2.d.ts +42 -0
package/dist/guest/driver-BOe7jBFw.js +5647 -0
package/dist/guest/driver.d.ts +21 -0
package/dist/guest/driver.js +3 -0
package/dist/guest/emails.d.ts +24 -0
package/dist/guest/emails.js +0 -0
package/dist/guest/index-heC1gFE_.d.ts +296 -0
package/dist/guest/journeys-CxuS-mHn.js +571 -0
package/dist/guest/journeys.d.ts +127 -0
package/dist/guest/journeys.js +3 -0
package/dist/guest/prelude.d.ts +1 -0
package/dist/guest/prelude.js +91 -0
package/dist/guest/wasi.d.ts +6 -0
package/dist/guest/wasi.js +43 -0
package/dist/index.js +11235 -0
package/examples/abandoned-checkout/emails/abandoned-checkout.tsx +104 -0
package/examples/abandoned-checkout/journeys/abandoned-checkout.ts +39 -0
package/examples/abandoned-checkout/scenarios/abandoned-checkout.recovered.json +10 -0
package/examples/abandoned-checkout/scenarios/abandoned-checkout.timeout.json +16 -0
package/examples/activity-decay/journeys/activity-decay.ts +36 -0
package/examples/activity-decay/scenarios/activity-decay.json +8 -0
package/examples/cross-app-pitch/emails/cross-app-pitch.tsx +77 -0
package/examples/cross-app-pitch/journeys/cross-app-pitch.ts +30 -0
package/examples/cross-app-pitch/scenarios/cross-app-pitch.json +16 -0
package/examples/winback/emails/winback.tsx +78 -0
package/examples/winback/journeys/winback.ts +33 -0
package/examples/winback/scenarios/winback.json +18 -0
package/package.json +82 -0
package/project/tsconfig.json +18 -0

package/examples/abandoned-checkout/emails/abandoned-checkout.tsx ADDED Viewed

@@ -0,0 +1,104 @@
+import type { SendClass, Subject } from "@cowliss/cli/emails";
+import {
+  Body,
+  Button,
+  Container,
+  Head,
+  Heading,
+  Html,
+  Preview,
+  Text,
+} from "@react-email/components";
+import type { CSSProperties, ReactElement } from "react";
+import { z } from "zod";
+/**
+ * The abandoned-checkout example's one email: a checkout opened, the 24-hour
+ * window closed without a purchase, so this is the single reminder the
+ * journey spends. Short and plain on purpose.
+ *
+ * No unsubscribe link in the body: one-click unsubscribe rides in the RFC
+ * 8058 headers the send path attaches, not the template. Inline styles only,
+ * because email clients strip Tailwind and external stylesheets alike.
+ *
+ * `checkoutUrl` belongs to your own store, so the journey supplies it and the
+ * button is simply omitted when it is absent; a hardcoded link here would
+ * send every org's users to the same place.
+ */
+export const props = z.object({
+  checkoutUrl: z.url().optional(),
+  firstName: z.string().optional(),
+});
+export const subject: Subject<typeof props> = (p) =>
+  p.firstName
+    ? `${p.firstName}, you left something in your cart`
+    : "You left something in your cart";
+export const sendClass: SendClass = "marketing";
+export const tags = ["demo", "checkout"];
+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",
+};
+const button: CSSProperties = {
+  display: "inline-block",
+  marginTop: "16px",
+  padding: "10px 20px",
+  borderRadius: "6px",
+  backgroundColor: "#111111",
+  color: "#ffffff",
+  fontSize: "14px",
+  fontWeight: 600,
+  textDecoration: "none",
+};
+export default function AbandonedCheckout(
+  p: z.infer<typeof props>,
+): ReactElement {
+  return (
+    <Html>
+      <Head />
+      <Preview>You left something in your cart</Preview>
+      <Body style={body}>
+        <Container style={container}>
+          <Heading style={heading}>
+            {p.firstName ? `Hi ${p.firstName},` : "Hi there,"}
+          </Heading>
+          <Text style={text}>
+            You started checking out but didn&apos;t finish. Your cart is still
+            here, and it only takes a moment to pick up where you left off.
+          </Text>
+          {p.checkoutUrl ? (
+            <Button style={button} href={p.checkoutUrl}>
+              Finish checkout
+            </Button>
+          ) : null}
+        </Container>
+      </Body>
+    </Html>
+  );
+}

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

@@ -0,0 +1,39 @@
+import { defineJourney } from "@cowliss/cli/journeys";
+/**
+ * Abandoned-checkout recovery: `checkout_started` opens a 24-hour window. A
+ * `purchase_completed` inside it closes the window quietly and marks the cart
+ * recovered, a trait your segments and other journeys can read. Silence
+ * spends exactly one reminder email and closes.
+ *
+ * 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",
+  tags: ["demo", "checkout"],
+  run: async (event, api) => {
+    const purchased = await api.waitForEvent("purchase_completed", {
+      timeout: "24h",
+    });
+    if (purchased) {
+      await api.traits.set("cart_recovered", true);
+      return;
+    }
+    // The checkout link belongs to your store, so the trigger event carries
+    // it; the email drops its button when the prop is missing.
+    const checkoutUrl = event.properties.checkoutUrl;
+    const me = await api.profile.get();
+    await api.email.send({
+      template: "abandoned-checkout",
+      props: {
+        checkoutUrl: typeof checkoutUrl === "string" ? checkoutUrl : undefined,
+        firstName:
+          typeof me.traits.firstName === "string"
+            ? me.traits.firstName
+            : undefined,
+      },
+    });
+  },
+});

package/examples/abandoned-checkout/scenarios/abandoned-checkout.recovered.json ADDED Viewed

@@ -0,0 +1,10 @@
+{
+  "user": { "id": "usr_1", "traits": { "email": "ada@example.com" } },
+  "events": [{ "at": "1h", "event": "purchase_completed" }],
+  "expect": [
+    {
+      "activity": "setTrait",
+      "input": { "key": "cart_recovered", "value": true }
+    }
+  ]
+}

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

@@ -0,0 +1,16 @@
+{
+  "user": {
+    "id": "usr_1",
+    "traits": { "email": "ada@example.com", "firstName": "Ada" }
+  },
+  "events": [],
+  "expect": [
+    {
+      "activity": "sendEmail",
+      "input": {
+        "template": "abandoned-checkout",
+        "props": { "firstName": "Ada" }
+      }
+    }
+  ]
+}

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

@@ -0,0 +1,36 @@
+import { defineJourney } from "@cowliss/cli/journeys";
+/**
+ * Timer decay: "active in the last 30 days" as a per-user journey instead of
+ * a nightly sweep. The trigger sets the flag and the execution waits; every
+ * 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.
+ *
+ * `"*"` is activity as it really arrives: whatever names your apps send,
+ * page_view and purchase and login alike. It never matches an event Cowliss
+ * wrote itself (those are all under `system.`), which is what stops the
+ * trait write below from flipping a segment whose entry event restarts this
+ * journey, forever.
+ *
+ * Example: add it with `cow add example activity-decay`; rename the trait to
+ * your domain's vocabulary, or narrow the pattern (`checkout.*`, or a list)
+ * if only some events should count as activity.
+ */
+export default defineJourney({
+  trigger: { event: "*" },
+  purpose: "emailMarketing",
+  tags: ["demo", "retention"],
+  run: async (_event, api) => {
+    await api.traits.set("active_30d", true);
+    const active = await api.waitForEvent("*", { timeout: "30d" });
+    if (active) {
+      // This is the loop, and it is bounded: restart ends this execution and
+      // starts a fresh one under the same workflow id with an empty journal,
+      // so a user who stays active for years never grows one.
+      await api.restart({ event: active });
+    }
+    await api.traits.unset("active_30d");
+  },
+});

package/examples/activity-decay/scenarios/activity-decay.json ADDED Viewed

@@ -0,0 +1,8 @@
+{
+  "user": { "id": "usr_1", "traits": {} },
+  "events": [{ "at": "10d", "event": "page_view" }],
+  "expect": [
+    { "activity": "setTrait", "input": { "key": "active_30d", "value": true } },
+    { "activity": "restart" }
+  ]
+}

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

@@ -0,0 +1,77 @@
+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 ADDED Viewed

@@ -0,0 +1,30 @@
+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",
+  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.email.send({
+      template: "cross-app-pitch",
+      props: { plan: "pro" },
+    });
+  },
+});

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

@@ -0,0 +1,16 @@
+{
+  "user": {
+    "id": "usr_1",
+    "traits": { "email": "ada@example.com", "plan": "free" }
+  },
+  "events": [],
+  "expect": [
+    {
+      "activity": "sendEmail",
+      "input": {
+        "template": "cross-app-pitch",
+        "props": { "plan": "pro" }
+      }
+    }
+  ]
+}

package/examples/winback/emails/winback.tsx ADDED Viewed

@@ -0,0 +1,78 @@
+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 winback example's one email, sent at the moment 30 days of silence
+ * make a customer lapsed. No discount and no urgency: the journey already
+ * knows this person bought before, so the job is a reminder, not a 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({
+  firstName: z.string().optional(),
+});
+export const subject: Subject<typeof props> = (p) =>
+  p.firstName ? `${p.firstName}, we miss you` : "We miss you";
+export const sendClass: SendClass = "marketing";
+export const tags = ["demo", "retention"];
+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 Winback(p: z.infer<typeof props>): ReactElement {
+  return (
+    <Html>
+      <Head />
+      <Preview>It has been a while</Preview>
+      <Body style={body}>
+        <Container style={container}>
+          <Heading style={heading}>
+            {p.firstName ? `Hi ${p.firstName},` : "Hi there,"}
+          </Heading>
+          <Text style={text}>
+            It has been a month since your last order. Nothing has changed about
+            how easy it is to come back, and we kept your details where you left
+            them.
+          </Text>
+        </Container>
+      </Body>
+    </Html>
+  );
+}

package/examples/winback/journeys/winback.ts ADDED Viewed

@@ -0,0 +1,33 @@
+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.
+ *
+ * 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",
+  tags: ["demo", "retention"],
+  run: async (_event, api) => {
+    await api.traits.set("purchased_recently", true);
+    while (await api.waitForEvent("purchase_completed", { timeout: "30d" })) {
+      // Another purchase inside 30 days: loop to reset the silence timer.
+    }
+    await api.traits.unset("purchased_recently");
+    const me = await api.profile.get();
+    await api.email.send({
+      template: "winback",
+      props: {
+        firstName:
+          typeof me.traits.firstName === "string"
+            ? me.traits.firstName
+            : undefined,
+      },
+    });
+  },
+});

package/examples/winback/scenarios/winback.json ADDED Viewed

@@ -0,0 +1,18 @@
+{
+  "user": {
+    "id": "usr_1",
+    "traits": { "email": "ada@example.com", "firstName": "Ada" }
+  },
+  "events": [
+    { "at": "10d", "event": "purchase_completed" },
+    { "at": "25d", "event": "purchase_completed" }
+  ],
+  "expect": [
+    {
+      "activity": "setTrait",
+      "input": { "key": "purchased_recently", "value": true }
+    },
+    { "activity": "unsetTrait", "input": { "key": "purchased_recently" } },
+    { "activity": "sendEmail", "input": { "template": "winback" } }
+  ]
+}

package/package.json ADDED Viewed

@@ -0,0 +1,82 @@
+{
+  "name": "@cowliss/cli",
+  "version": "0.1.0",
+  "type": "module",
+  "bin": {
+    "cow": "./dist/index.js"
+  },
+  "exports": {
+    "./journeys": {
+      "types": "./dist/guest/journeys.d.ts",
+      "default": "./dist/guest/journeys.js"
+    },
+    "./emails": {
+      "types": "./dist/guest/emails.d.ts",
+      "default": "./dist/guest/emails.js"
+    },
+    "./guest": {
+      "types": "./dist/guest/driver.d.ts",
+      "default": "./dist/guest/driver.js"
+    },
+    "./guest-wasi": {
+      "types": "./dist/guest/wasi.d.ts",
+      "default": "./dist/guest/wasi.js"
+    },
+    "./guest-prelude": {
+      "types": "./dist/guest/prelude.d.ts",
+      "default": "./dist/guest/prelude.js"
+    },
+    "./tsconfig.json": "./project/tsconfig.json",
+    "./package.json": "./package.json"
+  },
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.29.0",
+    "commander": "^14.0.1",
+    "esbuild": "^0.28.2",
+    "tar": "^7.5.22",
+    "zod": "^4.4.3"
+  },
+  "devDependencies": {
+    "@cowliss/api-client": "0.0.0",
+    "@cowliss/shared": "0.0.0",
+    "@react-email/components": "^1.0.12",
+    "@types/html-to-text": "^9.0.4",
+    "@types/node": "^26.2.0",
+    "@types/react": "^19.2.7",
+    "@types/react-dom": "^19.2.3",
+    "html-to-text": "^9.0.5",
+    "react": "^19.2.8",
+    "react-dom": "^19.2.8",
+    "tsdown": "^0.22.14",
+    "tsx": "^4.23.12",
+    "vitest": "^4.1.11"
+  },
+  "files": [
+    "dist",
+    "project",
+    "examples",
+    "LICENSE",
+    "README.md"
+  ],
+  "description": "Admin CLI, project workflow and MCP server for Cowliss.",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/bogdanrn/cowliss.git",
+    "directory": "apps/cli"
+  },
+  "homepage": "https://docs.cowliss.com",
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=22"
+  },
+  "scripts": {
+    "start": "tsx src/index.ts",
+    "build": "tsdown",
+    "typecheck": "tsc -b tsconfig.json",
+    "test": "vitest run",
+    "pretest": "tsdown"
+  }
+}

package/project/tsconfig.json ADDED Viewed

@@ -0,0 +1,18 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "compilerOptions": {
+    "target": "ES2023",
+    "lib": ["ES2023"],
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "jsx": "react-jsx",
+    "strict": true,
+    "noUncheckedIndexedAccess": true,
+    "skipLibCheck": true,
+    "isolatedModules": true,
+    "verbatimModuleSyntax": true,
+    "resolveJsonModule": true,
+    "noEmit": true,
+    "types": []
+  }
+}