@nocobase/client-v2 2.1.0-beta.36 → 2.1.0-beta.38

package/src/flow/admin-shell/AdminLayoutRouteCoordinator.ts

@@ -7,339 +7,21 @@
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
 
-import {
-  FlowEngine,
-  FlowModel,
-  observable,
-  parsePathnameToViewParams,
-  ViewNavigation,
-  type ViewParam,
-} from '@nocobase/flow-engine';
-import React from 'react';
-import { getViewDiffAndUpdateHidden, getKey } from '../getViewDiffAndUpdateHidden';
-import { getOpenViewStepParams } from '../flows/openViewFlow';
-import { resolveViewParamsToViewList, updateViewListHidden, type ViewItem } from '../resolveViewParamsToViewList';
-
-export interface RoutePageMeta {
-  active: boolean;
-  refreshDesktopRoutes?: () => Promise<unknown>;
-  layoutContentElement?: HTMLElement | null;
-}
-
-interface ViewRuntimeState {
-  destroy: (force?: boolean) => void;
-  update: (value: any) => void;
-  navigation: ViewNavigation;
-}
-
-interface RoutePageRuntime {
-  pageUid: string;
-  routeModel: FlowModel;
-  meta: RoutePageMeta;
-  viewState: Record<string, ViewRuntimeState>;
-  prevViewList: ViewItem[];
-  hasStepNavigated: boolean;
-  forceStop: boolean;
-}
-
-interface RouteLike {
-  params?: { name?: string };
-  pathname?: string;
-}
-
-const hasUsableSourceId = (sourceId: unknown) => sourceId !== undefined && sourceId !== null && String(sourceId) !== '';
+import type { FlowEngine } from '@nocobase/flow-engine';
+import { BaseLayoutRouteCoordinator, type BaseLayoutRouteCoordinatorOptions } from './BaseLayoutRouteCoordinator';
 
 /**
- * 管理 admin 场景下每个 page 的 v2 视图栈编排。
- * 该协调器只负责状态机和开关视图，不直接绑定 React 生命周期。
+ * Admin Layout 路由协调器。
+ *
+ * 该类保留旧导出路径，内部复用通用 BaseLayoutRouteCoordinator。
  */
-export class AdminLayoutRouteCoordinator {
-  private readonly flowEngine: FlowEngine;
-  private readonly runtimes = new Map<string, RoutePageRuntime>();
-  private layoutContentElement: HTMLElement | null = null;
-
-  private setRuntimeActive(runtime: RoutePageRuntime, active: boolean) {
-    runtime.meta.active = active;
-    if (runtime.routeModel.context.pageActive?.value !== active) {
-      runtime.routeModel.context.pageActive.value = active;
-    }
-  }
-
-  private getCurrentRouteByPageUid(pageUid: string) {
-    return this.flowEngine.context.routeRepository?.getRouteBySchemaUid?.(pageUid) || {};
-  }
-
-  constructor(flowEngine: FlowEngine) {
-    this.flowEngine = flowEngine;
-  }
-
-  setLayoutContentElement(element: HTMLElement | null) {
-    this.layoutContentElement = element;
-  }
-
-  registerPage(pageUid: string, meta: RoutePageMeta) {
-    const routeModel = this.getOrCreateRouteModel(pageUid);
-    const runtime: RoutePageRuntime = {
-      pageUid,
-      routeModel,
-      meta: {
-        active: !!meta.active,
-        refreshDesktopRoutes: meta.refreshDesktopRoutes,
-        layoutContentElement: meta.layoutContentElement || null,
-      },
-      viewState: {},
-      prevViewList: [],
-      hasStepNavigated: false,
-      forceStop: false,
-    };
-
-    this.ensureRouteModelContext(runtime);
-    this.runtimes.set(pageUid, runtime);
-    this.syncPageMeta(pageUid, meta);
-    this.syncRoute(this.flowEngine.context.route || {});
-
-    return runtime.routeModel;
-  }
-
-  syncPageMeta(pageUid: string, meta: Partial<RoutePageMeta>) {
-    const runtime = this.runtimes.get(pageUid);
-    if (!runtime) {
-      return;
-    }
-
-    runtime.meta = {
-      ...runtime.meta,
-      ...meta,
-      active: typeof meta.active === 'boolean' ? meta.active : runtime.meta.active,
-      layoutContentElement: meta.layoutContentElement ?? runtime.meta.layoutContentElement,
-    };
-
-    this.setRuntimeActive(runtime, runtime.meta.active);
-  }
-
-  unregisterPage(pageUid: string) {
-    this.cleanupPage(pageUid);
-    this.runtimes.delete(pageUid);
-  }
-
-  syncRoute(routeLike: RouteLike) {
-    const activePageUid = routeLike?.params?.name;
-    const pathname = routeLike?.pathname;
-
-    this.runtimes.forEach((runtime) => {
-      this.setRuntimeActive(runtime, runtime.pageUid === activePageUid);
-    });
-
-    if (!activePageUid || !pathname) {
-      return;
-    }
-
-    this.runtimes.forEach((runtime) => {
-      if (runtime.pageUid !== activePageUid) {
-        runtime.forceStop = true;
-      }
-    });
-
-    const runtime = this.runtimes.get(activePageUid);
-    if (!runtime) {
-      return;
-    }
-
-    runtime.forceStop = false;
-    this.syncRuntimeWithPathname(runtime, pathname);
-  }
-
-  cleanupPage(pageUid: string) {
-    const runtime = this.runtimes.get(pageUid);
-    if (!runtime) {
-      return;
-    }
-
-    runtime.forceStop = true;
-    runtime.prevViewList.forEach((viewItem) => {
-      this.flowEngine.removeModelWithSubModels(viewItem.params.viewUid);
-      runtime.viewState[getKey(viewItem)]?.destroy?.();
-      delete runtime.viewState[getKey(viewItem)];
+export class AdminLayoutRouteCoordinator extends BaseLayoutRouteCoordinator {
+  constructor(flowEngine: FlowEngine, options: BaseLayoutRouteCoordinatorOptions = {}) {
+    super(flowEngine, {
+      basePathname: '/admin',
+      ...options,
     });
-    runtime.prevViewList = [];
-    runtime.hasStepNavigated = false;
-  }
-
-  destroy() {
-    Array.from(this.runtimes.keys()).forEach((pageUid) => {
-      this.cleanupPage(pageUid);
-      this.runtimes.delete(pageUid);
-    });
-  }
-
-  private syncRuntimeWithPathname(runtime: RoutePageRuntime, pathname: string) {
-    try {
-      const viewStack = parsePathnameToViewParams(pathname);
-      const viewList = resolveViewParamsToViewList(this.flowEngine, viewStack, runtime.routeModel);
-
-      if (this.shouldStepNavigate(runtime, viewList)) {
-        this.stepNavigate(viewList, 0);
-        runtime.hasStepNavigated = true;
-        return;
-      }
-
-      const { viewsToClose, viewsToOpen } = getViewDiffAndUpdateHidden(runtime.prevViewList, viewList);
-
-      if (viewsToClose.length) {
-        viewsToClose.forEach((viewItem) => {
-          runtime.viewState[getKey(viewItem)]?.destroy?.(true);
-          delete runtime.viewState[getKey(viewItem)];
-        });
-        updateViewListHidden(viewList);
-      }
-
-      if (viewsToOpen.length) {
-        void this.handleOpenViews(runtime, viewList, viewsToOpen);
-      }
-
-      if (viewsToClose.length === 0 && viewsToOpen.length === 0) {
-        const currentViewItem = viewList.at(-1);
-        if (currentViewItem) {
-          runtime.viewState[getKey(currentViewItem)]?.navigation.setViewStack(viewList.map((item) => item.params));
-        }
-      }
-
-      runtime.prevViewList = [...viewList];
-    } catch (error) {
-      console.error(`[NocoBase] Failed to resolve view params to view list:`, error);
-    }
-  }
-
-  private shouldStepNavigate(runtime: RoutePageRuntime, viewList: ViewItem[]) {
-    return runtime.prevViewList.length === 0 && viewList.length > 1 && !runtime.hasStepNavigated;
-  }
-
-  private stepNavigate(viewList: ViewItem[], index: number) {
-    if (!viewList[index]) {
-      return;
-    }
-
-    if (index === 0) {
-      new ViewNavigation(this.flowEngine.context, []).navigateTo(viewList[index].params, { replace: true });
-    } else {
-      new ViewNavigation(
-        this.flowEngine.context,
-        viewList.slice(0, index).map((item) => item.params),
-      ).navigateTo(viewList[index].params);
-    }
-
-    this.stepNavigate(viewList, index + 1);
-  }
-
-  private async handleOpenViews(runtime: RoutePageRuntime, viewList: ViewItem[], viewsToOpen: ViewItem[]) {
-    const missingModels = viewsToOpen.filter((v) => !v.model);
-    if (missingModels.length > 0) {
-      await Promise.all(
-        missingModels.map(async (viewItem) => {
-          try {
-            viewItem.model = await this.flowEngine.loadModel({ uid: viewItem.modelUid });
-          } catch (error) {
-            console.error(`[NocoBase] Failed to load model ${viewItem.modelUid}:`, error);
-          }
-        }),
-      );
-    }
-
-    if (runtime.forceStop) {
-      return;
-    }
-
-    updateViewListHidden(viewList);
-    this.openViews(runtime, viewList, viewsToOpen, 0);
-  }
-
-  private openViews(runtime: RoutePageRuntime, viewList: ViewItem[], viewsToOpen: ViewItem[], index: number) {
-    if (!viewsToOpen[index]) {
-      return;
-    }
-
-    const viewItem = viewsToOpen[index];
-    if (!viewItem.model) {
-      return;
-    }
-
-    const destroyRef = React.createRef<(result?: any, force?: boolean) => void>();
-    const updateRef = React.createRef<(value: any) => void>();
-    const openViewParams = getOpenViewStepParams(viewItem.model);
-    const associationName =
-      openViewParams?.associationName && !hasUsableSourceId(viewItem.params.sourceId)
-        ? null
-        : openViewParams?.associationName;
-    const openerUids = viewList.slice(0, viewItem.index).map((item) => item.params.viewUid);
-    const navigation = new ViewNavigation(
-      this.flowEngine.context,
-      viewList.slice(0, viewItem.index + 1).map((item) => item.params),
-    );
-
-    viewItem.model.dispatchEvent('click', {
-      target: runtime.meta.layoutContentElement || this.layoutContentElement,
-      collectionName: openViewParams?.collectionName,
-      associationName,
-      dataSourceKey: openViewParams?.dataSourceKey,
-      destroyRef,
-      updateRef,
-      openerUids,
-      ...viewItem.params,
-      navigation,
-      onOpen: () => {
-        this.openViews(runtime, viewList, viewsToOpen, index + 1);
-      },
-      hidden: viewItem.hidden,
-      isMobileLayout: !!this.flowEngine.context.isMobileLayout,
-      triggerByRouter: true,
-    });
-
-    runtime.viewState[getKey(viewItem)] = {
-      destroy: (_force?: boolean) => destroyRef.current?.(),
-      update: (value: any) => updateRef.current?.(value),
-      navigation,
-    };
-  }
-
-  private ensureRouteModelContext(runtime: RoutePageRuntime) {
-    if (!runtime.routeModel.context.pageActive) {
-      runtime.routeModel.context.defineProperty('pageActive', {
-        value: observable.ref(false),
-        info: {
-          description:
-            'Whether current page route is active (keep-alive). This is an observable.ref<boolean> (use ctx.pageActive.value to read/write).',
-          detail: 'observable.ref<boolean>',
-        },
-      });
-    }
-
-    runtime.routeModel.context.defineProperty('currentRoute', {
-      get: () => this.getCurrentRouteByPageUid(runtime.pageUid),
-      // 当前路由来自 routeRepository，菜单更新后必须实时读取最新对象。
-      cache: false,
-    });
-
-    runtime.routeModel.context.defineProperty('refreshDesktopRoutes', {
-      get: () => runtime.meta.refreshDesktopRoutes,
-      // refresh 回调来自页面桥接层，切页后也需要读取最新引用。
-      cache: false,
-    });
-  }
-
-  private getOrCreateRouteModel(pageUid: string): FlowModel {
-    return (
-      this.flowEngine.getModel(pageUid) ||
-      this.flowEngine.createModel({
-        uid: pageUid,
-        use: 'RouteModel',
-      })
-    );
   }
 }
 
-/**
- * 将 pathname 解析结果和 pageUid 对齐，便于测试里复用。
- */
-export function toViewStack(pathname: string): ViewParam[] {
-  return parsePathnameToViewParams(pathname);
-}
+export { toViewStack, type BaseLayoutRouteCoordinatorOptions, type RoutePageMeta } from './BaseLayoutRouteCoordinator';