react-native-seel-widget 0.1.0 → 0.1.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-seel-widget",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "React-Native SeelWidget",
   "keywords": [
     "ReactNative"

package/src/constants/key_value.ts

@@ -0,0 +1,48 @@
+const KeyValue = {
+  wfp_title: `{{title}} for {{price}}`,
+  wfp_subtitle: `Extend your return window to 35 days`,
+  wfp_description: `Get a full refund if the order doesn't arrive as described, including loss & damage in transit`,
+  powered_by: `Powered by {{seel}}`,
+  ineligible_main_message: `We're unable to offer Worry-Free Purchase® for this order. This could be due to one or more of the following reasons`,
+  ineligible_reason_shipping: `Shipping destination not supported`,
+  ineligible_reason_currency: `Checkout currency not accepted`,
+  ineligible_reason_value: `Order value exceeds our coverage limit`,
+  ineligible_reason_items: `Item(s) not eligible for this service`,
+  ineligible_reason_system: `Our system has flagged this order as ineligible`,
+  ineligible_support_message: `If you have any questions, please contact our customer support team for assistance`,
+  ineligible_title: `Worry-Free Purchase® isn't eligible for this order`,
+  coverage_title: `We've Got You Covered`,
+  pricing_message: `Only {{price}} for Complete Peace of Mind`,
+  product_name: `Worry-Free Purchase®`,
+  whats_covered_title: `What's Covered`,
+  standard_coverage_intro: `In addition to your standard coverage under consumer protection laws for`,
+  standard_coverage_not_as_described: `Items not as described`,
+  standard_coverage_lost_damaged: `Items lost, stolen or damaged in transit (i.e. before they are in your physical possession (or in the possession of someone you have authorised to take delivery)`,
+  standard_coverage_not_matching: `Items not matching their description`,
+  standard_coverage_quality: `Items not of satisfactory quality or not fit for purpose`,
+  standard_coverage_not_delivered: `Items not delivered within 30 days of purchase, unless agreed otherwise`,
+  additional_coverage_intro: `Worry-Free Purchase® provides the following protection`,
+  additional_coverage_extended_return: `Extended return windows – Seven (7) additional days to decide`,
+  additional_coverage_post_delivery: `Post-delivery theft coverage – Protection for packages stolen or missing after delivery`,
+  additional_coverage_delay: `Delay compensation if the items are not delivered within 10 days`,
+  concierge_intro: `Shoppers also get white glove concierge help with post purchase issues and mishaps`,
+  concierge_app_access: `Access to desktop and mobile app`,
+  concierge_support: `Live, instant support`,
+  privacy_policy: `Privacy Policy`,
+  terms_of_service: `Terms of Service`,
+  cta_secure_purchase: `Secure Your Purchase Now`,
+  cta_continue_without: `Continue Without Protection`,
+  get_full_refund: `Get a Full Refund, No Questions Asked`,
+  lost_in_transit: `Lost in-transit`,
+  item_not_as_described: `Item arrived not as described`,
+  item_damaged: `Item damaged/non-functional on arrival`,
+  package_stolen: `Package stolen or missing after delivery`,
+  easy_resolution: `Easy Resolution`,
+  resolve_with_clicks: `Resolve your issues with just a few clicks`,
+  complete_peace_of_mind: `Complete Peace of Mind`,
+  zero_risk: `Zero-risk on your order with our protection`,
+  get_refund_promptly: `Get your refund promptly`,
+  worry_free_delivery: `Worry-Free Delivery®`,
+};
+
+export default KeyValue;

package/src/constants/network_request_statue_enum.ts

@@ -0,0 +1,13 @@
+export enum NetworkRequestStatueEnum {
+  /* eslint-disable no-bitwise */
+  Idle = 1 << 0,
+  Refreshing = 1 << 1,
+  LoadingMore = 1 << 2,
+  Loading = Refreshing | LoadingMore,
+  RefreshSuccess = 1 << 3,
+  LoadMoreSuccess = 1 << 4,
+  Success = RefreshSuccess | LoadMoreSuccess,
+  RefreshFailed = 1 << 5,
+  LoadMoreFailed = 1 << 6,
+  Failed = RefreshFailed | LoadMoreFailed,
+}

package/src/core/SeelWidgetSDK.ts

@@ -0,0 +1,103 @@
+/**
+ * Environment Enum
+ */
+export enum SeelEnvironment {
+  Development = 'development',
+  Production = 'production',
+}
+
+const defaultApiVersion: string = '2.6.0';
+const defaultSeelEnvironment: SeelEnvironment = SeelEnvironment.Production;
+const defaultRequestTimeout: number = 5000;
+
+interface SeelWidgetSDKProps {
+  apiKey: string;
+  apiVersion?: string;
+  environment?: SeelEnvironment;
+  requestTimeout?: number;
+}
+
+/**
+ * SeelWidgetSDK
+ * Main SDK class for Seel Widget functionality
+ */
+export class SeelWidgetSDK {
+  // MARK: - Singleton Instance
+  private static _shared: SeelWidgetSDK | null = null;
+
+  public static get shared(): SeelWidgetSDK {
+    if (!SeelWidgetSDK._shared) {
+      SeelWidgetSDK._shared = new SeelWidgetSDK();
+    }
+    return SeelWidgetSDK._shared;
+  }
+
+  // MARK: - Properties
+  private _apiKey: string = '';
+  private _apiVersion: string = defaultApiVersion;
+  private _environment: SeelEnvironment = defaultSeelEnvironment;
+  private _requestTimeout: number = defaultRequestTimeout;
+
+  // MARK: - Private Constructor
+  private constructor() {
+    // Private constructor for singleton pattern
+  }
+
+  // MARK: - Public Methods
+
+  /**
+   * Configure SeelWidgetSDK
+   * @param apiKey API key
+   * @param environment Environment (optional, defaults to production)
+   */
+  public configure(props: SeelWidgetSDKProps): void {
+    this._apiKey = props.apiKey;
+    this._apiVersion = props.apiVersion ?? defaultApiVersion;
+    this._environment = props.environment ?? defaultSeelEnvironment;
+    this._requestTimeout = props.requestTimeout ?? defaultRequestTimeout;
+  }
+
+  /**
+   * Get current API Key
+   */
+  public get apiKey(): string {
+    return this._apiKey;
+  }
+
+  /**
+   * Get current API Version
+   */
+  public get apiVersion(): string {
+    return this._apiVersion;
+  }
+
+  /**
+   * Get current environment
+   */
+  public get environment(): SeelEnvironment {
+    return this._environment;
+  }
+
+  /**
+   * Get current Request Timeout
+   */
+  public get requestTimeout(): number {
+    return this._requestTimeout;
+  }
+
+  /**
+   * Get current BaseURL
+   */
+  public get baseURL(): string {
+    return this._environment === SeelEnvironment.Production
+      ? 'https://api.seel.com'
+      : 'https://api-test.seel.com';
+  }
+
+  /**
+   * Check if configured
+   */
+  public get isConfigured(): boolean {
+    return this._apiKey !== '';
+  }
+}

package/src/dto/EventsRequest.ts

@@ -0,0 +1,71 @@
+import type { IEventInfo, IEvents, EventType } from './IEvents';
+
+/**
+ * Events Request/Response class
+ * Converts snake_case API format to camelCase for internal use
+ *
+ * @example
+ * ```ts
+ * const iRequest: IEvents = {
+ *   client_ip: '',
+ *   customer_id: '',
+ *   session_id: '',
+ *   event_source: '',
+ *   event_ts: '',
+ *   event_type: EventTypeEnum.product_page_exit,
+ * };
+ *
+ * const request: EventsRequest = new EventsRequest(iRequest);
+ * ```
+ */
+export default class EventsRequest {
+  /**
+   * Browser IP address
+   */
+  clientIP: string;
+  /**
+   * Customer Id
+   */
+  customerId: string;
+  /**
+   * Device Id
+   */
+  deviceId?: string;
+  /**
+   * Event Id
+   */
+  eventId?: string;
+  /**
+   * Event information object
+   * Each event_type has its own unique schema. For specific details, please refer to the custom pixel guide.
+   */
+  eventInfo?: IEventInfo;
+  /**
+   * Event source
+   */
+  eventSource: string;
+  /**
+   * Event created timestamp in milliseconds
+   */
+  eventTs: string;
+  /**
+   * Event type
+   */
+  eventType: EventType;
+  /**
+   * Session Id
+   */
+  sessionId: string;
+
+  constructor(props: IEvents) {
+    this.clientIP = props.client_ip;
+    this.customerId = props.customer_id;
+    this.deviceId = props.device_id;
+    this.eventId = props.event_id;
+    this.eventInfo = props.event_info;
+    this.eventSource = props.event_source || '';
+    this.eventTs = props.event_ts;
+    this.eventType = props.event_type;
+    this.sessionId = props.session_id;
+  }
+}

package/src/dto/EventsResponse.ts

@@ -0,0 +1,13 @@
+import type { IEvents } from './IEvents';
+import EventsRequest from './EventsRequest';
+
+/**
+ * Events Response class
+ * Reuses EventsRequest since they have the same structure
+ * This avoids code duplication while maintaining semantic clarity
+ */
+export default class EventsResponse extends EventsRequest {
+  constructor(props: IEvents) {
+    super(props);
+  }
+}

package/src/dto/IEvents.ts

@@ -0,0 +1,51 @@
+export enum EventTypeEnum {
+  product_page_enter = 'product_page_enter',
+  product_page_exit = 'product_page_exit',
+  product_share = 'product_share',
+  favorite_add = 'favorite_add',
+  favorite_remove = 'favorite_remove',
+  cart_add = 'cart_add',
+  cart_remove = 'cart_remove',
+  ra_checked = 'ra_checked',
+  ra_unchecked = 'ra_unchecked',
+  checkout_begin = 'checkout_begin',
+  checkout_complete = 'checkout_complete',
+}
+
+/**
+ * Event type union type
+ * Can be simplified to: export type EventType = EventTypeEnum;
+ */
+export type EventType = EventTypeEnum;
+
+/**
+ * Shipping address information for events
+ */
+export interface IEventShippingAddress {
+  shipping_address_state: string;
+  shipping_address_city: string;
+  shipping_address_zipcode: string;
+  shipping_address_country: string;
+}
+
+/**
+ * Event information object
+ * Each event_type has its own unique schema. For specific details, please refer to the custom pixel guide.
+ */
+export interface IEventInfo {
+  user_email?: string;
+  shipping_address?: IEventShippingAddress;
+  user_phone_number?: string;
+}
+
+export interface IEvents {
+  client_ip: string;
+  customer_id: string;
+  device_id?: string;
+  event_id?: string;
+  event_info?: IEventInfo;
+  event_source: string;
+  event_ts: string;
+  event_type: EventType;
+  session_id: string;
+}

package/src/dto/IQuotes.ts

@@ -0,0 +1,36 @@
+/**
+ * Shipping origin address information
+ */
+export interface IShippingOrigin {
+  /**
+   * The first line of the shipping address
+   */
+  address_1?: string;
+  /**
+   * The second line of the shipping address
+   */
+  address_2?: string;
+  /**
+   * The city of the shipping address
+   */
+  city: string;
+  /**
+   * ISO 3166-1 alpha-2 country code of the shipping address
+   */
+  country: string;
+  /**
+   * The state or province code of the shipping address
+   */
+  state: string;
+  /**
+   * The zipcode of the shipping address
+   */
+  zipcode: string;
+}
+
+/**
+ * Shipping address information
+ * Currently has the same structure as IShippingOrigin
+ * Using type alias to avoid unnecessary interface extension
+ */
+export type IShippingAddress = IShippingOrigin;

package/src/dto/IQuotesRequest.ts

@@ -0,0 +1,220 @@
+import type { IShippingOrigin, IShippingAddress } from './IQuotes';
+
+/**
+ * Customer information for quotes request
+ */
+export interface IQuotesRequestCustomer {
+  /**
+   * The unique identifier for the customer
+   */
+  customer_id: string;
+  /**
+   * The email address of the customer
+   */
+  email: string;
+  /**
+   * The first name of the customer
+   */
+  first_name?: string;
+  /**
+   * The last name of the customer
+   */
+  last_name?: string;
+  /**
+   * The phone number of the customer
+   */
+  phone?: string;
+}
+
+/**
+ * Extra information for quotes request
+ */
+export interface IQuotesRequestExtraInfo {
+  shipping_fee?: number;
+}
+
+/**
+ * Product Attributes
+ */
+export interface IProductAttributes {
+  /**
+   * The color of the product.
+   */
+  color?: string;
+  /**
+   * The size of the product.
+   */
+  size?: string;
+}
+
+/**
+ * Line item information for quotes request
+ */
+export interface IQuotesRequestLineItem {
+  /**
+   * The allocated discounts of the product.
+   */
+  allocated_discounts: number;
+  /**
+   * The brand name of the product.
+   */
+  brand_name?: string;
+  /**
+   * The main category of the product.
+   */
+  category_1: string;
+  /**
+   * The sub category of the product.
+   */
+  category_2: string;
+  /**
+   * The sub category of the product.
+   */
+  category_3?: string;
+  /**
+   * The sub category of the product.
+   */
+  category_4?: string;
+  /**
+   * The physical condition of the item (e.g. new, used, refurbished)
+   */
+  condition?: 'new' | 'used' | 'refurbished';
+  /**
+   * The currency of the price.
+   */
+  currency: string;
+  /**
+   * The final price of the product.
+   */
+  final_price: number | string;
+  /**
+   * The URLs of the product images.
+   */
+  image_urls?: string[];
+  /**
+   * Whether the item is final sale or not.
+   * Default: true
+   */
+  is_final_sale: boolean;
+  /**
+   * The ID of the item.
+   */
+  line_item_id: string;
+  /**
+   * The price of the product.
+   */
+  price: number;
+
+  product_attributes?: IProductAttributes;
+  /**
+   * The description of the product.
+   */
+  product_description?: string;
+  /**
+   * The ID of the product.
+   */
+  product_id: string;
+  /**
+   * The title of the product.
+   */
+  product_title: string;
+  /**
+   * The URL of the product.
+   */
+  product_url?: string;
+  /**
+   * The quantity of the product.
+   */
+  quantity: number;
+  /**
+   * The retail price of the product.
+   */
+  retail_price?: number;
+  /**
+   * Whether the item requires shipping or not.
+   */
+  requires_shipping: boolean;
+  /**
+   * The sales tax of the product.
+   */
+  sales_tax: number;
+  /**
+   * The ID of the seller.
+   */
+  seller_id?: string;
+  /**
+   * The name of the seller.
+   */
+  seller_name?: string;
+  /**
+   * Shipping origin
+   */
+  shipping_origin?: IShippingOrigin | null;
+  /**
+   * The sku of the product variant.
+   */
+  sku?: string;
+  /**
+   * The ID of the product variant.
+   */
+  variant_id?: string;
+  /**
+   * The title of the product variant.
+   */
+  variant_title?: string;
+}
+
+/**
+ * Quotes Request interface
+ * Fields are ordered logically: identifiers, configuration, data, metadata
+ */
+export interface IQuotesRequest {
+  /**
+   * The ID of a cart.
+   */
+  cart_id?: string;
+  /**
+   * The IP address of the client.
+   */
+  client_ip?: string;
+  /**
+   * The unique identifier for the merchant within Seel's system.
+   */
+  merchant_id?: string;
+  /**
+   * The ID of the shopping session.
+   */
+  session_id: string;
+
+  /**
+   * The type of the quote.
+   */
+  type: string;
+  /**
+   * The type of device from which user activity originated.
+   */
+  device_category: string;
+  /**
+   * The ID of the client device.
+   */
+  device_id?: string;
+  /**
+   * The method by which users accessed your website or application.
+   */
+  device_platform: string;
+  /**
+   * The default opt-in setting for the quote
+   */
+  is_default_on: boolean;
+
+  /**
+   * The list of items included in the quote.
+   */
+  line_items: IQuotesRequestLineItem[] | null;
+  customer: IQuotesRequestCustomer;
+  shipping_address: IShippingAddress;
+  /**
+   * Additional information for the quote
+   */
+  extra_info?: IQuotesRequestExtraInfo | null;
+}