@factorypure/client-helpers 1.1.25 → 1.1.26

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+import { MatchResult } from '@factorypure/matching-engine';
 import { z } from 'zod';
 /**
  * @packageDocumentation
@@ -878,4 +879,21 @@ export declare const calculateHideOverrideReasons: (result: ScrapeResultsType |
     found_product_ids?: string[];
 }, sku_alternates: string[]) => string[];
 export declare function findUnitVariations(data: any): any;
+/**
+ * Derives the high-confidence matched results (shownResults) from a MatchResult.
+ * Includes candidates at or above minConfidence whose visibility state is not HIDDEN,
+ * plus HIDDEN candidates whose filter rules are all confidence-overridable and whose
+ * confidence is at or above overrideThreshold.
+ * Results are sorted by price ascending by default; pass sortDirection to override.
+ */
+export declare function getShownResults(matchResult: MatchResult, sortedResults: (ScrapeResultsType | ImmersiveScrapeResultsType)[], minConfidence: number, sortDirection?: 'asc' | 'desc', overrideThreshold?: number): (ScrapeResultsType | ImmersiveScrapeResultsType)[];
+/**
+ * Derives the needs-review results from a MatchResult.
+ * Includes medium-confidence candidates (reviewConfidenceMin <= confidence < minConfidence)
+ * that are cheaper than both the variant price and the cheapest shown result.
+ * Also includes high-confidence candidates whose visibility_state is not VISIBLE but meet
+ * the same price conditions.
+ * Results are sorted by price ascending.
+ */
+export declare function getNeedsReviewResults(matchResult: MatchResult, sortedResults: (ScrapeResultsType | ImmersiveScrapeResultsType)[], shownResults: (ScrapeResultsType | ImmersiveScrapeResultsType)[], variantPrice: number, minConfidence: number, reviewConfidenceMin: number): (ScrapeResultsType | ImmersiveScrapeResultsType)[];
 export {};

package/dist/index.js

@@ -2222,3 +2222,72 @@ export function findUnitVariations(data) {
     });
     return results;
 }
+/**
+ * Derives the high-confidence matched results (shownResults) from a MatchResult.
+ * Includes candidates at or above minConfidence whose visibility state is not HIDDEN,
+ * plus HIDDEN candidates whose filter rules are all confidence-overridable and whose
+ * confidence is at or above overrideThreshold.
+ * Results are sorted by price ascending by default; pass sortDirection to override.
+ */
+export function getShownResults(matchResult, sortedResults, minConfidence, sortDirection = 'asc', overrideThreshold = 80) {
+    const shownResults = [];
+    matchResult.candidates.forEach((candidate) => {
+        const foundResult = sortedResults.find((res) => res.id.toString() === candidate.candidateId.toString());
+        if (candidate.confidence >= minConfidence) {
+            if (!foundResult)
+                return;
+            foundResult.candidate_result = candidate;
+            const decision = evaluateConfidenceOverride(foundResult.filter_results ?? [], foundResult.visibility_state ?? VisibilityState.VISIBLE, candidate.confidence, overrideThreshold);
+            if (decision === 'hide')
+                return;
+            if (decision === 'show_with_override') {
+                foundResult.confidence_override_active = true;
+            }
+            shownResults.push(foundResult);
+        }
+        else if (foundResult &&
+            foundResult.filter_results?.map((fr) => fr.ruleId).includes('match_confirmation_override')) {
+            shownResults.push(foundResult);
+        }
+    });
+    shownResults.sort((a, b) => {
+        const aPrice = a.extracted_total || a.extracted_price || 0;
+        const bPrice = b.extracted_total || b.extracted_price || 0;
+        return sortDirection === 'asc' ? aPrice - bPrice : bPrice - aPrice;
+    });
+    return shownResults;
+}
+/**
+ * Derives the needs-review results from a MatchResult.
+ * Includes medium-confidence candidates (reviewConfidenceMin <= confidence < minConfidence)
+ * that are cheaper than both the variant price and the cheapest shown result.
+ * Also includes high-confidence candidates whose visibility_state is not VISIBLE but meet
+ * the same price conditions.
+ * Results are sorted by price ascending.
+ */
+export function getNeedsReviewResults(matchResult, sortedResults, shownResults, variantPrice, minConfidence, reviewConfidenceMin) {
+    const firstValidResult = shownResults[0];
+    const cheapestShownPrice = firstValidResult?.extracted_total ?? firstValidResult?.extracted_price ?? Infinity;
+    const needsReviewResults = [];
+    matchResult.candidates.forEach((candidate) => {
+        if (candidate.confidence >= reviewConfidenceMin && candidate.confidence < minConfidence) {
+            const foundResult = sortedResults.find((res) => res.id.toString() === candidate.candidateId.toString());
+            if (!foundResult)
+                return;
+            const hasAbsoluteBlock = (foundResult.filter_results ?? []).some((fr) => ABSOLUTE_BLOCK_RULE_IDS.includes(fr.ruleId));
+            if (hasAbsoluteBlock)
+                return;
+            const priceTotal = foundResult.extracted_total || foundResult.extracted_price || 0;
+            if (priceTotal < variantPrice && priceTotal < cheapestShownPrice) {
+                foundResult.candidate_result = candidate;
+                needsReviewResults.push(foundResult);
+            }
+        }
+    });
+    needsReviewResults.sort((a, b) => {
+        const aPrice = a.extracted_total || a.extracted_price || 0;
+        const bPrice = b.extracted_total || b.extracted_price || 0;
+        return aPrice - bPrice;
+    });
+    return needsReviewResults;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@factorypure/client-helpers",
-    "version": "1.1.25",
+    "version": "1.1.26",
     "description": "",
     "main": "./dist/index.js",
     "types": "./dist/index.d.ts",
@@ -20,6 +20,7 @@
         "typescript": "^5.6.2"
     },
     "dependencies": {
+        "@factorypure/matching-engine": "^1.0.8",
         "@types/date-fns": "^2.5.3",
         "date-fns": "^4.1.0",
         "flexsearch": "^0.8.212",