feat!: support for multi possible values for productId and merchantName

klarna-incubator · Jan 12, 2024 · 7a3200c · 7a3200c
1 parent 5d1342f
commit 7a3200c
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 12 deletions.
diff --git a/src/compareWithLabeled.spec.ts b/src/compareWithLabeled.spec.ts
@@ -223,7 +223,7 @@ describe('evaluateLineItemFields', () => {
       {
         name: 'success',
         color: 'parsed',
-        productId: 'parsed',
+        productId: 'expected',
         imageUrl: 'parsed',
         quantity: null,
         size: 'parsed',
@@ -236,7 +236,7 @@ describe('evaluateLineItemFields', () => {
       {
         name: ['successful', 'failure'],
         color: 'expected',
-        productId: 'expected',
+        productId: ['expected'],
         imageUrl: ['expected', 'not expected'],
         quantity: 1,
         size: 'expected',
@@ -250,7 +250,7 @@ describe('evaluateLineItemFields', () => {
     expect(result).toMatchObject({
       lineItemName: { match: MatchKey.PARTIAL },
       lineItemColor: { match: MatchKey.NO },
-      lineItemProductId: { match: MatchKey.NO },
+      lineItemProductId: { match: MatchKey.FULL },
       lineItemProductImageUrl: { match: MatchKey.NO },
       lineItemQuantity: { match: MatchKey.FULL },
       lineItemSize: { match: MatchKey.NO },

diff --git a/src/compareWithLabeled.ts b/src/compareWithLabeled.ts
@@ -17,7 +17,7 @@ import {
   FieldResult,
   LineItem,
   LineItemFieldResults,
-  ComparisonInputWithMultipleValues,
+  ComparisonInputWithMultiPossibleValues,
 } from './types'
 
 type ComparisonResultWithoutAPS = Omit<ComparisonResult, 'APS'>
@@ -47,7 +47,7 @@ export const createMismatchComment = (
 export const evaluateField = (
   field: keyof ComparisonInput,
   parsed: ComparisonInput,
-  labeled: ComparisonInputWithMultipleValues,
+  labeled: ComparisonInputWithMultiPossibleValues,
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   comparator: ComparisonFn<any>,
   comparatorOptions?: ComparisonOptions
@@ -122,7 +122,7 @@ export const evaluateArray = <T = unknown>(
 
 export const evaluateCostsAddUp = (
   parsed: ComparisonInput,
-  labeled: ComparisonInputWithMultipleValues
+  labeled: ComparisonInputWithMultiPossibleValues
 ): FieldResult => {
   const expectedTotal = labeled?.totalAmount
   if (!expectedTotal) return { match: null, comments: ['missing labeled total amount'] }
@@ -164,7 +164,7 @@ export const evaluateCostsAddUp = (
 
 export const evaluateLineItemCount = (
   parsed: ComparisonInput['lineItems'],
-  labeled: ComparisonInputWithMultipleValues['lineItems']
+  labeled: ComparisonInputWithMultiPossibleValues['lineItems']
 ): FieldResult => {
   if (!parsed && !labeled) {
     return {
@@ -188,7 +188,7 @@ export const evaluateLineItemCount = (
 
 export const evaluateLineItemFields = (
   parsed: ComparisonInput['lineItems'],
-  labeled: ComparisonInputWithMultipleValues['lineItems']
+  labeled: ComparisonInputWithMultiPossibleValues['lineItems']
 ): LineItemFieldResults => {
   const result: LineItemFieldResults = {
     lineItemName: { match: null },
@@ -227,7 +227,8 @@ export const evaluateLineItemFields = (
     },
     productId: {
       fieldName: 'lineItemProductId',
-      comparator: fullOrNoMatchComparison,
+      comparator: compareStrings,
+      comparatorOptions: { allowPartialMatch: false },
     },
     imageUrl: {
       fieldName: 'lineItemProductImageUrl',
@@ -319,7 +320,7 @@ export const compareWithLabeled = ({
   labeled,
 }: {
   parsed: ComparisonInput
-  labeled: ComparisonInputWithMultipleValues
+  labeled: ComparisonInputWithMultiPossibleValues
 }): ComparisonResult => {
   const fieldResults: ComparisonResultWithoutAPS = {
     status: evaluateField('status', parsed, labeled, compareOrderStatus),

diff --git a/src/index.ts b/src/index.ts
@@ -1,3 +1,8 @@
 export { compareWithLabeled } from './compareWithLabeled'
 export { MatchKey, APS_FIELDS } from './constants'
-export type { ComparisonInput, ComparisonResult, LineItemWithMultiPossibleValues } from './types'
+export type {
+  ComparisonInput,
+  ComparisonInputWithMultiPossibleValues,
+  ComparisonResult,
+  LineItemWithMultiPossibleValues,
+} from './types'
diff --git a/src/types.ts b/src/types.ts
@@ -42,7 +42,7 @@ export type ComparisonInput = {
   trackingNumbers: string[] | null
 }
 
-export type ComparisonInputWithMultipleValues = Omit<
+export type ComparisonInputWithMultiPossibleValues = Omit<
   ComparisonInput,
   'lineItems' | 'merchantName'
 > & {