@factorypure/client-helpers 1.0.1 → 1.0.2

package/dist/index.d.ts

@@ -1 +1,37 @@
-export declare const filterScrapeResults: ({ scrapeResults, product, variant, filters, filterOptions, }: any) => any;
+import { z } from "zod";
+export declare const scrapeResultsSchema: any;
+export type ScrapeResultsType = z.infer<typeof scrapeResultsSchema>;
+export type ScrapeFiltersType = {
+    found_id_exclusions: number[];
+    showHighPriceOutliers: boolean;
+    showLowPriceOutliers: boolean;
+    dayWindow: number | null;
+    competitor_exclusions: string[];
+    match_values: string[];
+    skip_skus: string[];
+    vendor_search_exclusions: string[];
+    search_exclusions: string[];
+};
+export type FilterOptionsType = {
+    exclude_linked_variants_enabled?: boolean;
+    found_id_exclusions_enabled?: boolean;
+    price_filter_enabled?: boolean;
+    date_filter_enabled?: boolean;
+    competitor_filter_enabled?: boolean;
+    duplicates_filter_enabled?: boolean;
+    search_index_enabled?: boolean;
+    skip_skus_enabled?: boolean;
+    wattage_exclusions_enabled?: boolean;
+    search_exclusions_enabled?: boolean;
+};
+export declare const filterScrapeResults: ({ scrapeResults, variant, filters, filterOptions, }: {
+    scrapeResults: ScrapeResultsType[];
+    variant: {
+        id: number;
+        title: string;
+        sku: string;
+        price: number;
+    };
+    filters: ScrapeFiltersType;
+    filterOptions?: FilterOptionsType;
+}) => z.infer<any>[];

package/dist/index.js

@@ -3,10 +3,44 @@ import { subDays } from "date-fns";
 import { Index } from "flexsearch";
 // @ts-ignore
 import EnglishPreset from "flexsearch/lang/en";
+// @ts-ignore
+import { z } from "zod";
+export const scrapeResultsSchema = z.object({
+    id: z.number(),
+    scrape_id: z.number(),
+    variant_id: z.number(),
+    type: z.string(),
+    format: z.nullable(z.any()),
+    position: z.number(),
+    title: z.string(),
+    found_product_id: z.number(),
+    product_link: z.string(),
+    inline_link: z.nullable(z.any()),
+    immersive_product_page_token: z.string(),
+    serpapi_immersive_product_api: z.string(),
+    source: z.string(),
+    source_icon: z.string(),
+    multiple_sources: z.number(),
+    price: z.string(),
+    extracted_price: z.number(),
+    old_price: z.nullable(z.any()),
+    extracted_old_price: z.nullable(z.any()),
+    rating: z.nullable(z.any()),
+    reviews: z.nullable(z.any()),
+    snippet: z.nullable(z.any()),
+    thumbnail: z.string(),
+    serpapi_thumbnail: z.string(),
+    tag: z.nullable(z.any()),
+    extensions: z.nullable(z.any()),
+    delivery: z.nullable(z.any()),
+    created_at: z.string(),
+    store_id: z.number(),
+    match_score: z.number().nullable(),
+});
 const TOO_CHEAP_MULTIPLIER = 0.75;
 const TOO_EXPENSIVE_MULTIPLIER = 1.25;
 const wattages = Array.from({ length: 41 }, (_, i) => (5000 + i * 500).toString());
-export const filterScrapeResults = ({ scrapeResults, product, variant, filters, filterOptions = {
+export const filterScrapeResults = ({ scrapeResults, variant, filters, filterOptions = {
     exclude_linked_variants_enabled: true,
     found_id_exclusions_enabled: true,
     price_filter_enabled: true,
@@ -20,13 +54,13 @@ export const filterScrapeResults = ({ scrapeResults, product, variant, filters,
 }, }) => {
     let filteredResults = scrapeResults;
     if (filterOptions.exclude_linked_variants_enabled) {
-        filteredResults = filterLinkedElsewhereResults(filteredResults, variant);
+        filteredResults = filterLinkedElsewhereResults(filteredResults, variant.id);
     }
     if (filterOptions.found_id_exclusions_enabled) {
         filteredResults = filterFoundProductIdExclusions(filteredResults, filters.found_id_exclusions);
     }
     if (filterOptions.price_filter_enabled) {
-        filteredResults = filterPriceOutliers(filteredResults, variant, filters.showHighPriceOutliers, filters.showLowPriceOutliers);
+        filteredResults = filterPriceOutliers(filteredResults, variant.price, filters.showHighPriceOutliers, filters.showLowPriceOutliers);
     }
     if (filterOptions.date_filter_enabled) {
         filteredResults = filterDateWindow(filteredResults, filters.dayWindow);
@@ -38,11 +72,12 @@ export const filterScrapeResults = ({ scrapeResults, product, variant, filters,
         filteredResults = filterDuplicateResults(filteredResults);
     }
     if (filterOptions.search_index_enabled) {
-        filteredResults = handleIndexSearch(filteredResults, filters, variant, product, filterOptions);
+        filteredResults = handleIndexSearch(filteredResults, filters, variant, filterOptions);
     }
     return filteredResults;
 };
-const handleIndexSearch = (dataToSearch, filters, variant, product, filterOptions) => {
+const handleIndexSearch = (dataToSearch, filters, variant, filterOptions) => {
+    const { title, sku } = variant;
     function customEncoder(content) {
         const tokens = [];
         const str = content.toLowerCase();
@@ -68,12 +103,12 @@ const handleIndexSearch = (dataToSearch, filters, variant, product, filterOption
     const nots = [];
     if (filters.skip_skus.length && filterOptions.skip_skus_enabled) {
         const formatted = filters.skip_skus
-            .filter((sku) => sku.toLowerCase() !== variant.sku.toLowerCase())
+            .filter((sku) => sku.toLowerCase() !== sku.toLowerCase())
             .map((sku) => ` ${sku} `);
         nots.push(...formatted);
     }
-    const title = variant.title.toLowerCase();
-    const titleWithoutSku = title.replace(variant.sku.toLowerCase(), "");
+    const lowerCaseTitle = title.toLowerCase();
+    const titleWithoutSku = lowerCaseTitle.replace(sku.toLowerCase(), "");
     const wattageTerms = Array.from(titleWithoutSku.matchAll(/\b(\d{4,5})w\b/gi)).map((match) => match[1]);
     const wattagesToExclude = wattages.filter((wattage) => !wattageTerms.includes(wattage));
     if (filterOptions.wattage_exclusions_enabled) {
@@ -92,9 +127,9 @@ const handleIndexSearch = (dataToSearch, filters, variant, product, filterOption
     }
     if (filters.vendor_search_exclusions.length &&
         filterOptions.skip_skus_enabled) {
-        nots.push(...filters.vendor_search_exclusions.filter((sku) => sku.toLowerCase() !== variant.sku.toLowerCase()));
+        nots.push(...filters.vendor_search_exclusions.filter((sku) => sku.toLowerCase() !== sku.toLowerCase()));
     }
-    if (variant.title.toLowerCase().includes("dual fuel")) {
+    if (title.toLowerCase().includes("dual fuel")) {
         // nots.push('tri fuel', 'trifuel', 'tri-fuel')
     }
     let final = null;
@@ -124,7 +159,7 @@ const handleIndexSearch = (dataToSearch, filters, variant, product, filterOption
     // MUST INCLUDE SKU???
     final = final.and({
         index: index,
-        query: variant.sku,
+        query: sku,
         resolve: false,
         suggest: true,
     });
@@ -142,10 +177,10 @@ const handleIndexSearch = (dataToSearch, filters, variant, product, filterOption
     });
     return resultsArray;
 };
-const filterLinkedElsewhereResults = (results, variant) => {
+const filterLinkedElsewhereResults = (results, variantId) => {
     const filtered = results.filter((result) => {
         const productLinkedElsewhere = result.linked_variant_ids?.length > 0 &&
-            !result.linked_variant_ids.includes(variant.id);
+            !result.linked_variant_ids.includes(variantId);
         if (productLinkedElsewhere) {
             return false;
         }
@@ -164,12 +199,12 @@ const filterFoundProductIdExclusions = (results, found_id_exclusions) => {
     });
     return filtered;
 };
-const filterPriceOutliers = (results, variant, showHighPriceOutliers, showLowPriceOutliers) => {
+const filterPriceOutliers = (results, variantPrice, showHighPriceOutliers, showLowPriceOutliers) => {
     const filtered = results.filter((item) => {
         const showMoreExpensive = showHighPriceOutliers === true;
-        const isMoreExpensive = item.extracted_price > variant.price * TOO_EXPENSIVE_MULTIPLIER;
+        const isMoreExpensive = item.extracted_price > variantPrice * TOO_EXPENSIVE_MULTIPLIER;
         const showTooCheap = showLowPriceOutliers === true;
-        const isTooCheap = item.extracted_price < variant.price * TOO_CHEAP_MULTIPLIER;
+        const isTooCheap = item.extracted_price < variantPrice * TOO_CHEAP_MULTIPLIER;
         if (isMoreExpensive && !showMoreExpensive) {
             return false;
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@factorypure/client-helpers",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -21,6 +21,7 @@
   "dependencies": {
     "@types/date-fns": "^2.5.3",
     "date-fns": "^4.1.0",
-    "flexsearch": "^0.8.212"
+    "flexsearch": "^0.8.212",
+    "zod": "^4.3.5"
   }
 }