@fanfare-io/fanfare-sdk-contracts 0.1.0

package/dist/beacon.js

@@ -0,0 +1,269 @@
+import * as e from "valibot";
+import { RFM_SEGMENT_KEYS as u, BeaconEventNames as g, BeaconEventName as v } from "./beacon-names.js";
+const t = v, C = 50, P = 64, _ = 2048, E = 256, N = 50, T = /^\d{1,12}(\.\d{1,8})?$/, b = e.picklist(u), a = e.pipe(
+  e.string(),
+  e.maxLength(_, "validation.beacon.string.maxLength")
+), o = e.pipe(
+  e.string(),
+  e.maxLength(E, "validation.beacon.string.maxLength")
+), c = e.pipe(
+  e.string(),
+  e.regex(T, "validation.number"),
+  e.maxLength(E, "validation.beacon.money.maxLength")
+), l = e.pipe(
+  e.string(),
+  e.isoTimestamp(),
+  e.maxLength(64, "validation.beacon.timestamp.maxLength")
+), m = e.pipe(
+  e.string(),
+  e.regex(/^\d+$/),
+  e.maxLength(32, "validation.beacon.timestampNs.maxLength")
+), i = e.pipe(
+  e.number(),
+  e.check(Number.isFinite, "validation.beacon.number.finite")
+), I = e.pipe(
+  e.record(
+    e.pipe(e.string(), e.maxLength(P, "validation.beacon.propertyKey.maxLength")),
+    e.union([a, i, e.boolean(), e.null()])
+  ),
+  e.maxEntries(C, "validation.beacon.eventProperties.maxEntries")
+), s = {
+  postalCode: e.optional(o),
+  timezone: e.optional(o),
+  botScore: e.optional(i),
+  geoLat: e.optional(i),
+  geoLng: e.optional(i)
+}, O = e.object({
+  organizationId: o,
+  consumerId: e.optional(o),
+  eventId: o,
+  eventName: e.picklist(g),
+  eventTimestamp: l,
+  eventTimestampNs: e.optional(m),
+  receivedTimestamp: e.optional(l),
+  receivedTimestampNs: e.optional(m),
+  segments: e.optional(
+    e.object({
+      rfm: e.optional(b)
+    })
+  ),
+  userId: e.optional(o),
+  anonymousId: e.optional(o),
+  sessionId: e.optional(o),
+  platform: e.optional(o),
+  appVersion: e.optional(o),
+  deviceType: e.optional(o),
+  osName: e.optional(o),
+  osVersion: e.optional(o),
+  browserName: e.optional(o),
+  browserVersion: e.optional(o),
+  userAgent: e.optional(a),
+  ipAddress: e.optional(o),
+  geoCountry: e.optional(o),
+  geoRegion: e.optional(o),
+  geoCity: e.optional(o),
+  geoLatitude: e.optional(i),
+  geoLongitude: e.optional(i),
+  pageUrl: e.optional(a),
+  pagePath: e.optional(a),
+  pageTitle: e.optional(a),
+  screenName: e.optional(a),
+  referrerUrl: e.optional(a),
+  referringDomain: e.optional(a),
+  utmSource: e.optional(o),
+  utmMedium: e.optional(o),
+  utmCampaign: e.optional(o),
+  utmTerm: e.optional(o),
+  utmContent: e.optional(o),
+  eventSchemaVersion: e.optional(o),
+  eventProperties: e.optional(I),
+  beaconRequestId: e.optional(o)
+}), A = e.strictObject({
+  ...s,
+  pageType: e.optional(o)
+}), S = e.strictObject({
+  ...s,
+  productId: e.optional(o),
+  listName: e.optional(o),
+  position: e.optional(i)
+}), M = S, R = e.strictObject({
+  ...s,
+  productId: e.optional(o),
+  sku: e.optional(o),
+  productName: e.optional(a),
+  category: e.optional(o),
+  brand: e.optional(o),
+  variant: e.optional(o),
+  price: e.optional(c),
+  currency: e.optional(o)
+}), d = e.strictObject({
+  ...s,
+  cartId: e.optional(o),
+  productId: e.optional(o),
+  sku: e.optional(o),
+  productName: e.optional(a),
+  category: e.optional(o),
+  variant: e.optional(o),
+  price: e.optional(c),
+  quantity: e.optional(i),
+  currency: e.optional(o)
+}), y = d, B = e.strictObject({
+  ...s,
+  cartId: e.optional(o),
+  cartTotal: e.optional(c),
+  itemCount: e.optional(i),
+  currency: e.optional(o)
+}), L = e.strictObject({
+  ...s,
+  cartId: e.optional(o),
+  cartTotal: e.optional(c),
+  itemCount: e.optional(i),
+  currency: e.optional(o),
+  couponCodeApplied: e.optional(o)
+}), x = e.strictObject({
+  productId: e.optional(o),
+  sku: e.optional(o),
+  productName: e.optional(a),
+  category: e.optional(o),
+  variant: e.optional(o),
+  price: e.optional(c),
+  quantity: e.optional(i)
+}), V = e.strictObject({
+  ...s,
+  orderId: e.optional(o),
+  transactionId: e.optional(o),
+  totalRevenue: e.optional(c),
+  subtotal: e.optional(c),
+  tax: e.optional(c),
+  shippingCost: e.optional(c),
+  currency: e.optional(o),
+  couponCodeUsed: e.optional(o),
+  discountAmount: e.optional(c),
+  products: e.optional(
+    e.pipe(
+      e.array(x),
+      e.maxLength(N, "validation.beacon.purchaseProducts.maxLength")
+    )
+  )
+}), D = e.strictObject({
+  ...s,
+  searchQuery: e.optional(a),
+  resultsCount: e.optional(i)
+}), j = e.strictObject({
+  ...s,
+  experienceId: e.optional(o),
+  sequenceId: e.optional(o),
+  locationId: e.optional(o),
+  qrPayload: e.optional(a)
+}), G = e.picklist(["email", "sms"]), r = e.strictObject({
+  ...s,
+  channel: e.optional(G),
+  messageId: e.optional(o),
+  template: e.optional(o),
+  priority: e.optional(o),
+  consumerId: e.optional(o)
+}), U = e.strictObject({
+  ...r.entries,
+  bounceType: e.optional(o)
+}), k = e.strictObject({
+  ...r.entries,
+  complaintType: e.optional(o)
+}), f = e.strictObject({
+  ...r.entries,
+  retryCount: e.optional(i)
+}), n = (p, h) => e.object({
+  ...O.entries,
+  eventName: e.literal(p),
+  eventProperties: e.optional(h)
+}), w = n(t.PAGE_VIEW, A), F = n(
+  t.PRODUCT_IMPRESSION,
+  S
+), H = n(t.PRODUCT_CLICK, M), K = n(t.PRODUCT_VIEW, R), X = n(t.ADD_TO_CART, d), q = n(t.REMOVE_FROM_CART, y), Y = n(t.VIEW_CART, B), Q = n(t.BEGIN_CHECKOUT, L), z = n(t.PURCHASE, V), W = n(
+  t.SEARCH_SUBMITTED,
+  D
+), $ = n(t.QR_SCANNED, j), J = n(t.MESSAGE_SENT, r), Z = n(t.MESSAGE_DELIVERED, r), ee = n(t.MESSAGE_BOUNCED, U), oe = n(
+  t.MESSAGE_COMPLAINED,
+  k
+), te = n(t.MESSAGE_CLICKED, r), ne = n(t.MESSAGE_OPENED, r), ae = n(t.MESSAGE_READ, r), ie = n(t.MESSAGE_FAILED, f), ce = e.union([
+  w,
+  F,
+  H,
+  K,
+  X,
+  q,
+  Y,
+  Q,
+  z,
+  W,
+  $,
+  J,
+  Z,
+  ee,
+  oe,
+  te,
+  ne,
+  ae,
+  ie
+]);
+function re(p) {
+  return e.parse(ce, JSON.parse(p));
+}
+export {
+  X as AddToCartEventSchema,
+  d as AddToCartPropertiesSchema,
+  C as BEACON_EVENT_PROPERTIES_MAX_ENTRIES,
+  P as BEACON_EVENT_PROPERTY_KEY_MAX_LENGTH,
+  _ as BEACON_EVENT_PROPERTY_STRING_MAX_LENGTH,
+  N as BEACON_EVENT_PURCHASE_PRODUCTS_MAX_ITEMS,
+  E as BEACON_EVENT_SHORT_STRING_MAX_LENGTH,
+  O as BeaconEventCoreSchema,
+  s as BeaconEventEnrichmentPropertiesSchemaEntries,
+  a as BeaconEventLongStringSchema,
+  c as BeaconEventMoneyStringSchema,
+  t as BeaconEventName,
+  g as BeaconEventNames,
+  m as BeaconEventNanosecondsStringSchema,
+  i as BeaconEventNumberSchema,
+  I as BeaconEventPropertiesSchema,
+  ce as BeaconEventSchema,
+  o as BeaconEventShortStringSchema,
+  l as BeaconEventTimestampStringSchema,
+  Q as BeginCheckoutEventSchema,
+  L as BeginCheckoutPropertiesSchema,
+  T as MONETARY_AMOUNT_REGEX,
+  ee as MessageBouncedEventSchema,
+  U as MessageBouncedPropertiesSchema,
+  G as MessageChannelSchema,
+  te as MessageClickedEventSchema,
+  oe as MessageComplainedEventSchema,
+  k as MessageComplainedPropertiesSchema,
+  Z as MessageDeliveredEventSchema,
+  r as MessageEventPropertiesSchema,
+  ie as MessageFailedEventSchema,
+  f as MessageFailedPropertiesSchema,
+  ne as MessageOpenedEventSchema,
+  ae as MessageReadEventSchema,
+  J as MessageSentEventSchema,
+  w as PageViewEventSchema,
+  A as PageViewPropertiesSchema,
+  H as ProductClickEventSchema,
+  M as ProductClickPropertiesSchema,
+  F as ProductImpressionEventSchema,
+  S as ProductImpressionPropertiesSchema,
+  K as ProductViewEventSchema,
+  R as ProductViewPropertiesSchema,
+  z as PurchaseEventSchema,
+  x as PurchaseProductSchema,
+  V as PurchasePropertiesSchema,
+  $ as QRScannedEventSchema,
+  j as QRScannedPropertiesSchema,
+  u as RFM_SEGMENT_KEYS,
+  q as RemoveFromCartEventSchema,
+  y as RemoveFromCartPropertiesSchema,
+  b as RfmSegmentKeySchema,
+  W as SearchSubmittedEventSchema,
+  D as SearchSubmittedPropertiesSchema,
+  Y as ViewCartEventSchema,
+  B as ViewCartPropertiesSchema,
+  re as deserializeBeaconEvent
+};

package/dist/challenges.d.ts

@@ -0,0 +1,36 @@
+import { InferOutput } from 'valibot';
+import * as v from "valibot";
+export declare const ChallengeProvider: {
+    readonly TURNSTILE: "turnstile";
+};
+export declare const ChallengeProviders: readonly ["turnstile"];
+export type ChallengeProvider = (typeof ChallengeProviders)[number];
+export declare const ChallengeProviderSchema: v.PicklistSchema<readonly ["turnstile"], undefined>;
+export declare const ChallengeType: {
+    readonly TURNSTILE_INVISIBLE: "turnstile_invisible";
+    readonly TURNSTILE_MANAGED: "turnstile_managed";
+    readonly TURNSTILE_INTERACTIVE: "turnstile_interactive";
+};
+export declare const ChallengeTypes: readonly ["turnstile_invisible", "turnstile_managed", "turnstile_interactive"];
+export type ChallengeType = (typeof ChallengeTypes)[number];
+export declare const ChallengeTypeSchema: v.PicklistSchema<readonly ["turnstile_invisible", "turnstile_managed", "turnstile_interactive"], undefined>;
+export declare const ChallengePurpose: {
+    readonly EXPERIENCE_ENTRY: "experience_entry";
+};
+export declare const ChallengePurposes: readonly ["experience_entry"];
+export type ChallengePurpose = (typeof ChallengePurposes)[number];
+export declare const ChallengePurposeSchema: v.PicklistSchema<readonly ["experience_entry"], undefined>;
+export declare const RoutingChallengeSchema: v.ObjectSchema<{
+    readonly id: v.StringSchema<undefined>;
+    readonly provider: v.LiteralSchema<"turnstile", undefined>;
+    readonly type: v.PicklistSchema<readonly ["turnstile_invisible", "turnstile_managed", "turnstile_interactive"], undefined>;
+    readonly iframeUrl: v.StringSchema<undefined>;
+    readonly expiresAt: v.StringSchema<undefined>;
+}, undefined>;
+export type RoutingChallenge = InferOutput<typeof RoutingChallengeSchema>;
+export declare const BotMitigationStateSchema: v.ObjectSchema<{
+    readonly attemptsRemaining: v.OptionalSchema<v.NumberSchema<undefined>, undefined>;
+    readonly blockedUntil: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+    readonly message: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+}, undefined>;
+export type BotMitigationState = InferOutput<typeof BotMitigationStateSchema>;

package/dist/challenges.js

@@ -0,0 +1,37 @@
+import * as e from "valibot";
+const n = {
+  TURNSTILE: "turnstile"
+}, i = [n.TURNSTILE], a = e.picklist(i), t = {
+  TURNSTILE_INVISIBLE: "turnstile_invisible",
+  TURNSTILE_MANAGED: "turnstile_managed",
+  TURNSTILE_INTERACTIVE: "turnstile_interactive"
+}, l = [
+  t.TURNSTILE_INVISIBLE,
+  t.TURNSTILE_MANAGED,
+  t.TURNSTILE_INTERACTIVE
+], s = e.picklist(l), o = {
+  EXPERIENCE_ENTRY: "experience_entry"
+}, r = [o.EXPERIENCE_ENTRY], E = e.picklist(r), T = e.object({
+  id: e.string(),
+  provider: e.literal(n.TURNSTILE),
+  type: s,
+  iframeUrl: e.string(),
+  expiresAt: e.string()
+}), c = e.object({
+  attemptsRemaining: e.optional(e.number()),
+  blockedUntil: e.optional(e.string()),
+  message: e.optional(e.string())
+});
+export {
+  c as BotMitigationStateSchema,
+  n as ChallengeProvider,
+  a as ChallengeProviderSchema,
+  i as ChallengeProviders,
+  o as ChallengePurpose,
+  E as ChallengePurposeSchema,
+  r as ChallengePurposes,
+  t as ChallengeType,
+  s as ChallengeTypeSchema,
+  l as ChallengeTypes,
+  T as RoutingChallengeSchema
+};