@getmicdrop/venue-calendar 3.4.7 → 3.5.0

package/dist/seo/types.d.ts

@@ -0,0 +1,135 @@
+/**
+ * Input/output TypeScript interfaces for all JSON-LD builders.
+ *
+ * These describe the data shape each builder expects, NOT the raw API response
+ * shape (those exist in `api/types.ts`). The mapping from API types to these
+ * builder input types happens at the call site.
+ */
+
+// ---------------------------------------------------------------------------
+// Event builder inputs
+// ---------------------------------------------------------------------------
+
+/** What buildEventJsonLd expects for an event. */
+export interface EventJsonLdInput {
+  name: string;
+  startDateTime: string;
+  endDateTime?: string;
+  status?: string;
+  description?: string;
+  eventSummary?: string;
+  image?: string;
+  coverImage?: string;
+  ShowImage?: string;
+  availableTickets?: EventTicketInput[];
+  performers?: EventPerformerInput[];
+}
+
+export interface EventTicketInput {
+  visibility?: number;
+  salesChannel?: number;
+  price?: number | string;
+  remainingCapacity?: number;
+  quantityRemaining?: number;
+  quantity?: number;
+  soldOut?: boolean;
+  salesBegin?: string;
+  salesStart?: string;
+  saleBegin?: string;
+  onSaleStart?: string;
+  salesEnd?: string;
+  saleEnd?: string;
+  onSaleEnd?: string;
+}
+
+export interface EventPerformerInput {
+  acceptedState?: number;
+  shouldBeHidden?: boolean;
+  RosterPerformer?: {
+    User?: {
+      performerProfile?: {
+        firstName?: string;
+        lastName?: string;
+        displayName?: string;
+      };
+    };
+  };
+}
+
+export interface VenueInput {
+  name: string;
+  address?: string;
+  googleLocationNameCache?: string;
+}
+
+export interface OrganizerInput {
+  name: string;
+  url?: string;
+}
+
+// ---------------------------------------------------------------------------
+// Series builder inputs (Plan 02)
+// ---------------------------------------------------------------------------
+
+/** What buildSeriesJsonLd expects. */
+export interface SeriesJsonLdInput {
+  title: string;
+  description?: string;
+  eventSummary?: string;
+  image?: string;
+  timeZone: string;
+  venue: {
+    name: string;
+    googleLocationNameCache?: string;
+  };
+  performers?: Array<{ displayName: string }>;
+  occurrences: Array<{
+    id: number;
+    title: string;
+    slug: string;
+    startDateTime: string;
+    endDateTime?: string;
+    status?: string;
+    tickets?: Array<{ name: string; price: number; status: string }>;
+  }>;
+}
+
+// ---------------------------------------------------------------------------
+// Collection builder inputs (Plan 02)
+// ---------------------------------------------------------------------------
+
+// ---------------------------------------------------------------------------
+// HostSeoController options (Phase 6)
+// ---------------------------------------------------------------------------
+
+/** Options for HostSeoController constructor */
+export interface HostSeoControllerOptions {
+  /** Venue name for JSON-LD location and page title */
+  venueName: string;
+  /** Venue address string (from googleLocationNameCache or address field) */
+  venueAddress?: string;
+  /** Venue timezone (IANA), defaults to 'America/Los_Angeles' */
+  venueTimeZone?: string;
+  /** Base URL for canonical links, e.g., "https://comedy-club.com/shows" (defaults to current page URL without query params) */
+  baseUrl?: string;
+}
+
+/** What buildCollectionJsonLd expects. */
+export interface CollectionJsonLdInput {
+  collectionTitle: string;
+  description?: string;
+  summary?: string;
+  coverImage?: string;
+  dateRange?: { startDate: string; endDate: string } | null;
+  events: Array<{
+    id: number;
+    title: string;
+    slug?: string;
+    startDateTime?: string;
+    endDateTime?: string;
+    image?: string;
+    status?: string;
+    venueName?: string;
+    venueId?: number;
+  }>;
+}