feat(l10n): adds transformLocalizedStringToLocalizedField (#2148)

.changeset/twenty-rabbits-admire.md

@@ -0,0 +1,17 @@
+---
+'@commercetools-frontend/l10n': minor
+---
+
+Add `transformLocalizedStringToLocalizedField` to `i10n`.
+
+Transforms [`LocalizedString`](https://docs.commercetools.com/api/types#localizedstring) to a list of `LocalizedField` (`[{ locale: string, value: string }]`)
+
+**Example**
+
+```jsx
+import { transformLocalizedStringToLocalizedField } from '@commercetools-frontend/l10n';
+
+const productName = { sv: 'Kanelbulle', en: 'Cinnamon Bun' };
+console.log(transformLocalizedStringToLocalizedField(productName));
+// [{ locale: 'sv', value: 'Kanelbulle' }, { locale: 'en', value: 'Cinnamon Bun' }]
+```

packages/l10n/src/index.ts

@@ -22,5 +22,6 @@ export {
 export {
   applyTransformedLocalizedFields,
   transformLocalizedFieldToLocalizedString,
+  transformLocalizedStringToLocalizedField,
   formatLocalizedString,
 } from './localize';

packages/l10n/src/localize.spec.ts

@@ -1,9 +1,25 @@
 import {
   transformLocalizedFieldToLocalizedString,
+  transformLocalizedStringToLocalizedField,
   applyTransformedLocalizedFields,
   formatLocalizedString,
 } from './localize';
 
+describe('transformLocalizedStringToLocalizedField', () => {
+  describe('when LocalizedString is empty', () => {
+    it('should return empty LocalizedField[]', () => {
+      expect(transformLocalizedStringToLocalizedField({})).toEqual([]);
+    });
+  });
+  describe('when LocalizedString is not empty', () => {
+    it('should return LocalizedField[]', () => {
+      expect(
+        transformLocalizedStringToLocalizedField({ en: 'Fallout 4' })
+      ).toEqual([{ locale: 'en', value: 'Fallout 4' }]);
+    });
+  });
+});
+
 describe('applyTransformedLocalizedFields', () => {
   describe('when entity contains list of locale fields', () => {
     it('should inject localized string object field and remove outdated key', () => {

packages/l10n/src/localize.ts

@@ -28,6 +28,28 @@ export const transformLocalizedFieldToLocalizedString = (
   );
 };
 
+/**
+ * Transforms a `LocalizedString` object into a list of `LocalizedField`
+ *
+ * { sv: 'Hej' } -> [{ locale: 'sv', value: 'Hej' }]
+ */
+export const transformLocalizedStringToLocalizedField = (
+  localizedString: LocalizedString
+): LocalizedField[] => {
+  if (!localizedString || Object.keys(localizedString).length === 0) return [];
+  const sorted = Object.keys(localizedString).sort();
+  return sorted.reduce<LocalizedField[]>(
+    (updatedLocalizedField, locale) => [
+      ...updatedLocalizedField,
+      {
+        locale,
+        value: localizedString[locale],
+      },
+    ],
+    []
+  );
+};
+
 /**
  * Given a list of localized field names to map, replace the fields in the
  * format of `LocalizedField` to a `LocalizedString` object.