@getmicdrop/venue-calendar 3.3.0 → 3.3.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,289 +1,289 @@
1
- /**
2
- * API Types for MicDrop Public Checkout API
3
- *
4
- * These types define the shape of API requests and responses
5
- * for the public checkout flow (no authentication required).
6
- */
7
-
8
- // ============================================================================
9
- // Payment & Orders
10
- // ============================================================================
11
-
12
- export interface PaymentIntentRequest {
13
- IP?: string;
14
- productQuantities: Record<string | number, number>;
15
- }
16
-
17
- export interface PaymentIntentResponse {
18
- client_secret: string;
19
- amount: number;
20
- amount_total: number;
21
- tax_amount_exclusive?: number;
22
- service_fee?: number;
23
- discount?: number;
24
- gift_card_amount?: number;
25
- gift_card_code?: string;
26
- stripe_publishable_key?: string;
27
- }
28
-
29
- export interface CompleteReservationResponse {
30
- success: boolean;
31
- message?: string;
32
- error?: string;
33
- }
34
-
35
- export interface CancelReservationResponse {
36
- success: boolean;
37
- message?: string;
38
- error?: string;
39
- }
40
-
41
- export interface CreateOrderRequest {
42
- eventId: string | number;
43
- promoCode?: string;
44
- }
45
-
46
- export interface CreateOrderResponse {
47
- uuid: string;
48
- }
49
-
50
- export interface ValidatePaymentRequest {
51
- id: string;
52
- paymentIntentId: string;
53
- tickets: Record<string | number, number>;
54
- firstName: string;
55
- lastName: string;
56
- email: string;
57
- paymentMethod: string;
58
- mailingList?: boolean;
59
- saleType?: string;
60
- attendees?: AttendeeInfo[];
61
- }
62
-
63
- export interface AttendeeInfo {
64
- ticketId: string | number;
65
- firstName: string;
66
- lastName: string;
67
- email: string;
68
- }
69
-
70
- export interface ValidatePaymentResponse {
71
- success: boolean;
72
- status: string;
73
- orderUUID?: string;
74
- error?: string;
75
- }
76
-
77
- // ============================================================================
78
- // Session Management
79
- // ============================================================================
80
-
81
- export interface ExtendSessionRequest {
82
- orderUuid: string;
83
- }
84
-
85
- export interface ExtendSessionResponse {
86
- success: boolean;
87
- newExpiryTime?: string;
88
- remainingExtensions?: number;
89
- error?: string;
90
- }
91
-
92
- export interface SessionStatus {
93
- expiresAt?: string;
94
- extensionCount?: number;
95
- remainingExtensions?: number;
96
- canExtend?: boolean;
97
- reservationCount?: number;
98
- error?: string;
99
- }
100
-
101
- // ============================================================================
102
- // Promo Codes
103
- // ============================================================================
104
-
105
- export interface PromoValidationResponse {
106
- valid: boolean;
107
- revealHiddenTickets?: boolean;
108
- revealTicketIds?: number[];
109
- provideDiscount?: boolean;
110
- discountType?: 'percentage' | 'fixed';
111
- amount?: number;
112
- code?: string;
113
- error?: string;
114
- }
115
-
116
- export interface HasPromoCodesResponse {
117
- hasPromoCodes: boolean;
118
- }
119
-
120
- // ============================================================================
121
- // Orders
122
- // ============================================================================
123
-
124
- export interface Order {
125
- uuid: string;
126
- id?: number;
127
- customerEmail: string;
128
- customerFirstName?: string;
129
- customerLastName?: string;
130
- status: string;
131
- totalAmount: number;
132
- subtotal?: number;
133
- serviceFeesAmount: number;
134
- taxAmount: number;
135
- discount?: number;
136
- paymentIntentId?: string;
137
- paymentMethod?: string;
138
- purchasedTickets: PurchasedTicket[];
139
- createdAt?: string;
140
- updatedAt?: string;
141
- }
142
-
143
- export interface PurchasedTicket {
144
- uuid: string;
145
- id?: number;
146
- ticketNumber?: string;
147
- orderId?: string | number;
148
- attendeeFirstName?: string;
149
- attendeeLastName?: string;
150
- attendeeEmail?: string;
151
- ticketName: string;
152
- ticketTypeId?: number;
153
- purchasePrice: number;
154
- status?: string;
155
- checkedIn?: boolean;
156
- checkedInAt?: string;
157
- }
158
-
159
- // ============================================================================
160
- // Events
161
- // ============================================================================
162
-
163
- export interface Event {
164
- eventID: number;
165
- id?: number;
166
- name: string;
167
- title?: string;
168
- slug?: string;
169
- description?: string;
170
- date: string;
171
- startDateTime?: string;
172
- endDateTime?: string;
173
- doorsOpenTime?: string;
174
- timezone?: string;
175
- venueId?: number;
176
- venueName?: string;
177
- venueAddress?: string;
178
- location?: string;
179
- imageUrl?: string;
180
- imageURL?: string;
181
- status?: string;
182
- isPublished?: boolean;
183
- isCancelled?: boolean;
184
- availableTickets?: AvailableTicket[];
185
- ticketsAvailable?: number;
186
- ticketsSold?: number;
187
- minPrice?: number;
188
- maxPrice?: number;
189
- ctaText?: string;
190
- ctaState?: 'available' | 'sold_out' | 'coming_soon' | 'ended';
191
- showPerformers?: boolean;
192
- eventSeriesId?: number;
193
- seriesInstanceNumber?: number;
194
- }
195
-
196
- export interface AvailableTicket {
197
- id: number;
198
- name: string;
199
- description?: string;
200
- price: number;
201
- quantity: number;
202
- quantitySold?: number;
203
- quantityAvailable?: number;
204
- minPerOrder?: number;
205
- maxPerOrder?: number;
206
- saleStartDate?: string;
207
- saleEndDate?: string;
208
- isHidden?: boolean;
209
- revealWithPromoCode?: boolean;
210
- ticketType?: number; // 0 = GA, 1 = assigned
211
- sectionId?: number;
212
- sortOrder?: number;
213
- }
214
-
215
- export interface EventPerformersResponse {
216
- performers: Performer[];
217
- showPerformers: boolean;
218
- }
219
-
220
- export interface Performer {
221
- id: number;
222
- stageName: string;
223
- displayName?: string;
224
- avatar?: string;
225
- order?: number;
226
- }
227
-
228
- // ============================================================================
229
- // Venues
230
- // ============================================================================
231
-
232
- export interface Venue {
233
- id: number;
234
- name: string;
235
- slug?: string;
236
- address?: string;
237
- googleLocationNameCache?: string;
238
- city?: string;
239
- state?: string;
240
- zipCode?: string;
241
- country?: string;
242
- timezone?: string;
243
- logoUrl?: string;
244
- serviceFeePercentage?: number;
245
- serviceFeeCents?: number;
246
- taxPercentage?: number;
247
- organizationId?: number;
248
- }
249
-
250
- // ============================================================================
251
- // Series
252
- // ============================================================================
253
-
254
- export interface SeriesOccurrence {
255
- eventId: number;
256
- date: string;
257
- startDateTime: string;
258
- endDateTime?: string;
259
- instanceNumber: number;
260
- status: string;
261
- ticketsAvailable?: number;
262
- ctaState?: string;
263
- }
264
-
265
- export interface SeriesOccurrencesResponse {
266
- seriesId: number;
267
- occurrences: SeriesOccurrence[];
268
- }
269
-
270
- // ============================================================================
271
- // API Configuration
272
- // ============================================================================
273
-
274
- export interface ApiConfig {
275
- baseUrl?: string;
276
- timeout?: number;
277
- onError?: (error: Error) => void;
278
- }
279
-
280
- // ============================================================================
281
- // Generic API Response
282
- // ============================================================================
283
-
284
- export interface ApiResponse<T> {
285
- success: boolean;
286
- data?: T;
287
- error?: string;
288
- statusCode?: number;
289
- }
1
+ /**
2
+ * API Types for MicDrop Public Checkout API
3
+ *
4
+ * These types define the shape of API requests and responses
5
+ * for the public checkout flow (no authentication required).
6
+ */
7
+
8
+ // ============================================================================
9
+ // Payment & Orders
10
+ // ============================================================================
11
+
12
+ export interface PaymentIntentRequest {
13
+ IP?: string;
14
+ productQuantities: Record<string | number, number>;
15
+ }
16
+
17
+ export interface PaymentIntentResponse {
18
+ client_secret: string;
19
+ amount: number;
20
+ amount_total: number;
21
+ tax_amount_exclusive?: number;
22
+ service_fee?: number;
23
+ discount?: number;
24
+ gift_card_amount?: number;
25
+ gift_card_code?: string;
26
+ stripe_publishable_key?: string;
27
+ }
28
+
29
+ export interface CompleteReservationResponse {
30
+ success: boolean;
31
+ message?: string;
32
+ error?: string;
33
+ }
34
+
35
+ export interface CancelReservationResponse {
36
+ success: boolean;
37
+ message?: string;
38
+ error?: string;
39
+ }
40
+
41
+ export interface CreateOrderRequest {
42
+ eventId: string | number;
43
+ promoCode?: string;
44
+ }
45
+
46
+ export interface CreateOrderResponse {
47
+ uuid: string;
48
+ }
49
+
50
+ export interface ValidatePaymentRequest {
51
+ id: string;
52
+ paymentIntentId: string;
53
+ tickets: Record<string | number, number>;
54
+ firstName: string;
55
+ lastName: string;
56
+ email: string;
57
+ paymentMethod: string;
58
+ mailingList?: boolean;
59
+ saleType?: string;
60
+ attendees?: AttendeeInfo[];
61
+ }
62
+
63
+ export interface AttendeeInfo {
64
+ ticketId: string | number;
65
+ firstName: string;
66
+ lastName: string;
67
+ email: string;
68
+ }
69
+
70
+ export interface ValidatePaymentResponse {
71
+ success: boolean;
72
+ status: string;
73
+ orderUUID?: string;
74
+ error?: string;
75
+ }
76
+
77
+ // ============================================================================
78
+ // Session Management
79
+ // ============================================================================
80
+
81
+ export interface ExtendSessionRequest {
82
+ orderUuid: string;
83
+ }
84
+
85
+ export interface ExtendSessionResponse {
86
+ success: boolean;
87
+ newExpiryTime?: string;
88
+ remainingExtensions?: number;
89
+ error?: string;
90
+ }
91
+
92
+ export interface SessionStatus {
93
+ expiresAt?: string;
94
+ extensionCount?: number;
95
+ remainingExtensions?: number;
96
+ canExtend?: boolean;
97
+ reservationCount?: number;
98
+ error?: string;
99
+ }
100
+
101
+ // ============================================================================
102
+ // Promo Codes
103
+ // ============================================================================
104
+
105
+ export interface PromoValidationResponse {
106
+ valid: boolean;
107
+ revealHiddenTickets?: boolean;
108
+ revealTicketIds?: number[];
109
+ provideDiscount?: boolean;
110
+ discountType?: 'percentage' | 'fixed';
111
+ amount?: number;
112
+ code?: string;
113
+ error?: string;
114
+ }
115
+
116
+ export interface HasPromoCodesResponse {
117
+ hasPromoCodes: boolean;
118
+ }
119
+
120
+ // ============================================================================
121
+ // Orders
122
+ // ============================================================================
123
+
124
+ export interface Order {
125
+ uuid: string;
126
+ id?: number;
127
+ customerEmail: string;
128
+ customerFirstName?: string;
129
+ customerLastName?: string;
130
+ status: string;
131
+ totalAmount: number;
132
+ subtotal?: number;
133
+ serviceFeesAmount: number;
134
+ taxAmount: number;
135
+ discount?: number;
136
+ paymentIntentId?: string;
137
+ paymentMethod?: string;
138
+ purchasedTickets: PurchasedTicket[];
139
+ createdAt?: string;
140
+ updatedAt?: string;
141
+ }
142
+
143
+ export interface PurchasedTicket {
144
+ uuid: string;
145
+ id?: number;
146
+ ticketNumber?: string;
147
+ orderId?: string | number;
148
+ attendeeFirstName?: string;
149
+ attendeeLastName?: string;
150
+ attendeeEmail?: string;
151
+ ticketName: string;
152
+ ticketTypeId?: number;
153
+ purchasePrice: number;
154
+ status?: string;
155
+ checkedIn?: boolean;
156
+ checkedInAt?: string;
157
+ }
158
+
159
+ // ============================================================================
160
+ // Events
161
+ // ============================================================================
162
+
163
+ export interface Event {
164
+ eventID: number;
165
+ id?: number;
166
+ name: string;
167
+ title?: string;
168
+ slug?: string;
169
+ description?: string;
170
+ date: string;
171
+ startDateTime?: string;
172
+ endDateTime?: string;
173
+ doorsOpenTime?: string;
174
+ timezone?: string;
175
+ venueId?: number;
176
+ venueName?: string;
177
+ venueAddress?: string;
178
+ location?: string;
179
+ imageUrl?: string;
180
+ imageURL?: string;
181
+ status?: string;
182
+ isPublished?: boolean;
183
+ isCancelled?: boolean;
184
+ availableTickets?: AvailableTicket[];
185
+ ticketsAvailable?: number;
186
+ ticketsSold?: number;
187
+ minPrice?: number;
188
+ maxPrice?: number;
189
+ ctaText?: string;
190
+ ctaState?: 'available' | 'sold_out' | 'coming_soon' | 'ended';
191
+ showPerformers?: boolean;
192
+ eventSeriesId?: number;
193
+ seriesInstanceNumber?: number;
194
+ }
195
+
196
+ export interface AvailableTicket {
197
+ id: number;
198
+ name: string;
199
+ description?: string;
200
+ price: number;
201
+ quantity: number;
202
+ quantitySold?: number;
203
+ quantityAvailable?: number;
204
+ minPerOrder?: number;
205
+ maxPerOrder?: number;
206
+ saleStartDate?: string;
207
+ saleEndDate?: string;
208
+ isHidden?: boolean;
209
+ revealWithPromoCode?: boolean;
210
+ ticketType?: number; // 0 = GA, 1 = assigned
211
+ sectionId?: number;
212
+ sortOrder?: number;
213
+ }
214
+
215
+ export interface EventPerformersResponse {
216
+ performers: Performer[];
217
+ showPerformers: boolean;
218
+ }
219
+
220
+ export interface Performer {
221
+ id: number;
222
+ stageName: string;
223
+ displayName?: string;
224
+ avatar?: string;
225
+ order?: number;
226
+ }
227
+
228
+ // ============================================================================
229
+ // Venues
230
+ // ============================================================================
231
+
232
+ export interface Venue {
233
+ id: number;
234
+ name: string;
235
+ slug?: string;
236
+ address?: string;
237
+ googleLocationNameCache?: string;
238
+ city?: string;
239
+ state?: string;
240
+ zipCode?: string;
241
+ country?: string;
242
+ timezone?: string;
243
+ logoUrl?: string;
244
+ serviceFeePercentage?: number;
245
+ serviceFeeCents?: number;
246
+ taxPercentage?: number;
247
+ organizationId?: number;
248
+ }
249
+
250
+ // ============================================================================
251
+ // Series
252
+ // ============================================================================
253
+
254
+ export interface SeriesOccurrence {
255
+ eventId: number;
256
+ date: string;
257
+ startDateTime: string;
258
+ endDateTime?: string;
259
+ instanceNumber: number;
260
+ status: string;
261
+ ticketsAvailable?: number;
262
+ ctaState?: string;
263
+ }
264
+
265
+ export interface SeriesOccurrencesResponse {
266
+ seriesId: number;
267
+ occurrences: SeriesOccurrence[];
268
+ }
269
+
270
+ // ============================================================================
271
+ // API Configuration
272
+ // ============================================================================
273
+
274
+ export interface ApiConfig {
275
+ baseUrl?: string;
276
+ timeout?: number;
277
+ onError?: (error: Error) => void;
278
+ }
279
+
280
+ // ============================================================================
281
+ // Generic API Response
282
+ // ============================================================================
283
+
284
+ export interface ApiResponse<T> {
285
+ success: boolean;
286
+ data?: T;
287
+ error?: string;
288
+ statusCode?: number;
289
+ }
@@ -0,0 +1,33 @@
1
+ import { Venue } from './types.js';
2
+ /**
3
+ * Get venue details (public, no auth required)
4
+ *
5
+ * Fetches venue information including service fees and taxes
6
+ * needed for checkout calculations.
7
+ *
8
+ * @param venueId - The venue ID
9
+ * @returns Venue details or null on error
10
+ */
11
+ export declare function getVenue(venueId: string | number): Promise<Venue | null>;
12
+ /**
13
+ * Get venue service fee configuration
14
+ *
15
+ * Returns just the fee-related fields for checkout calculations.
16
+ *
17
+ * @param venueId - The venue ID
18
+ * @returns Fee configuration or null on error
19
+ */
20
+ export declare function getVenueFees(venueId: string | number): Promise<{
21
+ serviceFeePercentage: number;
22
+ serviceFeeCents: number;
23
+ taxPercentage: number;
24
+ } | null>;
25
+ /**
26
+ * Get venue by slug
27
+ *
28
+ * Fetches venue using its URL-friendly slug.
29
+ *
30
+ * @param slug - The venue slug
31
+ * @returns Venue details or null on error
32
+ */
33
+ export declare function getVenueBySlug(slug: string): Promise<Venue | null>;