@commercetools-frontend/application-cli 1.2.2 → 1.4.0

package/README.md

@@ -67,6 +67,18 @@ This command compiles the menu configuration [defined in the application config]
 pnpm application-cli compile-menu
 ```
 
+### Command: `validate-menu`
+
+This command validates the `menu.json` file generated by `compile-menu` command.
+
+> This is mostly useful for internal Merchant Center applications.
+
+```bash
+pnpm application-cli validate-menu \
+  --input-file=<filepath> \
+  --navigation=top  #option to switch between navbar (side) and appbar schema (top)
+```
+
 ### Command: `create-version`
 
 This command outputs a JSON string containing a list of deployed versions.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@commercetools-frontend/application-cli",
-  "version": "1.2.2",
+  "version": "1.4.0",
   "description": "Internal CLI to manage Merchant Center application deployments across various environments.",
   "keywords": [
     "commercetools",
@@ -18,11 +18,12 @@
   ],
   "dependencies": {
     "@babel/core": "^7.21.0",
-    "@commercetools-frontend/application-config": "21.24.1",
+    "@commercetools-frontend/application-config": "22.0.0",
     "@manypkg/find-root": "2.1.0",
     "cosmiconfig": "8.1.3",
     "dotenv": "16.0.3",
     "execa": "6.1.0",
+    "jsonschema": "^1.4.1",
     "listr": "0.14.3",
     "listr-verbose-renderer": "0.6.0",
     "mri": "1.2.0",

package/src/bin/cli.js

@@ -4,7 +4,7 @@ import mri from 'mri';
 import compileDeployments from '../commands/compile-deployments.js';
 import compileMenu from '../commands/compile-menu.js';
 import createVersion from '../commands/create-version.js';
-
+import validateMenu from '../commands/validate-menu.js';
 const cwd = process.cwd();
 
 (async () => {
@@ -82,6 +82,10 @@ Options:
         await compileMenu(cliFlags, cwd);
         process.exit(0);
         break;
+      case 'validate-menu':
+        await validateMenu(cliFlags, cwd);
+        process.exit(0);
+        break;
       case 'create-version':
         await createVersion(cliFlags, cwd);
         process.exit(0);

package/src/commands/validate-menu.js

@@ -0,0 +1,33 @@
+import fs from 'fs';
+import { Validator } from 'jsonschema';
+import { navbarMenuSchema, appbarMenuSchema } from '../schema.js';
+
+export function validateMenu(menuJson, schema = navbarMenuSchema) {
+  const validator = new Validator();
+  const result = validator.validate(menuJson, schema);
+  if (result.valid) {
+    return menuJson;
+  } else {
+    throw new Error('menu.json validation failed\n' + result.errors);
+  }
+}
+
+async function command(cliFlags, cwd) {
+  const menuJsonPath = cliFlags['input-file'];
+  const isAppbarMenu = cliFlags['navigation'] === 'top';
+
+  if (!menuJsonPath)
+    throw new Error(
+      `--input-file cannot be empty. please provide the path of compiled menu.json`
+    );
+  if (!fs.existsSync(menuJsonPath))
+    throw new Error(`The menu.json file doesn't exist: ${menuJsonPath}`);
+  const menuJson = fs.readFileSync(menuJsonPath, 'utf-8');
+
+  return validateMenu(
+    JSON.parse(menuJson),
+    isAppbarMenu ? appbarMenuSchema : navbarMenuSchema
+  );
+}
+
+export default command;

package/src/commands/validate-menu.spec.js

@@ -0,0 +1,43 @@
+import { validateMenu } from './validate-menu.js';
+
+describe('validate menu', () => {
+  test.each([
+    123,
+    '{value:123}',
+    {},
+    { uriPath: 'products', icon: 'ProductsIcon', submenu: [] },
+    {
+      uriPath: 123,
+      intlMessage: 123,
+      icon: 123,
+      permissions: '',
+      submenu: {},
+      key: {},
+      labelAllLocales: {},
+    },
+  ])('should return null for invalid menu configs', (json) => {
+    try {
+      expect(validateMenu(json)).toEqual([]);
+    } catch (error) {
+      // catch block is required otherwise the test fails
+      //  due to `validateMenu` throwing error for invalid menu
+    }
+  });
+  it('should return menu json for valid menu configs', async () => {
+    const menuJson = {
+      uriPath: 'products',
+      intlMessage: 'Products',
+      icon: 'ProductsIcon',
+      permissions: ['ViewProducts'],
+      submenu: [],
+      key: 'product',
+      labelAllLocales: [
+        {
+          locale: 'en',
+          value: 'product',
+        },
+      ],
+    };
+    expect(validateMenu(menuJson)).toEqual(menuJson);
+  });
+});

package/src/schema.js

@@ -0,0 +1,112 @@
+const baseMenuProperties = {
+  key: {
+    type: 'string',
+  },
+  uriPath: {
+    type: 'string',
+  },
+  icon: {
+    type: 'string',
+  },
+  featureToggle: {
+    type: ['string', 'null'],
+  },
+  labelAllLocales: {
+    type: 'array',
+    items: [
+      {
+        type: 'object',
+        properties: {
+          locale: { type: 'string' },
+          value: { type: 'string' },
+        },
+        required: ['locale', 'value'],
+      },
+    ],
+  },
+  menuVisibility: {
+    type: ['string', 'null'],
+  },
+  permissions: {
+    type: 'array',
+    items: {
+      type: 'string',
+    },
+  },
+  dataFences: {
+    type: ['array', 'null'],
+    items: [
+      {
+        type: ['object'],
+        properties: {
+          group: {
+            type: 'string',
+          },
+          name: {
+            type: 'string',
+          },
+          type: {
+            type: 'string',
+          },
+        },
+      },
+    ],
+  },
+  actionRights: {
+    type: ['array', 'null'],
+    items: [
+      {
+        type: ['object'],
+        properties: {
+          group: {
+            type: 'string',
+          },
+          name: {
+            type: 'string',
+          },
+        },
+      },
+    ],
+  },
+};
+
+export const navbarMenuSchema = {
+  $schema: 'https://json-schema.org/draft/2020-12/schema',
+  // "$id":""
+  title: 'NavbarMenu',
+  type: 'object',
+  properties: {
+    ...baseMenuProperties,
+    submenu: {
+      type: 'array',
+      items: [
+        {
+          type: 'object',
+          properties: baseMenuProperties,
+        },
+      ],
+    },
+  },
+  required: [
+    'icon',
+    'key',
+    'labelAllLocales',
+    'permissions',
+    'submenu',
+    'uriPath',
+  ],
+};
+
+export const appbarMenuSchema = {
+  $schema: 'https://json-schema.org/draft/2020-12/schema',
+  // "$id":""
+  title: 'AppbarMenu',
+  type: 'array',
+  items: [
+    {
+      type: 'object',
+      properties: baseMenuProperties,
+      required: ['key', 'labelAllLocales', 'permissions', 'uriPath'],
+    },
+  ],
+};