@cowliss/sdk 0.18.1 → 0.20.0

package/CHANGELOG.md

@@ -4,6 +4,19 @@
 
 What changed in each version of `@cowliss/sdk` after 0.16.0, newest first. Earlier versions are listed on [npm](https://www.npmjs.com/package/@cowliss/sdk?activeTab=versions).
 
+## 0.20.0 (2026-10-02)
+
+### Features
+
+- cow.templates.preview renders a template with your own props
+
+## 0.19.0 (2026-10-02)
+
+### Features
+
+- emails.send takes an idempotencyKey and creates the person it emails
+- cow.preferences.get and set, the hosted preferences page as data
+
 ## 0.18.1 (2026-10-01)
 
 ### Fixes

package/README.md

@@ -60,6 +60,13 @@ delivery id. A message to a profile goes to its `email` trait, skips anyone
 who turned that purpose off, and carries an unsubscribe link. Mail that
 follows a rule or a wait belongs in a journey.
 
+Render a pushed template with your own props, exactly as a send to an address
+would, without sending it:
+
+```ts
+const { subject, html } = await cow.templates.preview({ key: "receipt", props: { name: "Ada" } });
+```
+
 Send someone to their hosted email preferences page from your own "Manage
 email preferences" button. The link works for an hour, so ask for it on the
 click:

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import type { BatchBody, BatchResultDto, ErrorCode, EventDto, IdentifyInput, PreferencesLink, PreferencesLinkInput, ProfileDto, SendEmailInput, SendEmailResult, TrackInput } from "./types.js";
+import type { BatchBody, BatchResultDto, ErrorCode, EventDto, GetPreferencesInput, IdentifyInput, Preferences, PreferencesLink, PreferencesLinkInput, PreviewEmailInput, ProfileDto, SendEmailInput, SendEmailResult, SetPreferencesInput, TemplatePreview, TrackInput } from "./types.js";
 export type * from "./types.js";
 /**
  * The Cowliss TS client SDK. Small typed surface over the ingestion API:
@@ -98,20 +98,40 @@ export declare class Cow {
      *
      * Synchronous like the rest of the client: the promise resolves once the
      * message has been handed over, and `deliveryId` is the row that records
-     * what happened to it. Each call carries its own Idempotency-Key on every
+     * what happened to it. Each call carries an Idempotency-Key on every
      * attempt, so a retry after a lost reply answers with the first send's
-     * `deliveryId` instead of sending again.
+     * `deliveryId` instead of sending again. Pass your own `idempotencyKey`
+     * (an order id, a job id) and a second run of your own code dedupes too;
+     * without one, each call is a send of its own.
+     *
+     * Addressed to `{ email }` that no profile in the app holds yet, the send
+     * creates that profile first, as `identify` would.
      */
     emails: {
-        send: (input: WithDefaultSource<SendEmailInput>) => Promise<SendEmailResult>;
+        send: ({ idempotencyKey, ...input }: WithDefaultSource<SendEmailInput> & {
+            idempotencyKey?: string;
+        }) => Promise<SendEmailResult>;
     };
     /**
-     * A link to one person's hosted email preferences page, for your app's own
-     * "Manage email preferences" button: `to` is one identifier naming them,
-     * as in `emails.send`. The page lists every purpose their app declares as
-     * a switch, and the link works for an hour, so ask for it when they click.
+     * Templates as a send renders them. `preview` renders a pushed template
+     * with your own props, exactly as `emails.send` to an address would, and
+     * sends nothing: for showing your operators the message before it goes.
+     */
+    templates: {
+        preview: (input: WithDefaultSource<PreviewEmailInput>) => Promise<TemplatePreview>;
+    };
+    /**
+     * One person's email preferences, `to` naming them as in `emails.send`.
+     *
+     * `link` is the hosted page, for a "Manage email preferences" button: it
+     * lists every purpose their app declares as a switch, and the link works
+     * for an hour, so ask for it when they click. `get` and `set` are the same
+     * page as data, for an app that draws its own: `set` saves what the person
+     * chose, where `identify({ consent })` records what the app decided.
      */
     preferences: {
+        get: (input: WithDefaultSource<GetPreferencesInput>) => Promise<Preferences>;
+        set: (input: WithDefaultSource<SetPreferencesInput>) => Promise<Preferences>;
         link: (input: WithDefaultSource<PreferencesLinkInput>) => Promise<PreferencesLink>;
     };
     /**

package/dist/index.js

@@ -120,20 +120,44 @@ export class Cow {
      *
      * Synchronous like the rest of the client: the promise resolves once the
      * message has been handed over, and `deliveryId` is the row that records
-     * what happened to it. Each call carries its own Idempotency-Key on every
+     * what happened to it. Each call carries an Idempotency-Key on every
      * attempt, so a retry after a lost reply answers with the first send's
-     * `deliveryId` instead of sending again.
+     * `deliveryId` instead of sending again. Pass your own `idempotencyKey`
+     * (an order id, a job id) and a second run of your own code dedupes too;
+     * without one, each call is a send of its own.
+     *
+     * Addressed to `{ email }` that no profile in the app holds yet, the send
+     * creates that profile first, as `identify` would.
      */
     emails = {
-        send: (input) => this.#watch(async () => this.#post("/v1/emails", { data: { ...input, sourceId: this.#sourceFor(input) } }, crypto.randomUUID())),
+        send: ({ idempotencyKey, ...input }) => this.#watch(async () => this.#post("/v1/emails", { data: { ...input, sourceId: this.#sourceFor(input) } }, idempotencyKey ?? crypto.randomUUID())),
     };
     /**
-     * A link to one person's hosted email preferences page, for your app's own
-     * "Manage email preferences" button: `to` is one identifier naming them,
-     * as in `emails.send`. The page lists every purpose their app declares as
-     * a switch, and the link works for an hour, so ask for it when they click.
+     * Templates as a send renders them. `preview` renders a pushed template
+     * with your own props, exactly as `emails.send` to an address would, and
+     * sends nothing: for showing your operators the message before it goes.
+     */
+    templates = {
+        preview: (input) => this.#watch(async () => this.#post("/v1/email-previews", {
+            data: { ...input, sourceId: this.#sourceFor(input) },
+        })),
+    };
+    /**
+     * One person's email preferences, `to` naming them as in `emails.send`.
+     *
+     * `link` is the hosted page, for a "Manage email preferences" button: it
+     * lists every purpose their app declares as a switch, and the link works
+     * for an hour, so ask for it when they click. `get` and `set` are the same
+     * page as data, for an app that draws its own: `set` saves what the person
+     * chose, where `identify({ consent })` records what the app decided.
      */
     preferences = {
+        get: (input) => this.#watch(async () => this.#post("/v1/profile-preferences/find", {
+            data: { ...input, sourceId: this.#sourceFor(input) },
+        })),
+        set: (input) => this.#watch(async () => this.#post("/v1/profile-preferences", {
+            data: { ...input, sourceId: this.#sourceFor(input) },
+        })),
         link: (input) => this.#watch(async () => this.#post("/v1/preferences-links", {
             data: { ...input, sourceId: this.#sourceFor(input) },
         })),

package/dist/types.d.ts

@@ -161,12 +161,49 @@ export type SendEmailResult = {
     /** The delivery this send left behind: the row in Deliveries. */
     deliveryId: string;
 };
+/** A template key and the props a send would pass it. */
+export type PreviewEmailInput = {
+    sourceId: string;
+    key: string;
+    props?: Record<string, unknown>;
+};
+/** What a send of the template would carry. */
+export type TemplatePreview = {
+    subject: string;
+    html: string;
+    text: string;
+    /** The version that rendered it: the latest one that finished compiling. */
+    versionId: string;
+};
 /** One profile, named the way a send to a profile names it. */
 export type PreferencesLinkInput = {
     sourceId: string;
     /** Exactly one identifier naming a profile in the source's app. */
     to: Identifiers;
 };
+/** One profile's switches, read or saved from your app's own page. */
+export type GetPreferencesInput = PreferencesLinkInput;
+export type SetPreferencesInput = PreferencesLinkInput & {
+    /**
+     * The switches to change: `marketing` or a purpose your app declares.
+     * Keys left out keep their answer.
+     */
+    consent: ConsentPatch;
+};
+/** One switch: `marketing`, or a purpose your app declares. */
+export type Preference = {
+    key: string;
+    label: string;
+    description: string | null;
+    /** Whether a send under this purpose would reach them now. */
+    enabled: boolean;
+    /** Whether they hold their own answer, rather than the default. */
+    answered: boolean;
+};
+export type Preferences = {
+    /** `marketing` first, then your app's purposes by key. */
+    purposes: Preference[];
+};
 export type PreferencesLink = {
     /** The hosted preferences page for that profile. */
     url: string;

package/dist/version.autogenerated.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.18.1";
+export declare const SDK_VERSION = "0.20.0";

package/dist/version.autogenerated.js

@@ -1,2 +1,2 @@
 // Generated by scripts/version.ts from package.json. Do not edit.
-export const SDK_VERSION = "0.18.1";
+export const SDK_VERSION = "0.20.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cowliss/sdk",
-  "version": "0.18.1",
+  "version": "0.20.0",
   "type": "module",
   "exports": {
     ".": {