feat: to add custom fields to shipping method (#1841)

* feat: to add custom fields to shipping method * Create .changeset/healthy-glasses-prove.md * include custom into actionGroups(shippingMethods) and add two unit tests * Update packages/sync-actions/src/shipping-methods.js
commercetools · Mar 3, 2023 · b90c723 · b90c723
1 parent 96e1318
commit b90c723
Show file tree

Hide file tree

Showing 3 changed files with 77 additions and 2 deletions.
diff --git a/.changeset/healthy-glasses-prove.md b/.changeset/healthy-glasses-prove.md
@@ -0,0 +1,5 @@
+---
+"@commercetools/sync-actions": minor
+---
+
+Add Custom Fields to Shipping Methods.
diff --git a/packages/sync-actions/src/shipping-methods.js b/packages/sync-actions/src/shipping-methods.js
@@ -8,10 +8,11 @@ import type {
 } from 'types/sdk'
 import createBuildActions from './utils/create-build-actions'
 import createMapActionGroup from './utils/create-map-action-group'
+import actionsMapCustom from './utils/action-map-custom'
 import * as shippingMethodsActions from './shipping-methods-actions'
 import * as diffpatcher from './utils/diffpatcher'
 
-export const actionGroups = ['base', 'zoneRates']
+export const actionGroups = ['base', 'zoneRates', 'custom']
 
 function createShippingMethodsMapActions(
   mapActionGroup: Function,
@@ -40,6 +41,11 @@ function createShippingMethodsMapActions(
         )
       )
     )
+    allActions.push(
+      mapActionGroup('custom', (): Array<UpdateAction> =>
+        actionsMapCustom(diff, newObj, oldObj)
+      )
+    )
     return flatten(allActions)
   }
 }

diff --git a/packages/sync-actions/test/shipping-methods.spec.js b/packages/sync-actions/test/shipping-methods.spec.js
@@ -3,7 +3,7 @@ import { baseActionsList } from '../src/shipping-methods-actions'
 
 describe('Exports', () => {
   test('action group list', () => {
-    expect(actionGroups).toEqual(['base', 'zoneRates'])
+    expect(actionGroups).toEqual(['base', 'zoneRates', 'custom'])
   })
 
   test('correctly define base actions list', () => {
@@ -530,4 +530,68 @@ describe('Actions', () => {
       expect(actual).toEqual(expected)
     })
   })
+
+  describe('custom fields', () => {
+    test('should build `setCustomType` action', () => {
+      const before = {
+        custom: {
+          type: {
+            typeId: 'type',
+            id: 'customType1',
+          },
+          fields: {
+            customField1: true,
+          },
+        },
+      }
+      const now = {
+        custom: {
+          type: {
+            typeId: 'type',
+            id: 'customType2',
+          },
+          fields: {
+            customField1: true,
+          },
+        },
+      }
+      const actual = shippingMethodsSync.buildActions(now, before)
+      const expected = [{ action: 'setCustomType', ...now.custom }]
+      expect(actual).toEqual(expected)
+    })
+
+    test('should build `setCustomField` action', () => {
+      const before = {
+        custom: {
+          type: {
+            typeId: 'type',
+            id: 'customType1',
+          },
+          fields: {
+            customField1: false,
+          },
+        },
+      }
+      const now = {
+        custom: {
+          type: {
+            typeId: 'type',
+            id: 'customType1',
+          },
+          fields: {
+            customField1: true,
+          },
+        },
+      }
+      const actual = shippingMethodsSync.buildActions(now, before)
+      const expected = [
+        {
+          action: 'setCustomField',
+          name: 'customField1',
+          value: true,
+        },
+      ]
+      expect(actual).toEqual(expected)
+    })
+  })
 })