Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x | import { CACHE } from '@/constants/common';
import { HttpStatus } from '@/constants/httpStatus';
import { HttpError, getErrorMessage } from '@/helpers/exceptions';
import { parseQuantity } from '@/helpers/quantity';
import { parseChemicalSpecs, parseGrade, parsePurity } from '@/helpers/science';
import { mapDefined } from '@/helpers/utils';
import { ProductBuilder } from '@/utils/ProductBuilder';
import { translateAstToTypesenseFilter } from '@/utils/search-query/translators/translateAstToTypesenseFilter';
import { cstorage } from '@/utils/storage';
import { assertValidSearchResponse } from '@/utils/typeGuards/chemsavers';
import { SupplierBase } from './SupplierBase';
/**
* Module used to retrieve products sold on the Chemsavers website.
*
* @remarks
*
* Chemsavers does have an exposed GraphQL API which can be used to retrieve product data, but
* an even easier option is to use the Typesense search API which has all of their products
* listed and is easily searchable.
* @category Suppliers
* @source
*/
export class SupplierChemsavers
extends SupplierBase<ChemsaversProductObject, Product>
implements ISupplier
{
// Name of supplier (for display purposes)
public static readonly supplierName: string = 'Chemsavers';
// Base URL for HTTP(s) requests
public static readonly baseURL: string = 'https://www.chemsavers.com';
// Shipping scope for Chemsavers
public static readonly shipping: ShippingRange = 'international';
// The country code of the supplier.
public static readonly country: CountryCode = 'US';
// The payment methods accepted by the supplier.
public static readonly paymentMethods: PaymentMethod[] = ['amazononly'];
public readonly amazonStoreURL: string = 'https://www.amazon.com/s?rh=p_89%3AChemsavers';
// The API URL for the Typesense search API.
protected static readonly apiURL: string = '0ul35zwtpkx14ifhp-1.a1.typesense.net';
// Override the type of queryResults to use our specific type
protected queryResults: Array<ChemsaversProductObject> = [];
// Used to keep track of how many requests have been made to the supplier.
protected httpRequstCount: number = 0;
// Default Typesense API key. Used unless a rehydrated key is found in storage
// (see loadStoredApiKey); replaced and persisted by rehydrateApiKey on a 401.
protected apiKey: string = 'iPltuzpMbSZEuxT0fjPI0Ct9R1UBETTd';
// Typesense's filter_by supports &&/||/! so advanced queries are translated
// server-side instead of using the keyword-only fallback.
protected readonly supportsNativeAdvancedSearch: boolean = true;
// The Typesense search response carries every field (including variants), so
// getProductData is a passthrough — there's no per-product detail fetch to
// cache. Products are still keyed for exclusions via getUniqueProductKey.
protected readonly skipProductDetailCache: boolean = true;
protected static readonly supportsCAS: boolean = true;
// protected static readonly supportsFormula: boolean = true;
// protected static readonly supportsSMILES: boolean = true;
/**
* Derives the unique product key from a Chemsavers product object: its `id`
* (the same value passed to `.setID`), stable across query and detail.
* @param data - The raw Chemsavers product object
* @returns The product's id
* @example
* ```typescript
* this.getUniqueProductKey(result); // "12345"
* ```
* @source
*/
protected getUniqueProductKey(data: ChemsaversProductObject): string {
return String(data.id);
}
// HTTP headers used as a basis for all queries.
protected headers: HeadersInit = {
accept: ['application/json', 'text/plain', '*/*'].join(','),
'accept-language': 'en-US,en;q=0.9',
'cache-control': 'no-cache',
'content-type': 'text/plain',
pragma: 'no-cache',
priority: 'u=1, i',
};
/**
* Rehydrates the API key for the Typesense search API.
* @returns Promise resolving to void
* @source
* ```typescript
* await this.rehydrateApiKey();
* ```
*/
protected async rehydrateApiKey() {
this.logger.debug('Rehydrating api key');
// const fetchParams = {
// headers: {
// accept: "*/*",
// "accept-language": "en-US,en;q=0.8",
// "cache-control": "no-cache",
// pragma: "no-cache",
// priority: "u=1",
// "sec-ch-ua": '"Brave";v="149", "Chromium";v="149", "Not)A;Brand";v="24"',
// "sec-ch-ua-mobile": "?0",
// "sec-ch-ua-platform": '"macOS"',
// "sec-fetch-dest": "script",
// "sec-fetch-mode": "no-cors",
// "sec-fetch-site": "cross-site",
// "sec-fetch-storage-access": "none",
// "sec-gpc": "1",
// },
// referrer: "https://chemsavers.com/",
// body: null,
// method: "GET",
// mode: "cors",
// credentials: "include",
// };
// Run the cross-origin scrape from the background service worker. Fetching the
// storefront document from this (side-panel) context trips the extension page's
// `script-src 'self'` CSP and CORS; the worker has no document/CSP context and
// returns the response as plain text for the regex below.
const getHomePageReq = await this.backgroundFetch('https://chemsavers.com/', {
headers: {
accept:
'text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8',
'accept-language': 'en-US,en;q=0.8',
'cache-control': 'no-cache',
pragma: 'no-cache',
},
method: 'GET',
credentials: 'include',
});
this.logger.debug('Fetched home page for API key extraction', { getHomePageReq });
const getHomePage = await getHomePageReq.text();
if (!getHomePage) {
this.logger.warn(`Failed to get content from ${this.baseURL}`);
return;
}
const scriptSrcPattern = new RegExp(
'<script\\s.*src="(?<src>.*).*"\\sonload="onThemeBundleMain\\(\\)"><\\/script>',
);
const scriptSrcMatch = scriptSrcPattern.exec(getHomePage);
if (!scriptSrcMatch?.groups?.src) {
this.logger.warn(`Failed to find script src in ${getHomePage}`);
return;
}
const getJsContentReq = await this.backgroundFetch(scriptSrcMatch.groups.src, {
headers: {
accept: '*/*',
'accept-language': 'en-US,en;q=0.8',
'cache-control': 'no-cache',
pragma: 'no-cache',
},
referrer: 'https://chemsavers.com/',
method: 'GET',
credentials: 'include',
});
const getJsContent = await getJsContentReq?.text();
if (!getJsContent) {
this.logger.warn(`Failed to get content from ${scriptSrcMatch.groups.src}`);
return;
}
const apiKeyPattern = new RegExp('{server:{apiKey:"(?<apiKey>[a-zA-Z0-9]+)",');
const apiKeyMatch = apiKeyPattern.exec(getJsContent);
if (!apiKeyMatch?.groups?.apiKey) {
this.logger.warn(`Failed to find api key js bundle`, {
getJsContent,
apiKeyMatch,
apiKeyPattern,
});
return;
}
if (this.apiKey === apiKeyMatch.groups.apiKey) {
this.logger.debug('API key is already rehydrated', { apiKey: this.apiKey });
return;
}
this.apiKey = apiKeyMatch.groups.apiKey;
// Persist the working key so future searches/sessions skip the scrape.
await this.storeApiKey(this.apiKey);
}
/**
* Executes a product search query and returns matching products
* @param query - Search term to look for
* @param limit - The maximum number of results to query for
* @returns Promise resolving to array of product objects or void if search fails
* @example
* ```typescript
* const products = await this.queryProducts("acid");
* if (products) {
* products.forEach(product => {
* console.log(product.title, product.price);
* });
* }
* ```
* @source
*/
protected async queryProducts(
query: string,
limit: number = this.limit,
): Promise<ProductBuilder<Product>[] | void> {
// Prefer a previously rehydrated key from storage; fall back to the hardcoded default.
await this.loadStoredApiKey();
const body = this.makeRequestBody(query);
let searchRequest: unknown;
try {
// Try the search with the current API key first. The key is only rehydrated when
// the server rejects it, avoiding the scrape on every search.
searchRequest = await this.searchTypesense(body);
} catch (error) {
if (!this.isUnauthorized(error)) {
this.logger.error(`Error querying products: ${getErrorMessage(error)}`, { error });
return;
}
// 401: the key is stale. Drop the dead stored key, rehydrate once, and retry. A
// second 401 (or any retry failure) propagates — we stop the search rather than
// continue with a dead key.
this.logger.warn('Search returned 401; rehydrating API key and retrying');
await this.clearStoredApiKey();
await this.rehydrateApiKey();
searchRequest = await this.searchTypesense(body);
}
try {
this.logger.debug('Received search response', { searchRequest });
assertValidSearchResponse(searchRequest);
// Keep in-stock products, plus untracked ones: BigCommerce reports
// inventory_tracking "none" with inventoryLevel 0, but those are always purchasable.
const products = searchRequest.results[0].hits
.flat()
.map((hit) => hit.document)
.filter((p) => p.inventory_tracking === 'none' || p.inventoryLevel > 0);
this.logger.debug('Mapped search hits to products', { products });
const fuzzResults = this.fuzzyFilterAst<ChemsaversProductObject>(products);
this.logger.debug('Applied fuzzy filter to products', {
query,
searchRequest,
products,
fuzzResults,
});
const grouped = this.groupVariants<ChemsaversProductObject>(fuzzResults);
// Initialize product builders from filtered results
return this.initProductBuilders(grouped.slice(0, limit));
} catch (error) {
this.logger.error(`Error querying products: ${getErrorMessage(error)}`, { error });
return;
}
}
/**
* Performs a single Typesense `/multi_search` request with the current API key.
* @param body - The Typesense multi-search request body from {@link makeRequestBody}.
* @returns Promise resolving to the raw (unvalidated) search response.
* @throws HttpError with `status` 401 when the API key is rejected.
* @example
* ```typescript
* const raw = await this.searchTypesense(this.makeRequestBody("acid"));
* ```
* @source
*/
private async searchTypesense(body: object): Promise<unknown> {
return this.httpPostJson({
path: `/multi_search`,
host: this.apiURL,
params: {
'x-typesense-api-key': this.apiKey,
},
body,
});
}
/**
* Whether an error is an HTTP `401 Unauthorized` — the signal that the Typesense API
* key is stale and should be rehydrated.
* @param error - The value thrown by {@link searchTypesense}.
* @returns `true` when the error is an {@link HttpError} with `status` 401.
* @example
* ```typescript
* this.isUnauthorized(new HttpError(401, "Unauthorized")); // => true
* this.isUnauthorized(new HttpError(500, "Server Error")); // => false
* ```
* @source
*/
private isUnauthorized(error: unknown): boolean {
return error instanceof HttpError && error.status === HttpStatus.UNAUTHORIZED;
}
/**
* Loads a previously rehydrated API key from storage and adopts it, overriding the
* hardcoded default. No-op when nothing is stored, so the default key is used.
* @returns Promise resolving once the key (if any) has been adopted.
* @example
* ```typescript
* await this.loadStoredApiKey(); // this.apiKey now reflects the stored key if present
* ```
* @source
*/
private async loadStoredApiKey(): Promise<void> {
try {
const stored = await cstorage.local.get([CACHE.CHEMSAVERS_API_KEY]);
const key: unknown = stored[CACHE.CHEMSAVERS_API_KEY];
if (typeof key === 'string' && key.length > 0) {
this.apiKey = key;
}
} catch (error) {
this.logger.warn(`Failed to read stored API key: ${getErrorMessage(error)}`, { error });
}
}
/**
* Persists a working API key to storage so future searches and sessions can reuse it
* without re-scraping the storefront.
* @param key - The validated API key to store.
* @returns Promise resolving once the key has been written.
* @example
* ```typescript
* await this.storeApiKey("abc123");
* ```
* @source
*/
private async storeApiKey(key: string): Promise<void> {
try {
await cstorage.local.set({ [CACHE.CHEMSAVERS_API_KEY]: key });
} catch (error) {
this.logger.warn(`Failed to persist API key: ${getErrorMessage(error)}`, { error });
}
}
/**
* Removes the stored API key after it has been rejected, so the next session falls
* back to the hardcoded default rather than reusing a dead key.
* @returns Promise resolving once the key has been removed.
* @example
* ```typescript
* await this.clearStoredApiKey();
* ```
* @source
*/
private async clearStoredApiKey(): Promise<void> {
try {
await cstorage.local.remove(CACHE.CHEMSAVERS_API_KEY);
} catch (error) {
this.logger.warn(`Failed to remove stored API key: ${getErrorMessage(error)}`, { error });
}
}
/**
* Initialize product builders from Chemsavers search response data.
* Transforms product listings into ProductBuilder instances, handling:
* - Basic product information (title, URL, supplier)
* - Product descriptions and specifications
* - Product IDs and SKUs
* - Pricing information with currency details
* - CAS number extraction from product text
* - Quantity parsing from product names and descriptions
* - Grade/purity level extraction
* - Product categories and classifications
*
* @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(product.title, product.price, product.grade);
* }
* }
* ```
* @source
*/
protected initProductBuilders(data: ChemsaversProductObject[]): ProductBuilder<Product>[] {
return mapDefined(data, (result) => {
const builder = new ProductBuilder<Product>(this.baseURL);
const quantity = parseQuantity(result.name);
if (quantity === undefined) return;
// Purity sits in the title (e.g. "...99.999% - 50 G"); the formula is labelled in
// the description ("... | Formula: Na2O2 | ..."). Both setters guard internally.
const specs = parseChemicalSpecs(result.description);
const image = result.images?.find((img) => img.isThumbnail) ?? result.images?.[0];
builder
.setBasicInfo(result.name, result.url, this.supplierName)
.setDescription(result.description)
.setMatchPercentage(result.matchPercentage)
.setID(result.id)
.setCacheKey(this.getUniqueProductKey(result))
.setSku(result.sku)
.setPricing(result.price, 'USD', '$')
.setQuantity(quantity.quantity, quantity.uom)
.setCAS(result.CAS)
.setPurity(parsePurity(result.name))
.setGrade(parseGrade(result.name))
.setFormula(specs.formula)
.setImage(image?.urlStandard)
.setThumbnail(image?.urlThumbnail);
if (result.variants) {
builder.setVariants(
mapDefined(result.variants, (variant: ChemsaversProductVariant) => {
const quantity = parseQuantity(variant.name);
if (quantity === undefined) return;
return {
id: variant.id,
sku: variant.sku,
title: variant.name,
price: variant.price,
url: variant.url,
...quantity,
};
}),
);
}
return builder;
});
}
/**
* Creates the request body for the Typesense search API.
*
* Constructs a search request object that:
* - Searches across name, CAS, and SKU fields
* - Highlights matches in these fields
* - Returns paginated results based on the specified limit
* - Uses the 'products' collection
*
* @param query - The search term to look for in the product database
* @param limit - Maximum number of results to return (defaults to this.limit)
* @returns An object containing the search configuration for the Typesense API
* @source
*/
protected makeRequestBody(query: string, limit: number = 100): object {
const parsed = this.getAst();
// For an advanced query, let Typesense's filter_by do the boolean matching
// over `name` and return everything else via the `*` wildcard query.
const search = parsed.isAdvanced
? { q: '*', filter_by: translateAstToTypesenseFilter(parsed.ast) }
: { q: query };
return {
searches: [
{
query_by: 'name, CAS, sku',
highlight_full_fields: 'name, CAS, sku',
collection: 'products',
...search,
page: 0,
per_page: limit,
},
],
};
}
/**
* Transforms a Laboratorium Discounter product into the common Product type
* Extracts quantity information from various product fields and normalizes the data
* @param product - Product object from Laboratorium Discounter
* @returns Promise resolving to a partial Product object or void if invalid
* @example
* ```typescript
* const products = await this.queryProducts("acid");
* if (products) {
* const product = await this.getProductData(products[0]);
* if (product) {
* console.log(product.title, product.price, product.quantity, product.uom);
* }
* }
* ```
* @source
*/
protected async getProductData(
product: ProductBuilder<Product>,
): Promise<ProductBuilder<Product> | void> {
// Since Chemsavers includes all product data in search results,
// we can just return the product builder directly
return this.getProductDataWithCache(product, async (builder) => builder);
}
/**
* Selects the title of a product from the search response
* @param data - Product object from search response
* @returns - The title of the product
* @source
*/
protected titleSelector(data: ChemsaversProductObject): string {
return data.name;
}
}
|