@cowliss/sdk 0.6.0 → 0.8.0

package/README.md

@@ -36,6 +36,20 @@ await cow.track({
 });
 ```
 
+Send a transactional message from your own code, with a template you pushed
+or a body written inline:
+
+```ts
+await cow.emails.send({
+  to: "ada@example.com",
+  template: { key: "receipt", props: { orderId: "A-2291" } },
+});
+```
+
+It resolves once the message has been handed over, and answers with the
+delivery id. Mail that follows a rule or a wait belongs in a journey, which
+is where consent and frequency live.
+
 Every call carries `identifiers`, a map from kind to value. Cowliss generates
 the profile id and resolves the map to it, so a call that carries two
 identifiers is what links two profiles. There is no alias call.

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import type { BatchBody, BatchResultDto, ErrorCode, EventDto, IdentifyInput, ProfileDto, TrackInput } from "./types.js";
+import type { BatchBody, BatchResultDto, ErrorCode, EventDto, IdentifyInput, ProfileDto, SendEmailInput, SendEmailResult, TrackInput } from "./types.js";
 export type * from "./types.js";
 /**
  * The Cowliss TS client SDK. Small typed surface over the ingestion API:
@@ -89,6 +89,18 @@ export declare class Cow {
      * server-side. Historical timestamps pass through for backfill scripts.
      */
     track(input: WithDefaultSource<TrackInput>): Promise<EventDto>;
+    /**
+     * The transactional send a developer's own code makes: a receipt, a
+     * password reset, an export that is ready. Mail that follows a rule or a
+     * wait belongs in a journey, which is where consent and frequency live.
+     *
+     * 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.
+     */
+    emails: {
+        send: (input: WithDefaultSource<SendEmailInput>) => Promise<SendEmailResult>;
+    };
     /**
      * Batch import: one source's identify and track calls in one request.
      * Track items must carry an explicit messageId: the API requires it and

package/dist/index.js

@@ -111,6 +111,20 @@ export class Cow {
             return this.#post("/v1/track", { data: { ...input, sourceId: this.#sourceFor(input), messageId } }, messageId);
         });
     }
+    /**
+     * The transactional send a developer's own code makes: a receipt, a
+     * password reset, an export that is ready. Mail that follows a rule or a
+     * wait belongs in a journey, which is where consent and frequency live.
+     *
+     * 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.
+     */
+    emails = {
+        send: (input) => this.#watch(async () => this.#post("/v1/emails", {
+            data: { ...input, sourceId: this.#sourceFor(input) },
+        })),
+    };
     /**
      * Batch import: one source's identify and track calls in one request.
      * Track items must carry an explicit messageId: the API requires it and

package/dist/types.d.ts

@@ -13,7 +13,7 @@
  * typecheck here rather than at a customer's call site.
  */
 /** The API's error-code enum, as the SDK surfaces it on `CowError.code`. */
-export type ErrorCode = "malformed_request" | "invalid_key" | "forbidden" | "not_found" | "conflict" | "payload_too_large" | "validation_failed" | "trait_validation_failed" | "event_denied" | "trait_denied" | "over_quota" | "rate_limited" | "dependency_unavailable" | "internal" | "journey_fuel_exceeded" | "journey_timeout" | "journey_memory_exceeded" | "journey_error" | "journey_output_invalid" | "journey_nondeterministic" | "push_invalid" | "version_not_ready" | "project_exists" | "project_missing" | "artifact_too_large";
+export type ErrorCode = "malformed_request" | "invalid_key" | "forbidden" | "not_found" | "conflict" | "payload_too_large" | "validation_failed" | "trait_validation_failed" | "event_denied" | "trait_denied" | "over_quota" | "rate_limited" | "dependency_unavailable" | "internal" | "journey_fuel_exceeded" | "journey_timeout" | "journey_memory_exceeded" | "journey_error" | "journey_output_invalid" | "journey_nondeterministic" | "push_invalid" | "version_not_ready" | "artifact_too_large";
 export type IdentifierKind = "anonymousId" | "userId" | "clerkId" | "email";
 /**
  * The named identifiers a call carries, at least one. Cowliss generates the
@@ -57,10 +57,9 @@ export type EventDto = {
     receivedAt: string;
     messageId: string | null;
 };
-/** The fixed consent purposes, as a caller patches them. */
+/** The consent purpose every org holds, as a caller patches it. */
 export type ConsentPatch = {
-    emailMarketing?: boolean;
-    dataProcessing?: boolean;
+    marketing?: boolean;
 };
 export type IdentifyInput = {
     sourceId: string;
@@ -126,6 +125,30 @@ export type BatchItemResult = {
 export type BatchResultDto = {
     results: BatchItemResult[];
 };
+/** One transactional email: a pushed template, or a body written inline. */
+export type SendEmailInput = {
+    sourceId: string;
+    to: string | string[];
+    cc?: string | string[];
+    bcc?: string | string[];
+    replyTo?: string | string[];
+    /** An address on a domain this organization verified. There is no other. */
+    from: string;
+    /** Required with an inline body; refused beside a template, which writes it. */
+    subject?: string;
+    html?: string;
+    text?: string;
+    headers?: Record<string, string>;
+    /** A template key this organization pushed, and the props it declares. */
+    template?: {
+        key: string;
+        props?: Record<string, unknown>;
+    };
+};
+export type SendEmailResult = {
+    /** The delivery this send left behind: the row in Deliveries. */
+    deliveryId: string;
+};
 /**
  * The two runtime constants in this file, and the reason they live beside
  * the types rather than in `@cowliss/shared`: this module is the SDK's one

package/dist/version.autogenerated.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.6.0";
+export declare const SDK_VERSION = "0.8.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.6.0";
+export const SDK_VERSION = "0.8.0";

package/package.json

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