@nocobase/flow-engine 2.1.0-beta.41 → 2.1.0-beta.43

package/src/runjs-context/contexts/elementDoc.ts

@@ -0,0 +1,130 @@
+/**
+ * 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 { RunJSDocPropertyDoc } from '../../flowContext';
+
+const elementProperties: Record<string, RunJSDocPropertyDoc> = {
+  innerHTML: 'Sanitized inner HTML string.',
+  outerHTML: 'Sanitized outer HTML string.',
+  textContent: 'Text content.',
+  style: 'Inline style declaration.',
+  classList: 'DOMTokenList for CSS classes.',
+  appendChild: {
+    type: 'function',
+    description: 'Append a DOM node or text.',
+    detail: '(child: Node | string) => void',
+    completion: { insertText: `ctx.element.appendChild('text')` },
+  },
+  setAttribute: {
+    type: 'function',
+    description: 'Set an HTML attribute.',
+    detail: '(name: string, value: string) => void',
+    completion: { insertText: `ctx.element.setAttribute('data-key', 'value')` },
+  },
+  getAttribute: {
+    type: 'function',
+    description: 'Read an HTML attribute.',
+    detail: '(name: string) => string | null',
+    completion: { insertText: `ctx.element.getAttribute('data-key')` },
+  },
+  querySelector: {
+    type: 'function',
+    description: 'Find the first matching descendant.',
+    detail: '(selectors: string) => Element | null',
+    completion: { insertText: `ctx.element.querySelector('.selector')` },
+  },
+  querySelectorAll: {
+    type: 'function',
+    description: 'Find all matching descendants.',
+    detail: '(selectors: string) => NodeListOf<Element>',
+    completion: { insertText: `ctx.element.querySelectorAll('.selector')` },
+  },
+  addEventListener: {
+    type: 'function',
+    description: 'Attach an event listener to the element.',
+    detail: '(type: string, listener: EventListener) => void',
+    completion: { insertText: `ctx.element.addEventListener('click', (event) => {})` },
+  },
+  removeEventListener: {
+    type: 'function',
+    description: 'Remove an event listener from the element.',
+    detail: '(type: string, listener: EventListener) => void',
+    completion: { insertText: `ctx.element.removeEventListener('click', handler)` },
+  },
+};
+
+const zhCNElementProperties: Record<string, RunJSDocPropertyDoc> = {
+  innerHTML: '已消毒的 innerHTML 字符串。',
+  outerHTML: '已消毒的 outerHTML 字符串。',
+  textContent: '文本内容。',
+  style: '内联样式声明。',
+  classList: 'CSS class 列表。',
+  appendChild: {
+    type: 'function',
+    description: '追加 DOM 节点或文本。',
+    detail: '(child: Node | string) => void',
+    completion: { insertText: `ctx.element.appendChild('text')` },
+  },
+  setAttribute: {
+    type: 'function',
+    description: '设置 HTML 属性。',
+    detail: '(name: string, value: string) => void',
+    completion: { insertText: `ctx.element.setAttribute('data-key', 'value')` },
+  },
+  getAttribute: {
+    type: 'function',
+    description: '读取 HTML 属性。',
+    detail: '(name: string) => string | null',
+    completion: { insertText: `ctx.element.getAttribute('data-key')` },
+  },
+  querySelector: {
+    type: 'function',
+    description: '查询第一个匹配的后代元素。',
+    detail: '(selectors: string) => Element | null',
+    completion: { insertText: `ctx.element.querySelector('.selector')` },
+  },
+  querySelectorAll: {
+    type: 'function',
+    description: '查询所有匹配的后代元素。',
+    detail: '(selectors: string) => NodeListOf<Element>',
+    completion: { insertText: `ctx.element.querySelectorAll('.selector')` },
+  },
+  addEventListener: {
+    type: 'function',
+    description: '给元素添加事件监听。',
+    detail: '(type: string, listener: EventListener) => void',
+    completion: { insertText: `ctx.element.addEventListener('click', (event) => {})` },
+  },
+  removeEventListener: {
+    type: 'function',
+    description: '移除元素事件监听。',
+    detail: '(type: string, listener: EventListener) => void',
+    completion: { insertText: `ctx.element.removeEventListener('click', handler)` },
+  },
+};
+
+export function createElementPropertyDoc(
+  description = 'Current DOM container for this RunJS context. Usually an ElementProxy.',
+): RunJSDocPropertyDoc {
+  return {
+    description,
+    detail: 'HTMLElement | ElementProxy',
+    properties: elementProperties,
+  };
+}
+
+export function createZhCNElementPropertyDoc(
+  description = '当前 RunJS 上下文的 DOM 容器，通常为 ElementProxy。',
+): RunJSDocPropertyDoc {
+  return {
+    description,
+    detail: 'HTMLElement | ElementProxy',
+    properties: zhCNElementProperties,
+  };
+}

package/src/utils/loadedPageCache.ts

@@ -0,0 +1,147 @@
+/**
+ * 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 { FlowModel } from '../models';
+
+type LoadedPageOptions = {
+  parentId?: string;
+  subKey?: string;
+};
+
+type DirtyKeyOptions = {
+  force?: boolean;
+};
+
+type FlowSettingsContextLike = {
+  flowSettingsEnabled?: boolean;
+};
+
+type FlowEngineLike = {
+  context?: FlowSettingsContextLike;
+  previousEngine?: FlowEngineLike;
+};
+
+const getLoadedPageKey = (options?: LoadedPageOptions): string | undefined => {
+  const parentId = options?.parentId;
+  const subKey = options?.subKey;
+  if (!parentId || subKey !== 'page') {
+    return undefined;
+  }
+  return `${parentId}::${subKey}`;
+};
+
+const getLoadedPageKeyFromModel = (model?: FlowModel | null): string | undefined => {
+  let current = model;
+  while (current) {
+    if (current.subKey === 'page' && current.parent?.uid) {
+      return getLoadedPageKey({ parentId: current.parent.uid, subKey: current.subKey });
+    }
+    current = current.parent as FlowModel | undefined;
+  }
+  return undefined;
+};
+
+const isFlowSettingsEnabledForContext = (context?: FlowSettingsContextLike): boolean => {
+  try {
+    return !!context?.flowSettingsEnabled;
+  } catch (error) {
+    return false;
+  }
+};
+
+const isFlowSettingsEnabledForModel = (model?: FlowModel | null): boolean => {
+  if (isFlowSettingsEnabledForContext(model?.context as FlowSettingsContextLike | undefined)) {
+    return true;
+  }
+
+  const visited = new Set<FlowEngineLike>();
+  let engine = model?.flowEngine as FlowEngineLike | undefined;
+  while (engine && !visited.has(engine)) {
+    visited.add(engine);
+    if (isFlowSettingsEnabledForContext(engine.context)) {
+      return true;
+    }
+    engine = engine.previousEngine;
+  }
+  return false;
+};
+
+const removeLoadedModelTree = (model?: FlowModel | null): void => {
+  if (!model?.uid || !model.flowEngine) {
+    return;
+  }
+  if (model.flowEngine.getModel(model.uid) === model) {
+    model.flowEngine.removeModelWithSubModels(model.uid);
+  }
+};
+
+const mountLoadedModelToParent = <T extends FlowModel = FlowModel>(model: T | null, forceReplace = false): T | null => {
+  if (!model?.parent || !model.subKey) {
+    return model;
+  }
+
+  const mounted = (model.parent.subModels as any)?.[model.subKey];
+  const existing =
+    forceReplace && model.subType !== 'array' && mounted && !Array.isArray(mounted)
+      ? (mounted as FlowModel)
+      : model.parent.findSubModel(model.subKey, (m) => m.uid === model.uid);
+  if (existing) {
+    if (!forceReplace || existing === model) {
+      return model;
+    }
+    removeLoadedModelTree(existing);
+  }
+
+  if (model.subType === 'array') {
+    model.parent.addSubModel(model.subKey, model);
+  } else {
+    model.parent.setSubModel(model.subKey, model);
+  }
+  return model;
+};
+
+export const createLoadedPageCache = () => {
+  const dirtyKeys = new Set<string>();
+
+  return {
+    getDirtyKeyForModel(model?: FlowModel | null, options?: DirtyKeyOptions): string | undefined {
+      if (!options?.force && !isFlowSettingsEnabledForModel(model)) {
+        return undefined;
+      }
+      return getLoadedPageKeyFromModel(model);
+    },
+
+    markDirty(key?: string): void {
+      if (key) {
+        dirtyKeys.add(key);
+      }
+    },
+
+    shouldBypass(options?: LoadedPageOptions, isFlowSettingsEnabled?: () => boolean): boolean {
+      const key = getLoadedPageKey(options);
+      if (!key || !dirtyKeys.has(key)) {
+        return false;
+      }
+      try {
+        return !isFlowSettingsEnabled?.();
+      } catch (error) {
+        return true;
+      }
+    },
+
+    clear(options?: LoadedPageOptions): void {
+      const key = getLoadedPageKey(options);
+      if (key) {
+        dirtyKeys.delete(key);
+      }
+    },
+
+    mountModelToParent: mountLoadedModelToParent,
+  };
+};