@blocklet/meta 1.7.6 → 1.7.7

package/lib/parse-navigation.js

@@ -0,0 +1,78 @@
+const get = require('lodash/get');
+const normalizePathPrefix = require('@abtnode/util/lib/normalize-path-prefix');
+
+/**
+ * @param {*} navigation src
+ * @param {*} blocklet
+ * @param {*} prefix prefix of link
+ * @param {*} level 1 or 2. primary menu or secondary menu
+ */
+const parseNavigation = (navigation, blocklet, prefix = '/', level = 1) => {
+  const result = [];
+
+  (navigation || []).forEach((nav) => {
+    if (!nav.child) {
+      const item = {
+        title: nav.title,
+      };
+
+      if (nav.link) {
+        item.link = normalizePathPrefix(`${prefix}${nav.link || '/'}`);
+      }
+
+      if (level === 1) {
+        const list = parseNavigation(nav.items, blocklet, prefix, 2);
+        if (list.length) {
+          item.items = list;
+        }
+      }
+
+      result.push(item);
+      return;
+    }
+
+    if (!blocklet) {
+      return;
+    }
+
+    // parse child
+    const child = (blocklet.children || []).find((x) => [x.meta.name, x.meta.did].includes(nav.child));
+    if (!child) {
+      return;
+    }
+    const childTitle = child.meta.title || child.meta.name;
+
+    const childNavigation = get(child, 'meta.navigation', []);
+    if (!childNavigation.length) {
+      // child does not declares menu
+      result.push({
+        title: nav.title || childTitle,
+        link: normalizePathPrefix(`${prefix}${child.mountPoint || '/'}`),
+      });
+    } else if (childNavigation.length === 1) {
+      // child declares one menu
+      result.push({
+        title: nav.title || childNavigation[0].title || childTitle,
+        link: normalizePathPrefix(`${prefix}${child.mountPoint}${childNavigation[0].link || '/'}`),
+      });
+    } else {
+      // child declares multiple menus
+      if (level === 1) { // eslint-disable-line
+        // primary menu
+        const item = {
+          title: nav.title || child.meta.title || child.meta.name,
+          items: parseNavigation(childNavigation, null, normalizePathPrefix(`${prefix}${child.mountPoint}`), 2),
+        };
+        result.push(item);
+      } else {
+        // secondary menu
+        const list = parseNavigation(childNavigation, null, normalizePathPrefix(`${prefix}${child.mountPoint}`), 2);
+        result.push(...list);
+      }
+    }
+  });
+
+  return result;
+};
+
+module.exports = parseNavigation;

package/lib/schema.js

@@ -161,8 +161,7 @@ const childrenSchema = Joi.object({
         services: Joi.array().items(serviceSchema).unique('name'),
       })
     )
-    .optional()
-    .default([]),
+    .optional(),
   mountPoint: Joi.string().trim().min(1), // added in 1.2.3
   services: Joi.array().items(serviceSchema).unique('name'), // added in 1.2.3
 }).custom((value) => {
@@ -196,6 +195,22 @@ const titleSchema = Joi.string()
   });
 const descriptionSchema = Joi.string().trim().min(3).max(160);
 
+const navigationItemSchema = Joi.object({
+  title: Joi.string().required(),
+  link: Joi.string(),
+  child: Joi.string(), // child name or child did
+});
+
+const navigationSchema = Joi.array().items(
+  navigationItemSchema.append({
+    items: Joi.array().items(navigationItemSchema),
+  })
+);
+
+const themeSchema = Joi.object({
+  background: Joi.string(),
+});
+
 const createBlockletSchema = (
   baseDir,
   { ensureMain = false, ensureFiles = false, ensureDist = false, ...schemaOptions } = {}
@@ -397,6 +412,10 @@ const createBlockletSchema = (
 
     // blocklet component support
     children: Joi.array().items(childrenSchema).optional().default([]),
+
+    // navigation & theme
+    navigation: navigationSchema,
+    theme: themeSchema,
   })
     .rename('public_url', 'publicUrl', { ignoreUndefined: true, override: true })
     .rename('admin_url', 'adminUrl', { ignoreUndefined: true, override: true })
@@ -415,4 +434,6 @@ module.exports = {
   distSchema,
   titleSchema,
   descriptionSchema,
+  navigationSchema,
+  themeSchema,
 };

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.7.6",
+  "version": "1.7.7",
   "description": "Library to parse/validate/fix blocklet meta",
   "main": "lib/index.js",
   "files": [
@@ -18,7 +18,8 @@
   "author": "wangshijun <wangshijun2020@gmail.com> (http://github.com/wangshijun)",
   "license": "MIT",
   "dependencies": {
-    "@abtnode/constant": "1.7.6",
+    "@abtnode/constant": "1.7.7",
+    "@abtnode/util": "1.7.7",
     "@arcblock/did": "^1.16.0",
     "@arcblock/did-ext": "^1.16.0",
     "@arcblock/did-util": "^1.16.0",
@@ -44,5 +45,5 @@
   "devDependencies": {
     "jest": "^27.4.5"
   },
-  "gitHead": "47a9dbd6ea74419ff586336824ebb9b2fe7694aa"
+  "gitHead": "619db37ea7a91c64a9bf30836a55c70d55325e73"
 }