feat(migrate): type product-type sync

Author: phofmann

packages/sync-actions/src/product-types-actions.ts

@@ -3,6 +3,7 @@ import {
   buildBaseAttributesActions,
   createIsEmptyValue,
 } from './utils/common-actions'
+import { LocalizedString } from '@commercetools/platform-sdk'
 
 export const baseActionsList = [
   { action: 'changeName', key: 'name' },
@@ -112,8 +113,14 @@ export const generateBaseFieldsUpdateActions = (
   )
 }
 
+type AttributeDefinition = {
+  previous?: { name: string } | undefined
+  next?: { name: string } | undefined
+  hint?: { attributeName: string; isLocalized: boolean }
+}
+
 const generateUpdateActionsForAttributeDefinitions = (
-  attributeDefinitions = []
+  attributeDefinitions: Array<AttributeDefinition> = []
 ) => {
   const removedAttributeDefinitions = attributeDefinitions.filter(
     (attributeDefinition) =>
@@ -170,8 +177,22 @@ const generateUpdateActionsForAttributeDefinitions = (
     })),
   ]
 }
+
+export type AttributeEnumValues = {
+  previous?: {
+    key: string
+    label: LocalizedString | string | undefined
+    [key: string]: unknown
+  }
+  next?: {
+    key: string
+    label: LocalizedString | string | undefined
+    [key: string]: unknown
+  }
+  hint?: { attributeName: string; isLocalized: boolean }
+}
 const generateUpdateActionsForAttributeEnumValues = (
-  attributeEnumValues = []
+  attributeEnumValues: Array<AttributeEnumValues> = []
 ) => {
   const removedAttributeEnumValues = attributeEnumValues.filter(
     (attributeEnumValue) =>
@@ -295,20 +316,21 @@ const generateChangeAttributeOrderAction = (
   return null
 }
 
+export type NestedValues = {
+  attributeDefinitions?: Array<AttributeDefinition>
+  attributeEnumValues?: Array<AttributeEnumValues>
+}
 export const actionsMapForHints = (
-  nestedValuesChanges: {
-    attributeDefinitions: Array<any>
-    attributeEnumValues: Array<any>
-  } = { attributeDefinitions: [], attributeEnumValues: [] },
+  nestedValuesChanges: NestedValues,
   ptOld,
   ptNew
 ) => {
   const updateActions = [
     ...generateUpdateActionsForAttributeDefinitions(
-      nestedValuesChanges.attributeDefinitions
+      nestedValuesChanges?.attributeDefinitions
     ),
     ...generateUpdateActionsForAttributeEnumValues(
-      nestedValuesChanges.attributeEnumValues
+      nestedValuesChanges?.attributeEnumValues
     ),
   ]
 

packages/sync-actions/src/product-types.ts

@@ -9,6 +9,7 @@ import { SyncAction } from './types/update-actions'
 import createBuildActions from './utils/create-build-actions'
 import createMapActionGroup from './utils/create-map-action-group'
 import { diff } from './utils/diffpatcher'
+import { NestedValues } from './product-types-actions'
 
 type SyncActionConfig = { withHints?: boolean } & BaseSyncActionConfig
 
@@ -49,10 +50,14 @@ function createProductTypeMapActions(
   }
 }
 
+export type ProductTypeConfig = {
+  nestedValuesChanges: NestedValues
+}
+
 export default (
   actionGroupList?: Array<ActionGroup>,
   syncActionConfig?: SyncActionConfig
-): SyncAction<ProductTypeUpdateAction> => {
+): SyncAction<ProductTypeUpdateAction, ProductTypeConfig> => {
   const mapActionGroup = createMapActionGroup(actionGroupList)
   const doMapActions = createProductTypeMapActions(
     mapActionGroup,

packages/sync-actions/src/types/update-actions.ts

@@ -1,5 +1,5 @@
 import { UpdateAction } from '@commercetools/sdk-client-v2'
 
-export type SyncAction<T extends UpdateAction> = {
-  buildActions: (now: Object, before: Object) => Array<T>
+export type SyncAction<T extends UpdateAction, S = {}> = {
+  buildActions: (now: any, before: any, config: S) => Array<T>
 }

packages/sync-actions/test/product-types-sync-attribute-hints.spec.ts

@@ -1,6 +1,9 @@
-import createSyncProductTypes from '../src/product-types'
+import createSyncProductTypes, { ProductTypeConfig } from '../src/product-types'
+import { SyncAction } from '../src/types/update-actions'
+import { ProductTypeUpdateAction } from '@commercetools/platform-sdk/src'
+import { AttributeEnumValues } from '../src/product-types-actions'
 
-const createAttributeDefinitionDraftItem = (custom?) => ({
+const createAttributeDefinitionDraftItem = (custom?): AttributeEnumValues => ({
   previous: {
     type: { name: 'text' },
     name: 'attribute-name',
@@ -24,7 +27,9 @@ const createAttributeDefinitionDraftItem = (custom?) => ({
   ...custom,
 })
 
-const createAttributeEnumDraftItem = (custom?) => ({
+const createAttributeEnumDraftItem = (
+  custom?: AttributeEnumValues
+): AttributeEnumValues => ({
   previous: {
     key: 'enum-key',
     label: 'enum-label',
@@ -41,13 +46,13 @@ const createAttributeEnumDraftItem = (custom?) => ({
 })
 
 describe('product type hints', () => {
-  let updateActions
-  let sync
+  let updateActions: Array<ProductTypeUpdateAction>
+  let sync: SyncAction<ProductTypeUpdateAction, ProductTypeConfig>
   beforeEach(() => {
     sync = createSyncProductTypes([])
   })
   describe('attribute enum values', () => {
-    let attributeEnumDraftItem
+    let attributeEnumDraftItem: AttributeEnumValues
     describe('with previous', () => {
       describe('with no changes', () => {
         beforeEach(() => {
@@ -312,6 +317,40 @@ describe('product type hints', () => {
           ])
         })
       })
+      describe('when is truly localized', () => {
+        beforeEach(() => {
+          attributeEnumDraftItem = createAttributeEnumDraftItem({
+            previous: { label: { 'en-GB': 'uk-label' }, key: 'enum-key' },
+            next: { label: { 'en-GB': 'uk-label-new' }, key: 'enum-key' },
+            hint: {
+              // this hint value is used as `attributeName` for enum update actions
+              attributeName: 'attribute-name',
+              isLocalized: true,
+            },
+          })
+          updateActions = sync.buildActions(
+            {},
+            {},
+            {
+              nestedValuesChanges: {
+                attributeEnumValues: [attributeEnumDraftItem],
+              },
+            }
+          )
+        })
+        it('should match snapshot', () => {
+          expect(updateActions).toMatchSnapshot()
+        })
+        it('should generate `addLocalizedEnumValue`', () => {
+          expect(updateActions).toEqual([
+            {
+              action: 'changeLocalizedEnumValueLabel',
+              attributeName: attributeEnumDraftItem.hint.attributeName,
+              newValue: attributeEnumDraftItem.next,
+            },
+          ])
+        })
+      })
     })
   })
   describe('attribute hints', () => {