salsify-experiences-sdk/src/settings.ts

SDK to be used by commerce websites to implement product experiences.

// see ./options.ts

export default interface SdkSettings {
  /** Client identifier (UUID) provided by Salsify that uniquely identifies the website */
  readonly clientId: string
  /** Locale identifier that determines the language of the page content */
  readonly languageCode: string
  /** Enhanced Content settings, including the product identifier type */
  readonly enhancedContent: EnhancedContentSettings
  /** Whether or not cookie-based user tracking is enabled. The host site is responsible
   *  for displaying any user consent dialogs and setting this option based on the user's
   *  preference.
   */
  readonly tracking: boolean
  /** @internal */
  readonly staging?: boolean
  /** @internal */
  readonly cdnRoot?: string
}

export interface EnhancedContentSettings {
  /** Product identifier type that will be used to correlate published EC with products on your website
   *
   *  This is often a standardized identifier such as a UPC (GTIN-12) or EAN (GTIN-13), or your website’s product SKU
   */
  readonly idType?: string
}