All files / src/api client.ts

37.5% Statements 6/16
20% Branches 3/15
50% Functions 3/6
40% Lines 6/15

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242                                                                                                                                                                  4x 273x 273x 273x 273x                                       4x                                                                                                                                                                                                                                                                                
import { InputSearchQueryWithFields, SearchOptions } from "./search"
import { SearchResult } from "./search/generated"
 
/**
 * @group Nosto Client
 * @category Core
 */
type LogLevel = "error" | "warn" | "info" | "debug"
/**
 * @group Nosto Client
 * @category Core
 */
export interface Affinity {
    name: string
    score: number
}
 
/**
 * @group Nosto Client
 * @category Core
 */
export interface SessionAction {
    setPlacements(placements: string[]): SessionAction
    load(): Promise<{
        affinities: Record<string, Affinity[]>
        geo_location?: string[]
        page_views: number
        recommendations: Recommendation[]
    }>
}
 
/**
 * @group Nosto Client
 * @category Core
 */
export interface NostoSession {
    setCart(cart?: Cart): NostoSession
    setCustomer(customer?: Customer): NostoSession
    setResponseMode(mode: string): NostoSession
    setVariation(variation?: string): NostoSession
    addOrder(order: { purchase: Purchase }): SessionAction
    viewCategory(category: string): SessionAction
    viewProduct(product: string): SessionAction
    viewFrontPage(): SessionAction
    viewNotFound(): SessionAction
    viewOther(): SessionAction
    viewSearch(query: string): SessionAction
    viewCart(): SessionAction
}
 
/**
 * @group Nosto Client
 * @category Core
 */
export interface NostoClient {
    setAutoLoad(autoload: boolean): NostoClient
    defaultSession(): NostoSession
    placements: {
        getPlacements(): string[]
        injectCampaigns(recommendations: Record<string, Recommendation>): void
    }
    search(
        query: InputSearchQueryWithFields,
        options?: SearchOptions
    ): PromiseLike<SearchResult>
    recordSearchClick(
        type: "serp" | "autocomplete" | "category",
        hit: { url?: string; keyword?: string }
    ): void
    recordSearchSubmit(query: string): void
    captureError(
        error: unknown,
        reporter: string,
        level: LogLevel
    ): void
}
 
/**
 * @group Nosto Client
 * @category Core
 */
export function getNostoClient(): PromiseLike<NostoClient> {
    return new Promise((resolve, reject) => {
        if ("nostojs" in window && typeof window.nostojs === "function") {
            window.nostojs((api: NostoClient) => {
                resolve(api)
            })
        } else E{
            reject("nostojs not found")
        }
    })
}
/**
 *
 * @param msg Message to log
 * @param error Error instance to log
 * @param level Log level string
 */
export function log(message: string, error: unknown, level: LogLevel): void
/**
 *
 * @param error Error instance to log
 * @param level Log level string
 */
export function log(error: unknown, level: LogLevel): void
export function log(
    msgOrError: unknown,
    errorOrLevel: unknown,
    optLevel?: LogLevel
) {
    const msg = typeof msgOrError === "string" ? msgOrError : undefined
    const error = optLevel ? errorOrLevel : !msg ? msgOrError : undefined
    // @ts-expect-error type mismatch
    const level: LogLevel = (optLevel || (typeof errorOrLevel === "string" ? errorOrLevel : "error"))
    Iif (error) {
        (async () => {
            const api = await getNostoClient()
            api.captureError(error, "nostoAutocomplete", level)
        })()
    }
    console[level](...[msg, error].filter(Boolean))
}
 
/**
 * @group Nosto Client
 * @category Recommendation Types
 */
export interface Recommendation {
    result_id: string
    products: Product[]
    result_type: string
    title: string
    div_id: string
    source_product_ids: string[]
    params: unknown
}
 
/**
 * @group Nosto Client
 * @category Recommendation Types
 */
export interface Item {
    name: string
    price_currency_code: string
    product_id: string
    quantity: number
    sku_id: string
    unit_price: number
}
 
/**
 * @group Nosto Client
 * @category Recommendation Types
 */
export interface Cart {
    items: Item[]
}
 
/**
 * @group Nosto Client
 * @category Recommendation Types
 */
export interface Customer {
    customer_reference: string
    email: string
    first_name: string
    last_name: string
    newsletter: boolean
}
 
/**
 * @group Nosto Client
 * @category Recommendation Types
 */
export interface Buyer {
    first_name: string
    last_name: string
    email: string
    type: string
    newsletter: boolean
}
 
/**
 * @group Nosto Client
 * @category Recommendation Types
 */
export interface Purchase {
    number: string
    info: Buyer
    items: Item[]
}
 
/**
 * @group Nosto Client
 * @category Recommendation Types
 */
export interface SKU {
    id: string
    name: string
    price: number
    listPrice?: number
    url: URL
    imageUrl: URL
    gtin?: string
    availability: "InStock" | "OutOfStock"
    customFields?: { [key: string]: string }
}
 
/**
 * @group Nosto Client
 * @category Recommendation Types
 */
export interface Product {
    alternateImageUrls?: URL[]
    availability: "InStock" | "OutOfStock"
    brand?: string
    category: string[]
    categoryIds?: string[]
    description: string
    googleCategory?: string
    condition?: string
    gender?: string
    ageGroup?: string
    gtin?: string
    imageUrl: URL
    listPrice?: number
    name: string
    price: number
    ratingValue?: number
    reviewCount?: number
    priceCurrencyCode: string
    productId: string
    tags1?: string[]
    tags2?: string[]
    tags3?: string[]
    thumbUrl?: URL
    url: URL
    customFields?: { [key: string]: string }
    variationId?: string
    skus?: SKU[]
}