ChemPal Documentation - v1.7.0
    Preparing search index...

    Ambeed is a Chinese chemical supplier.

    Ambeed seems to have a custom API located at https://www.ambeed.com/webapi/v1. All the GET endpoints seem to require a params query parameter, which is a base64 encoded JSON string. They only seem to ship to three locations: USA, China and two places in Amsterdam. Each location has its own quantity

    const params = btoa(JSON.stringify({"keyword":"sodium","country":"United States","one_menu_id":0,"one_menu_life_id":0,"menu_id":0}));
    const url = `https://ambeed.com/webapi/v1/productlistbykeyword?params=${params}`;
    export class SupplierAmbeed
    extends SupplierBase<AmbeedProductObject, Product>
    implements ISupplier
    {
    // Name of supplier (for display purposes)
    public static readonly supplierName: string = 'Ambeed';

    // Ambeed's search natively accepts CAS numbers, molecular formulas, and SMILES
    // (it resolves them itself via resolvedStructures), so the base must not swap an
    // identifier query for a resolved name.
    protected static readonly supportsCAS: boolean = true;
    protected static readonly supportsFormula: boolean = true;
    protected static readonly supportsSMILES: boolean = true;

    // Base URL for HTTP(s) requests
    public static readonly baseURL: string = 'https://www.ambeed.com';

    // Shipping scope for Ambeed
    public static readonly shipping: ShippingRange = 'international';

    // The country code of the supplier.
    public static readonly country: CountryCode = 'CN';

    // The countries to which the supplier ships.
    public static readonly shipsTo: CountryCode[] = [
    'AR',
    'BR',
    'CA',
    'MX',
    'US',
    'AT',
    'BE',
    'BG',
    'HR',
    'CY',
    'CZ',
    'DK',
    'EE',
    'FI',
    'FR',
    'DE',
    'GR',
    'HU',
    'IE',
    'IT',
    'LV',
    'LI',
    'LT',
    'LU',
    'MT',
    'NL',
    'NO',
    'PL',
    'PT',
    'RO',
    'SK',
    'SI',
    'ES',
    'SE',
    'CH',
    'TR',
    'GB',
    'AU',
    'CN',
    'IN',
    'ID',
    'JP',
    'KR',
    'MY',
    'NZ',
    'PH',
    'SG',
    'TH',
    'VN',
    'EG',
    'IL',
    ] as const;

    // The payment methods accepted by the supplier.
    public static readonly paymentMethods: PaymentMethod[] = [
    'mastercard',
    'visa',
    'ach',
    'moneyorder',
    'check',
    ] as const;

    // Override the type of queryResults to use our specific type
    protected queryResults: Array<AmbeedProductObject> = [];

    // Used to keep track of how many requests have been made to the supplier.
    protected httpRequstCount: number = 0;

    /** The sign secret for the Ambeed API. */
    protected signSecret: string = this.calculateSignSecret();

    /** The XSRF token for the Ambeed API. */
    protected xsrfToken: string = '';

    // HTTP headers used as a basis for all queries.
    protected headers: HeadersInit = {
    accept: [
    'text/html',
    'application/xhtml+xml',
    'application/xml;q=0.9',
    'image/avif',
    'image/webp',
    'image/apng',
    '*/*;q=0.8',
    ].join(','),
    'accept-language': 'en-US,en;q=0.6',
    'cache-control': 'no-cache',
    pragma: 'no-cache',
    'x-requested-with': 'XMLHttpRequest',
    };

    /**
    * Derives the unique product key from an Ambeed product item: its `p_am`, the
    * per-listing article id (the `?am=` in the product URL and the `pr_am` on every
    * price row). NOT `p_id` — that identifies the *compound* (≈ CAS), which Ambeed
    * lists under multiple brands, each a distinct `p_am`/URL. Keying on `p_id`
    * collapses those separate listings onto one key, corrupting the per-product
    * detail cache and tripping the duplicate-results detector. Size variants remain
    * distinguished by their own `pr_id` (`variant.id`). Falls back to `p_id` only
    * when `p_am` is absent.
    * @param data - The raw Ambeed product list item
    * @returns The product's `p_am` (per-listing article id)
    * @example
    * ```typescript
    * this.getUniqueProductKey(product); // "A112492"
    * ```
    * @source
    */
    protected getUniqueProductKey(data: AmbeedProductListResponseResultItem): string {
    return String(data.p_am || data.p_id);
    }

    // /**
    // * Map of encoded price characters to their corresponding decoded characters.
    // */
    // protected encodedPriceChars: Map<string, string> = new Map([
    // ["\u00b6", "."],
    // ["\u0142", "$"],
    // ["\u00ca", "0"],
    // ["\u00c7", "1"],
    // ["\u00cb", "2"],
    // ["\u00a7", "3"],
    // ["\u00cd", "4"],
    // ["\u00ff", "5"],
    // ["\u00f2", "6"],
    // ["\u010f", "7"],
    // ["\u00f3", "8"],
    // ["\u00ee", "9"],
    // ]);

    /**
    * Calculates the sign secret for the Ambeed API.
    * @returns The sign secret
    * @example
    * ```js
    * console.log(this.calculateSignSecret());
    * // "6587ab544f254fe4a5f64a41531b95b2"
    * ```
    * @source
    */
    protected calculateSignSecret(): string {
    /** Obfuscation alphabet constants from Ambeed's `f1()` signer. */
    const forwardAlphabet = 'abcdefghijklmnopqrstuvwxyz';
    const reversedAlphabet = 'zyxwvutsrqponmlkjihgfedcba';
    const embeddedFragmentA = '7ab544f2'; // RC4 0x6a, key "&$SR"
    const embeddedFragmentB = 'fe4a5f64a41531b'; // RC4 0x80, key "W61u"
    return (
    String(forwardAlphabet.indexOf('g')) + // "6"
    String(forwardAlphabet.indexOf('f')) + // "5"
    String(reversedAlphabet.indexOf('y') * 8) + // "8"
    embeddedFragmentA +
    String(Math.pow(reversedAlphabet.indexOf('t'), 2) + 18) + // "54"
    embeddedFragmentB +
    String(Math.pow(forwardAlphabet.indexOf('k'), 2) - 5) + // "95"
    'b2'
    );
    }

    /**
    * Sets the XSRF token if it's not already set. Checks the browser cookies
    * first, and if the token isn't there, makes a request to the base URL to
    * have the backend plant it, then reads it back from the cookies.
    * @example
    * ```js
    * await this.setXsrfToken();
    * console.log(this.xsrfToken);
    * // "2|d4c7158a|d58bc32de23d069be88c542ddebdacb5|1782230077"
    * ```
    * @source
    */
    protected async setXsrfToken(): Promise<void> {
    if (this.xsrfToken) {
    return;
    }

    let cookie = await getCookie(this.baseURL, '_xsrf');
    if (cookie) {
    this.xsrfToken = cookie.value;
    return;
    }

    await this.httpGetHtml({
    path: '/',
    });

    cookie = await getCookie(this.baseURL, '_xsrf');
    if (cookie) {
    this.xsrfToken = cookie.value;
    return;
    }

    this.xsrfToken = '';
    return;
    }

    /**
    * Makes the query params for the Ambeed API.
    * @param query - The query to make the query params for
    * @returns The query params
    * @todo Add
    * @example
    * ```js
    * console.log(this.makeQueryParams("sodium chloride"));
    * // "btoa(JSON.stringify({ keyword: "sodium chloride" }))"
    * ```
    * @source
    */
    protected makeQueryParams(query: string): Base64String {
    // btoa returns a plain string; cast brands it as Base64String (a nominal Brand type).
    return btoa(JSON.stringify({ keyword: query })) as Base64String;
    }

    /**
    * Resolves the SDS document "type" to prefer for the current user, based on
    * their saved `location` (country) and `language` settings. European users
    * get a `sdsJsonEurope` (amgm-*) type matched to their language; everyone
    * else gets the country-specific `sdsJson` type. Falls back to English
    * (`am`) when there's no match.
    *
    * @returns The Ambeed SDS type string (e.g. `"amgm-de-de"`, `"am-cn"`, `"am"`)
    * @example
    * ```typescript
    * await this.getSdsType(); // user in Germany, language "de" -> "amgm-de-de"
    * ```
    * @source
    */
    private async getSdsType(): Promise<string> {
    const stored = await cstorage.local.get([CACHE.USER_SETTINGS]);
    const settings = (stored[CACHE.USER_SETTINGS] ?? {}) as Partial<UserSettings>;

    const country = (settings.location ?? '').toUpperCase();
    const language = (settings.language ?? getUserLanguage()).split('-')[0].toLowerCase();

    if (EUROPEAN_COUNTRY_CODES.has(country)) {
    if (country === 'GB') {
    return sdsJsonEurope['SDS-UK-EN'].type;
    }
    const suffix = LANGUAGE_TO_EU_SDS_SUFFIX[language] ?? 'EN';
    const key = `SDS-EU-${suffix}` as keyof typeof sdsJsonEurope;
    return (sdsJsonEurope[key] ?? sdsJsonEurope['SDS-EU-EN']).type;
    }

    const key = `SDS-${country}` as keyof typeof sdsJson;
    return (sdsJson[key] ?? sdsJson['SDS-US']).type;
    }

    /**
    * Fetches SDS documents for many products in a single batch request and
    * returns a map of AM id (`p_am`) → SDS PDF URL. Requests the user's
    * preferred SDS type plus English (`am`) as a fallback; for each product the
    * preferred type's URL wins, falling back to `am`.
    *
    * @param amNos - The product AM ids (`p_am`) to fetch SDS documents for
    * @returns A map of `p_am` → SDS URL (only products with an available SDS)
    * @example
    * ```typescript
    * await this.getSdsUrls(["A491321", "A1159477"]);
    * // { A491321: "https://.../SDS-A491321.pdf", A1159477: "https://.../SDS-A1159477.pdf" }
    * ```
    * @source
    */
    private async getSdsUrls(amNos: string[]): Promise<Record<string, string>> {
    if (amNos.length === 0) {
    return {};
    }

    const sdsType = await this.getSdsType();
    const reqBody = {
    am_nos: amNos,
    request_type: Array.from(new Set([sdsType, SDS_TYPE_FALLBACK])),
    };

    // SDS URLs are enrichment, not core data — a failed/blocked request must not take down the
    // whole supplier. Degrade to "no SDS links" instead of throwing.
    let response: unknown;
    try {
    response = await this.httpPostJson({
    path: 'webapi/v1/getPmsSdsByAms',
    params: {
    params: btoa(JSON.stringify(reqBody)),
    },
    headers: {
    'Content-Type': 'application/x-www-form-urlencoded; charset=UTF-8',
    },
    });
    } catch (error) {
    this.logger.warn('Ambeed SDS request failed; continuing without SDS URLs', { error, amNos });
    return {};
    }

    if (!isAmbeedGetPmsSdsByAmsResponse(response)) {
    this.logger.warn('Invalid Ambeed SDS response', { amNos, response });
    return {};
    }

    const urls: Record<string, string> = {};
    for (const [am, byType] of Object.entries(response.value.sds_list)) {
    const preferred = byType[sdsType];
    const fallback = byType[SDS_TYPE_FALLBACK];
    const url =
    preferred?.status && preferred.url
    ? preferred.url
    : fallback?.status && fallback.url
    ? fallback.url
    : undefined;
    if (url) {
    urls[am] = url;
    }
    }
    return urls;
    }

    /**
    * Construct spec sheet URL from product id
    *
    * @param proid - The product ID
    * @returns The spec sheet URL
    * @example
    * ```js
    * console.log(this.getSpecSheetUrl("A806610"));
    * // "/product-details/specification/A806610"
    * ```
    * @source
    */
    private getSpecSheetUrl(proid: string): string {
    return this.href(`/product-details/specification/${proid}`);
    }

    /**
    * Builds a base64-encoded, signed Ambeed API `params` payload. The `timestamp`
    * is injected and signed alongside `signedFields`; the signed keys are listed
    * in `__`. Any `extraFields` ride along unsigned (e.g. `proid` on the stock
    * request). Used by both `product_price` and `product_stock`.
    * @param signedFields - Fields to sign (besides the injected `timestamp`)
    * @param extraFields - Additional fields included unsigned in the payload
    * @param timestamp - Cache-busting timestamp (defaults to now)
    * @returns The base64-encoded `params` string
    * @example
    * ```js
    * // product_price
    * this.makeSignedParams({ proid: "P000640099" });
    * // btoa(JSON.stringify({ timestamp, proid, _: "<sign>", __: ["timestamp", "proid"] }))
    * // product_stock
    * this.makeSignedParams({ bd: "BD21445" }, { proid: "P000325570" });
    * // btoa(JSON.stringify({ timestamp, bd, _: "<sign>", __: ["timestamp", "bd"], proid }))
    * ```
    * @source
    */
    protected makeSignedParams(
    signedFields: Record<string, JsonValue>,
    extraFields: Record<string, JsonValue> = {},
    timestamp: number = Date.now(),
    ): Base64String {
    const signed = { timestamp, ...signedFields };
    return btoa(
    JSON.stringify({
    ...signed,
    _: this.getSign(signed, 1),
    __: Object.keys(signed),
    ...extraFields,
    }),
    ) as Base64String;
    }

    /**
    * Ambeed cache-busting timestamp used in signed API payloads.
    * @returns Base-36 timestamp string
    * @source
    */
    protected getEncodedDate(timestamp: number = Date.now()): string {
    return base36Timestamp(timestamp);
    }

    /**
    * Ambeed request signature (deobfuscated from `getSign` in dev/ambeed3.js).
    *
    * @param data - Mode `1`: plain object signed as a query string. Other modes: string input.
    * @param mode - `1` → Base64(MD5_hex(query + sign=secret)); else → MD5_hex(string + secret)
    * @returns Signature string
    * @source
    */
    protected getSign(data: Record<string, unknown> | string, mode: 0 | 1): string {
    if (mode === 1) {
    if (typeof data === 'string') {
    throw new Error('getSign mode 1 requires a plain object');
    }

    let query = objectToQueryString(data);
    query += (query ? '&sign=' : 'sign=') + this.signSecret;
    return base64EncodeUtf8(md5sum(query));
    }

    return md5sum(String(data) + this.signSecret);
    }

    /**
    *
    * Ambeed encodes all the prices in a different font (newwebfont/am-new.woff) than the rest
    * of the page which is stored as unicode characters in the API and their weird font
    * characters in the source, but displays just fine in the UI. For example, the API response
    * will have the price as `\u0142\u00c7\u00cd\u00a7\u00b6\u00ca\u00ca`, which in the source
    * is `łÇͧ¶ÊÊ`, but in the UI is displayed as `$143.00`.
    *
    * This conversion is just a simple character map lookup, which is stored at this.encodedPriceChars.
    *
    * @param str - The encoded price string
    * @returns The decoded price string
    * @example
    * ```js
    * console.log(
    * this.decodePrice("\u0142\u00c7\u00cd\u00a7\u00b6\u00ca\u00ca"),
    * this.decodePrice("\u0142\u00a7\u00f2\u00b6\u00ca\u00ca"),
    * this.decodePrice("\u0142\u00c7\u00ff\u00b6\u00ca\u00ca"),
    * this.decodePrice("\u0142\u00a7\u00cd\u010f\u00b6\u00ca\u00ca"),
    * this.decodePrice("\u0142\u00c7\u00ca\u00b6\u00ca\u00ca")
    * )
    * // $143.00 $36.00 $15.00 $347.00 $10.00
    * ```
    * @source
    */
    // protected decodePrice(encoded: string): string {
    // return encoded
    // .split("")
    // .map((char) => this.encodedPriceChars.get(char) || "")
    // .join("");
    // }

    protected decodeAmbeedFont(str: string): string {
    if (!str || typeof str !== 'string') {
    return str;
    }

    let out = '';
    for (const ch of str) {
    const cp = ch.codePointAt(0);
    out += cp !== undefined ? (AMBEED_FONT_MAP[cp] ?? ch) : ch;
    }
    return out;
    }

    /**
    * Decodes the price object values, which are encoded in the same font as the prices in the UI.
    * @param priceData - The price object to decode
    * @returns The decoded price object
    * @example
    * ```js
    * console.log(this.decodePriceObjectValues({
    * pr_usd: "\u0142\u00c7\u00cd\u00a7\u00b6\u00ca\u00ca",
    * pr_am: "A1144350",
    * vip_usd: "\u0142\u00a7\u00f2\u00b6\u00ca\u00ca",
    * discount_usd: "\u0142\u00c7\u00ff\u00b6\u00ca\u00ca",
    * pr_size: "1mg",
    * pr_id: 3255116
    * }))
    * // {
    * // pr_usd: "$143.00",
    * // pr_am: "A1144350",
    * // vip_usd: "$36.00",
    * // discount_usd: "$15.00",
    * // pr_size: "1mg",
    * // pr_id: 3255116
    * // }
    * ```
    * @source
    */
    protected decodePriceObjectValues(
    priceData: AmbeedProductListResponsePriceList,
    ): AmbeedProductListResponsePriceList {
    return {
    ...priceData,
    pr_usd: this.decodeAmbeedFont(priceData.pr_usd),
    vip_usd: this.decodeAmbeedFont(priceData.vip_usd),
    discount_usd: this.decodeAmbeedFont(priceData.discount_usd),
    };
    }

    /**
    * Sanitizes the searchable fields of a product, removing the <em></em> tags and decoding the prices.
    * @param product - The product to sanitize
    * @returns The sanitized product
    * @example
    * ```js
    * console.log(this.sanitizeSearchableFields({
    * p_name_en: "2-Ethoxyacetic <em>acid</em>",
    * p_proper_name3: "2-Ethoxyacetic <em>acid</em>",
    * p_cas: "108-24-7",
    * priceList: [
    * {
    * pr_usd: "\u0142\u00c7\u00cd\u00a7\u00b6\u00ca\u00ca",
    * pr_am: "A1144350",
    * vip_usd: "\u0142\u00a7\u00f2\u00b6\u00ca\u00ca",
    * discount_usd: "\u0142\u00c7\u00ff\u00b6\u00ca\u00ca",
    * pr_size: "1mg",
    * pr_id: 3255116
    * }
    * ]
    * }))
    * // {
    * // p_name_en: "2-Ethoxyacetic acid",
    * // p_proper_name3: "2-Ethoxyacetic acid",
    * // p_cas: "108-24-7",
    * // priceList: [
    * // {
    * // pr_usd: "$143.00",
    * // pr_am: "A1144350",
    * // vip_usd: "$36.00",
    * // discount_usd: "$15.00",
    * // pr_size: "1mg",
    * // pr_id: 3255116
    * // }
    * // ]
    * // }
    * ```
    * @source
    */
    protected sanitizeSearchableFields(
    product: AmbeedProductListResponseResultItem,
    ): AmbeedProductListResponseResultItem {
    if (product.priceList) {
    product.priceList = product.priceList.map(this.decodePriceObjectValues.bind(this));
    }
    return {
    ...product,
    p_bd: product.p_bd ?? '',
    p_id: product.p_id ?? '',
    p_name_en: product.p_name_en?.replace(/<\/?em>/g, ''),
    p_proper_name3: product.p_proper_name3?.replace(/<\/?em>/g, ''),
    p_cas: product.p_cas?.replace(/<\/?em>/g, ''),
    };
    }

    /**
    * Initializes the Ambeed session: sets the XSRF token, then aligns the
    * country cookie with the user's selected country (defaulting to
    * "United States" when none is stored).
    * @returns Resolves once the session cookies are set
    * @source
    */
    setup(): Promise<void> {
    return (async () => {
    await this.setXsrfToken();
    await this.setCountryCookie(await getUserCountryName());
    await this.getCountryCookie();
    })();
    }

    /**
    * The query params are sent over in a base64 encoded JSON.stringify of
    * ```js
    * params=btoa(JSON.stringify({ keyword: "sodium chloride" }))
    * params=btoa(JSON.stringify({ keyword: "acid", page:3 }))
    * ```
    * @source
    */
    protected async queryProducts(
    query: string,
    limit: number = this.limit,
    ): Promise<ProductBuilder<Product>[] | void> {
    const searchRequest: unknown = await this.httpGetJson({
    path: 'webapi/v1/productlistbykeyword',
    params: {
    params: this.makeQueryParams(query),
    },
    });

    assertIsAmbeedProductListResponse(searchRequest);

    // Sanitize the products, removing the <em></em> tags and decoding the prices.
    const products = searchRequest.value.result.map(this.sanitizeSearchableFields.bind(this));

    // Filter Ambeed's loose keyword results by the query type (CAS/formula/SMILES),
    // falling back to fuzzy name matching for plain-string queries.
    const fuzzedResults = this.filterByStructuredQuery(products);

    const slice = fuzzedResults.slice(0, limit);

    // Fetch every product's SDS document in a single batch request, then attach
    // each URL here (before queryProductsWithCache caches the builders) so the
    // SDS link is keyed/cached with the product. Products are keyed by `p_am`,
    // which initProductBuilders stores as the builder's UUID.
    const sdsByAm = await this.getSdsUrls(mapDefined(slice, (product) => product.p_am));
    const builders = this.initProductBuilders(slice);
    for (const builder of builders) {
    const pAm = builder.get('uuid');
    builder.setSDSUrl(typeof pAm === 'string' ? sdsByAm[pAm] : undefined);
    }

    return builders;
    }

    /**
    * Filters Ambeed's loose keyword results down to genuine matches using the
    * *type* of the query. Ambeed's `productlistbykeyword` matches a term as both a
    * name substring and (for a valid SMILES) a structure fragment, so a query like
    * `CCO` returns unrelated compounds. This routes by query type:
    * - CAS terms match the product `p_cas`,
    * - formula terms match the (de-HTML'd) `p_moleform`,
    * - SMILES terms are matched via their resolved CAS/name (resolved once upstream
    * by `SupplierFactory` and shared through `resolvedStructures`),
    * - plain-string queries fall back to the existing fuzzy name filter unchanged.
    *
    * Matching reuses the advanced-search AST evaluator, so boolean (AND/OR/NOT)
    * queries are honored: each item is scored against an augmented target built
    * from its name, CAS, and formula.
    *
    * @param items - The sanitized Ambeed product items to filter.
    * @returns The items whose identity matches the query, best score first.
    * @example
    * ```typescript
    * // query "1286754-10-6" -> only the item whose p_cas is 1286754-10-6
    * this.filterByStructuredQuery(items);
    * ```
    * @source
    */
    protected filterByStructuredQuery(
    items: AmbeedProductListResponseResultItem[],
    ): AmbeedProductListResponseResultItem[] {
    const parsed = this.getAst();
    const isStructured = extractAllPositiveTerms(parsed.ast).some(
    (term) => detectTermType(term) !== 'string' || looksLikeSmiles(term),
    );

    // Plain name queries keep today's fuzzy behavior untouched.
    if (!isStructured) {
    return this.fuzzyFilterAst<AmbeedProductListResponseResultItem>(items);
    }

    const ast = this.rewriteStructureLeaves(parsed.ast);
    const scorer = this.fuzzScorerOverride ?? this.fuzzScorer;

    const scored = mapDefined(items, (item) => {
    const score = scoreAstMatch(this.buildMatchTarget(item), ast, {
    scorer,
    threshold: this.minMatchPercentage,
    fuzzyWords: false,
    });
    return score === null ? undefined : { item, score };
    });

    scored.sort((a, b) => b.score - a.score);
    // Stamp the AST score onto each item (like fuzzyFilterAst's plain-query path) so
    // initProductBuilders can carry it onto the Product via setMatchPercentage.
    return scored.map((entry, idx) => this.attachFuzz(entry.item, entry.score, idx));
    }

    /**
    * Builds the searchable text an Ambeed item is matched against: its display
    * name, English name, CAS, formula (`<sub>` markup stripped), and InChIKey.
    * Combining these lets CAS/formula/SMILES-resolved terms match the field that
    * actually identifies the compound rather than only the title.
    * @param item - The Ambeed product item.
    * @returns A single space-joined string of the item's identifying fields.
    * @example
    * ```typescript
    * this.buildMatchTarget(item); // "Mal-PEG4-AcCOOH 14-(...)acid 1286754-10-6 C14H21NO8 IBIJ..."
    * ```
    * @source
    */
    private buildMatchTarget(item: AmbeedProductListResponseResultItem): string {
    return [
    item.p_proper_name3,
    item.p_name_en,
    item.p_cas,
    item.p_moleform ? htmlToAscii(item.p_moleform) : '',
    item.p_inchikey,
    ]
    .filter((part): part is string => typeof part === 'string' && part.length > 0)
    .join(' ');
    }

    /**
    * Returns a copy of the query AST with every SMILES leaf replaced by an OR of
    * its resolved identifiers (CAS numbers and name), looked up from
    * `resolvedStructures`. A SMILES leaf with no resolution is left unchanged and a
    * warning is logged, so matching degrades to the raw term. Non-SMILES leaves
    * (CAS, formula, plain strings) are returned as-is.
    * @param ast - The parsed query AST.
    * @returns A new AST with SMILES leaves rewritten to their resolved identifiers.
    * @source
    */
    private rewriteStructureLeaves(ast: SearchAst): SearchAst {
    switch (ast.type) {
    case 'term': {
    if (ast.value === '' || !looksLikeSmiles(ast.value)) {
    return ast;
    }
    const resolved = this.resolvedStructures?.get(ast.value);
    const identifiers = [...(resolved?.cas ?? []), ...(resolved?.name ? [resolved.name] : [])];
    if (identifiers.length === 0) {
    this.logger.warn('No resolved structure for SMILES term; matching raw term', {
    term: ast.value,
    });
    return ast;
    }
    return this.orTerms(identifiers);
    }
    case 'and':
    return {
    type: 'and',
    left: this.rewriteStructureLeaves(ast.left),
    right: this.rewriteStructureLeaves(ast.right),
    };
    case 'or':
    return {
    type: 'or',
    left: this.rewriteStructureLeaves(ast.left),
    right: this.rewriteStructureLeaves(ast.right),
    };
    case 'not':
    return { type: 'not', operand: this.rewriteStructureLeaves(ast.operand) };
    default:
    return ast;
    }
    }

    /**
    * Combines a non-empty list of phrase strings into a right-leaning OR AST, so a
    * SMILES term that resolves to several identifiers matches any of them.
    * @param values - The identifier strings to OR together (must be non-empty).
    * @returns An OR-tree, or a single term node when only one value is given.
    * @example
    * ```typescript
    * this.orTerms(["64-17-5", "ethanol"]);
    * // { type: "or", left: {term 64-17-5}, right: {term ethanol} }
    * ```
    * @source
    */
    private orTerms(values: string[]): SearchAst {
    return values
    .map((value): SearchAst => ({ type: 'term', value, phrase: false }))
    .reduce((left, right) => ({ type: 'or', left, right }));
    }

    /**
    * Selects the title of a product from the search response
    * @param data - Product object from search response
    * @returns Title of the product
    * @source
    */
    protected titleSelector(data: AmbeedProductListResponseResultItem): string {
    return (data.p_proper_name3?.trim() || data.p_name_en?.trim()) ?? '';
    }

    /**
    * Initialize product builders from Ambeed search response data.
    * Transforms product listings into ProductBuilder instances, handling:
    * - Basic product information (title, URL, supplier)
    * - Product descriptions and content
    * - Product IDs and SKUs
    * - Availability status
    * - CAS number extraction from product content
    * - Quantity parsing from variant information
    * - Product codes and EANs
    *
    * @param data - Array of product listings from search results
    * @returns Array of ProductBuilder instances initialized with product data
    * @example
    * ```typescript
    * const results = await this.queryProducts("sodium chloride");
    * if (results) {
    * const builders = this.initProductBuilders(results);
    * // Each builder contains parsed product data
    * for (const builder of builders) {
    * const product = await builder.build();
    * console.log({
    * title: product.title,
    * price: product.price,
    * quantity: product.quantity,
    * uom: product.uom,
    * cas: product.cas
    * });
    * }
    * }
    * ```
    * @source
    */
    protected initProductBuilders(
    data: AmbeedProductListResponseResultItem[],
    ): ProductBuilder<Product>[] {
    return mapDefined(data, (product) => {
    const productBuilder = new ProductBuilder(this.baseURL);

    const productTitle = this.titleSelector(product);
    if (typeof product.priceList?.[0]?.pr_usd !== 'string') {
    this.logger.warn(`Ambeed product ${productTitle} has no price`, product);
    return;
    }

    if (typeof product.priceList?.[0]?.pr_size !== 'string') {
    this.logger.warn(`Ambeed product ${productTitle} has no size`, product);
    return;
    }

    productBuilder.setCAS(product.p_cas);
    productBuilder.setSpecSheetUrl(this.getSpecSheetUrl(product.p_am));

    for (const variant of product.priceList) {
    const parsedPrice = parsePrice(variant.pr_usd);
    const quantity = parseQuantity(variant.pr_size);

    if (!parsedPrice || !quantity) {
    this.logger.warn(
    `Failed to parse Ambeed product price for ${productTitle}`,
    product,
    variant,
    );
    continue;
    }

    productBuilder.addVariant({
    title: variant.pr_size,
    price: parsedPrice.price,
    currencyCode: parsedPrice.currencyCode,
    currencySymbol: parsedPrice.currencySymbol,
    quantity: quantity.quantity,
    uom: quantity.uom,
    sku: variant.pr_am,
    id: String(variant.pr_id),
    });
    }

    // Use the first variant as the main product. The ID will be wrong, but well overwrite it later.
    const mainVariant = productBuilder.getVariant(0);

    if (!mainVariant) {
    this.logger.warn(`Ambeed product ${productTitle} has no main variant`, product);
    return;
    }

    return productBuilder
    .setData(mainVariant as Partial<Product>)
    .setBasicInfo(productTitle, `/products/${product.s_url}`, this.supplierName)
    .setMatchPercentage(this.matchScoreOf(product))
    .setID(product.p_id)
    .setCacheKey(this.getUniqueProductKey(product))
    .setSku(product.p_bd)
    .setUUID(product.p_am)
    .setImage(product.p_proimg)
    .setPurity(product.p_purity)
    .setMoleweight(product.p_moleweight)
    .setFormula(product.p_moleform)
    .setDescription(product.p_name_en)
    .setSupplierCountry(this.country)
    .setSupplierShipping(this.shipping)
    .setCAS(product.p_cas);
    });
    }

    /**
    * Sets the country cookie for the Ambeed API.
    * @param country - The country to set the cookie for
    * @returns The country cookie
    * @source
    */
    protected async setCountryCookie(country: string = 'United States'): Promise<void> {
    await this.httpPostJson({
    path: '/webapi/v1/countrycookie',
    params: {
    params: btoa(JSON.stringify({ country })),
    },
    headers: {
    'content-type': 'application/x-www-form-urlencoded; charset=UTF-8',
    },
    });
    }

    /**
    * Gets the country cookie currently set for the Ambeed API.
    * @returns The country cookie response, or void if the request fails
    * @example
    * ```js
    * const countryCookie = await this.getCountryCookie();
    * console.log(countryCookie);
    * // { time: "...", lang: "en", source: 1, code: 200, value: { country: "United States" } }
    * ```
    * @source
    */
    protected async getCountryCookie(): Promise<Maybe<JsonValue>> {
    const countryCookie = await this.httpGetJson({
    path: '/webapi/v1/countrycookie',
    });

    return countryCookie;
    }

    /**
    * Extracts the priced variants from an Ambeed `product_price` response value.
    *
    * The variants live under a dynamic `${pr_bd}_${p_purity}` key (e.g.
    * `"BD41982_95%"`) that varies per product and can't be indexed by a plain
    * string, so this walks the entries and returns the first array-valued one,
    * skipping the `proInfo` block.
    *
    * @param value - The `value` object from an AmbeedProductPriceResponse
    * @returns The list of priced variants, or an empty array when none is present
    * @example
    * ```js
    * this.getPriceVariants(response.value);
    * // [{ pr_id: 3805067, pr_size: "1mg", pr_usd: "$10.00", ... }]
    * ```
    * @source
    */
    protected getPriceVariants(
    value: AmbeedProductPriceResponseValue,
    ): AmbeedProductPriceResponseVariantItem[] {
    for (const [key, entry] of Object.entries(value)) {
    if (key === 'proInfo' || !Array.isArray(entry)) {
    continue;
    }
    return entry;
    }
    return [];
    }

    /**
    * No real need to get the product data on a second page, the initial product listing
    * page has enough data.
    * @param product - The product builder to get data for
    * @returns The product builder
    * @source
    */
    protected async getProductData(
    product: ProductBuilder<Product>,
    ): Promise<ProductBuilder<Product> | void> {
    // /webapi/v1/product_price?params=btoa(JSON.stringify({ proid: "P000640099" }))
    const proid = String(product.get('id'));
    const productPriceParams = this.makeSignedParams({ proid });

    const productPriceResponse = await this.httpPostJson({
    path: `/webapi/v1/product_price`,
    params: {
    num: this.getEncodedDate(),
    },
    headers: {
    'Content-Type': 'application/x-www-form-urlencoded; charset=UTF-8',
    },
    body: new URLSearchParams({
    params: productPriceParams,
    _xsrf: this.xsrfToken,
    }).toString(),
    });

    if (!isAmbeedProductPriceResponse(productPriceResponse)) {
    this.logger.warn('Invalid Ambeed product price response', {
    productPriceParams,
    productPriceResponse,
    });
    return product;
    }

    const variants = this.getPriceVariants(productPriceResponse.value);
    this.logger.log('Ambeed product price variants', variants);

    const stock = await this.getProductStock(proid, String(product.get('sku')));
    if (stock) {
    this.applyStockAvailability(product, stock);
    }

    return product;
    }

    /**
    * Fetches per-size stock for a product from `webapi/product_stock` (note: this
    * endpoint is unversioned, unlike `product_price`). Signs the batch id (`bd`)
    * and carries the product id (`proid`) unsigned. Stock is enrichment, not core
    * data, so a failed/blocked request degrades to "no stock info" rather than
    * throwing and taking down the whole product.
    * @param proid - The product ID (`p_id`)
    * @param bd - The batch ID (`p_bd`)
    * @returns The array of per-size stock rows, or undefined if the request fails or is invalid
    * @example
    * ```js
    * const stock = await this.getProductStock("P000325570", "BD21445");
    * console.log(stock?.[0]); // { size: "25g", has_stock: 2, ... }
    * ```
    * @source
    */
    private async getProductStock(
    proid: string,
    bd: string,
    ): Promise<AmbeedProductStockResponse['value'] | undefined> {
    const productStockParams = this.makeSignedParams({ bd }, { proid });

    let response: unknown;
    try {
    response = await this.httpPostJson({
    path: '/webapi/product_stock',
    headers: {
    'Content-Type': 'application/x-www-form-urlencoded; charset=UTF-8',
    },
    body: new URLSearchParams({
    params: productStockParams,
    _xsrf: this.xsrfToken,
    }).toString(),
    });
    } catch (error) {
    this.logger.warn('Ambeed stock request failed; continuing without stock', {
    error,
    proid,
    bd,
    });
    return;
    }

    if (!isAmbeedProductStockResponse(response)) {
    this.logger.warn('Invalid Ambeed product stock response', {
    productStockParams,
    response,
    });
    return;
    }

    return response.value;
    }

    /**
    * Applies stock availability to a product's variants and to the product
    * itself. Builds a set of in-stock size keys (`${quantity}${uom}`) from rows
    * with `has_stock > 0`, then marks each variant IN_STOCK/OUT_OF_STOCK by
    * matching its quantity+uom. The product is IN_STOCK if any variant is.
    * @param product - The product builder to update
    * @param stock - The per-size stock rows from `getProductStock`
    * @returns The same product builder, for chaining
    * @example
    * ```js
    * this.applyStockAvailability(builder, [{ size: "25g", has_stock: 2, ... }]);
    * // builder's "25g" variant -> AVAILABILITY.IN_STOCK
    * ```
    * @source
    */
    private applyStockAvailability(
    product: ProductBuilder<Product>,
    stock: AmbeedProductStockResponse['value'],
    ): ProductBuilder<Product> {
    const inStockSizes = new Set<string>();
    for (const row of stock) {
    if (typeof row.has_stock === 'number' && row.has_stock > 0) {
    const parsed = parseQuantity(row.size);
    if (parsed) {
    inStockSizes.add(`${parsed.quantity}${parsed.uom}`);
    }
    }
    }

    const variants = product.get('variants');
    if (!Array.isArray(variants)) {
    return product;
    }

    let anyInStock = false;
    const updated = variants.map((variant) => {
    const inStock = inStockSizes.has(`${variant.quantity}${variant.uom}`);
    anyInStock ||= inStock;
    return {
    ...variant,
    availability: inStock ? AVAILABILITY.IN_STOCK : AVAILABILITY.OUT_OF_STOCK,
    };
    });

    return product.setVariants(updated).setAvailability(anyInStock);
    }
    /**
    * Fetches the product matched by a CAS number along with Ambeed's recommended
    * products for that CAS.
    * @param cas - The CAS number to look up
    * @returns The validated CAS search response
    * @throws Error if the response does not match the expected structure
    * @example
    * ```js
    * const response = await this.getSearchProductAndRecommendedProductsByCAS("108-24-7");
    * console.log(response.value.search_pro_dict.p_name_en);
    * // "Acetic anhydride"
    * console.log(response.value.r_pro_list.length);
    * // 12
    * ```
    * @source
    */
    protected async getSearchProductAndRecommendedProductsByCAS(
    cas: string,
    ): Promise<AmbeedGetSearchProductAndRecommendedProductsByCASResponse> {
    const response = await this.httpPostJson({
    path: '/webapi/v1/get_search_product_and_recommended_products_by_cas',
    params: {
    params: btoa(JSON.stringify({ cas })),
    },
    headers: {
    'Content-Type': 'application/x-www-form-urlencoded; charset=UTF-8',
    },
    });

    assertIsAmbeedGetSearchProductAndRecommendedProductsByCASResponse(response);
    return response;
    }
    }

    Hierarchy (View Summary)

    Implements

    Index

    Accessors

    Constructors

    Methods

    Properties

    Accessors

    • get supplierClass(): typeof SupplierBase

      This supplier's own class, typed for static metadata access. this.constructor is otherwise typed Function (no custom statics), so the instance getters below read the concrete class's static fields through this narrowed view.

      Returns typeof SupplierBase

    • get shipsTo(): undefined | valueof<any>[]

      Instance view of the static shipsTo allowlist (keeps this.shipsTo working).

      Returns undefined | valueof<any>[]

    • get apiURL(): undefined | string

      Instance view of the static apiURL (keeps this.apiURL working).

      Returns undefined | string

    • get requiredHosts(): string[]

      All host origin patterns required for this supplier to function. Automatically includes baseURL and, if defined, apiURL. Used by the factory to check chrome permissions before querying.

      Returns string[]

    • get effectiveQuery(): string

      The single query term this supplier should search by. Normally the raw query, but when the query is a CAS/formula/SMILES identifier the supplier can't search for itself (per supportsCAS/supportsFormula/supportsSMILES) and the factory resolved it, it's the broadest resolved name — the one likely to yield the most store results — so a name-only supplier can answer "Na6O18P6" by searching "Sodium hexametaphosphate". Matching then scores results against every candidate (see effectiveQueryCandidates/fuzzyScore). Falls back to the raw query when the type is supported, the query is a plain name, or nothing was resolved.

      Returns string

      The effective search query.

      // this.query === "10124-56-8", supportsCAS === false, resolved names available
      this.effectiveQuery; // "Sodium hexametaphosphate"

    Constructors

    • Creates a new instance of the supplier base class. Initializes the supplier with query parameters, request limits, and abort controller. Sets up logging and default product values.

      Parameters

      • query: string

        The search term to query products for

      • limit: number = search.defaultResultsLimitPerSupplier

        The maximum number of results to return (default: 5)

      • Optionalcontroller: AbortController

        AbortController instance for managing request cancellation

      Returns SupplierAmbeed

      // Create a supplier with default limit
      const supplier = new MySupplier("sodium chloride", undefined, new AbortController());

      // Create a supplier with custom limit
      const supplier = new MySupplier("acetone", 10, new AbortController());

      // Create a supplier and handle cancellation
      const controller = new AbortController();
      const supplier = new MySupplier("ethanol", 5, controller);

      // Later, to cancel all pending requests:
      controller.abort();

    Methods

    • Derives the unique product key from an Ambeed product item: its p_am, the per-listing article id (the ?am= in the product URL and the pr_am on every price row). NOT p_id — that identifies the compound (≈ CAS), which Ambeed lists under multiple brands, each a distinct p_am/URL. Keying on p_id collapses those separate listings onto one key, corrupting the per-product detail cache and tripping the duplicate-results detector. Size variants remain distinguished by their own pr_id (variant.id). Falls back to p_id only when p_am is absent.

      Parameters

      Returns string

      The product's p_am (per-listing article id)

      this.getUniqueProductKey(product); // "A112492"
      
        protected getUniqueProductKey(data: AmbeedProductListResponseResultItem): string {
      return String(data.p_am || data.p_id);
      }
    • Calculates the sign secret for the Ambeed API.

      Returns string

      The sign secret

      console.log(this.calculateSignSecret());
      // "6587ab544f254fe4a5f64a41531b95b2"
        protected calculateSignSecret(): string {
      /** Obfuscation alphabet constants from Ambeed's `f1()` signer. */
      const forwardAlphabet = 'abcdefghijklmnopqrstuvwxyz';
      const reversedAlphabet = 'zyxwvutsrqponmlkjihgfedcba';
      const embeddedFragmentA = '7ab544f2'; // RC4 0x6a, key "&$SR"
      const embeddedFragmentB = 'fe4a5f64a41531b'; // RC4 0x80, key "W61u"
      return (
      String(forwardAlphabet.indexOf('g')) + // "6"
      String(forwardAlphabet.indexOf('f')) + // "5"
      String(reversedAlphabet.indexOf('y') * 8) + // "8"
      embeddedFragmentA +
      String(Math.pow(reversedAlphabet.indexOf('t'), 2) + 18) + // "54"
      embeddedFragmentB +
      String(Math.pow(forwardAlphabet.indexOf('k'), 2) - 5) + // "95"
      'b2'
      );
      }
    • Sets the XSRF token if it's not already set. Checks the browser cookies first, and if the token isn't there, makes a request to the base URL to have the backend plant it, then reads it back from the cookies.

      Returns Promise<void>

      await this.setXsrfToken();
      console.log(this.xsrfToken);
      // "2|d4c7158a|d58bc32de23d069be88c542ddebdacb5|1782230077"
        protected async setXsrfToken(): Promise<void> {
      if (this.xsrfToken) {
      return;
      }

      let cookie = await getCookie(this.baseURL, '_xsrf');
      if (cookie) {
      this.xsrfToken = cookie.value;
      return;
      }

      await this.httpGetHtml({
      path: '/',
      });

      cookie = await getCookie(this.baseURL, '_xsrf');
      if (cookie) {
      this.xsrfToken = cookie.value;
      return;
      }

      this.xsrfToken = '';
      return;
      }
    • Makes the query params for the Ambeed API.

      Parameters

      • query: string

        The query to make the query params for

      Returns Base64String

      The query params

      Add

      console.log(this.makeQueryParams("sodium chloride"));
      // "btoa(JSON.stringify({ keyword: "sodium chloride" }))"
        protected makeQueryParams(query: string): Base64String {
      // btoa returns a plain string; cast brands it as Base64String (a nominal Brand type).
      return btoa(JSON.stringify({ keyword: query })) as Base64String;
      }
    • Resolves the SDS document "type" to prefer for the current user, based on their saved location (country) and language settings. European users get a sdsJsonEurope (amgm-*) type matched to their language; everyone else gets the country-specific sdsJson type. Falls back to English (am) when there's no match.

      Returns Promise<string>

      The Ambeed SDS type string (e.g. "amgm-de-de", "am-cn", "am")

      await this.getSdsType(); // user in Germany, language "de" -> "amgm-de-de"
      
        private async getSdsType(): Promise<string> {
      const stored = await cstorage.local.get([CACHE.USER_SETTINGS]);
      const settings = (stored[CACHE.USER_SETTINGS] ?? {}) as Partial<UserSettings>;

      const country = (settings.location ?? '').toUpperCase();
      const language = (settings.language ?? getUserLanguage()).split('-')[0].toLowerCase();

      if (EUROPEAN_COUNTRY_CODES.has(country)) {
      if (country === 'GB') {
      return sdsJsonEurope['SDS-UK-EN'].type;
      }
      const suffix = LANGUAGE_TO_EU_SDS_SUFFIX[language] ?? 'EN';
      const key = `SDS-EU-${suffix}` as keyof typeof sdsJsonEurope;
      return (sdsJsonEurope[key] ?? sdsJsonEurope['SDS-EU-EN']).type;
      }

      const key = `SDS-${country}` as keyof typeof sdsJson;
      return (sdsJson[key] ?? sdsJson['SDS-US']).type;
      }
    • Fetches SDS documents for many products in a single batch request and returns a map of AM id (p_am) → SDS PDF URL. Requests the user's preferred SDS type plus English (am) as a fallback; for each product the preferred type's URL wins, falling back to am.

      Parameters

      • amNos: string[]

        The product AM ids (p_am) to fetch SDS documents for

      Returns Promise<Record<string, string>>

      A map of p_am → SDS URL (only products with an available SDS)

      await this.getSdsUrls(["A491321", "A1159477"]);
      // { A491321: "https://.../SDS-A491321.pdf", A1159477: "https://.../SDS-A1159477.pdf" }
        private async getSdsUrls(amNos: string[]): Promise<Record<string, string>> {
      if (amNos.length === 0) {
      return {};
      }

      const sdsType = await this.getSdsType();
      const reqBody = {
      am_nos: amNos,
      request_type: Array.from(new Set([sdsType, SDS_TYPE_FALLBACK])),
      };

      // SDS URLs are enrichment, not core data — a failed/blocked request must not take down the
      // whole supplier. Degrade to "no SDS links" instead of throwing.
      let response: unknown;
      try {
      response = await this.httpPostJson({
      path: 'webapi/v1/getPmsSdsByAms',
      params: {
      params: btoa(JSON.stringify(reqBody)),
      },
      headers: {
      'Content-Type': 'application/x-www-form-urlencoded; charset=UTF-8',
      },
      });
      } catch (error) {
      this.logger.warn('Ambeed SDS request failed; continuing without SDS URLs', { error, amNos });
      return {};
      }

      if (!isAmbeedGetPmsSdsByAmsResponse(response)) {
      this.logger.warn('Invalid Ambeed SDS response', { amNos, response });
      return {};
      }

      const urls: Record<string, string> = {};
      for (const [am, byType] of Object.entries(response.value.sds_list)) {
      const preferred = byType[sdsType];
      const fallback = byType[SDS_TYPE_FALLBACK];
      const url =
      preferred?.status && preferred.url
      ? preferred.url
      : fallback?.status && fallback.url
      ? fallback.url
      : undefined;
      if (url) {
      urls[am] = url;
      }
      }
      return urls;
      }
    • Construct spec sheet URL from product id

      Parameters

      • proid: string

        The product ID

      Returns string

      The spec sheet URL

      console.log(this.getSpecSheetUrl("A806610"));
      // "/product-details/specification/A806610"
        private getSpecSheetUrl(proid: string): string {
      return this.href(`/product-details/specification/${proid}`);
      }
    • Builds a base64-encoded, signed Ambeed API params payload. The timestamp is injected and signed alongside signedFields; the signed keys are listed in __. Any extraFields ride along unsigned (e.g. proid on the stock request). Used by both product_price and product_stock.

      Parameters

      • signedFields: Record<string, JsonValue>

        Fields to sign (besides the injected timestamp)

      • extraFields: Record<string, JsonValue> = {}

        Additional fields included unsigned in the payload

      • timestamp: number = ...

        Cache-busting timestamp (defaults to now)

      Returns Base64String

      The base64-encoded params string

      // product_price
      this.makeSignedParams({ proid: "P000640099" });
      // btoa(JSON.stringify({ timestamp, proid, _: "<sign>", __: ["timestamp", "proid"] }))
      // product_stock
      this.makeSignedParams({ bd: "BD21445" }, { proid: "P000325570" });
      // btoa(JSON.stringify({ timestamp, bd, _: "<sign>", __: ["timestamp", "bd"], proid }))
        protected makeSignedParams(
      signedFields: Record<string, JsonValue>,
      extraFields: Record<string, JsonValue> = {},
      timestamp: number = Date.now(),
      ): Base64String {
      const signed = { timestamp, ...signedFields };
      return btoa(
      JSON.stringify({
      ...signed,
      _: this.getSign(signed, 1),
      __: Object.keys(signed),
      ...extraFields,
      }),
      ) as Base64String;
      }
    • Ambeed cache-busting timestamp used in signed API payloads.

      Parameters

      • timestamp: number = ...

      Returns string

      Base-36 timestamp string

        protected getEncodedDate(timestamp: number = Date.now()): string {
      return base36Timestamp(timestamp);
      }
    • Ambeed request signature (deobfuscated from getSign in dev/ambeed3.js).

      Parameters

      • data: string | Record<string, unknown>

        Mode 1: plain object signed as a query string. Other modes: string input.

      • mode: 0 | 1

        1 → Base64(MD5_hex(query + sign=secret)); else → MD5_hex(string + secret)

      Returns string

      Signature string

        protected getSign(data: Record<string, unknown> | string, mode: 0 | 1): string {
      if (mode === 1) {
      if (typeof data === 'string') {
      throw new Error('getSign mode 1 requires a plain object');
      }

      let query = objectToQueryString(data);
      query += (query ? '&sign=' : 'sign=') + this.signSecret;
      return base64EncodeUtf8(md5sum(query));
      }

      return md5sum(String(data) + this.signSecret);
      }
    • Ambeed encodes all the prices in a different font (newwebfont/am-new.woff) than the rest of the page which is stored as unicode characters in the API and their weird font characters in the source, but displays just fine in the UI. For example, the API response will have the price as \u0142\u00c7\u00cd\u00a7\u00b6\u00ca\u00ca, which in the source is łÇͧ¶ÊÊ, but in the UI is displayed as $143.00.

      This conversion is just a simple character map lookup, which is stored at this.encodedPriceChars.

      Parameters

      • str: string

        The encoded price string

      Returns string

      The decoded price string

      console.log(
      this.decodePrice("\u0142\u00c7\u00cd\u00a7\u00b6\u00ca\u00ca"),
      this.decodePrice("\u0142\u00a7\u00f2\u00b6\u00ca\u00ca"),
      this.decodePrice("\u0142\u00c7\u00ff\u00b6\u00ca\u00ca"),
      this.decodePrice("\u0142\u00a7\u00cd\u010f\u00b6\u00ca\u00ca"),
      this.decodePrice("\u0142\u00c7\u00ca\u00b6\u00ca\u00ca")
      )
      // $143.00 $36.00 $15.00 $347.00 $10.00
        protected decodeAmbeedFont(str: string): string {
      if (!str || typeof str !== 'string') {
      return str;
      }

      let out = '';
      for (const ch of str) {
      const cp = ch.codePointAt(0);
      out += cp !== undefined ? (AMBEED_FONT_MAP[cp] ?? ch) : ch;
      }
      return out;
      }
    • Decodes the price object values, which are encoded in the same font as the prices in the UI.

      Parameters

      Returns AmbeedProductListResponsePriceList

      The decoded price object

      console.log(this.decodePriceObjectValues({
      pr_usd: "\u0142\u00c7\u00cd\u00a7\u00b6\u00ca\u00ca",
      pr_am: "A1144350",
      vip_usd: "\u0142\u00a7\u00f2\u00b6\u00ca\u00ca",
      discount_usd: "\u0142\u00c7\u00ff\u00b6\u00ca\u00ca",
      pr_size: "1mg",
      pr_id: 3255116
      }))
      // {
      // pr_usd: "$143.00",
      // pr_am: "A1144350",
      // vip_usd: "$36.00",
      // discount_usd: "$15.00",
      // pr_size: "1mg",
      // pr_id: 3255116
      // }
        protected decodePriceObjectValues(
      priceData: AmbeedProductListResponsePriceList,
      ): AmbeedProductListResponsePriceList {
      return {
      ...priceData,
      pr_usd: this.decodeAmbeedFont(priceData.pr_usd),
      vip_usd: this.decodeAmbeedFont(priceData.vip_usd),
      discount_usd: this.decodeAmbeedFont(priceData.discount_usd),
      };
      }
    • Sanitizes the searchable fields of a product, removing the tags and decoding the prices.

      Parameters

      Returns AmbeedProductListResponseResultItem

      The sanitized product

      console.log(this.sanitizeSearchableFields({
      p_name_en: "2-Ethoxyacetic <em>acid</em>",
      p_proper_name3: "2-Ethoxyacetic <em>acid</em>",
      p_cas: "108-24-7",
      priceList: [
      {
      pr_usd: "\u0142\u00c7\u00cd\u00a7\u00b6\u00ca\u00ca",
      pr_am: "A1144350",
      vip_usd: "\u0142\u00a7\u00f2\u00b6\u00ca\u00ca",
      discount_usd: "\u0142\u00c7\u00ff\u00b6\u00ca\u00ca",
      pr_size: "1mg",
      pr_id: 3255116
      }
      ]
      }))
      // {
      // p_name_en: "2-Ethoxyacetic acid",
      // p_proper_name3: "2-Ethoxyacetic acid",
      // p_cas: "108-24-7",
      // priceList: [
      // {
      // pr_usd: "$143.00",
      // pr_am: "A1144350",
      // vip_usd: "$36.00",
      // discount_usd: "$15.00",
      // pr_size: "1mg",
      // pr_id: 3255116
      // }
      // ]
      // }
        protected sanitizeSearchableFields(
      product: AmbeedProductListResponseResultItem,
      ): AmbeedProductListResponseResultItem {
      if (product.priceList) {
      product.priceList = product.priceList.map(this.decodePriceObjectValues.bind(this));
      }
      return {
      ...product,
      p_bd: product.p_bd ?? '',
      p_id: product.p_id ?? '',
      p_name_en: product.p_name_en?.replace(/<\/?em>/g, ''),
      p_proper_name3: product.p_proper_name3?.replace(/<\/?em>/g, ''),
      p_cas: product.p_cas?.replace(/<\/?em>/g, ''),
      };
      }
    • Initializes the Ambeed session: sets the XSRF token, then aligns the country cookie with the user's selected country (defaulting to "United States" when none is stored).

      Returns Promise<void>

      Resolves once the session cookies are set

        setup(): Promise<void> {
      return (async () => {
      await this.setXsrfToken();
      await this.setCountryCookie(await getUserCountryName());
      await this.getCountryCookie();
      })();
      }
    • The query params are sent over in a base64 encoded JSON.stringify of

      params=btoa(JSON.stringify({ keyword: "sodium chloride" }))
      params=btoa(JSON.stringify({ keyword: "acid", page:3 }))

      Parameters

      • query: string
      • limit: number = ...

      Returns Promise<void | ProductBuilder<Product>[]>

        protected async queryProducts(
      query: string,
      limit: number = this.limit,
      ): Promise<ProductBuilder<Product>[] | void> {
      const searchRequest: unknown = await this.httpGetJson({
      path: 'webapi/v1/productlistbykeyword',
      params: {
      params: this.makeQueryParams(query),
      },
      });

      assertIsAmbeedProductListResponse(searchRequest);

      // Sanitize the products, removing the <em></em> tags and decoding the prices.
      const products = searchRequest.value.result.map(this.sanitizeSearchableFields.bind(this));

      // Filter Ambeed's loose keyword results by the query type (CAS/formula/SMILES),
      // falling back to fuzzy name matching for plain-string queries.
      const fuzzedResults = this.filterByStructuredQuery(products);

      const slice = fuzzedResults.slice(0, limit);

      // Fetch every product's SDS document in a single batch request, then attach
      // each URL here (before queryProductsWithCache caches the builders) so the
      // SDS link is keyed/cached with the product. Products are keyed by `p_am`,
      // which initProductBuilders stores as the builder's UUID.
      const sdsByAm = await this.getSdsUrls(mapDefined(slice, (product) => product.p_am));
      const builders = this.initProductBuilders(slice);
      for (const builder of builders) {
      const pAm = builder.get('uuid');
      builder.setSDSUrl(typeof pAm === 'string' ? sdsByAm[pAm] : undefined);
      }

      return builders;
      }
    • Filters Ambeed's loose keyword results down to genuine matches using the type of the query. Ambeed's productlistbykeyword matches a term as both a name substring and (for a valid SMILES) a structure fragment, so a query like CCO returns unrelated compounds. This routes by query type:

      • CAS terms match the product p_cas,
      • formula terms match the (de-HTML'd) p_moleform,
      • SMILES terms are matched via their resolved CAS/name (resolved once upstream by SupplierFactory and shared through resolvedStructures),
      • plain-string queries fall back to the existing fuzzy name filter unchanged.

      Matching reuses the advanced-search AST evaluator, so boolean (AND/OR/NOT) queries are honored: each item is scored against an augmented target built from its name, CAS, and formula.

      Parameters

      Returns AmbeedProductListResponseResultItem[]

      The items whose identity matches the query, best score first.

      // query "1286754-10-6" -> only the item whose p_cas is 1286754-10-6
      this.filterByStructuredQuery(items);
        protected filterByStructuredQuery(
      items: AmbeedProductListResponseResultItem[],
      ): AmbeedProductListResponseResultItem[] {
      const parsed = this.getAst();
      const isStructured = extractAllPositiveTerms(parsed.ast).some(
      (term) => detectTermType(term) !== 'string' || looksLikeSmiles(term),
      );

      // Plain name queries keep today's fuzzy behavior untouched.
      if (!isStructured) {
      return this.fuzzyFilterAst<AmbeedProductListResponseResultItem>(items);
      }

      const ast = this.rewriteStructureLeaves(parsed.ast);
      const scorer = this.fuzzScorerOverride ?? this.fuzzScorer;

      const scored = mapDefined(items, (item) => {
      const score = scoreAstMatch(this.buildMatchTarget(item), ast, {
      scorer,
      threshold: this.minMatchPercentage,
      fuzzyWords: false,
      });
      return score === null ? undefined : { item, score };
      });

      scored.sort((a, b) => b.score - a.score);
      // Stamp the AST score onto each item (like fuzzyFilterAst's plain-query path) so
      // initProductBuilders can carry it onto the Product via setMatchPercentage.
      return scored.map((entry, idx) => this.attachFuzz(entry.item, entry.score, idx));
      }
    • Builds the searchable text an Ambeed item is matched against: its display name, English name, CAS, formula (<sub> markup stripped), and InChIKey. Combining these lets CAS/formula/SMILES-resolved terms match the field that actually identifies the compound rather than only the title.

      Parameters

      Returns string

      A single space-joined string of the item's identifying fields.

      this.buildMatchTarget(item); // "Mal-PEG4-AcCOOH 14-(...)acid 1286754-10-6 C14H21NO8 IBIJ..."
      
        private buildMatchTarget(item: AmbeedProductListResponseResultItem): string {
      return [
      item.p_proper_name3,
      item.p_name_en,
      item.p_cas,
      item.p_moleform ? htmlToAscii(item.p_moleform) : '',
      item.p_inchikey,
      ]
      .filter((part): part is string => typeof part === 'string' && part.length > 0)
      .join(' ');
      }
    • Returns a copy of the query AST with every SMILES leaf replaced by an OR of its resolved identifiers (CAS numbers and name), looked up from resolvedStructures. A SMILES leaf with no resolution is left unchanged and a warning is logged, so matching degrades to the raw term. Non-SMILES leaves (CAS, formula, plain strings) are returned as-is.

      Parameters

      Returns SearchAst

      A new AST with SMILES leaves rewritten to their resolved identifiers.

        private rewriteStructureLeaves(ast: SearchAst): SearchAst {
      switch (ast.type) {
      case 'term': {
      if (ast.value === '' || !looksLikeSmiles(ast.value)) {
      return ast;
      }
      const resolved = this.resolvedStructures?.get(ast.value);
      const identifiers = [...(resolved?.cas ?? []), ...(resolved?.name ? [resolved.name] : [])];
      if (identifiers.length === 0) {
      this.logger.warn('No resolved structure for SMILES term; matching raw term', {
      term: ast.value,
      });
      return ast;
      }
      return this.orTerms(identifiers);
      }
      case 'and':
      return {
      type: 'and',
      left: this.rewriteStructureLeaves(ast.left),
      right: this.rewriteStructureLeaves(ast.right),
      };
      case 'or':
      return {
      type: 'or',
      left: this.rewriteStructureLeaves(ast.left),
      right: this.rewriteStructureLeaves(ast.right),
      };
      case 'not':
      return { type: 'not', operand: this.rewriteStructureLeaves(ast.operand) };
      default:
      return ast;
      }
      }
    • Combines a non-empty list of phrase strings into a right-leaning OR AST, so a SMILES term that resolves to several identifiers matches any of them.

      Parameters

      • values: string[]

        The identifier strings to OR together (must be non-empty).

      Returns SearchAst

      An OR-tree, or a single term node when only one value is given.

      this.orTerms(["64-17-5", "ethanol"]);
      // { type: "or", left: {term 64-17-5}, right: {term ethanol} }
        private orTerms(values: string[]): SearchAst {
      return values
      .map((value): SearchAst => ({ type: 'term', value, phrase: false }))
      .reduce((left, right) => ({ type: 'or', left, right }));
      }
    • Initialize product builders from Ambeed search response data. Transforms product listings into ProductBuilder instances, handling:

      • Basic product information (title, URL, supplier)
      • Product descriptions and content
      • Product IDs and SKUs
      • Availability status
      • CAS number extraction from product content
      • Quantity parsing from variant information
      • Product codes and EANs

      Parameters

      Returns ProductBuilder<Product>[]

      Array of ProductBuilder instances initialized with product data

      const results = await this.queryProducts("sodium chloride");
      if (results) {
      const builders = this.initProductBuilders(results);
      // Each builder contains parsed product data
      for (const builder of builders) {
      const product = await builder.build();
      console.log({
      title: product.title,
      price: product.price,
      quantity: product.quantity,
      uom: product.uom,
      cas: product.cas
      });
      }
      }
        protected initProductBuilders(
      data: AmbeedProductListResponseResultItem[],
      ): ProductBuilder<Product>[] {
      return mapDefined(data, (product) => {
      const productBuilder = new ProductBuilder(this.baseURL);

      const productTitle = this.titleSelector(product);
      if (typeof product.priceList?.[0]?.pr_usd !== 'string') {
      this.logger.warn(`Ambeed product ${productTitle} has no price`, product);
      return;
      }

      if (typeof product.priceList?.[0]?.pr_size !== 'string') {
      this.logger.warn(`Ambeed product ${productTitle} has no size`, product);
      return;
      }

      productBuilder.setCAS(product.p_cas);
      productBuilder.setSpecSheetUrl(this.getSpecSheetUrl(product.p_am));

      for (const variant of product.priceList) {
      const parsedPrice = parsePrice(variant.pr_usd);
      const quantity = parseQuantity(variant.pr_size);

      if (!parsedPrice || !quantity) {
      this.logger.warn(
      `Failed to parse Ambeed product price for ${productTitle}`,
      product,
      variant,
      );
      continue;
      }

      productBuilder.addVariant({
      title: variant.pr_size,
      price: parsedPrice.price,
      currencyCode: parsedPrice.currencyCode,
      currencySymbol: parsedPrice.currencySymbol,
      quantity: quantity.quantity,
      uom: quantity.uom,
      sku: variant.pr_am,
      id: String(variant.pr_id),
      });
      }

      // Use the first variant as the main product. The ID will be wrong, but well overwrite it later.
      const mainVariant = productBuilder.getVariant(0);

      if (!mainVariant) {
      this.logger.warn(`Ambeed product ${productTitle} has no main variant`, product);
      return;
      }

      return productBuilder
      .setData(mainVariant as Partial<Product>)
      .setBasicInfo(productTitle, `/products/${product.s_url}`, this.supplierName)
      .setMatchPercentage(this.matchScoreOf(product))
      .setID(product.p_id)
      .setCacheKey(this.getUniqueProductKey(product))
      .setSku(product.p_bd)
      .setUUID(product.p_am)
      .setImage(product.p_proimg)
      .setPurity(product.p_purity)
      .setMoleweight(product.p_moleweight)
      .setFormula(product.p_moleform)
      .setDescription(product.p_name_en)
      .setSupplierCountry(this.country)
      .setSupplierShipping(this.shipping)
      .setCAS(product.p_cas);
      });
      }
    • Sets the country cookie for the Ambeed API.

      Parameters

      • country: string = 'United States'

        The country to set the cookie for

      Returns Promise<void>

      The country cookie

        protected async setCountryCookie(country: string = 'United States'): Promise<void> {
      await this.httpPostJson({
      path: '/webapi/v1/countrycookie',
      params: {
      params: btoa(JSON.stringify({ country })),
      },
      headers: {
      'content-type': 'application/x-www-form-urlencoded; charset=UTF-8',
      },
      });
      }
    • Gets the country cookie currently set for the Ambeed API.

      Returns Promise<Maybe<JsonValue>>

      The country cookie response, or void if the request fails

      const countryCookie = await this.getCountryCookie();
      console.log(countryCookie);
      // { time: "...", lang: "en", source: 1, code: 200, value: { country: "United States" } }
        protected async getCountryCookie(): Promise<Maybe<JsonValue>> {
      const countryCookie = await this.httpGetJson({
      path: '/webapi/v1/countrycookie',
      });

      return countryCookie;
      }
    • Extracts the priced variants from an Ambeed product_price response value.

      The variants live under a dynamic ${pr_bd}_${p_purity} key (e.g. "BD41982_95%") that varies per product and can't be indexed by a plain string, so this walks the entries and returns the first array-valued one, skipping the proInfo block.

      Parameters

      Returns AmbeedProductPriceResponseVariantItem[]

      The list of priced variants, or an empty array when none is present

      this.getPriceVariants(response.value);
      // [{ pr_id: 3805067, pr_size: "1mg", pr_usd: "$10.00", ... }]
        protected getPriceVariants(
      value: AmbeedProductPriceResponseValue,
      ): AmbeedProductPriceResponseVariantItem[] {
      for (const [key, entry] of Object.entries(value)) {
      if (key === 'proInfo' || !Array.isArray(entry)) {
      continue;
      }
      return entry;
      }
      return [];
      }
    • No real need to get the product data on a second page, the initial product listing page has enough data.

      Parameters

      Returns Promise<void | ProductBuilder<Product>>

      The product builder

        protected async getProductData(
      product: ProductBuilder<Product>,
      ): Promise<ProductBuilder<Product> | void> {
      // /webapi/v1/product_price?params=btoa(JSON.stringify({ proid: "P000640099" }))
      const proid = String(product.get('id'));
      const productPriceParams = this.makeSignedParams({ proid });

      const productPriceResponse = await this.httpPostJson({
      path: `/webapi/v1/product_price`,
      params: {
      num: this.getEncodedDate(),
      },
      headers: {
      'Content-Type': 'application/x-www-form-urlencoded; charset=UTF-8',
      },
      body: new URLSearchParams({
      params: productPriceParams,
      _xsrf: this.xsrfToken,
      }).toString(),
      });

      if (!isAmbeedProductPriceResponse(productPriceResponse)) {
      this.logger.warn('Invalid Ambeed product price response', {
      productPriceParams,
      productPriceResponse,
      });
      return product;
      }

      const variants = this.getPriceVariants(productPriceResponse.value);
      this.logger.log('Ambeed product price variants', variants);

      const stock = await this.getProductStock(proid, String(product.get('sku')));
      if (stock) {
      this.applyStockAvailability(product, stock);
      }

      return product;
      }
    • Fetches per-size stock for a product from webapi/product_stock (note: this endpoint is unversioned, unlike product_price). Signs the batch id (bd) and carries the product id (proid) unsigned. Stock is enrichment, not core data, so a failed/blocked request degrades to "no stock info" rather than throwing and taking down the whole product.

      Parameters

      • proid: string

        The product ID (p_id)

      • bd: string

        The batch ID (p_bd)

      Returns Promise<
          | undefined
          | []
          | {
              has_stock_quantitychina: number;
              has_stock_quantityam789: number;
              size: any;
              quantityam789: number;
              quantitychina: number;
              quantityam: number;
              has_stock_quantityusa: number;
              has_stock_quantityam: number;
              has_stock?: number;
              is_login: number;
              quantity_sale: number;
              quantityusa: number;
              rows: unknown[];
          }[],
      >

      The array of per-size stock rows, or undefined if the request fails or is invalid

      const stock = await this.getProductStock("P000325570", "BD21445");
      console.log(stock?.[0]); // { size: "25g", has_stock: 2, ... }
        private async getProductStock(
      proid: string,
      bd: string,
      ): Promise<AmbeedProductStockResponse['value'] | undefined> {
      const productStockParams = this.makeSignedParams({ bd }, { proid });

      let response: unknown;
      try {
      response = await this.httpPostJson({
      path: '/webapi/product_stock',
      headers: {
      'Content-Type': 'application/x-www-form-urlencoded; charset=UTF-8',
      },
      body: new URLSearchParams({
      params: productStockParams,
      _xsrf: this.xsrfToken,
      }).toString(),
      });
      } catch (error) {
      this.logger.warn('Ambeed stock request failed; continuing without stock', {
      error,
      proid,
      bd,
      });
      return;
      }

      if (!isAmbeedProductStockResponse(response)) {
      this.logger.warn('Invalid Ambeed product stock response', {
      productStockParams,
      response,
      });
      return;
      }

      return response.value;
      }
    • Applies stock availability to a product's variants and to the product itself. Builds a set of in-stock size keys (${quantity}${uom}) from rows with has_stock > 0, then marks each variant IN_STOCK/OUT_OF_STOCK by matching its quantity+uom. The product is IN_STOCK if any variant is.

      Parameters

      • product: ProductBuilder<Product>

        The product builder to update

      • stock:
            | []
            | {
                has_stock_quantitychina: number;
                has_stock_quantityam789: number;
                size: any;
                quantityam789: number;
                quantitychina: number;
                quantityam: number;
                has_stock_quantityusa: number;
                has_stock_quantityam: number;
                has_stock?: number;
                is_login: number;
                quantity_sale: number;
                quantityusa: number;
                rows: unknown[];
            }[]

        The per-size stock rows from getProductStock

        • []
        • {
              has_stock_quantitychina: number;
              has_stock_quantityam789: number;
              size: any;
              quantityam789: number;
              quantitychina: number;
              quantityam: number;
              has_stock_quantityusa: number;
              has_stock_quantityam: number;
              has_stock?: number;
              is_login: number;
              quantity_sale: number;
              quantityusa: number;
              rows: unknown[];
          }[]
          • has_stock_quantitychina: number

            Whether the China warehouse has stock (1/0).

          • has_stock_quantityam789: number

            Whether the AM789 warehouse has stock (1/0).

          • size: any

            Size/quantity this stock row applies to.

          • quantityam789: number

            Quantity available in the AM789 warehouse.

          • quantitychina: number

            Quantity available in the China warehouse.

          • quantityam: number

            Quantity available in the AM warehouse.

          • has_stock_quantityusa: number

            Whether the USA warehouse has stock (1/0).

          • has_stock_quantityam: number

            Whether the AM warehouse has stock (1/0).

          • Optionalhas_stock?: number

            Aggregate stock flag; > 0 means in stock (absent when out of stock).

          • is_login: number

            Whether the requesting user is logged in (1/0).

          • quantity_sale: number

            Quantity available for sale.

          • quantityusa: number

            Quantity available in the USA warehouse.

          • rows: unknown[]

            Additional per-batch stock rows.

      Returns ProductBuilder<Product>

      The same product builder, for chaining

      this.applyStockAvailability(builder, [{ size: "25g", has_stock: 2, ... }]);
      // builder's "25g" variant -> AVAILABILITY.IN_STOCK
        private applyStockAvailability(
      product: ProductBuilder<Product>,
      stock: AmbeedProductStockResponse['value'],
      ): ProductBuilder<Product> {
      const inStockSizes = new Set<string>();
      for (const row of stock) {
      if (typeof row.has_stock === 'number' && row.has_stock > 0) {
      const parsed = parseQuantity(row.size);
      if (parsed) {
      inStockSizes.add(`${parsed.quantity}${parsed.uom}`);
      }
      }
      }

      const variants = product.get('variants');
      if (!Array.isArray(variants)) {
      return product;
      }

      let anyInStock = false;
      const updated = variants.map((variant) => {
      const inStock = inStockSizes.has(`${variant.quantity}${variant.uom}`);
      anyInStock ||= inStock;
      return {
      ...variant,
      availability: inStock ? AVAILABILITY.IN_STOCK : AVAILABILITY.OUT_OF_STOCK,
      };
      });

      return product.setVariants(updated).setAvailability(anyInStock);
      }
    • Fetches the product matched by a CAS number along with Ambeed's recommended products for that CAS.

      Parameters

      • cas: string

        The CAS number to look up

      Returns Promise<AmbeedGetSearchProductAndRecommendedProductsByCASResponse>

      The validated CAS search response

      Error if the response does not match the expected structure

      const response = await this.getSearchProductAndRecommendedProductsByCAS("108-24-7");
      console.log(response.value.search_pro_dict.p_name_en);
      // "Acetic anhydride"
      console.log(response.value.r_pro_list.length);
      // 12
        protected async getSearchProductAndRecommendedProductsByCAS(
      cas: string,
      ): Promise<AmbeedGetSearchProductAndRecommendedProductsByCASResponse> {
      const response = await this.httpPostJson({
      path: '/webapi/v1/get_search_product_and_recommended_products_by_cas',
      params: {
      params: btoa(JSON.stringify({ cas })),
      },
      headers: {
      'Content-Type': 'application/x-www-form-urlencoded; charset=UTF-8',
      },
      });

      assertIsAmbeedGetSearchProductAndRecommendedProductsByCASResponse(response);
      return response;
      }
    • Determines whether this supplier ships to the given country. Prefers the explicit shipsTo allowlist when the supplier declares one; otherwise falls back to the coarse shipping scope — "worldwide"/"international" ship anywhere, while "domestic"/"local" ship only within the supplier's own country.

      Parameters

      • location: valueof

        The user's location as an ISO 3166-1 alpha-2 country code.

      Returns boolean

      True if the supplier ships to location, false otherwise.

      // Supplier with shipsTo = ["US", "CA"]:
      supplier.shipsToCountry("US"); // true
      supplier.shipsToCountry("DE"); // false
      // Domestic US supplier (no shipsTo):
      supplier.shipsToCountry("US"); // true
      supplier.shipsToCountry("DE"); // false
      // Worldwide supplier (no shipsTo):
      supplier.shipsToCountry("DE"); // true
        public shipsToCountry(location: CountryCode): boolean {
      // Pass an explicit meta object rather than `this.constructor` so the
      // (protected) `shipsTo` static doesn't clash with SupplierStaticMeta's public
      // shape; the getters read the concrete class's static values.
      return SupplierBase.shipsToCountryStatic(
      { shipping: this.shipping, country: this.country, shipsTo: this.shipsTo },
      location,
      );
      }
    • Whether a supplier with the given static shipping metadata ships to location. Shared by the instance shipsToCountry and SupplierFactory so the UI can test shipping compatibility from a supplier's static fields without instantiating it.

      Parameters

      • meta: SupplierStaticMeta

        The supplier's static shipping/country/shipsTo metadata.

      • location: valueof

        Destination country (ISO 3166-1 alpha-2).

      Returns boolean

      True when the supplier ships to location.

        public static shipsToCountryStatic(meta: SupplierStaticMeta, location: CountryCode): boolean {
      if (meta.shipsTo) {
      return meta.shipsTo.includes(location);
      }
      switch (meta.shipping) {
      case 'worldwide':
      case 'international':
      return true;
      case 'domestic':
      case 'local':
      return meta.country === location;
      default:
      return true;
      }
      }
    • Initializes the cache for the supplier. This is called after construction to ensure supplierName is set.

      Parameters

      • enabled: boolean = true
      • doNotCacheEmptyResults: boolean = false
      • cacheTtlMinutes: number = 0
      • noCacheStatusCodes: number[] = ...

      Returns void

      The cache is initialized with the supplier's name and is used to store both query results and product data. This method should be called after the supplier's name is set to ensure proper cache key generation.

      class MySupplier extends SupplierBase<Product> {
      constructor() {
      super("acetone", 5);
      // supplierName is set here
      this.initCache(); // Initialize cache after supplierName is set
      }
      }
        public initCache(
      enabled: boolean = true,
      doNotCacheEmptyResults: boolean = false,
      cacheTtlMinutes: number = 0,
      noCacheStatusCodes: number[] = [429],
      ): void {
      this.cache = new SupplierCache(
      this.supplierName,
      this.constructor.name,
      enabled,
      doNotCacheEmptyResults,
      cacheTtlMinutes,
      );
      // Stored on the supplier (not the cache): the decision is made at cache-write time in
      // getProductData(WithCache), where the per-product fetch status is known.
      this.noCacheStatusCodes = noCacheStatusCodes ?? [429];
      }
    • Applies (or clears) a runtime override for the fuzz scorer. Driven by userSettings.fuzzScorerOverride — when the user picks a scorer in the Advanced drawer section, SupplierFactory calls this on each instance so the choice takes effect uniformly across every supplier.

      Silently ignores unknown names so an outdated / corrupted setting can't blow up the search flow — callers fall back to the subclass default.

      Parameters

      • name: undefined | string

        Name of a scorer from FUZZ_SCORERS, or undefined to clear the override and use the subclass default.

      Returns void

      const supplier = new MySupplier("acetone", 5, controller);
      supplier.setFuzzScorerOverride("token_set_ratio");
      // fuzzyFilter now uses token_set_ratio regardless of MySupplier's default
      supplier.setFuzzScorerOverride(undefined);
      // back to MySupplier's default
        public setFuzzScorerOverride(name: string | undefined): void {
      console.debug('setFuzzScorerOverride', { name });
      if (isFuzzScorerName(name)) {
      this.fuzzScorerOverride = FUZZ_SCORERS[name];
      } else {
      this.fuzzScorerOverride = undefined;
      }
      }
    • Applies a runtime override for supplierSearchTimeBudgetSec, driven by userSettings.supplierSearchTimeBudgetSec (set in the Advanced settings section). Accepts the raw setting value (which may arrive as a string from the number input). An absent, empty, or invalid value is ignored so the supplier keeps its class default; a valid non-negative number (including 0 to disable the limit) replaces it.

      Parameters

      • value: unknown

        The override in seconds, or any value (invalid/empty input is ignored)

      Returns void

      supplier.setSupplierSearchTimeBudgetSec(60); // cap searches at 60s
      supplier.setSupplierSearchTimeBudgetSec(""); // no-op, keep the per-supplier default
        public setSupplierSearchTimeBudgetSec(value: unknown): void {
      if (value === undefined || value === null || value === '') {
      return;
      }
      const seconds = Number(value);
      if (!Number.isNaN(seconds) && seconds >= 0) {
      this.supplierSearchTimeBudgetSec = seconds;
      }
      }
    • Sets the parsed advanced-search query for this instance. Called by SupplierFactory once per search so every supplier shares the same parse of the user's input.

      Parameters

      Returns void

      supplier.setParsedQuery(parseSearchQuery("Sodium OR Potassium"));
      
        public setParsedQuery(parsed: ParsedSearchQuery | undefined): void {
      this.parsedQuery = parsed;
      }
    • Applies a runtime override for fuzzyFilteringDisabled, driven by userSettings.fuzzyFilteringDisabled. When true, fuzzball scoring is skipped and only the boolean predicate (substring matching) is applied.

      Parameters

      • value: boolean

        True to disable fuzzy filtering, false (default) to keep it.

      Returns void

      supplier.setFuzzyFilteringDisabled(true); // show raw/boolean-only results
      
        public setFuzzyFilteringDisabled(value: boolean): void {
      this.fuzzyFilteringDisabled = value === true;
      }
    • Sets the map of resolved structure terms for this instance. Called by SupplierFactory once per search so every supplier shares one resolution of any SMILES/structure terms instead of each hitting the network.

      Parameters

      • resolved: undefined | ReadonlyMap<string, ResolvedStructure>

        Map of raw search term → resolved structure, or undefined when none.

      Returns void

      supplier.setResolvedStructures(new Map([["CCO", { name: "ethanol", cas: ["64-17-5"] }]]));
      
        public setResolvedStructures(resolved: ReadonlyMap<string, ResolvedStructure> | undefined): void {
      this.resolvedStructures = resolved;
      this.effectiveQueryCandidatesCache = undefined;
      }
    • The candidate queries this supplier matches against. Normally just [this.query], but when the query is a CAS/formula/SMILES identifier the supplier can't search itself (per supportsCAS/supportsFormula/ supportsSMILES), it's the factory-resolved chemical-name candidates — the compound Title plus cleaned synonyms — so a product can be matched by whichever name scores best (see fuzzyScore). Falls back to [this.query] when the type is supported, the query is a plain name, or nothing was resolved. Memoized.

      Returns string[]

      The candidate queries, best first (never empty).

      // this.query === "10124-56-8", supportsCAS === false, resolution available
      this.effectiveQueryCandidates(); // ["Hexasodium hexametaphosphate", "Sodium hexametaphosphate", …]
        protected effectiveQueryCandidates(): string[] {
      if (this.effectiveQueryCandidatesCache === undefined) {
      this.effectiveQueryCandidatesCache = this.resolveEffectiveQueryCandidates();
      }
      return this.effectiveQueryCandidatesCache;
      }
    • Returns the parsed query for this instance. Uses the effectiveQuery, so an identifier query the supplier can't search is parsed as its resolved name. Otherwise lazily parses this.query when SupplierFactory did not set a parsed query (e.g. in unit tests that construct a supplier directly).

      Returns ParsedSearchQuery

      The parsed search query.

      const { isAdvanced, ast } = this.getAst();
      
        protected getAst(): ParsedSearchQuery {
      const effective = this.effectiveQuery;
      if (effective !== this.query) {
      return parseSearchQuery(effective);
      }
      return this.parsedQuery ?? parseSearchQuery(this.query);
      }
    • Retrieves HTTP headers from a URL using a HEAD request. Useful for checking content types, caching headers, and other metadata without downloading the full response.

      Parameters

      • url: string | URL

        The URL to fetch headers from

      Returns Promise<Maybe<HeadersInit>>

      Promise resolving to the response headers or void if request fails

      // Basic usage
      const headers = await supplier.httpGetHeaders('https://example.com/product/123');
      if (headers) {
      console.log('Content-Type:', headers['content-type']);
      }
      // With error handling
      try {
      const headers = await supplier.httpGetHeaders('https://example.com/product/123');
      if (headers) {
      console.log('Headers:', headers);
      }
      } catch (err) {
      console.error('Failed to fetch headers:', err);
      }
        protected async httpGetHeaders(url: string | URL): Promise<Maybe<HeadersInit>> {
      const requestObj = new Request(this.href(url), {
      signal: this.controller.signal,
      headers: new Headers(this.headers),
      referrer: this.baseURL,
      referrerPolicy: 'strict-origin-when-cross-origin',
      body: null,
      method: 'HEAD',
      mode: 'cors',
      credentials: 'include',
      });

      try {
      const httpResponse = await this.fetch(requestObj);
      return Object.fromEntries(httpResponse.headers.entries()) satisfies HeadersInit;
      } catch (error: unknown) {
      if (error instanceof Error && error.name === 'AbortError') {
      this.logger.warn('Request was aborted', { error, signal: this.controller.signal });
      this.controller.abort('Abort signal detected');
      } else {
      this.logger.error('Error received during fetch:', {
      error,
      signal: this.controller.signal,
      });
      }
      return;
      }
      }
    • Sends a POST request to the given URL with the given body and headers. Handles request setup, error handling, and response caching.

      Parameters

      Returns Promise<Maybe<Response>>

      Promise resolving to the Response object or void if request fails

      // Basic POST request
      const response = await supplier.httpPost({
      path: '/api/v1/products',
      body: { name: 'Test Chemical' }
      });
      // POST with custom headers
      const response = await supplier.httpPost({
      path: '/api/v1/products',
      body: { name: 'Test Chemical' },
      headers: {
      'Authorization': 'Bearer token123',
      'Content-Type': 'application/json'
      }
      });
      // POST with custom host and params
      const response = await supplier.httpPost({
      path: '/api/v1/products',
      host: 'api.example.com',
      body: { name: 'Test Chemical' },
      params: { version: '2' }
      });
      // Error handling
      try {
      const response = await supplier.httpPost({ path: '/api/v1/products', body: { name: 'Test' } });
      if (response && response.ok) {
      const data = await response.json();
      console.log('Created:', data);
      }
      } catch (err) {
      console.error('POST failed:', err);
      }
        protected async httpPost({
      path,
      host,
      body,
      params,
      headers,
      }: RequestOptions): Promise<Maybe<Response>> {
      this.logger.log('httpPost| Requesting:', {
      path,
      host,
      body,
      params,
      headers,
      });
      const method = 'POST';
      const mode = 'cors';
      const referrer = this.baseURL;
      const referrerPolicy = 'strict-origin-when-cross-origin';
      const signal = this.controller.signal;
      const headersObj = new Headers({
      ...this.headers,
      ...headers,
      });

      let bodyStr = null;
      if (body instanceof FormData) {
      headersObj.set('Content-Type', 'application/x-www-form-urlencoded; charset=UTF-8');
      bodyStr = body;
      } else if (typeof body === 'string') {
      bodyStr = body;
      } else if (typeof body === 'object' && body !== null) {
      bodyStr = JSON.stringify(body);
      }
      const url = this.href(path, params, host);

      const requestObj = new Request(url, {
      signal,
      headers: headersObj,
      referrer,
      referrerPolicy,
      body: bodyStr,
      method,
      mode,
      credentials: 'include',
      });

      // Fetch the goods
      const httpResponse = await this.fetch(requestObj);

      if (!isHttpResponse(httpResponse) || !httpResponse.ok) {
      const badResponse = await httpResponse.text();
      this.logger.error('Invalid POST response: ', badResponse);
      throw new TypeError(`Invalid POST response: ${String(httpResponse)}`);
      }

      return httpResponse;
      }
    • Sends a POST request with the body encoded as multipart/form-data. Converts the given object into a FormData instance (one field per key/value pair) before delegating to httpPost.

      Parameters

      • options: RequestOptions

        The request configuration options. body must be a non-null object.

      Returns Promise<Maybe<Response>>

      Promise resolving to the Response object or void if the request fails

      TypeError - If body is not an object, or the response is not a valid HTTP response

      const response = await this.httpPostFormData({
      path: "/api/v1/cart",
      body: { productId: "123", quantity: "2" },
      });
        protected async httpPostFormData({
      path,
      host,
      body,
      params,
      headers,
      }: RequestOptions): Promise<Maybe<Response>> {
      if (typeof body !== 'object' || body === null) {
      throw new TypeError('httpPostFormData| Body must be an object');
      }

      headers = {
      ...headers,
      'Content-Type': 'application/x-www-form-urlencoded',
      };
      const formData = new FormData();
      for (const [key, value] of Object.entries(body)) {
      formData.append(key, value);
      }
      const httpResponse = await this.httpPost({ path, host, body: formData, params, headers });
      if (!isHttpResponse(httpResponse) || !httpResponse.ok) {
      const badResponse = await httpResponse?.text();
      this.logger.error('Invalid POST response: ', badResponse);
      throw new TypeError(`Invalid POST response: ${String(httpResponse)}`);
      }
      this.logger.log('httpPostFormData| Successfully sent POST request to:', path);
      return httpResponse;
      }
    • Sends a POST request and returns the response as a JSON object.

      Parameters

      Returns Promise<Maybe<JsonValue>>

      The response from the POST request as a JSON object.

      // Basic usage
      const data = await supplier.httpPostJson({
      path: '/api/v1/products',
      body: { name: 'John' }
      });
      // With custom headers and error handling
      try {
      const data = await supplier.httpPostJson({
      path: '/api/v1/products',
      body: { name: 'John' },
      headers: { 'Authorization': 'Bearer token123' }
      });
      if (data) {
      console.log('Created:', data);
      }
      } catch (err) {
      console.error('POST JSON failed:', err);
      }
        protected async httpPostJson({
      path,
      host,
      body,
      params,
      headers,
      }: RequestOptions): Promise<Maybe<JsonValue>> {
      const httpResponse = await this.httpPost({ path, host, body, params, headers });
      if (!isJsonResponse(httpResponse) || !httpResponse.ok) {
      this.logger.error('httpPostJson| Invalid POST response: ', {
      httpResponse,
      path,
      host,
      body,
      params,
      headers,
      });
      throw new TypeError(`httpPostJson| Invalid POST response: ${httpResponse}`);
      }
      return await httpResponse.json();
      }
    • Sends a POST request and returns the response as a HTML string.

      Parameters

      Returns Promise<Maybe<string>>

      Promise resolving to the HTML response as a string or void if request fails

      TypeError - If the response is not valid HTML content

      // Basic usage
      const html = await supplier.httpPostHtml({
      path: '/api/v1/products',
      body: { name: 'John' }
      });
        protected async httpPostHtml({
      path,
      host,
      body,
      params,
      headers,
      }: RequestOptions): Promise<Maybe<string>> {
      const httpResponse = await this.httpPost({ path, host, body, params, headers });
      if (!isHtmlResponse(httpResponse)) {
      throw new TypeError(`httpPostHtml| Invalid POST response: ${httpResponse}`);
      }
      return await httpResponse.text();
      }
    • Sends a GET request to the given URL with the specified options. Handles request setup, error handling, and response caching.

      Parameters

      Returns Promise<Maybe<Response>>

      Promise resolving to the Response object or void if request fails

      // Basic GET request
      const response = await supplier.httpGet({
      path: '/products/search',
      params: { query: 'sodium chloride' }
      });
      // GET with custom headers
      const response = await supplier.httpGet({
      path: '/products/search',
      headers: { 'Accept': 'application/json' }
      });
      // GET with custom host
      const response = await supplier.httpGet({
      path: '/products/search',
      host: 'api.example.com',
      params: { category: 'chemicals' }
      });
      // Error handling
      try {
      const response = await supplier.httpGet({ path: '/products/search' });
      if (response && response.ok) {
      const data = await response.json();
      console.log('Products:', data);
      }
      } catch (err) {
      console.error('GET failed:', err);
      }
        protected async httpGet({
      path,
      params,
      headers,
      host,
      rethrowErrors,
      }: RequestOptions): Promise<Maybe<Response>> {
      // Check if the request has been aborted before proceeding
      if (this.controller.signal.aborted) {
      this.logger.warn('Request was aborted before fetch', {
      signal: this.controller.signal,
      });
      return;
      }

      const headersRaw = { ...this.headers };

      Object.assign(headersRaw, {
      accept: [
      'text/html',
      'application/xhtml+xml',
      'application/xml;q=0.9',
      'image/avif',
      'image/webp',
      'image/apng',
      '*/*;q=0.8',
      ].join(','),
      ...(headers ?? {}),
      });

      const requestObj = new Request(this.href(path, params, host), {
      signal: this.controller.signal,
      headers: new Headers(headersRaw),
      referrer: this.baseURL,
      referrerPolicy: 'no-referrer',
      body: null,
      method: 'GET',
      mode: 'cors',
      credentials: 'include',
      redirect: 'follow',
      });

      try {
      // Fetch the goods
      const httpResponse = await this.fetch(requestObj.url, requestObj);

      const responseHeaders = Object.fromEntries(
      httpResponse.headers.entries(),
      ) satisfies HeadersInit;
      this.logger.debug('responseHeaders:', responseHeaders);
      this.logger.debug('responseHeaders.location:', responseHeaders.location);

      return httpResponse;
      } catch (error: unknown) {
      if (error instanceof Error && error.name === 'AbortError') {
      this.logger.warn('Request was aborted', { error, signal: this.controller.signal });
      this.controller.abort('Abort signal detected');
      return;
      }
      this.logger.error('Error received during fetch:', {
      error,
      signal: this.controller.signal,
      });
      // Opt-in: surface the failure (e.g. an HttpError 429) so the caller can apply
      // status-aware retry/backoff. Default behavior remains swallow-and-return-undefined.
      if (rethrowErrors) {
      throw error;
      }
      return;
      }
      }
    • Scores a single string against the current search query (this.query) using the active fuzz scorer — the user's fuzzScorerOverride when set, otherwise the supplier's fuzzScorer. Returns a 0–100 similarity score (higher is closer). Useful for suppliers that can only fuzz-match after a secondary request reveals the real product name, e.g. when the search index only exposes coarse category breadcrumbs.

      Parameters

      • text: string

        The text to score against this.query.

      Returns number

      A similarity score from 0 (no match) to 100 (identical).

      // this.query === "sodium borohydride"
      this.fuzzyScore("Sodium borohydride, min 95%"); // ~90
      this.fuzzyScore("Acetone"); // ~10
        protected fuzzyScore(text: string): number {
      const activeScorer = this.fuzzScorerOverride ?? this.fuzzScorer;
      // Score against every effective-query candidate and keep the best — for an
      // identifier query these are the resolved name + synonyms, so a product
      // matches whichever name it names. A plain query has a single candidate.
      let best = 0;
      for (const candidate of this.effectiveQueryCandidates()) {
      const score = activeScorer(candidate, text);
      if (score > best) {
      best = score;
      }
      }
      return best;
      }
    • Filters an array of data using fuzzy string matching to find items that closely match a query string. Uses the WRatio algorithm from fuzzball for string similarity comparison.

      Type Parameters

      • X

      Parameters

      • query: string

        The search string to match against

      • data: X[]

        Array of data objects to search through

      • minMatchPercentage: number = ...

        Minimum match percentage (0-100) for a match to be included (default: 55)

      Returns X[]

      Array of matching data objects with added fuzzy match metadata

      // Example with simple string array
      const products = [
      { title: "Sodium Chloride", price: 29.99 },
      { title: "Sodium Hydroxide", price: 39.99 },
      { title: "Potassium Chloride", price: 19.99 }
      ];

      const matches = this.fuzzyFilter("sodium chloride", products);
      // Returns: [
      // {
      // title: "Sodium Chloride",
      // price: 29.99,
      // _fuzz: { score: 100, idx: 0 }
      // },
      // {
      // title: "Sodium Hydroxide",
      // price: 39.99,
      // _fuzz: { score: 85, idx: 1 }
      // }
      // ]

      // Example with custom minMatchPercentage
      const strictMatches = this.fuzzyFilter("sodium chloride", products, 90);
      // Returns only exact matches with score >= 90

      // Example with different data structure
      const chemicals = [
      { name: "NaCl", formula: "Sodium Chloride" },
      { name: "NaOH", formula: "Sodium Hydroxide" }
      ];

      // Override titleSelector to use formula field
      this.titleSelector = (data) => data.formula;
      const formulaMatches = this.fuzzyFilter("sodium chloride", chemicals);
        protected fuzzyFilter<X>(
      query: string,
      data: X[],
      minMatchPercentage: number = this.minMatchPercentage,
      ): X[] {
      // User's Advanced-settings override wins over the subclass default.
      const activeScorer = this.fuzzScorerOverride ?? this.fuzzScorer;

      // console.log(
      // `[fuzzyFilter] ${this.supplierName} query="${query}" — scorer comparison (cutoff=${minMatchPercentage})`,
      // );

      if (IS_DEV_BUILD) {
      this.showFuzzScorerComparisonTable(query, data);
      }

      if (this.fuzzyFilterRankOnly) {
      // Rank every candidate by score (no cutoff) and return them in score order; the
      // caller slices the top N. Avoids dropping clear matches whose ratio-style score
      // falls under minMatchPercentage purely because the title dwarfs the query.
      return extract(query, data, {
      scorer: activeScorer,
      processor: this.titleSelector,
      sortBySimilarity: true,
      }).map(([obj, score, idx]) => this.attachFuzz(obj, score, idx));
      }

      const results = extract(query, data, {
      scorer: activeScorer,
      processor: this.titleSelector,
      cutoff: minMatchPercentage,
      sortBySimilarity: true,
      }).reduce<FuzzyMatchResult<X>[]>((acc, [obj, score, idx]) => {
      if (score < minMatchPercentage) {
      this.logger.debug('fuzzyFilter: score below minimum match percentage, excluding product', {
      product: obj,
      score,
      idx,
      minMatchPercentage: minMatchPercentage,
      });
      return acc;
      }

      acc[idx] = Object.assign(obj, { _fuzz: { score, idx }, matchPercentage: score });
      return acc;
      }, []);

      this.logger.debug('[fuzzyFilter]', {
      supplierName: this.supplierName,
      query,
      minMatchPercentage,
      activeScorer,
      results,
      });

      // Get rid of any empty items that didn't match closely enough
      return results.filter((item) => !!item);
      }
    • Annotates an item with its fuzz score, returning it as a FuzzyMatchResult. Mutates obj in place (rather than spreading) so non-plain inputs — e.g. DOM Elements fuzzed by HTML-scraping suppliers — keep their prototype and methods. The as is needed because a direct Object.assign on an unconstrained X widens it away.

      Type Parameters

      • X

      Parameters

      • obj: X

        The matched item to annotate.

      • score: number

        The fuzz score (0–100).

      • idx: number

        The item's index in the source list.

      Returns FuzzyMatchResult<X>

      obj extended with _fuzz and matchPercentage.

      this.attachFuzz({ name: "NaCl" }, 92, 0);
      // => { name: "NaCl", _fuzz: { score: 92, idx: 0 }, matchPercentage: 92 }
        protected attachFuzz<X>(obj: X, score: number, idx: number): FuzzyMatchResult<X> {
      const result = obj as FuzzyMatchResult<X>;
      result._fuzz = { score, idx };
      result.matchPercentage = score;
      return result;
      }
    • Reads the fuzzy/AST match score that fuzzyFilterAst/attachFuzz stamped onto a scored search item, for handing to builder.setMatchPercentage in a supplier's initProductBuilders. Returns undefined when the item was never scored (e.g. fuzzy filtering disabled on a plain query) — setMatchPercentage ignores that, leaving the score unset.

      Parameters

      • item: unknown

        A scored search item (the raw supplier item after fuzzyFilterAst).

      Returns undefined | number

      The stamped match percentage, or undefined when the item carries no score.

      builder.setMatchPercentage(this.matchScoreOf(item));
      
        protected matchScoreOf(item: unknown): number | undefined {
      if (isPopulatedObject(item) && typeof item.matchPercentage === 'number') {
      return item.matchPercentage;
      }
      return undefined;
      }
    • Advanced-search-aware companion to fuzzyFilter. Filters data using the parsed query (getAst) so boolean operators (AND/OR/NOT) and nesting are honored, and respects the fuzzyFilteringDisabled toggle.

      Behavior matrix:

      • fuzzing on + plain query → delegates to fuzzyFilter (identical legacy path).
      • fuzzing off + plain query → returns data unchanged (raw supplier results).
      • fuzzing on + advanced query → fuzzy-scores each title against the AST, drops non-matches, ranks by score.
      • fuzzing off + advanced query → applies the boolean predicate with case-insensitive substring matching, original order preserved.

      Type Parameters

      • X

      Parameters

      • data: X[]

        Array of raw search-result objects to filter.

      • minMatchPercentage: number = ...

        Minimum leaf match score when fuzzing is on.

      Returns X[]

      The filtered (and, when fuzzing, ranked) subset, each item tagged with _fuzz/matchPercentage like fuzzyFilter.

      // this.query === "Sodium OR Potassium"
      const matches = this.fuzzyFilterAst(products);
        protected fuzzyFilterAst<X>(
      data: X[],
      minMatchPercentage: number = this.minMatchPercentage,
      ): X[] {
      const parsed = this.getAst();

      if (!parsed.isAdvanced) {
      // Plain query: no filtering when disabled; the multi-candidate path for a
      // resolved identifier query (several candidate names); else the legacy
      // single-query fuzzy path.
      if (this.fuzzyFilteringDisabled) {
      return data;
      }
      if (this.effectiveQueryCandidates().length > 1) {
      return this.fuzzyFilterCandidates(data, minMatchPercentage);
      }
      return this.fuzzyFilter(parsed.raw.trim(), data, minMatchPercentage);
      }

      const scorer = this.fuzzScorerOverride ?? this.fuzzScorer;
      // Rank-only floors the leaf score at 0 so predicate-matching items are never dropped
      // for a low fuzz score; the sort below still ranks them. Otherwise enforce the cutoff.
      const threshold = this.fuzzyFilteringDisabled
      ? 1
      : this.fuzzyFilterRankOnly
      ? 0
      : minMatchPercentage;
      const fuzzyWords = !this.fuzzyFilteringDisabled;

      const matched = data.reduce<FuzzyMatchResult<X>[]>((acc, obj, idx) => {
      const title = this.titleSelector(obj) ?? '';
      const score = scoreAstMatch(title, parsed.ast, { scorer, threshold, fuzzyWords });
      if (score === null) {
      return acc;
      }
      acc.push(this.attachFuzz(obj, score, idx));
      return acc;
      }, []);

      // Rank by relevance when fuzzing; preserve backend order when disabled.
      if (!this.fuzzyFilteringDisabled) {
      matched.sort((a, b) => (b.matchPercentage ?? 0) - (a.matchPercentage ?? 0));
      }
      return matched;
      }
    • Advanced-search-aware, keep-or-drop companion to fuzzyScore for suppliers that re-filter a single title after a detail fetch (e.g. LiMac). Returns the score to keep the item, or null to drop it, honoring both the parsed query and the fuzzyFilteringDisabled toggle:

      • fuzzing off → plain query keeps everything (score 100); advanced query keeps items satisfying the boolean predicate by substring match.
      • fuzzing on → plain query keeps items scoring at/above minMatchPercentage; advanced query keeps items satisfying the predicate with fuzzy leaf scores.

      Parameters

      • text: string

        The text (e.g. a detail-page product name) to score.

      Returns null | number

      A 0–100 score to keep the item, or null to drop it.

      // this.query === "acid AND NOT boric"
      this.fuzzyScoreAst("Sulfuric acid"); // a number
      this.fuzzyScoreAst("Boric acid"); // null
        protected fuzzyScoreAst(text: string): number | null {
      const parsed = this.getAst();

      if (!parsed.isAdvanced) {
      if (this.fuzzyFilteringDisabled) {
      return 100;
      }
      const score = this.fuzzyScore(text);
      return score >= this.minMatchPercentage ? score : null;
      }

      const scorer = this.fuzzScorerOverride ?? this.fuzzScorer;
      const threshold = this.fuzzyFilteringDisabled ? 1 : this.minMatchPercentage;
      return scoreAstMatch(text, parsed.ast, {
      scorer,
      threshold,
      fuzzyWords: !this.fuzzyFilteringDisabled,
      });
      }
    • Derives the backend search terms for a keyword-only supplier from an advanced query: one representative term per positive OR-group (the longest — most selective — token of each AND-group), de-duplicated and capped at maxFallbackQueries. Returns an empty array when there are no positive terms (e.g. a purely negative query), in which case the caller falls back to a single raw search.

      Returns string[]

      The de-duplicated, capped list of backend search terms.

      // this.query === "(Sodium OR Potassium) AND Hydroxide"
      this.deriveFallbackTerms(); // ["Hydroxide", "Hydroxide"] -> ["Hydroxide"] (deduped)
        protected deriveFallbackTerms(): string[] {
      const groups = extractOrGroups(this.getAst().ast);

      // How many AND-groups each term appears in — a term shared across groups (a
      // common factor, e.g. "Hydroxide" in "(Sodium OR Potassium) AND Hydroxide")
      // covers more of the query in fewer requests, so prefer it; break ties by
      // length (more selective). Picking one representative term per group keeps
      // each request's result set a superset of that group's matches.
      const frequency = new Map<string, number>();
      for (const group of groups) {
      for (const term of new Set(group)) {
      frequency.set(term, (frequency.get(term) ?? 0) + 1);
      }
      }

      const terms = groups
      .map(
      (group) =>
      group.slice().sort((a, b) => {
      const byFrequency = (frequency.get(b) ?? 0) - (frequency.get(a) ?? 0);
      return byFrequency !== 0 ? byFrequency : b.length - a.length;
      })[0],
      )
      .filter((term): term is string => Boolean(term));

      return [...new Set(terms)].slice(0, this.maxFallbackQueries);
      }
    • Makes an HTTP GET request and returns the response as a string. Handles request configuration, error handling, and HTML parsing.

      Parameters

      Returns Promise<Maybe<string>>

      Promise resolving to the HTML response as a string or void if request fails

      TypeError - If the response is not valid HTML content

      // Basic GET request
      const html = await this.httpGetHtml({
      path: "/api/products",
      params: { search: "sodium" }
      });

      // GET request with custom headers
      const html = await this.httpGetHtml({
      path: "/api/products",
      headers: {
      "Authorization": "Bearer token123",
      "Accept": "text/html"
      }
      });

      // GET request with custom host
      const html = await this.httpGetHtml({
      path: "/products",
      host: "api.supplier.com",
      params: { limit: 10 }
      });
        protected async httpGetHtml({
      path,
      params,
      headers,
      host,
      }: RequestOptions): Promise<Maybe<string>> {
      const httpResponse = await this.httpGet({ path, params, headers, host });
      if (!isHtmlResponse(httpResponse)) {
      throw new TypeError(`httpGetHtml| Invalid GET response: ${httpResponse}`);
      }
      return await httpResponse.text();
      }
    • Makes an HTTP GET request and returns the response as parsed JSON. Handles request configuration, error handling, and JSON parsing.

      Parameters

      Returns Promise<Maybe<JsonValue>>

      Promise resolving to the parsed JSON response or void if request fails

      TypeError - If the response is not valid JSON content

      // Basic GET request
      const data = await supplier.httpGetJson({ path: '/api/products', params: { search: 'sodium' } });
      // GET request with custom headers
      const data = await supplier.httpGetJson({
      path: '/api/products',
      headers: {
      'Authorization': 'Bearer token123',
      'Accept': 'application/json'
      }
      });
      // GET request with custom host
      const data = await supplier.httpGetJson({
      path: '/products',
      host: 'api.supplier.com',
      params: { limit: 10 }
      });
      // Error handling
      try {
      const data = await supplier.httpGetJson({ path: '/api/products' });
      if (data) {
      console.log('Products:', data);
      }
      } catch (error) {
      console.error('Failed to fetch products:', error);
      }
        protected async httpGetJson({
      path,
      params,
      headers = {},
      host,
      }: RequestOptions): Promise<Maybe<JsonValue>> {
      if (
      typeof headers?.accept === 'undefined' ||
      !Array.isArray(headers?.accept) ||
      !headers?.accept.includes('application/json')
      ) {
      headers.accept = ['application/json', 'text/plain', '*/*'].join(',');
      }
      const httpRequest = await this.httpGet({ path, params, headers, host });

      if (!isJsonResponse(httpRequest)) {
      const badResponse = isHttpResponse(httpRequest) ? await httpRequest.text() : undefined;
      this.logger.error('Invalid HTTP GET JSON response:', {
      badResponse,
      httpRequest,
      path,
      params,
      headers,
      host,
      });
      return;
      }

      return await httpRequest.json();
      }
    • Executes a product search query with caching support. First checks the cache for existing results, then falls back to the actual query if needed. The limit parameter is only used for the actual query and doesn't affect caching.

      Parameters

      • query: string

        The search term to query products for

      • limit: number = ...

        The maximum number of results to return (defaults to instance limit)

      Returns Promise<void | ProductBuilder<Product>[]>

      Promise resolving to array of product builders or void if search fails

      // Basic usage with default limit
      const results = await supplier.queryProductsWithCache("acetone");
      if (results) {
      console.log(`Found ${results.length} products`);
      }
      // With custom limit
      const results = await supplier.queryProductsWithCache("acetone", 10);
      if (results) {
      for (const builder of results) {
      const product = await builder.build();
      console.log(product.title, product.price);
      }
      }
        protected async queryProductsWithCache(
      query: string,
      limit: number = this.limit,
      ): Promise<ProductBuilder<T>[] | void> {
      // Check cache first (processed product data)
      this.logger.debug(
      'queryProductsWithCache: called for',
      this.supplierName,
      'query:',
      query,
      'limit:',
      limit,
      );
      const key = this.cache.generateCacheKey(query);
      const cached = await this.cache.getCachedQueryEntry(key);
      this.logger.debug('queryProductsWithCache: cache hit:', !!cached, 'key:', key);
      if (cached) {
      const cachedLimit = cached.__cacheMetadata.limit;
      const insufficientLimit = typeof cachedLimit === 'number' && cachedLimit < limit;
      if (!insufficientLimit) {
      this.logger.debug('Returning cached query results');
      // Re-initialize product builders from cached processed data
      return ProductBuilder.createFromCache<T>(this.baseURL, cached.data.slice(0, limit));
      }
      // Cached entry was built with a smaller limit than requested — drop it and re-query below.
      this.logger.debug('Invalidating query cache due to insufficient limit', {
      cachedLimit,
      requestedLimit: limit,
      });
      await deleteSupplierQueryCacheEntry(key);
      }

      // If not in cache, perform the actual query. Run setup first so any
      // subclass state it mutates (headers, localStorage, tokens, etc.) is
      // in place before `queryProducts` reads it. Memoized, so this is cheap
      // on repeat calls within the same supplier instance.
      await this.ensureSetup();
      const results = await this.queryProductsResolved(query, limit);
      if (results) {
      // Store processed results in cache (dumped/serialized form) and the limit used
      await this.cache.cacheQueryResults(
      query,
      results.map((b) => b.dump()),
      limit,
      );
      }
      return results;
      }
    • Resolves the supplier's queryProducts for the current search, applying the keyword-only advanced-search fallback when needed. For a plain query, or for a supplier that handles boolean queries natively (supportsNativeAdvancedSearch), this is a single queryProducts call. For an advanced query on a keyword-only backend, it issues one search per derived OR-group term (deriveFallbackTerms) and unions the results, deduping by product URL/ID. Each queryProducts batch already enforces the full boolean predicate via fuzzyFilterAst, so the union is the set of products matching the whole query. Honors httpRequestHardLimit; the fetches run inside execute()'s existing supplierSearchTimeBudgetSec race so an aborted controller cancels them.

      Parameters

      • query: string

        The raw search query.

      • limit: number

        The per-supplier result limit.

      Returns Promise<void | ProductBuilder<Product>[]>

      The (possibly unioned) product builders, or void.

        protected async queryProductsResolved(
      query: string,
      limit: number,
      ): Promise<ProductBuilder<T>[] | void> {
      const parsed = this.getAst();
      if (!parsed.isAdvanced || this.supportsNativeAdvancedSearch) {
      return this.queryProducts(query, limit);
      }

      const terms = this.deriveFallbackTerms();
      if (terms.length <= 1) {
      // Nothing to union (single positive term, or a purely negative query):
      // run the raw query once and let fuzzyFilterAst enforce the predicate.
      return this.queryProducts(terms[0] ?? query, limit);
      }

      const seen = new Set<string>();
      const union: ProductBuilder<T>[] = [];
      for (const term of terms) {
      if (this.requestCount >= this.httpRequestHardLimit) {
      this.logger.warn('queryProductsResolved: httpRequestHardLimit reached, stopping fallback', {
      term,
      requestCount: this.requestCount,
      });
      break;
      }
      const batch = await this.queryProducts(term, limit);
      if (!batch) {
      continue;
      }
      for (const builder of batch) {
      const key = String(builder.get('url') ?? builder.get('id') ?? builder.get('title') ?? '');
      if (key === '' || seen.has(key)) {
      continue;
      }
      seen.add(key);
      union.push(builder);
      }
      }
      return union.length > 0 ? union : undefined;
      }
    • Executes the supplier's search query and returns the results. This method will execute all results concurrently (to the limits set in the supplier class), and resolve to an array of product objects.

      Returns AsyncGenerator<Product, void, undefined>

      Promise resolving to an array of products

      This method is used to execute the supplier's search query and return the results.

        public async *execute(): AsyncGenerator<T, void, undefined> {
      // setup() is not called eagerly here — it's run lazily from the
      // phase-boundary gates inside `queryProductsWithCache` and
      // `getProductData` / `getProductDataWithCache`. A fully cached search
      // never reaches those gates, so setup's token/cookie/permission
      // requests are skipped entirely.
      // Snapshot the user's ignore list once per search. Any product whose
      // exclusion key matches an entry here is dropped before the detail phase
      // runs (see the filter after queryProductsWithCache below).
      this.excludedProductKeys = await loadExcludedProductKeys();
      // Over-fetch by the number of previously-ignored products belonging to
      // this supplier so that, in the worst case where every ignored product
      // appears in the top of the query result set, we still end up with
      // `this.limit` survivors after filtering. The queryProductsWithCache
      // cache invalidates itself when the requested limit exceeds the cached
      // limit, so this is safe.
      const excludedForSupplier = await countExcludedProductsForSupplier(this.supplierName);
      const fetchLimit = this.limit + excludedForSupplier;
      incrementSearchQueryCount(this.supplierName);

      // Optional per-supplier search-time budget; see armSearchTimeout. When it elapses the
      // race below wins via SEARCH_TIMEOUT and flushes any not-yet-yielded products.
      const SEARCH_TIMEOUT = Symbol('searchTimeout');
      const { promise: timeoutPromise, handle: timeoutHandle } =
      this.armSearchTimeout(SEARCH_TIMEOUT);

      try {
      const results = await this.queryProductsWithCache(this.query, fetchLimit);
      if (!results || results.length === 0) {
      this.logger.log(`No query results found`);
      return;
      }
      // Drop any products the user has ignored, then slice back down to the
      // user-visible limit. Uses the same dual-read (identity + legacy URL) as
      // getProductData/partitionForBatch so the check is consistent wherever it
      // fires first.
      const survivors: ProductBuilder<T>[] = [];
      for (const builder of results) {
      if (survivors.length >= this.limit) break;
      if (this.isExcluded(builder)) {
      this.logger.debug('Skipping excluded product (pre-detail)', {
      url: builder.get('url'),
      });
      continue;
      }
      survivors.push(builder);
      }
      this.products = survivors;
      const queue = new Queue(this.maxConcurrentRequests, this.minConcurrentCycle);

      // Each task fetches a product's detail data and finishes it, tagged with its index so the
      // yield loop can track which products are still outstanding when the budget elapses.
      const pending = new Map<number, Promise<{ index: number; finished: Maybe<T> }>>();
      this.products.forEach((product, index) => {
      pending.set(
      index,
      queue.run(async () => {
      // If the budget already elapsed, skip the (now-aborted) detail fetch — the timeout
      // handler below emits this product's basic data directly.
      if (this.controller.signal.aborted) {
      return { index, finished: undefined };
      }
      try {
      const builder = await this.getProductData(product);
      const finished = builder ? await this.finishProduct(builder) : undefined;
      return { index, finished };
      } catch (e: unknown) {
      this.logger.error('Error processing product', { error: e, product });
      incrementParseError(this.supplierName);
      return { index, finished: undefined };
      }
      }),
      );
      });

      // As each task resolves, yield the product. Race against the optional search-time budget;
      // when it elapses, emit every not-yet-yielded product with its basic (query-phase) data so
      // the rows still show — the enrichment for those simply wasn't cached, so a later search
      // (served from the query cache) re-fetches their detail data.
      const yielded = new Set<number>();
      while (pending.size > 0) {
      const result = await Promise.race(
      timeoutPromise ? [...pending.values(), timeoutPromise] : [...pending.values()],
      );

      if (result === SEARCH_TIMEOUT) {
      for (let index = 0; index < this.products.length; index++) {
      if (yielded.has(index)) continue;
      // The builder is enriched in place, so this carries whatever detail data was set
      // before the abort, falling back to the basic query-phase fields otherwise.
      const finished = await this.finishProduct(this.products[index]);
      if (finished) {
      yield finished;
      }
      }
      break;
      }

      pending.delete(result.index);
      yielded.add(result.index);
      if (result.finished) {
      yield result.finished;
      }
      }
      } finally {
      if (timeoutHandle !== undefined) {
      clearTimeout(timeoutHandle);
      }
      }
      }
    • Finalizes a partial product by adding computed properties and validating the result. This method:

      1. Validates the product has minimal required properties
      2. Computes USD price if product is in different currency
      3. Calculates base quantity using the unit of measure
      4. Ensures the product URL is absolute

      Parameters

      Returns Promise<Maybe<Product>>

      Promise resolving to a complete Product object or void if validation fails

      // Example with a valid partial product
      const builder = new ProductBuilder<Product>(this.baseURL);
      builder
      .setBasicInfo("Sodium Chloride", "/products/nacl", "ChemSupplier")
      .setPricing(29.99, "USD", "$")
      .setQuantity(500, "g");

      const finishedProduct = await this.finishProduct(builder);
      if (finishedProduct) {
      console.log("Finalized product:", {
      title: finishedProduct.title,
      price: finishedProduct.price,
      quantity: finishedProduct.quantity,
      uom: finishedProduct.uom,
      usdPrice: finishedProduct.usdPrice,
      baseQuantity: finishedProduct.baseQuantity
      });
      }

      // Example with an invalid partial product
      const invalidBuilder = new ProductBuilder<Product>(this.baseURL);
      invalidBuilder.setBasicInfo("Sodium Chloride", "/products/nacl", "ChemSupplier");
      // Missing required fields

      const invalidProduct = await this.finishProduct(invalidBuilder);
      if (!invalidProduct) {
      console.log("Failed to finalize product - missing required fields");
      }
        protected async finishProduct(product: ProductBuilder<T>): Promise<Maybe<T>> {
      if (!isMinimalProduct(product.dump())) {
      this.logger.warn('Unable to finish product - Minimum data not set', { product });
      return;
      }

      // Dev guard: every builder should carry a stamped `cacheKey` (set at parse
      // time via `setCacheKey(getUniqueProductKey(item))`). A missing key means a
      // supplier implemented `getUniqueProductKey` but forgot to stamp — it would
      // silently disable per-product caching and precise exclusion for that
      // product. Surface it loudly in dev/tests.
      if (IS_DEV_BUILD && product.get('cacheKey') == null) {
      this.logger.error('finishProduct| product is missing a stamped cacheKey', {
      supplier: this.supplierName,
      url: product.get('url'),
      });
      }

      // Set the country and shipping scope of the supplier
      // have different restrictions on different products or countries.
      product.setSupplierCountry(this.country);
      product.setSupplierShipping(this.shipping);

      if (this.paymentMethods.length > 0) {
      product.setSupplierPaymentMethods(this.paymentMethods);
      }

      // Marketplace storefronts. The "*only" methods point users away from the supplier's own
      // (restricted) site, so a missing store URL is a misconfiguration — surface it loudly in dev.
      // The plain "ebay"/"amazon" methods instead drive an informational "more products there"
      // notice; the store URL is optional, so stamp it only when present and don't warn.
      if (this.paymentMethods.includes('ebayonly')) {
      if (IS_DEV_BUILD && !this.ebayStoreURL) {
      this.logger.error("finishProduct| supplier declares 'ebayonly' but sets no ebayStoreURL", {
      supplier: this.supplierName,
      });
      }
      product.setSupplierEbayStoreURL(this.ebayStoreURL);
      } else if (this.paymentMethods.includes('ebay') && this.ebayStoreURL) {
      product.setSupplierEbayStoreURL(this.ebayStoreURL);
      }

      if (this.paymentMethods.includes('amazononly')) {
      if (IS_DEV_BUILD && !this.amazonStoreURL) {
      this.logger.error(
      "finishProduct| supplier declares 'amazononly' but sets no amazonStoreURL",
      { supplier: this.supplierName },
      );
      }
      product.setSupplierAmazonStoreURL(this.amazonStoreURL);
      } else if (this.paymentMethods.includes('amazon') && this.amazonStoreURL) {
      product.setSupplierAmazonStoreURL(this.amazonStoreURL);
      }

      const built = await product.build();
      return built;
      }
    • The stable per-product cache/exclusion key for a builder: the identity stamped on it at parse time (getUniqueProductKeysetCacheKey), hashed with the supplier name via getProductIdentityKey. Returns undefined when no identity was stamped (so callers can skip the identity cache/exclusion path).

      Parameters

      Returns undefined | string

      The identity cache key, or undefined when unstamped

      const key = this.productIdentityKey(builder); // md5({key, supplier}) or undefined
      
        protected productIdentityKey(product: ProductBuilder<T>): string | undefined {
      const identity = product.get('cacheKey');
      if (typeof identity === 'string' && identity.length > 0) {
      return this.cache.getProductIdentityCacheKey(identity);
      }
      return undefined;
      }
    • Whether a product is on the user's ignore list, matched by its identity key (productIdentityKey) — the same key the "Ignore Product" action writes.

      Parameters

      Returns boolean

      true if the product matches an ignore-list entry

      if (this.isExcluded(builder)) continue; // skip ignored product
      
        protected isExcluded(product: ProductBuilder<T>): boolean {
      const identityKey = this.productIdentityKey(product);
      return identityKey !== undefined && this.excludedProductKeys.has(identityKey);
      }
    • Partitions query-phase builders for a batch supplier (one that enriches details up front rather than per-product in getProductData). Runs a three-way split: ignored products are dropped from both results; cache hits (found in the product-detail cache by their stamped identity) are hydrated in place via setData and kept in survivors but excluded from misses; everything else is a miss, kept in both. The caller enriches only misses, then caches them, and returns survivors.

      Skips the cache lookup entirely when skipProductDetailCache is true (pure-search suppliers), so those still drop ignored products but treat every survivor as needing no enrichment.

      Parameters

      Returns Promise<
          {
              survivors: ProductBuilder<Product>[];
              misses: ProductBuilder<Product>[];
          },
      >

      { survivors, misses } — see above

      const { survivors, misses } = await this.partitionForBatch(builders);
      await this.enrichVariants(misses);
      await this.cacheProductBuilders(misses);
      return survivors;
        protected async partitionForBatch(
      products: ProductBuilder<T>[],
      ): Promise<{ survivors: ProductBuilder<T>[]; misses: ProductBuilder<T>[] }> {
      const survivors: ProductBuilder<T>[] = [];
      const misses: ProductBuilder<T>[] = [];
      for (const product of products) {
      if (this.isExcluded(product)) {
      continue;
      }
      survivors.push(product);
      if (this.skipProductDetailCache) {
      continue;
      }
      const key = this.productIdentityKey(product);
      const cached = key ? await this.cache.getCachedProductData(key) : undefined;
      if (isCachedProductData<T>(cached)) {
      product.setData(cached);
      } else {
      misses.push(product);
      }
      }
      return { survivors, misses };
      }
    • Writes each enriched builder to the product-detail cache under its stamped identity key. No-ops for suppliers with skipProductDetailCache true, for aborted searches, and for builders shouldCacheProductData rejects (e.g. a fetch that hit a noCacheStatusCode). Used by batch suppliers after enriching their misses.

      Parameters

      Returns Promise<void>

      A promise that resolves once all writes complete

      await this.cacheProductBuilders(misses);
      
        protected async cacheProductBuilders(products: ProductBuilder<T>[]): Promise<void> {
      if (this.skipProductDetailCache || this.controller.signal.aborted) {
      return;
      }
      await Promise.all(
      products.map(async (product) => {
      const key = this.productIdentityKey(product);
      if (key && this.shouldCacheProductData(product)) {
      await this.cache.cacheProductData(key, product.dump());
      }
      }),
      );
      }
    • Takes in either a relative or absolute URL and returns an absolute URL. This is useful for when you aren't sure if the link (retrieved from parsed text, a setting, an element, an anchor value, etc) is absolute or not. Using relative links will result in http://chrome-extension://... being added to the link.

      Parameters

      • path: string | URL

        URL object or string

      • Optionalparams: Maybe<RequestParams>

        The parameters to add to the URL.

      • Optionalhost: string

        The host to use for overrides (eg: needing to call a different host for an API)

      Returns string

      absolute URL

      this.href('/some/path')
      // https://supplier_base_url.com/some/path

      this.href('https://supplier_base_url.com/some/path', null, 'another_host.com')
      // https://another_host.com/some/path

      this.href('/some/path', { a: 'b', c: 'd' }, 'another_host.com')
      // http://another_host.com/some/path?a=b&c=d

      this.href('https://supplier_base_url.com/some/path')
      // https://supplier_base_url.com/some/path

      this.href(new URL('https://supplier_base_url.com/some/path'))
      // https://supplier_base_url.com/some/path

      this.href('/some/path', { a: 'b', c: 'd' })
      // https://supplier_base_url.com/some/path?a=b&c=d

      this.href('https://supplier_base_url.com/some/path', new URLSearchParams({ a: 'b', c: 'd' }))
      // https://supplier_base_url.com/some/path?a=b&c=d
        protected href(path: string | URL, params?: Maybe<RequestParams>, host?: string): string {
      const href = new URL(path, this.baseURL);

      if (host) {
      href.host = host;
      }

      if (params && Object.keys(params).length > 0) {
      href.search = this.buildSearchParams(params).toString();
      }

      return String(href);
      }
    • Recursively serializes an object into URLSearchParams, encoding nested objects with bracket notation (parent[child]=value). Fixes the case that new URLSearchParams(obj) mishandles — it stringifies a nested object to "[object Object]" — so a params object with nested filters serializes correctly. Primitive values (and arrays, which serialize comma-joined like URLSearchParams does) are appended directly.

      Parameters

      • obj: Record<string, unknown>

        The params object to serialize

      • params: URLSearchParams = ...

        The URLSearchParams to append into (defaults to a fresh instance)

      • prefix: string = ''

        The key prefix used while recursing into nested objects

      Returns URLSearchParams

      The populated URLSearchParams

      this.buildSearchParams({ q: "acid", filter: { size: "500g" } }).toString();
      // "q=acid&filter%5Bsize%5D=500g" (i.e. filter[size]=500g)
        protected buildSearchParams(
      obj: Record<string, unknown>,
      params: URLSearchParams = new URLSearchParams(),
      prefix: string = '',
      ): URLSearchParams {
      for (const [key, value] of Object.entries(obj)) {
      // Bracket-nest the key as depth grows: parent[child][grandchild]...
      const formKey = prefix ? `${prefix}[${key}]` : key;
      if (isPopulatedObject(value)) {
      this.buildSearchParams(value, params, formKey);
      } else {
      params.append(formKey, String(value));
      }
      }
      return params;
      }
    • Retrieves product data with caching support. Similar to getProductData but allows for additional parameters to be included in the cache key.

      Parameters

      Returns Promise<void | ProductBuilder<Product>>

      Promise resolving to the updated ProductBuilder or void if fetch fails

      const builder = new ProductBuilder<Product>(this.baseURL);
      builder.setBasicInfo("Acetone", "/products/acetone", "ChemSupplier");

      const updatedBuilder = await supplier.getProductDataWithCache(
      builder,
      async (b) => {
      // Custom fetching logic
      return b;
      },
      );
        protected async getProductDataWithCache(
      product: ProductBuilder<T>,
      fetcher: (builder: ProductBuilder<T>) => Promise<ProductBuilder<T> | void>,
      ): Promise<ProductBuilder<T> | void> {
      const url = product.get('url');
      if (typeof url !== 'string') {
      this.logger.error('[SupplierBase > getProductDataWithCache] Invalid URL in product:', {
      url,
      });
      return undefined;
      }
      // Skip products the user has ignored (matched by identity key).
      if (this.isExcluded(product)) {
      this.logger.debug('[SupplierBase > getProductDataWithCache] Skipping excluded product', {
      url,
      supplierName: this.supplierName,
      });
      return undefined;
      }

      // Key by the supplier's stable identity, stamped on the builder at parse
      // time. Absent only if a supplier failed to stamp one, in which case this
      // product simply isn't cached.
      const cacheKey = this.productIdentityKey(product);
      this.logger.debug(
      '[SupplierBase > getProductDataWithCache] Product detail cache key:',
      cacheKey,
      {
      url,
      },
      );
      try {
      if (!this.skipProductDetailCache && cacheKey) {
      const cachedData = await this.cache.getCachedProductData(cacheKey);
      if (isCachedProductData<T>(cachedData)) {
      product.setData(cachedData);
      return product;
      }
      }
      // Cache miss (or caching skipped): run setup (memoized) so any state
      // subclasses rely on is ready before the fetcher reads it, then fetch.
      await this.ensureSetup();
      let resultBuilder: ProductBuilder<T> | void = undefined;
      try {
      resultBuilder = await fetcher(product);
      } catch (err: unknown) {
      this.logger.error(
      '[SupplierBase > getProductDataWithCache] Error in product detail fetcher:',
      err,
      );
      incrementParseError(this.supplierName);
      return undefined;
      }
      if (resultBuilder) {
      incrementProductCount(this.supplierName);
      // Skip caching when the search was aborted (e.g. supplierSearchTimeBudgetSec) — the enrichment
      // fetch was cancelled, so the data is incomplete and a later search should retry it.
      if (
      cacheKey &&
      !this.skipProductDetailCache &&
      !this.controller.signal.aborted &&
      this.shouldCacheProductData(resultBuilder)
      ) {
      await this.cache.cacheProductData(cacheKey, resultBuilder.dump());
      }
      }
      return resultBuilder;
      } catch (outerErr: unknown) {
      this.logger.error(
      '[SupplierBase > getProductDataWithCache] Error in getProductDataWithCache:',
      outerErr,
      );
      incrementParseError(this.supplierName);
      return undefined;
      }
      }
    • The key under which a product's detail-fetch failures are recorded/looked up: its permalink if set, otherwise its processing URL. Subclasses that fetch supplemental data should record failures under this same key so shouldCacheProductData can match them.

      Parameters

      Returns undefined | string

      The fetch key, or undefined when neither permalink nor url is a string

      this.productFetchKey(builder); // "https://www.aladdinsci.com/us_en/x.html"
      
        protected productFetchKey(product: ProductBuilder<T>): string | undefined {
      const key = product.get('permalink') ?? product.get('url');
      return typeof key === 'string' ? key : undefined;
      }
    • Records the HTTP status of a failed product-detail fetch so shouldCacheProductData can skip caching it. Non-HTTP failures (no status) are not recorded.

      Parameters

      • key: string

        The product fetch key (see productFetchKey)

      • OptionalhttpStatus: number

        The HTTP status of the failure, if it was an HttpError

      Returns void

      void

      this.recordFetchFailure(permalink, 429);
      
        protected recordFetchFailure(key: string, httpStatus?: number): void {
      if (typeof httpStatus === 'number') {
      this.failedFetchStatuses.set(key, httpStatus);
      }
      }
    • Decides whether a freshly-fetched product's detail data should be written to the cache. Skips caching when the product's last detail fetch failed with a noCacheStatusCodes status (default 429), so a later search retries it instead of serving the incomplete cached entry. The product is still listed regardless.

      Parameters

      Returns boolean

      True to cache the product data, false to skip caching it

      this.shouldCacheProductData(builder); // false when the detail fetch hit a 429
      
        protected shouldCacheProductData(product: ProductBuilder<T>): boolean {
      const key = this.productFetchKey(product);
      if (key === undefined) {
      return true;
      }
      const failedStatus = this.failedFetchStatuses.get(key);
      return failedStatus === undefined || !this.noCacheStatusCodes.includes(failedStatus);
      }
    • Groups variants of a product by their title

      Type Parameters

      • R

      Parameters

      • data: R[]

        Array of product listings from search results

      Returns R[]

      Array of product listings with grouped variants

      Create a generic method for this, the same method is used in Synthetika and could be of use with LoudWolf.

      const results = await this.queryProducts("sodium chloride");
      const grouped = this.groupVariants(results);
      // grouped is an array of product listings with grouped variants
        protected groupVariants<R>(data: R[]): R[] {
      const variants: GroupedItem<R>[] = data
      .map((item) => {
      const title = this.titleSelector(item);
      if (!title) {
      this.logger.error('No title found in product:', { item });
      return undefined;
      }
      const groupId = stripQuantityFromString(title.replace(/(?<=\d{1,3})\s(?=\d{3})/g, ''));
      const groupIdWithoutSpaces = groupId.replace(/[\s-]/g, '');
      return { ...item, groupId: groupIdWithoutSpaces };
      })
      .filter((item): item is GroupedItem<R> => item !== undefined);

      const products = Object.groupBy(variants, (item) => item.groupId);

      return Object.values(products)
      .filter((product): product is GroupedItem<R>[] => product !== undefined)
      .map((product) => {
      const main = product.splice(0, 1)[0];
      // eslint-disable-next-line @typescript-eslint/no-unused-vars
      const { groupId, ...newObject } = main;
      // R is unconstrained, so TS widens newObject.variants to
      // R["variants"] & (R[] | undefined), which it cannot prove product
      // (GroupedItem<R>[]) satisfies; assert to the destructured property type.
      newObject.variants = product as typeof newObject.variants;

      return newObject;
      })
      .filter((item): item is GroupedItem<R> => item !== undefined);
      }
    • Runs an HTTP request from the extension's background service worker instead of this (page) context, sidestepping the CORS restrictions that apply to extension pages. The target host must be granted in the manifest host_permissions. Returns a real Response (text/JSON bodies only). Independent of fetch — it does not share the request counter, hard limit, or WAF retry logic.

      Parameters

      • url: string

        The absolute URL to request.

      • Optionalinit: BackgroundFetchInit

        Optional serializable request options (method, headers, body, etc.).

      Returns Promise<Response>

      A Response reconstructed from the worker's reply.

      // Inside a supplier method, e.g. scraping an asset blocked by page CORS:
      const homepage = await this.backgroundFetch("https://chemsavers.com/");
      const html = await homepage.text();

      const search = await this.backgroundFetch("https://api.example.com/search", {
      method: "POST",
      headers: { "content-type": "application/json" },
      body: JSON.stringify({ q: "acid" }),
      });
      const results = search.ok ? await search.json() : undefined;
        protected async backgroundFetch(url: string, init?: BackgroundFetchInit): Promise<Response> {
      this.logger.debug(`Background fetching: ${url}`);
      return backgroundFetch(url, init);
      }
    • Internal fetch method with request counting and decorator. Tracks request count and enforces hard limits on HTTP requests.

      Parameters

      • ...args: [input: URL | RequestInfo, init?: RequestInit]

        Arguments to pass to fetchDecorator (usually a Request or URL and options)

      Returns Promise<FetchDecoratorResponse>

      The response from the fetchDecorator

      Error if request count exceeds hard limit

      // Example usage inside a subclass:
      const response = await this.fetch(new Request('https://example.com'));
      if (response.ok) {
      const data = await response.json();
      console.log(data);
      }
      // With custom request options
      const response = await this.fetch(
      new Request('https://example.com', {
      headers: { 'Accept': 'application/json' }
      })
      );
        protected async fetch(
      ...args: Parameters<typeof fetchDecorator>
      ): Promise<FetchDecoratorResponse> {
      const [input] = args;
      this.logger.debug(`Fetching: ${input}`);

      // One initial attempt plus up to `challengeRetryLimit` retries. A 403 from
      // a WAF cookie handshake plants a cookie on the first hit (stored because
      // credentials:"include"); the retry sends it back and usually passes.
      const maxAttempts = 1 + Math.max(0, this.challengeRetryLimit);

      for (let attempt = 1; attempt <= maxAttempts; attempt++) {
      // Each attempt is a real network request, so it counts toward the hard
      // limit. For non-retrying suppliers (maxAttempts === 1) this is
      // identical to the previous single increment.
      this.requestCount++;
      if (this.requestCount > this.httpRequestHardLimit) {
      this.logger.warn('Request count exceeded hard limit', { requestCount: this.requestCount });
      incrementFailure(this.supplierName);
      throw new Error('Request count exceeded hard limit');
      }

      try {
      const response = await fetchDecorator(...args);
      this.logger.debug(`Response Status: ${response.status}`);
      this.logger.debug('response hash:', response.requestHash);
      if (typeof response.data === 'string' && response.data?.length === 0) {
      throw new EmptyResponseError(`Invalid response: ${response.data}`);
      }
      incrementSuccess(this.supplierName);
      return response;
      } catch (error: unknown) {
      if (this.shouldRetryChallenge(error) && attempt < maxAttempts) {
      this.logger.warn('Retrying after 403 (WAF cookie handshake)', {
      attempt,
      maxAttempts,
      input,
      });
      await sleep(this.challengeRetryDelayMs);
      continue;
      }
      incrementFailure(this.supplierName);
      throw error;
      }
      }

      // Unreachable: the loop always returns on success or throws on the final
      // failed attempt. Present only to satisfy the return-type checker.
      throw new Error('fetch: exhausted retries without resolving');
      }

    Properties

    supplierName: string = 'Ambeed'

    The name of the supplier (used for display name, lists, etc).

    supportsCAS: boolean = true

    Whether this supplier can search its own site by a CAS number / molecular formula / SMILES directly. Default false: the supplier matches product names, not identifiers, so when the query is one of these identifier types (see detectTermType) the base swaps it for the chemical name the factory resolved (see effectiveQuery). Set the relevant flag true on a supplier whose search natively accepts that identifier (e.g. Ambeed), so it receives the raw identifier unchanged.

    supportsFormula: boolean = true
    supportsSMILES: boolean = true
    baseURL: string = 'https://www.ambeed.com'

    The base URL for the supplier.

    shipping: ShippingRange = 'international'

    The shipping scope of the supplier. Used to determine the shipping scope of the supplier.

    country: valueof = 'CN'

    The country code of the supplier. Used to determine the currency and other country-specific information.

    shipsTo: valueof<any>[] = ...

    The countries to which the supplier ships.

    public readonly shipsTo: CountryCode[] = ["US", "CN", "NL"];
    
      public static readonly shipsTo: CountryCode[] = [
    'AR',
    'BR',
    'CA',
    'MX',
    'US',
    'AT',
    'BE',
    'BG',
    'HR',
    'CY',
    'CZ',
    'DK',
    'EE',
    'FI',
    'FR',
    'DE',
    'GR',
    'HU',
    'IE',
    'IT',
    'LV',
    'LI',
    'LT',
    'LU',
    'MT',
    'NL',
    'NO',
    'PL',
    'PT',
    'RO',
    'SK',
    'SI',
    'ES',
    'SE',
    'CH',
    'TR',
    'GB',
    'AU',
    'CN',
    'IN',
    'ID',
    'JP',
    'KR',
    'MY',
    'NZ',
    'PH',
    'SG',
    'TH',
    'VN',
    'EG',
    'IL',
    ] as const;
    paymentMethods: PaymentMethod[] = ...

    The payment methods accepted by the supplier. Used to determine the payment methods accepted by the supplier.

    queryResults: AmbeedProductObject[] = []

    If the products first require a query of a search page that gets iterated over, those results are stored here. Acts as a cache for the initial search results before they are processed into full product objects.

    httpRequstCount: number = 0
    signSecret: string = ...

    The sign secret for the Ambeed API.

    xsrfToken: string = ''

    The XSRF token for the Ambeed API.

    headers: HeadersInit = ...

    HTTP headers used as a basis for all requests to the supplier. These headers are merged with any request-specific headers when making HTTP requests.

    class MySupplier extends SupplierBase<Product> {
    constructor() {
    super();
    this.headers = {
    "Accept": "application/json",
    "User-Agent": "ChemPal/1.0"
    };
    }
    }
      protected headers: HeadersInit = {
    accept: [
    'text/html',
    'application/xhtml+xml',
    'application/xml;q=0.9',
    'image/avif',
    'image/webp',
    'image/apng',
    '*/*;q=0.8',
    ].join(','),
    'accept-language': 'en-US,en;q=0.6',
    'cache-control': 'no-cache',
    pragma: 'no-cache',
    'x-requested-with': 'XMLHttpRequest',
    };
    color: string = ...

    Color used to visually tag this supplier's log output (and available for charts/UI). Defaults to a stable palette color derived from the class name via getSupplierColor, so no supplier has to set one. Override by assigning a hex string in a subclass constructor (also call this.logger.setColor(this.color) there to recolor the already-built logger).

    minMatchPercentage: number = 65

    The minimum match percentage for a product to be considered a match.

    fuzzScorer: FuzzScorerFn = WRatio

    Fuzz scorer used by fuzzyFilter to score each candidate's title against the query. Any function from fuzzball with the (str1, str2, opts?) => number shape works. Subclasses override this when a supplier's title format needs a different scorer (e.g. a catalog that pads titles with boilerplate might prefer partial_ratio). Defaults to WRatio.

    Overridable at runtime from userSettings.fuzzScorerOverride — see setFuzzScorerOverride and fuzzyFilter below. The user's Advanced settings selection wins over this subclass default when set.

    fuzzScorerOverride?: FuzzScorerFn

    Runtime override resolved from userSettings.fuzzScorerOverride. When set, fuzzyFilter uses this instead of this.fuzzScorer. Undefined (the default) means "use whatever the supplier class picked". Mutated by setFuzzScorerOverride so it can't be readonly.

    parsedQuery?: ParsedSearchQuery

    Parsed advanced-search query, set per-instance by SupplierFactory from the user's input. When absent (e.g. a directly-constructed test supplier), getAst lazily parses this.query instead.

    resolvedStructures?: ReadonlyMap<string, ResolvedStructure>

    SMILES/structure query terms resolved to their chemical identifiers, keyed by the raw search term. Resolved once per search by SupplierFactory (network- bound, via NCI Cactus/PubChem) and shared with every supplier so none of them re-resolve. Undefined when the query has no structure terms. Only suppliers that filter by structure (currently Ambeed) read this; others ignore it.

    fuzzyFilteringDisabled: boolean = false

    Runtime flag resolved from userSettings.fuzzyFilteringDisabled. When true, fuzzyFilterAst skips fuzzball scoring: plain queries return raw supplier results and advanced queries are filtered only by the boolean predicate via case-insensitive substring matching.

    fuzzyFilterRankOnly: boolean = false

    Fuzzy strategy. When true (the default), fuzzyFilter/fuzzyFilterAst rank candidates by fuzz score and keep them all (in score order) instead of dropping anything below minMatchPercentage; the base search pipeline then caps the list to limit, so the highest-scoring matches survive. This avoids dropping clear matches whose ratio-style score falls under the cutoff purely because the title dwarfs the query. Set to false on a supplier to restore the hard-cutoff behavior.

    maxFallbackQueries: number = 4

    Maximum number of backend search requests the keyword-only fallback issues.

    supportsNativeAdvancedSearch: boolean = false

    Whether queryProducts handles an advanced (boolean) query natively in a single request — true for suppliers that translate the AST into a server-side query (Wix, Shopify, Chemsavers/Typesense, LiMac/FreeFind). When false (the default), queryProductsWithCache drives the keyword-only fallback: one backend search per positive OR-group, unioned and deduped, with the full boolean predicate enforced client-side by fuzzyFilterAst.

    skipProductDetailCache: boolean = false

    Opt-out flag for the per-product detail cache. Left false (the default), every supplier caches its per-product detail data — the safe default, since forgetting to set this just yields harmless redundant caching, never a silent cache regression.

    Set true only on a supplier that resolves every field in the initial search (a passthrough getProductData with no per-product fetch): for those the per-product cache saves nothing, so getProductData/getProductDataWithCache/partitionForBatch skip the product-detail cache read+write. The query cache still serves repeat searches, and getUniqueProductKey is still used for exclusions. Mark the concrete pure-search supplier (not a shared base class), so a base's fetching subclass keeps caching by default.

    ebayStoreURL?: string

    The supplier's eBay storefront. Subclasses that list "ebayonly" in SupplierBase.paymentMethods must override this; see src/suppliers/__tests__/storeOnlyPaymentMethods.test.ts, which enforces the pairing that TypeScript can't express.

    amazonStoreURL?: string

    The supplier's Amazon storefront. Required alongside "amazononly", exactly as ebayStoreURL is for "ebayonly".

    apiURL?: string

    Optional external API hostname used by some suppliers (e.g., Typesense, Searchanise). When set, automatically included in requiredHosts for permission checks.

    query: string

    String to query for (product name, CAS, etc.). The search term that will be used to find products. Set during construction and used throughout the supplier's lifecycle.

    baseSearchParams: Record<string, string | number> = {}

    The base search parameters that are always included in search requests. These parameters are merged with any additional search parameters when making requests to the supplier's API.

    class MySupplier extends SupplierBase<Product> {
    constructor() {
    super();
    this.baseSearchParams = {
    format: "json",
    version: "2.0"
    };
    }
    }
      protected baseSearchParams: Record<string, string | number> = {};
    
    controller: AbortController

    The AbortController instance used to manage and cancel ongoing requests. This allows for cancellation of in-flight requests when needed, such as when a new search is started or the supplier is disposed.

    const controller = new AbortController();
    const supplier = new MySupplier("acetone", 5, controller);

    // Later, to cancel all pending requests:
    controller.abort();
      protected controller: AbortController;
    
    limit: number

    The maximum number of results to return for a search query. This is not a limit on HTTP requests, but rather the number of products that will be returned to the caller.

    const supplier = new MySupplier("acetone", 5); // Limit to 5 results
    for await (const product of supplier) {
    // Will yield at most 5 products
    }
      protected limit: number;
    
    products: ProductBuilder<Product>[] = []

    The products that are currently being built by the supplier. This array holds ProductBuilder instances that are in the process of being transformed into complete Product objects.

    await supplier.queryProducts("acetone");
    console.log(`Building ${supplier.products.length} products`);
    for (const builder of supplier.products) {
    const product = await builder.build();
    console.log("Built product:", product.title);
    }
      protected products: ProductBuilder<T>[] = [];
    
    httpRequestHardLimit: number = 50

    Maximum number of HTTP requests allowed per search query. This is a hard limit to prevent excessive requests to the supplier's API. If this limit is reached, the supplier will stop making new requests.

    50
    
    class MySupplier extends SupplierBase<Product> {
    constructor() {
    super();
    this.httpRequestHardLimit = 100; // Allow more requests
    }
    }
      protected httpRequestHardLimit: number = 50;
    
    requestCount: number = 0

    Counter for HTTP requests made during the current query execution. This is used to track the number of requests and ensure we don't exceed the httpRequestHardLimit.

    0
    
    await supplier.queryProducts("acetone");
    console.log(`Made ${supplier.requestCount} requests`);
    if (supplier.requestCount >= supplier.httpRequestHardLimit) {
    console.log("Reached request limit");
    }
      protected requestCount: number = 0;
    
    maxConcurrentRequests: number = 3

    Number of requests to process in parallel when fetching product details. This controls the batch size for concurrent requests to avoid overwhelming the supplier's API and the user's bandwidth.

    10
    
    class MySupplier extends SupplierBase<Product> {
    constructor() {
    super();
    // Process 5 requests at a time
    this.maxConcurrentRequests = 5;
    }
    }
      protected maxConcurrentRequests: number = 3;
    
    minConcurrentCycle: number = 100

    Minimum number of milliseconds between two consecutive tasks

      protected minConcurrentCycle: number = 100;
    
    supplierSearchTimeBudgetSec: number = search.supplierSearchTimeBudgetSec

    Maximum wall-clock time (in seconds) a single supplier's execute() search may run. Once exceeded, any in-flight and pending product-detail requests are aborted and the search stops yielding new products — only those already collected are returned. Measured from the start of execute(), so it also bounds a slow initial query. Defaults to search.supplierSearchTimeBudgetSec from config.json; set to 0 to disable the limit. Override per supplier for sources that are slow or rate-limit-prone.

    search.supplierSearchTimeBudgetSec (config.json)

      protected supplierSearchTimeBudgetSec: number = search.supplierSearchTimeBudgetSec;
    
    requiredCookies: SupplierCookieSeed[] = []

    Cookies that must be written into the browser jar before any request runs — e.g. a currency or session-preference cookie the backend reads. Seeded once per instance by ensureSetup (before setup) via chrome.cookies, since the Cookie request header is on the fetch-forbidden list and can't be set through this.headers. Each entry's url defaults to baseURL. Subclasses override this instead of hand-rolling a setup that calls chrome.cookies.set directly.

    []
    
    class MySupplier extends SupplierBase<Partial<Product>, Product> {
    protected readonly requiredCookies: SupplierCookieSeed[] = [
    { name: "currency", value: "2" },
    ];
    }
      protected readonly requiredCookies: SupplierCookieSeed[] = [];
    
    challengeRetryLimit: number = 0

    Number of times fetch retries a request that comes back 403. Some suppliers sit behind a WAF that 403s the first hit while planting a session cookie (a "cookie handshake"); because every request now sets credentials: "include", that cookie lands in the jar and the retry carries it back, usually passing. We can't gate on the Set-Cookie header (it's fetch-forbidden and invisible to JS), so this per-supplier flag is the gate — 0 (the default) means never retry. Only enable it for suppliers known to do this handshake.

    0
    
      protected readonly challengeRetryLimit: number = 0;
    
    challengeRetryDelayMs: number = 300

    Delay in milliseconds between 403 challenge retries. Gives the WAF a brief beat before re-requesting with the freshly-planted cookie.

    300
    
      protected readonly challengeRetryDelayMs: number = 300;
    
    logger: Logger

    Logger for the supplier. Initialized in the constructor with the name of the inheriting class.

    productDefaults: ProductDefaults = ...

    Default values for products. These will get overridden if they're found in the product data.

    Cache instance for this supplier.

    Initialized after construction by initCache() (called from SupplierFactory once supplierName is set). The ! assertion is safe here because every code path that reads this.cache (queryProductsWithCache, getProductData, getProductDataWithCache) runs only after execute() is called on a factory-built instance, and the factory always calls initCache() before handing the instance out.

    noCacheStatusCodes: number[] = ...

    HTTP status codes that, when hit while fetching a product's detail data, prevent that product from being cached (see shouldCacheProductData). Mirrors userSettings.noCacheStatusCodes; set by initCache. Defaults to [429].

    failedFetchStatuses: Map<string, number> = ...

    Maps a product's fetch key (permalink, falling back to its processing URL) to the HTTP status of its last failed detail fetch. Populated by subclasses via recordFetchFailure and consulted by shouldCacheProductData. Per-search, since the factory builds a fresh supplier instance for each search.

    excludedProductKeys: Set<string> = ...

    Product-data cache keys the user has explicitly excluded via the "Ignore Product" context menu action. Loaded once per execute() from storage.local so membership checks are synchronous on the hot path (see getProductData). Newly-ignored products take effect on the next search, which matches the stated feature requirement.