@nocobase/flow-engine 2.1.0-alpha.40 → 2.1.0-alpha.46

package/lib/runjs-context/contexts/elementDoc.js

@@ -0,0 +1,152 @@
+/**
+ * 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 __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+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 elementDoc_exports = {};
+__export(elementDoc_exports, {
+  createElementPropertyDoc: () => createElementPropertyDoc,
+  createZhCNElementPropertyDoc: () => createZhCNElementPropertyDoc
+});
+module.exports = __toCommonJS(elementDoc_exports);
+const elementProperties = {
+  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 = {
+  innerHTML: "\u5DF2\u6D88\u6BD2\u7684 innerHTML \u5B57\u7B26\u4E32\u3002",
+  outerHTML: "\u5DF2\u6D88\u6BD2\u7684 outerHTML \u5B57\u7B26\u4E32\u3002",
+  textContent: "\u6587\u672C\u5185\u5BB9\u3002",
+  style: "\u5185\u8054\u6837\u5F0F\u58F0\u660E\u3002",
+  classList: "CSS class \u5217\u8868\u3002",
+  appendChild: {
+    type: "function",
+    description: "\u8FFD\u52A0 DOM \u8282\u70B9\u6216\u6587\u672C\u3002",
+    detail: "(child: Node | string) => void",
+    completion: { insertText: `ctx.element.appendChild('text')` }
+  },
+  setAttribute: {
+    type: "function",
+    description: "\u8BBE\u7F6E HTML \u5C5E\u6027\u3002",
+    detail: "(name: string, value: string) => void",
+    completion: { insertText: `ctx.element.setAttribute('data-key', 'value')` }
+  },
+  getAttribute: {
+    type: "function",
+    description: "\u8BFB\u53D6 HTML \u5C5E\u6027\u3002",
+    detail: "(name: string) => string | null",
+    completion: { insertText: `ctx.element.getAttribute('data-key')` }
+  },
+  querySelector: {
+    type: "function",
+    description: "\u67E5\u8BE2\u7B2C\u4E00\u4E2A\u5339\u914D\u7684\u540E\u4EE3\u5143\u7D20\u3002",
+    detail: "(selectors: string) => Element | null",
+    completion: { insertText: `ctx.element.querySelector('.selector')` }
+  },
+  querySelectorAll: {
+    type: "function",
+    description: "\u67E5\u8BE2\u6240\u6709\u5339\u914D\u7684\u540E\u4EE3\u5143\u7D20\u3002",
+    detail: "(selectors: string) => NodeListOf<Element>",
+    completion: { insertText: `ctx.element.querySelectorAll('.selector')` }
+  },
+  addEventListener: {
+    type: "function",
+    description: "\u7ED9\u5143\u7D20\u6DFB\u52A0\u4E8B\u4EF6\u76D1\u542C\u3002",
+    detail: "(type: string, listener: EventListener) => void",
+    completion: { insertText: `ctx.element.addEventListener('click', (event) => {})` }
+  },
+  removeEventListener: {
+    type: "function",
+    description: "\u79FB\u9664\u5143\u7D20\u4E8B\u4EF6\u76D1\u542C\u3002",
+    detail: "(type: string, listener: EventListener) => void",
+    completion: { insertText: `ctx.element.removeEventListener('click', handler)` }
+  }
+};
+function createElementPropertyDoc(description = "Current DOM container for this RunJS context. Usually an ElementProxy.") {
+  return {
+    description,
+    detail: "HTMLElement | ElementProxy",
+    properties: elementProperties
+  };
+}
+__name(createElementPropertyDoc, "createElementPropertyDoc");
+function createZhCNElementPropertyDoc(description = "\u5F53\u524D RunJS \u4E0A\u4E0B\u6587\u7684 DOM \u5BB9\u5668\uFF0C\u901A\u5E38\u4E3A ElementProxy\u3002") {
+  return {
+    description,
+    detail: "HTMLElement | ElementProxy",
+    properties: zhCNElementProperties
+  };
+}
+__name(createZhCNElementPropertyDoc, "createZhCNElementPropertyDoc");
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createElementPropertyDoc,
+  createZhCNElementPropertyDoc
+});

package/lib/utils/loadedPageCache.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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;
+};
+export declare const createLoadedPageCache: () => {
+    getDirtyKeyForModel(model?: FlowModel | null, options?: DirtyKeyOptions): string | undefined;
+    markDirty(key?: string): void;
+    shouldBypass(options?: LoadedPageOptions, isFlowSettingsEnabled?: () => boolean): boolean;
+    clear(options?: LoadedPageOptions): void;
+    mountModelToParent: <T extends FlowModel<import("..").DefaultStructure> = FlowModel<import("..").DefaultStructure>>(model: T, forceReplace?: boolean) => T;
+};
+export {};

package/lib/utils/loadedPageCache.js

@@ -0,0 +1,139 @@
+/**
+ * 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 __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+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 loadedPageCache_exports = {};
+__export(loadedPageCache_exports, {
+  createLoadedPageCache: () => createLoadedPageCache
+});
+module.exports = __toCommonJS(loadedPageCache_exports);
+const getLoadedPageKey = /* @__PURE__ */ __name((options) => {
+  const parentId = options == null ? void 0 : options.parentId;
+  const subKey = options == null ? void 0 : options.subKey;
+  if (!parentId || subKey !== "page") {
+    return void 0;
+  }
+  return `${parentId}::${subKey}`;
+}, "getLoadedPageKey");
+const getLoadedPageKeyFromModel = /* @__PURE__ */ __name((model) => {
+  var _a;
+  let current = model;
+  while (current) {
+    if (current.subKey === "page" && ((_a = current.parent) == null ? void 0 : _a.uid)) {
+      return getLoadedPageKey({ parentId: current.parent.uid, subKey: current.subKey });
+    }
+    current = current.parent;
+  }
+  return void 0;
+}, "getLoadedPageKeyFromModel");
+const isFlowSettingsEnabledForContext = /* @__PURE__ */ __name((context) => {
+  try {
+    return !!(context == null ? void 0 : context.flowSettingsEnabled);
+  } catch (error) {
+    return false;
+  }
+}, "isFlowSettingsEnabledForContext");
+const isFlowSettingsEnabledForModel = /* @__PURE__ */ __name((model) => {
+  if (isFlowSettingsEnabledForContext(model == null ? void 0 : model.context)) {
+    return true;
+  }
+  const visited = /* @__PURE__ */ new Set();
+  let engine = model == null ? void 0 : model.flowEngine;
+  while (engine && !visited.has(engine)) {
+    visited.add(engine);
+    if (isFlowSettingsEnabledForContext(engine.context)) {
+      return true;
+    }
+    engine = engine.previousEngine;
+  }
+  return false;
+}, "isFlowSettingsEnabledForModel");
+const removeLoadedModelTree = /* @__PURE__ */ __name((model) => {
+  if (!(model == null ? void 0 : model.uid) || !model.flowEngine) {
+    return;
+  }
+  if (model.flowEngine.getModel(model.uid) === model) {
+    model.flowEngine.removeModelWithSubModels(model.uid);
+  }
+}, "removeLoadedModelTree");
+const mountLoadedModelToParent = /* @__PURE__ */ __name((model, forceReplace = false) => {
+  var _a;
+  if (!(model == null ? void 0 : model.parent) || !model.subKey) {
+    return model;
+  }
+  const mounted = (_a = model.parent.subModels) == null ? void 0 : _a[model.subKey];
+  const existing = forceReplace && model.subType !== "array" && mounted && !Array.isArray(mounted) ? mounted : 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;
+}, "mountLoadedModelToParent");
+const createLoadedPageCache = /* @__PURE__ */ __name(() => {
+  const dirtyKeys = /* @__PURE__ */ new Set();
+  return {
+    getDirtyKeyForModel(model, options) {
+      if (!(options == null ? void 0 : options.force) && !isFlowSettingsEnabledForModel(model)) {
+        return void 0;
+      }
+      return getLoadedPageKeyFromModel(model);
+    },
+    markDirty(key) {
+      if (key) {
+        dirtyKeys.add(key);
+      }
+    },
+    shouldBypass(options, isFlowSettingsEnabled) {
+      const key = getLoadedPageKey(options);
+      if (!key || !dirtyKeys.has(key)) {
+        return false;
+      }
+      try {
+        return !(isFlowSettingsEnabled == null ? void 0 : isFlowSettingsEnabled());
+      } catch (error) {
+        return true;
+      }
+    },
+    clear(options) {
+      const key = getLoadedPageKey(options);
+      if (key) {
+        dirtyKeys.delete(key);
+      }
+    },
+    mountModelToParent: mountLoadedModelToParent
+  };
+}, "createLoadedPageCache");
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createLoadedPageCache
+});

package/lib/utils/parsePathnameToViewParams.d.ts

@@ -16,6 +16,10 @@ export interface ViewParam {
     /** source Id */
     sourceId?: string;
 }
+export interface ParsePathnameToViewParamsOptions {
+    rootPrefix?: string;
+    basePath?: string;
+}
 /**
  * 解析路径名为视图参数数组
  *
@@ -31,4 +35,4 @@ export interface ViewParam {
  * parsePathnameToViewParams('/admin/xxx/view/yyy') // [{ viewUid: 'xxx' }, { viewUid: 'yyy' }]
  * ```
  */
-export declare const parsePathnameToViewParams: (pathname: string) => ViewParam[];
+export declare const parsePathnameToViewParams: (pathname: string, options?: ParsePathnameToViewParamsOptions) => ViewParam[];

package/lib/utils/parsePathnameToViewParams.js

@@ -30,20 +30,44 @@ __export(parsePathnameToViewParams_exports, {
   parsePathnameToViewParams: () => parsePathnameToViewParams
 });
 module.exports = __toCommonJS(parsePathnameToViewParams_exports);
-const parsePathnameToViewParams = /* @__PURE__ */ __name((pathname) => {
+const normalizePathname = /* @__PURE__ */ __name((pathname) => {
+  if (!pathname || pathname === "/") {
+    return "/";
+  }
+  return `/${pathname.replace(/^\/+/, "").replace(/\/+$/, "")}`;
+}, "normalizePathname");
+const normalizeBasePath = /* @__PURE__ */ __name((basePath) => `/${basePath.replace(/^\/+/, "").replace(/\/+$/, "")}`, "normalizeBasePath");
+const stripBasePath = /* @__PURE__ */ __name((pathname, basePath) => {
+  const normalizedPathname = normalizePathname(pathname);
+  const normalizedBasePath = normalizeBasePath(basePath);
+  if (normalizedPathname === normalizedBasePath) {
+    return "";
+  }
+  if (normalizedPathname.startsWith(`${normalizedBasePath}/`)) {
+    return normalizedPathname.slice(normalizedBasePath.length + 1);
+  }
+  return "";
+}, "stripBasePath");
+const parsePathnameToViewParams = /* @__PURE__ */ __name((pathname, options = {}) => {
   if (!pathname || pathname === "/") {
     return [];
   }
-  const segments = pathname.replace(/^\/+/, "").split("/").filter(Boolean);
-  if (segments.length < 2) {
+  const rootPrefix = options.rootPrefix || "admin";
+  const relativePath = options.basePath ? stripBasePath(pathname, options.basePath) : "";
+  const segments = (options.basePath ? relativePath : pathname).replace(/^\/+/, "").split("/").filter(Boolean);
+  if (segments.length < (options.basePath ? 1 : 2)) {
     return [];
   }
   const result = [];
   let currentView = null;
   let i = 0;
+  if (options.basePath) {
+    currentView = { viewUid: segments[0] };
+    i = 1;
+  }
   while (i < segments.length) {
     const segment = segments[i];
-    if (segment === "admin" || segment === "view") {
+    if (segment === rootPrefix || segment === "view") {
       if (currentView) {
         result.push(currentView);
       }

package/lib/views/ViewNavigation.d.ts

@@ -11,6 +11,14 @@ import { ViewParam as SharedViewParam } from '../utils';
 type ViewParams = Omit<SharedViewParam, 'viewUid'> & {
     viewUid?: string;
 };
+export interface GeneratePathnameFromViewParamsOptions {
+    prefix?: string;
+    basePath?: string;
+}
+export interface ViewNavigationOptions {
+    basePath?: string;
+    layoutBasePath?: string;
+}
 /**
  * 将 ViewParam 数组转换为 pathname
  *
@@ -24,12 +32,13 @@ type ViewParams = Omit<SharedViewParam, 'viewUid'> & {
  * generatePathnameFromViewParams([{ viewUid: 'xxx' }, { viewUid: 'yyy' }]) // '/admin/xxx/view/yyy'
  * ```
  */
-export declare function generatePathnameFromViewParams(viewParams: ViewParams[]): string;
+export declare function generatePathnameFromViewParams(viewParams: ViewParams[], options?: GeneratePathnameFromViewParamsOptions): string;
 export declare class ViewNavigation {
     viewStack: ReadonlyArray<ViewParams>;
     ctx: FlowEngineContext;
     viewParams: ViewParams;
-    constructor(ctx: FlowEngineContext, viewParams: ViewParams[]);
+    private readonly basePath?;
+    constructor(ctx: FlowEngineContext, viewParams: ViewParams[], options?: ViewNavigationOptions);
     setViewStack(viewParams: ViewParams[]): void;
     changeTo(viewParam: ViewParams): void;
     navigateTo(viewParam: ViewParams, opts?: {
@@ -37,5 +46,6 @@ export declare class ViewNavigation {
         state?: any;
     }): void;
     back(): void;
+    private getLayoutBasePath;
 }
 export {};

package/lib/views/ViewNavigation.js

@@ -47,11 +47,17 @@ function hasUsableSourceId(sourceId) {
   return sourceId !== void 0 && sourceId !== null && String(sourceId) !== "";
 }
 __name(hasUsableSourceId, "hasUsableSourceId");
-function generatePathnameFromViewParams(viewParams) {
+function normalizeBasePath(basePath) {
+  const value = basePath || "/admin";
+  return `/${value.replace(/^\/+/, "").replace(/\/+$/, "")}`;
+}
+__name(normalizeBasePath, "normalizeBasePath");
+function generatePathnameFromViewParams(viewParams, options = {}) {
+  const basePath = normalizeBasePath(options.basePath || options.prefix);
   if (!viewParams || viewParams.length === 0) {
-    return "/admin";
+    return basePath;
   }
-  const segments = ["admin"];
+  const segments = basePath.replace(/^\/+/, "").split("/").filter(Boolean);
   viewParams.forEach((viewParam, index) => {
     if (index > 0) {
       segments.push("view");
@@ -78,9 +84,11 @@ const _ViewNavigation = class _ViewNavigation {
   // 只能通过 setViewStack 修改
   ctx;
   viewParams;
-  constructor(ctx, viewParams) {
+  basePath;
+  constructor(ctx, viewParams, options = {}) {
     this.setViewStack(viewParams);
     this.ctx = ctx;
+    this.basePath = options.basePath || options.layoutBasePath;
     (0, import_reactive.define)(this, {
       viewParams: import_reactive.observable
     });
@@ -96,19 +104,26 @@ const _ViewNavigation = class _ViewNavigation {
       }
       return { ...item };
     });
-    const newPathname = generatePathnameFromViewParams(newViewStack);
+    const newPathname = generatePathnameFromViewParams(newViewStack, { basePath: this.getLayoutBasePath() });
     this.ctx.router.navigate(newPathname, { replace: true });
   }
   navigateTo(viewParam, opts) {
-    const newViewPathname = generatePathnameFromViewParams([...this.viewStack, viewParam]);
+    const newViewPathname = generatePathnameFromViewParams([...this.viewStack, viewParam], {
+      basePath: this.getLayoutBasePath()
+    });
     const newPathname = newViewPathname;
     this.ctx.router.navigate(newPathname, opts);
   }
   back() {
     const prevStack = this.viewStack.slice(0, -1);
-    const prevPath = generatePathnameFromViewParams(prevStack);
+    const prevPath = generatePathnameFromViewParams(prevStack, { basePath: this.getLayoutBasePath() });
     this.ctx.router.navigate(prevPath, { replace: true });
   }
+  getLayoutBasePath() {
+    var _a, _b;
+    const routePath = (_a = this.ctx.layout) == null ? void 0 : _a.routePath;
+    return this.basePath || ((_b = this.ctx.layoutRoute) == null ? void 0 : _b.basePathname) || ((routePath == null ? void 0 : routePath.startsWith("/")) ? routePath : "/admin");
+  }
 };
 __name(_ViewNavigation, "ViewNavigation");
 let ViewNavigation = _ViewNavigation;