@nocobase/plugin-client 1.6.0-alpha.2 → 1.6.0-alpha.21

package/dist/server/migrations/2024122912211-transform-menu-schema-to-routes.js

@@ -0,0 +1,184 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var transform_menu_schema_to_routes_exports = {};
+__export(transform_menu_schema_to_routes_exports, {
+  default: () => transform_menu_schema_to_routes_default,
+  schemaToRoutes: () => schemaToRoutes
+});
+module.exports = __toCommonJS(transform_menu_schema_to_routes_exports);
+var import_server = require("@nocobase/server");
+class transform_menu_schema_to_routes_default extends import_server.Migration {
+  appVersion = "<1.6.0";
+  async up() {
+    const uiSchemas = this.db.getRepository("uiSchemas");
+    const desktopRoutes = this.db.getRepository("desktopRoutes");
+    const count = await desktopRoutes.count();
+    if (count > 0) {
+      return;
+    }
+    const mobileRoutes = this.db.getRepository("mobileRoutes");
+    const rolesRepository = this.db.getRepository("roles");
+    const menuSchema = await uiSchemas.getJsonSchema("nocobase-admin-menu");
+    const routes = await schemaToRoutes(menuSchema, uiSchemas);
+    try {
+      await this.db.sequelize.transaction(async (transaction) => {
+        var _a;
+        if (routes.length > 0) {
+          await desktopRoutes.createMany({
+            records: routes,
+            transaction
+          });
+          const roles = await rolesRepository.find({
+            appends: ["desktopRoutes", "menuUiSchemas"],
+            transaction
+          });
+          for (const role of roles) {
+            const menuUiSchemas = role.menuUiSchemas || [];
+            const desktopRoutes2 = role.desktopRoutes || [];
+            const needRemoveIds = getNeedRemoveIds(desktopRoutes2, menuUiSchemas);
+            if (needRemoveIds.length === 0) {
+              continue;
+            }
+            await this.db.getRepository("roles.desktopRoutes", role.name).remove({
+              tk: needRemoveIds,
+              transaction
+            });
+          }
+        }
+        if (mobileRoutes) {
+          const allMobileRoutes = await mobileRoutes.find({
+            transaction
+          });
+          for (const item of allMobileRoutes || []) {
+            if (item.type !== "page") {
+              continue;
+            }
+            const mobileRouteSchema = await uiSchemas.getJsonSchema(item.schemaUid);
+            const enableTabs = !!((_a = mobileRouteSchema == null ? void 0 : mobileRouteSchema["x-component-props"]) == null ? void 0 : _a.displayTabs);
+            await mobileRoutes.update({
+              filterByTk: item.id,
+              values: {
+                enableTabs
+              },
+              transaction
+            });
+            await mobileRoutes.update({
+              filter: {
+                parentId: item.id
+              },
+              values: {
+                hidden: !enableTabs
+              },
+              transaction
+            });
+          }
+        }
+      });
+    } catch (error) {
+      console.error("Migration failed:", error);
+      throw error;
+    }
+  }
+}
+async function schemaToRoutes(schema, uiSchemas) {
+  const schemaKeys = Object.keys(schema.properties || {});
+  if (schemaKeys.length === 0) {
+    return [];
+  }
+  const result = schemaKeys.map(async (key) => {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j;
+    const item = schema.properties[key];
+    if (item["x-component"] === "Menu.SubMenu") {
+      return {
+        type: "group",
+        title: item.title,
+        icon: (_a = item["x-component-props"]) == null ? void 0 : _a.icon,
+        schemaUid: item["x-uid"],
+        hideInMenu: false,
+        children: await schemaToRoutes(item, uiSchemas)
+      };
+    }
+    if (item["x-component"] === "Menu.Item") {
+      const menuSchema = await uiSchemas.getProperties(item["x-uid"]);
+      const pageSchema = (_b = menuSchema == null ? void 0 : menuSchema.properties) == null ? void 0 : _b.page;
+      const enableTabs = (_c = pageSchema == null ? void 0 : pageSchema["x-component-props"]) == null ? void 0 : _c.enablePageTabs;
+      const enableHeader = !((_d = pageSchema == null ? void 0 : pageSchema["x-component-props"]) == null ? void 0 : _d.disablePageHeader);
+      const displayTitle = !((_e = pageSchema == null ? void 0 : pageSchema["x-component-props"]) == null ? void 0 : _e.hidePageTitle);
+      return {
+        type: "page",
+        title: item.title,
+        icon: (_f = item["x-component-props"]) == null ? void 0 : _f.icon,
+        schemaUid: pageSchema == null ? void 0 : pageSchema["x-uid"],
+        menuSchemaUid: item["x-uid"],
+        hideInMenu: false,
+        enableTabs,
+        enableHeader,
+        displayTitle,
+        children: (await schemaToRoutes(pageSchema, uiSchemas)).map((item2) => ({ ...item2, hidden: !enableTabs }))
+      };
+    }
+    if (item["x-component"] === "Menu.URL") {
+      return {
+        type: "link",
+        title: item.title,
+        icon: (_g = item["x-component-props"]) == null ? void 0 : _g.icon,
+        options: {
+          href: (_h = item["x-component-props"]) == null ? void 0 : _h.href,
+          params: (_i = item["x-component-props"]) == null ? void 0 : _i.params
+        },
+        schemaUid: item["x-uid"],
+        hideInMenu: false
+      };
+    }
+    return {
+      type: "tabs",
+      title: item.title || '{{t("Unnamed")}}',
+      icon: (_j = item["x-component-props"]) == null ? void 0 : _j.icon,
+      schemaUid: item["x-uid"],
+      tabSchemaName: key,
+      hideInMenu: false
+    };
+  });
+  return Promise.all(result);
+}
+function getNeedRemoveIds(desktopRoutes, menuUiSchemas) {
+  const uidList = menuUiSchemas.map((item) => item["x-uid"]);
+  return desktopRoutes.filter((item) => {
+    if (item.type === "tabs") {
+      const page = desktopRoutes.find((route) => (route == null ? void 0 : route.id) === (item == null ? void 0 : item.parentId));
+      return !uidList.includes(page == null ? void 0 : page.menuSchemaUid);
+    }
+    if (item.type === "page") {
+      return !uidList.includes(item == null ? void 0 : item.menuSchemaUid);
+    }
+    return !uidList.includes(item == null ? void 0 : item.schemaUid);
+  }).map((item) => item == null ? void 0 : item.id);
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  schemaToRoutes
+});

package/dist/server/server.d.ts

@@ -11,5 +11,11 @@ export declare class PluginClientServer extends Plugin {
     beforeLoad(): Promise<void>;
     install(): Promise<void>;
     load(): Promise<void>;
+    setACL(): void;
+    /**
+     * used to implement: roles with permission (allowNewMenu is true) can directly access the newly created menu
+     */
+    bindNewMenuToRoles(): void;
+    registerActionHandlers(): void;
 }
 export default PluginClientServer;

package/dist/server/server.js

@@ -41,11 +41,11 @@ __export(server_exports, {
 });
 module.exports = __toCommonJS(server_exports);
 var import_server = require("@nocobase/server");
+var process = __toESM(require("node:process"));
 var import_path = require("path");
 var import_antd = require("./antd");
 var import_cron = require("./cron");
 var import_cronstrue = require("./cronstrue");
-var process = __toESM(require("node:process"));
 async function getLang(ctx) {
   const SystemSetting = ctx.db.getRepository("systemSettings");
   const systemSetting = await SystemSetting.findOne();
@@ -96,17 +96,17 @@ class PluginClientServer extends import_server.Plugin {
     this.app.acl.allow("app", "getInfo");
     this.app.acl.registerSnippet({
       name: "app",
-      actions: ["app:restart", "app:clearCache"]
+      actions: ["app:restart", "app:refresh", "app:clearCache"]
     });
     const dialect = this.app.db.sequelize.getDialect();
-    this.app.resource({
+    this.app.resourceManager.define({
       name: "app",
       actions: {
         async getInfo(ctx, next) {
           var _a, _b;
           const SystemSetting = ctx.db.getRepository("systemSettings");
           const systemSetting = await SystemSetting.findOne();
-          const enabledLanguages = systemSetting.get("enabledLanguages") || [];
+          const enabledLanguages = (systemSetting == null ? void 0 : systemSetting.get("enabledLanguages")) || [];
           const currentUser = ctx.state.currentUser;
           let lang = (enabledLanguages == null ? void 0 : enabledLanguages[0]) || process.env.APP_LANG || "en-US";
           if (enabledLanguages.includes(currentUser == null ? void 0 : currentUser.appLang)) {
@@ -124,6 +124,12 @@ class PluginClientServer extends import_server.Plugin {
           if (process.env["EXPORT_LIMIT"]) {
             info.exportLimit = parseInt(process.env["EXPORT_LIMIT"]);
           }
+          if (process.env["EXPORT_AUTO_MODE_THRESHOLD"]) {
+            info.exportAutoModeThreshold = parseInt(process.env["EXPORT_AUTO_MODE_THRESHOLD"]);
+          }
+          if (process.env["EXPORT_ATTACHMENTS_AUTO_MODE_THRESHOLD"]) {
+            info.exportAttachmentsAutoModeThreshold = parseInt(process.env["EXPORT_ATTACHMENTS_AUTO_MODE_THRESHOLD"]);
+          }
           ctx.body = info;
           await next();
         },
@@ -143,10 +149,91 @@ class PluginClientServer extends import_server.Plugin {
         async restart(ctx, next) {
           ctx.app.runAsCLI(["restart"], { from: "user" });
           await next();
+        },
+        async refresh(ctx, next) {
+          ctx.app.runCommand("refresh");
+          await next();
         }
       }
     });
-    this.app.auditManager.registerActions(["app:restart", "app:clearCache"]);
+    this.app.auditManager.registerActions(["app:restart", "app:refresh", "app:clearCache"]);
+    this.registerActionHandlers();
+    this.bindNewMenuToRoles();
+    this.setACL();
+    this.app.db.on("desktopRoutes.afterUpdate", async (instance, { transaction }) => {
+      if (instance.changed("enableTabs")) {
+        const repository = this.app.db.getRepository("desktopRoutes");
+        await repository.update({
+          filter: {
+            parentId: instance.id
+          },
+          values: {
+            hidden: !instance.enableTabs
+          },
+          transaction
+        });
+      }
+    });
+  }
+  setACL() {
+    this.app.acl.registerSnippet({
+      name: `ui.desktopRoutes`,
+      actions: ["desktopRoutes:create", "desktopRoutes:update", "desktopRoutes:move", "desktopRoutes:destroy"]
+    });
+    this.app.acl.registerSnippet({
+      name: `pm.desktopRoutes`,
+      actions: ["desktopRoutes:list", "roles.desktopRoutes:*"]
+    });
+    this.app.acl.allow("desktopRoutes", "listAccessible", "loggedIn");
+  }
+  /**
+   * used to implement: roles with permission (allowNewMenu is true) can directly access the newly created menu
+   */
+  bindNewMenuToRoles() {
+    this.app.db.on("roles.beforeCreate", async (instance) => {
+      instance.set(
+        "allowNewMenu",
+        instance.allowNewMenu === void 0 ? ["admin", "member"].includes(instance.name) : !!instance.allowNewMenu
+      );
+    });
+    this.app.db.on("desktopRoutes.afterCreate", async (instance, { transaction }) => {
+      const addNewMenuRoles = await this.app.db.getRepository("roles").find({
+        filter: {
+          allowNewMenu: true
+        },
+        transaction
+      });
+      await this.app.db.getRepository("desktopRoutes.roles", instance.id).add({
+        tk: addNewMenuRoles.map((role) => role.name),
+        transaction
+      });
+    });
+  }
+  registerActionHandlers() {
+    this.app.resourceManager.registerActionHandler("desktopRoutes:listAccessible", async (ctx, next) => {
+      const desktopRoutesRepository = ctx.db.getRepository("desktopRoutes");
+      const rolesRepository = ctx.db.getRepository("roles");
+      if (ctx.state.currentRole === "root") {
+        ctx.body = await desktopRoutesRepository.find({
+          tree: true,
+          ...ctx.query
+        });
+        return await next();
+      }
+      const role = await rolesRepository.findOne({
+        filterByTk: ctx.state.currentRole,
+        appends: ["desktopRoutes"]
+      });
+      const desktopRoutesId = role.get("desktopRoutes").filter((item) => !item.hidden).map((item) => item.id);
+      ctx.body = await desktopRoutesRepository.find({
+        tree: true,
+        ...ctx.query,
+        filter: {
+          id: desktopRoutesId
+        }
+      });
+      await next();
+    });
   }
 }
 var server_default = PluginClientServer;

package/package.json

@@ -4,7 +4,7 @@
   "displayName.zh-CN": "WEB 客户端",
   "description": "Provides a client interface for the NocoBase server",
   "description.zh-CN": "为 NocoBase 服务端提供客户端界面",
-  "version": "1.6.0-alpha.2",
+  "version": "1.6.0-alpha.21",
   "main": "./dist/server/index.js",
   "license": "AGPL-3.0",
   "devDependencies": {
@@ -20,5 +20,5 @@
     "@nocobase/test": "1.x",
     "@nocobase/utils": "1.x"
   },
-  "gitHead": "08bbc34c21727fc0ad0880f397a42bf7741091ee"
+  "gitHead": "873cbaec9554e684781b8dc6cfd4386bb5cfa5b0"
 }