@nocobase/flow-engine/src/utils/parsePathnameToViewParams.ts

A standalone flow engine for NocoBase, managing workflows, models, and actions.

/**
 * 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 interface ViewParam {
  /** 视图唯一标识符，一般为某个 Model 实例的 uid */
  viewUid: string;
  /** 标签页唯一标识符 */
  tabUid?: string;
  /** 弹窗记录的 id */
  filterByTk?: string;
  /** source Id */
  sourceId?: string;
}

/**
 * 解析路径名为视图参数数组
 *
 * 支持解析包含多个视图的路径，每个视图可以包含 tab、filterByTk、sourceId 等参数
 *
 * @param pathname - 要解析的路径名，格式如 '/admin/xxx/view/xxx/tab/xxx'
 * @returns 视图参数数组，每个元素对应一个视图
 *
 * @example
 * ```typescript
 * parsePathnameToViewParams('/admin/xxx') // [{ viewUid: 'xxx' }]
 * parsePathnameToViewParams('/admin/xxx/tab/yyy') // [{ viewUid: 'xxx', tabUid: 'yyy' }]
 * parsePathnameToViewParams('/admin/xxx/view/yyy') // [{ viewUid: 'xxx' }, { viewUid: 'yyy' }]
 * ```
 */
export const parsePathnameToViewParams = (pathname: string): ViewParam[] => {
  if (!pathname || pathname === '/') {
    return [];
  }

  // 移除开头的斜杠并分割路径
  const segments = pathname.replace(/^\/+/, '').split('/').filter(Boolean);

  if (segments.length < 2) {
    return [];
  }

  const result: ViewParam[] = [];
  let currentView: ViewParam | null = null;
  let i = 0;

  while (i < segments.length) {
    const segment = segments[i];

    // 处理 admin 或 view 关键字
    if (segment === 'admin' || segment === 'view') {
      // 如果有当前视图，先保存到结果中
      if (currentView) {
        result.push(currentView);
      }

      // 获取视图 UID
      if (i + 1 < segments.length) {
        currentView = { viewUid: segments[i + 1] };
        i += 2; // 跳过 admin/view 和 viewUid
      } else {
        // 没有 viewUid，跳出循环
        break;
      }
    }
    // 处理参数
    else if (currentView && i + 1 < segments.length) {
      const value = segments[i + 1];

      switch (segment) {
        case 'tab':
          currentView.tabUid = value;
          break;
        case 'filterbytk':
          currentView.filterByTk = value;
          break;
        case 'sourceid':
          currentView.sourceId = value;
          break;
        default:
          // 未知参数，跳过
          break;
      }

      i += 2; // 跳过参数名和参数值
    } else {
      // 无法处理的情况，跳过当前段
      i++;
    }
  }

  // 保存最后一个视图
  if (currentView) {
    result.push(currentView);
  }

  return result;
};