@astroscope/relay 1.0.0 → 1.1.0

package/README.md

@@ -227,8 +227,10 @@ A server destination is a `name` and a `send(payload, meta)`, where `meta` adds
 | `@astroscope/relay/gtm`           | `gtm.purchase(commerce, params?)`, … and `gtm.event(name, params)`                               | `gtmContainer()`: `dataLayer` pushes with `event_id`; consent is the container's own embedding              |
 | `@astroscope/relay/matomo`        | `matomo.event()`, `matomo.siteSearch()`, `matomo.order()`, `matomo.calls(…)`                      | `matomoTracker()`: the `_paq` queue; a cookieless setup is `false` in the consent source                    |
 | `@astroscope/relay/awin`          | `awin.sale({ amount, orderRef, currency, voucher?, parts? })`                                     | `awinMastertag({ advertiserId, testMode? })`: declares `AWIN.Tracking.Sale` and fires the fall-back pixel               |
-| `@astroscope/relay/openai`        | `openai.contentsViewed()`, `itemsAdded()`, `checkoutStarted()`, `orderCreated()`, `leadCreated()` | `openAiPixel({ countryCallingCode? })`: the openai ads pixel, identifiers hashed and sent through `init`       |
+| `@astroscope/relay/openai`        | every event openai names: `openai.pageViewed()`, `contentsViewed()`, `itemsAdded()`, `checkoutStarted()`, `orderCreated()`, `leadCreated()`, `registrationCompleted()`, `appointmentScheduled()`, `subscriptionCreated()`, `trialStarted()`, and `custom(name)` | `openAiPixel({ countryCallingCode? })`: the openai ads pixel, identifiers hashed and sent through `init`       |
 | `@astroscope/relay/openai/server` | the same builders                                                                                | `openAiConversions({ apiKey, pixelId, integrationSource, countryCallingCode? })`: the conversions api                    |
+| `@astroscope/relay/meta`          | `meta.purchase()`, `meta.lead()`, `meta.subscribe()`, … the standard events, and `meta.event(name, data)` | `metaPixel({ pixelId, countryCallingCode? })`: the meta pixel the cmp's base code initialized, waited for, events fired on it alone, identifiers hashed into advanced matching; track `meta.pageView()` from the layout |
+| `@astroscope/relay/meta/server`   | the same builders                                                                                | `metaConversions({ accessToken, pixelId, testEventCode?, countryCallingCode? })`: the conversions api, with `fbp`/`fbc` off the pixel's cookies |
 
 A destination of your own follows the same shape: builders for the payload, a browser destination, a server destination, all under one name. `wellKnownEvents(create)` from the root entry makes a builder set of the well-known events.
 

package/dist/{conversion-user-CV8xIWDK.js → conversion-user-BgpXmIdJ.js}

@@ -1,17 +1,25 @@
 // src/conversion-user.ts
 /** normalizes and hashes the identifiers the way the pixels and the conversions apis expect them */
 async function hashUser(user, options = {}) {
-	const [email, phone, firstName, lastName] = await Promise.all([
+	const [email, phone, firstName, lastName, city, postalCode, country, externalId] = await Promise.all([
 		hashOptional(normalizeEmail(user.email)),
 		hashOptional(normalizePhone(user.phone, options.countryCallingCode)),
 		hashOptional(normalizeName(user.firstName)),
-		hashOptional(normalizeName(user.lastName))
+		hashOptional(normalizeName(user.lastName)),
+		hashOptional(normalizeName(user.city)),
+		hashOptional(normalizePostalCode(user.postalCode)),
+		hashOptional(normalizeCountry(user.country)),
+		hashOptional(user.externalId?.trim())
 	]);
 	return withoutEmpty({
 		email,
 		phone,
 		firstName,
-		lastName
+		lastName,
+		city,
+		postalCode,
+		country,
+		externalId
 	});
 }
 function normalizeEmail(email) {
@@ -34,6 +42,15 @@ function normalizePhone(phone, countryCallingCode) {
 function normalizeName(name) {
 	return name?.toLowerCase().replaceAll(/[\s!-/:-@[-`{-~]/g, "") || void 0;
 }
+/** lowercase without whitespace */
+function normalizePostalCode(postalCode) {
+	return postalCode?.toLowerCase().replaceAll(/\s/g, "") || void 0;
+}
+/** the lowercase two-letter code, anything else is dropped */
+function normalizeCountry(country) {
+	const code = country?.trim().toLowerCase();
+	return code && /^[a-z]{2}$/.test(code) ? code : void 0;
+}
 async function sha256(value) {
 	const digest = await crypto.subtle.digest("SHA-256", new TextEncoder().encode(value));
 	return Array.from(new Uint8Array(digest), (byte) => byte.toString(16).padStart(2, "0")).join("");
@@ -46,4 +63,4 @@ function withoutEmpty(user) {
 }
 export { sha256 as a, normalizePhone as i, normalizeEmail as n, normalizeName as r, hashUser as t };
 
-//# sourceMappingURL=conversion-user-CV8xIWDK.js.map
+//# sourceMappingURL=conversion-user-BgpXmIdJ.js.map

package/dist/conversion-user-BgpXmIdJ.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"conversion-user-BgpXmIdJ.js","names":[],"sources":["../src/conversion-user.ts"],"sourcesContent":["/** what the visitor entered for a conversion; a destination that identifies hashes it as it requires */\nexport type ConversionUser = {\n  email?: string | undefined;\n  phone?: string | undefined;\n  firstName?: string | undefined;\n  lastName?: string | undefined;\n  city?: string | undefined;\n  postalCode?: string | undefined;\n  /** the two-letter country code */\n  country?: string | undefined;\n  /** the site's own id of the visitor: a customer or subscriber id */\n  externalId?: string | undefined;\n};\n\n/** the identifiers of a visitor as the ad platforms match them: normalized, then sha256 as lowercase hex */\nexport type HashedUser = {\n  email?: string | undefined;\n  phone?: string | undefined;\n  firstName?: string | undefined;\n  lastName?: string | undefined;\n  city?: string | undefined;\n  postalCode?: string | undefined;\n  country?: string | undefined;\n  externalId?: string | undefined;\n};\n\nexport type HashOptions = {\n  /**\n   * The country calling code a national phone number gets (`49` for a German site): a number\n   * with one leading zero is taken as national, `+` or `00` prefixes are international.\n   */\n  countryCallingCode?: string | undefined;\n};\n\n/** normalizes and hashes the identifiers the way the pixels and the conversions apis expect them */\nexport async function hashUser(user: ConversionUser, options: HashOptions = {}): Promise<HashedUser> {\n  const [email, phone, firstName, lastName, city, postalCode, country, externalId] = await Promise.all([\n    hashOptional(normalizeEmail(user.email)),\n    hashOptional(normalizePhone(user.phone, options.countryCallingCode)),\n    hashOptional(normalizeName(user.firstName)),\n    hashOptional(normalizeName(user.lastName)),\n    hashOptional(normalizeName(user.city)),\n    hashOptional(normalizePostalCode(user.postalCode)),\n    hashOptional(normalizeCountry(user.country)),\n    hashOptional(user.externalId?.trim()),\n  ]);\n\n  return withoutEmpty({ email, phone, firstName, lastName, city, postalCode, country, externalId });\n}\n\nexport function normalizeEmail(email: string | undefined): string | undefined {\n  return email?.trim().toLowerCase() || undefined;\n}\n\n/**\n * Digits only, with the country calling code: a national number (one leading zero) gets the\n * site's code, `+` and `00` prefixes are dropped. Returns `undefined` for anything that is not\n * 8 to 15 digits afterwards.\n */\nexport function normalizePhone(phone: string | undefined, countryCallingCode: string | undefined): string | undefined {\n  const compact = phone?.replaceAll(/[\\s().-]/g, '');\n\n  if (!compact) {\n    return undefined;\n  }\n\n  const international = compact.startsWith('+') || compact.startsWith('00');\n  const national = compact.replace(/^\\+?0*/, '');\n  const digits = international || !compact.startsWith('0') ? national : `${countryCallingCode ?? ''}${national}`;\n\n  return /^\\d{8,15}$/.test(digits) ? digits : undefined;\n}\n\n/** lowercase, without whitespace and punctuation */\nexport function normalizeName(name: string | undefined): string | undefined {\n  return name?.toLowerCase().replaceAll(/[\\s!-/:-@[-`{-~]/g, '') || undefined;\n}\n\n/** lowercase without whitespace */\nexport function normalizePostalCode(postalCode: string | undefined): string | undefined {\n  return postalCode?.toLowerCase().replaceAll(/\\s/g, '') || undefined;\n}\n\n/** the lowercase two-letter code, anything else is dropped */\nexport function normalizeCountry(country: string | undefined): string | undefined {\n  const code = country?.trim().toLowerCase();\n\n  return code && /^[a-z]{2}$/.test(code) ? code : undefined;\n}\n\nexport async function sha256(value: string): Promise<string> {\n  const digest = await crypto.subtle.digest('SHA-256', new TextEncoder().encode(value));\n\n  return Array.from(new Uint8Array(digest), (byte) => byte.toString(16).padStart(2, '0')).join('');\n}\n\nasync function hashOptional(value: string | undefined): Promise<string | undefined> {\n  return value ? sha256(value) : undefined;\n}\n\nfunction withoutEmpty(user: HashedUser): HashedUser {\n  return Object.fromEntries(Object.entries(user).filter(([, value]) => value)) as HashedUser;\n}\n"],"mappings":";;AAmCA,eAAsB,SAAS,MAAsB,UAAuB,CAAC,GAAwB;CACnG,MAAM,CAAC,OAAO,OAAO,WAAW,UAAU,MAAM,YAAY,SAAS,cAAc,MAAM,QAAQ,IAAI;EACnG,aAAa,eAAe,KAAK,KAAK,CAAC;EACvC,aAAa,eAAe,KAAK,OAAO,QAAQ,kBAAkB,CAAC;EACnE,aAAa,cAAc,KAAK,SAAS,CAAC;EAC1C,aAAa,cAAc,KAAK,QAAQ,CAAC;EACzC,aAAa,cAAc,KAAK,IAAI,CAAC;EACrC,aAAa,oBAAoB,KAAK,UAAU,CAAC;EACjD,aAAa,iBAAiB,KAAK,OAAO,CAAC;EAC3C,aAAa,KAAK,YAAY,KAAK,CAAC;CACtC,CAAC;CAED,OAAO,aAAa;EAAE;EAAO;EAAO;EAAW;EAAU;EAAM;EAAY;EAAS;CAAW,CAAC;AAClG;AAEA,SAAgB,eAAe,OAA+C;CAC5E,OAAO,OAAO,KAAK,CAAC,CAAC,YAAY,KAAK,KAAA;AACxC;;;;;;AAOA,SAAgB,eAAe,OAA2B,oBAA4D;CACpH,MAAM,UAAU,OAAO,WAAW,aAAa,EAAE;CAEjD,IAAI,CAAC,SACH;CAGF,MAAM,gBAAgB,QAAQ,WAAW,GAAG,KAAK,QAAQ,WAAW,IAAI;CACxE,MAAM,WAAW,QAAQ,QAAQ,UAAU,EAAE;CAC7C,MAAM,SAAS,iBAAiB,CAAC,QAAQ,WAAW,GAAG,IAAI,WAAW,GAAG,sBAAsB,KAAK;CAEpG,OAAO,aAAa,KAAK,MAAM,IAAI,SAAS,KAAA;AAC9C;;AAGA,SAAgB,cAAc,MAA8C;CAC1E,OAAO,MAAM,YAAY,CAAC,CAAC,WAAW,qBAAqB,EAAE,KAAK,KAAA;AACpE;;AAGA,SAAgB,oBAAoB,YAAoD;CACtF,OAAO,YAAY,YAAY,CAAC,CAAC,WAAW,OAAO,EAAE,KAAK,KAAA;AAC5D;;AAGA,SAAgB,iBAAiB,SAAiD;CAChF,MAAM,OAAO,SAAS,KAAK,CAAC,CAAC,YAAY;CAEzC,OAAO,QAAQ,aAAa,KAAK,IAAI,IAAI,OAAO,KAAA;AAClD;AAEA,eAAsB,OAAO,OAAgC;CAC3D,MAAM,SAAS,MAAM,OAAO,OAAO,OAAO,WAAW,IAAI,YAAY,CAAC,CAAC,OAAO,KAAK,CAAC;CAEpF,OAAO,MAAM,KAAK,IAAI,WAAW,MAAM,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC,CAAC,SAAS,GAAG,GAAG,CAAC,CAAC,CAAC,KAAK,EAAE;AACjG;AAEA,eAAe,aAAa,OAAwD;CAClF,OAAO,QAAQ,OAAO,KAAK,IAAI,KAAA;AACjC;AAEA,SAAS,aAAa,MAA8B;CAClD,OAAO,OAAO,YAAY,OAAO,QAAQ,IAAI,CAAC,CAAC,QAAQ,GAAG,WAAW,KAAK,CAAC;AAC7E"}

package/dist/{conversion-user-DCfM5EuZ.d.ts → conversion-user-fHh2xXBc.d.ts}

@@ -4,6 +4,12 @@ type ConversionUser = {
   phone?: string | undefined;
   firstName?: string | undefined;
   lastName?: string | undefined;
+  city?: string | undefined;
+  postalCode?: string | undefined;
+  /** the two-letter country code */
+  country?: string | undefined;
+  /** the site's own id of the visitor: a customer or subscriber id */
+  externalId?: string | undefined;
 };
 /** the identifiers of a visitor as the ad platforms match them: normalized, then sha256 as lowercase hex */
 type HashedUser = {
@@ -11,6 +17,10 @@ type HashedUser = {
   phone?: string | undefined;
   firstName?: string | undefined;
   lastName?: string | undefined;
+  city?: string | undefined;
+  postalCode?: string | undefined;
+  country?: string | undefined;
+  externalId?: string | undefined;
 };
 type HashOptions = {
   /**
@@ -32,4 +42,4 @@ declare function normalizePhone(phone: string | undefined, countryCallingCode: s
 declare function normalizeName(name: string | undefined): string | undefined;
 declare function sha256(value: string): Promise<string>;
 export { normalizeEmail as a, sha256 as c, hashUser as i, HashOptions as n, normalizeName as o, HashedUser as r, normalizePhone as s, ConversionUser as t };
-//# sourceMappingURL=conversion-user-DCfM5EuZ.d.ts.map
+//# sourceMappingURL=conversion-user-fHh2xXBc.d.ts.map

package/dist/conversion-user-fHh2xXBc.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"conversion-user-fHh2xXBc.d.ts","names":[],"sources":["../src/conversion-user.ts"],"mappings":";KACY;EACV;EACA;EACA;EACA;EACA;EACA;;EAEA;;EAEA;;;KAIU;EACV;EACA;EACA;EACA;EACA;EACA;EACA;EACA;;KAGU;;;;;EAKV;;;iBAIoB,SAAS,MAAM,gBAAgB,UAAS,cAAmB,QAAQ;iBAezE,eAAe;;;;;;iBASf,eAAe,2BAA2B;;iBAe1C,cAAc;iBAgBR,OAAO,gBAAgB"}

package/dist/index.browser.d.ts

@@ -1,4 +1,4 @@
-import { t as ConversionUser } from "./conversion-user-DCfM5EuZ.js";
+import { t as ConversionUser } from "./conversion-user-fHh2xXBc.js";
 import { n as collect, r as inlineTrack, t as CollectOptions } from "./collect-DRl177oR.js";
 import { _ as WellKnownCreate, a as CommerceItem, b as wellKnownEvents, c as PurchaseParams, d as SearchParams, f as SelectItemParams, g as ViewItemParams, h as ViewItemListParams, i as BeginCheckoutParams, l as RefundParams, m as ViewCartParams, n as AddShippingInfoParams, o as GenerateLeadParams, p as SignUpParams, r as AddToCartParams, s as LoginParams, t as AddPaymentInfoParams, u as RemoveFromCartParams, v as WellKnownName, y as isCommerceEvent } from "./commerce-DCGO8yag.js";
 import { a as DomainEvent, c as RELAY_TRACK_ATTRIBUTE, d as RelayParams, h as trackAttribute, i as DestinationName, l as RelayDestinations, m as defineEvent, n as ConsentRecord, o as EventDefinition, p as TrackInput, r as ConsentSource, s as EventMeta, t as ConsentAnswer, u as RelayEvent } from "./shared-CSwqcxPI.js";

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { t as ConversionUser } from "./conversion-user-DCfM5EuZ.js";
+import { t as ConversionUser } from "./conversion-user-fHh2xXBc.js";
 import { n as collect, r as inlineTrack, t as CollectOptions } from "./collect-DRl177oR.js";
 import { _ as WellKnownCreate, a as CommerceItem, b as wellKnownEvents, c as PurchaseParams, d as SearchParams, f as SelectItemParams, g as ViewItemParams, h as ViewItemListParams, i as BeginCheckoutParams, l as RefundParams, m as ViewCartParams, n as AddShippingInfoParams, o as GenerateLeadParams, p as SignUpParams, r as AddToCartParams, s as LoginParams, t as AddPaymentInfoParams, u as RemoveFromCartParams, v as WellKnownName, y as isCommerceEvent } from "./commerce-DCGO8yag.js";
 import { a as DomainEvent, c as RELAY_TRACK_ATTRIBUTE, d as RelayParams, h as trackAttribute, i as DestinationName, l as RelayDestinations, m as defineEvent, n as ConsentRecord, o as EventDefinition, p as TrackInput, r as ConsentSource, s as EventMeta, t as ConsentAnswer, u as RelayEvent } from "./shared-CSwqcxPI.js";

package/dist/meta/index.d.ts

@@ -0,0 +1,95 @@
+import { a as Destination } from "../bus-Z7l8oJtS.js";
+import { t as ConversionUser } from "../conversion-user-fHh2xXBc.js";
+/** the standard events meta optimizes on; anything else is a custom event */
+type MetaStandardEventName = 'AddPaymentInfo' | 'AddToCart' | 'AddToWishlist' | 'CompleteRegistration' | 'Contact' | 'CustomizeProduct' | 'Donate' | 'FindLocation' | 'InitiateCheckout' | 'Lead' | 'PageView' | 'Purchase' | 'Schedule' | 'Search' | 'StartTrial' | 'SubmitApplication' | 'Subscribe' | 'ViewContent';
+/** an item of `contents` */
+type MetaContent = {
+  id: string;
+  quantity: number;
+  item_price?: number | undefined;
+  title?: string | undefined;
+  category?: string | undefined;
+  [key: string]: unknown;
+};
+/** the parameters of an event, as the pixel and the conversions api take them under `custom_data` */
+type MetaCustomData = {
+  value?: number | undefined;
+  currency?: string | undefined;
+  content_name?: string | undefined;
+  content_category?: string | undefined;
+  content_ids?: readonly string[] | undefined;
+  content_type?: 'product' | 'product_group' | undefined;
+  contents?: readonly MetaContent[] | undefined;
+  num_items?: number | undefined;
+  order_id?: string | undefined;
+  search_string?: string | undefined;
+  status?: string | undefined;
+  predicted_ltv?: number | undefined;
+  [key: string]: unknown;
+};
+type MetaPurchaseData = MetaCustomData & {
+  value: number;
+  currency: string;
+};
+/**
+ * What meta takes, from the pixel and from the conversions api alike: the event, its parameters
+ * and, for a conversion the visitor entered identifiers for, the identifiers — hashed by whichever
+ * half sends them.
+ */
+type MetaEvent = {
+  name: string;
+  /** a custom event goes through `trackCustom`; a standard one through `track` */
+  custom: boolean;
+  data: MetaCustomData;
+  user?: ConversionUser | undefined;
+};
+declare module '@astroscope/relay' {
+  interface RelayDestinations {
+    meta: MetaEvent;
+  }
+}
+/**
+ * The meta builders: the standard events, and `event(name, data)` for a custom one. What an event
+ * definition puts under `meta`.
+ */
+export declare const meta: {
+  /** a standard event by name, for one without its own builder */
+  standard: (name: MetaStandardEventName, data?: MetaCustomData, user?: ConversionUser) => MetaEvent;
+  /** a custom event: any name meta has no standard event for */
+  event: (name: string, data?: MetaCustomData, user?: ConversionUser) => MetaEvent;
+  pageView: () => MetaEvent;
+  viewContent: (data: MetaCustomData, user?: ConversionUser) => MetaEvent;
+  search: (data: MetaCustomData, user?: ConversionUser) => MetaEvent;
+  addToCart: (data: MetaCustomData, user?: ConversionUser) => MetaEvent;
+  initiateCheckout: (data: MetaCustomData, user?: ConversionUser) => MetaEvent;
+  addPaymentInfo: (data: MetaCustomData, user?: ConversionUser) => MetaEvent;
+  purchase: (data: MetaPurchaseData, user?: ConversionUser) => MetaEvent;
+  lead: (data?: MetaCustomData, user?: ConversionUser) => MetaEvent;
+  completeRegistration: (data?: MetaCustomData, user?: ConversionUser) => MetaEvent;
+  subscribe: (data?: MetaCustomData, user?: ConversionUser) => MetaEvent;
+  schedule: (data?: MetaCustomData, user?: ConversionUser) => MetaEvent;
+  contact: (data?: MetaCustomData, user?: ConversionUser) => MetaEvent;
+};
+type Fbq = (...args: unknown[]) => void;
+declare global {
+  interface Window {
+    fbq?: Fbq | undefined;
+  }
+}
+export type MetaPixelOptions = {
+  /** the pixel the base code initialized: the events fire on it alone, the identifiers go to it */
+  pixelId: string;
+  /** the country calling code national phone numbers get before hashing, e.g. `49` */
+  countryCallingCode?: string | undefined;
+};
+/**
+ * The meta pixel as a destination: fires the `meta` payload of an event on this pixel under the
+ * event's id, so a conversion the server also reported through the conversions api counts once.
+ * The pixel's base code is injected by the cmp after consent, so `window.fbq` shows up late:
+ * events wait for it. The identifiers an event carries are hashed and handed to the pixel's
+ * advanced matching right before it. `PageView` is an event like any other: track
+ * `meta.pageView()` from the layout.
+ */
+export declare function metaPixel(options: MetaPixelOptions): Destination<'meta'>;
+export type { MetaContent, MetaCustomData, MetaEvent, MetaPurchaseData, MetaStandardEventName };
+//# sourceMappingURL=index.d.ts.map

package/dist/meta/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":["_0"],"sources":["../../src/meta/shared.ts","../../src/meta/index.ts"],"mappings":";;;KAKY;;KAqBA;EACV;EACA;EACA;EACA;EACA;GACC;;;KAIS;EACV;EACA;EACA;EACA;EACA;EACA;EACA,oBAAoB;EACpB;EACA;EACA;EACA;EACA;GACC;;KAGS,mBAAmB;EAAmB;EAAe;;;;;;;KAOrD;EACV;;EAEA;EACA,MAAM;EACN,OAAO;;;YAIG;IACR,MAAM;;;;;;;qBAeG;;EAXW,WAAA,MAAA,uBAAqB,OAAQ,gBAAc,OAAc,mBAAiB;;EAelF,QAAA,cAAM,OAAQ,gBAAc,OAAc,mBAAiB;EAM3D,gBAAA;EACM,cAAA,MAAA,gBAAc,OAAS,mBAAiB;EAC7C,SAAA,MAAA,gBAAc,OAAS,mBAAiB;EACrC,YAAA,MAAA,gBAAc,OAAS,mBAAiB;EACjC,mBAAA,MAAA,gBAAc,OAAS,mBAAiB;EAC1C,iBAAA,MAAA,gBAAc,OAAS,mBAAiB;EAC9C,WAAA,MAAA,kBAAgB,OAAS,mBAAiB;EAC7C,OAAA,OAAA,gBAAc,OAAS,mBAAiB;EACxB,uBAAA,OAAA,gBAAc,OAAS,mBAAiB;EACnD,YAAA,OAAA,gBAAc,OAAS,mBAAiB;EACzC,WAAA,OAAA,gBAAc,OAAS,mBAAiB;EACzC,UAAA,OAAA,gBAAc,OAAS,mBAAiB;;KCrFtD,UAAU;QAEP;YACI;IACR,MAAM;;;YAIE;;EAEV;;EAEA;;;;;;;;;;wBAWc,UAAU,SAAS,mBAAmB"}

package/dist/meta/index.js

@@ -0,0 +1,84 @@
+import { t as hashUser } from "../conversion-user-BgpXmIdJ.js";
+import { a as isBrowser } from "../shared-D281USsp.js";
+// src/meta/shared.ts
+const standard = (name, data = {}, user) => ({
+	name,
+	custom: false,
+	data,
+	user
+});
+/**
+* The meta builders: the standard events, and `event(name, data)` for a custom one. What an event
+* definition puts under `meta`.
+*/
+const meta = {
+	/** a standard event by name, for one without its own builder */
+	standard,
+	/** a custom event: any name meta has no standard event for */
+	event: (name, data = {}, user) => ({
+		name,
+		custom: true,
+		data,
+		user
+	}),
+	pageView: () => standard("PageView"),
+	viewContent: (data, user) => standard("ViewContent", data, user),
+	search: (data, user) => standard("Search", data, user),
+	addToCart: (data, user) => standard("AddToCart", data, user),
+	initiateCheckout: (data, user) => standard("InitiateCheckout", data, user),
+	addPaymentInfo: (data, user) => standard("AddPaymentInfo", data, user),
+	purchase: (data, user) => standard("Purchase", data, user),
+	lead: (data, user) => standard("Lead", data, user),
+	completeRegistration: (data, user) => standard("CompleteRegistration", data, user),
+	subscribe: (data, user) => standard("Subscribe", data, user),
+	schedule: (data, user) => standard("Schedule", data, user),
+	contact: (data, user) => standard("Contact", data, user)
+};
+// src/meta/index.ts
+/**
+* The meta pixel as a destination: fires the `meta` payload of an event on this pixel under the
+* event's id, so a conversion the server also reported through the conversions api counts once.
+* The pixel's base code is injected by the cmp after consent, so `window.fbq` shows up late:
+* events wait for it. The identifiers an event carries are hashed and handed to the pixel's
+* advanced matching right before it. `PageView` is an event like any other: track
+* `meta.pageView()` from the layout.
+*/
+function metaPixel(options) {
+	const { pixelId, countryCallingCode } = options;
+	let initializedUserKey;
+	return {
+		name: "meta",
+		ready: () => isBrowser() && typeof globalThis.window.fbq === "function",
+		send: (event, meta) => {
+			Promise.resolve(event.user ? hashUser(event.user, { countryCallingCode }) : void 0).then((hashed) => fire(event, meta, hashed)).catch((error) => console.error("relay: destination meta failed", error));
+		}
+	};
+	function fire(event, meta, hashed) {
+		const fbq = globalThis.window.fbq;
+		if (!fbq) return;
+		identify(fbq, hashed);
+		fbq(event.custom ? "trackSingleCustom" : "trackSingle", pixelId, event.name, event.data, { eventID: meta.id });
+	}
+	function identify(fbq, hashed) {
+		const user = withoutEmpty({
+			em: hashed?.email,
+			ph: hashed?.phone,
+			fn: hashed?.firstName,
+			ln: hashed?.lastName,
+			ct: hashed?.city,
+			zp: hashed?.postalCode,
+			country: hashed?.country,
+			external_id: hashed?.externalId
+		});
+		const key = JSON.stringify(user);
+		if (key === initializedUserKey || Object.keys(user).length === 0) return;
+		initializedUserKey = key;
+		fbq("init", pixelId, user);
+	}
+}
+function withoutEmpty(user) {
+	return Object.fromEntries(Object.entries(user).filter(([, value]) => value));
+}
+export { meta, metaPixel };
+
+//# sourceMappingURL=index.js.map

package/dist/meta/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../../src/meta/shared.ts","../../src/meta/index.ts"],"sourcesContent":["// imported by the pixel and the conversions api — no node or browser imports here\n\nimport type { ConversionUser } from '../conversion-user.js';\n\n/** the standard events meta optimizes on; anything else is a custom event */\nexport type MetaStandardEventName =\n  | 'AddPaymentInfo'\n  | 'AddToCart'\n  | 'AddToWishlist'\n  | 'CompleteRegistration'\n  | 'Contact'\n  | 'CustomizeProduct'\n  | 'Donate'\n  | 'FindLocation'\n  | 'InitiateCheckout'\n  | 'Lead'\n  | 'PageView'\n  | 'Purchase'\n  | 'Schedule'\n  | 'Search'\n  | 'StartTrial'\n  | 'SubmitApplication'\n  | 'Subscribe'\n  | 'ViewContent';\n\n/** an item of `contents` */\nexport type MetaContent = {\n  id: string;\n  quantity: number;\n  item_price?: number | undefined;\n  title?: string | undefined;\n  category?: string | undefined;\n  [key: string]: unknown;\n};\n\n/** the parameters of an event, as the pixel and the conversions api take them under `custom_data` */\nexport type MetaCustomData = {\n  value?: number | undefined;\n  currency?: string | undefined;\n  content_name?: string | undefined;\n  content_category?: string | undefined;\n  content_ids?: readonly string[] | undefined;\n  content_type?: 'product' | 'product_group' | undefined;\n  contents?: readonly MetaContent[] | undefined;\n  num_items?: number | undefined;\n  order_id?: string | undefined;\n  search_string?: string | undefined;\n  status?: string | undefined;\n  predicted_ltv?: number | undefined;\n  [key: string]: unknown;\n};\n\nexport type MetaPurchaseData = MetaCustomData & { value: number; currency: string };\n\n/**\n * What meta takes, from the pixel and from the conversions api alike: the event, its parameters\n * and, for a conversion the visitor entered identifiers for, the identifiers — hashed by whichever\n * half sends them.\n */\nexport type MetaEvent = {\n  name: string;\n  /** a custom event goes through `trackCustom`; a standard one through `track` */\n  custom: boolean;\n  data: MetaCustomData;\n  user?: ConversionUser | undefined;\n};\n\ndeclare module '@astroscope/relay' {\n  interface RelayDestinations {\n    meta: MetaEvent;\n  }\n}\n\nconst standard = (name: MetaStandardEventName, data: MetaCustomData = {}, user?: ConversionUser): MetaEvent => ({\n  name,\n  custom: false,\n  data,\n  user,\n});\n\n/**\n * The meta builders: the standard events, and `event(name, data)` for a custom one. What an event\n * definition puts under `meta`.\n */\nexport const meta = {\n  /** a standard event by name, for one without its own builder */\n  standard,\n  /** a custom event: any name meta has no standard event for */\n  event: (name: string, data: MetaCustomData = {}, user?: ConversionUser): MetaEvent => ({\n    name,\n    custom: true,\n    data,\n    user,\n  }),\n  pageView: (): MetaEvent => standard('PageView'),\n  viewContent: (data: MetaCustomData, user?: ConversionUser): MetaEvent => standard('ViewContent', data, user),\n  search: (data: MetaCustomData, user?: ConversionUser): MetaEvent => standard('Search', data, user),\n  addToCart: (data: MetaCustomData, user?: ConversionUser): MetaEvent => standard('AddToCart', data, user),\n  initiateCheckout: (data: MetaCustomData, user?: ConversionUser): MetaEvent => standard('InitiateCheckout', data, user),\n  addPaymentInfo: (data: MetaCustomData, user?: ConversionUser): MetaEvent => standard('AddPaymentInfo', data, user),\n  purchase: (data: MetaPurchaseData, user?: ConversionUser): MetaEvent => standard('Purchase', data, user),\n  lead: (data?: MetaCustomData, user?: ConversionUser): MetaEvent => standard('Lead', data, user),\n  completeRegistration: (data?: MetaCustomData, user?: ConversionUser): MetaEvent => standard('CompleteRegistration', data, user),\n  subscribe: (data?: MetaCustomData, user?: ConversionUser): MetaEvent => standard('Subscribe', data, user),\n  schedule: (data?: MetaCustomData, user?: ConversionUser): MetaEvent => standard('Schedule', data, user),\n  contact: (data?: MetaCustomData, user?: ConversionUser): MetaEvent => standard('Contact', data, user),\n};\n","import type { Destination } from '../client/bus.js';\nimport { type HashedUser, hashUser } from '../conversion-user.js';\nimport { type EventMeta, isBrowser } from '../shared.js';\nimport type { MetaEvent } from './shared.js';\n\nexport type { MetaContent, MetaCustomData, MetaEvent, MetaPurchaseData, MetaStandardEventName } from './shared.js';\nexport { meta } from './shared.js';\n\n/** the advanced matching data of the pixel: normalized identifiers as lowercase sha256 hex */\ntype MetaPixelUser = {\n  em?: string | undefined;\n  ph?: string | undefined;\n  fn?: string | undefined;\n  ln?: string | undefined;\n  ct?: string | undefined;\n  zp?: string | undefined;\n  country?: string | undefined;\n  external_id?: string | undefined;\n};\n\ntype Fbq = (...args: unknown[]) => void;\n\ndeclare global {\n  interface Window {\n    fbq?: Fbq | undefined;\n  }\n}\n\nexport type MetaPixelOptions = {\n  /** the pixel the base code initialized: the events fire on it alone, the identifiers go to it */\n  pixelId: string;\n  /** the country calling code national phone numbers get before hashing, e.g. `49` */\n  countryCallingCode?: string | undefined;\n};\n\n/**\n * The meta pixel as a destination: fires the `meta` payload of an event on this pixel under the\n * event's id, so a conversion the server also reported through the conversions api counts once.\n * The pixel's base code is injected by the cmp after consent, so `window.fbq` shows up late:\n * events wait for it. The identifiers an event carries are hashed and handed to the pixel's\n * advanced matching right before it. `PageView` is an event like any other: track\n * `meta.pageView()` from the layout.\n */\nexport function metaPixel(options: MetaPixelOptions): Destination<'meta'> {\n  const { pixelId, countryCallingCode } = options;\n  let initializedUserKey: string | undefined;\n\n  return {\n    name: 'meta',\n    ready: () => isBrowser() && typeof globalThis.window.fbq === 'function',\n    send: (event, meta) => {\n      void Promise.resolve(event.user ? hashUser(event.user, { countryCallingCode }) : undefined)\n        .then((hashed) => fire(event, meta, hashed))\n        .catch((error: unknown) => console.error('relay: destination meta failed', error));\n    },\n  };\n\n  function fire(event: MetaEvent, meta: EventMeta, hashed: HashedUser | undefined): void {\n    const fbq = globalThis.window.fbq;\n\n    if (!fbq) return;\n\n    identify(fbq, hashed);\n    fbq(event.custom ? 'trackSingleCustom' : 'trackSingle', pixelId, event.name, event.data, { eventID: meta.id });\n  }\n\n  // the base code initialized the pixel already; a conversion with identifiers initializes it again with them\n  function identify(fbq: Fbq, hashed: HashedUser | undefined): void {\n    const user = withoutEmpty({\n      em: hashed?.email,\n      ph: hashed?.phone,\n      fn: hashed?.firstName,\n      ln: hashed?.lastName,\n      ct: hashed?.city,\n      zp: hashed?.postalCode,\n      country: hashed?.country,\n      external_id: hashed?.externalId,\n    });\n    const key = JSON.stringify(user);\n\n    if (key === initializedUserKey || Object.keys(user).length === 0) {\n      return;\n    }\n\n    initializedUserKey = key;\n    fbq('init', pixelId, user);\n  }\n}\n\nfunction withoutEmpty(user: MetaPixelUser): MetaPixelUser {\n  return Object.fromEntries(Object.entries(user).filter(([, value]) => value)) as MetaPixelUser;\n}\n"],"mappings":";;;AAyEA,MAAM,YAAY,MAA6B,OAAuB,CAAC,GAAG,UAAsC;CAC9G;CACA,QAAQ;CACR;CACA;AACF;;;;;AAMA,MAAa,OAAO;;CAElB;;CAEA,QAAQ,MAAc,OAAuB,CAAC,GAAG,UAAsC;EACrF;EACA,QAAQ;EACR;EACA;CACF;CACA,gBAA2B,SAAS,UAAU;CAC9C,cAAc,MAAsB,SAAqC,SAAS,eAAe,MAAM,IAAI;CAC3G,SAAS,MAAsB,SAAqC,SAAS,UAAU,MAAM,IAAI;CACjG,YAAY,MAAsB,SAAqC,SAAS,aAAa,MAAM,IAAI;CACvG,mBAAmB,MAAsB,SAAqC,SAAS,oBAAoB,MAAM,IAAI;CACrH,iBAAiB,MAAsB,SAAqC,SAAS,kBAAkB,MAAM,IAAI;CACjH,WAAW,MAAwB,SAAqC,SAAS,YAAY,MAAM,IAAI;CACvG,OAAO,MAAuB,SAAqC,SAAS,QAAQ,MAAM,IAAI;CAC9F,uBAAuB,MAAuB,SAAqC,SAAS,wBAAwB,MAAM,IAAI;CAC9H,YAAY,MAAuB,SAAqC,SAAS,aAAa,MAAM,IAAI;CACxG,WAAW,MAAuB,SAAqC,SAAS,YAAY,MAAM,IAAI;CACtG,UAAU,MAAuB,SAAqC,SAAS,WAAW,MAAM,IAAI;AACtG;;;;;;;;;;AC/DA,SAAgB,UAAU,SAAgD;CACxE,MAAM,EAAE,SAAS,uBAAuB;CACxC,IAAI;CAEJ,OAAO;EACL,MAAM;EACN,aAAa,UAAU,KAAK,OAAO,WAAW,OAAO,QAAQ;EAC7D,OAAO,OAAO,SAAS;GACrB,QAAa,QAAQ,MAAM,OAAO,SAAS,MAAM,MAAM,EAAE,mBAAmB,CAAC,IAAI,KAAA,CAAS,CAAC,CACxF,MAAM,WAAW,KAAK,OAAO,MAAM,MAAM,CAAC,CAAC,CAC3C,OAAO,UAAmB,QAAQ,MAAM,kCAAkC,KAAK,CAAC;EACrF;CACF;CAEA,SAAS,KAAK,OAAkB,MAAiB,QAAsC;EACrF,MAAM,MAAM,WAAW,OAAO;EAE9B,IAAI,CAAC,KAAK;EAEV,SAAS,KAAK,MAAM;EACpB,IAAI,MAAM,SAAS,sBAAsB,eAAe,SAAS,MAAM,MAAM,MAAM,MAAM,EAAE,SAAS,KAAK,GAAG,CAAC;CAC/G;CAGA,SAAS,SAAS,KAAU,QAAsC;EAChE,MAAM,OAAO,aAAa;GACxB,IAAI,QAAQ;GACZ,IAAI,QAAQ;GACZ,IAAI,QAAQ;GACZ,IAAI,QAAQ;GACZ,IAAI,QAAQ;GACZ,IAAI,QAAQ;GACZ,SAAS,QAAQ;GACjB,aAAa,QAAQ;EACvB,CAAC;EACD,MAAM,MAAM,KAAK,UAAU,IAAI;EAE/B,IAAI,QAAQ,sBAAsB,OAAO,KAAK,IAAI,CAAC,CAAC,WAAW,GAC7D;EAGF,qBAAqB;EACrB,IAAI,QAAQ,SAAS,IAAI;CAC3B;AACF;AAEA,SAAS,aAAa,MAAoC;CACxD,OAAO,OAAO,YAAY,OAAO,QAAQ,IAAI,CAAC,CAAC,QAAQ,GAAG,WAAW,KAAK,CAAC;AAC7E"}

package/dist/meta/server.d.ts

@@ -0,0 +1,20 @@
+import { a as ServerDestination } from "../runtime-J8VplGyY.js";
+export type MetaConversionsOptions = {
+  /** the system user access token from the events manager */
+  accessToken: string;
+  pixelId: string;
+  /** the code from the events manager's test events tab: the events show up there instead of counting */
+  testEventCode?: string | undefined;
+  /** the country calling code national phone numbers get before hashing, e.g. `49` */
+  countryCallingCode?: string | undefined;
+  /** the graph api version; default the one this package was written against */
+  apiVersion?: string | undefined;
+  fetch?: typeof fetch | undefined;
+};
+/**
+ * The meta conversions api as a server destination: reports the `meta` payload of an event under
+ * the id the pixel fires it with, with the identifiers hashed and the browser and click ids off
+ * the pixel's cookies; a click id the pixel has not stored yet is taken from the page's `fbclid`.
+ */
+export declare function metaConversions(options: MetaConversionsOptions): ServerDestination<'meta'>;
+//# sourceMappingURL=server.d.ts.map

package/dist/meta/server.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"server.d.ts","names":[],"sources":["../../src/meta/server.ts"],"mappings":";YAcY;;EAEV;EACA;;EAEA;;EAEA;;EAEA;EACA,eAAe;;;;;;;wBAQD,gBAAgB,SAAS,yBAAyB"}

package/dist/meta/server.js

@@ -0,0 +1,77 @@
+import { t as hashUser } from "../conversion-user-BgpXmIdJ.js";
+import { t as withoutQuery } from "../source-url-Cqfh3UjO.js";
+// src/meta/server.ts
+const CONVERSIONS_API_URL = "https://graph.facebook.com";
+const CONVERSIONS_API_VERSION = "v24.0";
+const CONVERSIONS_API_TIMEOUT_MS = 1e4;
+/** the cookies the pixel sets: the browser id, and the click id of the visitor who came from a meta ad */
+const BROWSER_ID_COOKIE = "_fbp";
+const CLICK_ID_COOKIE = "_fbc";
+const CLICK_ID_PARAM = "fbclid";
+/**
+* The meta conversions api as a server destination: reports the `meta` payload of an event under
+* the id the pixel fires it with, with the identifiers hashed and the browser and click ids off
+* the pixel's cookies; a click id the pixel has not stored yet is taken from the page's `fbclid`.
+*/
+function metaConversions(options) {
+	const doFetch = options.fetch ?? fetch;
+	const url = `${CONVERSIONS_API_URL}/${options.apiVersion ?? CONVERSIONS_API_VERSION}/${encodeURIComponent(options.pixelId)}/events`;
+	return {
+		name: "meta",
+		async send(event, { id, at, request }) {
+			const hashed = await hashUser(event.user ?? {}, { countryCallingCode: options.countryCallingCode });
+			const body = {
+				access_token: options.accessToken,
+				...options.testEventCode && { test_event_code: options.testEventCode },
+				data: [{
+					event_name: event.name,
+					event_time: Math.floor(at / 1e3),
+					event_id: id,
+					event_source_url: withoutQuery(request.sourceUrl),
+					action_source: "website",
+					user_data: withoutEmpty({
+						em: toList(hashed.email),
+						ph: toList(hashed.phone),
+						fn: toList(hashed.firstName),
+						ln: toList(hashed.lastName),
+						ct: toList(hashed.city),
+						zp: toList(hashed.postalCode),
+						country: toList(hashed.country),
+						external_id: toList(hashed.externalId),
+						client_ip_address: request.clientAddress,
+						client_user_agent: request.headers.get("user-agent") ?? void 0,
+						fbp: request.cookie(BROWSER_ID_COOKIE),
+						fbc: request.cookie(CLICK_ID_COOKIE) ?? clickIdOf(request, at)
+					}),
+					custom_data: event.data
+				}]
+			};
+			const response = await doFetch(url, {
+				method: "POST",
+				headers: { "content-type": "application/json" },
+				body: JSON.stringify(body),
+				signal: AbortSignal.timeout(CONVERSIONS_API_TIMEOUT_MS)
+			});
+			if (!response.ok) throw new Error(`conversions api responded ${response.status}: ${await response.text()}`);
+		}
+	};
+}
+/** the click id in the pixel's cookie format, from the `fbclid` of the page the conversion happened on */
+function clickIdOf(request, at) {
+	let fbclid;
+	try {
+		fbclid = new URL(request.sourceUrl).searchParams.get(CLICK_ID_PARAM);
+	} catch {
+		return;
+	}
+	return fbclid ? `fb.1.${at}.${fbclid}` : void 0;
+}
+function toList(value) {
+	return value ? [value] : void 0;
+}
+function withoutEmpty(data) {
+	return Object.fromEntries(Object.entries(data).filter(([, value]) => value !== void 0));
+}
+export { metaConversions };
+
+//# sourceMappingURL=server.js.map

package/dist/meta/server.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"server.js","names":[],"sources":["../../src/meta/server.ts"],"sourcesContent":["import { hashUser } from '../conversion-user.js';\nimport type { RelayRequest, ServerDestination } from '../runtime.js';\nimport { withoutQuery } from '../source-url.js';\nimport type { MetaEvent } from './shared.js';\n\nconst CONVERSIONS_API_URL = 'https://graph.facebook.com';\nconst CONVERSIONS_API_VERSION = 'v24.0';\nconst CONVERSIONS_API_TIMEOUT_MS = 10_000;\n\n/** the cookies the pixel sets: the browser id, and the click id of the visitor who came from a meta ad */\nconst BROWSER_ID_COOKIE = '_fbp';\nconst CLICK_ID_COOKIE = '_fbc';\nconst CLICK_ID_PARAM = 'fbclid';\n\nexport type MetaConversionsOptions = {\n  /** the system user access token from the events manager */\n  accessToken: string;\n  pixelId: string;\n  /** the code from the events manager's test events tab: the events show up there instead of counting */\n  testEventCode?: string | undefined;\n  /** the country calling code national phone numbers get before hashing, e.g. `49` */\n  countryCallingCode?: string | undefined;\n  /** the graph api version; default the one this package was written against */\n  apiVersion?: string | undefined;\n  fetch?: typeof fetch | undefined;\n};\n\n/**\n * The meta conversions api as a server destination: reports the `meta` payload of an event under\n * the id the pixel fires it with, with the identifiers hashed and the browser and click ids off\n * the pixel's cookies; a click id the pixel has not stored yet is taken from the page's `fbclid`.\n */\nexport function metaConversions(options: MetaConversionsOptions): ServerDestination<'meta'> {\n  const doFetch = options.fetch ?? fetch;\n  const url = `${CONVERSIONS_API_URL}/${options.apiVersion ?? CONVERSIONS_API_VERSION}/${encodeURIComponent(options.pixelId)}/events`;\n\n  return {\n    name: 'meta',\n    async send(event: MetaEvent, { id, at, request }) {\n      const hashed = await hashUser(event.user ?? {}, { countryCallingCode: options.countryCallingCode });\n      const body = {\n        access_token: options.accessToken,\n        ...(options.testEventCode && { test_event_code: options.testEventCode }),\n        data: [\n          {\n            event_name: event.name,\n            event_time: Math.floor(at / 1000),\n            event_id: id,\n            event_source_url: withoutQuery(request.sourceUrl),\n            action_source: 'website',\n            user_data: withoutEmpty({\n              em: toList(hashed.email),\n              ph: toList(hashed.phone),\n              fn: toList(hashed.firstName),\n              ln: toList(hashed.lastName),\n              ct: toList(hashed.city),\n              zp: toList(hashed.postalCode),\n              country: toList(hashed.country),\n              external_id: toList(hashed.externalId),\n              client_ip_address: request.clientAddress,\n              client_user_agent: request.headers.get('user-agent') ?? undefined,\n              fbp: request.cookie(BROWSER_ID_COOKIE),\n              fbc: request.cookie(CLICK_ID_COOKIE) ?? clickIdOf(request, at),\n            }),\n            custom_data: event.data,\n          },\n        ],\n      };\n\n      const response = await doFetch(url, {\n        method: 'POST',\n        headers: { 'content-type': 'application/json' },\n        body: JSON.stringify(body),\n        signal: AbortSignal.timeout(CONVERSIONS_API_TIMEOUT_MS),\n      });\n\n      if (!response.ok) {\n        throw new Error(`conversions api responded ${response.status}: ${await response.text()}`);\n      }\n    },\n  };\n}\n\n/** the click id in the pixel's cookie format, from the `fbclid` of the page the conversion happened on */\nfunction clickIdOf(request: RelayRequest, at: number): string | undefined {\n  let fbclid: string | null;\n\n  try {\n    fbclid = new URL(request.sourceUrl).searchParams.get(CLICK_ID_PARAM);\n  } catch {\n    return undefined;\n  }\n\n  return fbclid ? `fb.1.${at}.${fbclid}` : undefined;\n}\n\nfunction toList(value: string | undefined): string[] | undefined {\n  return value ? [value] : undefined;\n}\n\nfunction withoutEmpty<T extends Record<string, unknown>>(data: T): Partial<T> {\n  return Object.fromEntries(Object.entries(data).filter(([, value]) => value !== undefined)) as Partial<T>;\n}\n"],"mappings":";;;AAKA,MAAM,sBAAsB;AAC5B,MAAM,0BAA0B;AAChC,MAAM,6BAA6B;;AAGnC,MAAM,oBAAoB;AAC1B,MAAM,kBAAkB;AACxB,MAAM,iBAAiB;;;;;;AAoBvB,SAAgB,gBAAgB,SAA4D;CAC1F,MAAM,UAAU,QAAQ,SAAS;CACjC,MAAM,MAAM,GAAG,oBAAoB,GAAG,QAAQ,cAAc,wBAAwB,GAAG,mBAAmB,QAAQ,OAAO,EAAE;CAE3H,OAAO;EACL,MAAM;EACN,MAAM,KAAK,OAAkB,EAAE,IAAI,IAAI,WAAW;GAChD,MAAM,SAAS,MAAM,SAAS,MAAM,QAAQ,CAAC,GAAG,EAAE,oBAAoB,QAAQ,mBAAmB,CAAC;GAClG,MAAM,OAAO;IACX,cAAc,QAAQ;IACtB,GAAI,QAAQ,iBAAiB,EAAE,iBAAiB,QAAQ,cAAc;IACtE,MAAM,CACJ;KACE,YAAY,MAAM;KAClB,YAAY,KAAK,MAAM,KAAK,GAAI;KAChC,UAAU;KACV,kBAAkB,aAAa,QAAQ,SAAS;KAChD,eAAe;KACf,WAAW,aAAa;MACtB,IAAI,OAAO,OAAO,KAAK;MACvB,IAAI,OAAO,OAAO,KAAK;MACvB,IAAI,OAAO,OAAO,SAAS;MAC3B,IAAI,OAAO,OAAO,QAAQ;MAC1B,IAAI,OAAO,OAAO,IAAI;MACtB,IAAI,OAAO,OAAO,UAAU;MAC5B,SAAS,OAAO,OAAO,OAAO;MAC9B,aAAa,OAAO,OAAO,UAAU;MACrC,mBAAmB,QAAQ;MAC3B,mBAAmB,QAAQ,QAAQ,IAAI,YAAY,KAAK,KAAA;MACxD,KAAK,QAAQ,OAAO,iBAAiB;MACrC,KAAK,QAAQ,OAAO,eAAe,KAAK,UAAU,SAAS,EAAE;KAC/D,CAAC;KACD,aAAa,MAAM;IACrB,CACF;GACF;GAEA,MAAM,WAAW,MAAM,QAAQ,KAAK;IAClC,QAAQ;IACR,SAAS,EAAE,gBAAgB,mBAAmB;IAC9C,MAAM,KAAK,UAAU,IAAI;IACzB,QAAQ,YAAY,QAAQ,0BAA0B;GACxD,CAAC;GAED,IAAI,CAAC,SAAS,IACZ,MAAM,IAAI,MAAM,6BAA6B,SAAS,OAAO,IAAI,MAAM,SAAS,KAAK,GAAG;EAE5F;CACF;AACF;;AAGA,SAAS,UAAU,SAAuB,IAAgC;CACxE,IAAI;CAEJ,IAAI;EACF,SAAS,IAAI,IAAI,QAAQ,SAAS,CAAC,CAAC,aAAa,IAAI,cAAc;CACrE,QAAQ;EACN;CACF;CAEA,OAAO,SAAS,QAAQ,GAAG,GAAG,WAAW,KAAA;AAC3C;AAEA,SAAS,OAAO,OAAiD;CAC/D,OAAO,QAAQ,CAAC,KAAK,IAAI,KAAA;AAC3B;AAEA,SAAS,aAAgD,MAAqB;CAC5E,OAAO,OAAO,YAAY,OAAO,QAAQ,IAAI,CAAC,CAAC,QAAQ,GAAG,WAAW,UAAU,KAAA,CAAS,CAAC;AAC3F"}

package/dist/openai/index.d.ts

@@ -1,33 +1,59 @@
 import { a as Destination } from "../bus-Z7l8oJtS.js";
-import { t as ConversionUser } from "../conversion-user-DCfM5EuZ.js";
+import { t as ConversionUser } from "../conversion-user-fHh2xXBc.js";
 /** monetary values are integers in the minor unit of the currency: 12999 for 129.99 EUR */
 type OpenAiContent = {
-  id: string;
-  name: string;
-  content_type: string;
-  quantity: number;
-  amount: number;
-  currency: string;
+  id?: string | undefined;
+  name?: string | undefined;
+  /** e.g. `product`, `plan`, `page` */
+  content_type?: string | undefined;
+  quantity?: number | undefined;
+  /** per unit */
+  amount?: number | undefined;
+  currency?: string | undefined;
+};
+/** what every data shape may carry: the money, and the items, where the event has any */
+type OpenAiBaseData = {
+  amount?: number | undefined;
+  /** required with `amount` */
+  currency?: string | undefined;
+  contents?: readonly OpenAiContent[] | undefined;
 };
-type OpenAiContentsData = {
+type OpenAiContentsData = OpenAiBaseData & {
   type: 'contents';
-  amount: number;
-  currency: string;
-  contents: readonly OpenAiContent[];
 };
-type OpenAiCustomerActionData = {
+type OpenAiCustomerActionData = Omit<OpenAiBaseData, 'contents'> & {
   type: 'customer_action';
 };
+type OpenAiPlanEnrollmentData = OpenAiBaseData & {
+  type: 'plan_enrollment';
+  plan_id?: string | undefined;
+};
+type OpenAiCustomData = OpenAiBaseData & {
+  type: 'custom';
+  plan_id?: string | undefined;
+};
+type OpenAiContentsEventName = 'contents_viewed' | 'items_added' | 'checkout_started' | 'order_created' | 'page_viewed';
+type OpenAiCustomerActionEventName = 'lead_created' | 'registration_completed' | 'appointment_scheduled';
+type OpenAiPlanEnrollmentEventName = 'subscription_created' | 'trial_started';
 /**
  * What openai takes, from the pixel and from the conversions api alike: the event and, for a
  * conversion the visitor entered identifiers for, the identifiers — hashed by whichever half sends.
+ * The app events (`app_installed`, `app_opened`) are a mobile app's, not a website's, and have no builder.
  */
 type OpenAiEvent = ({
-  name: 'contents_viewed' | 'items_added' | 'checkout_started' | 'order_created';
+  name: OpenAiContentsEventName;
   data: OpenAiContentsData;
 } | {
-  name: 'lead_created';
+  name: OpenAiCustomerActionEventName;
   data: OpenAiCustomerActionData;
+} | {
+  name: OpenAiPlanEnrollmentEventName;
+  data: OpenAiPlanEnrollmentData;
+} | {
+  name: 'custom';
+  /** 1 to 64 lowercase letters, digits, underscores or dashes, no standard event's name */
+  customName: string;
+  data: OpenAiCustomData;
 }) & {
   user?: ConversionUser | undefined;
 };
@@ -36,12 +62,18 @@ declare module '@astroscope/relay' {
     openai: OpenAiEvent;
   }
 }
+/** an item as the site has it: the price in the major unit, 129.99 for 129.99 EUR */
 type OpenAiContentInput = {
   id: string;
   name: string;
   price: number;
   quantity: number;
 };
+/** the money of an event: the total in the major unit, and its currency */
+type OpenAiMoney = {
+  value: number;
+  currency: string;
+};
 type OpenAiContents = {
   items: readonly OpenAiContentInput[];
   currency: string;
@@ -51,13 +83,40 @@ type OpenAiContents = {
   contentType?: string | undefined;
   user?: ConversionUser | undefined;
 };
-/** the openai builders: the events openai has a name for. What an event definition puts under `openai` */
+type OpenAiPlan = {
+  /** the site's plan identifier */
+  id?: string | undefined;
+  money?: OpenAiMoney | undefined;
+  /** the plan's items, if any; `content_type` `plan` by default */
+  items?: readonly OpenAiContentInput[] | undefined;
+  contentType?: string | undefined;
+  user?: ConversionUser | undefined;
+};
+type OpenAiCustom = OpenAiPlan & {
+  /** the `content_type` of the items; default `product` */
+  contentType?: string | undefined;
+};
+/**
+ * The openai builders: every event openai has a name for, and `custom(name)`. What an event
+ * definition puts under `openai`.
+ */
 export declare const openai: {
   contentsViewed: (contents: OpenAiContents) => OpenAiEvent;
   itemsAdded: (contents: OpenAiContents) => OpenAiEvent;
   checkoutStarted: (contents: OpenAiContents) => OpenAiEvent;
   orderCreated: (contents: OpenAiContents) => OpenAiEvent;
-  leadCreated: (user?: ConversionUser) => OpenAiEvent;
+  /** the page as a content: its id is what the reports group by, e.g. the path */
+  pageViewed: (page: {
+    id: string;
+    name: string;
+  }) => OpenAiEvent;
+  leadCreated: (user?: ConversionUser, money?: OpenAiMoney) => OpenAiEvent;
+  registrationCompleted: (user?: ConversionUser, money?: OpenAiMoney) => OpenAiEvent;
+  appointmentScheduled: (user?: ConversionUser, money?: OpenAiMoney) => OpenAiEvent;
+  subscriptionCreated: (plan?: OpenAiPlan) => OpenAiEvent;
+  trialStarted: (plan?: OpenAiPlan) => OpenAiEvent;
+  /** a custom event: any name openai has no standard event for */
+  custom: (name: string, { id, money, items, contentType, user }?: OpenAiCustom) => OpenAiEvent;
 };
 export declare function toMinorUnits(value: number): number;
 /** advanced matching data of the pixel: normalized identifiers as lowercase sha256 hex */
@@ -70,6 +129,8 @@ type OpenAiUser = {
 type OpenAiOptions = {
   /** deduplicates against the same event sent through the conversions api */
   event_id?: string | undefined;
+  /** the name of a `custom` event; no standard event takes one */
+  custom_event_name?: string | undefined;
 };
 type Oaiq = {
   (command: 'init', options: {
@@ -93,5 +154,5 @@ export type OpenAiPixelOptions = {
  * identifiers an event carries are hashed and sent through `init` right before it.
  */
 export declare function openAiPixel(options?: OpenAiPixelOptions): Destination<'openai'>;
-export type { OpenAiContent, OpenAiContentInput, OpenAiContents, OpenAiContentsData, OpenAiCustomerActionData, OpenAiEvent };
+export type { OpenAiContent, OpenAiContentInput, OpenAiContents, OpenAiContentsData, OpenAiCustom, OpenAiCustomData, OpenAiCustomerActionData, OpenAiEvent, OpenAiMoney, OpenAiPlan, OpenAiPlanEnrollmentData };
 //# sourceMappingURL=index.d.ts.map

package/dist/openai/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","names":["_0"],"sources":["../../src/openai/shared.ts","../../src/openai/index.ts"],"mappings":";;;KAKY;EACV;EACA;EACA;EACA;EACA;EACA;;KAGU;EACV;EACA;EACA;EACA,mBAAmB;;KAGT;EACV;;;;;;KAOU;EAER;EACA,MAAM;;EAGN;EACA,MAAM;;EAGR,OAAO;;;YAIG;IACR,QAAQ;;;KAIA;EAAuB;EAAY;EAAc;EAAe;;KAEhE;EACV,gBAAgB;EAChB;;EAEA;;EAEA;EACA,OAAO;;;qBAII;EACgB,iBAAA,UAAA,mBAAiB;EACrB,aAAA,UAAA,mBAAiB;EACZ,kBAAA,UAAA,mBAAiB;EACpB,eAAA,UAAA,mBAAiB;EACrB,cAAA,OAAA,mBAAiB;;wBA4BxB,aAAa;;KCrFxB;EACH;EACA;EACA;EACA;;KAGG;;EAEH;;KAGG;GACF,iBAAiB;IAAW,MAAM;;GAClC,oBAAoB,MAAM,qBAAqB,MAAM,qBAAqB,UAAU;;QAG/E;YACI;IACR,OAAO;;;YAIC;;EAEV;;;;;;;;wBAWc,YAAY,UAAS,qBAA0B"}
+{"version":3,"file":"index.d.ts","names":["_0"],"sources":["../../src/openai/shared.ts","../../src/openai/index.ts"],"mappings":";;;KAKY;EACV;EACA;;EAEA;EACA;;EAEA;EACA;;;KAIG;EACH;;EAEA;EACA,oBAAoB;;KAGV,qBAAqB;EAC/B;;KAGU,2BAA2B,KAAK;EAC1C;;KAGU,2BAA2B;EACrC;EACA;;KAGU,mBAAmB;EAC7B;EACA;;KAGU;KACA;KACA;;;;;;KAOA;EAER,MAAM;EACN,MAAM;;EAGN,MAAM;EACN,MAAM;;EAGN,MAAM;EACN,MAAM;;EAGN;;EAEA;EACA,MAAM;;EAGR,OAAO;;;YAIG;IACR,QAAQ;;;;KAKA;EAAuB;EAAY;EAAc;EAAe;;;KAGhE;EAAgB;EAAe;;KAE/B;EACV,gBAAgB;EAChB;;EAEA;;EAEA;EACA,OAAO;;KAGG;;EAEV;EACA,QAAQ;;EAER,iBAAiB;EACjB;EACA,OAAO;;KAGG,eAAe;;EAEzB;;;;;;qBAOW;EACgB,iBAAA,UAAA,mBAAiB;EACrB,aAAA,UAAA,mBAAiB;EACZ,kBAAA,UAAA,mBAAiB;EACpB,eAAA,UAAA,mBAAiB;;EAEvB,aAAA;IAAE;IAAY;QAAiB;EAI7B,cAAA,OAAA,gBAAc,QAAU,gBAAc;EAC5B,wBAAA,OAAA,gBAAc,QAAU,gBAAc;EAEvC,uBAAA,OAAA,gBAAc,QAAU,gBAAc;EAExC,sBAAA,OAAA,eAAkB;EACzB,eAAA,OAAA,eAAkB;;EAExB,SAAA,gBAAM,IAAA,OAAA,OAAA,aAAA,SAAuD,iBAAoB;;wBAqDlF,aAAa;;KCrKxB;EACH;EACA;EACA;EACA;;KAGG;;EAEH;;EAEA;;KAGG;GACF,iBAAiB;IAAW,MAAM;;GAClC,oBAAoB,MAAM,qBAAqB,MAAM,qBAAqB,UAAU;;QAG/E;YACI;IACR,OAAO;;;YAIC;;EAEV;;;;;;;;wBAWc,YAAY,UAAS,qBAA0B"}

package/dist/openai/index.js

@@ -1,15 +1,42 @@
-import { t as hashUser } from "../conversion-user-CV8xIWDK.js";
+import { t as hashUser } from "../conversion-user-BgpXmIdJ.js";
 import { a as isBrowser } from "../shared-D281USsp.js";
 // src/openai/shared.ts
-/** the openai builders: the events openai has a name for. What an event definition puts under `openai` */
+/**
+* The openai builders: every event openai has a name for, and `custom(name)`. What an event
+* definition puts under `openai`.
+*/
 const openai = {
 	contentsViewed: (contents) => contentsEvent("contents_viewed", contents),
 	itemsAdded: (contents) => contentsEvent("items_added", contents),
 	checkoutStarted: (contents) => contentsEvent("checkout_started", contents),
 	orderCreated: (contents) => contentsEvent("order_created", contents),
-	leadCreated: (user) => ({
-		name: "lead_created",
-		data: { type: "customer_action" },
+	/** the page as a content: its id is what the reports group by, e.g. the path */
+	pageViewed: (page) => ({
+		name: "page_viewed",
+		data: {
+			type: "contents",
+			contents: [{
+				id: page.id,
+				name: page.name,
+				content_type: "page"
+			}]
+		}
+	}),
+	leadCreated: (user, money) => actionEvent("lead_created", user, money),
+	registrationCompleted: (user, money) => actionEvent("registration_completed", user, money),
+	appointmentScheduled: (user, money) => actionEvent("appointment_scheduled", user, money),
+	subscriptionCreated: (plan = {}) => planEvent("subscription_created", plan),
+	trialStarted: (plan = {}) => planEvent("trial_started", plan),
+	/** a custom event: any name openai has no standard event for */
+	custom: (name, { id, money, items, contentType = "product", user } = {}) => ({
+		name: "custom",
+		customName: name,
+		data: {
+			type: "custom",
+			plan_id: id,
+			...toMoneyData(money),
+			...toContentsData(items, contentType, money?.currency)
+		},
 		user
 	})
 };
@@ -18,20 +45,54 @@ function contentsEvent(name, { items, currency, value, contentType = "product",
 		name,
 		data: {
 			type: "contents",
-			amount: toMinorUnits(value ?? items.reduce((sum, item) => sum + item.price * item.quantity, 0)),
-			currency,
-			contents: items.map((item) => ({
-				id: item.id,
-				name: item.name,
-				content_type: contentType,
-				quantity: item.quantity,
-				amount: toMinorUnits(item.price),
+			...toMoneyData({
+				value: value ?? items.reduce((sum, item) => sum + item.price * item.quantity, 0),
 				currency
-			}))
+			}),
+			...toContentsData(items, contentType, currency)
+		},
+		user
+	};
+}
+function actionEvent(name, user, money) {
+	return {
+		name,
+		data: {
+			type: "customer_action",
+			...toMoneyData(money)
+		},
+		user
+	};
+}
+function planEvent(name, { id, money, items, contentType = "plan", user }) {
+	return {
+		name,
+		data: {
+			type: "plan_enrollment",
+			plan_id: id,
+			...toMoneyData(money),
+			...toContentsData(items, contentType, money?.currency)
 		},
 		user
 	};
 }
+function toMoneyData(money) {
+	return money ? {
+		amount: toMinorUnits(money.value),
+		currency: money.currency
+	} : {};
+}
+function toContentsData(items, contentType, currency) {
+	if (!items) return {};
+	return { contents: items.map((item) => ({
+		id: item.id,
+		name: item.name,
+		content_type: contentType,
+		quantity: item.quantity,
+		amount: toMinorUnits(item.price),
+		currency
+	})) };
+}
 function toMinorUnits(value) {
 	return Math.round(value * 100);
 }
@@ -57,7 +118,10 @@ function measure(event, meta, hashed) {
 	const oaiq = window.oaiq;
 	if (!oaiq) return;
 	if (hashed) identify(oaiq, hashed);
-	oaiq("measure", event.name, event.data, { event_id: meta.id });
+	oaiq("measure", event.name, event.data, {
+		event_id: meta.id,
+		...event.name === "custom" && { custom_event_name: event.customName }
+	});
 }
 function identify(oaiq, hashed) {
 	const user = withoutEmpty({

package/dist/openai/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../../src/openai/shared.ts","../../src/openai/index.ts"],"sourcesContent":["// imported by the pixel and the conversions api — no node or browser imports here\n\nimport type { ConversionUser } from '../conversion-user.js';\n\n/** monetary values are integers in the minor unit of the currency: 12999 for 129.99 EUR */\nexport type OpenAiContent = {\n  id: string;\n  name: string;\n  content_type: string;\n  quantity: number;\n  amount: number;\n  currency: string;\n};\n\nexport type OpenAiContentsData = {\n  type: 'contents';\n  amount: number;\n  currency: string;\n  contents: readonly OpenAiContent[];\n};\n\nexport type OpenAiCustomerActionData = {\n  type: 'customer_action';\n};\n\n/**\n * What openai takes, from the pixel and from the conversions api alike: the event and, for a\n * conversion the visitor entered identifiers for, the identifiers — hashed by whichever half sends.\n */\nexport type OpenAiEvent = (\n  | {\n    name: 'contents_viewed' | 'items_added' | 'checkout_started' | 'order_created';\n    data: OpenAiContentsData;\n  }\n  | {\n    name: 'lead_created';\n    data: OpenAiCustomerActionData;\n  }\n) & {\n  user?: ConversionUser | undefined;\n};\n\ndeclare module '@astroscope/relay' {\n  interface RelayDestinations {\n    openai: OpenAiEvent;\n  }\n}\n\nexport type OpenAiContentInput = { id: string; name: string; price: number; quantity: number };\n\nexport type OpenAiContents = {\n  items: readonly OpenAiContentInput[];\n  currency: string;\n  /** the total; default: the items summed */\n  value?: number | undefined;\n  /** the `content_type` of the contents; default `product` */\n  contentType?: string | undefined;\n  user?: ConversionUser | undefined;\n};\n\n/** the openai builders: the events openai has a name for. What an event definition puts under `openai` */\nexport const openai = {\n  contentsViewed: (contents: OpenAiContents): OpenAiEvent => contentsEvent('contents_viewed', contents),\n  itemsAdded: (contents: OpenAiContents): OpenAiEvent => contentsEvent('items_added', contents),\n  checkoutStarted: (contents: OpenAiContents): OpenAiEvent => contentsEvent('checkout_started', contents),\n  orderCreated: (contents: OpenAiContents): OpenAiEvent => contentsEvent('order_created', contents),\n  leadCreated: (user?: ConversionUser): OpenAiEvent => ({ name: 'lead_created', data: { type: 'customer_action' }, user }),\n};\n\nfunction contentsEvent(\n  name: 'contents_viewed' | 'items_added' | 'checkout_started' | 'order_created',\n  { items, currency, value, contentType = 'product', user }: OpenAiContents,\n): OpenAiEvent {\n  const total = value ?? items.reduce((sum, item) => sum + item.price * item.quantity, 0);\n\n  return {\n    name,\n    data: {\n      type: 'contents',\n      amount: toMinorUnits(total),\n      currency,\n      contents: items.map((item) => ({\n        id: item.id,\n        name: item.name,\n        content_type: contentType,\n        quantity: item.quantity,\n        amount: toMinorUnits(item.price),\n        currency,\n      })),\n    },\n    user,\n  };\n}\n\nexport function toMinorUnits(value: number): number {\n  return Math.round(value * 100);\n}\n","import type { Destination } from '../client/bus.js';\nimport { type HashedUser, hashUser } from '../conversion-user.js';\nimport { type EventMeta, isBrowser } from '../shared.js';\nimport type { OpenAiEvent } from './shared.js';\n\nexport type { OpenAiContent, OpenAiContentInput, OpenAiContents, OpenAiContentsData, OpenAiCustomerActionData, OpenAiEvent } from './shared.js';\nexport { openai, toMinorUnits } from './shared.js';\n\n/** advanced matching data of the pixel: normalized identifiers as lowercase sha256 hex */\ntype OpenAiUser = {\n  email_sha256?: string | undefined;\n  phone_number_sha256?: string | undefined;\n  first_name_sha256?: string | undefined;\n  last_name_sha256?: string | undefined;\n};\n\ntype OpenAiOptions = {\n  /** deduplicates against the same event sent through the conversions api */\n  event_id?: string | undefined;\n};\n\ntype Oaiq = {\n  (command: 'init', options: { user: OpenAiUser }): void;\n  (command: 'measure', name: OpenAiEvent['name'], data: OpenAiEvent['data'], options?: OpenAiOptions): void;\n};\n\ndeclare global {\n  interface Window {\n    oaiq?: Oaiq | undefined;\n  }\n}\n\nexport type OpenAiPixelOptions = {\n  /** the country calling code national phone numbers get before hashing, e.g. `49` */\n  countryCallingCode?: string | undefined;\n};\n\nlet initializedUserKey: string | undefined;\n\n/**\n * The openai ads pixel as a destination: measures the `openai` payload of an event under the event's\n * id, so a conversion the server also reported through the conversions api counts once. The pixel\n * is injected by the cmp after consent, so `window.oaiq` shows up late: events wait for it. The\n * identifiers an event carries are hashed and sent through `init` right before it.\n */\nexport function openAiPixel(options: OpenAiPixelOptions = {}): Destination<'openai'> {\n  return {\n    name: 'openai',\n    ready: () => isBrowser() && typeof globalThis.window.oaiq === 'function',\n    send: (event, meta) => {\n      const user = event.user ? hashUser(event.user, { countryCallingCode: options.countryCallingCode }) : undefined;\n\n      void Promise.resolve(user)\n        .then((hashed) => measure(event, meta, hashed))\n        .catch((error: unknown) => console.error('relay: destination openai failed', error));\n    },\n  };\n}\n\nfunction measure(event: OpenAiEvent, meta: EventMeta, hashed: HashedUser | undefined): void {\n  const oaiq = window.oaiq;\n\n  if (!oaiq) return;\n\n  if (hashed) {\n    identify(oaiq, hashed);\n  }\n\n  oaiq('measure', event.name, event.data as OpenAiEvent['data'], { event_id: meta.id });\n}\n\nfunction identify(oaiq: Oaiq, hashed: HashedUser): void {\n  const user = withoutEmpty({\n    email_sha256: hashed.email,\n    phone_number_sha256: hashed.phone,\n    first_name_sha256: hashed.firstName,\n    last_name_sha256: hashed.lastName,\n  });\n  const key = JSON.stringify(user);\n\n  if (key === initializedUserKey || Object.keys(user).length === 0) {\n    return;\n  }\n\n  initializedUserKey = key;\n  oaiq('init', { user });\n}\n\nfunction withoutEmpty(user: OpenAiUser): OpenAiUser {\n  return Object.fromEntries(Object.entries(user).filter(([, value]) => value)) as OpenAiUser;\n}\n"],"mappings":";;;;AA6DA,MAAa,SAAS;CACpB,iBAAiB,aAA0C,cAAc,mBAAmB,QAAQ;CACpG,aAAa,aAA0C,cAAc,eAAe,QAAQ;CAC5F,kBAAkB,aAA0C,cAAc,oBAAoB,QAAQ;CACtG,eAAe,aAA0C,cAAc,iBAAiB,QAAQ;CAChG,cAAc,UAAwC;EAAE,MAAM;EAAgB,MAAM,EAAE,MAAM,kBAAkB;EAAG;CAAK;AACxH;AAEA,SAAS,cACP,MACA,EAAE,OAAO,UAAU,OAAO,cAAc,WAAW,QACtC;CAGb,OAAO;EACL;EACA,MAAM;GACJ,MAAM;GACN,QAAQ,aANE,SAAS,MAAM,QAAQ,KAAK,SAAS,MAAM,KAAK,QAAQ,KAAK,UAAU,CAAC,CAMxD;GAC1B;GACA,UAAU,MAAM,KAAK,UAAU;IAC7B,IAAI,KAAK;IACT,MAAM,KAAK;IACX,cAAc;IACd,UAAU,KAAK;IACf,QAAQ,aAAa,KAAK,KAAK;IAC/B;GACF,EAAE;EACJ;EACA;CACF;AACF;AAEA,SAAgB,aAAa,OAAuB;CAClD,OAAO,KAAK,MAAM,QAAQ,GAAG;AAC/B;;AC3DA,IAAI;;;;;;;AAQJ,SAAgB,YAAY,UAA8B,CAAC,GAA0B;CACnF,OAAO;EACL,MAAM;EACN,aAAa,UAAU,KAAK,OAAO,WAAW,OAAO,SAAS;EAC9D,OAAO,OAAO,SAAS;GACrB,MAAM,OAAO,MAAM,OAAO,SAAS,MAAM,MAAM,EAAE,oBAAoB,QAAQ,mBAAmB,CAAC,IAAI,KAAA;GAErG,QAAa,QAAQ,IAAI,CAAC,CACvB,MAAM,WAAW,QAAQ,OAAO,MAAM,MAAM,CAAC,CAAC,CAC9C,OAAO,UAAmB,QAAQ,MAAM,oCAAoC,KAAK,CAAC;EACvF;CACF;AACF;AAEA,SAAS,QAAQ,OAAoB,MAAiB,QAAsC;CAC1F,MAAM,OAAO,OAAO;CAEpB,IAAI,CAAC,MAAM;CAEX,IAAI,QACF,SAAS,MAAM,MAAM;CAGvB,KAAK,WAAW,MAAM,MAAM,MAAM,MAA6B,EAAE,UAAU,KAAK,GAAG,CAAC;AACtF;AAEA,SAAS,SAAS,MAAY,QAA0B;CACtD,MAAM,OAAO,aAAa;EACxB,cAAc,OAAO;EACrB,qBAAqB,OAAO;EAC5B,mBAAmB,OAAO;EAC1B,kBAAkB,OAAO;CAC3B,CAAC;CACD,MAAM,MAAM,KAAK,UAAU,IAAI;CAE/B,IAAI,QAAQ,sBAAsB,OAAO,KAAK,IAAI,CAAC,CAAC,WAAW,GAC7D;CAGF,qBAAqB;CACrB,KAAK,QAAQ,EAAE,KAAK,CAAC;AACvB;AAEA,SAAS,aAAa,MAA8B;CAClD,OAAO,OAAO,YAAY,OAAO,QAAQ,IAAI,CAAC,CAAC,QAAQ,GAAG,WAAW,KAAK,CAAC;AAC7E"}
+{"version":3,"file":"index.js","names":[],"sources":["../../src/openai/shared.ts","../../src/openai/index.ts"],"sourcesContent":["// imported by the pixel and the conversions api — no node or browser imports here\n\nimport type { ConversionUser } from '../conversion-user.js';\n\n/** monetary values are integers in the minor unit of the currency: 12999 for 129.99 EUR */\nexport type OpenAiContent = {\n  id?: string | undefined;\n  name?: string | undefined;\n  /** e.g. `product`, `plan`, `page` */\n  content_type?: string | undefined;\n  quantity?: number | undefined;\n  /** per unit */\n  amount?: number | undefined;\n  currency?: string | undefined;\n};\n\n/** what every data shape may carry: the money, and the items, where the event has any */\ntype OpenAiBaseData = {\n  amount?: number | undefined;\n  /** required with `amount` */\n  currency?: string | undefined;\n  contents?: readonly OpenAiContent[] | undefined;\n};\n\nexport type OpenAiContentsData = OpenAiBaseData & {\n  type: 'contents';\n};\n\nexport type OpenAiCustomerActionData = Omit<OpenAiBaseData, 'contents'> & {\n  type: 'customer_action';\n};\n\nexport type OpenAiPlanEnrollmentData = OpenAiBaseData & {\n  type: 'plan_enrollment';\n  plan_id?: string | undefined;\n};\n\nexport type OpenAiCustomData = OpenAiBaseData & {\n  type: 'custom';\n  plan_id?: string | undefined;\n};\n\nexport type OpenAiContentsEventName = 'contents_viewed' | 'items_added' | 'checkout_started' | 'order_created' | 'page_viewed';\nexport type OpenAiCustomerActionEventName = 'lead_created' | 'registration_completed' | 'appointment_scheduled';\nexport type OpenAiPlanEnrollmentEventName = 'subscription_created' | 'trial_started';\n\n/**\n * What openai takes, from the pixel and from the conversions api alike: the event and, for a\n * conversion the visitor entered identifiers for, the identifiers — hashed by whichever half sends.\n * The app events (`app_installed`, `app_opened`) are a mobile app's, not a website's, and have no builder.\n */\nexport type OpenAiEvent = (\n  | {\n    name: OpenAiContentsEventName;\n    data: OpenAiContentsData;\n  }\n  | {\n    name: OpenAiCustomerActionEventName;\n    data: OpenAiCustomerActionData;\n  }\n  | {\n    name: OpenAiPlanEnrollmentEventName;\n    data: OpenAiPlanEnrollmentData;\n  }\n  | {\n    name: 'custom';\n    /** 1 to 64 lowercase letters, digits, underscores or dashes, no standard event's name */\n    customName: string;\n    data: OpenAiCustomData;\n  }\n) & {\n  user?: ConversionUser | undefined;\n};\n\ndeclare module '@astroscope/relay' {\n  interface RelayDestinations {\n    openai: OpenAiEvent;\n  }\n}\n\n/** an item as the site has it: the price in the major unit, 129.99 for 129.99 EUR */\nexport type OpenAiContentInput = { id: string; name: string; price: number; quantity: number };\n\n/** the money of an event: the total in the major unit, and its currency */\nexport type OpenAiMoney = { value: number; currency: string };\n\nexport type OpenAiContents = {\n  items: readonly OpenAiContentInput[];\n  currency: string;\n  /** the total; default: the items summed */\n  value?: number | undefined;\n  /** the `content_type` of the contents; default `product` */\n  contentType?: string | undefined;\n  user?: ConversionUser | undefined;\n};\n\nexport type OpenAiPlan = {\n  /** the site's plan identifier */\n  id?: string | undefined;\n  money?: OpenAiMoney | undefined;\n  /** the plan's items, if any; `content_type` `plan` by default */\n  items?: readonly OpenAiContentInput[] | undefined;\n  contentType?: string | undefined;\n  user?: ConversionUser | undefined;\n};\n\nexport type OpenAiCustom = OpenAiPlan & {\n  /** the `content_type` of the items; default `product` */\n  contentType?: string | undefined;\n};\n\n/**\n * The openai builders: every event openai has a name for, and `custom(name)`. What an event\n * definition puts under `openai`.\n */\nexport const openai = {\n  contentsViewed: (contents: OpenAiContents): OpenAiEvent => contentsEvent('contents_viewed', contents),\n  itemsAdded: (contents: OpenAiContents): OpenAiEvent => contentsEvent('items_added', contents),\n  checkoutStarted: (contents: OpenAiContents): OpenAiEvent => contentsEvent('checkout_started', contents),\n  orderCreated: (contents: OpenAiContents): OpenAiEvent => contentsEvent('order_created', contents),\n  /** the page as a content: its id is what the reports group by, e.g. the path */\n  pageViewed: (page: { id: string; name: string }): OpenAiEvent => ({\n    name: 'page_viewed',\n    data: { type: 'contents', contents: [{ id: page.id, name: page.name, content_type: 'page' }] },\n  }),\n  leadCreated: (user?: ConversionUser, money?: OpenAiMoney): OpenAiEvent => actionEvent('lead_created', user, money),\n  registrationCompleted: (user?: ConversionUser, money?: OpenAiMoney): OpenAiEvent =>\n    actionEvent('registration_completed', user, money),\n  appointmentScheduled: (user?: ConversionUser, money?: OpenAiMoney): OpenAiEvent =>\n    actionEvent('appointment_scheduled', user, money),\n  subscriptionCreated: (plan: OpenAiPlan = {}): OpenAiEvent => planEvent('subscription_created', plan),\n  trialStarted: (plan: OpenAiPlan = {}): OpenAiEvent => planEvent('trial_started', plan),\n  /** a custom event: any name openai has no standard event for */\n  custom: (name: string, { id, money, items, contentType = 'product', user }: OpenAiCustom = {}): OpenAiEvent => ({\n    name: 'custom',\n    customName: name,\n    data: { type: 'custom', plan_id: id, ...toMoneyData(money), ...toContentsData(items, contentType, money?.currency) },\n    user,\n  }),\n};\n\nfunction contentsEvent(name: OpenAiContentsEventName, { items, currency, value, contentType = 'product', user }: OpenAiContents): OpenAiEvent {\n  const total = value ?? items.reduce((sum, item) => sum + item.price * item.quantity, 0);\n\n  return {\n    name,\n    data: { type: 'contents', ...toMoneyData({ value: total, currency }), ...toContentsData(items, contentType, currency) },\n    user,\n  };\n}\n\nfunction actionEvent(name: OpenAiCustomerActionEventName, user?: ConversionUser, money?: OpenAiMoney): OpenAiEvent {\n  return { name, data: { type: 'customer_action', ...toMoneyData(money) }, user };\n}\n\nfunction planEvent(name: OpenAiPlanEnrollmentEventName, { id, money, items, contentType = 'plan', user }: OpenAiPlan): OpenAiEvent {\n  return {\n    name,\n    data: { type: 'plan_enrollment', plan_id: id, ...toMoneyData(money), ...toContentsData(items, contentType, money?.currency) },\n    user,\n  };\n}\n\nfunction toMoneyData(money: OpenAiMoney | undefined): Pick<OpenAiBaseData, 'amount' | 'currency'> {\n  return money ? { amount: toMinorUnits(money.value), currency: money.currency } : {};\n}\n\nfunction toContentsData(\n  items: readonly OpenAiContentInput[] | undefined,\n  contentType: string,\n  currency: string | undefined,\n): Pick<OpenAiBaseData, 'contents'> {\n  if (!items) return {};\n\n  return {\n    contents: items.map((item) => ({\n      id: item.id,\n      name: item.name,\n      content_type: contentType,\n      quantity: item.quantity,\n      amount: toMinorUnits(item.price),\n      currency,\n    })),\n  };\n}\n\nexport function toMinorUnits(value: number): number {\n  return Math.round(value * 100);\n}\n","import type { Destination } from '../client/bus.js';\nimport { type HashedUser, hashUser } from '../conversion-user.js';\nimport { type EventMeta, isBrowser } from '../shared.js';\nimport type { OpenAiEvent } from './shared.js';\n\nexport type {\n  OpenAiContent,\n  OpenAiContentInput,\n  OpenAiContents,\n  OpenAiContentsData,\n  OpenAiCustom,\n  OpenAiCustomData,\n  OpenAiCustomerActionData,\n  OpenAiEvent,\n  OpenAiMoney,\n  OpenAiPlan,\n  OpenAiPlanEnrollmentData,\n} from './shared.js';\nexport { openai, toMinorUnits } from './shared.js';\n\n/** advanced matching data of the pixel: normalized identifiers as lowercase sha256 hex */\ntype OpenAiUser = {\n  email_sha256?: string | undefined;\n  phone_number_sha256?: string | undefined;\n  first_name_sha256?: string | undefined;\n  last_name_sha256?: string | undefined;\n};\n\ntype OpenAiOptions = {\n  /** deduplicates against the same event sent through the conversions api */\n  event_id?: string | undefined;\n  /** the name of a `custom` event; no standard event takes one */\n  custom_event_name?: string | undefined;\n};\n\ntype Oaiq = {\n  (command: 'init', options: { user: OpenAiUser }): void;\n  (command: 'measure', name: OpenAiEvent['name'], data: OpenAiEvent['data'], options?: OpenAiOptions): void;\n};\n\ndeclare global {\n  interface Window {\n    oaiq?: Oaiq | undefined;\n  }\n}\n\nexport type OpenAiPixelOptions = {\n  /** the country calling code national phone numbers get before hashing, e.g. `49` */\n  countryCallingCode?: string | undefined;\n};\n\nlet initializedUserKey: string | undefined;\n\n/**\n * The openai ads pixel as a destination: measures the `openai` payload of an event under the event's\n * id, so a conversion the server also reported through the conversions api counts once. The pixel\n * is injected by the cmp after consent, so `window.oaiq` shows up late: events wait for it. The\n * identifiers an event carries are hashed and sent through `init` right before it.\n */\nexport function openAiPixel(options: OpenAiPixelOptions = {}): Destination<'openai'> {\n  return {\n    name: 'openai',\n    ready: () => isBrowser() && typeof globalThis.window.oaiq === 'function',\n    send: (event, meta) => {\n      const user = event.user ? hashUser(event.user, { countryCallingCode: options.countryCallingCode }) : undefined;\n\n      void Promise.resolve(user)\n        .then((hashed) => measure(event, meta, hashed))\n        .catch((error: unknown) => console.error('relay: destination openai failed', error));\n    },\n  };\n}\n\nfunction measure(event: OpenAiEvent, meta: EventMeta, hashed: HashedUser | undefined): void {\n  const oaiq = window.oaiq;\n\n  if (!oaiq) return;\n\n  if (hashed) {\n    identify(oaiq, hashed);\n  }\n\n  oaiq('measure', event.name, event.data as OpenAiEvent['data'], {\n    event_id: meta.id,\n    ...(event.name === 'custom' && { custom_event_name: event.customName }),\n  });\n}\n\nfunction identify(oaiq: Oaiq, hashed: HashedUser): void {\n  const user = withoutEmpty({\n    email_sha256: hashed.email,\n    phone_number_sha256: hashed.phone,\n    first_name_sha256: hashed.firstName,\n    last_name_sha256: hashed.lastName,\n  });\n  const key = JSON.stringify(user);\n\n  if (key === initializedUserKey || Object.keys(user).length === 0) {\n    return;\n  }\n\n  initializedUserKey = key;\n  oaiq('init', { user });\n}\n\nfunction withoutEmpty(user: OpenAiUser): OpenAiUser {\n  return Object.fromEntries(Object.entries(user).filter(([, value]) => value)) as OpenAiUser;\n}\n"],"mappings":";;;;;;;AAmHA,MAAa,SAAS;CACpB,iBAAiB,aAA0C,cAAc,mBAAmB,QAAQ;CACpG,aAAa,aAA0C,cAAc,eAAe,QAAQ;CAC5F,kBAAkB,aAA0C,cAAc,oBAAoB,QAAQ;CACtG,eAAe,aAA0C,cAAc,iBAAiB,QAAQ;;CAEhG,aAAa,UAAqD;EAChE,MAAM;EACN,MAAM;GAAE,MAAM;GAAY,UAAU,CAAC;IAAE,IAAI,KAAK;IAAI,MAAM,KAAK;IAAM,cAAc;GAAO,CAAC;EAAE;CAC/F;CACA,cAAc,MAAuB,UAAqC,YAAY,gBAAgB,MAAM,KAAK;CACjH,wBAAwB,MAAuB,UAC7C,YAAY,0BAA0B,MAAM,KAAK;CACnD,uBAAuB,MAAuB,UAC5C,YAAY,yBAAyB,MAAM,KAAK;CAClD,sBAAsB,OAAmB,CAAC,MAAmB,UAAU,wBAAwB,IAAI;CACnG,eAAe,OAAmB,CAAC,MAAmB,UAAU,iBAAiB,IAAI;;CAErF,SAAS,MAAc,EAAE,IAAI,OAAO,OAAO,cAAc,WAAW,SAAuB,CAAC,OAAoB;EAC9G,MAAM;EACN,YAAY;EACZ,MAAM;GAAE,MAAM;GAAU,SAAS;GAAI,GAAG,YAAY,KAAK;GAAG,GAAG,eAAe,OAAO,aAAa,OAAO,QAAQ;EAAE;EACnH;CACF;AACF;AAEA,SAAS,cAAc,MAA+B,EAAE,OAAO,UAAU,OAAO,cAAc,WAAW,QAAqC;CAG5I,OAAO;EACL;EACA,MAAM;GAAE,MAAM;GAAY,GAAG,YAAY;IAAE,OAJ/B,SAAS,MAAM,QAAQ,KAAK,SAAS,MAAM,KAAK,QAAQ,KAAK,UAAU,CAAC;IAI3B;GAAS,CAAC;GAAG,GAAG,eAAe,OAAO,aAAa,QAAQ;EAAE;EACtH;CACF;AACF;AAEA,SAAS,YAAY,MAAqC,MAAuB,OAAkC;CACjH,OAAO;EAAE;EAAM,MAAM;GAAE,MAAM;GAAmB,GAAG,YAAY,KAAK;EAAE;EAAG;CAAK;AAChF;AAEA,SAAS,UAAU,MAAqC,EAAE,IAAI,OAAO,OAAO,cAAc,QAAQ,QAAiC;CACjI,OAAO;EACL;EACA,MAAM;GAAE,MAAM;GAAmB,SAAS;GAAI,GAAG,YAAY,KAAK;GAAG,GAAG,eAAe,OAAO,aAAa,OAAO,QAAQ;EAAE;EAC5H;CACF;AACF;AAEA,SAAS,YAAY,OAA6E;CAChG,OAAO,QAAQ;EAAE,QAAQ,aAAa,MAAM,KAAK;EAAG,UAAU,MAAM;CAAS,IAAI,CAAC;AACpF;AAEA,SAAS,eACP,OACA,aACA,UACkC;CAClC,IAAI,CAAC,OAAO,OAAO,CAAC;CAEpB,OAAO,EACL,UAAU,MAAM,KAAK,UAAU;EAC7B,IAAI,KAAK;EACT,MAAM,KAAK;EACX,cAAc;EACd,UAAU,KAAK;EACf,QAAQ,aAAa,KAAK,KAAK;EAC/B;CACF,EAAE,EACJ;AACF;AAEA,SAAgB,aAAa,OAAuB;CAClD,OAAO,KAAK,MAAM,QAAQ,GAAG;AAC/B;;ACzIA,IAAI;;;;;;;AAQJ,SAAgB,YAAY,UAA8B,CAAC,GAA0B;CACnF,OAAO;EACL,MAAM;EACN,aAAa,UAAU,KAAK,OAAO,WAAW,OAAO,SAAS;EAC9D,OAAO,OAAO,SAAS;GACrB,MAAM,OAAO,MAAM,OAAO,SAAS,MAAM,MAAM,EAAE,oBAAoB,QAAQ,mBAAmB,CAAC,IAAI,KAAA;GAErG,QAAa,QAAQ,IAAI,CAAC,CACvB,MAAM,WAAW,QAAQ,OAAO,MAAM,MAAM,CAAC,CAAC,CAC9C,OAAO,UAAmB,QAAQ,MAAM,oCAAoC,KAAK,CAAC;EACvF;CACF;AACF;AAEA,SAAS,QAAQ,OAAoB,MAAiB,QAAsC;CAC1F,MAAM,OAAO,OAAO;CAEpB,IAAI,CAAC,MAAM;CAEX,IAAI,QACF,SAAS,MAAM,MAAM;CAGvB,KAAK,WAAW,MAAM,MAAM,MAAM,MAA6B;EAC7D,UAAU,KAAK;EACf,GAAI,MAAM,SAAS,YAAY,EAAE,mBAAmB,MAAM,WAAW;CACvE,CAAC;AACH;AAEA,SAAS,SAAS,MAAY,QAA0B;CACtD,MAAM,OAAO,aAAa;EACxB,cAAc,OAAO;EACrB,qBAAqB,OAAO;EAC5B,mBAAmB,OAAO;EAC1B,kBAAkB,OAAO;CAC3B,CAAC;CACD,MAAM,MAAM,KAAK,UAAU,IAAI;CAE/B,IAAI,QAAQ,sBAAsB,OAAO,KAAK,IAAI,CAAC,CAAC,WAAW,GAC7D;CAGF,qBAAqB;CACrB,KAAK,QAAQ,EAAE,KAAK,CAAC;AACvB;AAEA,SAAS,aAAa,MAA8B;CAClD,OAAO,OAAO,YAAY,OAAO,QAAQ,IAAI,CAAC,CAAC,QAAQ,GAAG,WAAW,KAAK,CAAC;AAC7E"}

package/dist/openai/server.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"server.d.ts","names":[],"sources":["../../src/openai/server.ts"],"mappings":";YAUY;;EAEV;EACA;;EAEA;;EAEA;EACA,eAAe;;;;;;wBAOD,kBAAkB,SAAS,2BAA2B"}
+{"version":3,"file":"server.d.ts","names":[],"sources":["../../src/openai/server.ts"],"mappings":";YAWY;;EAEV;EACA;;EAEA;;EAEA;EACA,eAAe;;;;;;wBAOD,kBAAkB,SAAS,2BAA2B"}

package/dist/openai/server.js

@@ -1,4 +1,5 @@
-import { t as hashUser } from "../conversion-user-CV8xIWDK.js";
+import { t as hashUser } from "../conversion-user-BgpXmIdJ.js";
+import { t as withoutQuery } from "../source-url-Cqfh3UjO.js";
 // src/openai/server.ts
 const CONVERSIONS_API_URL = "https://bzr.openai.com/v1/events";
 const CONVERSIONS_API_TIMEOUT_MS = 1e4;
@@ -19,8 +20,9 @@ function openAiConversions(options) {
 				events: [{
 					id,
 					type: event.name,
+					...event.name === "custom" && { custom_event_name: event.customName },
 					timestamp_ms: Date.now(),
-					source_url: request.sourceUrl,
+					source_url: withoutQuery(request.sourceUrl),
 					action_source: "web",
 					user: {
 						emails_sha256: toList(hashed.email),

package/dist/openai/server.js.map

@@ -1 +1 @@
-{"version":3,"file":"server.js","names":[],"sources":["../../src/openai/server.ts"],"sourcesContent":["import { hashUser } from '../conversion-user.js';\nimport type { ServerDestination } from '../runtime.js';\nimport type { OpenAiEvent } from './shared.js';\n\nconst CONVERSIONS_API_URL = 'https://bzr.openai.com/v1/events';\nconst CONVERSIONS_API_TIMEOUT_MS = 10_000;\n\n/** the click reference the pixel stores for the visitor who came from an openai ad */\nconst CLICK_REFERENCE_COOKIE = '__obref';\n\nexport type OpenAiConversionsOptions = {\n  /** the conversions api key from the ads manager */\n  apiKey: string;\n  pixelId: string;\n  /** names the sending system in the request, e.g. `my-site-de` */\n  integrationSource: string;\n  /** the country calling code national phone numbers get before hashing, e.g. `49` */\n  countryCallingCode?: string | undefined;\n  fetch?: typeof fetch | undefined;\n};\n\n/**\n * The openai ads conversions api as a server destination: reports the `openai` payload of an event\n * under the id the pixel fires it with.\n */\nexport function openAiConversions(options: OpenAiConversionsOptions): ServerDestination<'openai'> {\n  const doFetch = options.fetch ?? fetch;\n\n  return {\n    name: 'openai',\n    async send(event: OpenAiEvent, { id, request }) {\n      const hashed = await hashUser(event.user ?? {}, { countryCallingCode: options.countryCallingCode });\n      const body = {\n        integration_source: options.integrationSource,\n        events: [\n          {\n            id,\n            type: event.name,\n            timestamp_ms: Date.now(),\n            source_url: request.sourceUrl,\n            action_source: 'web',\n            user: {\n              emails_sha256: toList(hashed.email),\n              phone_numbers_sha256: toList(hashed.phone),\n              first_names_sha256: toList(hashed.firstName),\n              last_names_sha256: toList(hashed.lastName),\n              ip_address: request.clientAddress,\n              user_agent: request.headers.get('user-agent') ?? undefined,\n              obref: request.cookie(CLICK_REFERENCE_COOKIE),\n            },\n            data: event.data,\n          },\n        ],\n      };\n\n      const response = await doFetch(`${CONVERSIONS_API_URL}?pid=${encodeURIComponent(options.pixelId)}`, {\n        method: 'POST',\n        headers: { authorization: `Bearer ${options.apiKey}`, 'content-type': 'application/json' },\n        body: JSON.stringify(body),\n        signal: AbortSignal.timeout(CONVERSIONS_API_TIMEOUT_MS),\n      });\n\n      if (!response.ok) {\n        throw new Error(`conversions api responded ${response.status}: ${await response.text()}`);\n      }\n    },\n  };\n}\n\nfunction toList(value: string | undefined): string[] | undefined {\n  return value ? [value] : undefined;\n}\n"],"mappings":";;AAIA,MAAM,sBAAsB;AAC5B,MAAM,6BAA6B;;AAGnC,MAAM,yBAAyB;;;;;AAiB/B,SAAgB,kBAAkB,SAAgE;CAChG,MAAM,UAAU,QAAQ,SAAS;CAEjC,OAAO;EACL,MAAM;EACN,MAAM,KAAK,OAAoB,EAAE,IAAI,WAAW;GAC9C,MAAM,SAAS,MAAM,SAAS,MAAM,QAAQ,CAAC,GAAG,EAAE,oBAAoB,QAAQ,mBAAmB,CAAC;GAClG,MAAM,OAAO;IACX,oBAAoB,QAAQ;IAC5B,QAAQ,CACN;KACE;KACA,MAAM,MAAM;KACZ,cAAc,KAAK,IAAI;KACvB,YAAY,QAAQ;KACpB,eAAe;KACf,MAAM;MACJ,eAAe,OAAO,OAAO,KAAK;MAClC,sBAAsB,OAAO,OAAO,KAAK;MACzC,oBAAoB,OAAO,OAAO,SAAS;MAC3C,mBAAmB,OAAO,OAAO,QAAQ;MACzC,YAAY,QAAQ;MACpB,YAAY,QAAQ,QAAQ,IAAI,YAAY,KAAK,KAAA;MACjD,OAAO,QAAQ,OAAO,sBAAsB;KAC9C;KACA,MAAM,MAAM;IACd,CACF;GACF;GAEA,MAAM,WAAW,MAAM,QAAQ,GAAG,oBAAoB,OAAO,mBAAmB,QAAQ,OAAO,KAAK;IAClG,QAAQ;IACR,SAAS;KAAE,eAAe,UAAU,QAAQ;KAAU,gBAAgB;IAAmB;IACzF,MAAM,KAAK,UAAU,IAAI;IACzB,QAAQ,YAAY,QAAQ,0BAA0B;GACxD,CAAC;GAED,IAAI,CAAC,SAAS,IACZ,MAAM,IAAI,MAAM,6BAA6B,SAAS,OAAO,IAAI,MAAM,SAAS,KAAK,GAAG;EAE5F;CACF;AACF;AAEA,SAAS,OAAO,OAAiD;CAC/D,OAAO,QAAQ,CAAC,KAAK,IAAI,KAAA;AAC3B"}
+{"version":3,"file":"server.js","names":[],"sources":["../../src/openai/server.ts"],"sourcesContent":["import { hashUser } from '../conversion-user.js';\nimport type { ServerDestination } from '../runtime.js';\nimport { withoutQuery } from '../source-url.js';\nimport type { OpenAiEvent } from './shared.js';\n\nconst CONVERSIONS_API_URL = 'https://bzr.openai.com/v1/events';\nconst CONVERSIONS_API_TIMEOUT_MS = 10_000;\n\n/** the click reference the pixel stores for the visitor who came from an openai ad */\nconst CLICK_REFERENCE_COOKIE = '__obref';\n\nexport type OpenAiConversionsOptions = {\n  /** the conversions api key from the ads manager */\n  apiKey: string;\n  pixelId: string;\n  /** names the sending system in the request, e.g. `my-site-de` */\n  integrationSource: string;\n  /** the country calling code national phone numbers get before hashing, e.g. `49` */\n  countryCallingCode?: string | undefined;\n  fetch?: typeof fetch | undefined;\n};\n\n/**\n * The openai ads conversions api as a server destination: reports the `openai` payload of an event\n * under the id the pixel fires it with.\n */\nexport function openAiConversions(options: OpenAiConversionsOptions): ServerDestination<'openai'> {\n  const doFetch = options.fetch ?? fetch;\n\n  return {\n    name: 'openai',\n    async send(event: OpenAiEvent, { id, request }) {\n      const hashed = await hashUser(event.user ?? {}, { countryCallingCode: options.countryCallingCode });\n      const body = {\n        integration_source: options.integrationSource,\n        events: [\n          {\n            id,\n            type: event.name,\n            ...(event.name === 'custom' && { custom_event_name: event.customName }),\n            timestamp_ms: Date.now(),\n            source_url: withoutQuery(request.sourceUrl),\n            action_source: 'web',\n            user: {\n              emails_sha256: toList(hashed.email),\n              phone_numbers_sha256: toList(hashed.phone),\n              first_names_sha256: toList(hashed.firstName),\n              last_names_sha256: toList(hashed.lastName),\n              ip_address: request.clientAddress,\n              user_agent: request.headers.get('user-agent') ?? undefined,\n              obref: request.cookie(CLICK_REFERENCE_COOKIE),\n            },\n            data: event.data,\n          },\n        ],\n      };\n\n      const response = await doFetch(`${CONVERSIONS_API_URL}?pid=${encodeURIComponent(options.pixelId)}`, {\n        method: 'POST',\n        headers: { authorization: `Bearer ${options.apiKey}`, 'content-type': 'application/json' },\n        body: JSON.stringify(body),\n        signal: AbortSignal.timeout(CONVERSIONS_API_TIMEOUT_MS),\n      });\n\n      if (!response.ok) {\n        throw new Error(`conversions api responded ${response.status}: ${await response.text()}`);\n      }\n    },\n  };\n}\n\nfunction toList(value: string | undefined): string[] | undefined {\n  return value ? [value] : undefined;\n}\n"],"mappings":";;;AAKA,MAAM,sBAAsB;AAC5B,MAAM,6BAA6B;;AAGnC,MAAM,yBAAyB;;;;;AAiB/B,SAAgB,kBAAkB,SAAgE;CAChG,MAAM,UAAU,QAAQ,SAAS;CAEjC,OAAO;EACL,MAAM;EACN,MAAM,KAAK,OAAoB,EAAE,IAAI,WAAW;GAC9C,MAAM,SAAS,MAAM,SAAS,MAAM,QAAQ,CAAC,GAAG,EAAE,oBAAoB,QAAQ,mBAAmB,CAAC;GAClG,MAAM,OAAO;IACX,oBAAoB,QAAQ;IAC5B,QAAQ,CACN;KACE;KACA,MAAM,MAAM;KACZ,GAAI,MAAM,SAAS,YAAY,EAAE,mBAAmB,MAAM,WAAW;KACrE,cAAc,KAAK,IAAI;KACvB,YAAY,aAAa,QAAQ,SAAS;KAC1C,eAAe;KACf,MAAM;MACJ,eAAe,OAAO,OAAO,KAAK;MAClC,sBAAsB,OAAO,OAAO,KAAK;MACzC,oBAAoB,OAAO,OAAO,SAAS;MAC3C,mBAAmB,OAAO,OAAO,QAAQ;MACzC,YAAY,QAAQ;MACpB,YAAY,QAAQ,QAAQ,IAAI,YAAY,KAAK,KAAA;MACjD,OAAO,QAAQ,OAAO,sBAAsB;KAC9C;KACA,MAAM,MAAM;IACd,CACF;GACF;GAEA,MAAM,WAAW,MAAM,QAAQ,GAAG,oBAAoB,OAAO,mBAAmB,QAAQ,OAAO,KAAK;IAClG,QAAQ;IACR,SAAS;KAAE,eAAe,UAAU,QAAQ;KAAU,gBAAgB;IAAmB;IACzF,MAAM,KAAK,UAAU,IAAI;IACzB,QAAQ,YAAY,QAAQ,0BAA0B;GACxD,CAAC;GAED,IAAI,CAAC,SAAS,IACZ,MAAM,IAAI,MAAM,6BAA6B,SAAS,OAAO,IAAI,MAAM,SAAS,KAAK,GAAG;EAE5F;CACF;AACF;AAEA,SAAS,OAAO,OAAiD;CAC/D,OAAO,QAAQ,CAAC,KAAK,IAAI,KAAA;AAC3B"}

package/dist/server/index.d.ts

@@ -1,5 +1,5 @@
 import { n as ConsentRecord } from "../shared-CSwqcxPI.js";
-import { a as normalizeEmail, c as sha256, i as hashUser, n as HashOptions, o as normalizeName, r as HashedUser, s as normalizePhone } from "../conversion-user-DCfM5EuZ.js";
+import { a as normalizeEmail, c as sha256, i as hashUser, n as HashOptions, o as normalizeName, r as HashedUser, s as normalizePhone } from "../conversion-user-fHh2xXBc.js";
 import { a as ServerDestination, c as defineRelayServer, i as ServerConsent, n as RelayRequest, o as ServerDestinations, r as RelayServerConfig, s as ServerEventMeta, t as AnyServerDestination } from "../runtime-J8VplGyY.js";
 import { APIContext } from "astro";
 /** what the middleware knows about the request `track()` is called in */

package/dist/server/index.js

@@ -1,5 +1,5 @@
 import { n as relayConsent } from "../context-D11BBDcb.js";
-import { a as sha256, i as normalizePhone, n as normalizeEmail, r as normalizeName, t as hashUser } from "../conversion-user-CV8xIWDK.js";
+import { a as sha256, i as normalizePhone, n as normalizeEmail, r as normalizeName, t as hashUser } from "../conversion-user-BgpXmIdJ.js";
 // src/runtime.ts
 /** types the server registry: the default export of `src/relay/server.ts` */
 function defineRelayServer(config) {

package/dist/source-url-Cqfh3UjO.js

@@ -0,0 +1,13 @@
+// src/source-url.ts
+/** the page without its query and fragment: a token or a click id in the url is no conversion api's business */
+function withoutQuery(url) {
+	try {
+		const parsed = new URL(url);
+		return `${parsed.origin}${parsed.pathname}`;
+	} catch {
+		return url;
+	}
+}
+export { withoutQuery as t };
+
+//# sourceMappingURL=source-url-Cqfh3UjO.js.map

package/dist/source-url-Cqfh3UjO.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"source-url-Cqfh3UjO.js","names":[],"sources":["../src/source-url.ts"],"sourcesContent":["/** the page without its query and fragment: a token or a click id in the url is no conversion api's business */\nexport function withoutQuery(url: string): string {\n  try {\n    const parsed = new URL(url);\n\n    return `${parsed.origin}${parsed.pathname}`;\n  } catch {\n    return url;\n  }\n}\n"],"mappings":";;AACA,SAAgB,aAAa,KAAqB;CAChD,IAAI;EACF,MAAM,SAAS,IAAI,IAAI,GAAG;EAE1B,OAAO,GAAG,OAAO,SAAS,OAAO;CACnC,QAAQ;EACN,OAAO;CACT;AACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@astroscope/relay",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Consent-aware event relay for Astro",
   "type": "module",
   "main": "./dist/index.js",
@@ -66,6 +66,14 @@
     "./openai/server": {
       "types": "./dist/openai/server.d.ts",
       "import": "./dist/openai/server.js"
+    },
+    "./meta": {
+      "types": "./dist/meta/index.d.ts",
+      "import": "./dist/meta/index.js"
+    },
+    "./meta/server": {
+      "types": "./dist/meta/server.d.ts",
+      "import": "./dist/meta/server.js"
     }
   },
   "files": [
@@ -89,6 +97,7 @@
     "tracking",
     "ga4",
     "awin",
+    "meta",
     "ccm19",
     "matomo",
     "conversions",

package/dist/conversion-user-CV8xIWDK.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"conversion-user-CV8xIWDK.js","names":[],"sources":["../src/conversion-user.ts"],"sourcesContent":["/** what the visitor entered for a conversion; a destination that identifies hashes it as it requires */\nexport type ConversionUser = {\n  email?: string | undefined;\n  phone?: string | undefined;\n  firstName?: string | undefined;\n  lastName?: string | undefined;\n};\n\n/** the identifiers of a visitor as the ad platforms match them: normalized, then sha256 as lowercase hex */\nexport type HashedUser = {\n  email?: string | undefined;\n  phone?: string | undefined;\n  firstName?: string | undefined;\n  lastName?: string | undefined;\n};\n\nexport type HashOptions = {\n  /**\n   * The country calling code a national phone number gets (`49` for a German site): a number\n   * with one leading zero is taken as national, `+` or `00` prefixes are international.\n   */\n  countryCallingCode?: string | undefined;\n};\n\n/** normalizes and hashes the identifiers the way the pixels and the conversions apis expect them */\nexport async function hashUser(user: ConversionUser, options: HashOptions = {}): Promise<HashedUser> {\n  const [email, phone, firstName, lastName] = await Promise.all([\n    hashOptional(normalizeEmail(user.email)),\n    hashOptional(normalizePhone(user.phone, options.countryCallingCode)),\n    hashOptional(normalizeName(user.firstName)),\n    hashOptional(normalizeName(user.lastName)),\n  ]);\n\n  return withoutEmpty({ email, phone, firstName, lastName });\n}\n\nexport function normalizeEmail(email: string | undefined): string | undefined {\n  return email?.trim().toLowerCase() || undefined;\n}\n\n/**\n * Digits only, with the country calling code: a national number (one leading zero) gets the\n * site's code, `+` and `00` prefixes are dropped. Returns `undefined` for anything that is not\n * 8 to 15 digits afterwards.\n */\nexport function normalizePhone(phone: string | undefined, countryCallingCode: string | undefined): string | undefined {\n  const compact = phone?.replaceAll(/[\\s().-]/g, '');\n\n  if (!compact) {\n    return undefined;\n  }\n\n  const international = compact.startsWith('+') || compact.startsWith('00');\n  const national = compact.replace(/^\\+?0*/, '');\n  const digits = international || !compact.startsWith('0') ? national : `${countryCallingCode ?? ''}${national}`;\n\n  return /^\\d{8,15}$/.test(digits) ? digits : undefined;\n}\n\n/** lowercase, without whitespace and punctuation */\nexport function normalizeName(name: string | undefined): string | undefined {\n  return name?.toLowerCase().replaceAll(/[\\s!-/:-@[-`{-~]/g, '') || undefined;\n}\n\nexport async function sha256(value: string): Promise<string> {\n  const digest = await crypto.subtle.digest('SHA-256', new TextEncoder().encode(value));\n\n  return Array.from(new Uint8Array(digest), (byte) => byte.toString(16).padStart(2, '0')).join('');\n}\n\nasync function hashOptional(value: string | undefined): Promise<string | undefined> {\n  return value ? sha256(value) : undefined;\n}\n\nfunction withoutEmpty(user: HashedUser): HashedUser {\n  return Object.fromEntries(Object.entries(user).filter(([, value]) => value)) as HashedUser;\n}\n"],"mappings":";;AAyBA,eAAsB,SAAS,MAAsB,UAAuB,CAAC,GAAwB;CACnG,MAAM,CAAC,OAAO,OAAO,WAAW,YAAY,MAAM,QAAQ,IAAI;EAC5D,aAAa,eAAe,KAAK,KAAK,CAAC;EACvC,aAAa,eAAe,KAAK,OAAO,QAAQ,kBAAkB,CAAC;EACnE,aAAa,cAAc,KAAK,SAAS,CAAC;EAC1C,aAAa,cAAc,KAAK,QAAQ,CAAC;CAC3C,CAAC;CAED,OAAO,aAAa;EAAE;EAAO;EAAO;EAAW;CAAS,CAAC;AAC3D;AAEA,SAAgB,eAAe,OAA+C;CAC5E,OAAO,OAAO,KAAK,CAAC,CAAC,YAAY,KAAK,KAAA;AACxC;;;;;;AAOA,SAAgB,eAAe,OAA2B,oBAA4D;CACpH,MAAM,UAAU,OAAO,WAAW,aAAa,EAAE;CAEjD,IAAI,CAAC,SACH;CAGF,MAAM,gBAAgB,QAAQ,WAAW,GAAG,KAAK,QAAQ,WAAW,IAAI;CACxE,MAAM,WAAW,QAAQ,QAAQ,UAAU,EAAE;CAC7C,MAAM,SAAS,iBAAiB,CAAC,QAAQ,WAAW,GAAG,IAAI,WAAW,GAAG,sBAAsB,KAAK;CAEpG,OAAO,aAAa,KAAK,MAAM,IAAI,SAAS,KAAA;AAC9C;;AAGA,SAAgB,cAAc,MAA8C;CAC1E,OAAO,MAAM,YAAY,CAAC,CAAC,WAAW,qBAAqB,EAAE,KAAK,KAAA;AACpE;AAEA,eAAsB,OAAO,OAAgC;CAC3D,MAAM,SAAS,MAAM,OAAO,OAAO,OAAO,WAAW,IAAI,YAAY,CAAC,CAAC,OAAO,KAAK,CAAC;CAEpF,OAAO,MAAM,KAAK,IAAI,WAAW,MAAM,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC,CAAC,SAAS,GAAG,GAAG,CAAC,CAAC,CAAC,KAAK,EAAE;AACjG;AAEA,eAAe,aAAa,OAAwD;CAClF,OAAO,QAAQ,OAAO,KAAK,IAAI,KAAA;AACjC;AAEA,SAAS,aAAa,MAA8B;CAClD,OAAO,OAAO,YAAY,OAAO,QAAQ,IAAI,CAAC,CAAC,QAAQ,GAAG,WAAW,KAAK,CAAC;AAC7E"}

package/dist/conversion-user-DCfM5EuZ.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"conversion-user-DCfM5EuZ.d.ts","names":[],"sources":["../src/conversion-user.ts"],"mappings":";KACY;EACV;EACA;EACA;EACA;;;KAIU;EACV;EACA;EACA;EACA;;KAGU;;;;;EAKV;;;iBAIoB,SAAS,MAAM,gBAAgB,UAAS,cAAmB,QAAQ;iBAWzE,eAAe;;;;;;iBASf,eAAe,2BAA2B;;iBAe1C,cAAc;iBAIR,OAAO,gBAAgB"}