@blocklet/meta 1.7.19 → 1.7.22

package/lib/fix.js

@@ -77,10 +77,7 @@ const fixFiles = (data) => {
     delete data.files;
   } else if (data.files) {
     data.files = data.files.filter((file) => {
-      if (!file || typeof file !== 'string') {
-        return false;
-      }
-      return true;
+      return !(!file || typeof file !== 'string');
     });
   }
 };
@@ -93,10 +90,7 @@ const fixKeywords = (data) => {
     delete data.keywords;
   } else if (data.keywords) {
     data.keywords = data.keywords.filter((kw) => {
-      if (typeof kw !== 'string' || !kw) {
-        return false;
-      }
-      return true;
+      return !(typeof kw !== 'string' || !kw);
     });
   }
 };
@@ -109,10 +103,7 @@ const fixTags = (data) => {
     delete data.tags;
   } else if (data.tags) {
     data.tags = data.tags.filter((t) => {
-      if (typeof t !== 'string' || !t) {
-        return false;
-      }
-      return true;
+      return !(typeof t !== 'string' || !t);
     });
   }
 };

package/lib/get-component-process-id.js

@@ -0,0 +1,17 @@
+const crypto = require('crypto');
+
+const md5 = (str) => crypto.createHash('md5').update(str).digest('hex');
+
+const getComponentProcessId = (component, ancestors = []) => {
+  const name = !ancestors.length
+    ? component.meta.name
+    : `${ancestors.map((x) => encodeURIComponent(x.meta.name)).join('/')}/${encodeURIComponent(component.meta.name)}`;
+
+  if (name.length < 240) {
+    return name;
+  }
+
+  return md5(name);
+};
+
+module.exports = getComponentProcessId;

package/lib/parse-navigation.js

@@ -5,23 +5,31 @@ 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
+ * @param {*} _level 1: primary menu, >2: secondary menu
  */
-const parseNavigation = (navigation, blocklet, prefix = '/', level = 1) => {
+const parseNavigation = (navigation, blocklet, prefix = '/', _level = 1) => {
   const result = [];
 
   (navigation || []).forEach((nav) => {
     if (!nav.child) {
+      if (_level > 1 && nav.items?.length) {
+        const list = parseNavigation(nav.items, blocklet, prefix, _level + 1);
+        result.push(...list);
+        return;
+      }
+
       const item = {
         title: nav.title,
       };
 
       if (nav.link) {
         item.link = nav.link.startsWith('/') ? normalizePathPrefix(`${prefix}${nav.link || '/'}`) : nav.link;
+      } else {
+        item.link = '';
       }
 
-      if (level === 1) {
-        const list = parseNavigation(nav.items, blocklet, prefix, 2);
+      if (nav.items?.length) {
+        const list = parseNavigation(nav.items, blocklet, prefix, _level + 1);
         if (list.length) {
           item.items = list;
         }
@@ -57,16 +65,21 @@ const parseNavigation = (navigation, blocklet, prefix = '/', level = 1) => {
       });
     } else {
       // child declares multiple menus
-      if (level === 1) { // eslint-disable-line
+      const list = parseNavigation(
+        childNavigation,
+        child,
+        normalizePathPrefix(`${prefix}${child.mountPoint}`),
+        _level + 1
+      );
+
+      if (_level === 1) { // eslint-disable-line
         // primary menu
-        const item = {
+        result.push({
           title: nav.title || child.meta.title || child.meta.name,
-          items: parseNavigation(childNavigation, null, normalizePathPrefix(`${prefix}${child.mountPoint}`), 2),
-        };
-        result.push(item);
+          items: list,
+        });
       } else {
         // secondary menu
-        const list = parseNavigation(childNavigation, null, normalizePathPrefix(`${prefix}${child.mountPoint}`), 2);
         result.push(...list);
       }
     }

package/lib/util.js

@@ -4,15 +4,58 @@ const slugify = require('slugify');
 
 const { NODE_SERVICES, SLOT_FOR_IP_DNS_SITE, WHO_CAN_ACCESS } = require('@abtnode/constant');
 
-const { BlockletGroup, fromBlockletStatus, fromBlockletSource, BLOCKLET_INTERFACE_TYPE_WEB } = require('./constants');
+const {
+  BlockletGroup,
+  fromBlockletStatus,
+  fromBlockletSource,
+  BLOCKLET_INTERFACE_TYPE_WEB,
+  BLOCKLET_CONFIGURABLE_KEY,
+} = require('./constants');
+
+const getComponentId = (component, ancestors = []) =>
+  `${ancestors.map((x) => (x && x.meta ? x.meta.did : '')).join('/')}${ancestors.length ? '/' : ''}${
+    component && component.meta ? component.meta.did : ''
+  }`;
+
+const getComponentName = (component, ancestors = []) =>
+  `${ancestors.map((x) => (x && x.meta ? x.meta.name : '')).join('/')}${ancestors.length ? '/' : ''}${
+    component && component.meta ? component.meta.name : ''
+  }`;
+
+const getComponentBundleId = (component) => `${component.meta.bundleName}@${component.meta.version}`;
+
+const forEachBlocklet = (
+  blocklet,
+  cb,
+  { parallel = false, sync, params: inputParams, _parent, _root, _level = 0, _tasks: inputTasks, _ancestors = [] } = {}
+) => {
+  const root = _root || _parent || blocklet;
+
+  // id maybe meaningless if no meta in blocklet or _ancestors
+  const id = getComponentId(blocklet, _ancestors);
+
+  const newAncestors = _ancestors.concat(blocklet);
 
-const forEachBlocklet = (blocklet, cb, { parallel = false, sync } = {}) => {
   // sync
   if (sync) {
-    cb(blocklet);
+    const params = cb(blocklet, {
+      parent: _parent,
+      root,
+      level: _level,
+      params: inputParams,
+      ancestors: _ancestors,
+      id,
+    });
     if (blocklet.children) {
       for (const child of blocklet.children) {
-        cb(child);
+        forEachBlocklet(child, cb, {
+          sync,
+          params,
+          _parent: blocklet,
+          _root: root,
+          _level: _level + 1,
+          _ancestors: newAncestors,
+        });
       }
     }
     return null;
@@ -23,10 +66,23 @@ const forEachBlocklet = (blocklet, cb, { parallel = false, sync } = {}) => {
     // eslint-disable-next-line no-async-promise-executor
     return new Promise(async (resolve, reject) => {
       try {
-        await cb(blocklet);
+        const params = await cb(blocklet, {
+          parent: _parent,
+          root,
+          level: _level,
+          ancestors: _ancestors,
+          params: inputParams,
+          id,
+        });
         if (blocklet.children) {
           for (const child of blocklet.children) {
-            await cb(child);
+            await forEachBlocklet(child, cb, {
+              params,
+              _parent: blocklet,
+              _root: root,
+              _level: _level + 1,
+              _ancestors: newAncestors,
+            });
           }
         }
 
@@ -38,38 +94,125 @@ const forEachBlocklet = (blocklet, cb, { parallel = false, sync } = {}) => {
   }
 
   // parallel
-  const tasks = [];
-  tasks.push(cb(blocklet));
+  const tasks = inputTasks || [];
+  tasks.push(cb(blocklet, { parent: _parent, root, level: _level, ancestors: _ancestors }));
   if (blocklet.children) {
     for (const child of blocklet.children) {
-      tasks.push(cb(child));
+      forEachBlocklet(child, cb, {
+        parallel,
+        _parent: blocklet,
+        _root: root,
+        _level: _level + 1,
+        _tasks: tasks,
+        _ancestors: newAncestors,
+        id,
+      });
     }
   }
+  if (inputTasks) {
+    return null;
+  }
   return Promise.all(tasks);
 };
 
 const forEachBlockletSync = (blocklet, cb) => forEachBlocklet(blocklet, cb, { sync: true });
 
-const getRequiredMissingConfigs = (blocklet) => {
-  const missingConfigs = [];
-  const configs = blocklet.configs || [];
-  configs.forEach((item) => {
-    if (item.required && !item.value) {
-      missingConfigs.push({ did: blocklet.meta.did, key: item.key, description: item.description });
+const forEachChild = (blocklet, cb, params) => {
+  return forEachBlocklet(
+    blocklet,
+    (b, opt) => {
+      if (opt.level === 0) {
+        return {};
+      }
+      return cb(b, opt);
+    },
+    params
+  );
+};
+
+const forEachChildSync = (blocklet, cb) => forEachChild(blocklet, cb, { sync: true });
+
+const findComponentById = (blocklet, componentId, { _ancestors = [], returnAncestors = false } = {}) => {
+  const id = getComponentId(blocklet, _ancestors);
+  if (componentId === id) {
+    if (returnAncestors) {
+      return {
+        component: blocklet,
+        ancestors: _ancestors,
+      };
     }
-  });
 
-  // eslint-disable-next-line no-restricted-syntax
+    return blocklet;
+  }
+
   for (const child of blocklet.children || []) {
-    const childConfigs = child.configs || [];
-    // configProp does not exist in root blocklet config
-    // or value of configProp in root blocklet config is empty.
-    childConfigs.forEach((x) => {
-      if (x.required && !x.value && !configs.some((y) => y.key === x.key && y.value)) {
-        missingConfigs.push({ did: child.meta.did, key: x.key, description: x.description });
+    const ancestors = _ancestors.concat(blocklet);
+    const component = findComponentById(child, componentId, { _ancestors: ancestors, returnAncestors });
+    if (component) {
+      return component;
+    }
+  }
+
+  return null;
+};
+
+const getSharedConfigObj = (component, ancestors) => {
+  const res = {};
+  if (!ancestors) {
+    return res;
+  }
+
+  for (let i = ancestors.length - 1; i >= 0; i--) {
+    const ancestor = ancestors[i];
+    if (Array.isArray(ancestor.configs)) {
+      ancestor.configs.forEach(({ key, value, secure, shared }) => {
+        if (res[key]) {
+          return;
+        }
+
+        if (!value || secure !== false || shared === false || BLOCKLET_CONFIGURABLE_KEY[key]) {
+          return;
+        }
+
+        const config = (component.configs || []).find((x) => x.key === key);
+        if (config && config.value) {
+          return;
+        }
+
+        res[key] = value;
+      });
+    }
+  }
+
+  return res;
+};
+
+const getAppMissingConfigs = (blocklet = {}) => {
+  const missingConfigs = [];
+
+  forEachBlockletSync(blocklet, (b, { ancestors }) => {
+    const configs = b.configs || [];
+    const sharedConfigObj = getSharedConfigObj(b, ancestors);
+    configs.forEach((item) => {
+      if (item.required && !item.value && !sharedConfigObj[item.key]) {
+        missingConfigs.push({ did: b.meta.did, key: item.key, description: item.description });
       }
     });
-  }
+  });
+
+  return missingConfigs;
+};
+
+const getComponentMissingConfigs = (component = {}, ancestors = []) => {
+  const missingConfigs = [];
+
+  const configs = component.configs || [];
+  const sharedConfigObj = getSharedConfigObj(component, ancestors);
+  configs.forEach((item) => {
+    if (item.required && !item.value && !sharedConfigObj[item.key]) {
+      missingConfigs.push({ did: component.meta.did, key: item.key, description: item.description });
+    }
+  });
 
   return missingConfigs;
 };
@@ -163,20 +306,21 @@ const fixBlockletStatus = (blocklet) => {
     return;
   }
 
-  blocklet.status = fromBlockletStatus(blocklet.status);
-  blocklet.source = fromBlockletSource(blocklet.source);
-  (blocklet.children || []).forEach((child) => {
-    child.status = fromBlockletStatus(child.status);
-    if (child.source !== undefined) {
-      child.source = fromBlockletSource(child.source);
+  forEachBlockletSync(blocklet, (b) => {
+    b.status = fromBlockletStatus(b.status);
+    if (b.source !== undefined) {
+      b.source = fromBlockletSource(b.source);
     }
   });
+
   if (blocklet.settings) {
     (blocklet.settings.children || []).forEach((child) => {
-      child.status = fromBlockletStatus(child.status);
-      if (child.source !== undefined) {
-        child.source = fromBlockletSource(child.source);
-      }
+      forEachBlockletSync(child, (b) => {
+        b.status = fromBlockletStatus(b.status);
+        if (b.source !== undefined) {
+          b.source = fromBlockletSource(b.source);
+        }
+      });
     });
   }
 };
@@ -237,10 +381,14 @@ const urlFriendly = (name) => slugify(name.replace(/^[@./-]/, '').replace(/[@./_
 module.exports = {
   isFreeBlocklet,
   isComponentBlocklet,
+  forEachBlocklet,
   forEachBlockletSync,
+  forEachChild,
+  forEachChildSync,
   isDeletableBlocklet,
-  forEachBlocklet,
-  getRequiredMissingConfigs,
+  getSharedConfigObj,
+  getAppMissingConfigs,
+  getComponentMissingConfigs,
   wipeSensitiveData,
   hasRunnableComponent,
   getDisplayName,
@@ -250,4 +398,8 @@ module.exports = {
   getWhoCanAccess,
   replaceSlotToIp,
   urlFriendly,
+  getComponentId,
+  getComponentName,
+  getComponentBundleId,
+  findComponentById,
 };

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.7.19",
+  "version": "1.7.22",
   "description": "Library to parse/validate/fix blocklet meta",
   "main": "lib/index.js",
   "files": [
@@ -18,8 +18,8 @@
   "author": "wangshijun <wangshijun2020@gmail.com> (http://github.com/wangshijun)",
   "license": "MIT",
   "dependencies": {
-    "@abtnode/constant": "1.7.19",
-    "@abtnode/util": "1.7.19",
+    "@abtnode/constant": "1.7.22",
+    "@abtnode/util": "1.7.22",
     "@arcblock/did": "^1.16.15",
     "@arcblock/did-ext": "^1.16.15",
     "@arcblock/did-util": "^1.16.15",
@@ -47,5 +47,5 @@
   "devDependencies": {
     "jest": "^27.4.5"
   },
-  "gitHead": "73c02fe34d02270e59c5edfeedd7e2a878b772c4"
+  "gitHead": "6190972e62b5e6b1039aa71a291b3e2c521df367"
 }