@getspot/spot-widget 2.0.0 → 2.0.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @getspot/spot-widget
 
+## 2.0.1
+
+### Patch Changes
+
+- ccc78eb: Fix npm docs generation for interfaces and types
+
 ## 2.0.0
 
 ### Major Changes

package/README.md

@@ -327,35 +327,222 @@ Use the production environment for live applications:
 }
 ```
 
+
+
 ## API Reference
 
 This package exports the following types and interfaces:
 
 ### Interfaces
 
-- [ApiConfig](docs/interfaces/ApiConfig.md)
-- [ApiError](docs/interfaces/ApiError.md)
-- [ApiResponse](docs/interfaces/ApiResponse.md)
-- [BatchQuoteItem](docs/interfaces/BatchQuoteItem.md)
-- [BatchQuoteRequest](docs/interfaces/BatchQuoteRequest.md)
-- [Callbacks](docs/interfaces/Callbacks.md)
-- [CartInfo](docs/interfaces/CartInfo.md)
-- [Communication](docs/interfaces/Communication.md)
-- [ElementOptions](docs/interfaces/ElementOptions.md)
-- [PayoutScheduleItem](docs/interfaces/PayoutScheduleItem.md)
-- [QualifyingReason](docs/interfaces/QualifyingReason.md)
-- [Quote](docs/interfaces/Quote.md)
-- [QuoteItem](docs/interfaces/QuoteItem.md)
-- [QuoteMetadata](docs/interfaces/QuoteMetadata.md)
-- [SelectionData](docs/interfaces/SelectionData.md)
-- [SpotWidgetOptions](docs/interfaces/SpotWidgetOptions.md)
-- [Theme](docs/interfaces/Theme.md)
+#### ApiConfig
+
+```typescript
+export interface ApiConfig {
+  environment: 'sandbox' | 'production' | 'local';
+  partnerId: string;
+  customEndpoint?: string;
+}
+```
+
+#### QuoteMetadata
+
+```typescript
+export interface QuoteMetadata {
+  segment?: string;
+  operator?: string;
+  channel?: string;
+  consumerId?: string;
+}
+```
+
+#### CartInfo
+
+```typescript
+export interface CartInfo {
+  cartId: string;
+  cartName: string;
+  currencyCode: 'USD' | 'CAD' | 'AUD';
+  metadata?: QuoteMetadata;
+  isPartialPayment?: boolean;
+}
+```
+
+#### QuoteItem
+
+```typescript
+export interface QuoteItem {
+  productPrice: number;
+  productType: 'Pass' | 'Trip' | 'Registration';
+  productDuration: 'Daily' | 'Seasonal' | 'Trip' | 'Event';
+  productId: string;
+  cartId: string;
+  cartName: string;
+  productName: string;
+  participantDescription?: string;
+  eventType: string;
+  currencyCode: 'USD' | 'CAD' | 'AUD';
+  startDate: string;
+  endDate: string;
+  partnerRiskEnd?: Date;
+  metadata?: QuoteMetadata;
+  isPartialPayment?: boolean;
+  hostCountry?: string;
+  hostCountryState?: string;
+  destinations?: string[];
+  dob?: string;
+}
+```
+
+#### BatchQuoteRequest
+
+```typescript
+export interface BatchQuoteRequest {
+  cartInfo: CartInfo;
+  items: BatchQuoteItem[];
+}
+```
+
+#### QualifyingReason
+
+```typescript
+export interface QualifyingReason {
+  rank: number;
+  name?: string;
+  benefitType?: {
+    name: string;
+  };
+}
+```
+
+#### PayoutScheduleItem
+
+```typescript
+export interface PayoutScheduleItem {
+  text: string;
+  percent: string | number;
+  amount: number;
+}
+```
+
+#### Communication
+
+```typescript
+export interface Communication {
+  name: string;
+  description: string;
+  bulletPoints: string[];
+  yesOptionText: string;
+  noOptionText: string;
+  legalDisclaimer: string;
+  termsAndConditionsUrl: string;
+  paymentTerms?: string;
+}
+```
+
+#### Quote
+
+```typescript
+export interface Quote {
+  id: string;
+  cartItemId?: string;
+  spotPrice: number;
+  currencyCode: string;
+  communication: Communication;
+  payoutSchedule: PayoutScheduleItem[];
+  qualifyingReasons?: QualifyingReason[];
+  coveredItems?: string[];
+  originalQuotes?: Quote[];
+}
+```
+
+#### ApiResponse
+
+```typescript
+export interface ApiResponse {
+  status: 'QUOTE_AVAILABLE' | 'QUOTES_AVAILABLE' | 'NO_MATCHING_QUOTE';
+  data?: Quote;
+  quotes?: Quote[];
+  totalSpotPrice?: number;
+  spotPrice?: number;
+  currencyCode?: string;
+  communication?: Communication;
+  payoutSchedule?: PayoutScheduleItem[];
+  coveredItems?: string[];
+}
+```
+
+#### SelectionData
+
+```typescript
+export interface SelectionData {
+  status: 'QUOTE_ACCEPTED' | 'QUOTE_DECLINED';
+  spotPrice?: number;
+  quoteId?: string;
+  selection?: string;
+  batchQuoteDetails?: Array<{
+    quoteId: string;
+    productPrice: number;
+    cartItemId: string;
+  }>;
+}
+```
+
+#### Callbacks
+
+```typescript
+export interface Callbacks {
+  onOptIn?: (data: SelectionData) => void;
+  onOptOut?: (data: SelectionData) => void;
+  onQuoteRetrieved?: (quote: Quote) => void;
+  onError?: (error: { message: string; status?: number; responseBody?: any }) => void;
+  noMatchingQuote?: (data: { status: string; data: QuoteRequestData }) => void;
+}
+```
+
+#### Theme
+
+```typescript
+export interface Theme {
+  [key: string]: string;
+}
+```
+
+#### SpotWidgetOptions
+
+```typescript
+export interface SpotWidgetOptions {
+  location?: string | HTMLElement;
+  showTable?: boolean;
+  optInSelected?: boolean;
+  apiConfig: ApiConfig;
+  quoteRequestData: QuoteRequestData;
+  callbacks?: Callbacks;
+  theme?: Theme;
+  isPartialPayment?: boolean;
+}
+```
+
+#### ElementOptions
+
+```typescript
+export interface ElementOptions {
+  text?: string;
+  className?: string;
+  parent?: HTMLElement;
+  innerHTML?: string;
+  href?: string;
+  target?: string;
+}
+```
 
 ### Type Aliases
 
-- [QuoteRequestData](docs/type-aliases/QuoteRequestData.md)
+#### QuoteRequestData
 
-> **📚 Full API Documentation**: See [docs/](docs/) for detailed documentation of all types and interfaces.
+```typescript
+export type QuoteRequestData = QuoteItem | BatchQuoteRequest;
+```
 
 ## Framework Integration
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@getspot/spot-widget",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "publishConfig": {
     "access": "public"
   },