@nocobase/plugin-ui-layout 2.2.0-alpha.2

package/dist/server/ensureDefaultUiLayout.js

@@ -0,0 +1,129 @@
+/**
+ * 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 ensureDefaultUiLayout_exports = {};
+__export(ensureDefaultUiLayout_exports, {
+  ensureDefaultUiLayout: () => ensureDefaultUiLayout
+});
+module.exports = __toCommonJS(ensureDefaultUiLayout_exports);
+var import_constants = require("../constants");
+const GENERATED_DEFAULT_TITLE = "Untitled";
+const DEFAULT_ADMIN_UI_LAYOUT_PROTECTED_FIELDS = [
+  "layoutType",
+  "routeName",
+  "routePath",
+  "authCheck",
+  "enabled"
+];
+function getFallbackTitle(record) {
+  if (record.uid === import_constants.DEFAULT_ADMIN_UI_LAYOUT.uid) {
+    return import_constants.DEFAULT_ADMIN_UI_LAYOUT.title;
+  }
+  if (record.layoutType === import_constants.UI_LAYOUT_TYPE_MOBILE) {
+    return "Mobile layout";
+  }
+  if (record.layoutType === import_constants.UI_LAYOUT_TYPE_DESKTOP) {
+    return "Desktop layout";
+  }
+  return record.routeName || record.uid;
+}
+function shouldBackfillTitle(title) {
+  return !title || title === GENERATED_DEFAULT_TITLE;
+}
+async function ensureUiLayoutTitles(repository, transaction) {
+  const records = await repository.find({ transaction });
+  for (const record of records) {
+    if (!shouldBackfillTitle(record.get("title"))) {
+      continue;
+    }
+    await repository.update({
+      filterByTk: record.get("uid"),
+      values: {
+        title: getFallbackTitle(record.toJSON())
+      },
+      transaction
+    });
+  }
+}
+async function ensureDefaultMobileUiLayout(repository, transaction) {
+  const existed = await repository.findOne({
+    filter: {
+      uid: import_constants.DEFAULT_MOBILE_UI_LAYOUT.uid
+    },
+    transaction
+  });
+  if (existed) {
+    return;
+  }
+  await repository.create({
+    values: import_constants.DEFAULT_MOBILE_UI_LAYOUT,
+    transaction
+  });
+}
+async function ensureDefaultUiLayout(db) {
+  await db.sequelize.transaction(async (transaction) => {
+    const repository = db.getRepository("uiLayouts");
+    const existed = await repository.findOne({
+      filter: {
+        uid: import_constants.DEFAULT_ADMIN_UI_LAYOUT.uid
+      },
+      transaction
+    });
+    if (!existed) {
+      await repository.create({
+        values: import_constants.DEFAULT_ADMIN_UI_LAYOUT,
+        transaction
+      });
+      await ensureDefaultMobileUiLayout(repository, transaction);
+      await ensureUiLayoutTitles(repository, transaction);
+      return;
+    }
+    const values = {};
+    for (const field of DEFAULT_ADMIN_UI_LAYOUT_PROTECTED_FIELDS) {
+      if (existed.get(field) !== import_constants.DEFAULT_ADMIN_UI_LAYOUT[field]) {
+        Object.assign(values, {
+          [field]: import_constants.DEFAULT_ADMIN_UI_LAYOUT[field]
+        });
+      }
+    }
+    if (shouldBackfillTitle(existed.get("title"))) {
+      values.title = import_constants.DEFAULT_ADMIN_UI_LAYOUT.title;
+    }
+    if (Object.keys(values).length) {
+      await repository.update({
+        filterByTk: existed.get("uid"),
+        values,
+        transaction
+      });
+    }
+    await ensureUiLayoutTitles(repository, transaction);
+    await ensureDefaultMobileUiLayout(repository, transaction);
+  });
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ensureDefaultUiLayout
+});

package/dist/server/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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.
+ */
+export { default } from './plugin';

package/dist/server/index.js

@@ -0,0 +1,42 @@
+/**
+ * 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 __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+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 __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var server_exports = {};
+__export(server_exports, {
+  default: () => import_plugin.default
+});
+module.exports = __toCommonJS(server_exports);
+var import_plugin = __toESM(require("./plugin"));

package/dist/server/migrations/20260601090000-ensure-default-admin-layout.d.ts

@@ -0,0 +1,13 @@
+/**
+ * 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.
+ */
+import { Migration } from '@nocobase/server';
+export default class extends Migration {
+    on: string;
+    up(): Promise<void>;
+}

package/dist/server/migrations/20260601090000-ensure-default-admin-layout.js

@@ -0,0 +1,39 @@
+/**
+ * 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 ensure_default_admin_layout_exports = {};
+__export(ensure_default_admin_layout_exports, {
+  default: () => ensure_default_admin_layout_default
+});
+module.exports = __toCommonJS(ensure_default_admin_layout_exports);
+var import_server = require("@nocobase/server");
+var import_ensureDefaultUiLayout = require("../ensureDefaultUiLayout");
+class ensure_default_admin_layout_default extends import_server.Migration {
+  on = "afterSync";
+  async up() {
+    await (0, import_ensureDefaultUiLayout.ensureDefaultUiLayout)(this.db);
+  }
+}

package/dist/server/migrations/20260615090000-backfill-admin-layout-desktop-routes.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 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.
+ */
+import type { Database } from '@nocobase/database';
+import { Migration } from '@nocobase/server';
+export declare function backfillAdminLayoutDesktopRoutes(db: Database): Promise<void>;
+export default class extends Migration {
+    on: string;
+    up(): Promise<void>;
+}

package/dist/server/migrations/20260615090000-backfill-admin-layout-desktop-routes.js

@@ -0,0 +1,94 @@
+/**
+ * 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 backfill_admin_layout_desktop_routes_exports = {};
+__export(backfill_admin_layout_desktop_routes_exports, {
+  backfillAdminLayoutDesktopRoutes: () => backfillAdminLayoutDesktopRoutes,
+  default: () => backfill_admin_layout_desktop_routes_default
+});
+module.exports = __toCommonJS(backfill_admin_layout_desktop_routes_exports);
+var import_server = require("@nocobase/server");
+var import_constants = require("../../constants");
+function hasRelationRecords(route, relationName) {
+  const records = route.get(relationName);
+  return Array.isArray(records) && records.length > 0;
+}
+function hasRelation(db, collectionName, relationName) {
+  var _a;
+  return !!((_a = db.getCollection(collectionName)) == null ? void 0 : _a.getField(relationName));
+}
+async function backfillAdminLayoutDesktopRoutesInTransaction(db, transaction) {
+  if (!db.getCollection("desktopRoutes") || !db.getCollection("uiLayouts")) {
+    return;
+  }
+  if (!hasRelation(db, "desktopRoutes", "uiLayouts")) {
+    return;
+  }
+  const adminLayout = await db.getRepository("uiLayouts").findOne({
+    filterByTk: import_constants.DEFAULT_ADMIN_UI_LAYOUT.uid,
+    transaction
+  });
+  if (!adminLayout) {
+    return;
+  }
+  const hasMultiPortalRelation = !!db.getCollection("multiPortals") && hasRelation(db, "desktopRoutes", "multiPortals");
+  const appends = hasMultiPortalRelation ? ["uiLayouts", "multiPortals"] : ["uiLayouts"];
+  const routes = await db.getRepository("desktopRoutes").find({
+    appends,
+    transaction
+  });
+  for (const route of routes) {
+    const routeId = route.get("id");
+    if (routeId === null || routeId === void 0) {
+      continue;
+    }
+    if (hasRelationRecords(route, "uiLayouts")) {
+      continue;
+    }
+    if (hasMultiPortalRelation && hasRelationRecords(route, "multiPortals")) {
+      continue;
+    }
+    await db.getRepository("desktopRoutes.uiLayouts", routeId).set({
+      tk: [import_constants.DEFAULT_ADMIN_UI_LAYOUT.uid],
+      transaction
+    });
+  }
+}
+async function backfillAdminLayoutDesktopRoutes(db) {
+  await db.sequelize.transaction(async (transaction) => {
+    await backfillAdminLayoutDesktopRoutesInTransaction(db, transaction);
+  });
+}
+class backfill_admin_layout_desktop_routes_default extends import_server.Migration {
+  on = "afterSync";
+  async up() {
+    await backfillAdminLayoutDesktopRoutes(this.db);
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  backfillAdminLayoutDesktopRoutes
+});

package/dist/server/plugin.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 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.
+ */
+import { Plugin } from '@nocobase/server';
+export declare class PluginUiLayoutServer extends Plugin {
+    afterAdd(): Promise<void>;
+    beforeLoad(): Promise<void>;
+    load(): Promise<void>;
+    install(): Promise<void>;
+    afterEnable(): Promise<void>;
+    afterDisable(): Promise<void>;
+    remove(): Promise<void>;
+}
+export default PluginUiLayoutServer;