@flowgram-vue/free-history-plugin 0.2.0

package/src/operation-metas/reset-layout.ts

@@ -0,0 +1,33 @@
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+import { type PluginContext } from '@flowgram-vue/core';
+import { WorkflowResetLayoutService } from '@flowgram-vue/free-layout-core';
+import { type OperationMeta } from '@flowgram-vue/history';
+
+import { FreeOperationType, type ResetLayoutOperationValue } from '../types';
+import { baseOperationMeta } from './base';
+
+export const resetLayoutOperationMeta: OperationMeta<
+  ResetLayoutOperationValue,
+  PluginContext,
+  void
+> = {
+  ...baseOperationMeta,
+  type: FreeOperationType.resetLayout,
+  inverse: op => ({
+    ...op,
+    value: {
+      ...op.value,
+      value: op.value.oldValue,
+      oldValue: op.value.value,
+    },
+  }),
+  apply: async (operation, ctx: PluginContext) => {
+    const reset = ctx.get<WorkflowResetLayoutService>(WorkflowResetLayoutService);
+    await reset.layoutToPositions(operation.value.ids, operation.value.value);
+  },
+  shouldMerge: () => false,
+};

package/src/types.ts

@@ -0,0 +1,173 @@
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+/* eslint-disable @typescript-eslint/naming-convention */
+import { type IPoint } from '@flowgram-vue/utils';
+import { type Operation, type OperationMeta } from '@flowgram-vue/history';
+import {
+  type WorkflowContentChangeType,
+  type WorkflowContentChangeEvent,
+  type WorkflowLineEntity,
+  type WorkflowLinePortInfo,
+  type WorkflowNodeJSON,
+  type PositionMap,
+} from '@flowgram-vue/free-layout-core';
+import { type FlowNodeEntity, type FlowNodeJSON } from '@flowgram-vue/document';
+import { type EntityData, type PluginContext } from '@flowgram-vue/core';
+
+export enum FreeOperationType {
+  addLine = 'addLine',
+  deleteLine = 'deleteLine',
+  changeLineData = 'changeLineData',
+  moveNode = 'moveNode',
+  addNode = 'addNode',
+  deleteNode = 'deleteNode',
+  changeNodeData = 'changeNodeData',
+  resetLayout = 'resetLayout',
+  dragNodes = 'dragNodes',
+  moveChildNodes = 'moveChildNodes',
+}
+
+export interface AddOrDeleteLineOperationValue extends WorkflowLinePortInfo {
+  id: string;
+}
+
+export interface ChangeLineDataValue {
+  id: string;
+  oldValue: unknown;
+  newValue: unknown;
+}
+export interface AddOrDeleteWorkflowNodeOperationValue {
+  node: WorkflowNodeJSON;
+  parentID?: string;
+}
+
+export interface AddLineOperation extends Operation {
+  type: FreeOperationType.addLine;
+  value: AddOrDeleteLineOperationValue;
+}
+
+export interface ChangeLineDataOperation extends Operation {
+  type: FreeOperationType.changeLineData;
+  value: ChangeLineDataValue;
+}
+
+export interface DeleteLineOperation extends Operation {
+  type: FreeOperationType.deleteLine;
+  value: AddOrDeleteLineOperationValue;
+}
+
+export interface MoveNodeOperation extends Operation {
+  type: FreeOperationType.moveNode;
+  value: MoveNodeOperationValue;
+}
+
+export interface AddWorkflowNodeOperation extends Operation {
+  type: FreeOperationType.addNode;
+  value: AddOrDeleteWorkflowNodeOperationValue;
+}
+
+export interface DeleteWorkflowNodeOperation extends Operation {
+  type: FreeOperationType.deleteNode;
+  value: AddOrDeleteWorkflowNodeOperationValue;
+}
+
+export interface MoveNodeOperationValue {
+  id: string;
+  value: {
+    x: number;
+    y: number;
+  };
+  oldValue: {
+    x: number;
+    y: number;
+  };
+}
+
+export interface DragNodeOperationValue {
+  ids: string[];
+  value: IPoint[];
+  oldValue: IPoint[];
+}
+
+export interface ResetLayoutOperationValue {
+  ids: string[];
+  value: PositionMap;
+  oldValue: PositionMap;
+}
+
+export interface ContentChangeTypeToOperation<T extends Operation> {
+  type: WorkflowContentChangeType;
+  toOperation: (event: WorkflowContentChangeEvent, ctx: PluginContext) => T | undefined;
+}
+
+export interface EntityDataType {
+  type: FreeOperationType;
+  toEntityData: (node: FlowNodeEntity, ctx: PluginContext) => EntityData;
+}
+
+export interface ChangeNodeDataValue {
+  id: string;
+  value: unknown;
+  oldValue: unknown;
+  path: string;
+}
+
+export interface ChangeLineDataValue {
+  id: string;
+  newValue: unknown;
+  oldValue: unknown;
+}
+
+/**
+ * 将node转成json
+ */
+export type NodeToJson = (node: FlowNodeEntity) => FlowNodeJSON;
+/**
+ * 将line转成json
+ */
+export type LineToJson = (node: WorkflowLineEntity) => FlowNodeJSON;
+/**
+ * 根据节点id获取label
+ */
+export type GetNodeLabelById = (id: string) => string;
+/**
+ * 根据节点获取label
+ */
+export type GetNodeLabel = (node: FlowNodeJSON) => string;
+/**
+ * 根据分支获取label
+ */
+export type GetBlockLabel = (node: FlowNodeJSON) => string;
+/**
+ * 根据节点获取URI
+ */
+export type GetNodeURI = (id: string) => string | any;
+/**
+ * 根据连线获取URI
+ */
+export type GetLineURI = (id: string) => string | any;
+
+/**
+ * 插件配置
+ */
+export interface FreeHistoryPluginOptions<CTX extends PluginContext = PluginContext> {
+  enable?: boolean;
+  limit?: number;
+  nodeToJSON?: (ctx: CTX) => NodeToJson;
+  getNodeLabelById?: (ctx: CTX) => GetNodeLabelById;
+  getNodeLabel?: (ctx: CTX) => GetNodeLabel;
+  getBlockLabel?: (ctx: CTX) => GetBlockLabel;
+  getNodeURI?: (ctx: CTX) => GetNodeURI;
+  getLineURI?: (ctx: CTX) => GetLineURI;
+  operationMetas?: OperationMeta[];
+  enableChangeNode?: boolean; // default true
+  enableChangeLineData?: boolean; // default true
+  uri?: string | any;
+}
+
+export interface IHandler<E> {
+  handle: (event: E, ctx: PluginContext) => void | Promise<void>;
+}