refactor: reorganize package structure and decouple framework packages (#338)
* refactor: reorganize package structure and decouple framework packages ## Package Structure Reorganization - Reorganized 55 packages into categorized subdirectories: - packages/framework/ - Generic framework (Laya/Cocos compatible) - packages/engine/ - ESEngine core modules - packages/rendering/ - Rendering modules (WASM dependent) - packages/physics/ - Physics modules - packages/streaming/ - World streaming - packages/network-ext/ - Network extensions - packages/editor/ - Editor framework and plugins - packages/rust/ - Rust WASM engine - packages/tools/ - Build tools and SDK ## Framework Package Decoupling - Decoupled behavior-tree and blueprint packages from ESEngine dependencies - Created abstracted interfaces (IBTAssetManager, IBehaviorTreeAssetContent) - ESEngine-specific code moved to esengine/ subpath exports - Framework packages now usable with Cocos/Laya without ESEngine ## CI Configuration - Updated CI to only type-check and lint framework packages - Added type-check:framework and lint:framework scripts ## Breaking Changes - Package import paths changed due to directory reorganization - ESEngine integrations now use subpath imports (e.g., '@esengine/behavior-tree/esengine') * fix: update es-engine file path after directory reorganization * docs: update README to focus on framework over engine * ci: only build framework packages, remove Rust/WASM dependencies * fix: remove esengine subpath from behavior-tree and blueprint builds ESEngine integration code will only be available in full engine builds. Framework packages are now purely engine-agnostic. * fix: move network-protocols to framework, build both in CI * fix: update workflow paths from packages/core to packages/framework/core * fix: exclude esengine folder from type-check in behavior-tree and blueprint * fix: update network tsconfig references to new paths * fix: add test:ci:framework to only test framework packages in CI * fix: only build core and math npm packages in CI * fix: exclude test files from CodeQL and fix string escaping security issue
This commit is contained in:
YHH
GitHub
38
packages/tools/sdk/module.json
Normal file
38
packages/tools/sdk/module.json
Normal file
@@ -0,0 +1,38 @@
|
||||
{
|
||||
"id": "sdk",
|
||||
"name": "@esengine/sdk",
|
||||
"globalKey": "sdk",
|
||||
"displayName": "Unified SDK",
|
||||
"outputPath": "dist/index.js",
|
||||
"description": "Unified SDK entry point - import everything from a single package | 统一 SDK 入口 - 从单个包导入所有内容",
|
||||
"version": "1.0.0",
|
||||
"category": "Core",
|
||||
"icon": "Package",
|
||||
"tags": ["sdk", "unified", "entry"],
|
||||
"isCore": true,
|
||||
"defaultEnabled": true,
|
||||
"isEngineModule": true,
|
||||
"canContainContent": false,
|
||||
"platforms": ["web", "desktop", "mobile"],
|
||||
"hasRuntime": true,
|
||||
"dependencies": [
|
||||
"@esengine/ecs-framework",
|
||||
"@esengine/ecs-framework-math",
|
||||
"@esengine/engine-core",
|
||||
"@esengine/sprite",
|
||||
"@esengine/fairygui",
|
||||
"@esengine/audio",
|
||||
"@esengine/camera",
|
||||
"@esengine/particle",
|
||||
"@esengine/physics-rapier2d",
|
||||
"@esengine/tilemap",
|
||||
"@esengine/behavior-tree",
|
||||
"@esengine/asset-system"
|
||||
],
|
||||
"exports": {
|
||||
"components": [],
|
||||
"systems": [],
|
||||
"other": ["*"]
|
||||
},
|
||||
"requiresWasm": false
|
||||
}
|
||||
53
packages/tools/sdk/package.json
Normal file
53
packages/tools/sdk/package.json
Normal file
@@ -0,0 +1,53 @@
|
||||
{
|
||||
"name": "@esengine/sdk",
|
||||
"version": "1.0.0",
|
||||
"description": "Unified SDK entry point for ESEngine - single import for all engine modules",
|
||||
"main": "dist/index.js",
|
||||
"module": "dist/index.js",
|
||||
"types": "dist/index.d.ts",
|
||||
"type": "module",
|
||||
"exports": {
|
||||
".": {
|
||||
"types": "./dist/index.d.ts",
|
||||
"import": "./dist/index.js"
|
||||
}
|
||||
},
|
||||
"files": [
|
||||
"dist"
|
||||
],
|
||||
"scripts": {
|
||||
"build": "tsup",
|
||||
"build:watch": "tsup --watch",
|
||||
"type-check": "tsc --noEmit",
|
||||
"clean": "rimraf dist"
|
||||
},
|
||||
"dependencies": {
|
||||
"@esengine/ecs-framework": "workspace:*",
|
||||
"@esengine/engine-core": "workspace:*",
|
||||
"@esengine/ecs-framework-math": "workspace:*",
|
||||
"@esengine/sprite": "workspace:*",
|
||||
"@esengine/fairygui": "workspace:*",
|
||||
"@esengine/audio": "workspace:*",
|
||||
"@esengine/camera": "workspace:*",
|
||||
"@esengine/particle": "workspace:*",
|
||||
"@esengine/physics-rapier2d": "workspace:*",
|
||||
"@esengine/tilemap": "workspace:*",
|
||||
"@esengine/behavior-tree": "workspace:*",
|
||||
"@esengine/asset-system": "workspace:*"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@esengine/build-config": "workspace:*",
|
||||
"rimraf": "^5.0.5",
|
||||
"tsup": "^8.0.0",
|
||||
"typescript": "^5.3.3"
|
||||
},
|
||||
"keywords": [
|
||||
"esengine",
|
||||
"sdk",
|
||||
"ecs",
|
||||
"game-engine",
|
||||
"unified-api"
|
||||
],
|
||||
"author": "yhh",
|
||||
"license": "MIT"
|
||||
}
|
||||
200
packages/tools/sdk/src/index.ts
Normal file
200
packages/tools/sdk/src/index.ts
Normal file
@@ -0,0 +1,200 @@
|
||||
/**
|
||||
* @esengine/sdk - 统一 SDK 入口
|
||||
*
|
||||
* Unified SDK entry point for user scripts.
|
||||
* 用户脚本的统一 SDK 入口。
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* // 统一导入所有引擎 API
|
||||
* // Unified import for all engine APIs
|
||||
* import { Component, Entity, Vector2, SpriteComponent } from '@esengine/sdk';
|
||||
* ```
|
||||
*
|
||||
* @packageDocumentation
|
||||
*/
|
||||
|
||||
// ============================================================================
|
||||
// Core ECS Framework (@esengine/ecs-framework)
|
||||
// 核心 ECS 框架
|
||||
// ============================================================================
|
||||
export * from '@esengine/ecs-framework';
|
||||
|
||||
// ============================================================================
|
||||
// Math Library (@esengine/ecs-framework-math)
|
||||
// 数学库
|
||||
// ============================================================================
|
||||
export * from '@esengine/ecs-framework-math';
|
||||
|
||||
// ============================================================================
|
||||
// Engine Core (@esengine/engine-core)
|
||||
// 引擎核心
|
||||
// ============================================================================
|
||||
export * from '@esengine/engine-core';
|
||||
|
||||
// ============================================================================
|
||||
// Sprite System (@esengine/sprite)
|
||||
// 精灵系统
|
||||
// ============================================================================
|
||||
export * from '@esengine/sprite';
|
||||
|
||||
// ============================================================================
|
||||
// FairyGUI System (@esengine/fairygui)
|
||||
// FairyGUI 系统
|
||||
// Note: Selective exports to avoid conflicts with ecs-framework and math
|
||||
// ============================================================================
|
||||
export {
|
||||
// ECS Integration
|
||||
FGUIComponent,
|
||||
FGUIRenderSystem,
|
||||
getFGUIRenderSystem,
|
||||
setFGUIRenderSystem,
|
||||
FGUIRuntimeModule,
|
||||
FGUIPlugin,
|
||||
// Core
|
||||
GObject,
|
||||
GComponent,
|
||||
GRoot,
|
||||
GGroup,
|
||||
Controller,
|
||||
Transition,
|
||||
UIConfig,
|
||||
getUIConfig,
|
||||
setUIConfig,
|
||||
UIObjectFactory,
|
||||
GObjectPool,
|
||||
DragDropManager,
|
||||
EScaleMode,
|
||||
EAlignMode,
|
||||
// Widgets
|
||||
GImage,
|
||||
GTextField,
|
||||
GGraph,
|
||||
GButton,
|
||||
GProgressBar,
|
||||
GSlider,
|
||||
GLoader,
|
||||
GList,
|
||||
GTextInput,
|
||||
EKeyboardType,
|
||||
PopupMenu,
|
||||
Window,
|
||||
// Package
|
||||
UIPackage,
|
||||
PackageItem,
|
||||
// Events
|
||||
EventDispatcher,
|
||||
FGUIEvents,
|
||||
// Render
|
||||
RenderCollector,
|
||||
RenderBridge,
|
||||
Canvas2DBackend,
|
||||
FGUIRenderDataProvider,
|
||||
createFGUIRenderDataProvider,
|
||||
// Tween
|
||||
GTween,
|
||||
GTweener,
|
||||
TweenManager,
|
||||
TweenValue,
|
||||
evaluateEase,
|
||||
// Asset
|
||||
FUIAssetLoader,
|
||||
fuiAssetLoader,
|
||||
// Field Types
|
||||
EButtonMode,
|
||||
EAutoSizeType,
|
||||
EAlignType,
|
||||
EVertAlignType,
|
||||
ELoaderFillType,
|
||||
EListLayoutType,
|
||||
EListSelectionMode,
|
||||
EOverflowType,
|
||||
EPackageItemType,
|
||||
EObjectType,
|
||||
EProgressTitleType,
|
||||
EScrollBarDisplayType,
|
||||
EScrollType,
|
||||
EFlipType,
|
||||
EChildrenRenderOrder,
|
||||
EGroupLayoutType,
|
||||
EPopupDirection,
|
||||
ERelationType,
|
||||
EFillMethod,
|
||||
EFillOrigin,
|
||||
EObjectPropID,
|
||||
EGearType,
|
||||
EEaseType,
|
||||
EBlendMode,
|
||||
ETransitionActionType,
|
||||
EGraphType,
|
||||
} from '@esengine/fairygui';
|
||||
|
||||
// Re-export conflicting types with FGUI prefix
|
||||
export {
|
||||
Timer as FGUITimer,
|
||||
Stage as FGUIStage,
|
||||
ServiceContainer as FGUIServiceContainer,
|
||||
Point as FGUIPoint,
|
||||
Rectangle as FGUIRectangle,
|
||||
} from '@esengine/fairygui';
|
||||
|
||||
export type {
|
||||
// FairyGUI types
|
||||
IFGUIComponentData,
|
||||
RenderSubmitCallback,
|
||||
ItemRenderer,
|
||||
ItemProvider,
|
||||
IUISource,
|
||||
TypedEventListener,
|
||||
EventListener,
|
||||
FGUIEventType,
|
||||
IEventContext,
|
||||
IInputEventData,
|
||||
IFUIAsset,
|
||||
IEngineRenderData,
|
||||
IFGUIRenderDataProvider,
|
||||
TextureResolverFn,
|
||||
TweenCallback,
|
||||
} from '@esengine/fairygui';
|
||||
|
||||
// ============================================================================
|
||||
// Audio System (@esengine/audio)
|
||||
// 音频系统
|
||||
// ============================================================================
|
||||
export * from '@esengine/audio';
|
||||
|
||||
// ============================================================================
|
||||
// Camera System (@esengine/camera)
|
||||
// 摄像机系统
|
||||
// ============================================================================
|
||||
export * from '@esengine/camera';
|
||||
|
||||
// ============================================================================
|
||||
// Particle System (@esengine/particle)
|
||||
// 粒子系统
|
||||
// ============================================================================
|
||||
export * from '@esengine/particle';
|
||||
|
||||
// ============================================================================
|
||||
// Physics 2D System (@esengine/physics-rapier2d)
|
||||
// 2D 物理系统
|
||||
// ============================================================================
|
||||
export * from '@esengine/physics-rapier2d';
|
||||
|
||||
// ============================================================================
|
||||
// Tilemap System (@esengine/tilemap)
|
||||
// 瓦片地图系统
|
||||
// ============================================================================
|
||||
export * from '@esengine/tilemap';
|
||||
|
||||
// ============================================================================
|
||||
// Behavior Tree System (@esengine/behavior-tree)
|
||||
// 行为树系统
|
||||
// ============================================================================
|
||||
export * from '@esengine/behavior-tree';
|
||||
|
||||
// ============================================================================
|
||||
// Asset System (@esengine/asset-system)
|
||||
// 资产系统
|
||||
// ============================================================================
|
||||
export * from '@esengine/asset-system';
|
||||
10
packages/tools/sdk/tsconfig.build.json
Normal file
10
packages/tools/sdk/tsconfig.build.json
Normal file
@@ -0,0 +1,10 @@
|
||||
{
|
||||
"extends": "./tsconfig.json",
|
||||
"compilerOptions": {
|
||||
"composite": false,
|
||||
"declaration": true,
|
||||
"declarationMap": true,
|
||||
"emitDeclarationOnly": false
|
||||
},
|
||||
"exclude": ["node_modules", "dist", "**/*.test.ts", "**/*.spec.ts"]
|
||||
}
|
||||
53
packages/tools/sdk/tsconfig.json
Normal file
53
packages/tools/sdk/tsconfig.json
Normal file
@@ -0,0 +1,53 @@
|
||||
{
|
||||
"extends": "../../../tsconfig.base.json",
|
||||
"compilerOptions": {
|
||||
"composite": true,
|
||||
"outDir": "./dist",
|
||||
"rootDir": "./src"
|
||||
},
|
||||
"include": [
|
||||
"src/**/*"
|
||||
],
|
||||
"exclude": [
|
||||
"node_modules",
|
||||
"dist"
|
||||
],
|
||||
"references": [
|
||||
{
|
||||
"path": "../../framework/core"
|
||||
},
|
||||
{
|
||||
"path": "../../engine/engine-core"
|
||||
},
|
||||
{
|
||||
"path": "../../framework/math"
|
||||
},
|
||||
{
|
||||
"path": "../../rendering/sprite"
|
||||
},
|
||||
{
|
||||
"path": "../../rendering/fairygui"
|
||||
},
|
||||
{
|
||||
"path": "../../rendering/audio"
|
||||
},
|
||||
{
|
||||
"path": "../../rendering/camera"
|
||||
},
|
||||
{
|
||||
"path": "../../rendering/particle"
|
||||
},
|
||||
{
|
||||
"path": "../../physics/physics-rapier2d"
|
||||
},
|
||||
{
|
||||
"path": "../../rendering/tilemap"
|
||||
},
|
||||
{
|
||||
"path": "../../framework/behavior-tree"
|
||||
},
|
||||
{
|
||||
"path": "../../engine/asset-system"
|
||||
}
|
||||
]
|
||||
}
|
||||
7
packages/tools/sdk/tsup.config.ts
Normal file
7
packages/tools/sdk/tsup.config.ts
Normal file
@@ -0,0 +1,7 @@
|
||||
import { defineConfig } from 'tsup';
|
||||
import { runtimeOnlyPreset } from '../../tools/build-config/src/presets/plugin-tsup';
|
||||
|
||||
export default defineConfig({
|
||||
...runtimeOnlyPreset(),
|
||||
tsconfig: 'tsconfig.build.json'
|
||||
});
|
||||
Reference in New Issue
Block a user