@fanfare-io/fanfare-sdk-contracts 0.14.0 → 0.16.0

package/dist/auction.d.ts

@@ -1,12 +1,84 @@
 import { InferOutput } from 'valibot';
 import * as v from "valibot";
-export declare const AuctionBidderStateResponseSchema: v.LooseObjectSchema<{
-    readonly status: v.PicklistSchema<["NOT_BID", "BIDDING", "WINNING", "OUTBID", "WON", "LOST"], undefined>;
-    readonly lastBidAmount: v.NullishSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>]>, undefined>;
+export declare const AuctionLiveSchema: v.VariantSchema<"auctionType", [v.StrictObjectSchema<{
+    readonly auctionType: v.LiteralSchema<"english", undefined>;
+    readonly highestBid: v.NullableSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>]>, undefined>;
+    readonly minNextBid: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>]>;
+    readonly bidCount: v.NumberSchema<undefined>;
+    readonly effectiveSettleAt: v.StringSchema<undefined>;
+    readonly closeAt: v.NullableSchema<v.StringSchema<undefined>, undefined>;
+    readonly autoExtended: v.BooleanSchema<undefined>;
+    readonly reserveMet: v.BooleanSchema<undefined>;
+    readonly ended: v.BooleanSchema<undefined>;
+}, undefined>, v.StrictObjectSchema<{
+    readonly auctionType: v.LiteralSchema<"dutch", undefined>;
+    readonly currentPrice: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>]>;
+    readonly remainingQuantity: v.NumberSchema<undefined>;
+    readonly totalQuantity: v.NumberSchema<undefined>;
+    readonly nextDropAt: v.NullableSchema<v.StringSchema<undefined>, undefined>;
+    readonly floorPrice: v.NullableSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>]>, undefined>;
+    readonly settleAt: v.StringSchema<undefined>;
+    readonly ended: v.BooleanSchema<undefined>;
+}, undefined>], undefined>;
+export type AuctionLive = InferOutput<typeof AuctionLiveSchema>;
+/**
+ * The auction configuration read. These fifteen fields are an authored projection of the auction
+ * row: checkout and operator fields never leave the server on this endpoint, so a key outside this
+ * set is a contract drift, not an addition to tolerate.
+ */
+export declare const AuctionDetailsResponseSchema: v.StrictObjectSchema<{
+    readonly id: v.StringSchema<undefined>;
+    readonly timeZone: v.StringSchema<undefined>;
+    readonly settleAt: v.StringSchema<undefined>;
+    readonly currencyCode: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.NonEmptyAction<string, undefined>]>;
+    readonly auctionType: v.PicklistSchema<["english", "dutch"], undefined>;
+    readonly openAt: v.NullishSchema<v.StringSchema<undefined>, undefined>;
+    readonly closeAt: v.NullishSchema<v.StringSchema<undefined>, undefined>;
+    readonly reservePrice: v.NullishSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>]>, undefined>;
+    readonly minBidIncrement: v.NullishSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>]>, undefined>;
+    readonly startPrice: v.NullishSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>]>, undefined>;
+    readonly floorPrice: v.NullishSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>]>, undefined>;
+    readonly priceDropAmount: v.NullishSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>]>, undefined>;
+    readonly autoExtendSeconds: v.NullishSchema<v.NumberSchema<undefined>, undefined>;
+    readonly priceDropIntervalSeconds: v.NullishSchema<v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>]>, undefined>;
+    readonly quantity: v.NullishSchema<v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>]>, undefined>;
+}, undefined>;
+export type AuctionDetailsResponse = InferOutput<typeof AuctionDetailsResponseSchema>;
+export declare const AuctionBidderStateResponseSchema: v.StrictObjectSchema<{
+    readonly status: v.PicklistSchema<["NOT_BID", "WINNING", "OUTBID", "WON", "LOST"], undefined>;
+    readonly lastBidAmount: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>]>, undefined>;
     readonly winningBidAmount: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>]>, undefined>;
     readonly bidCount: v.OptionalSchema<v.NumberSchema<undefined>, undefined>;
     readonly admissionGrant: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+    readonly expiresAt: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+    readonly selection: v.OptionalSchema<v.ObjectSchema<{
+        readonly productId: v.StringSchema<undefined>;
+        readonly variantId: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+    }, undefined>, undefined>;
+    readonly standing: v.OptionalSchema<v.PicklistSchema<["unreserved", "reserved", "completed", "expired"], undefined>, undefined>;
+    readonly releaseClass: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+    readonly outcome: v.OptionalSchema<v.PicklistSchema<["completed", "expired"], undefined>, undefined>;
     readonly degraded: v.OptionalSchema<v.BooleanSchema<undefined>, undefined>;
+    readonly live: v.VariantSchema<"auctionType", [v.StrictObjectSchema<{
+        readonly auctionType: v.LiteralSchema<"english", undefined>;
+        readonly highestBid: v.NullableSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>]>, undefined>;
+        readonly minNextBid: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>]>;
+        readonly bidCount: v.NumberSchema<undefined>;
+        readonly effectiveSettleAt: v.StringSchema<undefined>;
+        readonly closeAt: v.NullableSchema<v.StringSchema<undefined>, undefined>;
+        readonly autoExtended: v.BooleanSchema<undefined>;
+        readonly reserveMet: v.BooleanSchema<undefined>;
+        readonly ended: v.BooleanSchema<undefined>;
+    }, undefined>, v.StrictObjectSchema<{
+        readonly auctionType: v.LiteralSchema<"dutch", undefined>;
+        readonly currentPrice: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>]>;
+        readonly remainingQuantity: v.NumberSchema<undefined>;
+        readonly totalQuantity: v.NumberSchema<undefined>;
+        readonly nextDropAt: v.NullableSchema<v.StringSchema<undefined>, undefined>;
+        readonly floorPrice: v.NullableSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>]>, undefined>;
+        readonly settleAt: v.StringSchema<undefined>;
+        readonly ended: v.BooleanSchema<undefined>;
+    }, undefined>], undefined>;
 }, undefined>;
 export type AuctionBidderStateResponse = InferOutput<typeof AuctionBidderStateResponseSchema>;
 export declare const AuctionHighestBidResponseSchema: v.LooseObjectSchema<{

package/dist/auction.js

@@ -1,24 +1,78 @@
-import * as o from "valibot";
-const e = o.string(), t = o.pipe(e, o.regex(/^\d{1,12}(\.\d{1,8})?$/)), n = o.picklist(["NOT_BID", "BIDDING", "WINNING", "OUTBID", "WON", "LOST"]), s = o.looseObject({
-  status: n,
-  lastBidAmount: o.nullish(t),
-  winningBidAmount: o.optional(t),
-  bidCount: o.optional(o.number()),
-  admissionGrant: o.optional(e),
-  // The bid is committed, but a post-commit effect (event fan-out, credential mint) did not
-  // complete on this request. The standing is authoritative; a later status read reconciles
-  // whatever the effect would have projected.
-  degraded: o.optional(o.boolean())
-}), a = o.looseObject({
-  amount: t
-}), i = o.looseObject({
-  amount: t,
-  timestamp: e,
-  isHighest: o.boolean()
-}), c = o.array(i);
+import * as e from "valibot";
+const t = e.string(), n = e.pipe(t, e.regex(/^\d{1,12}(\.\d{1,8})?$/)), i = e.picklist(["NOT_BID", "WINNING", "OUTBID", "WON", "LOST"]), o = e.object({
+  productId: t,
+  variantId: e.optional(t)
+}), l = e.strictObject({
+  auctionType: e.literal("english"),
+  highestBid: e.nullable(n),
+  minNextBid: n,
+  bidCount: e.number(),
+  effectiveSettleAt: t,
+  closeAt: e.nullable(t),
+  autoExtended: e.boolean(),
+  reserveMet: e.boolean(),
+  ended: e.boolean()
+}), s = e.strictObject({
+  auctionType: e.literal("dutch"),
+  currentPrice: n,
+  remainingQuantity: e.number(),
+  totalQuantity: e.number(),
+  nextDropAt: e.nullable(t),
+  floorPrice: e.nullable(n),
+  settleAt: t,
+  ended: e.boolean()
+}), c = e.variant("auctionType", [l, s]), r = e.strictObject({
+  id: t,
+  timeZone: t,
+  settleAt: t,
+  currencyCode: e.pipe(t, e.nonEmpty()),
+  auctionType: e.picklist(["english", "dutch"]),
+  openAt: e.nullish(t),
+  closeAt: e.nullish(t),
+  reservePrice: e.nullish(n),
+  minBidIncrement: e.nullish(n),
+  startPrice: e.nullish(n),
+  floorPrice: e.nullish(n),
+  priceDropAmount: e.nullish(n),
+  autoExtendSeconds: e.nullish(e.number()),
+  priceDropIntervalSeconds: e.nullish(e.pipe(e.number(), e.integer())),
+  quantity: e.nullish(e.pipe(e.number(), e.integer()))
+}), u = e.strictObject({
+  status: i,
+  lastBidAmount: e.optional(n),
+  winningBidAmount: e.optional(n),
+  bidCount: e.optional(e.number()),
+  admissionGrant: e.optional(t),
+  // WON: the grant's continuation deadline, as the admission register holds it.
+  expiresAt: e.optional(t),
+  // WON: the product the win is bound to.
+  selection: e.optional(o),
+  // WON: the admission register's standing for this win, and the recorded cause when it is
+  // `expired`. `outcome` is the terminal result derived from that standing — a WON bidder whose
+  // admission was paid reads `completed`, one whose window closed reads `expired`.
+  standing: e.optional(e.picklist(["unreserved", "reserved", "completed", "expired"])),
+  releaseClass: e.optional(t),
+  outcome: e.optional(e.picklist(["completed", "expired"])),
+  // The bid is committed, but the credential mint did not complete on this request, or the
+  // register could not be read to resolve the outcome. The standing is authoritative; a later
+  // status read reconciles whatever was left unresolved. Event fan-out failures do not raise it:
+  // publication runs after the commit, and a failed one is recovered by the sweep.
+  degraded: e.optional(e.boolean()),
+  // Every display fact the surface needs to render this auction, so a bidder-state read is the
+  // only request a live auction surface makes per tick.
+  live: c
+}), p = e.looseObject({
+  amount: n
+}), a = e.looseObject({
+  amount: n,
+  timestamp: t,
+  isHighest: e.boolean()
+}), d = e.array(a);
 export {
-  i as AuctionBidHistoryItemResponseSchema,
-  c as AuctionBidHistoryResponseSchema,
-  s as AuctionBidderStateResponseSchema,
-  a as AuctionHighestBidResponseSchema
+  a as AuctionBidHistoryItemResponseSchema,
+  d as AuctionBidHistoryResponseSchema,
+  u as AuctionBidderStateResponseSchema,
+  r as AuctionDetailsResponseSchema,
+  p as AuctionHighestBidResponseSchema,
+  c as AuctionLiveSchema
 };

package/dist/beacon.d.ts

@@ -2982,7 +2982,7 @@ export declare const SequenceEndedEventSchema: v.SchemaWithPipe<readonly [v.Obje
     eventName: "sequenceEnded";
     eventProperties?: {
         distributionType?: "queue" | "draw" | "auction" | "timed_release" | "appointment" | undefined;
-        outcome?: "completed" | "closed" | "denied" | "left" | "won" | "lost" | "cancelled" | "no_show" | "expired" | undefined;
+        outcome?: "completed" | "expired" | "closed" | "denied" | "left" | "won" | "lost" | "cancelled" | "no_show" | undefined;
         denialReason?: "ended" | "not_queued" | "not_entered" | "missing_distribution" | "not_participating" | "floor_unsold" | "QUEUE_CLOSED" | "DRAW_CLOSED" | "DRAW_COMPLETED" | "RELEASE_CLOSED" | "BOT_DETECTED" | "VALIDATION_LIMIT_REACHED" | "ORDER_LIMIT_EXCEEDED" | "ADMISSION_EXPIRED" | "TOKEN_EXPIRED" | "NO_SELECTABLE_PRODUCT" | "STOCK_CONSTRAINED" | undefined;
         postalCode?: string | undefined;
         timezone?: string | undefined;
@@ -5922,7 +5922,7 @@ export declare const BeaconEventSchema: v.UnionSchema<[v.SchemaWithPipe<readonly
     eventName: "sequenceEnded";
     eventProperties?: {
         distributionType?: "queue" | "draw" | "auction" | "timed_release" | "appointment" | undefined;
-        outcome?: "completed" | "closed" | "denied" | "left" | "won" | "lost" | "cancelled" | "no_show" | "expired" | undefined;
+        outcome?: "completed" | "expired" | "closed" | "denied" | "left" | "won" | "lost" | "cancelled" | "no_show" | undefined;
         denialReason?: "ended" | "not_queued" | "not_entered" | "missing_distribution" | "not_participating" | "floor_unsold" | "QUEUE_CLOSED" | "DRAW_CLOSED" | "DRAW_COMPLETED" | "RELEASE_CLOSED" | "BOT_DETECTED" | "VALIDATION_LIMIT_REACHED" | "ORDER_LIMIT_EXCEEDED" | "ADMISSION_EXPIRED" | "TOKEN_EXPIRED" | "NO_SELECTABLE_PRODUCT" | "STOCK_CONSTRAINED" | undefined;
         postalCode?: string | undefined;
         timezone?: string | undefined;

package/dist/bridge.d.ts

@@ -1,4 +1,5 @@
 import { DistributionType, SequenceOutcomeType } from './consumer-me';
+import { SelectionChoice, SelectionDraft } from './selection';
 /**
  * Name of the DOM `CustomEvent` dispatched whenever the journey's projected
  * state changes.
@@ -15,6 +16,45 @@ export declare const FANFARE_STATE_CHANGE_EVENT: "fanfare:state-change";
  * recognise.
  */
 export declare const BRIDGE_EVENT_VERSION = 1;
+/**
+ * Name of the DOM `CustomEvent` dispatched whenever the consumer's product
+ * selection changes.
+ *
+ * A separate event from {@link FANFARE_STATE_CHANGE_EVENT}, with its own
+ * version: a selection moves under a state that has not changed, and a page
+ * listening for one has no reason to receive the other.
+ */
+export declare const FANFARE_SELECTION_CHANGE_EVENT: "fanfare:selection-change";
+/**
+ * Version of the {@link FanfareSelectionChangeDetail} payload.
+ *
+ * Versioned independently of {@link BRIDGE_EVENT_VERSION}: the two payloads
+ * break on their own schedules.
+ */
+export declare const SELECTION_BRIDGE_EVENT_VERSION: 1;
+/** `detail` of a {@link FANFARE_SELECTION_CHANGE_EVENT} event. */
+export interface FanfareSelectionChangeDetail {
+    /** Payload version; compare against `1` and ignore unrecognised versions. */
+    version: 1;
+    experienceId: string;
+    sequenceId: string;
+    /** The consumer's local pick; may lead, equal, or lag `committed`. */
+    draft: SelectionDraft;
+    /** The server-committed pair, or null before any pin. */
+    committed: SelectionChoice | null;
+    /** Qualifies `committed`; null iff `committed` is null. */
+    resolution: "chosen" | "assigned" | "auto" | null;
+    /** Stable per widget instance; `seq` is monotonic within it and restarts with it. */
+    emitterId: string;
+    seq: number;
+}
+/**
+ * The DOM event carrying a {@link FanfareSelectionChangeDetail}.
+ *
+ * Used to narrow inside a listener — `(e as FanfareSelectionChangeEvent).detail` —
+ * because no global event-map augmentation ships with this package.
+ */
+export type FanfareSelectionChangeEvent = CustomEvent<FanfareSelectionChangeDetail>;
 /** Fields every payload arm carries, whatever the journey stage. */
 interface FanfareStateChangeBase {
     /** Payload version; compare against `1` and ignore unrecognised versions. */

package/dist/bridge.js

@@ -1,5 +1,7 @@
-const E = "fanfare:state-change", t = 1;
+const E = "fanfare:state-change", N = 1, _ = "fanfare:selection-change", n = 1;
 export {
-  t as BRIDGE_EVENT_VERSION,
-  E as FANFARE_STATE_CHANGE_EVENT
+  N as BRIDGE_EVENT_VERSION,
+  _ as FANFARE_SELECTION_CHANGE_EVENT,
+  E as FANFARE_STATE_CHANGE_EVENT,
+  n as SELECTION_BRIDGE_EVENT_VERSION
 };