@getspot/spot-widget 2.0.0 → 2.1.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @getspot/spot-widget
 
+## 2.1.0
+
+### Minor Changes
+
+- bdef1ee: logoposition flag and other enhancements
+
+## 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,227 @@ 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;
+  logoPosition?: "bottom-right" | "top-right";
+  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/dist/index.d.ts

@@ -8,18 +8,22 @@ declare class SpotWidget {
     private errorEl?;
     private quote?;
     private _onResize;
+    private _resizeObserver?;
     constructor(options?: Partial<SpotWidgetOptions>);
     private _init;
     private _renderWidget;
     private _updateLayout;
+    private _shouldUseDesktopLayout;
+    private _setupResizeObserver;
+    private _resizeTimeout?;
     private _setupOptionListeners;
     showSelectionError(): void;
     hideSelectionError(): void;
     validateSelection(): boolean;
-    updateQuote(newQuoteRequestData: SpotWidgetOptions['quoteRequestData']): Promise<boolean>;
+    updateQuote(newQuoteRequestData: SpotWidgetOptions["quoteRequestData"]): Promise<boolean>;
     getSelection(): SelectionData | null;
     destroy(): void;
 }
 export default SpotWidget;
-export type { SpotWidgetOptions, SelectionData, Quote, ApiConfig, QuoteRequestData, QuoteItem, BatchQuoteItem, BatchQuoteRequest, CartInfo, QualifyingReason, PayoutScheduleItem, Communication, ApiResponse, ApiError, ElementOptions, QuoteMetadata, Callbacks, Theme } from './types.js';
+export type { SpotWidgetOptions, SelectionData, Quote, ApiConfig, QuoteRequestData, QuoteItem, BatchQuoteItem, BatchQuoteRequest, CartInfo, QualifyingReason, PayoutScheduleItem, Communication, ApiResponse, ApiError, ElementOptions, QuoteMetadata, Callbacks, Theme, } from "./types.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,EAAE,iBAAiB,EAAS,aAAa,EAAqB,MAAM,YAAY,CAAC;AAkB7F,cAAM,UAAU;IACd,OAAO,CAAC,OAAO,CAAoB;IACnC,OAAO,CAAC,IAAI,CAAc;IAC1B,OAAO,CAAC,gBAAgB,CAAgB;IACxC,OAAO,CAAC,SAAS,CAAC,CAAc;IAChC,OAAO,CAAC,cAAc,CAAC,CAAc;IACrC,OAAO,CAAC,OAAO,CAAC,CAAc;IAC9B,OAAO,CAAC,KAAK,CAAC,CAAQ;IACtB,OAAO,CAAC,SAAS,CAAa;gBAElB,OAAO,GAAE,OAAO,CAAC,iBAAiB,CAAM;YAqBtC,KAAK;IAgFnB,OAAO,CAAC,aAAa;IAiDrB,OAAO,CAAC,aAAa;IAUrB,OAAO,CAAC,qBAAqB;IA6F7B,kBAAkB,IAAI,IAAI;IAgB1B,kBAAkB,IAAI,IAAI;IAM1B,iBAAiB,IAAI,OAAO;IAgBtB,WAAW,CAAC,mBAAmB,EAAE,iBAAiB,CAAC,kBAAkB,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAqE/F,YAAY,IAAI,aAAa,GAAG,IAAI;IAiCpC,OAAO,IAAI,IAAI;CAMhB;AAED,eAAe,UAAU,CAAC;AAC1B,YAAY,EACV,iBAAiB,EACjB,aAAa,EACb,KAAK,EACL,SAAS,EACT,gBAAgB,EAChB,SAAS,EACT,cAAc,EACd,iBAAiB,EACjB,QAAQ,EACR,gBAAgB,EAChB,kBAAkB,EAClB,aAAa,EACb,WAAW,EACX,QAAQ,EACR,cAAc,EACd,aAAa,EACb,SAAS,EACT,KAAK,EACN,MAAM,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,EACV,iBAAiB,EAEjB,aAAa,EAEd,MAAM,YAAY,CAAC;AAkBpB,cAAM,UAAU;IACd,OAAO,CAAC,OAAO,CAAoB;IACnC,OAAO,CAAC,IAAI,CAAc;IAC1B,OAAO,CAAC,gBAAgB,CAAgB;IACxC,OAAO,CAAC,SAAS,CAAC,CAAc;IAChC,OAAO,CAAC,cAAc,CAAC,CAAc;IACrC,OAAO,CAAC,OAAO,CAAC,CAAc;IAC9B,OAAO,CAAC,KAAK,CAAC,CAAQ;IACtB,OAAO,CAAC,SAAS,CAAa;IAC9B,OAAO,CAAC,eAAe,CAAC,CAAiB;gBAE7B,OAAO,GAAE,OAAO,CAAC,iBAAiB,CAAM;YAsBtC,KAAK;IA8EnB,OAAO,CAAC,aAAa;IAkDrB,OAAO,CAAC,aAAa;IAkBrB,OAAO,CAAC,uBAAuB;IA0C/B,OAAO,CAAC,oBAAoB;IAkB5B,OAAO,CAAC,cAAc,CAAC,CAAS;IAEhC,OAAO,CAAC,qBAAqB;IA2F7B,kBAAkB,IAAI,IAAI;IAgB1B,kBAAkB,IAAI,IAAI;IAM1B,iBAAiB,IAAI,OAAO;IAgBtB,WAAW,CACf,mBAAmB,EAAE,iBAAiB,CAAC,kBAAkB,CAAC,GACzD,OAAO,CAAC,OAAO,CAAC;IAiEnB,YAAY,IAAI,aAAa,GAAG,IAAI;IA+BpC,OAAO,IAAI,IAAI;CAahB;AAED,eAAe,UAAU,CAAC;AAC1B,YAAY,EACV,iBAAiB,EACjB,aAAa,EACb,KAAK,EACL,SAAS,EACT,gBAAgB,EAChB,SAAS,EACT,cAAc,EACd,iBAAiB,EACjB,QAAQ,EACR,gBAAgB,EAChB,kBAAkB,EAClB,aAAa,EACb,WAAW,EACX,QAAQ,EACR,cAAc,EACd,aAAa,EACb,SAAS,EACT,KAAK,GACN,MAAM,YAAY,CAAC"}