@blocklet/meta 1.8.34 → 1.8.36

package/lib/parse-navigation.js

@@ -1,249 +1,188 @@
-const get = require('lodash/get');
-const cloneDeep = require('lodash/cloneDeep');
-const isEqual = require('lodash/isEqual');
-const normalizePathPrefix = require('@abtnode/util/lib/normalize-path-prefix');
-
-const parseLinkString = (link, prefix = '') =>
-  link.startsWith('/') ? normalizePathPrefix(`${prefix}${link || '/'}`) : link;
-
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const get_1 = __importDefault(require("lodash/get"));
+const cloneDeep_1 = __importDefault(require("lodash/cloneDeep"));
+const isEqual_1 = __importDefault(require("lodash/isEqual"));
+const normalize_path_prefix_1 = __importDefault(require("@abtnode/util/lib/normalize-path-prefix"));
+const parseLinkString = (link, prefix = '') => link.startsWith('/') ? (0, normalize_path_prefix_1.default)(`${prefix}${link || '/'}`) : link;
 const parseLink = (input, prefix) => {
-  if (Object.prototype.toString.call(input) === '[object Object]') {
-    return Object.entries(input).reduce((o, [key, value]) => {
-      o[key] = parseLinkString(value, prefix);
-      return o;
-    }, {});
-  }
-
-  return parseLinkString(input, prefix);
+    if (Object.prototype.toString.call(input) === '[object Object]') {
+        return Object.entries(input).reduce((o, [key, value]) => {
+            o[key] = parseLinkString(value, prefix);
+            return o;
+        }, {});
+    }
+    return parseLinkString(input, prefix);
 };
-
 const getGroups = (navigation) => {
-  const groups = {};
-  for (const nav of navigation) {
-    const sections = !nav.section || !nav.section.length ? ['__undefined__'] : nav.section;
-    for (const sec of sections) {
-      if (!groups[sec]) {
-        groups[sec] = [];
-      }
-
-      const item = {
-        ...nav,
-      };
-
-      if (nav.section) {
-        item.section = sec === '__undefined__' ? [] : [sec];
-      }
-
-      groups[sec].push(item);
+    const groups = {};
+    for (const nav of navigation) {
+        const sections = !nav.section || !nav.section.length ? ['__undefined__'] : nav.section;
+        for (const sec of sections) {
+            if (!groups[sec]) {
+                groups[sec] = [];
+            }
+            const item = Object.assign({}, nav);
+            if (nav.section) {
+                item.section = sec === '__undefined__' ? [] : [sec];
+            }
+            groups[sec].push(item);
+        }
     }
-  }
-  return Object.values(groups);
+    return Object.values(groups);
 };
-
 const getChildName = (nav) => nav.component || nav.child;
-
-/**
- * @param {*} navigation src
- * @param {*} blocklet
- * @param {*} prefix prefix of link
- * @param {*} _level 1: primary menu, >2: secondary menu
- */
 const doParseNavigation = (navigation, blocklet, prefix = '/', _level = 1) => {
-  const result = [];
-
-  (navigation || []).forEach((nav) => {
-    if (!getChildName(nav)) {
-      if (_level > 1 && nav.items?.length) {
-        const list = doParseNavigation(nav.items, blocklet, prefix, _level + 1);
-        result.push(...list);
-        return;
-      }
-
-      const item = {
-        title: nav.title,
-      };
-
-      if (nav.section) {
-        item.section = nav.section;
-      }
-
-      if (nav.icon) {
-        item.icon = nav.icon;
-      }
-
-      if (nav.link) {
-        item.link = parseLink(nav.link, prefix);
-      } else {
-        item.link = '';
-      }
-
-      if (nav.role) {
-        item.role = nav.role;
-      }
-
-      if (nav.items?.length) {
-        const list = doParseNavigation(nav.items, blocklet, prefix, _level + 1);
-        if (list.length) {
-          item.items = list;
+    const result = [];
+    (navigation || []).forEach((nav) => {
+        var _a, _b;
+        if (!getChildName(nav)) {
+            if (_level > 1 && ((_a = nav.items) === null || _a === void 0 ? void 0 : _a.length)) {
+                const list = doParseNavigation(nav.items, blocklet, prefix, _level + 1);
+                result.push(...list);
+                return;
+            }
+            const item = {
+                title: nav.title,
+            };
+            if (nav.section) {
+                item.section = nav.section;
+            }
+            if (nav.icon) {
+                item.icon = nav.icon;
+            }
+            if (nav.link) {
+                item.link = parseLink(nav.link, prefix);
+            }
+            else {
+                item.link = '';
+            }
+            if (nav.role) {
+                item.role = nav.role;
+            }
+            if ((_b = nav.items) === null || _b === void 0 ? void 0 : _b.length) {
+                const list = doParseNavigation(nav.items, blocklet, prefix, _level + 1);
+                if (list.length) {
+                    item.items = list;
+                }
+            }
+            result.push(item);
+            return;
         }
-      }
-
-      result.push(item);
-      return;
-    }
-
-    if (!blocklet) {
-      return;
-    }
-
-    // parse child
-    const child = (blocklet.children || []).find((x) => [x.meta.name, x.meta.did].includes(getChildName(nav)));
-    if (!child) {
-      return;
-    }
-    const childTitle = child.meta.title || child.meta.name;
-
-    const itemProto = {
-      title: nav.title || childTitle,
-    };
-
-    if (nav.section) {
-      itemProto.section = nav.section;
-    }
-
-    if (nav.icon) {
-      itemProto.icon = nav.icon;
-    }
-
-    if (nav.role) {
-      itemProto.role = nav.role;
-    }
-
-    // get groups by section
-    const groups = getGroups(get(child, 'meta.navigation', []));
-
-    if (!groups.length) {
-      // child does not declares menu
-      const item = cloneDeep(itemProto);
-      item.link = parseLink(child.mountPoint || '/', prefix);
-      result.push(item);
-    } else {
-      for (const childNavigation of groups) {
-        if (childNavigation.length === 1) {
-          // child declares one menu
-          const childNav = childNavigation[0];
-
-          const item = cloneDeep(itemProto);
-
-          item.title = nav.title || childNav.title || childTitle;
-
-          if (childNav.icon) {
-            item.icon = item.icon || childNav.icon;
-          }
-
-          if (childNav.role) {
-            item.role = item.role || childNav.role;
-          }
-
-          if (childNav.section) {
-            item.section = item.section || childNav.section;
-          }
-
-          item.link = parseLink(childNavigation[0].link || '/', normalizePathPrefix(`${prefix}${child.mountPoint}`));
-
-          // doParseNavigation because child nav depth may be > 1
-          const list = doParseNavigation(
-            childNavigation,
-            child,
-            normalizePathPrefix(`${prefix}${child.mountPoint}`),
-            _level + 1
-          );
-
-          if (list.length > 1) {
-            // more than 1 child nav
-            delete item.link;
-            result.push({
-              ...item,
-              items: list,
-            });
-          } else {
-            // only 1 child nav
-            item.link = list[0].link;
+        if (!blocklet) {
+            return;
+        }
+        // parse child
+        const child = (blocklet.children || []).find((x) => [x.meta.name, x.meta.did].includes(getChildName(nav)));
+        if (!child) {
+            return;
+        }
+        const childTitle = child.meta.title || child.meta.name;
+        const itemProto = {
+            title: nav.title || childTitle,
+        };
+        if (nav.section) {
+            itemProto.section = nav.section;
+        }
+        if (nav.icon) {
+            itemProto.icon = nav.icon;
+        }
+        if (nav.role) {
+            itemProto.role = nav.role;
+        }
+        // get groups by section
+        const groups = getGroups((0, get_1.default)(child, 'meta.navigation', []));
+        if (!groups.length) {
+            // child does not declares menu
+            const item = (0, cloneDeep_1.default)(itemProto);
+            item.link = parseLink(child.mountPoint || '/', prefix);
             result.push(item);
-          }
-        } else {
-          // child declares multiple menus
-          const groupSection = childNavigation[0].section || [];
-
-          const list = doParseNavigation(
-            childNavigation,
-            child,
-            normalizePathPrefix(`${prefix}${child.mountPoint}`),
-            _level + 1
-          );
-
-          if (_level === 1) {
-            // primary menu
-            const item = cloneDeep(itemProto);
-
-            if (groupSection.length) {
-              item.section = item.section || groupSection;
+        }
+        else {
+            for (const childNavigation of groups) {
+                if (childNavigation.length === 1) {
+                    // child declares one menu
+                    const childNav = childNavigation[0];
+                    const item = (0, cloneDeep_1.default)(itemProto);
+                    item.title = nav.title || childNav.title || childTitle;
+                    if (childNav.icon) {
+                        item.icon = item.icon || childNav.icon;
+                    }
+                    if (childNav.role) {
+                        item.role = item.role || childNav.role;
+                    }
+                    if (childNav.section) {
+                        item.section = item.section || childNav.section;
+                    }
+                    item.link = parseLink(childNavigation[0].link || '/', (0, normalize_path_prefix_1.default)(`${prefix}${child.mountPoint}`));
+                    // doParseNavigation because child nav depth may be > 1
+                    const list = doParseNavigation(childNavigation, child, (0, normalize_path_prefix_1.default)(`${prefix}${child.mountPoint}`), _level + 1);
+                    if (list.length > 1) {
+                        // more than 1 child nav
+                        delete item.link;
+                        result.push(Object.assign(Object.assign({}, item), { items: list }));
+                    }
+                    else {
+                        // only 1 child nav
+                        item.link = list[0].link;
+                        result.push(item);
+                    }
+                }
+                else {
+                    // child declares multiple menus
+                    const groupSection = childNavigation[0].section || [];
+                    const list = doParseNavigation(childNavigation, child, (0, normalize_path_prefix_1.default)(`${prefix}${child.mountPoint}`), _level + 1);
+                    if (_level === 1) {
+                        // primary menu
+                        const item = (0, cloneDeep_1.default)(itemProto);
+                        if (groupSection.length) {
+                            item.section = item.section || groupSection;
+                        }
+                        item.items = list;
+                        result.push(Object.assign(Object.assign({}, item), { items: list }));
+                    }
+                    else {
+                        // secondary menu
+                        result.push(...list);
+                    }
+                }
             }
-
-            item.items = list;
-            result.push({
-              ...item,
-              items: list,
-            });
-          } else {
-            // secondary menu
-            result.push(...list);
-          }
         }
-      }
-    }
-  });
-
-  return result;
+    });
+    return result;
 };
-
 const markDuplicate = (navigation, compares = []) => {
-  navigation.forEach((item) => {
-    const compare = { link: item.link, section: item.section || [] };
-    if (item.link && compares.some((x) => isEqual(x, compare))) {
-      item.duplicate = true;
-    }
-    if (item.link) {
-      compares.push(compare);
-    }
-
-    if (item.items) {
-      markDuplicate(item.items, compares);
-    }
-  });
-
-  return navigation;
+    navigation.forEach((item) => {
+        const compare = { link: item.link, section: item.section || [] };
+        if (item.link && compares.some((x) => (0, isEqual_1.default)(x, compare))) {
+            item.duplicate = true;
+        }
+        if (item.link) {
+            compares.push(compare);
+        }
+        if (item.items) {
+            markDuplicate(item.items, compares);
+        }
+    });
+    return navigation;
 };
-
 const filterDuplicate = (navigation) => {
-  const res = navigation.filter((x) => !x.duplicate);
-  res.forEach((item) => {
-    if (item.items) {
-      item.items = filterDuplicate(item.items);
-    }
-  });
-
-  return res;
+    const res = navigation.filter((x) => !x.duplicate);
+    res.forEach((item) => {
+        if (item.items) {
+            item.items = filterDuplicate(item.items);
+        }
+    });
+    return res;
 };
-
 const uniq = (navigation) => {
-  return filterDuplicate(markDuplicate(navigation));
+    return filterDuplicate(markDuplicate(navigation));
 };
-
 const parseNavigation = (...args) => {
-  const res = doParseNavigation(...args);
-
-  return uniq(res).filter((x) => x.link || (x.items && x.items.length));
+    // @ts-expect-error
+    const res = doParseNavigation(...args);
+    return uniq(res).filter((x) => x.link || (x.items && x.items.length));
 };
-
 module.exports = parseNavigation;

package/lib/parse.d.ts

@@ -0,0 +1,22 @@
+import { TBlockletMeta } from './types';
+/**
+ * Get blocklet meta from blocklet.yml
+ * @param {string} dir blocklet directory
+ * @param {object} options.extraRawAttrs extra attributes, will be used as base attributes
+ * @param {boolean} options.ensureMain should we verify that main exists
+ * @param {boolean} options.ensureDist should we verify that dist exists
+ * @param {boolean} options.ensureFiles should we verify that logo and files exists
+ * @param {Array} options.serviceMetas should we verify that each service is validate (using JSON Schema defined serviceMetas)
+ */
+declare const parse: (dir: string, { ensureMain, ensureFiles, ensureDist, extraRawAttrs, serviceMetas, schemaOptions, fix, }?: {
+    ensureMain?: boolean;
+    ensureFiles?: boolean;
+    ensureDist?: boolean;
+    extraRawAttrs?: any;
+    serviceMetas?: any;
+    schemaOptions?: any;
+    enableDefaults?: boolean;
+    extraAttrSpec?: any;
+    fix?: boolean;
+}) => TBlockletMeta;
+export = parse;

package/lib/parse.js

@@ -1,15 +1,18 @@
-const fs = require('fs');
-const path = require('path');
-const yaml = require('js-yaml');
-const camelCase = require('lodash/camelCase');
-const debug = require('debug')('@blocklet/meta:parse');
-
-const { BLOCKLET_META_FILE, BLOCKLET_META_FILE_ALT } = require('./constants');
-
-const toBlockletDid = require('./did');
-const { createBlockletSchema } = require('./schema');
-const { fixRequired, fixRepository, fixFiles, fixPerson, fixKeywords, fixTags, fixService } = require('./fix');
-
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const js_yaml_1 = __importDefault(require("js-yaml"));
+const camelCase_1 = __importDefault(require("lodash/camelCase"));
+const debug_1 = __importDefault(require("debug"));
+const constants_1 = __importDefault(require("./constants"));
+const did_1 = __importDefault(require("./did"));
+const schema_1 = require("./schema");
+const fix_1 = require("./fix");
+const debug = (0, debug_1.default)('@blocklet/meta:parse');
+const { BLOCKLET_META_FILE, BLOCKLET_META_FILE_ALT } = constants_1.default;
 /**
  * Get blocklet meta from blocklet.yml
  * @param {string} dir blocklet directory
@@ -19,77 +22,63 @@ const { fixRequired, fixRepository, fixFiles, fixPerson, fixKeywords, fixTags, f
  * @param {boolean} options.ensureFiles should we verify that logo and files exists
  * @param {Array} options.serviceMetas should we verify that each service is validate (using JSON Schema defined serviceMetas)
  */
-const parse = (
-  dir,
-  {
-    ensureMain = false,
-    ensureFiles = false,
-    ensureDist = false,
-    extraRawAttrs = {},
-    serviceMetas,
-    schemaOptions = {},
-    fix = true,
-  } = {}
-) => {
-  let result = {};
-
-  const blockletMetaFile = path.join(dir, BLOCKLET_META_FILE);
-  const blockletMetaFileAlt = path.join(dir, BLOCKLET_META_FILE_ALT);
-  if (fs.existsSync(blockletMetaFile)) {
-    try {
-      result = Object.assign(result, yaml.load(fs.readFileSync(blockletMetaFile).toString(), { json: true }));
-      debug(`parse ${blockletMetaFile}`, result);
-    } catch (err) {
-      console.error(`parse_blocklet_meta from ${BLOCKLET_META_FILE} failed`, err);
+const parse = (dir, { ensureMain = false, ensureFiles = false, ensureDist = false, extraRawAttrs = {}, serviceMetas, schemaOptions = {}, fix = true, } = {}) => {
+    let result = {};
+    const blockletMetaFile = path_1.default.join(dir, BLOCKLET_META_FILE);
+    const blockletMetaFileAlt = path_1.default.join(dir, BLOCKLET_META_FILE_ALT);
+    if (fs_1.default.existsSync(blockletMetaFile)) {
+        try {
+            result = Object.assign(result, js_yaml_1.default.load(fs_1.default.readFileSync(blockletMetaFile).toString(), { json: true }));
+            debug(`parse ${blockletMetaFile}`, result);
+        }
+        catch (err) {
+            console.error(`parse_blocklet_meta from ${BLOCKLET_META_FILE} failed`, err);
+        }
+    }
+    else if (fs_1.default.existsSync(blockletMetaFileAlt)) {
+        try {
+            result = Object.assign(result, js_yaml_1.default.load(fs_1.default.readFileSync(blockletMetaFileAlt).toString(), { json: true }));
+            debug(`parse ${blockletMetaFileAlt}`, result);
+        }
+        catch (err) {
+            console.error(`parse_blocklet_meta from ${BLOCKLET_META_FILE_ALT} failed`, err);
+        }
+    }
+    else {
+        throw new Error(`no ${BLOCKLET_META_FILE} or ${BLOCKLET_META_FILE_ALT} found`);
+    }
+    // User Can override with extra meta attrs: useful for registry
+    if (extraRawAttrs) {
+        result = Object.assign(result, extraRawAttrs);
+    }
+    if (!fix) {
+        // @ts-ignore
+        return result;
     }
-  } else if (fs.existsSync(blockletMetaFileAlt)) {
-    try {
-      result = Object.assign(result, yaml.load(fs.readFileSync(blockletMetaFileAlt).toString(), { json: true }));
-      debug(`parse ${blockletMetaFileAlt}`, result);
-    } catch (err) {
-      console.error(`parse_blocklet_meta from ${BLOCKLET_META_FILE_ALT} failed`, err);
+    // Fix
+    (0, fix_1.fixRequired)(result, dir);
+    (0, fix_1.fixRepository)(result);
+    (0, fix_1.fixFiles)(result);
+    (0, fix_1.fixKeywords)(result);
+    (0, fix_1.fixTags)(result);
+    (0, fix_1.fixPerson)(result);
+    // @ts-expect-error TS(2554) FIXME: Expected 1 arguments, but got 2.
+    (0, fix_1.fixService)(result, serviceMetas);
+    debug('fix', result);
+    // We will overwrite did anyway
+    result.path = `/${result.group}/${result.name}`;
+    result.did = (0, did_1.default)(Buffer.from(result.name, 'utf8'));
+    // Ensure camelCase
+    result = Object.keys(result).reduce((acc, k) => {
+        acc[(0, camelCase_1.default)(k)] = result[k];
+        return acc;
+    }, {});
+    // Validate and cleanup
+    const schema = (0, schema_1.createBlockletSchema)(dir, Object.assign({ ensureMain, ensureFiles, ensureDist }, schemaOptions));
+    const { value, error } = schema.validate(result);
+    if (error) {
+        throw new Error(`Invalid blocklet.yml: ${error.details.map((x) => x.message).join(', ')}`);
     }
-  } else {
-    throw new Error(`no ${BLOCKLET_META_FILE} or ${BLOCKLET_META_FILE_ALT} found`);
-  }
-
-  // User Can override with extra meta attrs: useful for registry
-  if (extraRawAttrs) {
-    result = Object.assign(result, extraRawAttrs);
-  }
-
-  if (!fix) {
-    return result;
-  }
-
-  // Fix
-  fixRequired(result, dir);
-  fixRepository(result);
-  fixFiles(result);
-  fixKeywords(result);
-  fixTags(result);
-  fixPerson(result);
-  fixService(result, serviceMetas);
-  debug('fix', result);
-
-  // We will overwrite did anyway
-  result.path = `/${result.group}/${result.name}`;
-  result.did = toBlockletDid(Buffer.from(result.name, 'utf8'));
-
-  // Ensure camelCase
-  result = Object.keys(result).reduce((acc, k) => {
-    acc[camelCase(k)] = result[k];
-    return acc;
-  }, {});
-
-  // Validate and cleanup
-  const schema = createBlockletSchema(dir, { ensureMain, ensureFiles, ensureDist, ...schemaOptions });
-  const { value, error } = schema.validate(result);
-  if (error) {
-    throw new Error(`Invalid blocklet.yml: ${error.details.map((x) => x.message).join(', ')}`);
-  }
-
-  return value;
+    return value;
 };
-
 module.exports = parse;