@decocms/apps-sfmc-personalization 8.1.0-next.0 → 8.1.0-next.2

package/dist/index.d.ts

@@ -0,0 +1,21 @@
+import type { PersonalizationEvent, PersonalizationResponse } from "./types.ts";
+export type { CampaignResponse, PersonalizationEvent, PersonalizationLineItem, PersonalizationProduct, PersonalizationResponse, } from "./types.ts";
+export interface SfmcPersonalizationConfig {
+    /** The account's API origin, e.g. `https://<account>.<instance>.evergage.com`. */
+    baseUrl: string;
+    /** The dataset events are sent to. */
+    dataset: string;
+}
+export declare class SfmcPersonalizationError extends Error {
+    readonly operation: string;
+    readonly status: number;
+    constructor(operation: string, status: number);
+}
+export declare function createSfmcPersonalizationClient(config: SfmcPersonalizationConfig, options?: {
+    fetch?: typeof globalThis.fetch;
+}): {
+    /** Sends an interaction and returns the campaigns it triggered. */
+    sendEvent(event: PersonalizationEvent): Promise<PersonalizationResponse>;
+};
+export type SfmcPersonalizationClient = ReturnType<typeof createSfmcPersonalizationClient>;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,oBAAoB,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAC;AAEhF,YAAY,EACV,gBAAgB,EAChB,oBAAoB,EACpB,uBAAuB,EACvB,sBAAsB,EACtB,uBAAuB,GACxB,MAAM,YAAY,CAAC;AAEpB,MAAM,WAAW,yBAAyB;IACxC,kFAAkF;IAClF,OAAO,EAAE,MAAM,CAAC;IAChB,sCAAsC;IACtC,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,qBAAa,wBAAyB,SAAQ,KAAK;IAE/C,QAAQ,CAAC,SAAS,EAAE,MAAM;IAC1B,QAAQ,CAAC,MAAM,EAAE,MAAM;IAFzB,YACW,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,EAGxB;CACF;AAED,wBAAgB,+BAA+B,CAC7C,MAAM,EAAE,yBAAyB,EACjC,OAAO,GAAE;IAAE,KAAK,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,CAAA;CAAO;IAQ/C,mEAAmE;IAC7D,SAAS,QAAQ,oBAAoB,GAAG,OAAO,CAAC,uBAAuB,CAAC;EAYjF;AAED,MAAM,MAAM,yBAAyB,GAAG,UAAU,CAAC,OAAO,+BAA+B,CAAC,CAAC"}

package/dist/index.js

@@ -0,0 +1,41 @@
+/**
+ * `@decocms/apps-sfmc-personalization`: a thin client for Salesforce
+ * Marketing Cloud Personalization (formerly Evergage). See /next/upstream-clients.
+ *
+ * Every request goes through `createInstrumentedFetch` with provider
+ * `sfmc-personalization`. No retries or circuit breaker. Reading the
+ * shopper's cookie, converting products to commerce types and caching belong
+ * to the site (platform templates and site code).
+ */
+import { createInstrumentedFetch } from "@decocms/blocks/fetch";
+export class SfmcPersonalizationError extends Error {
+    operation;
+    status;
+    constructor(operation, status) {
+        super(`sfmc-personalization ${operation} failed with HTTP ${status}`);
+        this.operation = operation;
+        this.status = status;
+    }
+}
+export function createSfmcPersonalizationClient(config, options = {}) {
+    const request = createInstrumentedFetch({
+        provider: "sfmc-personalization",
+        fetch: options.fetch,
+    });
+    return {
+        /** Sends an interaction and returns the campaigns it triggered. */
+        async sendEvent(event) {
+            const url = new URL(`/api2/event/${encodeURIComponent(config.dataset)}`, config.baseUrl);
+            const response = await request(url, {
+                operation: "sendEvent",
+                method: "POST",
+                headers: { "content-type": "application/json" },
+                body: JSON.stringify(event),
+            });
+            if (!response.ok)
+                throw new SfmcPersonalizationError("sendEvent", response.status);
+            return (await response.json());
+        },
+    };
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,OAAO,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AAkBhE,MAAM,OAAO,wBAAyB,SAAQ,KAAK;IAEtC,SAAS;IACT,MAAM;IAFjB,YACW,SAAiB,EACjB,MAAc;QAEvB,KAAK,CAAC,wBAAwB,SAAS,qBAAqB,MAAM,EAAE,CAAC,CAAC;yBAH7D,SAAS;sBACT,MAAM;IAGjB,CAAC;CACF;AAED,MAAM,UAAU,+BAA+B,CAC7C,MAAiC,EACjC,OAAO,GAAwC,EAAE;IAEjD,MAAM,OAAO,GAAG,uBAAuB,CAAC;QACtC,QAAQ,EAAE,sBAAsB;QAChC,KAAK,EAAE,OAAO,CAAC,KAAK;KACrB,CAAC,CAAC;IAEH,OAAO;QACL,mEAAmE;QACnE,KAAK,CAAC,SAAS,CAAC,KAA2B;YACzC,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,eAAe,kBAAkB,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;YACzF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,EAAE;gBAClC,SAAS,EAAE,WAAW;gBACtB,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;gBAC/C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;aAC5B,CAAC,CAAC;YACH,IAAI,CAAC,QAAQ,CAAC,EAAE;gBAAE,MAAM,IAAI,wBAAwB,CAAC,WAAW,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;YACnF,OAAO,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAA4B,CAAC;QAC5D,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,68 @@
+/**
+ * Salesforce Marketing Cloud Personalization (formerly Evergage): request and
+ * response shapes of the Event API (`POST /api2/event/{dataset}`).
+ *
+ * Product fields are configured per dataset, so `PersonalizationProduct`
+ * keeps the common fields and accepts whatever else the dataset exposes.
+ */
+export interface PersonalizationProduct {
+    id: string;
+    name: string;
+    /** List price. */
+    price: number;
+    /** Promotional price, when one is active. */
+    salePrice?: number;
+    inventoryCount: number;
+    imageUrls: string[];
+    /** Absolute product URL. */
+    url: string;
+    /** ISO 4217 currency code. */
+    currency: string;
+    description?: string;
+    itemType?: string;
+    categories?: string[];
+    /** Whatever else the dataset's catalog schema defines. */
+    [customField: string]: unknown;
+}
+/** A cart line, sent with cart-aware interactions. */
+export interface PersonalizationLineItem {
+    catalogObjectType: string;
+    catalogObjectId: string;
+    quantity: number;
+    price: number;
+}
+/** The interaction a shopper had; the response holds the campaigns it triggered. */
+export interface PersonalizationEvent {
+    source: {
+        channel: string;
+        url: string;
+    };
+    interaction: {
+        name: string;
+        lineItems?: PersonalizationLineItem[];
+    };
+    user: {
+        anonymousId?: string;
+        encryptedId?: string;
+        attributes?: Record<string, unknown>;
+    };
+    flags?: {
+        nonInteractive?: boolean;
+        doNotTrack?: boolean;
+    };
+    pageView?: boolean;
+}
+export interface CampaignResponse {
+    campaignId: string;
+    payload: {
+        experience?: string;
+        headerText?: string;
+        products?: PersonalizationProduct[];
+        userGroup?: string;
+        [field: string]: unknown;
+    };
+}
+export interface PersonalizationResponse {
+    campaignResponses?: CampaignResponse[];
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,kBAAkB;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,6CAA6C;IAC7C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,4BAA4B;IAC5B,GAAG,EAAE,MAAM,CAAC;IACZ,8BAA8B;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,0DAA0D;IAC1D,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC;CAChC;AAED,sDAAsD;AACtD,MAAM,WAAW,uBAAuB;IACtC,iBAAiB,EAAE,MAAM,CAAC;IAC1B,eAAe,EAAE,MAAM,CAAC;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,oFAAoF;AACpF,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE;QACN,OAAO,EAAE,MAAM,CAAC;QAChB,GAAG,EAAE,MAAM,CAAC;KACb,CAAC;IACF,WAAW,EAAE;QACX,IAAI,EAAE,MAAM,CAAC;QACb,SAAS,CAAC,EAAE,uBAAuB,EAAE,CAAC;KACvC,CAAC;IACF,IAAI,EAAE;QACJ,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACtC,CAAC;IACF,KAAK,CAAC,EAAE;QACN,cAAc,CAAC,EAAE,OAAO,CAAC;QACzB,UAAU,CAAC,EAAE,OAAO,CAAC;KACtB,CAAC;IACF,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,gBAAgB;IAC/B,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE;QACP,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,QAAQ,CAAC,EAAE,sBAAsB,EAAE,CAAC;QACpC,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC;KAC1B,CAAC;CACH;AAED,MAAM,WAAW,uBAAuB;IACtC,iBAAiB,CAAC,EAAE,gBAAgB,EAAE,CAAC;CACxC"}

package/dist/types.js

@@ -0,0 +1,9 @@
+/**
+ * Salesforce Marketing Cloud Personalization (formerly Evergage): request and
+ * response shapes of the Event API (`POST /api2/event/{dataset}`).
+ *
+ * Product fields are configured per dataset, so `PersonalizationProduct`
+ * keeps the common fields and accepts whatever else the dataset exposes.
+ */
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@decocms/apps-sfmc-personalization",
-  "version": "8.1.0-next.0",
+  "version": "8.1.0-next.2",
   "type": "module",
   "description": "Thin client for Salesforce Marketing Cloud Personalization (formerly Evergage)",
   "repository": {
@@ -8,22 +8,29 @@
     "url": "https://github.com/decocms/blocks.git",
     "directory": "packages/apps-sfmc-personalization"
   },
-  "main": "./src/index.ts",
+  "files": [
+    "dist",
+    "src",
+    "!src/**/*.test.ts",
+    "!src/**/__tests__"
+  ],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "exports": {
-    ".": "./src/index.ts"
+    ".": {
+      "types": "./dist/index.d.ts",
+      "source": "./src/index.ts",
+      "default": "./dist/index.js"
+    }
   },
   "scripts": {
-    "build": "tsc",
+    "build": "node ../../scripts/tsc.mjs --clean dist -p tsconfig.build.json",
+    "prepack": "npm run build",
     "test": "vitest run --root ../.. packages/apps-sfmc-personalization/",
-    "typecheck": "tsc --noEmit",
-    "lint:unused": "knip"
+    "typecheck": "node ../../scripts/tsc.mjs -p tsconfig.json"
   },
   "dependencies": {
-    "@decocms/blocks": "8.1.0-next.0"
-  },
-  "devDependencies": {
-    "knip": "^5.86.0",
-    "typescript": "^5.9.0"
+    "@decocms/blocks": "8.1.0-next.2"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org",

package/src/index.ts

@@ -5,10 +5,10 @@
  * Every request goes through `createInstrumentedFetch` with provider
  * `sfmc-personalization`. No retries or circuit breaker. Reading the
  * shopper's cookie, converting products to commerce types and caching belong
- * to the site (platform templates and the framework binding).
+ * to the site (platform templates and site code).
  */
 import { createInstrumentedFetch } from "@decocms/blocks/fetch";
-import type { PersonalizationEvent, PersonalizationResponse } from "./types";
+import type { PersonalizationEvent, PersonalizationResponse } from "./types.ts";
 
 export type {
   CampaignResponse,
@@ -16,7 +16,7 @@ export type {
   PersonalizationLineItem,
   PersonalizationProduct,
   PersonalizationResponse,
-} from "./types";
+} from "./types.ts";
 
 export interface SfmcPersonalizationConfig {
   /** The account's API origin, e.g. `https://<account>.<instance>.evergage.com`. */
@@ -36,7 +36,7 @@ export class SfmcPersonalizationError extends Error {
 
 export function createSfmcPersonalizationClient(
   config: SfmcPersonalizationConfig,
-  options: { fetch?: typeof fetch } = {},
+  options: { fetch?: typeof globalThis.fetch } = {},
 ) {
   const request = createInstrumentedFetch({
     provider: "sfmc-personalization",

package/src/__tests__/client.test.ts

@@ -1,48 +0,0 @@
-/**
- * The Marketing Cloud Personalization client (/next/upstream-clients): the
- * Event API through the instrumented fetch, errors without bodies.
- */
-import { describe, expect, it, vi } from "vitest";
-import { createSfmcPersonalizationClient, SfmcPersonalizationError } from "../index";
-
-function fakeFetch(status: number, body: unknown) {
-  return vi.fn(
-    async (_input: string | URL | Request, _init?: RequestInit) =>
-      new Response(JSON.stringify(body), { status }),
-  );
-}
-
-const config = { baseUrl: "https://acme.us-1.evergage.com", dataset: "engage" };
-const event = {
-  source: { channel: "WebServer", url: "https://shop.example.com/" },
-  interaction: { name: "Personalization Campaigns" },
-  user: { anonymousId: "anon-1" },
-  flags: { nonInteractive: true, doNotTrack: false },
-  pageView: false,
-};
-
-describe("createSfmcPersonalizationClient", () => {
-  it("sendEvent posts the event to the dataset and returns the campaigns", async () => {
-    const campaigns = { campaignResponses: [{ campaignId: "c1", payload: { products: [] } }] };
-    const fetch = fakeFetch(200, campaigns);
-    const sfmc = createSfmcPersonalizationClient(config, { fetch });
-
-    await expect(sfmc.sendEvent(event)).resolves.toEqual(campaigns);
-
-    const [url, init] = fetch.mock.calls[0];
-    expect(String(url)).toBe("https://acme.us-1.evergage.com/api2/event/engage");
-    expect(init?.method).toBe("POST");
-    expect(JSON.parse(String(init?.body))).toEqual(event);
-  });
-
-  it("throws the operation and status, never the body", async () => {
-    const fetch = fakeFetch(500, { error: "anon-1 not found" });
-    const sfmc = createSfmcPersonalizationClient(config, { fetch });
-
-    const error = await sfmc.sendEvent(event).catch((e: unknown) => e);
-
-    expect(error).toBeInstanceOf(SfmcPersonalizationError);
-    expect(error).toMatchObject({ operation: "sendEvent", status: 500 });
-    expect((error as Error).message).not.toContain("anon-1");
-  });
-});

package/tsconfig.json

@@ -1,7 +0,0 @@
-{
-  "extends": "../../tsconfig.base.json",
-  "compilerOptions": {
-    "outDir": "dist"
-  },
-  "include": ["src/**/*"]
-}