@bridgeline-digital/hawksearch-handlebars-ui 5.2.6 → 5.2.8

package/dist/models/content.models.d.ts

@@ -0,0 +1,94 @@
+import { Item, ItemType } from './base.models';
+/**
+ * @category Content
+ */
+export interface ContentType {
+    id: number;
+    campaignId: number;
+    type: string;
+    title: string;
+    trackingEnabled: boolean;
+    zone: string;
+}
+/**
+ * @category Content
+ */
+export interface CustomContent extends ContentType {
+    type: 'custom';
+    content: string;
+}
+/**
+ * @category Content
+ */
+export interface CustomWidgetContent extends ContentType {
+    type: 'custom-widget';
+    data: any;
+}
+/**
+ * @category Content
+ */
+export interface FeaturedItemsContentItem extends Item {
+    pinned: boolean;
+    score: number;
+    type: ItemType;
+}
+/**
+ * @category Content
+ */
+export interface FeaturedItemsContent extends ContentType {
+    type: 'featured-items';
+    items: Array<FeaturedItemsContentItem>;
+}
+/**
+ * @category Content
+ */
+export interface ImageContent extends ContentType {
+    type: 'image';
+    image: {
+        url: string;
+        height?: number;
+        width?: number;
+        altText?: string;
+        title?: string;
+    };
+    link?: {
+        url: string;
+        target: string;
+    };
+}
+/**
+ * @category Content
+ */
+export interface PopularQueriesContentItem {
+    query: string;
+    count: number;
+    weight: number;
+}
+/**
+ * @category Content
+ */
+export interface PopularQueriesContent extends ContentType {
+    type: 'popular-queries';
+    items: Array<PopularQueriesContentItem>;
+}
+/**
+ * @category Content
+ */
+export interface ContentZoneItem {
+    mobile: ContentType;
+    tablet: ContentType;
+    desktop: ContentType;
+}
+/**
+ * @category Content
+ */
+export interface ContentZone {
+    name: string;
+    items: Array<ContentZoneItem>;
+}
+/**
+ * @category Content
+ */
+export interface ContentZones {
+    [zone: string]: ContentZone;
+}

package/dist/models/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @module Models
+ */
+export * from './autocomplete.models';
+export * from './base.models';
+export * from './component.models';
+export * from './content.models';
+export * from './raw';
+export * from './recommendation.models';
+export * from './search.models';
+export * from './tracking.models';

package/dist/models/raw/index.d.ts

@@ -0,0 +1,4 @@
+export * from './raw-autocomplete.models';
+export * from './raw-base.models';
+export * from './raw-recommendation.models';
+export * from './raw-search.models';

package/dist/models/raw/raw-autocomplete.models.d.ts

@@ -0,0 +1,51 @@
+import { RawSearchResultsItem } from './raw-search.models';
+export interface RawAutocompleteRequest {
+    ClientGuid: string;
+    IndexName?: string;
+    Keyword?: string;
+    DisplayFullResponse?: boolean;
+}
+export interface RawAutocompleteCategory {
+    Url: string;
+    Value: string;
+    FieldQSName: string;
+    FieldQSValue: string;
+}
+export interface RawAutocompleteContent {
+    Value: string;
+    Url: string;
+    Results: RawSearchResultsItem;
+}
+export interface RawAutocompleteQuery {
+    RawValue: string;
+    Url: string;
+    Value: string;
+}
+export interface RawAutocompleteProduct {
+    ProductName: string;
+    Sku: string;
+    Thumb?: {
+        AltText: string;
+        Url: string;
+    };
+    Url: string;
+    Results: RawSearchResultsItem;
+}
+export interface RawAutocompleteResponse {
+    Categories: Array<RawAutocompleteCategory>;
+    CategoryHeading: string;
+    Content: Array<RawAutocompleteContent>;
+    ContentCount: number;
+    ContentHeading: string;
+    Count: number;
+    DYMContentHeading: string;
+    DymContentSearch?: Array<RawAutocompleteQuery>;
+    DYMProductHeading: string;
+    DymProductsSearch?: Array<RawAutocompleteQuery>;
+    Popular: Array<RawAutocompleteQuery>;
+    PopularHeading: string;
+    ProductHeading: string;
+    ProductCount: number;
+    Products: Array<RawAutocompleteProduct>;
+    ViewAllButtonLabel: string;
+}

package/dist/models/raw/raw-base.models.d.ts

@@ -0,0 +1,8 @@
+export interface RawVariantDocument {
+    hawk_child_attributes?: Array<Record<string, Array<string>>>;
+    hawk_child_attributes_hits?: Array<{
+        Items: Array<Record<string, Array<string>>>;
+        NofPages: number;
+        NofResults: number;
+    }>;
+}

package/dist/models/raw/raw-recommendation.models.d.ts

@@ -0,0 +1,39 @@
+import { RawVariantDocument } from './raw-base.models';
+export interface RawRecommendationsRequest {
+    clientGuid: string;
+    indexName?: string;
+    landingPageUrl?: string;
+    visitId: string;
+    visitorId: string;
+    renderHTML: boolean;
+    widgetUids: Array<{
+        widgetGuid: string;
+        uniqueid?: string;
+    }>;
+}
+export type RawRecommendationsItemCustomDict = Record<string, string | Array<string>> & RawVariantDocument;
+export interface RawRecommendationsItem extends Record<string, any> {
+    customDict: RawRecommendationsItemCustomDict;
+    id: string;
+    imageUrl?: string;
+    itemName: string;
+    url: string;
+    price?: string;
+    rating?: string;
+    salePrice?: string;
+    shortDescription?: string;
+}
+export interface RawRecommendationsWidget {
+    isCarousel: boolean;
+    isVertical: boolean;
+    itemsCount: number;
+    recommendationItems?: Array<RawRecommendationsItem>;
+    widgetCssClass: string;
+    widgetGuid: string;
+    widgetName: string;
+}
+export interface RawRecommendationsResponse {
+    isSuccess: boolean;
+    requestId: string;
+    widgetItems?: Array<RawRecommendationsWidget>;
+}

package/dist/models/raw/raw-search.models.d.ts

@@ -0,0 +1,191 @@
+import { RawVariantDocument } from './raw-base.models';
+export interface RawFacetValue {
+    Count: number;
+    Label: string;
+    Level?: number;
+    Value: string;
+    RangeEnd: string;
+    RangeMax: string;
+    RangeMin: string;
+    RangeStart: string;
+    Selected?: boolean;
+    Children?: Array<RawFacetValue>;
+}
+export interface RawFacetRangeValue {
+    AssetFullUrl: string;
+    IsNumeric: boolean;
+    LBound: string;
+    Label: string;
+    UBound: string;
+    Value: string;
+}
+export interface RawFeaturedItem extends RawMerchandisingItem {
+    FeaturedItems?: Array<RawSearchResultsItem>;
+    Items?: Array<RawSearchResultsItem>;
+}
+export interface RawFeaturedItems {
+    Items: Array<RawFeaturedItem>;
+}
+export interface RawFacetSwatchValue {
+    Value: string;
+    Color?: string;
+    AssetName?: string;
+    AssetUrl?: string;
+    IsDefault: boolean;
+}
+export interface RawFacet {
+    AlwaysVisible: boolean;
+    CurrencySymbol: string;
+    DataType: string;
+    DisplayType: string;
+    ExpandSelection: boolean;
+    FacetId: number;
+    FacetType: string;
+    Field: string;
+    FieldType: string;
+    IsCollapsedDefault?: boolean;
+    IsCollapsible?: boolean;
+    IsCurrency: boolean;
+    IsNumeric: boolean;
+    IsSearch: boolean;
+    IsVisible: boolean;
+    Name: string;
+    ParamName?: string;
+    Ranges?: Array<RawFacetRangeValue>;
+    ScrollHeight?: number;
+    ScrollThreshold?: number;
+    SearchThreshold?: number;
+    ShowFacetCount?: boolean;
+    ShowItemsCount?: boolean;
+    Tooltip?: string;
+    TruncateThreshold?: number;
+    Values?: Array<RawFacetValue>;
+    SwatchData?: Array<RawFacetSwatchValue>;
+}
+export interface RawMerchandisingItem {
+    AltTag?: string;
+    BannerId: number;
+    CampaignId: number;
+    ContentType: string;
+    ForwardUrl?: string;
+    Height?: number;
+    ImageUrl?: string;
+    IsMobile: boolean;
+    IsTablet: boolean;
+    IsTrackingEnabled?: boolean;
+    MobileHeight?: number;
+    MobileWidth?: number;
+    Output?: any;
+    TabletHeight?: number;
+    TabletWidth?: number;
+    Target: string;
+    Title: string;
+    WidgetType?: string;
+    Width?: number;
+    Zone: string;
+}
+export interface RawMerchandising {
+    Items: Array<RawMerchandisingItem>;
+}
+export interface RawPageContent {
+    ZoneName: string;
+    Items: Array<RawMerchandisingItem>;
+}
+export interface RawSearchSelectionItem {
+    Label: string;
+    Value: string;
+}
+export interface RawSearchSelection {
+    Label: string;
+    Items: Array<RawSearchSelectionItem>;
+}
+export interface RawSearchSelections {
+    [field: string]: RawSearchSelection;
+}
+export interface RawSearchPagination {
+    CurrentPage: number;
+    IsShowFirstLink: boolean;
+    IsShowLastLink: boolean;
+    MaxPerPage: number;
+    NofPages: number;
+    NofResults: number;
+    NumberOfPageLinks: number;
+    Items: Array<{
+        Label: string;
+        PageSize: number;
+        Selected: boolean;
+        Default: boolean;
+    }>;
+}
+export interface RawSearchSorting {
+    Value?: string;
+    Items: Array<{
+        Label: string;
+        Value: string;
+        IsDefault: boolean;
+        Selected: boolean;
+    }>;
+}
+export interface RawSearchRedirect {
+    Location: string;
+    Target?: string;
+}
+export type RawSearchResultsItemDocument = Record<string, Array<string>> & RawVariantDocument;
+export interface RawSearchResultsItem {
+    DocId: string;
+    Document: RawSearchResultsItemDocument;
+    IsPin: boolean;
+    IsVisible: boolean;
+    Score: number;
+}
+export interface RawSearchResponse {
+    AdjustedKeyword?: string;
+    Breadcrumb?: string;
+    CustomHtml?: string;
+    DidYouMean?: Array<string>;
+    Facets?: Array<RawFacet>;
+    FeaturedItems?: RawFeaturedItems;
+    HeaderTitle?: string;
+    Keyword?: string;
+    Merchandising?: RawMerchandising;
+    MetaDescription?: string;
+    MetaKeywords?: string;
+    MetaRobots?: string;
+    PageContent?: Array<RawPageContent>;
+    PageHeading?: string;
+    PageLayoutId?: number;
+    PageLayoutHtml?: string;
+    Pagination?: RawSearchPagination;
+    Redirect?: RawSearchRedirect;
+    RelCanonical?: string;
+    Results?: Array<RawSearchResultsItem>;
+    Selections?: RawSearchSelections;
+    Sorting?: RawSearchSorting;
+    Success: boolean;
+    TrackingId: string;
+}
+export interface RawSearchRequest {
+    ClientData?: {
+        UserAgent?: string;
+        VisitorId?: string;
+        VisitId?: string;
+    };
+    ClientGuid: string;
+    CustomURL?: string;
+    IgnoreSpellcheck?: boolean;
+    IndexName?: string;
+    IsInPreview?: boolean;
+    Keyword?: string;
+    FacetSelections?: Record<string, Array<string> | undefined>;
+    MaxPerPage?: number;
+    PageNo?: number;
+    SearchWithin?: string;
+    SortBy?: string;
+    Variants?: {
+        CountFacetHitOnChild?: boolean;
+        MaxPerPage?: number;
+        PageNo?: number;
+        SortBy?: string;
+        SortCode?: string;
+    };
+}

package/dist/models/recommendation.models.d.ts

@@ -0,0 +1,31 @@
+import { Item } from './base.models';
+/**
+ * @category Recommendations
+ */
+export interface RecommendationsRequest {
+    widgetId: string;
+    itemId?: string;
+    url?: string;
+}
+/**
+ * @category Recommendations
+ */
+export interface RecommendationsItem extends Item {
+}
+/**
+ * @category Recommendations
+ */
+export interface RecommendationsWidget {
+    id: string;
+    requestId: string;
+    title: string;
+    carousel: boolean;
+    items?: Array<RecommendationsItem>;
+}
+/**
+ * @category Recommendations
+ */
+export interface RecommendationsResponse {
+    requestId: string;
+    widgets?: Array<RecommendationsWidget>;
+}

package/dist/models/search.models.d.ts

@@ -0,0 +1,237 @@
+import { Item, ItemType, ItemVariant } from './base.models';
+import { ContentZones } from './content.models';
+/**
+ * @category Search
+ */
+export type FacetValueState = {
+    toggled?: boolean;
+};
+/**
+ * @category Search
+ */
+export type FacetState = {
+    id: number;
+    collapsed?: boolean;
+    filter?: string;
+    toggled?: boolean;
+    values?: Record<string, FacetValueState>;
+};
+/**
+ * @category Search
+ */
+export type FacetType = 'checkbox' | 'color' | 'date-range' | 'link' | 'numeric-range' | 'range-slider' | 'recent-searches' | 'related-searches' | 'search' | 'size' | 'tabs' | 'unsupported';
+/**
+ * @category Search
+ */
+export interface ContentConfiguration {
+    breadcrumbs?: string;
+    customHtml?: string;
+    heading?: string;
+}
+/**
+ * @category Search
+ */
+export interface SelectedFacetValue {
+    title: string;
+    value: string;
+    excluded: boolean;
+}
+/**
+ * @category Search
+ */
+export interface SelectedFacet {
+    field: string;
+    currency: boolean;
+    title: string;
+    values: Array<SelectedFacetValue>;
+}
+/**
+ * @category Search
+ */
+export interface FacetScrolling {
+    height?: number;
+    threshold: number;
+}
+/**
+ * @category Search
+ */
+export interface FacetTruncation {
+    threshold: number;
+}
+/**
+ * @category Search
+ */
+export interface FacetSearch {
+    threshold: number;
+}
+/**
+ * @category Search
+ */
+export interface FacetValueColor {
+    name: string;
+    hex?: string;
+    imageUrl?: string;
+}
+/**
+ * @category Search
+ */
+export interface FacetValue {
+    title: string;
+    imageUrl?: string;
+    value?: string;
+    color?: FacetValueColor;
+    count?: number;
+    level?: number;
+    selected?: boolean;
+    excluded?: boolean;
+    children?: Array<FacetValue>;
+}
+/**
+ * @category Search
+ */
+interface FacetRange<T> {
+    type: string;
+    min: T;
+    max: T;
+    start: T;
+    end: T;
+}
+/**
+ * @category Search
+ */
+export interface DateFacetRange extends FacetRange<Date> {
+    type: 'date';
+}
+/**
+ * @category Search
+ */
+export interface NumericFacetRange extends FacetRange<number> {
+    type: 'numeric';
+}
+/**
+ * @category Search
+ */
+export interface Facet {
+    id: number;
+    type: FacetType;
+    title: string;
+    values?: Array<FacetValue>;
+    field: string;
+    collapsible: boolean;
+    collapsed?: boolean;
+    displayCount?: boolean;
+    range?: DateFacetRange | NumericFacetRange;
+    scrolling?: FacetScrolling;
+    search?: FacetSearch;
+    searchWithin?: string;
+    tooltip?: string;
+    truncation?: FacetTruncation;
+    visible: boolean;
+}
+/**
+ * @category Search
+ */
+export interface PaginationOption {
+    title: string;
+    pageSize: number;
+    selected: boolean;
+    default: boolean;
+}
+/**
+ * @category Search
+ */
+export interface Pagination {
+    page: number;
+    pageSize: number;
+    totalPages: number;
+    totalResults: number;
+    maxPageLinks?: number;
+    displayFirstLink: boolean;
+    displayLastLink: boolean;
+    options: Array<PaginationOption>;
+}
+/**
+ * @category Search
+ */
+export interface Redirect {
+    url: string;
+    target?: string;
+}
+/**
+ * @category Search
+ */
+export interface SeoConfiguration {
+    canonicalUrl?: string;
+    description?: string;
+    keywords?: string;
+    robots?: string;
+    title?: string;
+}
+/**
+ * @category Search
+ */
+export interface SortingOption {
+    title: string;
+    value: string;
+    default: boolean;
+    selected: boolean;
+}
+/**
+ * @category Search
+ */
+export interface Sorting {
+    value?: string;
+    options: Array<SortingOption>;
+}
+/**
+ * @category Search
+ */
+export interface SearchResultsItemVariant extends ItemVariant {
+}
+/**
+ * @category Search
+ */
+export interface SearchResultsItem extends Item {
+    pinned: boolean;
+    score: number;
+    type: ItemType;
+}
+/**
+ * @category Search
+ */
+export interface SearchResponse {
+    content?: ContentConfiguration;
+    contentZones?: ContentZones;
+    customLayout?: string;
+    facets?: Array<Facet>;
+    modifiedQuery?: string;
+    pagination?: Pagination;
+    query?: string;
+    querySuggestions?: Array<string>;
+    redirect?: Redirect;
+    results?: Array<SearchResultsItem>;
+    selectedFacets?: Array<SelectedFacet>;
+    seo?: SeoConfiguration;
+    sorting?: Sorting;
+    success: boolean;
+    trackingId: string;
+}
+/**
+ * @category Search
+ */
+export type SelectedFacets = Record<string, Array<string> | undefined>;
+/**
+ * @category Search
+ */
+export interface SearchRequest {
+    disableSpellcheck?: boolean;
+    facets?: SelectedFacets;
+    newRequest: boolean;
+    pageSize?: number;
+    page?: number;
+    query?: string;
+    searchWithin?: string;
+    sort?: string;
+    url?: string;
+}
+export {};

package/dist/models/tracking.models.d.ts

@@ -0,0 +1,42 @@
+/**
+ * @category Tracking
+ */
+export declare enum AutocompleteItemType {
+    Search = 1,
+    Category = 2,
+    Product = 3,
+    Content = 4
+}
+/**
+ * @category Tracking
+ */
+export declare enum EventType {
+    PageLoad = 1,
+    Search = 2,
+    Click = 3,
+    AddToCart = 4,
+    Rate = 5,
+    Sale = 6,
+    BannerClick = 7,
+    BannerImpression = 8,
+    RecommendationClick = 10,
+    AutocompleteClick = 11,
+    AddToCartMultiple = 14
+}
+/**
+ * @category Tracking
+ */
+export declare enum PageType {
+    Item = 1,
+    Landing = 2,
+    Cart = 3,
+    Order = 4,
+    Custom = 5
+}
+/**
+ * @category Tracking
+ */
+export declare enum SearchType {
+    Initial = 1,
+    Refinement = 2
+}