@flowgram-vue/core 0.2.0

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@flowgram-vue/core",
+  "version": "0.2.0",
+  "type": "module",
+  "license": "MIT",
+  "homepage": "https://flowgram.ai/",
+  "repository": "https://github.com/Crayon-hua/flowgram-vue",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "src",
+    "dist"
+  ],
+  "dependencies": {
+    "@phosphor/messaging": "^1.3.0",
+    "@tweenjs/tween.js": "^18",
+    "inversify": "^6.0.1",
+    "lodash-es": "^4.17.21",
+    "nanoid": "^5.0.9",
+    "reflect-metadata": "~0.2.2",
+    "@flowgram-vue/command": "0.2.0",
+    "@flowgram-vue/utils": "0.2.0"
+  },
+  "peerDependencies": {
+    "vue": "^3.3.0"
+  },
+  "devDependencies": {
+    "@types/lodash-es": "^4.17.12",
+    "@types/node": "^20",
+    "@vitejs/plugin-vue": "^6.0.1",
+    "@vitest/coverage-v8": "^3.2.4",
+    "@vue/test-utils": "^2.4.6",
+    "eslint": "^9.0.0",
+    "jsdom": "^26.1.0",
+    "typescript": "^5.8.3",
+    "vitest": "^3.2.4",
+    "vue": "^3.5.18",
+    "@flowgram-vue/eslint-config": "0.2.0",
+    "@flowgram-vue/build-config": "0.2.0",
+    "@flowgram-vue/ts-config": "0.2.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "flowgram-build",
+    "test": "vitest run",
+    "lint": "eslint .",
+    "ts-check": "tsc --noEmit",
+    "type-check": "tsc --noEmit",
+    "build:fast": "flowgram-build --fast",
+    "build:watch": "flowgram-build --watch"
+  }
+}

package/src/common/config-entity.ts

@@ -0,0 +1,80 @@
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+import { type Disposable } from '@flowgram-vue/utils';
+
+import type { EntityDataRegistry } from './entity-data';
+import { EntityData } from './entity-data';
+import { Entity, type EntityOpts } from './entity';
+
+export interface ConfigEntityProps {}
+
+// let version = 0
+
+export function createConfigDataRegistry<P>(entity: ConfigEntity<any>): EntityDataRegistry {
+  class ConfigData extends EntityData<P> {
+    getDefaultData(): P {
+      return entity.getDefaultConfig();
+    }
+
+    checkChanged(newProps: Partial<P>): boolean {
+      return entity.checkChanged(this.data, newProps);
+    }
+
+    toJSON(): object {
+      return super.toJSON();
+    }
+  }
+
+  Object.defineProperty(ConfigData, 'type', {
+    value: `_${entity.type}DataMixin`,
+    // value: `_${entity.type}DataMixin_${version++}`,
+  });
+
+  return ConfigData as any;
+}
+
+/**
+ * 用于专门的数据配置，且是单例
+ */
+export class ConfigEntity<
+  P extends ConfigEntityProps = ConfigEntityProps,
+  O extends EntityOpts = EntityOpts,
+> extends Entity<O> {
+  static type = 'ConfigEntity';
+
+  protected ConfigDataRegistry: EntityDataRegistry;
+
+  constructor(opts: O) {
+    super(opts);
+    this.isInitialized = true;
+    this.ConfigDataRegistry = createConfigDataRegistry<P>(this);
+    this.addData(this.ConfigDataRegistry);
+    this.isInitialized = false;
+  }
+
+  getDefaultConfig(): P {
+    return {} as P;
+  }
+
+  /**
+   * 判断 config 数据是否变化
+   */
+  checkChanged(oldData: P, newData: Partial<P>): boolean {
+    return Entity.checkDataChanged(oldData, newData);
+  }
+
+  get config(): P {
+    return this.getData(this.ConfigDataRegistry)!.data as P;
+  }
+
+  updateConfig(props: Partial<P>): void {
+    this.updateData(this.ConfigDataRegistry, props);
+  }
+
+  onConfigChanged(fn: (data: P) => void): Disposable {
+    return this.getData<EntityData>(this.ConfigDataRegistry)!.onDataChange(d => fn(d.data as P));
+  }
+}

package/src/common/entity-data.ts

@@ -0,0 +1,171 @@
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+import { Compare, DisposableImpl, Emitter } from '@flowgram-vue/utils';
+
+import { Entity } from './entity';
+
+/**
+ * 实体的数据块
+ */
+export abstract class EntityData<
+  DATA = any | number | string,
+  OPTS extends {} = {},
+> extends DisposableImpl {
+  static type = 'EntityData';
+
+  protected onDataChangeEmitter = new Emitter<EntityData<DATA, OPTS>>();
+
+  protected onWillChangeEmitter = new Emitter<EntityData<DATA, OPTS>>();
+
+  protected _data: DATA;
+
+  private _changeLocked = false;
+
+  protected _version = 0;
+
+  declare entity: Entity;
+
+  /**
+   * 修改后触发
+   */
+  readonly onDataChange = this.onDataChangeEmitter.event;
+
+  /**
+   * 修改前触发
+   */
+  readonly onWillChange = this.onWillChangeEmitter.event;
+
+  /**
+   * 初始化数据
+   */
+  abstract getDefaultData(): DATA;
+
+  constructor(entity: Entity, readonly opts?: OPTS) {
+    super();
+    this.entity = entity;
+    this._data = this.getDefaultData();
+    this.toDispose.push(this.onDataChangeEmitter);
+    this.toDispose.push(this.onWillChangeEmitter);
+  }
+
+  /**
+   * data 类型
+   */
+  get type(): string {
+    if (!(this.constructor as any).type) {
+      throw new Error(`Entity Data Registry need a type: ${this.constructor.name}`);
+    }
+    return (this.constructor as any).type;
+  }
+
+  /**
+   * 当前数据
+   */
+  get data(): DATA {
+    return this._data;
+  }
+
+  /**
+   * 更新单个数据
+   */
+  update(props: Partial<DATA> | keyof DATA | DATA, value?: any): void {
+    if (arguments.length === 2) {
+      if (this._data[props as keyof DATA] !== value) {
+        this.fireWillChange();
+        this._data[props as keyof DATA] = value;
+        this.fireChange();
+      }
+    } else if (this.checkChanged(props as Partial<DATA>)) {
+      this.fireWillChange();
+      if (typeof props !== 'object') {
+        this._data = props as any;
+      } else {
+        this._data = { ...this._data, ...(props as Partial<DATA>) };
+      }
+      this.fireChange();
+    }
+  }
+
+  /**
+   * 更新全量数据
+   * @param props
+   */
+  fullyUpdate(props: DATA): void {
+    // 仅做一层的全量比较
+    if (Compare.isChanged(this._data, props, 1, false)) {
+      this.fireWillChange();
+      this._data = props;
+      this.fireChange();
+    }
+  }
+
+  /**
+   * @deprecated
+   * 检测属性是否更改，默认采用浅比较
+   */
+  checkChanged(newProps: Partial<DATA> | DATA): boolean {
+    return Entity.checkDataChanged(this._data, newProps);
+  }
+
+  /**
+   * 存储数据，一般在关闭浏览器后需要暂时存到 localStorage
+   */
+  toJSON(): any {
+    return this.data as any;
+  }
+
+  /**
+   * 还原数据
+   */
+  fromJSON(data: object): void {
+    this.update(data);
+  }
+
+  get changeLocked(): boolean {
+    return this._changeLocked;
+  }
+
+  set changeLocked(p) {
+    this._changeLocked = p;
+  }
+
+  fireWillChange(): void {
+    this.onWillChangeEmitter.fire(this as EntityData<DATA, OPTS>);
+  }
+
+  fireChange(): void {
+    if (this._changeLocked) return;
+    this._version++;
+    /* istanbul ignore next */
+    if (this._version >= Number.MAX_SAFE_INTEGER) {
+      this._version = 0;
+    }
+    this.onDataChangeEmitter.fire(this as EntityData<DATA, OPTS>);
+  }
+
+  protected bindChange(data: EntityData, fn?: () => void): void {
+    this.toDispose.push(
+      data.onDataChange(() => {
+        if (fn) fn();
+        this.fireChange();
+      }),
+    );
+  }
+
+  get version() {
+    return this._version;
+  }
+}
+
+export type EntityDataProps<E extends EntityData> = E['data'];
+
+export interface EntityDataRegistry<E extends EntityData = EntityData> {
+  new (...args: any[]): E;
+
+  type: E['type'];
+}
+
+export type EntityDataInjector = <OPTS extends {} = {}>() => OPTS;

package/src/common/entity-manager-contribution.ts

@@ -0,0 +1,12 @@
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+import { type EntityManager } from './entity-manager';
+
+export const EntityManagerContribution = Symbol('EntityManagerContribution');
+
+export interface EntityManagerContribution {
+  registerEntityManager(entityManager: EntityManager): void;
+}