@blocklet/meta 1.8.56 → 1.8.58

package/lib/parse-navigation-from-blocklet.d.ts

@@ -1,4 +1,11 @@
-declare const checkLink: (value: any) => boolean;
+declare const checkLink: (value: string) => boolean;
+interface DeepWalkCallback {
+    (current: any, parent: any, options: DeepWalkCallbackOptions): void;
+}
+interface DeepWalkCallbackOptions {
+    index: number;
+    level: number;
+}
 /**
  *
  * @param {object} tree 需要深度遍历的数状结构
@@ -9,17 +16,43 @@ declare const checkLink: (value: any) => boolean;
  * @param {object} param.parent 当前节点的父节点
  * @param {number} param.level 当前节点的深度
  */
-declare function deepWalk(tree: any, cb?: () => void, { key, order }?: {
-    key?: string;
-    order?: string;
+type TreeNode<K extends string> = Record<string, any> & {
+    [key in K]?: TreeNode<K>[];
+};
+declare function deepWalk<K extends string>(tree: TreeNode<K>, cb: DeepWalkCallback, { key, order }: {
+    key: K;
+    order?: 'first' | 'last';
+}): void;
+declare function deepWalk(tree: TreeNode<'children'>, cb: DeepWalkCallback, { key, order }?: {
+    key?: 'children';
+    order?: 'first' | 'last';
 }): void;
 /**
  * 判断一个传入值是否属于一个 section
  * @param {string | array} sections 需要判断的对象
  * @param {string} section 目标 section
  */
-declare function isMatchSection(sections: any, section: any): boolean;
-declare function joinLink(navigation: any, components: any): any;
+declare function isMatchSection(sections: string[] | string, section: string): boolean;
+interface NavigationItem {
+    id: string;
+    role?: string;
+    section?: string;
+    title?: string;
+    link?: string;
+    items?: NavigationItem[];
+    component?: string;
+    child?: string;
+    [key: string]: any;
+}
+interface ComponentItem {
+    name: string;
+    link: string;
+}
+declare function joinLink(navigation: NavigationItem, components: ComponentItem[]): NavigationItem;
+interface FlatternNavigationOption {
+    transform?: (current: any, parent?: any) => any;
+    depth?: number;
+}
 /**
  * 将树状结构的导航列表进行扁平化处理
  * @param {array} navigationList 树状结构的导航列表
@@ -28,25 +61,30 @@ declare function joinLink(navigation: any, components: any): any;
  * @param {function} params.transform 当发生拍平处理时
  * @returns 扁平化后的导航列表
  */
-declare function flatternNavigation(list?: any[], { depth, transform }?: {
-    depth?: number;
-    transform?: (v: any) => any;
-}): any[];
+declare function flatternNavigation(list?: NavigationItem[], { depth, transform }?: FlatternNavigationOption): any[];
 /**
  * 根据导航中每一个子菜单所属的 section，将原由的导航数据分离为多个导航数据（此时每一个导航 item 只会包含一个 section）
  * @param {array} navigation 导航列表数据（树状结构，目前只适用于两层的树状结构）
  * @returns
  */
-declare function splitNavigationBySection(navigation: any): any[];
+declare function splitNavigationBySection(navigation: NavigationItem[]): any[];
 /**
  * 将导航数据进行层叠处理
  * @param {array} list 扁平化的导航数据
  * @returns 处理后的导航
  */
 declare function nestNavigationList(list?: any[]): any[];
-declare function filterNavigation(navigationList: any, components?: any[]): any[];
-declare function cleanOrphanNavigation(list: any): any;
-declare function parseNavigation(blocklet?: {}, options?: {}): {
+declare function filterNavigation(navigationList: NavigationItem[], components?: ComponentItem[]): any[];
+declare function cleanOrphanNavigation(list: NavigationItem[]): NavigationItem[];
+interface Blocklet {
+    settings?: {
+        navigations?: NavigationItem[];
+    };
+}
+interface ParseNavigationOption {
+    beforeProcess?: (data: any) => any;
+}
+declare function parseNavigation(blocklet?: Blocklet, options?: ParseNavigationOption): {
     navigationList: any[];
     components: any[];
     builtinList: any[];

package/lib/parse-navigation-from-blocklet.js

@@ -1,5 +1,4 @@
 "use strict";
-// @ts-nocheck
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -36,16 +35,6 @@ const checkLink = (value) => {
     return false;
 };
 exports.checkLink = checkLink;
-/**
- *
- * @param {object} tree 需要深度遍历的数状结构
- * @param {function} cb 每一个节点的回调函数，回调的参数：当前节点数据，父亲节点数据，{index:当前节点所属的数组中的序号，level: 当前节点所处的深度}
- * @param {object} param 深度遍历的参数
- * @param {string} param.key 孩子数组的 key 值
- * @param {number} param.index 当前节点所属的数组中的序号
- * @param {object} param.parent 当前节点的父节点
- * @param {number} param.level 当前节点的深度
- */
 function deepWalk(tree, cb = () => { }, { key = 'children', order = 'first' } = {}) {
     function walk(current, { index = 0, parent = null, level = 0 } = {}) {
         if (Array.isArray(current)) {
@@ -118,7 +107,7 @@ function optionalJoin(prefix = '/', url = '') {
     }
     return resultUrl;
 }
-function smartJoinLink(_parentLink, _childLink, { strict = true } = {}) {
+function smartJoinLink(_parentLink, _childLink, { strict = true, } = {}) {
     let parentLink = _parentLink;
     let childLink = _childLink;
     if (!strict) {
@@ -477,7 +466,18 @@ function filterNavigation(navigationList, components = []) {
             }
         }
     }, { key: 'items' });
-    const filteredNavigation = nestedNavigation.filter((item) => item.visible !== false);
+    const filteredNavigation = nestedNavigation.filter((item) => {
+        var _a;
+        if (item.visible === false)
+            return false;
+        // 如果某一菜单的 子菜单 均为隐藏状态，则一级菜单本身也不显示出来
+        if (item.items &&
+            Array.isArray(item.items) &&
+            item.items.length > 0 &&
+            ((_a = item.items) === null || _a === void 0 ? void 0 : _a.every((v) => v.visible === false)))
+            return false;
+        return true;
+    });
     return filteredNavigation;
 }
 exports.filterNavigation = filterNavigation;

package/lib/parse.js

@@ -87,7 +87,20 @@ const parse = (dir, { ensureMain = false, ensureFiles = false, ensureDist = fals
         ensureComponentStore }, schemaOptions));
     const { value, error } = schema.validate(result);
     if (error) {
-        throw new Error(`Invalid blocklet.yml: ${error.details.map((x) => x.message).join(', ')}`);
+        throw new Error(`Invalid blocklet.yml: ${error.details
+            .map((x) => {
+            try {
+                // 根据 navigation 校验规则定制特殊的错误消息显示
+                if (x.type === 'array.unique' && x.path[0] === 'navigation') {
+                    return `${x.message}: ${x.context.value.id}`;
+                }
+            }
+            catch (_a) {
+                //
+            }
+            return x.message;
+        })
+            .join(', ')}`);
     }
     return value;
 };

package/lib/schema.js

@@ -42,14 +42,26 @@ const checkLinkHelper = (value, helper) => {
         return value;
     }
     // @ts-expect-error
-    return helper.message('Invalid navigation link');
+    return helper.message(`Invalid navigation link: ${value}
+
+A valid navigation link should be a relative url which start with '/' or a absolute url, such as:
+- /en/home
+- /zh/home
+- https://www.arcblock.io`);
 };
 const checkId = (value, helper) => {
     if (!value || (0, is_var_name_1.default)(value)) {
         return value;
     }
     // @ts-expect-error
-    return helper.message('Invalid navigation id');
+    return helper.message(`Invalid navigation id: ${value}
+
+A valid navigation id is should follow the rules of javascript variables, such as:
+- foo
+- fooBar
+- foo123
+
+see detail in https://www.npmjs.com/package/is-var-name`);
 };
 const titleSchema = Joi.string()
     .trim()

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.8.56",
+  "version": "1.8.58",
   "description": "Library to parse/validate/fix blocklet meta",
   "main": "./lib/index.js",
   "typings": "./lib/index.d.ts",
@@ -24,14 +24,14 @@
   "author": "wangshijun <wangshijun2020@gmail.com> (http://github.com/wangshijun)",
   "license": "MIT",
   "dependencies": {
-    "@abtnode/client": "1.8.56",
-    "@abtnode/constant": "1.8.56",
-    "@abtnode/util": "1.8.56",
+    "@abtnode/client": "1.8.58",
+    "@abtnode/constant": "1.8.58",
+    "@abtnode/util": "1.8.58",
     "@arcblock/did": "1.18.34",
     "@arcblock/did-ext": "1.18.34",
     "@arcblock/did-util": "1.18.34",
     "@arcblock/jwt": "1.18.34",
-    "@blocklet/constant": "1.8.56",
+    "@blocklet/constant": "1.8.58",
     "@ocap/asset": "1.18.34",
     "@ocap/mcrypto": "1.18.34",
     "@ocap/types": "1.18.34",
@@ -80,5 +80,5 @@
     "ts-node": "^10.9.1",
     "typescript": "^4.8.4"
   },
-  "gitHead": "8c24c9d747e96e05510b9cbe863666960569fb46"
+  "gitHead": "697fbc1875ee02f6a0dd18e48a5a3f523209f208"
 }