@tmagic/utils 1.5.0-beta.8 → 1.5.0

package/dist/tmagic-utils.js

@@ -115,6 +115,8 @@ const getIdFromEl = () => dslDomRelateConfig.getIdFromEl;
 const getElById = () => dslDomRelateConfig.getElById;
 const setIdToEl = () => dslDomRelateConfig.setIdToEl;
 
+let _globalThis;
+const getGlobalThis = () => _globalThis || (_globalThis = typeof globalThis !== "undefined" ? globalThis : typeof self !== "undefined" ? self : typeof window !== "undefined" ? window : typeof global !== "undefined" ? global : {});
 const sleep = (ms) => new Promise((resolve) => {
   const timer = setTimeout(() => {
     clearTimeout(timer);
@@ -122,7 +124,7 @@ const sleep = (ms) => new Promise((resolve) => {
   }, ms);
 });
 const toLine = (name = "") => name.replace(/\B([A-Z])/g, "-$1").toLowerCase();
-const toHump = (name = "") => name.replace(/-(\w)/g, (all, letter) => letter.toUpperCase());
+const toHump = (name = "") => name.replace(/-(\w)/g, (_all, letter) => letter.toUpperCase());
 const emptyFn = () => void 0;
 const getNodePath = (id, data = []) => {
   const path = [];
@@ -149,6 +151,30 @@ const getNodePath = (id, data = []) => {
   get(id, data);
   return path;
 };
+const getNodeInfo = (id, root) => {
+  const info = {
+    node: null,
+    parent: null,
+    page: null
+  };
+  if (!root) return info;
+  if (id === root.id) {
+    info.node = root;
+    return info;
+  }
+  const path = getNodePath(id, root.items);
+  if (!path.length) return info;
+  path.unshift(root);
+  info.node = path[path.length - 1];
+  info.parent = path[path.length - 2];
+  path.forEach((item) => {
+    if (isPage(item) || isPageFragment(item)) {
+      info.page = item;
+      return;
+    }
+  });
+  return info;
+};
 const filterXSS = (str) => str.replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;").replace(/'/g, "&apos;");
 const getUrlParam = (param, url) => {
   const u = url || location.href;
@@ -384,20 +410,44 @@ const convertToNumber = (value, parentValue = 0) => {
   }
   return parseFloat(value);
 };
-const addParamToUrl = (obj, global = globalThis, needReload = true) => {
-  const url = new URL(global.location.href);
+const addParamToUrl = (obj, global2 = globalThis, needReload = true) => {
+  const url = new URL(global2.location.href);
   const { searchParams } = url;
   for (const [k, v] of Object.entries(obj)) {
     searchParams.set(k, v);
   }
   const newUrl = url.toString();
   if (needReload) {
-    global.location.href = newUrl;
+    global2.location.href = newUrl;
   } else {
-    global.history.pushState({}, "", url);
+    global2.history.pushState({}, "", url);
   }
 };
 const dataSourceTemplateRegExp = /\$\{([\s\S]+?)\}/g;
 const isDslNode = (config) => typeof config[IS_DSL_NODE_KEY] === "undefined" || config[IS_DSL_NODE_KEY] === true;
+const traverseNode = (node, cb, parents = []) => {
+  cb(node, parents);
+  if (Array.isArray(node.items) && node.items.length) {
+    parents.push(node);
+    node.items.forEach((item) => {
+      traverseNode(item, cb, [...parents]);
+    });
+  }
+};
+const isValueIncludeDataSource = (value) => {
+  if (typeof value === "string" && /\$\{([\s\S]+?)\}/.test(value)) {
+    return true;
+  }
+  if (Array.isArray(value) && `${value[0]}`.startsWith(DATA_SOURCE_FIELDS_SELECT_VALUE_PREFIX)) {
+    return true;
+  }
+  if (value?.isBindDataSource && value.dataSourceId) {
+    return true;
+  }
+  if (value?.isBindDataSourceField && value.dataSourceId) {
+    return true;
+  }
+  return false;
+};
 
-export { DATA_SOURCE_FIELDS_CHANGE_EVENT_PREFIX, DATA_SOURCE_FIELDS_SELECT_VALUE_PREFIX, DSL_NODE_KEY_COPY_PREFIX, IS_DSL_NODE_KEY, addClassName, addParamToUrl, asyncLoadCss, asyncLoadJs, calcValueByFontsize, calculatePercentage, compiledCond, compiledNode, convertToNumber, createDiv, dataSourceTemplateRegExp, emptyFn, filterXSS, getDefaultValueFromFields, getDepKeys, getDepNodeIds, getDocument, getElById, getHost, getIdFromEl, getKeys, getKeysArray, getNodePath, getNodes, getUrlParam, getValueByKeyPath, guid, injectStyle, isDslNode, isNumber, isObject, isPage, isPageFragment, isPercentage, isPop, isSameDomain, removeClassName, removeClassNameByClassName, replaceChildNode, setDslDomRelateConfig, setIdToEl, setValueByKeyPath, sleep, toHump, toLine };
+export { DATA_SOURCE_FIELDS_CHANGE_EVENT_PREFIX, DATA_SOURCE_FIELDS_SELECT_VALUE_PREFIX, DSL_NODE_KEY_COPY_PREFIX, IS_DSL_NODE_KEY, addClassName, addParamToUrl, asyncLoadCss, asyncLoadJs, calcValueByFontsize, calculatePercentage, compiledCond, compiledNode, convertToNumber, createDiv, dataSourceTemplateRegExp, emptyFn, filterXSS, getDefaultValueFromFields, getDepKeys, getDepNodeIds, getDocument, getElById, getGlobalThis, getHost, getIdFromEl, getKeys, getKeysArray, getNodeInfo, getNodePath, getNodes, getUrlParam, getValueByKeyPath, guid, injectStyle, isDslNode, isNumber, isObject, isPage, isPageFragment, isPercentage, isPop, isSameDomain, isValueIncludeDataSource, removeClassName, removeClassNameByClassName, replaceChildNode, setDslDomRelateConfig, setIdToEl, setValueByKeyPath, sleep, toHump, toLine, traverseNode };

package/dist/tmagic-utils.umd.cjs

@@ -2724,6 +2724,8 @@
   const getElById = () => dslDomRelateConfig.getElById;
   const setIdToEl = () => dslDomRelateConfig.setIdToEl;
 
+  let _globalThis;
+  const getGlobalThis = () => _globalThis || (_globalThis = typeof globalThis !== "undefined" ? globalThis : typeof self !== "undefined" ? self : typeof window !== "undefined" ? window : typeof global !== "undefined" ? global : {});
   const sleep = (ms) => new Promise((resolve) => {
     const timer = setTimeout(() => {
       clearTimeout(timer);
@@ -2731,7 +2733,7 @@
     }, ms);
   });
   const toLine = (name = "") => name.replace(/\B([A-Z])/g, "-$1").toLowerCase();
-  const toHump = (name = "") => name.replace(/-(\w)/g, (all, letter) => letter.toUpperCase());
+  const toHump = (name = "") => name.replace(/-(\w)/g, (_all, letter) => letter.toUpperCase());
   const emptyFn = () => void 0;
   const getNodePath = (id, data = []) => {
     const path = [];
@@ -2758,6 +2760,30 @@
     get(id, data);
     return path;
   };
+  const getNodeInfo = (id, root) => {
+    const info = {
+      node: null,
+      parent: null,
+      page: null
+    };
+    if (!root) return info;
+    if (id === root.id) {
+      info.node = root;
+      return info;
+    }
+    const path = getNodePath(id, root.items);
+    if (!path.length) return info;
+    path.unshift(root);
+    info.node = path[path.length - 1];
+    info.parent = path[path.length - 2];
+    path.forEach((item) => {
+      if (isPage(item) || isPageFragment(item)) {
+        info.page = item;
+        return;
+      }
+    });
+    return info;
+  };
   const filterXSS = (str) => str.replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;").replace(/'/g, "&apos;");
   const getUrlParam = (param, url) => {
     const u = url || location.href;
@@ -2993,21 +3019,45 @@
     }
     return parseFloat(value);
   };
-  const addParamToUrl = (obj, global = globalThis, needReload = true) => {
-    const url = new URL(global.location.href);
+  const addParamToUrl = (obj, global2 = globalThis, needReload = true) => {
+    const url = new URL(global2.location.href);
     const { searchParams } = url;
     for (const [k, v] of Object.entries(obj)) {
       searchParams.set(k, v);
     }
     const newUrl = url.toString();
     if (needReload) {
-      global.location.href = newUrl;
+      global2.location.href = newUrl;
     } else {
-      global.history.pushState({}, "", url);
+      global2.history.pushState({}, "", url);
     }
   };
   const dataSourceTemplateRegExp = /\$\{([\s\S]+?)\}/g;
   const isDslNode = (config) => typeof config[IS_DSL_NODE_KEY] === "undefined" || config[IS_DSL_NODE_KEY] === true;
+  const traverseNode = (node, cb, parents = []) => {
+    cb(node, parents);
+    if (Array.isArray(node.items) && node.items.length) {
+      parents.push(node);
+      node.items.forEach((item) => {
+        traverseNode(item, cb, [...parents]);
+      });
+    }
+  };
+  const isValueIncludeDataSource = (value) => {
+    if (typeof value === "string" && /\$\{([\s\S]+?)\}/.test(value)) {
+      return true;
+    }
+    if (Array.isArray(value) && `${value[0]}`.startsWith(DATA_SOURCE_FIELDS_SELECT_VALUE_PREFIX)) {
+      return true;
+    }
+    if (value?.isBindDataSource && value.dataSourceId) {
+      return true;
+    }
+    if (value?.isBindDataSourceField && value.dataSourceId) {
+      return true;
+    }
+    return false;
+  };
 
   exports.DATA_SOURCE_FIELDS_CHANGE_EVENT_PREFIX = DATA_SOURCE_FIELDS_CHANGE_EVENT_PREFIX;
   exports.DATA_SOURCE_FIELDS_SELECT_VALUE_PREFIX = DATA_SOURCE_FIELDS_SELECT_VALUE_PREFIX;
@@ -3031,10 +3081,12 @@
   exports.getDepNodeIds = getDepNodeIds;
   exports.getDocument = getDocument;
   exports.getElById = getElById;
+  exports.getGlobalThis = getGlobalThis;
   exports.getHost = getHost;
   exports.getIdFromEl = getIdFromEl;
   exports.getKeys = getKeys;
   exports.getKeysArray = getKeysArray;
+  exports.getNodeInfo = getNodeInfo;
   exports.getNodePath = getNodePath;
   exports.getNodes = getNodes;
   exports.getUrlParam = getUrlParam;
@@ -3049,6 +3101,7 @@
   exports.isPercentage = isPercentage;
   exports.isPop = isPop;
   exports.isSameDomain = isSameDomain;
+  exports.isValueIncludeDataSource = isValueIncludeDataSource;
   exports.removeClassName = removeClassName;
   exports.removeClassNameByClassName = removeClassNameByClassName;
   exports.replaceChildNode = replaceChildNode;
@@ -3058,6 +3111,7 @@
   exports.sleep = sleep;
   exports.toHump = toHump;
   exports.toLine = toLine;
+  exports.traverseNode = traverseNode;
 
   Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.5.0-beta.8",
+  "version": "1.5.0",
   "name": "@tmagic/utils",
   "type": "module",
   "main": "dist/tmagic-utils.umd.cjs",
@@ -22,6 +22,7 @@
     "node": ">=18"
   },
   "repository": {
+    "directory": "packages/utils",
     "type": "git",
     "url": "https://github.com/Tencent/tmagic-editor.git"
   },
@@ -32,11 +33,11 @@
     "@types/lodash-es": "^4.17.4",
     "@types/node": "^18.19.0",
     "rimraf": "^3.0.2",
-    "vite": "^5.4.3"
+    "vite": "^5.4.10"
   },
   "peerDependencies": {
     "typescript": "*",
-    "@tmagic/schema": "1.5.0-beta.8"
+    "@tmagic/schema": "1.5.0"
   },
   "peerDependenciesMeta": {
     "typescript": {

package/src/index.ts

@@ -1,3 +1,4 @@
+/* eslint-disable no-nested-ternary */
 /*
  * Tencent is pleased to support the open source community by making TMagicEditor available.
  *
@@ -18,11 +19,41 @@
 
 import { cloneDeep, set as objectSet } from 'lodash-es';
 
-import type { DataSchema, DataSourceDeps, Id, MComponent, MNode, MNodeInstance } from '@tmagic/schema';
+import type {
+  DataSchema,
+  DataSourceDeps,
+  Id,
+  MApp,
+  MComponent,
+  MContainer,
+  MNode,
+  MNodeInstance,
+  MPage,
+  MPageFragment,
+} from '@tmagic/schema';
 import { NodeType } from '@tmagic/schema';
 
+import type { EditorNodeInfo } from '@editor/type';
+
 export * from './dom';
 
+// for typeof global checks without @types/node
+declare let global: {};
+
+let _globalThis: any;
+export const getGlobalThis = (): any =>
+  _globalThis ||
+  (_globalThis =
+    typeof globalThis !== 'undefined'
+      ? globalThis
+      : typeof self !== 'undefined'
+      ? self
+      : typeof window !== 'undefined'
+      ? window
+      : typeof global !== 'undefined'
+      ? global
+      : {});
+
 export const sleep = (ms: number): Promise<void> =>
   new Promise((resolve) => {
     const timer = setTimeout(() => {
@@ -34,7 +65,7 @@ export const sleep = (ms: number): Promise<void> =>
 // 驼峰转换横线
 export const toLine = (name = '') => name.replace(/\B([A-Z])/g, '-$1').toLowerCase();
 
-export const toHump = (name = ''): string => name.replace(/-(\w)/g, (all, letter) => letter.toUpperCase());
+export const toHump = (name = ''): string => name.replace(/-(\w)/g, (_all, letter) => letter.toUpperCase());
 
 export const emptyFn = (): any => undefined;
 
@@ -78,6 +109,39 @@ export const getNodePath = (id: Id, data: MNode[] = []): MNode[] => {
   return path;
 };
 
+export const getNodeInfo = (id: Id, root: Pick<MApp, 'id' | 'items'> | null) => {
+  const info: EditorNodeInfo = {
+    node: null,
+    parent: null,
+    page: null,
+  };
+
+  if (!root) return info;
+
+  if (id === root.id) {
+    info.node = root;
+    return info;
+  }
+
+  const path = getNodePath(id, root.items);
+
+  if (!path.length) return info;
+
+  path.unshift(root);
+
+  info.node = path[path.length - 1] as MComponent;
+  info.parent = path[path.length - 2] as MContainer;
+
+  path.forEach((item) => {
+    if (isPage(item) || isPageFragment(item)) {
+      info.page = item as MPage | MPageFragment;
+      return;
+    }
+  });
+
+  return info;
+};
+
 export const filterXSS = (str: string) =>
   str.replace(/</g, '&lt;').replace(/>/g, '&gt;').replace(/"/g, '&quot;').replace(/'/g, '&apos;');
 
@@ -425,3 +489,39 @@ export const dataSourceTemplateRegExp = /\$\{([\s\S]+?)\}/g;
 
 export const isDslNode = (config: MNodeInstance) =>
   typeof config[IS_DSL_NODE_KEY] === 'undefined' || config[IS_DSL_NODE_KEY] === true;
+
+export interface NodeItem {
+  items?: NodeItem[];
+  [key: string]: any;
+}
+
+export const traverseNode = <T extends NodeItem = NodeItem>(
+  node: T,
+  cb: (node: T, parents: T[]) => void,
+  parents: T[] = [],
+) => {
+  cb(node, parents);
+
+  if (Array.isArray(node.items) && node.items.length) {
+    parents.push(node);
+    node.items.forEach((item) => {
+      traverseNode(item as T, cb, [...parents]);
+    });
+  }
+};
+
+export const isValueIncludeDataSource = (value: any) => {
+  if (typeof value === 'string' && /\$\{([\s\S]+?)\}/.test(value)) {
+    return true;
+  }
+  if (Array.isArray(value) && `${value[0]}`.startsWith(DATA_SOURCE_FIELDS_SELECT_VALUE_PREFIX)) {
+    return true;
+  }
+  if (value?.isBindDataSource && value.dataSourceId) {
+    return true;
+  }
+  if (value?.isBindDataSourceField && value.dataSourceId) {
+    return true;
+  }
+  return false;
+};

package/types/index.d.ts

@@ -1,4 +1,11 @@
-import { Id, MNode, MComponent, DataSourceDeps, DataSchema, MNodeInstance } from '@tmagic/schema';
+import { Id, MNode as MNode$1, MApp, MComponent, DataSourceDeps, DataSchema, MNodeInstance } from '@tmagic/schema';
+import { MNode, MContainer, MPage, MPageFragment } from '@tmagic/core';
+
+interface EditorNodeInfo {
+    node: MNode | null;
+    parent: MContainer | null;
+    page: MPage | MPageFragment | null;
+}
 
 declare const asyncLoadJs: (url: string, crossOrigin?: string, document?: Document) => any;
 declare const asyncLoadCss: (url: string, document?: Document) => any;
@@ -22,6 +29,7 @@ declare const getIdFromEl: () => (el?: HTMLElement | SVGElement | null) => strin
 declare const getElById: () => (doc?: Document, id?: string | number) => HTMLElement;
 declare const setIdToEl: () => (el: HTMLElement | SVGElement, id: string | number) => void;
 
+declare const getGlobalThis: () => any;
 declare const sleep: (ms: number) => Promise<void>;
 declare const toLine: (name?: string) => string;
 declare const toHump: (name?: string) => string;
@@ -32,7 +40,8 @@ declare const emptyFn: () => any;
  * @param {Array} data 要查找的根容器节点
  * @return {Array} 组件在data中的子孙路径
  */
-declare const getNodePath: (id: Id, data?: MNode[]) => MNode[];
+declare const getNodePath: (id: Id, data?: MNode$1[]) => MNode$1[];
+declare const getNodeInfo: (id: Id, root: Pick<MApp, "id" | "items"> | null) => EditorNodeInfo;
 declare const filterXSS: (str: string) => string;
 declare const getUrlParam: (param: string, url?: string) => string;
 declare const isObject: (obj: any) => boolean;
@@ -51,7 +60,7 @@ declare const guid: (digit?: number) => string;
 declare const getKeysArray: (keys: string | number) => string[];
 declare const getValueByKeyPath: (keys?: number | string | string[], data?: Record<string | number, any>) => any;
 declare const setValueByKeyPath: (keys: string | number, value: any, data?: Record<string | number, any>) => any;
-declare const getNodes: (ids: Id[], data?: MNode[]) => MNode[];
+declare const getNodes: (ids: Id[], data?: MNode$1[]) => MNode$1[];
 declare const getDepKeys: (dataSourceDeps: DataSourceDeps | undefined, nodeId: Id) => Id[];
 declare const getDepNodeIds: (dataSourceDeps?: DataSourceDeps) => string[];
 /**
@@ -60,10 +69,10 @@ declare const getDepNodeIds: (dataSourceDeps?: DataSourceDeps) => string[];
  * @param data 需要修改的数据
  * @param parentId 父节点 id
  */
-declare const replaceChildNode: (newNode: MNode, data?: MNode[], parentId?: Id) => void;
+declare const replaceChildNode: (newNode: MNode$1, data?: MNode$1[], parentId?: Id) => void;
 declare const DSL_NODE_KEY_COPY_PREFIX = "__tmagic__";
 declare const IS_DSL_NODE_KEY = "__tmagic__dslNode";
-declare const compiledNode: (compile: (value: any) => any, node: MNode, dataSourceDeps?: DataSourceDeps, sourceId?: Id) => MNode;
+declare const compiledNode: (compile: (value: any) => any, node: MNode$1, dataSourceDeps?: DataSourceDeps, sourceId?: Id) => MNode$1;
 declare const compiledCond: (op: string, fieldValue: any, inputValue: any, range?: number[]) => boolean;
 declare const getDefaultValueFromFields: (fields: DataSchema[]) => Record<string, any>;
 declare const DATA_SOURCE_FIELDS_SELECT_VALUE_PREFIX = "ds-field::";
@@ -81,5 +90,11 @@ declare const convertToNumber: (value: number | string, parentValue?: number) =>
 declare const addParamToUrl: (obj: Record<string, any>, global?: typeof globalThis, needReload?: boolean) => void;
 declare const dataSourceTemplateRegExp: RegExp;
 declare const isDslNode: (config: MNodeInstance) => boolean;
+interface NodeItem {
+    items?: NodeItem[];
+    [key: string]: any;
+}
+declare const traverseNode: <T extends NodeItem = NodeItem>(node: T, cb: (node: T, parents: T[]) => void, parents?: T[]) => void;
+declare const isValueIncludeDataSource: (value: any) => boolean;
 
-export { DATA_SOURCE_FIELDS_CHANGE_EVENT_PREFIX, DATA_SOURCE_FIELDS_SELECT_VALUE_PREFIX, DSL_NODE_KEY_COPY_PREFIX, IS_DSL_NODE_KEY, addClassName, addParamToUrl, asyncLoadCss, asyncLoadJs, calcValueByFontsize, calculatePercentage, compiledCond, compiledNode, convertToNumber, createDiv, dataSourceTemplateRegExp, emptyFn, filterXSS, getDefaultValueFromFields, getDepKeys, getDepNodeIds, getDocument, getElById, getHost, getIdFromEl, getKeys, getKeysArray, getNodePath, getNodes, getUrlParam, getValueByKeyPath, guid, injectStyle, isDslNode, isNumber, isObject, isPage, isPageFragment, isPercentage, isPop, isSameDomain, removeClassName, removeClassNameByClassName, replaceChildNode, setDslDomRelateConfig, setIdToEl, setValueByKeyPath, sleep, toHump, toLine };
+export { DATA_SOURCE_FIELDS_CHANGE_EVENT_PREFIX, DATA_SOURCE_FIELDS_SELECT_VALUE_PREFIX, DSL_NODE_KEY_COPY_PREFIX, IS_DSL_NODE_KEY, type NodeItem, addClassName, addParamToUrl, asyncLoadCss, asyncLoadJs, calcValueByFontsize, calculatePercentage, compiledCond, compiledNode, convertToNumber, createDiv, dataSourceTemplateRegExp, emptyFn, filterXSS, getDefaultValueFromFields, getDepKeys, getDepNodeIds, getDocument, getElById, getGlobalThis, getHost, getIdFromEl, getKeys, getKeysArray, getNodeInfo, getNodePath, getNodes, getUrlParam, getValueByKeyPath, guid, injectStyle, isDslNode, isNumber, isObject, isPage, isPageFragment, isPercentage, isPop, isSameDomain, isValueIncludeDataSource, removeClassName, removeClassNameByClassName, replaceChildNode, setDslDomRelateConfig, setIdToEl, setValueByKeyPath, sleep, toHump, toLine, traverseNode };