@getmicdrop/venue-calendar 4.0.92 → 4.0.93

package/dist/api/types.d.ts

@@ -1,438 +1,447 @@
-/**
- * API Types for MicDrop Public Checkout API
- *
- * These types define the shape of API requests and responses
- * for the public checkout flow (no authentication required).
- */
-
-import type { EventId, SeriesId } from '@getmicdrop/svelte-components';
-
-// ============================================================================
-// Payment & Orders
-// ============================================================================
-
-export interface PaymentIntentRequest {
-  IP?: string;
-  productQuantities: Record<string | number, number>;
-}
-
-export interface PaymentIntentResponse {
-  client_secret: string;
-  amount: number;
-  amount_total: number;
-  tax_amount_exclusive?: number;
-  service_fee?: number;
-  discount?: number;
-  gift_card_amount?: number;
-  gift_card_code?: string;
-  stripe_publishable_key?: string;
-}
-
-export interface CompleteReservationResponse {
-  success: boolean;
-  message?: string;
-  error?: string;
-}
-
-export interface CancelReservationResponse {
-  success: boolean;
-  message?: string;
-  error?: string;
-}
-
-export interface CreateOrderRequest {
-  eventId: string | number;
-  promoCode?: string;
-}
-
-export interface CreateOrderResponse {
-  uuid: string;
-}
-
-export interface ValidatePaymentRequest {
-  id: string;
-  paymentIntentId: string;
-  tickets: Record<string | number, number>;
-  firstName: string;
-  lastName: string;
-  email: string;
-  paymentMethod: string;
-  mailingList?: boolean;
-  saleType?: string;
-  attendees?: AttendeeInfo[];
-}
-
-export interface AttendeeInfo {
-  ticketId: string | number;
-  firstName: string;
-  lastName: string;
-  email: string;
-}
-
-export interface ValidatePaymentResponse {
-  success: boolean;
-  status: string;
-  orderUUID?: string;
-  error?: string;
-  /**
-   * Fail-closed FLOOR fields. When the event is canceled/postponed between
-   * cart-creation and finalize, the backend gate refuses to capture the charge
-   * and sets one of these (alongside `success: false`). Either flag means the
-   * buyer was NOT charged; the checkout raises the charge-aware
-   * EventUnavailableModal instead of navigating to success. Optional because
-   * they are only present on the rejected-finalize path.
-   */
-  eventCanceled?: boolean;
-  eventPostponed?: boolean;
-}
-
-// ============================================================================
-// Session Management
-// ============================================================================
-
-export interface ExtendSessionRequest {
-  orderUuid: string;
-}
-
-export interface ExtendSessionResponse {
-  success: boolean;
-  newExpiryTime?: string;
-  remainingExtensions?: number;
-  error?: string;
-  /**
-   * HTTP status code from the backend on failure. Populated on non-OK
-   * responses so callers can distinguish "session already expired"
-   * (typically 410 Gone) from "max extensions reached" or generic 5xx.
-   * Undefined on network errors and on success.
-   */
-  statusCode?: number;
-}
-
-export interface SessionStatus {
-  expiresAt?: string;
-  extensionCount?: number;
-  remainingExtensions?: number;
-  canExtend?: boolean;
-  reservationCount?: number;
-  error?: string;
-  // 404 from /orders/session/{uuid}: the cart's reservations are
-  // gone (expired or never existed). Callers polling on an interval
-  // MUST treat this as terminal and stop — see CartView.svelte.
-  notFound?: boolean;
-  // Live event status piggybacked on the session heartbeat so the public
-  // checkout can flip the buy button the moment an operator cancels/postpones,
-  // without a dedicated poll or socket. One of the auth-service Event statuses
-  // (draft|live|started|ended|canceled|postponed). Absent if the lookup failed.
-  eventStatus?: string;
-}
-
-// ============================================================================
-// Promo Codes
-// ============================================================================
-
-export interface PromoValidationResponse {
-  valid: boolean;
-  revealHiddenTickets?: boolean;
-  revealTicketIds?: number[];
-  provideDiscount?: boolean;
-  discountType?: 'percentage' | 'fixed';
-  amount?: number;
-  code?: string;
-  error?: string;
-}
-
-export interface HasPromoCodesResponse {
-  hasPromoCodes: boolean;
-}
-
-// ============================================================================
-// Orders
-// ============================================================================
-
-export interface Order {
-  uuid: string;
-  id?: number;
-  customerEmail: string;
-  customerFirstName?: string;
-  customerLastName?: string;
-  status: string;
-  totalAmount: number;
-  subtotal?: number;
-  serviceFeesAmount: number;
-  taxAmount: number;
-  discount?: number;
-  paymentIntentId?: string;
-  paymentMethod?: string;
-  purchasedTickets: PurchasedTicket[];
-  createdAt?: string;
-  updatedAt?: string;
-}
-
-export interface PurchasedTicket {
-  uuid: string;
-  id?: number;
-  ticketNumber?: string;
-  orderId?: string | number;
-  attendeeFirstName?: string;
-  attendeeLastName?: string;
-  attendeeEmail?: string;
-  ticketName: string;
-  ticketTypeId?: number;
-  purchasePrice: number;
-  status?: string;
-  checkedIn?: boolean;
-  checkedInAt?: string;
-}
-
-// ============================================================================
-// Events
-// ============================================================================
-
-export interface Event {
-  eventID: number;
-  id?: number;
-  name: string;
-  title?: string;
-  slug?: string;
-  description?: string;
-  date: string;
-  startDateTime?: string;
-  endDateTime?: string;
-  doorsOpenTime?: string;
-  timezone?: string;
-  venueId?: number;
-  venueName?: string;
-  venueAddress?: string;
-  location?: string;
-  imageUrl?: string;
-  imageURL?: string;
-  status?: string;
-  isPublished?: boolean;
-  isCancelled?: boolean;
-  availableTickets?: AvailableTicket[];
-  ticketsAvailable?: number;
-  ticketsSold?: number;
-  minPrice?: number;
-  maxPrice?: number;
-  ctaText?: string;
-  ctaState?: 'available' | 'sold_out' | 'coming_soon' | 'ended';
-  showPerformers?: boolean;
-  eventSeriesId?: number;
-  seriesInstanceNumber?: number;
-  // ── Passthrough seams (events convergence) ─────────────────────────────
-  // Carried verbatim from the wire by parseEvent so view-shape projections
-  // (utils/event-transform.js, public-calendar-flow/transform.ts) compose the
-  // canonical instead of reading wire fields directly. The object-valued
-  // fields are intentionally raw (see composition note in
-  // api/transformers/event.ts) — their consumers own the wire variance.
-  timeZone?: string;
-  eventSummary?: string;
-  password?: string;
-  hasPassword?: boolean;
-  disclaimer?: string;
-  ticketType?: number;
-  eventTicketingType?: number;
-  ageRestriction?: number;
-  displayAgeRestriction?: boolean;
-  displayStartTime?: boolean;
-  displayEndTime?: boolean;
-  displayDoorsTime?: boolean;
-  collectionId?: number;
-  ticketsRemaining?: number;
-  ticketsTotal?: number;
-  hasHiddenTickets?: boolean;
-  stage?: { name?: string } | null;
-  stageName?: string;
-  // Widget-filter dimensions on the public month feeds (saved-widget engine):
-  // stage/category/performer/collection data the embed adapts onto the SC
-  // FilterableEvent view (lib/widget-filters.js).
-  stageId?: number;
-  eventCategoryTypes?: number[] | null;
-  publicPerformers?: Array<{
-    id?: number;
-    displayName?: string;
-    image?: string;
-  }> | null;
-  collectionIds?: number[] | null;
-  venue?: Record<string, any>;
-  performers?: Record<string, any>[];
-  faqs?: Record<string, any>[];
-  showtimes?: Record<string, any>[];
-  purchasedTickets?: Record<string, any>[];
-}
-
-export interface AvailableTicket {
-  id: number;
-  name: string;
-  description?: string;
-  price: number;
-  quantity: number;
-  quantitySold?: number;
-  quantityAvailable?: number;
-  minPerOrder?: number;
-  maxPerOrder?: number;
-  saleStartDate?: string;
-  saleEndDate?: string;
-  isHidden?: boolean;
-  revealWithPromoCode?: boolean;
-  ticketType?: number; // 0 = GA, 1 = assigned
-  sectionId?: number;
-  sortOrder?: number;
-}
-
-export interface EventPerformersResponse {
-  performers: Performer[];
-  showPerformers: boolean;
-}
-
-export interface Performer {
-  id: number;
-  displayName: string;
-  avatar?: string;
-  order?: number;
-}
-
-// ============================================================================
-// Venues
-// ============================================================================
-
-export interface Venue {
-  id: number;
-  name: string;
-  slug?: string;
-  address?: string;
-  googleLocationNameCache?: string;
-  city?: string;
-  state?: string;
-  zipCode?: string;
-  country?: string;
-  timezone?: string;
-  logoUrl?: string;
-  serviceFeePercentage?: number;
-  serviceFeeCents?: number;
-  taxPercentage?: number;
-  organizationId?: number;
-}
-
-// ============================================================================
-// Series
-// ============================================================================
-
-export interface SeriesOccurrence {
-  eventId: EventId;
-  date: string;
-  startDateTime: string;
-  endDateTime?: string;
-  instanceNumber: number;
-  status: string;
-  ticketsAvailable?: number;
-  ctaState?: string;
-}
-
-export interface SeriesOccurrencesResponse {
-  seriesId: SeriesId;
-  occurrences: SeriesOccurrence[];
-}
-
-// ============================================================================
-// Series Page
-// ============================================================================
-
-export interface SeriesPageData {
-  id: number;
-  title: string;
-  description: string;
-  eventSummary?: string;
-  image?: string;
-  timeZone: string;
-  venue: {
-    id: number;
-    name: string;
-    location?: string;
-    googleLocationNameCache?: string;
-    faq?: Array<{ question: string; answer: string }> | string;
-    disclaimer?: string;
-  };
-  performers: Array<{
-    displayName: string;
-    firstName?: string;
-    lastName?: string;
-    profileImage?: string;
-  }>;
-  occurrences: Array<{
-    id: number;
-    slug: string;
-    startDateTime: string;
-    endDateTime: string;
-    ctaState: {
-      text: string;
-      disabled: boolean;
-      reason?: string;
-    };
-  }>;
-}
-
-// ============================================================================
-// Entity resolution (type-agnostic public id → concrete entity)
-// ============================================================================
-
-/**
- * Response shape of `/api/v2/public/resolve/{id}`. The embed deep-link is
- * type-agnostic (`#{id}-{slug}`), so the backend resolves which kind of entity
- * the id points at; `data` is the corresponding event / series / collection
- * payload (same shape the dedicated fetchers return for that type).
- */
-export interface ResolvedEntity {
-  type: 'event' | 'series' | 'collection';
-  id: string | number;
-  title?: string;
-  data: any;
-}
-
-// ============================================================================
-// Public Collection
-// ============================================================================
-
-export interface PublicCollectionData {
-  id: number;
-  collectionTitle: string;
-  summary?: string;
-  description?: string;
-  coverImage?: string;
-  events: Array<{
-    id: number;
-    title: string;
-    slug?: string;
-    startDateTime?: string;
-    endDateTime?: string;
-    image?: string;
-    status?: string;
-    venue?: { name: string };
-    minPrice?: number;
-  }>;
-}
-
-// ============================================================================
-// API Configuration
-// ============================================================================
-
-export interface ApiConfig {
-  baseUrl?: string;
-  timeout?: number;
-  /** Number of additional attempts after the first try (default: 2 = 3 total tries). */
-  retries?: number;
-  /** Base delay before the first retry; doubles each attempt (default: 500ms). */
-  retryDelay?: number;
-  onError?: (_error: Error) => void;
-}
-
-// ============================================================================
-// Generic API Response
-// ============================================================================
-
-export interface ApiResponse<T> {
-  success: boolean;
-  data?: T;
-  error?: string;
-  statusCode?: number;
-}
+/**
+ * API Types for MicDrop Public Checkout API
+ *
+ * These types define the shape of API requests and responses
+ * for the public checkout flow (no authentication required).
+ */
+
+import type { EventId, SeriesId } from '@getmicdrop/svelte-components';
+
+// ============================================================================
+// Payment & Orders
+// ============================================================================
+
+export interface PaymentIntentRequest {
+  IP?: string;
+  productQuantities: Record<string | number, number>;
+}
+
+export interface PaymentIntentResponse {
+  client_secret: string;
+  amount: number;
+  amount_total: number;
+  subtotal?: number;
+  tax_amount_exclusive?: number;
+  service_fee?: number;
+  discount?: number;
+  gift_card_amount?: number;
+  gift_card_code?: string;
+  stripe_publishable_key?: string;
+  // ISO-4217 currency (Stripe returns it lowercase). Feeds the checkout totals.
+  currency?: string;
+}
+
+export interface CompleteReservationResponse {
+  success: boolean;
+  message?: string;
+  error?: string;
+}
+
+export interface CancelReservationResponse {
+  success: boolean;
+  message?: string;
+  error?: string;
+}
+
+export interface CreateOrderRequest {
+  eventId: string | number;
+  promoCode?: string;
+}
+
+export interface CreateOrderResponse {
+  uuid: string;
+}
+
+export interface ValidatePaymentRequest {
+  id: string;
+  paymentIntentId: string;
+  tickets: Record<string | number, number>;
+  firstName: string;
+  lastName: string;
+  email: string;
+  paymentMethod: string;
+  mailingList?: boolean;
+  saleType?: string;
+  attendees?: AttendeeInfo[];
+}
+
+export interface AttendeeInfo {
+  ticketId: string | number;
+  firstName: string;
+  lastName: string;
+  email: string;
+}
+
+export interface ValidatePaymentResponse {
+  success: boolean;
+  status: string;
+  orderUUID?: string;
+  error?: string;
+  /**
+   * Fail-closed FLOOR fields. When the event is canceled/postponed between
+   * cart-creation and finalize, the backend gate refuses to capture the charge
+   * and sets one of these (alongside `success: false`). Either flag means the
+   * buyer was NOT charged; the checkout raises the charge-aware
+   * EventUnavailableModal instead of navigating to success. Optional because
+   * they are only present on the rejected-finalize path.
+   */
+  eventCanceled?: boolean;
+  eventPostponed?: boolean;
+}
+
+// ============================================================================
+// Session Management
+// ============================================================================
+
+export interface ExtendSessionRequest {
+  orderUuid: string;
+}
+
+export interface ExtendSessionResponse {
+  success: boolean;
+  newExpiryTime?: string;
+  remainingExtensions?: number;
+  error?: string;
+  /**
+   * HTTP status code from the backend on failure. Populated on non-OK
+   * responses so callers can distinguish "session already expired"
+   * (typically 410 Gone) from "max extensions reached" or generic 5xx.
+   * Undefined on network errors and on success.
+   */
+  statusCode?: number;
+}
+
+export interface SessionStatus {
+  expiresAt?: string;
+  extensionCount?: number;
+  remainingExtensions?: number;
+  canExtend?: boolean;
+  reservationCount?: number;
+  error?: string;
+  // 404 from /orders/session/{uuid}: the cart's reservations are
+  // gone (expired or never existed). Callers polling on an interval
+  // MUST treat this as terminal and stop — see CartView.svelte.
+  notFound?: boolean;
+  // Live event status piggybacked on the session heartbeat so the public
+  // checkout can flip the buy button the moment an operator cancels/postpones,
+  // without a dedicated poll or socket. One of the auth-service Event statuses
+  // (draft|live|started|ended|canceled|postponed). Absent if the lookup failed.
+  eventStatus?: string;
+}
+
+// ============================================================================
+// Promo Codes
+// ============================================================================
+
+export interface PromoValidationResponse {
+  valid: boolean;
+  revealHiddenTickets?: boolean;
+  revealTicketIds?: number[];
+  provideDiscount?: boolean;
+  discountType?: 'percentage' | 'fixed';
+  amount?: number;
+  code?: string;
+  error?: string;
+}
+
+export interface HasPromoCodesResponse {
+  hasPromoCodes: boolean;
+}
+
+// ============================================================================
+// Orders
+// ============================================================================
+
+export interface Order {
+  uuid: string;
+  id?: number;
+  customerEmail: string;
+  customerFirstName?: string;
+  customerLastName?: string;
+  status: string;
+  totalAmount: number;
+  subtotal?: number;
+  serviceFeesAmount: number;
+  taxAmount: number;
+  discount?: number;
+  paymentIntentId?: string;
+  paymentMethod?: string;
+  purchasedTickets: PurchasedTicket[];
+  createdAt?: string;
+  updatedAt?: string;
+}
+
+export interface PurchasedTicket {
+  uuid: string;
+  id?: number;
+  ticketNumber?: string;
+  orderId?: string | number;
+  attendeeFirstName?: string;
+  attendeeLastName?: string;
+  attendeeEmail?: string;
+  ticketName: string;
+  ticketTypeId?: number;
+  purchasePrice: number;
+  status?: string;
+  checkedIn?: boolean;
+  checkedInAt?: string;
+}
+
+// ============================================================================
+// Events
+// ============================================================================
+
+export interface Event {
+  eventID: number;
+  id?: number;
+  name: string;
+  title?: string;
+  slug?: string;
+  description?: string;
+  date: string;
+  startDateTime?: string;
+  endDateTime?: string;
+  doorsOpenTime?: string;
+  timezone?: string;
+  venueId?: number;
+  venueName?: string;
+  venueAddress?: string;
+  location?: string;
+  imageUrl?: string;
+  imageURL?: string;
+  status?: string;
+  isPublished?: boolean;
+  isCancelled?: boolean;
+  availableTickets?: AvailableTicket[];
+  ticketsAvailable?: number;
+  ticketsSold?: number;
+  minPrice?: number;
+  maxPrice?: number;
+  ctaText?: string;
+  ctaState?: 'available' | 'sold_out' | 'coming_soon' | 'ended';
+  showPerformers?: boolean;
+  eventSeriesId?: number;
+  seriesInstanceNumber?: number;
+  // ── Passthrough seams (events convergence) ─────────────────────────────
+  // Carried verbatim from the wire by parseEvent so view-shape projections
+  // (utils/event-transform.js, public-calendar-flow/transform.ts) compose the
+  // canonical instead of reading wire fields directly. The object-valued
+  // fields are intentionally raw (see composition note in
+  // api/transformers/event.ts) — their consumers own the wire variance.
+  timeZone?: string;
+  eventSummary?: string;
+  password?: string;
+  hasPassword?: boolean;
+  disclaimer?: string;
+  ticketType?: number;
+  eventTicketingType?: number;
+  ageRestriction?: number;
+  displayAgeRestriction?: boolean;
+  displayStartTime?: boolean;
+  displayEndTime?: boolean;
+  displayDoorsTime?: boolean;
+  collectionId?: number;
+  ticketsRemaining?: number;
+  ticketsTotal?: number;
+  hasHiddenTickets?: boolean;
+  stage?: { name?: string } | null;
+  stageName?: string;
+  // Widget-filter dimensions on the public month feeds (saved-widget engine):
+  // stage/category/performer/collection data the embed adapts onto the SC
+  // FilterableEvent view (lib/widget-filters.js).
+  stageId?: number;
+  eventCategoryTypes?: number[] | null;
+  publicPerformers?: Array<{
+    id?: number;
+    displayName?: string;
+    image?: string;
+  }> | null;
+  collectionIds?: number[] | null;
+  venue?: Record<string, any>;
+  performers?: Record<string, any>[];
+  faqs?: Record<string, any>[];
+  showtimes?: Record<string, any>[];
+  purchasedTickets?: Record<string, any>[];
+}
+
+export interface AvailableTicket {
+  id: number;
+  name: string;
+  description?: string;
+  price: number;
+  quantity: number;
+  quantitySold?: number;
+  quantityAvailable?: number;
+  minPerOrder?: number;
+  maxPerOrder?: number;
+  saleStartDate?: string;
+  saleEndDate?: string;
+  isHidden?: boolean;
+  revealWithPromoCode?: boolean;
+  ticketType?: number; // 0 = GA, 1 = assigned
+  sectionId?: number;
+  sortOrder?: number;
+}
+
+export interface EventPerformersResponse {
+  performers: Performer[];
+  showPerformers: boolean;
+}
+
+export interface Performer {
+  id: number;
+  displayName: string;
+  avatar?: string;
+  order?: number;
+}
+
+// ============================================================================
+// Venues
+// ============================================================================
+
+export interface Venue {
+  id: number;
+  name: string;
+  slug?: string;
+  address?: string;
+  googleLocationNameCache?: string;
+  city?: string;
+  state?: string;
+  zipCode?: string;
+  country?: string;
+  timezone?: string;
+  logoUrl?: string;
+  serviceFeePercentage?: number;
+  serviceFeeCents?: number;
+  taxPercentage?: number;
+  organizationId?: number;
+}
+
+// ============================================================================
+// Series
+// ============================================================================
+
+export interface SeriesOccurrence {
+  eventId: EventId;
+  date: string;
+  startDateTime: string;
+  endDateTime?: string;
+  instanceNumber: number;
+  status: string;
+  ticketsAvailable?: number;
+  ctaState?: string;
+}
+
+export interface SeriesOccurrencesResponse {
+  seriesId: SeriesId;
+  occurrences: SeriesOccurrence[];
+}
+
+// ============================================================================
+// Series Page
+// ============================================================================
+
+export interface SeriesPageData {
+  id: number;
+  title: string;
+  description: string;
+  eventSummary?: string;
+  image?: string;
+  timeZone: string;
+  venue: {
+    id: number;
+    name: string;
+    location?: string;
+    googleLocationNameCache?: string;
+    faq?: Array<{ question: string; answer: string }> | string;
+    disclaimer?: string;
+  };
+  performers: Array<{
+    displayName: string;
+    firstName?: string;
+    lastName?: string;
+    profileImage?: string;
+  }>;
+  occurrences: Array<{
+    id: number;
+    slug: string;
+    startDateTime: string;
+    endDateTime: string;
+    ctaState: {
+      text: string;
+      disabled: boolean;
+      reason?: string;
+    };
+  }>;
+}
+
+// ============================================================================
+// Entity resolution (type-agnostic public id → concrete entity)
+// ============================================================================
+
+/**
+ * Response shape of `/api/v2/public/resolve/{id}`. The embed deep-link is
+ * type-agnostic (`#{id}-{slug}`), so the backend resolves which kind of entity
+ * the id points at; `data` is the corresponding event / series / collection
+ * payload (same shape the dedicated fetchers return for that type).
+ */
+export interface ResolvedEntity {
+  type: 'event' | 'series' | 'collection';
+  id: string | number;
+  title?: string;
+  data: any;
+}
+
+// ============================================================================
+// Public Collection
+// ============================================================================
+
+export interface PublicCollectionData {
+  id: number;
+  collectionTitle: string;
+  summary?: string;
+  description?: string;
+  coverImage?: string;
+  events: Array<{
+    id: number;
+    title: string;
+    slug?: string;
+    startDateTime?: string;
+    endDateTime?: string;
+    image?: string;
+    status?: string;
+    venue?: { name: string };
+    minPrice?: number;
+  }>;
+  // Password-gate variant: a protected collection responds with a gate signal
+  // instead of the collection body (either `passwordRequired: true` or an
+  // `error.code === 'PASSWORD_REQUIRED'`). Modelled here as optional wire
+  // fields so the view can read them without an `as any` escape.
+  passwordRequired?: boolean;
+  error?: { code?: string };
+}
+
+// ============================================================================
+// API Configuration
+// ============================================================================
+
+export interface ApiConfig {
+  baseUrl?: string;
+  timeout?: number;
+  /** Number of additional attempts after the first try (default: 2 = 3 total tries). */
+  retries?: number;
+  /** Base delay before the first retry; doubles each attempt (default: 500ms). */
+  retryDelay?: number;
+  onError?: (_error: Error) => void;
+}
+
+// ============================================================================
+// Generic API Response
+// ============================================================================
+
+export interface ApiResponse<T> {
+  success: boolean;
+  data?: T;
+  error?: string;
+  statusCode?: number;
+}