@nocobase/flow-engine 2.2.0-alpha.1 → 2.2.0-alpha.11

package/src/utils/index.ts

@@ -66,6 +66,16 @@ export { extractPropertyPath, formatPathToVariable, isVariableExpression } from
 
 export { clearAutoFlowError, getAutoFlowError, setAutoFlowError, type AutoFlowError } from './autoFlowError';
 export { parsePathnameToViewParams, type ViewParam } from './parsePathnameToViewParams';
+export {
+  createOpenViewRouteState,
+  decodeOpenViewRouteState,
+  encodeOpenViewRouteState,
+  isOpenViewRouteStateToken,
+  RUNJS_OPEN_VIEW_ROUTE_STATE,
+  type OpenViewRouteMode,
+  type OpenViewRouteSize,
+  type OpenViewRouteState,
+} from './openViewRouteState';
 export {
   decodeBase64Url,
   encodeBase64Url,
@@ -77,15 +87,6 @@ export {
   serializeCtxDateValue,
 } from './dateVariable';
 
-// 安全全局对象（window/document）
-export {
-  createSafeDocument,
-  createSafeWindow,
-  createSafeNavigator,
-  createSafeRunJSGlobals,
-  runjsWithSafeGlobals,
-} from './safeGlobals';
-
 // RunJS value helpers
 export { isRunJSValue, normalizeRunJSValue, extractUsedVariablePathsFromRunJS, type RunJSValue } from './runjsValue';
 

package/src/utils/loadedPageCache.ts

@@ -123,6 +123,13 @@ export const createLoadedPageCache = () => {
       }
     },
 
+    markDirtyForOptions(options?: LoadedPageOptions): void {
+      const key = getLoadedPageKey(options);
+      if (key) {
+        dirtyKeys.add(key);
+      }
+    },
+
     shouldBypass(options?: LoadedPageOptions, isFlowSettingsEnabled?: () => boolean): boolean {
       const key = getLoadedPageKey(options);
       if (!key || !dirtyKeys.has(key)) {

package/src/utils/openViewRouteState.ts

@@ -0,0 +1,107 @@
+/**
+ * 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.
+ */
+
+const OPEN_VIEW_ROUTE_MODES = ['drawer', 'dialog', 'embed'] as const;
+const OPEN_VIEW_ROUTE_SIZES = ['small', 'medium', 'large'] as const;
+const OPEN_VIEW_ROUTE_STATE_TOKEN_ALPHABET = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ';
+const OPEN_VIEW_ROUTE_STATE_TOKEN_LENGTH = 8;
+
+export type OpenViewRouteMode = (typeof OPEN_VIEW_ROUTE_MODES)[number];
+export type OpenViewRouteSize = (typeof OPEN_VIEW_ROUTE_SIZES)[number];
+
+export type OpenViewRouteState = {
+  mode?: OpenViewRouteMode;
+  size?: OpenViewRouteSize;
+};
+
+export const RUNJS_OPEN_VIEW_ROUTE_STATE = Symbol.for('nocobase.runjs.openViewRouteState');
+
+function isOpenViewRouteMode(value: unknown): value is OpenViewRouteMode {
+  return typeof value === 'string' && (OPEN_VIEW_ROUTE_MODES as readonly string[]).includes(value);
+}
+
+function isOpenViewRouteSize(value: unknown): value is OpenViewRouteSize {
+  return typeof value === 'string' && (OPEN_VIEW_ROUTE_SIZES as readonly string[]).includes(value);
+}
+
+export function createOpenViewRouteState(input?: { mode?: unknown; size?: unknown }): OpenViewRouteState | undefined {
+  const state: OpenViewRouteState = {};
+
+  if (isOpenViewRouteMode(input?.mode)) {
+    state.mode = input.mode;
+  }
+  if (isOpenViewRouteSize(input?.size)) {
+    state.size = input.size;
+  }
+
+  return state.mode || state.size ? state : undefined;
+}
+
+function hashString(value: string) {
+  let hash = 2166136261;
+  for (let i = 0; i < value.length; i++) {
+    hash ^= value.charCodeAt(i);
+    hash = Math.imul(hash, 16777619);
+  }
+  return hash >>> 0;
+}
+
+function stateToCode(state: OpenViewRouteState) {
+  const modeIndex = state.mode ? OPEN_VIEW_ROUTE_MODES.indexOf(state.mode) + 1 : 0;
+  const sizeIndex = state.size ? OPEN_VIEW_ROUTE_SIZES.indexOf(state.size) + 1 : 0;
+  const code = modeIndex * 4 + sizeIndex;
+  return code > 0 ? code : undefined;
+}
+
+function codeToState(code: number): OpenViewRouteState | undefined {
+  const modeIndex = Math.floor(code / 4);
+  const sizeIndex = code % 4;
+  return createOpenViewRouteState({
+    mode: modeIndex ? OPEN_VIEW_ROUTE_MODES[modeIndex - 1] : undefined,
+    size: sizeIndex ? OPEN_VIEW_ROUTE_SIZES[sizeIndex - 1] : undefined,
+  });
+}
+
+function tokenForCode(viewUid: string, code: number) {
+  let seed = hashString(`${viewUid}:${code}`);
+  let token = '';
+  for (let i = 0; i < OPEN_VIEW_ROUTE_STATE_TOKEN_LENGTH; i++) {
+    seed = Math.imul(seed ^ (code + i * 17), 16777619) >>> 0;
+    token += OPEN_VIEW_ROUTE_STATE_TOKEN_ALPHABET[seed % OPEN_VIEW_ROUTE_STATE_TOKEN_ALPHABET.length];
+  }
+  return token;
+}
+
+export function isOpenViewRouteStateToken(value: unknown): value is string {
+  return (
+    typeof value === 'string' &&
+    value.length === OPEN_VIEW_ROUTE_STATE_TOKEN_LENGTH &&
+    [...value].every((char) => OPEN_VIEW_ROUTE_STATE_TOKEN_ALPHABET.includes(char))
+  );
+}
+
+export function encodeOpenViewRouteState(viewUid: string, input?: { mode?: unknown; size?: unknown }) {
+  const state = createOpenViewRouteState(input);
+  const code = state ? stateToCode(state) : undefined;
+  return code ? tokenForCode(viewUid, code) : undefined;
+}
+
+export function decodeOpenViewRouteState(viewUid: string, token: unknown) {
+  if (!isOpenViewRouteStateToken(token)) {
+    return undefined;
+  }
+
+  for (let code = 1; code < 16; code++) {
+    if (tokenForCode(viewUid, code) === token) {
+      return codeToState(code);
+    }
+  }
+
+  return undefined;
+}

package/src/utils/parsePathnameToViewParams.ts

@@ -7,6 +7,8 @@
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
 
+import { decodeOpenViewRouteState, type OpenViewRouteState } from './openViewRouteState';
+
 export interface ViewParam {
   /** 视图唯一标识符，一般为某个 Model 实例的 uid */
   viewUid: string;
@@ -16,6 +18,8 @@ export interface ViewParam {
   filterByTk?: string | Record<string, string | number>;
   /** source Id */
   sourceId?: string;
+  /** RunJS ctx.openView runtime display overrides decoded from URL. */
+  openViewRouteState?: OpenViewRouteState;
 }
 
 export interface ParsePathnameToViewParamsOptions {
@@ -109,7 +113,25 @@ export const parsePathnameToViewParams = (
       }
     }
     // 处理参数
-    else if (currentView && i + 1 < segments.length) {
+    else if (currentView) {
+      if (segment === 'opts') {
+        if (i + 1 < segments.length) {
+          const routeState = decodeOpenViewRouteState(currentView.viewUid, segments[i + 1]);
+          if (routeState) {
+            currentView.openViewRouteState = routeState;
+          }
+          i += 2;
+        } else {
+          i++;
+        }
+        continue;
+      }
+
+      if (i + 1 >= segments.length) {
+        i++;
+        continue;
+      }
+
       const rawValue = segments[i + 1];
       // 尝试对路径段进行解码
       let decoded: string = rawValue;

package/src/utils/resolveRunJSObjectValues.ts

@@ -8,7 +8,6 @@
  */
 
 import { isRunJSValue, normalizeRunJSValue } from './runjsValue';
-import { runjsWithSafeGlobals } from './safeGlobals';
 
 /**
  * Resolve an object's values, executing any RunJSValue entries via ctx.runjs.
@@ -29,7 +28,11 @@ export async function resolveRunJSObjectValues(ctx: unknown, raw: unknown): Prom
     if (isRunJSValue(value)) {
       const { code, version } = normalizeRunJSValue(value);
       if (!code.trim()) continue;
-      const ret = await runjsWithSafeGlobals(ctx, code, { version });
+      const runjsCtx = ctx as
+        | { runjs?: (code: string, variables?: Record<string, any>, options?: Record<string, any>) => Promise<any> }
+        | undefined
+        | null;
+      const ret = await runjsCtx?.runjs?.(code, undefined, { version });
       if (!ret?.success) {
         throw new Error(`RunJS execution failed for "${key}"`);
       }

package/src/utils/runjsModuleLoader.ts

@@ -9,7 +9,6 @@
 
 import { setRunJSLibOverride } from '../runjsLibs';
 import { resolveModuleUrl } from './resolveModuleUrl';
-import { registerRunJSSafeDocumentGlobals, registerRunJSSafeWindowGlobals } from './safeGlobals';
 
 /**
  * RunJS 外部模块加载辅助（浏览器侧）。
@@ -38,26 +37,6 @@ type ParsedPackageSpecifier = {
   subpath?: string;
 };
 
-function snapshotOwnKeys(obj: any): string[] {
-  try {
-    if (!obj || (typeof obj !== 'object' && typeof obj !== 'function')) return [];
-    return Object.getOwnPropertyNames(obj);
-  } catch (_) {
-    return [];
-  }
-}
-
-function diffAddedKeys(afterKeys: string[], beforeKeys: string[]): string[] {
-  if (!afterKeys.length) return [];
-  if (!beforeKeys.length) return [...afterKeys];
-  const beforeSet = new Set(beforeKeys);
-  const added: string[] = [];
-  for (const k of afterKeys) {
-    if (!beforeSet.has(k)) added.push(k);
-  }
-  return added;
-}
-
 /**
  * 使用全局 Promise 链实现“互斥锁”：
  * - 锁存放在 `globalThis.__nocobaseRunjsModuleLoadLock`；
@@ -298,9 +277,6 @@ async function prefetchEsmModule(url: string, options?: { timeoutMs?: number }):
  */
 export async function runjsRequireAsync(requirejs: RequireJsLike, url: string): Promise<any> {
   return await withRunjsModuleLoadLock(async () => {
-    const beforeWinKeys = typeof window !== 'undefined' ? snapshotOwnKeys(window) : [];
-    const beforeDocKeys = typeof document !== 'undefined' ? snapshotOwnKeys(document) : [];
-
     let result: any;
     let error: any;
     try {
@@ -319,14 +295,6 @@ export async function runjsRequireAsync(requirejs: RequireJsLike, url: string):
       });
     } catch (e) {
       error = e;
-    } finally {
-      const afterWinKeys = typeof window !== 'undefined' ? snapshotOwnKeys(window) : [];
-      const afterDocKeys = typeof document !== 'undefined' ? snapshotOwnKeys(document) : [];
-      const addedWinKeys = diffAddedKeys(afterWinKeys, beforeWinKeys);
-      const addedDocKeys = diffAddedKeys(afterDocKeys, beforeDocKeys);
-      // Best-effort: allow RunJS safe window/document to access globals introduced by this module load.
-      registerRunJSSafeWindowGlobals(addedWinKeys);
-      registerRunJSSafeDocumentGlobals(addedDocKeys);
     }
 
     if (error) throw error;

package/src/views/ViewNavigation.ts

@@ -9,7 +9,7 @@
 
 import { FlowEngineContext } from '../flowContext';
 import { define, observable } from '../reactive';
-import { ViewParam as SharedViewParam } from '../utils';
+import { encodeOpenViewRouteState, ViewParam as SharedViewParam } from '../utils';
 
 type ViewParams = Omit<SharedViewParam, 'viewUid'> & { viewUid?: string };
 
@@ -79,6 +79,11 @@ export function generatePathnameFromViewParams(
     // 添加视图 UID
     segments.push(viewParam.viewUid);
 
+    const openViewRouteStateToken = encodeOpenViewRouteState(viewParam.viewUid, viewParam.openViewRouteState);
+    if (openViewRouteStateToken) {
+      segments.push('opts', openViewRouteStateToken);
+    }
+
     // 添加参数
     if (viewParam.tabUid) {
       segments.push('tab', viewParam.tabUid);

package/src/views/__tests__/ViewNavigation.test.ts

@@ -7,6 +7,7 @@
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
 
+import { encodeOpenViewRouteState } from '../../utils/openViewRouteState';
 import { ViewNavigation, generatePathnameFromViewParams } from '../ViewNavigation';
 
 describe('ViewNavigation', () => {
@@ -220,6 +221,20 @@ describe('generatePathnameFromViewParams', () => {
     expect(generatePathnameFromViewParams([{ viewUid: 'xxx' }, { viewUid: 'yyy' }])).toBe('/admin/xxx/view/yyy');
   });
 
+  it('should generate RunJS openView route state params after the matching view uid', () => {
+    const token = encodeOpenViewRouteState('yyy', { mode: 'dialog', size: 'large' });
+    if (!token) {
+      throw new Error('Expected openView route state token.');
+    }
+    const pathname = generatePathnameFromViewParams([
+      { viewUid: 'xxx' },
+      { viewUid: 'yyy', openViewRouteState: { mode: 'dialog', size: 'large' }, filterByTk: '1' },
+    ]);
+
+    expect(token).toMatch(/^[A-Za-z]{8}$/);
+    expect(pathname).toBe(`/admin/xxx/view/yyy/opts/${token}/filterbytk/1`);
+  });
+
   it('should generate complex path with all parameters', () => {
     expect(
       generatePathnameFromViewParams([

package/lib/utils/safeGlobals.d.ts

@@ -1,28 +0,0 @@
-/**
- * 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 declare function registerRunJSSafeWindowGlobals(keys: Iterable<string> | null | undefined): void;
-export declare function registerRunJSSafeDocumentGlobals(keys: Iterable<string> | null | undefined): void;
-export declare function __resetRunJSSafeGlobalsRegistryForTests(): void;
-export declare function createSafeWindow(extra?: Record<string, any>): Record<string, any>;
-export declare function createSafeDocument(extra?: Record<string, any>): Record<string, any>;
-export declare function createSafeNavigator(extra?: Record<string, any>): {};
-/**
- * Create a safe globals object for RunJS execution.
- *
- * - Always tries to provide `navigator`
- * - Best-effort provides `window` and `document` in browser environments
- * - Never throws (so callers can decide how to handle missing globals)
- */
-export declare function createSafeRunJSGlobals(extraGlobals?: Record<string, any>): Record<string, any>;
-/**
- * Execute RunJS with safe globals (window/document/navigator).
- *
- * Keeps `this` binding by calling `ctx.runjs(...)` instead of passing bare function references.
- */
-export declare function runjsWithSafeGlobals(ctx: unknown, code: string, options?: any, extraGlobals?: Record<string, any>): Promise<any>;