@shware/analytics 9.0.1 → 9.1.0

package/dist/track/oaiq.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"oaiq.d.mts","names":[],"sources":["../../src/track/oaiq.ts"],"mappings":";;;qBAGa;;;;;YAiBD;EACV;EACA;EACA;EACA;;EAEA;EACA;;YAGU;EACV;;EAEA;EACA;EACA,WAAW;;YAGD;EACV;EACA;EACA;;YAGU;EACV;EACA;EACA;EACA;EACA,WAAW;;YAGD;EACV;EACA;EACA;EACA,WAAW;;YAGD,YAAY,eAAe,qBAAqB,qBAAqB;;;;;YAMrE;EACV,uBAAuB;EACvB,kBAAkB;EAClB,iBAAiB;EACjB,aAAa;EACb,cAAc;EACd,eAAe;EACf,aAAa;EACb,wBAAwB;EACxB,sBAAsB;EACtB,eAAe;;YAGL,sBAAsB;;;;;;YAOtB;EACV;EACA;;EAEA;;EAEA;;EAEA;;YAGU;EACV;;EAEA;EACA,OAAO;;;;;;YAOG;;EAEV;;EAEA;;EAEA;;iBAGe;EACf,KAAK,iBAAiB,QAAQ;EAC9B,KAAK,UAAU,eACb,oBACA,OAAO,GACP,MAAM,eAAe,IACrB,UAAU;EAEZ,KACE,oBACA,iBACA,MAAM,iBACN,SAAS;IAAmB;;;;wBAgChB,aAAa,uBAAuB;wBAYpC,YAAY,QAAQ,QAAQ,oBAAoB;YAkEpD;EACV,MAAM;EACN,MAAM;;;wBAIQ,YAAY,UAAU,WACpC,MAAM,UAAU,IAChB,aAAa,gBAAgB,KAC5B"}
+{"version":3,"file":"oaiq.d.mts","names":[],"sources":["../../src/track/oaiq.ts"],"mappings":";;;qBAGa;;;;;YAiBD;EACV;EACA;EACA;EACA;;EAEA;EACA;;YAGU;EACV;;EAEA;EACA;EACA,WAAW;;YAGD;EACV;EACA;EACA;;YAGU;EACV;EACA;EACA;EACA;EACA,WAAW;;YAGD;EACV;EACA;EACA;EACA,WAAW;;YAGD,YAAY,eAAe,qBAAqB,qBAAqB;;;;;YAMrE;EACV,uBAAuB;EACvB,kBAAkB;EAClB,iBAAiB;EACjB,aAAa;EACb,cAAc;EACd,eAAe;EACf,aAAa;EACb,wBAAwB;EACxB,sBAAsB;EACtB,eAAe;;YAGL,sBAAsB;;;;;;;;;wBAuBlB,mBAAmB;;;;;;YAevB;EACV;;EAEA;EACA;;EAEA;EACA;;EAEA;;EAEA;;EAEA;EACA;;;;;;wBAOc,kBAAkB;;wBASlB,iBAAiB;YAIrB;EACV;;EAEA;EACA,OAAO;;;;;;YAOG;;EAEV;;EAEA;;EAEA;;iBAGe;EACf,KAAK,iBAAiB,QAAQ;EAC9B,KAAK,UAAU,eACb,oBACA,OAAO,GACP,MAAM,eAAe,IACrB,UAAU;EAEZ,KACE,oBACA,iBACA,MAAM,iBACN,SAAS;IAAmB;;;;;;;;wBAoChB,aAAa,uBAAuB;wBAapC,YAAY,QAAQ,QAAQ,oBAAoB;YAqEpD;EACV,MAAM;EACN,MAAM;;;wBAIQ,YAAY,UAAU,WACpC,MAAM,UAAU,IAChB,aAAa,gBAAgB,KAC5B"}

package/dist/track/oaiq.mjs

@@ -9,6 +9,43 @@ const NON_AD_EVENTS = [
 	"view_promotion",
 	"select_promotion"
 ];
+const STANDARD_EVENTS = [
+	"appointment_scheduled",
+	"checkout_started",
+	"contents_viewed",
+	"items_added",
+	"lead_created",
+	"order_created",
+	"page_viewed",
+	"registration_completed",
+	"subscription_created",
+	"trial_started"
+];
+/**
+* A track name as an OpenAI `custom_event_name`: 1–64 letters, digits, underscores or hyphens,
+* starting and ending with a letter or digit, not a standard event name; the API lowercases it.
+* Anything else becomes an underscore, so `Sign Up.Clicked` is `sign_up_clicked`. Undefined when
+* nothing usable is left — the event is then not sent at all. The pixel and the server both name
+* a custom event through this, so the two still deduplicate.
+* https://developers.openai.com/ads/supported-events
+*/
+function oaiCustomEventName(name) {
+	const sanitized = name.toLowerCase().replace(/[^a-z0-9_-]+/g, "_").slice(0, 64).replace(/^[_-]+|[_-]+$/g, "");
+	if (!sanitized || STANDARD_EVENTS.includes(sanitized)) return void 0;
+	return sanitized;
+}
+/**
+* A phone number as OpenAI hashes it: whitespace, parentheses, periods and hyphens removed, then
+* the leading `+` and zeroes; 8–15 digits with the country code, else not a usable number.
+*/
+function normalizeOAIPhone(phone) {
+	const digits = phone.replace(/[\s().-]/g, "").replace(/^\+/, "").replace(/^0+/, "");
+	return /^\d{8,15}$/.test(digits) ? digits : void 0;
+}
+/** A name as OpenAI hashes it: lowercase, no whitespace or ASCII punctuation, accents kept. */
+function normalizeOAIName(name) {
+	return name?.toLowerCase().replace(/[\s!-/:-@[-`{-~]/g, "") || void 0;
+}
 /**
 * Currencies whose minor unit has 0 or 3 decimal places; everything else uses 2.
 * Follows Stripe's zero-decimal convention (e.g., MGA is treated as 0, ISK is included),
@@ -43,24 +80,32 @@ const THREE_DECIMAL_CURRENCIES = /* @__PURE__ */ new Set([
 	"OMR",
 	"TND"
 ]);
-/** Convert a major-unit amount (e.g., 129.99) into ISO 4217 minor units (e.g., 12,999). */
+/**
+* Convert a major-unit amount (e.g., 129.99) into ISO 4217 minor units (e.g., 12,999). None
+* without a currency: the minor unit depends on it, and OpenAI requires a `currency` with every
+* `amount` — an amount alone would be invalid, not just imprecise.
+*/
 function toMinorUnits(value, currency) {
 	if (value === void 0 || value === null || Number.isNaN(value)) return void 0;
 	const code = currency?.toUpperCase();
+	if (!code) return void 0;
 	const exponent = code && ZERO_DECIMAL_CURRENCIES.has(code) ? 0 : code && THREE_DECIMAL_CURRENCIES.has(code) ? 3 : 2;
 	return Math.round(value * 10 ** exponent);
 }
 function mapContents(items, currency) {
 	if (!items || items.length === 0) return void 0;
 	const code = currency?.toUpperCase();
-	return items.map((item) => ({
-		id: item.item_id,
-		name: item.item_name,
-		content_type: item.item_category,
-		quantity: item.quantity,
-		amount: toMinorUnits(item.price, currency),
-		currency: item.price !== void 0 ? code : void 0
-	}));
+	return items.map((item) => {
+		const amount = toMinorUnits(item.price, currency);
+		return {
+			id: item.item_id,
+			name: item.item_name,
+			content_type: item.item_category,
+			quantity: item.quantity,
+			amount,
+			currency: amount !== void 0 ? code : void 0
+		};
+	});
 }
 /** Safely read a property off loosely typed track properties without widening to `any`. */
 function prop(properties, key) {
@@ -167,6 +212,6 @@ function mapOAIEvent(name, properties) {
 	}
 }
 //#endregion
-export { NON_AD_EVENTS, mapContents, mapOAIEvent, toMinorUnits };
+export { NON_AD_EVENTS, mapContents, mapOAIEvent, normalizeOAIName, normalizeOAIPhone, oaiCustomEventName, toMinorUnits };
 
 //# sourceMappingURL=oaiq.mjs.map

package/dist/track/oaiq.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"oaiq.mjs","names":[],"sources":["../../src/track/oaiq.ts"],"sourcesContent":["import type { Item } from './gtag';\nimport type { EventName, TrackName, TrackProperties } from './types';\n\nexport const NON_AD_EVENTS = [\n  // metrics\n  'CLS',\n  'FCP',\n  'FID',\n  'INP',\n  'LCP',\n  'TTFB',\n  // promotions\n  'view_promotion',\n  'select_promotion',\n];\n\n/**\n * Content item shared by `contents` and `plan_enrollment` events.\n * https://developers.openai.com/ads/supported-events\n */\nexport type ContentItem = {\n  id?: string;\n  name?: string;\n  content_type?: string;\n  quantity?: number;\n  /** Per-item monetary value in ISO 4217 minor units (e.g., 12,999 = $129.99 USD). */\n  amount?: number;\n  currency?: string;\n};\n\nexport type ContentsData = {\n  type: 'contents';\n  /** Monetary value in ISO 4217 minor units (e.g., 12,999 = $129.99 USD). */\n  amount?: number;\n  currency?: string;\n  contents?: ContentItem[];\n};\n\nexport type CustomerActionData = {\n  type: 'customer_action';\n  amount?: number;\n  currency?: string;\n};\n\nexport type PlanEnrollmentData = {\n  type: 'plan_enrollment';\n  plan_id?: string;\n  amount?: number;\n  currency?: string;\n  contents?: ContentItem[];\n};\n\nexport type CustomEventData = {\n  type: 'custom';\n  amount?: number;\n  currency?: string;\n  contents?: ContentItem[];\n};\n\nexport type EventData = ContentsData | CustomerActionData | PlanEnrollmentData | CustomEventData;\n\n/**\n * Standard event names and the `data` shape each one expects.\n * https://developers.openai.com/ads/supported-events\n */\nexport type StandardEvents = {\n  appointment_scheduled: CustomerActionData;\n  checkout_started: ContentsData;\n  contents_viewed: ContentsData;\n  items_added: ContentsData;\n  lead_created: CustomerActionData;\n  order_created: ContentsData;\n  page_viewed: ContentsData;\n  registration_completed: CustomerActionData;\n  subscription_created: PlanEnrollmentData;\n  trial_started: PlanEnrollmentData;\n};\n\nexport type StandardEvent = keyof StandardEvents;\n\n/**\n * Identity fields passed to `oaiq(\"init\", ...)` for conversion matching. Email and external id\n * must be pre-hashed as lowercase 64-char SHA-256 hex strings; the rest are sent as raw values.\n * https://developers.openai.com/ads/measurement-pixel\n */\nexport type OAIQUser = {\n  email_sha256?: string;\n  external_id_sha256?: string;\n  /** Two-letter ISO 3166-1 country code (e.g. \"US\"). */\n  country?: string;\n  /** Lowercased, max 128 characters. */\n  city?: string;\n  /** Max 32 characters. */\n  zip_code?: string;\n};\n\nexport type InitConfig = {\n  pixelId: string;\n  /** Log SDK activity to the browser console. */\n  debug?: boolean;\n  user?: OAIQUser;\n};\n\n/**\n * Fourth argument of `oaiq(\"measure\", ...)`. Required for custom events (carries\n * `custom_event_name`); optional for standard events.\n */\nexport type MeasureOptions = {\n  /** Shared with the Conversions API to deduplicate the same conversion across browser and server. */\n  event_id?: string;\n  /** Required for custom events; 1-64 chars of letters, numbers, underscores, or dashes. */\n  custom_event_name?: string;\n  /** When true, opts the event out of user-level personalization. */\n  opt_out?: boolean;\n};\n\nexport interface OAIQ {\n  oaiq(command: 'init', config: InitConfig): void;\n  oaiq<T extends StandardEvent>(\n    command: 'measure',\n    event: T,\n    data: StandardEvents[T],\n    options?: MeasureOptions\n  ): void;\n  oaiq(\n    command: 'measure',\n    event: 'custom',\n    data: CustomEventData,\n    options: MeasureOptions & { custom_event_name: string }\n  ): void;\n}\n\n/**\n * Currencies whose minor unit has 0 or 3 decimal places; everything else uses 2.\n * Follows Stripe's zero-decimal convention (e.g., MGA is treated as 0, ISK is included),\n * which can differ from strict ISO 4217 exponents.\n * https://docs.stripe.com/currencies#zero-decimal\n */\nconst ZERO_DECIMAL_CURRENCIES = new Set([\n  'BIF',\n  'CLP',\n  'DJF',\n  'GNF',\n  'ISK',\n  'JPY',\n  'KMF',\n  'KRW',\n  'MGA',\n  'PYG',\n  'RWF',\n  'UGX',\n  'VND',\n  'VUV',\n  'XAF',\n  'XOF',\n  'XPF',\n]);\nconst THREE_DECIMAL_CURRENCIES = new Set(['BHD', 'IQD', 'JOD', 'KWD', 'LYD', 'OMR', 'TND']);\n\n/** Convert a major-unit amount (e.g., 129.99) into ISO 4217 minor units (e.g., 12,999). */\nexport function toMinorUnits(value?: number | null, currency?: string): number | undefined {\n  if (value === undefined || value === null || Number.isNaN(value)) return undefined;\n  const code = currency?.toUpperCase();\n  const exponent =\n    code && ZERO_DECIMAL_CURRENCIES.has(code)\n      ? 0\n      : code && THREE_DECIMAL_CURRENCIES.has(code)\n        ? 3\n        : 2;\n  return Math.round(value * 10 ** exponent);\n}\n\nexport function mapContents(items?: Item[], currency?: string): ContentItem[] | undefined {\n  if (!items || items.length === 0) return undefined;\n  const code = currency?.toUpperCase();\n  return items.map((item) => ({\n    id: item.item_id,\n    name: item.item_name,\n    content_type: item.item_category,\n    quantity: item.quantity,\n    amount: toMinorUnits(item.price, currency),\n    currency: item.price !== undefined ? code : undefined,\n  }));\n}\n\n/** Safely read a property off loosely typed track properties without widening to `any`. */\nfunction prop(properties: unknown, key: string): unknown {\n  return typeof properties === 'object' && properties !== null\n    ? (properties as Record<string, unknown>)[key]\n    : undefined;\n}\n\nfunction readValue(properties: unknown): number | undefined {\n  const value = prop(properties, 'value');\n  return typeof value === 'number' ? value : undefined;\n}\n\nfunction readCurrency(properties: unknown): string | undefined {\n  const currency = prop(properties, 'currency');\n  return typeof currency === 'string' ? currency : undefined;\n}\n\nfunction readItems(properties: unknown): Item[] | undefined {\n  const items = prop(properties, 'items');\n  return Array.isArray(items) ? (items as Item[]) : undefined;\n}\n\nfunction contentsData(properties: unknown): ContentsData {\n  const currency = readCurrency(properties);\n  return {\n    type: 'contents',\n    amount: toMinorUnits(readValue(properties), currency),\n    currency: currency?.toUpperCase(),\n    contents: mapContents(readItems(properties), currency),\n  };\n}\n\nfunction customerActionData(properties: unknown): CustomerActionData {\n  const currency = readCurrency(properties);\n  return {\n    type: 'customer_action',\n    amount: toMinorUnits(readValue(properties), currency),\n    currency: currency?.toUpperCase(),\n  };\n}\n\nfunction planEnrollmentData(properties: unknown): PlanEnrollmentData {\n  const currency = readCurrency(properties);\n  const items = readItems(properties);\n  return {\n    type: 'plan_enrollment',\n    plan_id: items?.[0]?.item_id,\n    amount: toMinorUnits(readValue(properties), currency),\n    currency: currency?.toUpperCase(),\n    contents: mapContents(items, currency),\n  };\n}\n\nexport type MappedOAIEvent = {\n  type: StandardEvent | 'custom';\n  data: EventData;\n};\n\n/** Map an internal track event onto an OpenAI standard (or custom) conversion event. */\nexport function mapOAIEvent<T extends EventName>(\n  name: TrackName<T>,\n  properties?: TrackProperties<T>\n): MappedOAIEvent {\n  switch (name) {\n    case 'page_view':\n      return { type: 'page_viewed', data: contentsData(properties) };\n    case 'view_item':\n    case 'view_item_list':\n      return { type: 'contents_viewed', data: contentsData(properties) };\n    case 'begin_checkout':\n      return { type: 'checkout_started', data: contentsData(properties) };\n    case 'add_to_cart':\n      return { type: 'items_added', data: contentsData(properties) };\n    case 'purchase':\n      return { type: 'order_created', data: contentsData(properties) };\n    case 'generate_lead':\n    case 'qualify_lead':\n      return { type: 'lead_created', data: customerActionData(properties) };\n    case 'sign_up':\n    case 'login':\n      return { type: 'registration_completed', data: customerActionData(properties) };\n    case 'schedule':\n      return { type: 'appointment_scheduled', data: customerActionData(properties) };\n    case 'subscribe':\n      return { type: 'subscription_created', data: planEnrollmentData(properties) };\n    case 'trial_begin':\n      return { type: 'trial_started', data: planEnrollmentData(properties) };\n    default: {\n      const currency = readCurrency(properties);\n      return {\n        type: 'custom',\n        data: {\n          type: 'custom',\n          amount: toMinorUnits(readValue(properties), currency),\n          currency: currency?.toUpperCase(),\n          contents: mapContents(readItems(properties), currency),\n        },\n      };\n    }\n  }\n}\n"],"mappings":";AAGA,MAAa,gBAAgB;CAE3B;CACA;CACA;CACA;CACA;CACA;CAEA;CACA;AACF;;;;;;;AA4HA,MAAM,0CAA0B,IAAI,IAAI;CACtC;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AACF,CAAC;AACD,MAAM,2CAA2B,IAAI,IAAI;CAAC;CAAO;CAAO;CAAO;CAAO;CAAO;CAAO;AAAK,CAAC;;AAG1F,SAAgB,aAAa,OAAuB,UAAuC;CACzF,IAAI,UAAU,KAAA,KAAa,UAAU,QAAQ,OAAO,MAAM,KAAK,GAAG,OAAO,KAAA;CACzE,MAAM,OAAO,UAAU,YAAY;CACnC,MAAM,WACJ,QAAQ,wBAAwB,IAAI,IAAI,IACpC,IACA,QAAQ,yBAAyB,IAAI,IAAI,IACvC,IACA;CACR,OAAO,KAAK,MAAM,QAAQ,MAAM,QAAQ;AAC1C;AAEA,SAAgB,YAAY,OAAgB,UAA8C;CACxF,IAAI,CAAC,SAAS,MAAM,WAAW,GAAG,OAAO,KAAA;CACzC,MAAM,OAAO,UAAU,YAAY;CACnC,OAAO,MAAM,KAAK,UAAU;EAC1B,IAAI,KAAK;EACT,MAAM,KAAK;EACX,cAAc,KAAK;EACnB,UAAU,KAAK;EACf,QAAQ,aAAa,KAAK,OAAO,QAAQ;EACzC,UAAU,KAAK,UAAU,KAAA,IAAY,OAAO,KAAA;CAC9C,EAAE;AACJ;;AAGA,SAAS,KAAK,YAAqB,KAAsB;CACvD,OAAO,OAAO,eAAe,YAAY,eAAe,OACnD,WAAuC,OACxC,KAAA;AACN;AAEA,SAAS,UAAU,YAAyC;CAC1D,MAAM,QAAQ,KAAK,YAAY,OAAO;CACtC,OAAO,OAAO,UAAU,WAAW,QAAQ,KAAA;AAC7C;AAEA,SAAS,aAAa,YAAyC;CAC7D,MAAM,WAAW,KAAK,YAAY,UAAU;CAC5C,OAAO,OAAO,aAAa,WAAW,WAAW,KAAA;AACnD;AAEA,SAAS,UAAU,YAAyC;CAC1D,MAAM,QAAQ,KAAK,YAAY,OAAO;CACtC,OAAO,MAAM,QAAQ,KAAK,IAAK,QAAmB,KAAA;AACpD;AAEA,SAAS,aAAa,YAAmC;CACvD,MAAM,WAAW,aAAa,UAAU;CACxC,OAAO;EACL,MAAM;EACN,QAAQ,aAAa,UAAU,UAAU,GAAG,QAAQ;EACpD,UAAU,UAAU,YAAY;EAChC,UAAU,YAAY,UAAU,UAAU,GAAG,QAAQ;CACvD;AACF;AAEA,SAAS,mBAAmB,YAAyC;CACnE,MAAM,WAAW,aAAa,UAAU;CACxC,OAAO;EACL,MAAM;EACN,QAAQ,aAAa,UAAU,UAAU,GAAG,QAAQ;EACpD,UAAU,UAAU,YAAY;CAClC;AACF;AAEA,SAAS,mBAAmB,YAAyC;CACnE,MAAM,WAAW,aAAa,UAAU;CACxC,MAAM,QAAQ,UAAU,UAAU;CAClC,OAAO;EACL,MAAM;EACN,SAAS,QAAQ,EAAE,EAAE;EACrB,QAAQ,aAAa,UAAU,UAAU,GAAG,QAAQ;EACpD,UAAU,UAAU,YAAY;EAChC,UAAU,YAAY,OAAO,QAAQ;CACvC;AACF;;AAQA,SAAgB,YACd,MACA,YACgB;CAChB,QAAQ,MAAR;EACE,KAAK,aACH,OAAO;GAAE,MAAM;GAAe,MAAM,aAAa,UAAU;EAAE;EAC/D,KAAK;EACL,KAAK,kBACH,OAAO;GAAE,MAAM;GAAmB,MAAM,aAAa,UAAU;EAAE;EACnE,KAAK,kBACH,OAAO;GAAE,MAAM;GAAoB,MAAM,aAAa,UAAU;EAAE;EACpE,KAAK,eACH,OAAO;GAAE,MAAM;GAAe,MAAM,aAAa,UAAU;EAAE;EAC/D,KAAK,YACH,OAAO;GAAE,MAAM;GAAiB,MAAM,aAAa,UAAU;EAAE;EACjE,KAAK;EACL,KAAK,gBACH,OAAO;GAAE,MAAM;GAAgB,MAAM,mBAAmB,UAAU;EAAE;EACtE,KAAK;EACL,KAAK,SACH,OAAO;GAAE,MAAM;GAA0B,MAAM,mBAAmB,UAAU;EAAE;EAChF,KAAK,YACH,OAAO;GAAE,MAAM;GAAyB,MAAM,mBAAmB,UAAU;EAAE;EAC/E,KAAK,aACH,OAAO;GAAE,MAAM;GAAwB,MAAM,mBAAmB,UAAU;EAAE;EAC9E,KAAK,eACH,OAAO;GAAE,MAAM;GAAiB,MAAM,mBAAmB,UAAU;EAAE;EACvE,SAAS;GACP,MAAM,WAAW,aAAa,UAAU;GACxC,OAAO;IACL,MAAM;IACN,MAAM;KACJ,MAAM;KACN,QAAQ,aAAa,UAAU,UAAU,GAAG,QAAQ;KACpD,UAAU,UAAU,YAAY;KAChC,UAAU,YAAY,UAAU,UAAU,GAAG,QAAQ;IACvD;GACF;EACF;CACF;AACF"}
+{"version":3,"file":"oaiq.mjs","names":[],"sources":["../../src/track/oaiq.ts"],"sourcesContent":["import type { Item } from './gtag';\nimport type { EventName, TrackName, TrackProperties } from './types';\n\nexport const NON_AD_EVENTS = [\n  // metrics\n  'CLS',\n  'FCP',\n  'FID',\n  'INP',\n  'LCP',\n  'TTFB',\n  // promotions\n  'view_promotion',\n  'select_promotion',\n];\n\n/**\n * Content item shared by `contents` and `plan_enrollment` events.\n * https://developers.openai.com/ads/supported-events\n */\nexport type ContentItem = {\n  id?: string;\n  name?: string;\n  content_type?: string;\n  quantity?: number;\n  /** Per-item monetary value in ISO 4217 minor units (e.g., 12,999 = $129.99 USD). */\n  amount?: number;\n  currency?: string;\n};\n\nexport type ContentsData = {\n  type: 'contents';\n  /** Monetary value in ISO 4217 minor units (e.g., 12,999 = $129.99 USD). */\n  amount?: number;\n  currency?: string;\n  contents?: ContentItem[];\n};\n\nexport type CustomerActionData = {\n  type: 'customer_action';\n  amount?: number;\n  currency?: string;\n};\n\nexport type PlanEnrollmentData = {\n  type: 'plan_enrollment';\n  plan_id?: string;\n  amount?: number;\n  currency?: string;\n  contents?: ContentItem[];\n};\n\nexport type CustomEventData = {\n  type: 'custom';\n  amount?: number;\n  currency?: string;\n  contents?: ContentItem[];\n};\n\nexport type EventData = ContentsData | CustomerActionData | PlanEnrollmentData | CustomEventData;\n\n/**\n * Standard event names and the `data` shape each one expects.\n * https://developers.openai.com/ads/supported-events\n */\nexport type StandardEvents = {\n  appointment_scheduled: CustomerActionData;\n  checkout_started: ContentsData;\n  contents_viewed: ContentsData;\n  items_added: ContentsData;\n  lead_created: CustomerActionData;\n  order_created: ContentsData;\n  page_viewed: ContentsData;\n  registration_completed: CustomerActionData;\n  subscription_created: PlanEnrollmentData;\n  trial_started: PlanEnrollmentData;\n};\n\nexport type StandardEvent = keyof StandardEvents;\n\nconst STANDARD_EVENTS: readonly string[] = [\n  'appointment_scheduled',\n  'checkout_started',\n  'contents_viewed',\n  'items_added',\n  'lead_created',\n  'order_created',\n  'page_viewed',\n  'registration_completed',\n  'subscription_created',\n  'trial_started',\n] satisfies StandardEvent[];\n\n/**\n * A track name as an OpenAI `custom_event_name`: 1–64 letters, digits, underscores or hyphens,\n * starting and ending with a letter or digit, not a standard event name; the API lowercases it.\n * Anything else becomes an underscore, so `Sign Up.Clicked` is `sign_up_clicked`. Undefined when\n * nothing usable is left — the event is then not sent at all. The pixel and the server both name\n * a custom event through this, so the two still deduplicate.\n * https://developers.openai.com/ads/supported-events\n */\nexport function oaiCustomEventName(name: string): string | undefined {\n  const sanitized = name\n    .toLowerCase()\n    .replace(/[^a-z0-9_-]+/g, '_')\n    .slice(0, 64)\n    .replace(/^[_-]+|[_-]+$/g, '');\n  if (!sanitized || STANDARD_EVENTS.includes(sanitized)) return undefined;\n  return sanitized;\n}\n\n/**\n * Identity fields passed to `oaiq(\"init\", ...)` for conversion matching. Identifiers are\n * normalized, then sent as lowercase 64-char SHA-256 hex strings; geographic values are raw.\n * https://developers.openai.com/ads/measurement-pixel#send-user-data\n */\nexport type OAIQUser = {\n  email_sha256?: string;\n  /** 8–15 digits with the country code, no leading `+` or zeroes (`normalizeOAIPhone`). */\n  phone_number_sha256?: string;\n  external_id_sha256?: string;\n  /** Lowercase, without whitespace or ASCII punctuation (`normalizeOAIName`). */\n  first_name_sha256?: string;\n  last_name_sha256?: string;\n  /** Two-letter ISO 3166-1 country code (e.g. \"US\"). */\n  country?: string;\n  /** Max 128 characters; OpenAI trims and lowercases it. */\n  city?: string;\n  /** State, province or region, max 128 characters. */\n  region?: string;\n  postal_code?: string;\n};\n\n/**\n * A phone number as OpenAI hashes it: whitespace, parentheses, periods and hyphens removed, then\n * the leading `+` and zeroes; 8–15 digits with the country code, else not a usable number.\n */\nexport function normalizeOAIPhone(phone: string): string | undefined {\n  const digits = phone\n    .replace(/[\\s().-]/g, '')\n    .replace(/^\\+/, '')\n    .replace(/^0+/, '');\n  return /^\\d{8,15}$/.test(digits) ? digits : undefined;\n}\n\n/** A name as OpenAI hashes it: lowercase, no whitespace or ASCII punctuation, accents kept. */\nexport function normalizeOAIName(name: string | undefined): string | undefined {\n  return name?.toLowerCase().replace(/[\\s!-/:-@[-`{-~]/g, '') || undefined;\n}\n\nexport type InitConfig = {\n  pixelId: string;\n  /** Log SDK activity to the browser console. */\n  debug?: boolean;\n  user?: OAIQUser;\n};\n\n/**\n * Fourth argument of `oaiq(\"measure\", ...)`. Required for custom events (carries\n * `custom_event_name`); optional for standard events.\n */\nexport type MeasureOptions = {\n  /** Shared with the Conversions API to deduplicate the same conversion across browser and server. */\n  event_id?: string;\n  /** Required for custom events; 1-64 chars of letters, numbers, underscores, or dashes. */\n  custom_event_name?: string;\n  /** When true, opts the event out of user-level personalization. */\n  opt_out?: boolean;\n};\n\nexport interface OAIQ {\n  oaiq(command: 'init', config: InitConfig): void;\n  oaiq<T extends StandardEvent>(\n    command: 'measure',\n    event: T,\n    data: StandardEvents[T],\n    options?: MeasureOptions\n  ): void;\n  oaiq(\n    command: 'measure',\n    event: 'custom',\n    data: CustomEventData,\n    options: MeasureOptions & { custom_event_name: string }\n  ): void;\n}\n\n/**\n * Currencies whose minor unit has 0 or 3 decimal places; everything else uses 2.\n * Follows Stripe's zero-decimal convention (e.g., MGA is treated as 0, ISK is included),\n * which can differ from strict ISO 4217 exponents.\n * https://docs.stripe.com/currencies#zero-decimal\n */\nconst ZERO_DECIMAL_CURRENCIES = new Set([\n  'BIF',\n  'CLP',\n  'DJF',\n  'GNF',\n  'ISK',\n  'JPY',\n  'KMF',\n  'KRW',\n  'MGA',\n  'PYG',\n  'RWF',\n  'UGX',\n  'VND',\n  'VUV',\n  'XAF',\n  'XOF',\n  'XPF',\n]);\nconst THREE_DECIMAL_CURRENCIES = new Set(['BHD', 'IQD', 'JOD', 'KWD', 'LYD', 'OMR', 'TND']);\n\n/**\n * Convert a major-unit amount (e.g., 129.99) into ISO 4217 minor units (e.g., 12,999). None\n * without a currency: the minor unit depends on it, and OpenAI requires a `currency` with every\n * `amount` — an amount alone would be invalid, not just imprecise.\n */\nexport function toMinorUnits(value?: number | null, currency?: string): number | undefined {\n  if (value === undefined || value === null || Number.isNaN(value)) return undefined;\n  const code = currency?.toUpperCase();\n  if (!code) return undefined;\n  const exponent =\n    code && ZERO_DECIMAL_CURRENCIES.has(code)\n      ? 0\n      : code && THREE_DECIMAL_CURRENCIES.has(code)\n        ? 3\n        : 2;\n  return Math.round(value * 10 ** exponent);\n}\n\nexport function mapContents(items?: Item[], currency?: string): ContentItem[] | undefined {\n  if (!items || items.length === 0) return undefined;\n  const code = currency?.toUpperCase();\n  return items.map((item) => {\n    const amount = toMinorUnits(item.price, currency);\n    return {\n      id: item.item_id,\n      name: item.item_name,\n      content_type: item.item_category,\n      quantity: item.quantity,\n      amount,\n      currency: amount !== undefined ? code : undefined,\n    };\n  });\n}\n\n/** Safely read a property off loosely typed track properties without widening to `any`. */\nfunction prop(properties: unknown, key: string): unknown {\n  return typeof properties === 'object' && properties !== null\n    ? (properties as Record<string, unknown>)[key]\n    : undefined;\n}\n\nfunction readValue(properties: unknown): number | undefined {\n  const value = prop(properties, 'value');\n  return typeof value === 'number' ? value : undefined;\n}\n\nfunction readCurrency(properties: unknown): string | undefined {\n  const currency = prop(properties, 'currency');\n  return typeof currency === 'string' ? currency : undefined;\n}\n\nfunction readItems(properties: unknown): Item[] | undefined {\n  const items = prop(properties, 'items');\n  return Array.isArray(items) ? (items as Item[]) : undefined;\n}\n\nfunction contentsData(properties: unknown): ContentsData {\n  const currency = readCurrency(properties);\n  return {\n    type: 'contents',\n    amount: toMinorUnits(readValue(properties), currency),\n    currency: currency?.toUpperCase(),\n    contents: mapContents(readItems(properties), currency),\n  };\n}\n\nfunction customerActionData(properties: unknown): CustomerActionData {\n  const currency = readCurrency(properties);\n  return {\n    type: 'customer_action',\n    amount: toMinorUnits(readValue(properties), currency),\n    currency: currency?.toUpperCase(),\n  };\n}\n\nfunction planEnrollmentData(properties: unknown): PlanEnrollmentData {\n  const currency = readCurrency(properties);\n  const items = readItems(properties);\n  return {\n    type: 'plan_enrollment',\n    plan_id: items?.[0]?.item_id,\n    amount: toMinorUnits(readValue(properties), currency),\n    currency: currency?.toUpperCase(),\n    contents: mapContents(items, currency),\n  };\n}\n\nexport type MappedOAIEvent = {\n  type: StandardEvent | 'custom';\n  data: EventData;\n};\n\n/** Map an internal track event onto an OpenAI standard (or custom) conversion event. */\nexport function mapOAIEvent<T extends EventName>(\n  name: TrackName<T>,\n  properties?: TrackProperties<T>\n): MappedOAIEvent {\n  switch (name) {\n    case 'page_view':\n      return { type: 'page_viewed', data: contentsData(properties) };\n    case 'view_item':\n    case 'view_item_list':\n      return { type: 'contents_viewed', data: contentsData(properties) };\n    case 'begin_checkout':\n      return { type: 'checkout_started', data: contentsData(properties) };\n    case 'add_to_cart':\n      return { type: 'items_added', data: contentsData(properties) };\n    case 'purchase':\n      return { type: 'order_created', data: contentsData(properties) };\n    case 'generate_lead':\n    case 'qualify_lead':\n      return { type: 'lead_created', data: customerActionData(properties) };\n    case 'sign_up':\n    case 'login':\n      return { type: 'registration_completed', data: customerActionData(properties) };\n    case 'schedule':\n      return { type: 'appointment_scheduled', data: customerActionData(properties) };\n    case 'subscribe':\n      return { type: 'subscription_created', data: planEnrollmentData(properties) };\n    case 'trial_begin':\n      return { type: 'trial_started', data: planEnrollmentData(properties) };\n    default: {\n      const currency = readCurrency(properties);\n      return {\n        type: 'custom',\n        data: {\n          type: 'custom',\n          amount: toMinorUnits(readValue(properties), currency),\n          currency: currency?.toUpperCase(),\n          contents: mapContents(readItems(properties), currency),\n        },\n      };\n    }\n  }\n}\n"],"mappings":";AAGA,MAAa,gBAAgB;CAE3B;CACA;CACA;CACA;CACA;CACA;CAEA;CACA;AACF;AAkEA,MAAM,kBAAqC;CACzC;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AACF;;;;;;;;;AAUA,SAAgB,mBAAmB,MAAkC;CACnE,MAAM,YAAY,KACf,YAAY,CAAC,CACb,QAAQ,iBAAiB,GAAG,CAAC,CAC7B,MAAM,GAAG,EAAE,CAAC,CACZ,QAAQ,kBAAkB,EAAE;CAC/B,IAAI,CAAC,aAAa,gBAAgB,SAAS,SAAS,GAAG,OAAO,KAAA;CAC9D,OAAO;AACT;;;;;AA4BA,SAAgB,kBAAkB,OAAmC;CACnE,MAAM,SAAS,MACZ,QAAQ,aAAa,EAAE,CAAC,CACxB,QAAQ,OAAO,EAAE,CAAC,CAClB,QAAQ,OAAO,EAAE;CACpB,OAAO,aAAa,KAAK,MAAM,IAAI,SAAS,KAAA;AAC9C;;AAGA,SAAgB,iBAAiB,MAA8C;CAC7E,OAAO,MAAM,YAAY,CAAC,CAAC,QAAQ,qBAAqB,EAAE,KAAK,KAAA;AACjE;;;;;;;AA4CA,MAAM,0CAA0B,IAAI,IAAI;CACtC;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AACF,CAAC;AACD,MAAM,2CAA2B,IAAI,IAAI;CAAC;CAAO;CAAO;CAAO;CAAO;CAAO;CAAO;AAAK,CAAC;;;;;;AAO1F,SAAgB,aAAa,OAAuB,UAAuC;CACzF,IAAI,UAAU,KAAA,KAAa,UAAU,QAAQ,OAAO,MAAM,KAAK,GAAG,OAAO,KAAA;CACzE,MAAM,OAAO,UAAU,YAAY;CACnC,IAAI,CAAC,MAAM,OAAO,KAAA;CAClB,MAAM,WACJ,QAAQ,wBAAwB,IAAI,IAAI,IACpC,IACA,QAAQ,yBAAyB,IAAI,IAAI,IACvC,IACA;CACR,OAAO,KAAK,MAAM,QAAQ,MAAM,QAAQ;AAC1C;AAEA,SAAgB,YAAY,OAAgB,UAA8C;CACxF,IAAI,CAAC,SAAS,MAAM,WAAW,GAAG,OAAO,KAAA;CACzC,MAAM,OAAO,UAAU,YAAY;CACnC,OAAO,MAAM,KAAK,SAAS;EACzB,MAAM,SAAS,aAAa,KAAK,OAAO,QAAQ;EAChD,OAAO;GACL,IAAI,KAAK;GACT,MAAM,KAAK;GACX,cAAc,KAAK;GACnB,UAAU,KAAK;GACf;GACA,UAAU,WAAW,KAAA,IAAY,OAAO,KAAA;EAC1C;CACF,CAAC;AACH;;AAGA,SAAS,KAAK,YAAqB,KAAsB;CACvD,OAAO,OAAO,eAAe,YAAY,eAAe,OACnD,WAAuC,OACxC,KAAA;AACN;AAEA,SAAS,UAAU,YAAyC;CAC1D,MAAM,QAAQ,KAAK,YAAY,OAAO;CACtC,OAAO,OAAO,UAAU,WAAW,QAAQ,KAAA;AAC7C;AAEA,SAAS,aAAa,YAAyC;CAC7D,MAAM,WAAW,KAAK,YAAY,UAAU;CAC5C,OAAO,OAAO,aAAa,WAAW,WAAW,KAAA;AACnD;AAEA,SAAS,UAAU,YAAyC;CAC1D,MAAM,QAAQ,KAAK,YAAY,OAAO;CACtC,OAAO,MAAM,QAAQ,KAAK,IAAK,QAAmB,KAAA;AACpD;AAEA,SAAS,aAAa,YAAmC;CACvD,MAAM,WAAW,aAAa,UAAU;CACxC,OAAO;EACL,MAAM;EACN,QAAQ,aAAa,UAAU,UAAU,GAAG,QAAQ;EACpD,UAAU,UAAU,YAAY;EAChC,UAAU,YAAY,UAAU,UAAU,GAAG,QAAQ;CACvD;AACF;AAEA,SAAS,mBAAmB,YAAyC;CACnE,MAAM,WAAW,aAAa,UAAU;CACxC,OAAO;EACL,MAAM;EACN,QAAQ,aAAa,UAAU,UAAU,GAAG,QAAQ;EACpD,UAAU,UAAU,YAAY;CAClC;AACF;AAEA,SAAS,mBAAmB,YAAyC;CACnE,MAAM,WAAW,aAAa,UAAU;CACxC,MAAM,QAAQ,UAAU,UAAU;CAClC,OAAO;EACL,MAAM;EACN,SAAS,QAAQ,EAAE,EAAE;EACrB,QAAQ,aAAa,UAAU,UAAU,GAAG,QAAQ;EACpD,UAAU,UAAU,YAAY;EAChC,UAAU,YAAY,OAAO,QAAQ;CACvC;AACF;;AAQA,SAAgB,YACd,MACA,YACgB;CAChB,QAAQ,MAAR;EACE,KAAK,aACH,OAAO;GAAE,MAAM;GAAe,MAAM,aAAa,UAAU;EAAE;EAC/D,KAAK;EACL,KAAK,kBACH,OAAO;GAAE,MAAM;GAAmB,MAAM,aAAa,UAAU;EAAE;EACnE,KAAK,kBACH,OAAO;GAAE,MAAM;GAAoB,MAAM,aAAa,UAAU;EAAE;EACpE,KAAK,eACH,OAAO;GAAE,MAAM;GAAe,MAAM,aAAa,UAAU;EAAE;EAC/D,KAAK,YACH,OAAO;GAAE,MAAM;GAAiB,MAAM,aAAa,UAAU;EAAE;EACjE,KAAK;EACL,KAAK,gBACH,OAAO;GAAE,MAAM;GAAgB,MAAM,mBAAmB,UAAU;EAAE;EACtE,KAAK;EACL,KAAK,SACH,OAAO;GAAE,MAAM;GAA0B,MAAM,mBAAmB,UAAU;EAAE;EAChF,KAAK,YACH,OAAO;GAAE,MAAM;GAAyB,MAAM,mBAAmB,UAAU;EAAE;EAC/E,KAAK,aACH,OAAO;GAAE,MAAM;GAAwB,MAAM,mBAAmB,UAAU;EAAE;EAC9E,KAAK,eACH,OAAO;GAAE,MAAM;GAAiB,MAAM,mBAAmB,UAAU;EAAE;EACvE,SAAS;GACP,MAAM,WAAW,aAAa,UAAU;GACxC,OAAO;IACL,MAAM;IACN,MAAM;KACJ,MAAM;KACN,QAAQ,aAAa,UAAU,UAAU,GAAG,QAAQ;KACpD,UAAU,UAAU,YAAY;KAChC,UAAU,YAAY,UAAU,UAAU,GAAG,QAAQ;IACvD;GACF;EACF;CACF;AACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shware/analytics",
-  "version": "9.0.1",
+  "version": "9.1.0",
   "private": false,
   "repository": {
     "type": "git",