refactor(config): localized label fields of menu links is optional an…

…d defaults to empty array (#2333)
commercetools · Aug 9, 2021 · d7b712e · d7b712e · vercel · Aug 9, 2021
1 parent fd03430
commit d7b712e
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 87 deletions.
diff --git a/.changeset/blue-buses-laugh.md b/.changeset/blue-buses-laugh.md
@@ -0,0 +1,5 @@
+---
+'@commercetools-frontend/application-config': patch
+---
+
+Localized label field of menu links is optional and defaults to empty array.
diff --git a/packages/application-config/schema.json b/packages/application-config/schema.json
@@ -30,13 +30,7 @@
       "type": "string",
       "oneOf": [
         {
-          "enum": [
-            "gcp-au",
-            "gcp-eu",
-            "gcp-us",
-            "aws-fra",
-            "aws-ohio"
-          ]
+          "enum": ["gcp-au", "gcp-eu", "gcp-us", "aws-fra", "aws-ohio"]
         },
         {
           "$ref": "#/definitions/envVariablePlaceholder"
@@ -71,10 +65,7 @@
         }
       },
       "additionalProperties": false,
-      "required": [
-        "view",
-        "manage"
-      ]
+      "required": ["view", "manage"]
     },
     "env": {
       "description": "This is an object of keys that represents different environments (for example `production`). The environment used depends on the environment variable `MC_APP_ENV`. If `MC_APP_ENV` isn't set then `NODE_ENV` will be used. If neither is set, it defaults to `development`",
@@ -113,15 +104,11 @@
             }
           },
           "additionalProperties": false,
-          "required": [
-            "url"
-          ]
+          "required": ["url"]
         }
       },
       "additionalProperties": false,
-      "required": [
-        "production"
-      ]
+      "required": ["production"]
     },
     "additionalEnv": {
       "description": "Additional environment values unique to your Custom Application that are injected in the application context.",
@@ -152,9 +139,7 @@
             }
           },
           "additionalProperties": false,
-          "required": [
-            "connect-src"
-          ]
+          "required": ["connect-src"]
         },
         "featurePolicies": {
           "description": "Configuration for the HTTP Feature-Policy header (https://developer.mozilla.org/en-US/docs/Web/HTTP/Feature_Policy/Using_Feature_Policy)",
@@ -168,18 +153,13 @@
           "description": "Additional configuration for the HTTP Strict-Transport-Security header (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security)",
           "type": "array",
           "items": {
-            "enum": [
-              "includeSubDomains",
-              "preload"
-            ]
+            "enum": ["includeSubDomains", "preload"]
           },
           "uniqueItems": true
         }
       },
       "additionalProperties": false,
-      "required": [
-        "csp"
-      ]
+      "required": ["csp"]
     },
     "menuLinks": {
       "description": "Configuration for the menu links on the left-side navbar.",
@@ -196,30 +176,21 @@
         "labelAllLocales": {
           "description": "Localized label based on the application locales available from the user profile.",
           "type": "array",
+          "default": [],
           "items": {
             "type": "object",
             "properties": {
               "locale": {
                 "type": "string",
-                "enum": [
-                  "en",
-                  "de",
-                  "es",
-                  "fr-FR",
-                  "zh-CN",
-                  "ja"
-                ]
+                "enum": ["en", "de", "es", "fr-FR", "zh-CN", "ja"]
               },
               "value": {
                 "description": "A label for the specific locale or a reference to a translated message. For example `${intl:en:Menu.Avengers}` which looks for the message key `Menu.Avengers` in the `src/i18n/data/en.json`",
                 "type": "string"
               }
             },
             "additionalProperties": false,
-            "required": [
-              "locale",
-              "value"
-            ]
+            "required": ["locale", "value"]
           }
         },
         "permissions": {
@@ -248,30 +219,21 @@
               "labelAllLocales": {
                 "description": "Localized label based on the application locales available from the user profile.",
                 "type": "array",
+                "default": [],
                 "items": {
                   "type": "object",
                   "properties": {
                     "locale": {
                       "type": "string",
-                      "enum": [
-                        "en",
-                        "de",
-                        "es",
-                        "fr-FR",
-                        "zh-CN",
-                        "ja"
-                      ]
+                      "enum": ["en", "de", "es", "fr-FR", "zh-CN", "ja"]
                     },
                     "value": {
                       "description": "A label for the specific locale or a reference to a translated message. For example `${intl:en:Menu.Avengers}` which looks for the message key `Menu.Avengers` in the `src/i18n/data/en.json`",
                       "type": "string"
                     }
                   },
                   "additionalProperties": false,
-                  "required": [
-                    "locale",
-                    "value"
-                  ]
+                  "required": ["locale", "value"]
                 }
               },
               "permissions": {
@@ -304,10 +266,5 @@
     }
   },
   "additionalProperties": true,
-  "required": [
-    "name",
-    "entryPointUriPath",
-    "cloudIdentifier",
-    "env"
-  ]
-}
+  "required": ["name", "entryPointUriPath", "cloudIdentifier", "env"]
+}
diff --git a/packages/application-config/test/fixtures/config-intl-variables.json b/packages/application-config/test/fixtures/config-intl-variables.json
@@ -20,27 +20,13 @@
         "value": "${intl:de:Menu.Avengers}"
       }
     ],
-    "permissions": [
-      "ViewAvengers"
-    ],
+    "permissions": ["ViewAvengers"],
     "submenuLinks": [
       {
         "uriPath": "new",
-        "defaultLabel": "New Avenger",
-        "labelAllLocales": [
-          {
-            "locale": "en",
-            "value": "${intl:en:Menu.Avengers.New}"
-          },
-          {
-            "locale": "de",
-            "value": "${intl:de:Menu.Avengers.New}"
-          }
-        ],
-        "permissions": [
-          "ManageAvengers"
-        ]
+        "defaultLabel": "${intl:en:Menu.Avengers.New}",
+        "permissions": ["ManageAvengers"]
       }
     ]
   }
-}
+}
diff --git a/packages/application-config/test/process-config.spec.js b/packages/application-config/test/process-config.spec.js
@@ -527,17 +527,8 @@ describe('processing a config with intl variable placeholders', () => {
             submenuLinks: [
               {
                 uriPath: 'new',
-                defaultLabel: 'New Avenger',
-                labelAllLocales: [
-                  {
-                    locale: 'en',
-                    value: 'Add avenger',
-                  },
-                  {
-                    locale: 'de',
-                    value: 'Avenger hinzufügen',
-                  },
-                ],
+                defaultLabel: 'Add avenger',
+                labelAllLocales: [],
                 permissions: ['ManageAvengers'],
               },
             ],