@cowliss/cli 0.5.0 → 0.7.0

package/dist/guest/journeys.d.ts

@@ -1,11 +1,11 @@
-import { n as Duration, r as GuestEvent, t as Trigger } from "./index-BDj02EsQ.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;
 /**
  * A profile as the capability layer hands it back: the recipient of this
- * execution (`api.profile.get()`) or another profile in the same org and
- * environment (`api.profiles.get(id)`). A fresh read on every call.
+ * execution (`api.profile.get()`) or another profile in the same org
+ * (`api.profiles.get(id)`). A fresh read on every call.
  */
 type Profile = {
   /** The Cowliss-generated profile id (`usr_`). */
@@ -23,7 +23,7 @@ type EmailSendResult = {
   status: string;
 };
 /**
- * A capability that failed host-side (an unknown destination, invalid
+ * A capability that failed host-side (an unknown webhook, invalid
  * props, a profile that is not there). The failure is journaled, so a
  * journey that catches it takes the same branch on every replay.
  */
@@ -68,11 +68,16 @@ type Api = {
       template: Key;
       props: TemplateProps<Key>;
       /**
-       * Send this one mail from a different sender identity than the
-       * journey's own. A name the organization has configured, resolved in
-       * the environment the execution is running in.
+       * Send this one mail from a different address than the journey's own:
+       * `"billing@acme.com"` or `"Billing <billing@acme.com>"`. The domain
+       * must be one your organization has verified, or the send is skipped.
        */
-      senderIdentity?: string;
+      from?: string;
+      /**
+       * Where a reply to this one mail goes, instead of the from-address.
+       * Any address: nothing is sent from it.
+       */
+      replyTo?: string;
     }): Promise<EmailSendResult>;
     webhook(args: {
       destination: string;
@@ -116,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;
   /**
-   * The sender identity every `api.send.email` in this journey goes out as:
-   * the name of one your organization has configured, or `cowliss-default`
-   * for the address Cowliss gives you with nothing to set up. A single send
+   * 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.
    *
-   * Required, and named here rather than in a settings page, so the address
-   * a journey sends from is readable in the journey's own source. It is
-   * resolved per environment, which is why it is a name and not an id.
+   * 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.
    */
-  senderIdentity: string;
+  from: string;
   /** The author's labels; the dashboard's only grouping. Defaults to none. */
   tags: string[];
 };
@@ -141,13 +165,18 @@ type Journey = JourneyConfig & {
 /**
  * Author a journey. Throws at definition time on an invalid config.
  *
- * There is no environment gate here: a journey runs wherever it is enabled,
- * and nowhere else (ADR 0011). A source that still passes `environments` is
- * a typecheck error in `cow build`, which is where the author can fix it.
+ * There is no environment gate here: an organization has one data space, and
+ * 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-C8j8Sqvl.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-14FnzM-h.js";
+import { t as runGuest } from "./driver-C1bsCjZT.js";
 
 //#region src/guest/wasi.ts
 const STDIN = 0;