import{Pt as e,dt as t,n,pt as r}from"./chunks/framework.DDIL1KmX.js";var i=JSON.parse(`{"title":"dataSourceService方法","description":"","frontmatter":{},"headers":[],"relativePath":"api/editor/dataSourceServiceMethods.md","filePath":"api/editor/dataSourceServiceMethods.md"}`),a={name:`api/editor/dataSourceServiceMethods.md`};function o(n,i,a,o,s,c){return e(),t(`div`,null,[...i[0]||=[r(`

dataSourceService方法

get

参数：
- {StateKey} name 状态键名
返回：
- {any} 对应的状态值
详情：
获取数据源服务的内部状态
可用的状态键：
- datasourceTypeList: 数据源类型列表
- dataSources: 当前数据源列表
- editable: 是否可编辑
- configs: 数据源表单配置
- values: 数据源默认值
- events: 数据源事件列表
- methods: 数据源方法列表
示例：

import { dataSourceService } from "@tmagic/editor";

const dataSources = dataSourceService.get("dataSources");
console.log(dataSources);

set

参数：
- {StateKey} name 状态键名
- {any} value 状态值
返回：
- {void}
详情：
设置数据源服务的内部状态
示例：

import { dataSourceService } from "@tmagic/editor";

dataSourceService.set("editable", false);

getFormConfig

扩展支持： 是
参数：
- {string} type 数据源类型，默认为 'base'

返回：

{FormConfig} 表单配置

查看 FormConfig 及关联类型定义

export type FormConfig<T = never> = FormItemConfig<T>[];

export type FormItemConfig<T = never> = ChildConfig<T> | DynamicTypeConfig | EditorChildConfig<T> | T;

export type ChildConfig<T = never> =
  | ContainerCommonConfig<T>
  | TabConfig<T>
  | RowConfig<T>
  | FieldsetConfig<T>
  | PanelConfig<T>
  | TableConfig
  | GroupListConfig<T>
  | StepConfig<T>
  | DisplayConfig
  | TextConfig
  | NumberConfig
  | NumberRangeConfig
  | HiddenConfig
  | LinkConfig<T>
  | DaterangeConfig
  | TimerangeConfig
  | SelectConfig
  | CascaderConfig
  | HtmlField
  | DateConfig
  | ColorPickConfig
  | TimeConfig
  | DateTimeConfig
  | CheckboxConfig
  | SwitchConfig
  | RadioGroupConfig
  | CheckboxGroupConfig
  | TextareaConfig
  | DynamicFieldConfig
  | ComponentConfig
  | FlexLayoutConfig<T>;

export interface DynamicTypeConfig extends FormItem {
  type: TypeFunction;
  [key: string]: any;
}

export interface FormItem {
  /** vnode的key值，默认是遍历数组时的index */
  __key?: string | number;
  /** 表单域标签的的宽度，例如 '50px'。支持 auto。 */
  labelWidth?: string | number;
  /** label 标签的title属性 */
  labelTitle?: string;
  className?: string;
  /** 字段名 */
  name?: string | number;
  /** 额外的提示信息，和 help 类似，当提示文案同时出现时，可以使用这个。 */
  extra?: string | FilterFunction<string>;
  /** 额外的提示信息，和 extra 类似，着重强调时用这个显示，优先级高于extra*/
  extraTips?: string;
  /** 配置提示信息 */
  tooltip?: ToolTipConfigType | FilterFunction<ToolTipConfigType>;
  /** 是否置灰 */
  disabled?: boolean | FilterFunction;
  /** 使用表单中的值作为key，例如配置了text，则使用model.text作为key */
  key?: string;
  /** 是否显示 */
  display?: boolean | 'expand' | FilterFunction<boolean | 'expand'>;
  /** 值发生改变时调用的方法 */
  onChange?: OnChangeHandler;
  /** label 标签的文本 */
  text?: string | FilterFunction<string>;
  /** 右侧感叹号 */
  tip?: string;

  filter?: 'number' | OnChangeHandler;
  /** 是否去除首尾空格 */
  trim?: boolean;
  /** 默认值 */
  defaultValue?: any | DefaultValueFunction;
  /** 标题下方的额外提示信息 */
  titleExtra?: string;
  /** 表单验证规则 */
  rules?: Rule[];
  extensible?: boolean;
  dynamicKey?: string;
  /** 是否需要显示\`展开更多配置\` */
  expand?: boolean;
  style?: Record<string, any>;
  fieldStyle?: Record<string, any>;
  labelPosition?: 'top' | 'left' | 'right';
  flat?: boolean;
  fixed?: boolean | 'left' | 'right';
  operateColWidth?: number | string;
}

详情：
获取指定类型数据源的表单配置
示例：

import { dataSourceService } from "@tmagic/editor";

const config = dataSourceService.getFormConfig("http");
console.log(config);

setFormConfig

扩展支持： 是
参数：
- {string} type 数据源类型
- {FormConfig} config 表单配置
返回：
- {void}
详情：
设置指定类型数据源的表单配置
示例：

import { dataSourceService } from "@tmagic/editor";

dataSourceService.setFormConfig("http", [
  {
    name: "url",
    text: "请求地址",
    type: "text",
  },
  {
    name: "method",
    text: "请求方法",
    type: "select",
    options: [
      { text: "GET", value: "GET" },
      { text: "POST", value: "POST" },
    ],
  },
]);

getFormValue

扩展支持： 是
参数：
- {string} type 数据源类型，默认为 'base'

返回：

{Partial<DataSourceSchema>} 数据源默认值

查看 DataSourceSchema 及关联类型定义

export interface DataSourceSchema {
  /** 数据源类型，根据类型来实例化；例如http则使用new HttpDataSource */
  type: string;
  /** 实体ID */
  id: string;
  /** 实体名称，用于关联时展示 */
  title?: string;
  /** 实体描述，鼠标hover时展示 */
  description?: string;
  /** 字段列表 */
  fields: DataSchema[];
  /** 方法列表 */
  methods: CodeBlockContent[];
  /** mock数据 */
  mocks?: MockSchema[];
  /** 事件 */
  events: EventConfig[];
  /** 不执行init的环境 */
  disabledInitInJsEngine?: (JsEngine | string)[];
  /** 扩展字段 */
  [key: string]: any;
}

export interface DataSchema {
  type?: DataSourceFieldType;
  /** 键名 */
  name: string;
  /** 展示名称 */
  title?: string;
  /** 实体描述，鼠标hover时展示 */
  description?: string;
  /** 默认值 */
  defaultValue?: any;
  /** 是否可用 */
  enable?: boolean;
  /** type === 'object' || type === 'array' */
  fields?: DataSchema[];
}

export interface MockSchema {
  /** 名称 */
  title: string;
  /** 详细描述 */
  description?: string;
  /** 是否启用，用于编辑器以外的runtime */
  enable: boolean;
  /** 编辑器中使用使用此条数据，仅用于编辑器runtime中 */
  useInEditor: boolean;
  /** mock数据 */
  data: Record<string | number, any>;
}

export interface CodeBlockContent {
  /** 代码块名称 */
  name: string;
  /** 代码块内容 */
  content: ((...args: any[]) => any) | Function;
  /** 参数定义 */
  params: CodeParam[] | [];
  /** 注释 */
  desc?: string;
  /** 扩展字段 */
  [propName: string]: any;
}

export interface CodeParam {
  /** 参数名 */
  name: string;
  /** 扩展字段 */
  [propName: string]: any;
}

export interface EventConfig {
  /** 待触发的事件名称 */
  name: string;
  /** 动作响应配置 */
  actions: EventActionItem[];
}

export type JsEngine = 'browser' | 'hippy' | 'nodejs';

详情：
获取指定类型数据源的默认值
示例：

import { dataSourceService } from "@tmagic/editor";

const defaultValue = dataSourceService.getFormValue("http");
console.log(defaultValue);

setFormValue

扩展支持： 是
参数：
- {string} type 数据源类型
- {Partial<DataSourceSchema>} value 数据源默认值
返回：
- {void}
详情：
设置指定类型数据源的默认值
示例：

import { dataSourceService } from "@tmagic/editor";

dataSourceService.setFormValue("http", {
  type: "http",
  method: "GET",
  url: "",
});

getFormEvent

扩展支持： 是
参数：
- {string} type 数据源类型，默认为 'base'

返回：

{EventOption[]} 事件列表

查看 EventOption 类型定义

export interface EventOption {
  label: string;
  value: string;
}

详情：
获取指定类型数据源的事件列表
示例：

import { dataSourceService } from "@tmagic/editor";

const events = dataSourceService.getFormEvent("http");
console.log(events);

setFormEvent

扩展支持： 是
参数：
- {string} type 数据源类型
- {EventOption[]} value 事件列表
返回：
- {void}
详情：
设置指定类型数据源的事件列表
示例：

import { dataSourceService } from "@tmagic/editor";

dataSourceService.setFormEvent("http", [
  { label: "请求成功", value: "success" },
  { label: "请求失败", value: "error" },
]);

getFormMethod

扩展支持： 是
参数：
- {string} type 数据源类型，默认为 'base'
返回：
- {EventOption[]} 方法列表
详情：
获取指定类型数据源的方法列表
示例：

import { dataSourceService } from "@tmagic/editor";

const methods = dataSourceService.getFormMethod("http");
console.log(methods);

setFormMethod

扩展支持： 是
参数：
- {string} type 数据源类型
- {EventOption[]} value 方法列表
返回：
- {void}
详情：
设置指定类型数据源的方法列表
示例：

import { dataSourceService } from "@tmagic/editor";

dataSourceService.setFormMethod("http", [
  { label: "发起请求", value: "request" },
  { label: "重试", value: "retry" },
]);

add

扩展支持： 是
参数：
- {DataSourceSchema} config 数据源配置
- {Object} options 可选配置
  - {boolean} doNotPushHistory 是否不写入历史记录（默认 false）
  - {string} historyDescription 见 editorService 历史记录相关 options
  - {HistoryOpSource} historySource 见 editorService 历史记录相关 options
返回：
- {DataSourceSchema} 添加后的数据源配置
详情：
添加一个数据源，如果配置中没有id或id已存在，会自动生成新的id
TIP
添加成功会自动调用 historyService.push('dataSource', step, id) 入栈一条 oldSchema=null 的新增记录，参见 historyService.push。传入 doNotPushHistory: true 可跳过写入历史栈，常用于批量导入、外部同步等非用户操作场景。
示例：

import { dataSourceService } from "@tmagic/editor";

const newDs = dataSourceService.add({
  type: "http",
  title: "用户信息",
  url: "/api/user",
  method: "GET",
});

console.log(newDs.id); // 自动生成的id

update

扩展支持： 是
参数：
- {DataSourceSchema} config 数据源配置
- {Object} options 可选配置
  - {ChangeRecord[]} changeRecords 变更记录
  - {boolean} doNotPushHistory 是否不写入历史记录（默认 false）
  - {string} historyDescription 见 editorService 历史记录相关 options
  - {HistoryOpSource} historySource 见 editorService 历史记录相关 options
查看 ChangeRecord 类型定义
ts
```
export interface ChangeRecord {
  propPath?: string;
  value: any;
}
```
返回：
- {DataSourceSchema} 更新后的数据源配置
详情：
更新数据源
TIP
更新成功会自动调用 historyService.push('dataSource', step, id) 入栈一条 oldSchema / newSchema 均为对应 schema 的更新记录，传入的 changeRecords 也会一并写进 step；撤销/重做时调用方可据此按 propPath 局部回放，缺省才退化为整 schema 替换。传入 doNotPushHistory: true 可跳过写入历史栈。
示例：

import { dataSourceService } from "@tmagic/editor";

const updatedDs = dataSourceService.update({
  id: "ds_123",
  type: "http",
  title: "用户详情",
  url: "/api/user/detail",
});

console.log(updatedDs);

remove

扩展支持： 是
参数：
- {string} id 数据源id
- {Object} options 可选配置
  - {boolean} doNotPushHistory 是否不写入历史记录（默认 false）
  - {string} historyDescription 见 editorService 历史记录相关 options
  - {HistoryOpSource} historySource 见 editorService 历史记录相关 options
返回：
- {void}
详情：
删除指定id的数据源
TIP
对实际存在的数据源会自动调用 historyService.push('dataSource', step, id) 入栈一条 newSchema=null 的删除记录；不存在的 id 不会入历史。传入 doNotPushHistory: true 也可显式跳过写入历史栈。
示例：

import { dataSourceService } from "@tmagic/editor";

dataSourceService.remove("ds_123");

addAndGetHistoryId

参数： 同 add
返回：
- {DslOpWithHistoryIdsResult<DataSourceSchema>}
  - result：同 add 的返回值（新增的数据源配置）
  - historyIds：本次写入历史记录的 uuid 列表；未写入历史（doNotPushHistory: true 等）时为 []
详情：
与 add 行为完全一致，并在返回值中额外提供 historyIds，可用于精确引用 / 定位该条历史记录。参见 editorService 历史记录 uuid 与 *AndGetHistoryId。
示例：

import { dataSourceService } from "@tmagic/editor";

const { result, historyIds } = dataSourceService.addAndGetHistoryId({
  type: "http",
  title: "用户信息",
  url: "/api/user",
});
console.log(result); // 新增的数据源配置
console.log(historyIds); // 本次新增对应的历史记录 uuid 列表，或 []

updateAndGetHistoryId

参数： 同 update
返回：
- {DslOpWithHistoryIdsResult<DataSourceSchema>}
  - result：同 update 的返回值（更新后的数据源配置）
  - historyIds：本次写入历史记录的 uuid 列表；未写入历史时为 []
详情：
与 update 行为完全一致，并在返回值中额外提供 historyIds

removeAndGetHistoryId

参数： 同 remove
返回：
- {DslOpWithHistoryIdsResult<void>}
  - historyIds：本次写入历史记录的 uuid 列表；删除的 id 不存在或未写入历史时为 []
详情：
与 remove 行为完全一致，并在返回值中额外提供 historyIds

revertById

参数：
- {string[]} uuids 目标历史记录的 uuid 列表（通常由 addAndGetHistoryId 等方法返回的 historyIds）
返回：
- {(DataSourceStepValue | null)[]} 与入参同序的回滚结果列表，某项失败时为 null
详情：
通过历史记录 uuid「回滚」数据源历史步骤（类 git revert 语义），语义同按 (id, index) 回滚，仅无需调用方再传 dataSourceId 与 index。按数组顺序依次回滚。参见 editorService 历史记录 uuid 与 *AndGetHistoryId。
示例：

import { dataSourceService } from "@tmagic/editor";

const { historyIds } = dataSourceService.addAndGetHistoryId({ type: "http", title: "用户信息" });
if (historyIds.length) {
  dataSourceService.revertById(historyIds);
}

createId

扩展支持： 是
参数： 无
返回：
- {string} 生成的唯一id
详情：
生成一个唯一的数据源id，格式为 ds_ + guid
示例：

import { dataSourceService } from "@tmagic/editor";

const id = dataSourceService.createId();
console.log(id); // 'ds_xxx-xxx-xxx'

getDataSourceById

参数：
- {string} id 数据源id
返回：
- {DataSourceSchema | undefined} 数据源配置
详情：
根据id获取数据源配置
示例：

import { dataSourceService } from "@tmagic/editor";

const ds = dataSourceService.getDataSourceById("ds_123");
console.log(ds);

undo

参数：
- {Id} id 数据源id
返回：
- {DataSourceStepValue | null} 撤销的 step；栈不存在或已无可撤销时返回 null
详情：
撤销指定数据源的最近一次变更。内部根据 historyService 取出 step 后，复用 add / update / remove 写回，并自动带上 doNotPushHistory: true，确保不会再次入栈。
写回会触发对应的 add / update / remove 事件，编辑器内部据此重新维护数据源相关的依赖收集（DepTargetType.DATA_SOURCE / DATA_SOURCE_COND / DATA_SOURCE_METHOD），无需调用方额外处理。
对于带有 changeRecords 的更新 step，会按 propPath 局部 patch 当前数据源；缺省才退化为整 schema 替换，避免冲掉同节点上的其它无关变更。
示例：

import { dataSourceService } from "@tmagic/editor";

if (dataSourceService.canUndo("ds_123")) {
  dataSourceService.undo("ds_123");
}

redo

参数：
- {Id} id 数据源id
返回：
- {DataSourceStepValue | null} 重做的 step；栈不存在或已无可重做时返回 null
详情：
重做指定数据源的下一次变更。其它行为同 undo。

canUndo

参数：
- {Id} id 数据源id
返回：
- {boolean}
详情：
当前指定数据源是否可撤销，等价于 historyService.canUndo('dataSource', id)。

canRedo

参数：
- {Id} id 数据源id
返回：
- {boolean}
详情：
当前指定数据源是否可重做，等价于 historyService.canRedo('dataSource', id)。

copyWithRelated

参数：

{MNode | MNode[]} config 组件节点配置
{TargetOptions} collectorOptions 可选的收集器配置

查看 MNode 及关联类型定义

export type MNode = MComponent | MContainer | MIteratorContainer | MPage | MApp | MPageFragment;

export interface MComponent {
  /** 组件ID，默认为\${type}_\${number}}形式, 如：page_123 */
  id: Id;
  /** 组件类型 */
  type?: string;
  /** 组件显示名称 */
  name?: string;
  /** 组件根Dom上的class */
  className?: string;
  /* 关联事件集合 */
  events?: EventConfig[];
  /** 是否隐藏 */
  visible?: boolean;
  /** 显示条件中配置的数据源条件的编译结果 */
  condResult?: boolean;
  /** 组件根Dom的style */
  style?: StyleSchema;
  [NODE_CONDS_KEY]?: DisplayCond[];
  [NODE_CONDS_RESULT_KEY]?: boolean;
  [key: string]: any;
}

export interface MContainer extends MComponent {
  /** 容器类型，默认为'container' */
  type?: NodeType.CONTAINER | string;
  /** 容器子元素 */
  items: (MComponent | MContainer)[];
}

export interface MIteratorContainer extends MContainer {
  type: 'iterator-container';
  iteratorData: any[];
  dsField: string[];
  itemConfig: {
    layout: string;
    [NODE_CONDS_KEY]: DisplayCond[];
    style: Record<string, string | number>;
  };
}

export interface MPage extends MContainer {
  /** 页面类型 */
  type: NodeType.PAGE;
}

export interface MApp extends MComponent {
  /** App页面类型，app作为整个结构的根节点；有且只有一个 */
  type: NodeType.ROOT;
  /** */
  items: (MPage | MPageFragment)[];
  /** 代码块 */
  codeBlocks?: CodeBlockDSL;

  dataSources?: DataSourceSchema[];

  dataSourceDeps?: DataSourceDeps;
  dataSourceCondDeps?: DataSourceDeps;
  dataSourceMethodDeps?: DataSourceDeps;
}

export interface MPageFragment extends MContainer {
  /** 页面类型 */
  type: NodeType.PAGE_FRAGMENT;
}

返回：
- {void}
详情：
复制组件时会带上组件关联的数据源，将关联的数据源存储到 localStorage
示例：

import { dataSourceService, editorService } from "@tmagic/editor";

const node = editorService.get("node");
dataSourceService.copyWithRelated(node);

paste

参数： 无
返回：
- {void}
详情：
粘贴数据源，从 localStorage 中读取复制的数据源并添加到当前页面
如果数据源id已存在，则不会覆盖
示例：

import { dataSourceService } from "@tmagic/editor";

dataSourceService.paste();

resetState

参数： 无
返回：
- {void}
详情：
重置数据源服务状态，清空所有数据源
示例：

import { dataSourceService } from "@tmagic/editor";

dataSourceService.resetState();

destroy

参数： 无
返回：
- {void}
详情：
销毁 dataSourceService，移除所有事件监听并重置状态
示例：

import { dataSourceService } from "@tmagic/editor";

dataSourceService.destroy();

usePlugin

详情：

usePlugin支持更加灵活更加细致的扩展，上述方法中标记有扩展支持：是的方法都支持使用usePlugin扩展

每个支持扩展的方法都支持定制before、after两个hook来干预原有方法的行为，before可以用于修改传入参数，after可以用于修改返回的值

示例：

import { dataSourceService } from "@tmagic/editor";

dataSourceService.usePlugin({
  beforeAdd(config) {
    console.log("添加前:", config);
    return [config];
  },

  afterAdd(result, config) {
    console.log("添加后:", result);
    return result;
  },
});

removeAllPlugins

详情：

删掉当前设置的所有扩展

示例：

import { dataSourceService } from "@tmagic/editor";

dataSourceService.removeAllPlugins();

`,88)]])}var s=n(a,[[`render`,o]]);export{i as __pageData,s as default};

dataSourceService方法 ​

get ​

set ​

getFormConfig ​

setFormConfig ​

getFormValue ​

setFormValue ​

getFormEvent ​

setFormEvent ​

getFormMethod ​

setFormMethod ​

add ​

update ​

remove ​

addAndGetHistoryId ​

updateAndGetHistoryId ​

removeAndGetHistoryId ​

revertById ​

createId ​

getDataSourceById ​

undo ​

redo ​

canUndo ​

canRedo ​

copyWithRelated ​

paste ​

resetState ​

destroy ​

usePlugin ​

removeAllPlugins ​

dataSourceService方法

get

set

getFormConfig

setFormConfig

getFormValue

setFormValue

getFormEvent

setFormEvent

getFormMethod

setFormMethod

add

update

remove

addAndGetHistoryId

updateAndGetHistoryId

removeAndGetHistoryId

revertById

createId

getDataSourceById

undo

redo

canUndo

canRedo

copyWithRelated

paste

resetState

destroy

usePlugin

removeAllPlugins