Class SearchService

ProtectedfieldMappings

ProtectedvariantFieldMappings

ProtectedonSearchPage

• get onSearchPage(): boolean

  Returns boolean

ProtectedgenerateGuid

• generateGuid(): string

  Returns string

ProtectedgetApiHeaders

• getApiHeaders(): Headers

  Builds the request headers for HawkSearch API calls.

  User-Agent, X-Forwarded-For, X-HawkSearch-ClientGuid, and X-HawkSearch-IgnoreTracking are values a server-side HawkSearch SDK would normally populate automatically. Because this library calls the API directly from the browser, it reconstructs them here by hand.

  Everything is best-effort and defensive on purpose:

  • User-Agent is a browser "forbidden header" — fetch may silently drop it or throw when it's set.
  • The library also runs in sandboxed iframes (e.g. BigCommerce), SSR / hydration, and jsdom tests, where window / navigator / the HawkSearch global may be undefined, or where new Headers() / headers.set() themselves can throw.

  These headers are optional enrichment (analytics / geo / tracking), never required for the request to succeed — so a failure to build any one of them must never break a search. Each header is resolved and set in its own try/catch (see setHeaderSafe): a failing header is logged in debug mode and skipped while the rest still go out.

  Returns Headers

ProtectedgetFullUrl

• getFullUrl(
      url: string | undefined,
      prefix: string | undefined,
  ): string | undefined

  Parameters

  • url: string | undefined
  • prefix: string | undefined

  Returns string | undefined

ProtectedgetHeaders

• getHeaders(): Headers

  Returns Headers

ProtectedgetNumber

• getNumber(
      data: object,
      fieldMappings: string[],
      defaultValue?: number,
  ): number | undefined

  Parameters

  • data: object
  • fieldMappings: string[]
  • OptionaldefaultValue: number

  Returns number | undefined

ProtectedgetString

• getString(
      data: object,
      fieldMappings: string[],
      defaultValue?: string,
  ): string | undefined

  Parameters

  • data: object
  • fieldMappings: string[]
  • OptionaldefaultValue: string

  Returns string | undefined

ProtectedgetUrl

• getUrl(
      data: object,
      fieldMappings: string[],
      prefix?: string,
  ): string | undefined

  Parameters

  • data: object
  • fieldMappings: string[]
  • Optionalprefix: string

  Returns string | undefined

ProtectedgetValue

• getValue(data: object, fieldMappings: string[]): string[] | undefined

  Parameters

  • data: object
  • fieldMappings: string[]

  Returns string[] | undefined

ProtectedhttpPost

• httpPost<T>(
      relativeUrl: string,
      body?: any,
      customHeaders?: any,
      isAbsoluteUrl?: boolean,
  ): Promise<T>

  Type Parameters

  • T

  Parameters

  • relativeUrl: string
  • Optionalbody: any
  • OptionalcustomHeaders: any
  • OptionalisAbsoluteUrl: boolean

  Returns Promise<T>

ProtectedstripHtml

• stripHtml(input: string): string

  Parameters

  • input: string

  Returns string

ProtectedtriggerBindEvent

• triggerBindEvent<T>(
      component: keyof HawkSearchComponents,
      data: T,
      filter?: string,
  ): void

  Type Parameters

  • T

  Parameters

  • component: keyof HawkSearchComponents
  • data: T
  • Optionalfilter: string

  Returns void

ProtectedtriggerEvent

• triggerEvent<T>(name: string, data: T): void

  Type Parameters

  • T

  Parameters

  • name: string
  • data: T

  Returns void