mm_nav 0.0.0-stage → 1.1.1

package/README.md

@@ -1,3 +1,2 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+## 导航框架
+用于生成前端所需的路由导航，配合vue路由使用，可以实现动态添加页面。

package/com.json

@@ -0,0 +1,5 @@
+{
+    "name": "Nav",
+    "title": "导航",
+    "state": 1
+}

package/config.tpl.json

@@ -0,0 +1,84 @@
+{
+	// 路由导航名称
+	"name": "${name || 'admin'}",
+	// 路由导航标题
+	"title": "${title || '管理员'}",
+	// 执行排序, 数值越小越优先执行
+	"sort": 1,
+	/* 路由数组 */
+	"routes": [
+		{
+			// 路由名称
+			"name": "root",
+			// 路由路径
+			"path": "/",
+			// vue组件路径
+			"component": "",
+			// 访问级别
+			"level": 1,
+			/* 授权协议 */
+			"oauth": {
+				// 是否需要登录, true表示需要登录才能访问该接口
+				"sign_in": false,
+				// 会员权限级别, 如果小于该值, 则无法访问, 0为不限制
+				"vip": 0,
+				// 管理员权限级别, 如果小于该值, 则无法访问, 0为不限制
+				"gm": 0,
+				// 商户/第三方权限级别, 如果小于该值, 则无法访问, 0为不限制
+				"mc": 0,
+				// 用户组, 允许访问该接口的普通用户群体, 例如: [1,3]
+				"user_group": [
+					1
+				],
+				// 管理组, 允许访问该接口的管理员群体, 例如: [1,3]
+				"user_admin": [
+					1
+				]
+			}
+		}
+	],
+	/* 顶部导航 */
+	"top_nav": [],
+	/* 左边导航 */
+	"left_nav": [],
+	/* 底部导航 */
+	"bottom_nav": [],
+	/* 右边导航 */
+	"right_nav": [],
+	/* 快捷导航 */
+	"quick_nav": [],
+	/* 桌面导航 */
+	"desktop_nav": [],
+	/* 主导航 */
+	"main_nav": [
+		{
+			// 导航标题
+			"title": "系统",
+			// 路由地址
+			"url": "/sys",
+			// 显示顺序, 数字越小显示越靠前
+			"display": 3,
+			/* 子导航 */
+			"sub": [
+				{
+					// 导航标题
+					"title": "用户管理",
+					// 路由地址
+					"url": "/sys/app"
+				},
+				{
+					// 导航标题
+					"title": "网站设置",
+					// 路由地址
+					"url": "/sys/web"
+				},
+				{
+					// 导航标题
+					"title": "应用管理",
+					// 路由地址
+					"url": "/sys/app"
+				}
+			]
+		}
+	]
+}

package/example/index.js

@@ -0,0 +1,35 @@
+/**
+ * mm_nav 最小可运行示例
+ * @description 演示 Nav 导航类的路由/导航项构建与 Manager 管理器（纯内存操作，无外部服务）
+ */
+const { Nav, Manager, navAdmin } = require('../index.js');
+
+/**
+ * 主函数
+ */
+function main() {
+  console.log('== mm_nav 示例开始 ==');
+
+  // 实例化导航驱动
+  const nav = new Nav({ name: 'example' });
+
+  // 构建导航项与路由
+  const mainNav = nav.newNav('首页', 'home', '/home', 1);
+  const route = nav.newRoutes('example', 'pc', 'example_index', 0);
+  console.log('导航项:', JSON.stringify(mainNav));
+  console.log('路由项:', JSON.stringify(route));
+
+  // 追加到配置并输出
+  nav.config.main_nav.push(mainNav);
+  nav.config.routes.push(route);
+  const result = nav.run('main_nav');
+  console.log('run("main_nav") 输出条目数:', result.main_nav.length);
+
+  // 通过工厂函数获取管理器实例
+  const manager = navAdmin('example');
+  console.log('navAdmin 获取实例:', manager instanceof Manager);
+
+  console.log('== mm_nav 示例结束 ==');
+}
+
+main();

package/index.js

@@ -0,0 +1,17 @@
+const Admin = require('mm_corejs').Admin;
+const Manager = require('./lib/manager');
+
+let admin = new Admin();
+admin.setClass(Manager);
+
+module.exports = {
+  Nav: require('./lib/nav'),
+  Manager,
+  admin,
+  navAdmin(scope, config) {
+    if (!scope) {
+      scope = 'os';
+    }
+    return admin.get(scope, config);
+  }
+};

package/lib/manager.js

@@ -0,0 +1,187 @@
+const Manager = require("mm_mod").Manager;
+const Nav = require("./nav");
+
+/**
+ * NavManager导航类
+ * @augments {Manager}
+ * @class
+ */
+class NavManager extends Manager {
+  /**
+   * 配置参数
+   * @type {object}
+   */
+  static config = {
+    /**
+     * 名称
+     * @type {string}
+     */
+    name: "",
+    /**
+     * 标题
+     * @type {string}
+     */
+    title: "导航管理",
+    /**
+     * 描述
+     * @type {string}
+     */
+    description: "这是导航管理器",
+    /**
+     * API配置获取函数（可选注入，按scope返回api集合；未配置则跳过API配置获取）
+     * @type {Function|null}
+     */
+    get_api: null,
+  };
+
+  /**
+   * 构造函数
+   * @param {object} config 配置参数
+   * @param {object} parent 父级模块（仅作兼容传入，不使用）
+   */
+  constructor(config, parent) {
+    super({ ...NavManager.config, ...config }, parent);
+  }
+}
+
+/**
+ * 导航驱动类
+ * @type {Drive}
+ */
+NavManager.prototype.Drive = Nav;
+
+/**
+ * 注册一个导航配置（方案B：手动注册，不扫描目录）
+ * @param {object} config 驱动配置（必须包含 name）
+ * @returns {object} 驱动实例
+ */
+NavManager.prototype.add = function (config) {
+  var drive = new this.Drive(config, this);
+  this.set(drive.config.name, drive);
+  return drive;
+};
+
+/**
+ * 注销一个导航配置
+ * @param {string} name 导航名称
+ * @returns {Promise<boolean>} 是否删除成功
+ */
+NavManager.prototype.del = async function (name) {
+  return Manager.prototype.del.call(this, name);
+};
+
+/**
+ * 重载一个导航配置（按原配置重建驱动实例）
+ * @param {string} name 导航名称
+ * @returns {Promise<boolean>} 是否执行成功
+ */
+NavManager.prototype.reload = async function (name) {
+  var drive = this.get(name);
+  if (!drive) {
+    this.log("warn", "导航配置不存在，无法重载", name);
+    return false;
+  }
+  var config = drive.config;
+  await this.del(name);
+  this.add(config);
+  return true;
+};
+
+/**
+ * 执行导航
+ * @param {string} name 导航名称
+ * @param {string} type 导航类型
+ * @returns {object | string} 导航配置
+ */
+NavManager.prototype.run = async function (name, type) {
+  var obj = new Drive();
+  if (name) {
+    var mod = this.get(name);
+    if (mod) {
+      obj.merge(mod.config);
+    }
+  } else {
+    var mods = this.values();
+    for (var i = 0; i < mods.length; i++) {
+      obj.merge(mods[i].config);
+    }
+  }
+
+  await obj.sort();
+  var cg = obj.config;
+  if (cg.name) {
+    if (type) {
+      return cg[type];
+    } else {
+      return cg;
+    }
+  }
+  return null;
+};
+
+/**
+ * 排序所有导航配置
+ * @returns {Promise<Array>} 按sort降序排列的配置列表
+ */
+NavManager.prototype._sort = async function () {
+  var mods = this.values();
+  for (var i = 0; i < mods.length; i++) {
+    await mods[i].sort();
+  }
+  var infos = this.configs;
+  infos.sort((o1, o2) => {
+    var p1 = o1.sort || 100;
+    var p2 = o2.sort || 100;
+    return p2 - p1;
+  });
+  return infos;
+};
+
+/**
+ * 更新路由vue文件
+ * @param {object} param 参数
+ * @property {string} param.name 要更新的配置名
+ * @property {boolean} param.cover 是否覆盖文件
+ * @property {string} param.route_name 路由名称
+ * @property {string} param.path 路由路径
+ * @returns {string} 更新成功返回null, 失败返回错误提示
+ */
+NavManager.prototype.updateVue = async function (param) {
+  var { name, cover, route_name, path } = param;
+
+  if (name) {
+    var mod = this.get(name);
+    if (mod) {
+      await mod.updateVue(path, cover);
+    } else {
+      return "该配置不存在";
+    }
+  } else {
+    var infos = this.configs;
+    for (var i = 0; i < infos.length; i++) {
+      var info = infos[i];
+      if (route_name && info.name !== route_name) {
+        continue;
+      }
+      var drive = this.get(info.name);
+      if (drive) {
+        await drive.updateVue(path, cover);
+      }
+    }
+  }
+  return null;
+};
+
+/**
+ * 获取所有导航配置列表（方案B：来自注册表，替代旧基类 getInfos）
+ * @returns {Array} 配置数组
+ * @private
+ */
+NavManager.prototype._getInfos = function () {
+  return this.values().map((d) => d.config);
+};
+
+/**
+ * @module 导出导航管理器类
+ */
+module.exports = NavManager;