@cowliss/cli 0.6.0 → 0.7.0

package/dist/guest/journeys.d.ts

@@ -1,4 +1,4 @@
-import { n as Duration, r as GuestEvent, t as Trigger } from "./index-CXcCEcAg.js";
+import { i as GuestEvent, n as Trigger, r as TriggerInput, t as Duration } from "./index-3PMqJKmc.js";
 //#region src/guest/journeys.d.ts
 /** The event a journey runs for, or the one a `waitForEvent` resolved with. */
 type Event = GuestEvent;
@@ -121,22 +121,41 @@ type Api = {
 type JourneyConfig = {
   trigger: Trigger;
   /**
-   * A fixed purpose (`emailMarketing`, `dataProcessing`) or one this
-   * project declares in `cow.json`. The key's shape is checked here; that
-   * the org declares it is checked when the release is deployed.
+   * Why this journey contacts someone: `marketing`, `transactional`, or a
+   * purpose this project declares in `cow.json`. The key's shape is checked
+   * here; that the org declares it is checked when the release is deployed.
    */
   purpose: string;
+  /**
+   * How often one recipient may enter this journey. A marketing journey
+   * enrolls each recipient once, ever; give it a `cooldown` and it re-opens
+   * that long after their last completed run. A transactional journey
+   * enrolls on every trigger — three orders are three receipts — so it
+   * takes no cooldown and `cow build` refuses one.
+   *
+   * History counts: adding a cooldown to a journey that has been running
+   * for months measures from runs that already completed.
+   */
+  enrollment?: {
+    cooldown: Duration;
+  };
+  /**
+   * One plain sentence saying what this journey does for the person who
+   * gets it. Shown wherever the journey is read. Optional; at most 500
+   * characters.
+   */
+  description?: string;
   /**
    * The address every `api.send.email` in this journey goes out as:
    * `"billing@acme.com"` or `"Billing <billing@acme.com>"`. A single send
    * can override it.
    *
-   * Optional: leave it out and Cowliss sends from the address it gives your
-   * organization, with nothing to set up. Named here rather than in a
-   * settings page, so the address a journey sends from is readable in the
-   * journey's own source.
+   * Required, on a domain your organization has verified: there is no
+   * address Cowliss lends you. Named here rather than in a settings page,
+   * so the address a journey sends from is readable in the journey's own
+   * source.
    */
-  from?: string;
+  from: string;
   /** The author's labels; the dashboard's only grouping. Defaults to none. */
   tags: string[];
 };
@@ -147,11 +166,17 @@ type Journey = JourneyConfig & {
  * Author a journey. Throws at definition time on an invalid config.
  *
  * There is no environment gate here: an organization has one data space, and
- * a journey runs wherever it is enabled and nowhere else (ADR 0011, ADR 0013).
+ * a journey runs wherever it is on and nowhere else (ADR 0011, ADR 0013).
  */
-declare function defineJourney(input: Omit<JourneyConfig, "tags"> & {
+declare function defineJourney(input: Omit<JourneyConfig, "tags" | "trigger"> & {
+  /**
+   * What starts it: `{ event }`, or `{ segment }` carrying the predicate
+   * list of the segment this journey enrolls from. Written form, so a
+   * predicate can leave `match` and `atLeast` out.
+   */
+  trigger: TriggerInput;
   tags?: string[];
   run: (event: Event, api: Api) => Promise<void>;
 }): Journey;
 //#endregion
-export { Api, CapabilityError, CowTemplates, type Duration, EmailSendResult, Event, Journey, JourneyConfig, Profile, type Trigger, defineJourney };
+export { Api, CapabilityError, CowTemplates, type Duration, EmailSendResult, Event, Journey, JourneyConfig, Profile, type Trigger, type TriggerInput, defineJourney };

package/dist/guest/journeys.js

@@ -1,3 +1,3 @@
-import { n as defineJourney, t as CapabilityError } from "./journeys-BrcKEXz0.js";
+import { n as defineJourney, t as CapabilityError } from "./journeys-Dpsp225V.js";
 
 export { CapabilityError, defineJourney };

package/dist/guest/wasi.js

@@ -1,4 +1,4 @@
-import { t as runGuest } from "./driver-DBt5l1Z5.js";
+import { t as runGuest } from "./driver-C1bsCjZT.js";
 
 //#region src/guest/wasi.ts
 const STDIN = 0;