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
@@ -0,0 +1,64 @@
|
||||
/**
|
||||
* Rapier2D 加载器配置
|
||||
* Rapier2D loader configuration
|
||||
*/
|
||||
|
||||
import type { WasmLibraryConfig } from '@esengine/platform-common';
|
||||
import { isEditorEnvironment } from '@esengine/platform-common';
|
||||
|
||||
/**
|
||||
* 获取 WASM 路径
|
||||
* Get WASM path based on environment
|
||||
*
|
||||
* Editor: engine/rapier2d/pkg/rapier_wasm2d_bg.wasm (deployed by vite build plugin)
|
||||
* Runtime: wasm/rapier_wasm2d_bg.wasm (deployed by game build)
|
||||
*/
|
||||
function getWasmPath(): string {
|
||||
const isEditor = isEditorEnvironment();
|
||||
// Editor uses dist/engine/rapier2d/pkg/ structure (from vite copy-engine-modules plugin)
|
||||
// 编辑器使用 dist/engine/rapier2d/pkg/ 结构（来自 vite copy-engine-modules 插件）
|
||||
const path = isEditor
|
||||
? 'engine/rapier2d/pkg/rapier_wasm2d_bg.wasm'
|
||||
: 'wasm/rapier_wasm2d_bg.wasm';
|
||||
|
||||
console.log(`[Rapier2D] isEditor=${isEditor}, wasmPath=${path}`);
|
||||
return path;
|
||||
}
|
||||
|
||||
/**
|
||||
* Rapier2D 加载器配置
|
||||
*
|
||||
* Web 平台：使用标准版（独立 WASM 文件）
|
||||
* 小游戏平台：使用独立 WASM 文件 + WXWebAssembly 加载
|
||||
*/
|
||||
export const Rapier2DLoaderConfig: WasmLibraryConfig = {
|
||||
name: 'Rapier2D',
|
||||
|
||||
web: {
|
||||
/**
|
||||
* WASM 文件路径
|
||||
* 编辑器: engine/rapier2d/pkg/rapier_wasm2d_bg.wasm
|
||||
* 运行时: wasm/rapier_wasm2d_bg.wasm
|
||||
*/
|
||||
get wasmPath(): string {
|
||||
return getWasmPath();
|
||||
}
|
||||
},
|
||||
|
||||
minigame: {
|
||||
/**
|
||||
* WASM 文件路径（相对于小游戏根目录）
|
||||
*/
|
||||
wasmPath: 'wasm/rapier_wasm2d_bg.wasm',
|
||||
|
||||
/**
|
||||
* iOS 微信小游戏需要 TextDecoder polyfill
|
||||
*/
|
||||
needsTextDecoderPolyfill: true,
|
||||
|
||||
/**
|
||||
* iOS 微信小游戏需要 TextEncoder polyfill
|
||||
*/
|
||||
needsTextEncoderPolyfill: true,
|
||||
}
|
||||
};
|
||||
@@ -0,0 +1,237 @@
|
||||
/**
|
||||
* 微信小游戏平台 Rapier2D 加载器
|
||||
*
|
||||
* 使用 WXWebAssembly 加载独立的 .wasm 文件
|
||||
*/
|
||||
|
||||
import type {
|
||||
IWasmLibraryLoader,
|
||||
WasmLibraryConfig,
|
||||
PlatformInfo
|
||||
} from '@esengine/platform-common';
|
||||
import {
|
||||
PlatformType,
|
||||
installTextDecoderPolyfill,
|
||||
installTextEncoderPolyfill
|
||||
} from '@esengine/platform-common';
|
||||
|
||||
/**
|
||||
* Rapier2D 模块类型
|
||||
*/
|
||||
type RapierModule = typeof import('@esengine/rapier2d');
|
||||
|
||||
/**
|
||||
* 微信小游戏 WASM API 类型声明
|
||||
*/
|
||||
declare const WXWebAssembly: {
|
||||
instantiate(
|
||||
path: string,
|
||||
imports?: WebAssembly.Imports
|
||||
): Promise<WebAssembly.Instance>;
|
||||
Memory: typeof WebAssembly.Memory;
|
||||
Table: typeof WebAssembly.Table;
|
||||
};
|
||||
|
||||
/**
|
||||
* 微信小游戏平台 Rapier2D 加载器
|
||||
*
|
||||
* 特殊处理：
|
||||
* 1. 安装 TextDecoder/TextEncoder polyfill
|
||||
* 2. 使用 WXWebAssembly 加载 .wasm 文件
|
||||
* 3. 临时替换全局 WebAssembly 对象
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* const loader = new WeChatRapier2DLoader(config);
|
||||
* if (loader.isSupported()) {
|
||||
* const RAPIER = await loader.load();
|
||||
* // 使用 RAPIER...
|
||||
* }
|
||||
* ```
|
||||
*/
|
||||
export class WeChatRapier2DLoader implements IWasmLibraryLoader<RapierModule> {
|
||||
private _config: WasmLibraryConfig;
|
||||
|
||||
/**
|
||||
* 创建微信小游戏平台 Rapier2D 加载器
|
||||
*
|
||||
* @param config - 加载器配置
|
||||
*/
|
||||
constructor(config: WasmLibraryConfig) {
|
||||
this._config = config;
|
||||
}
|
||||
|
||||
/**
|
||||
* 加载 Rapier2D 模块
|
||||
*
|
||||
* @returns 初始化完成的 Rapier2D 模块
|
||||
*/
|
||||
async load(): Promise<RapierModule> {
|
||||
console.log(`[${this._config.name}] 正在加载微信小游戏版本...`);
|
||||
|
||||
// 1. 安装必要的 polyfills
|
||||
this.installPolyfills();
|
||||
|
||||
// 2. 检查 WXWebAssembly 支持
|
||||
if (typeof WXWebAssembly === 'undefined') {
|
||||
throw new Error(
|
||||
`[${this._config.name}] 当前微信基础库版本不支持 WebAssembly，` +
|
||||
'请升级微信或使用更高版本的基础库'
|
||||
);
|
||||
}
|
||||
|
||||
// 3. 加载 Rapier2D
|
||||
const RAPIER = await this.loadRapierWithWXWasm();
|
||||
|
||||
console.log(`[${this._config.name}] 加载完成`);
|
||||
return RAPIER;
|
||||
}
|
||||
|
||||
/**
|
||||
* 安装必要的 polyfills
|
||||
*/
|
||||
private installPolyfills(): void {
|
||||
const config = this._config.minigame;
|
||||
|
||||
if (config?.needsTextDecoderPolyfill) {
|
||||
installTextDecoderPolyfill();
|
||||
}
|
||||
|
||||
if (config?.needsTextEncoderPolyfill) {
|
||||
installTextEncoderPolyfill();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 使用 WXWebAssembly 加载 Rapier2D
|
||||
*
|
||||
* 通过临时替换全局 WebAssembly 对象来使 Rapier2D 使用 WXWebAssembly
|
||||
*
|
||||
* @returns 初始化完成的 Rapier2D 模块
|
||||
*/
|
||||
private async loadRapierWithWXWasm(): Promise<RapierModule> {
|
||||
// 保存原始 WebAssembly 对象
|
||||
const originalWebAssembly = (globalThis as any).WebAssembly;
|
||||
|
||||
try {
|
||||
// 创建一个包装的 WebAssembly 对象
|
||||
// 让 Rapier2D 的初始化代码使用 WXWebAssembly
|
||||
(globalThis as any).WebAssembly = this.createWXWebAssemblyWrapper();
|
||||
|
||||
// 导入 Rapier2D 标准版
|
||||
const RAPIER = await import('@esengine/rapier2d');
|
||||
|
||||
// 初始化 WASM - 标准版需要提供 WASM 路径
|
||||
const wasmPath = this._config.minigame?.wasmPath || 'wasm/rapier_wasm2d_bg.wasm';
|
||||
await RAPIER.init(wasmPath);
|
||||
|
||||
return RAPIER;
|
||||
} finally {
|
||||
// 恢复原始 WebAssembly 对象
|
||||
if (originalWebAssembly) {
|
||||
(globalThis as any).WebAssembly = originalWebAssembly;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 创建 WXWebAssembly 包装器
|
||||
*
|
||||
* 将 WXWebAssembly 包装成与标准 WebAssembly API 兼容的形式
|
||||
*
|
||||
* @returns 包装后的 WebAssembly 对象
|
||||
*/
|
||||
private createWXWebAssemblyWrapper(): typeof WebAssembly {
|
||||
const wasmPath = this._config.minigame?.wasmPath || 'wasm/rapier2d_bg.wasm';
|
||||
|
||||
return {
|
||||
instantiate: async (
|
||||
bufferSource: BufferSource | WebAssembly.Module,
|
||||
imports?: WebAssembly.Imports
|
||||
): Promise<WebAssembly.WebAssemblyInstantiatedSource> => {
|
||||
// WXWebAssembly.instantiate 直接接受文件路径
|
||||
const instance = await WXWebAssembly.instantiate(wasmPath, imports);
|
||||
return {
|
||||
instance,
|
||||
module: {} as WebAssembly.Module
|
||||
};
|
||||
},
|
||||
|
||||
instantiateStreaming: async (
|
||||
response: Response | PromiseLike<Response>,
|
||||
imports?: WebAssembly.Imports
|
||||
): Promise<WebAssembly.WebAssemblyInstantiatedSource> => {
|
||||
// 微信不支持 streaming，直接使用 instantiate
|
||||
const instance = await WXWebAssembly.instantiate(wasmPath, imports);
|
||||
return {
|
||||
instance,
|
||||
module: {} as WebAssembly.Module
|
||||
};
|
||||
},
|
||||
|
||||
compile: async (bytes: BufferSource): Promise<WebAssembly.Module> => {
|
||||
// 微信小游戏不支持单独编译
|
||||
throw new Error('WXWebAssembly 不支持 compile 方法');
|
||||
},
|
||||
|
||||
compileStreaming: async (source: Response | PromiseLike<Response>): Promise<WebAssembly.Module> => {
|
||||
throw new Error('WXWebAssembly 不支持 compileStreaming 方法');
|
||||
},
|
||||
|
||||
validate: (bytes: BufferSource): boolean => {
|
||||
// 简单返回 true，实际验证在 instantiate 时进行
|
||||
return true;
|
||||
},
|
||||
|
||||
Memory: WXWebAssembly.Memory,
|
||||
Table: WXWebAssembly.Table,
|
||||
Global: (globalThis as any).WebAssembly?.Global,
|
||||
Tag: (globalThis as any).WebAssembly?.Tag,
|
||||
Exception: (globalThis as any).WebAssembly?.Exception,
|
||||
CompileError: (globalThis as any).WebAssembly?.CompileError || Error,
|
||||
LinkError: (globalThis as any).WebAssembly?.LinkError || Error,
|
||||
RuntimeError: (globalThis as any).WebAssembly?.RuntimeError || Error,
|
||||
} as unknown as typeof WebAssembly;
|
||||
}
|
||||
|
||||
/**
|
||||
* 检查是否支持 WXWebAssembly
|
||||
*
|
||||
* @returns 是否支持
|
||||
*/
|
||||
isSupported(): boolean {
|
||||
return typeof WXWebAssembly !== 'undefined';
|
||||
}
|
||||
|
||||
/**
|
||||
* 获取平台信息
|
||||
* Get platform information
|
||||
*/
|
||||
getPlatformInfo(): PlatformInfo {
|
||||
const needsPolyfills: string[] = [];
|
||||
|
||||
if (typeof globalThis.TextDecoder === 'undefined') {
|
||||
needsPolyfills.push('TextDecoder');
|
||||
}
|
||||
if (typeof globalThis.TextEncoder === 'undefined') {
|
||||
needsPolyfills.push('TextEncoder');
|
||||
}
|
||||
|
||||
return {
|
||||
type: PlatformType.WeChatMiniGame,
|
||||
supportsWasm: typeof WXWebAssembly !== 'undefined',
|
||||
supportsSharedArrayBuffer: false,
|
||||
needsPolyfills,
|
||||
isEditor: false // 微信小游戏不可能是编辑器环境 | WeChat cannot be editor
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* 获取加载器配置
|
||||
*
|
||||
* @returns 配置对象
|
||||
*/
|
||||
getConfig(): WasmLibraryConfig {
|
||||
return this._config;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,96 @@
|
||||
/**
|
||||
* Web 平台 Rapier2D 加载器
|
||||
*
|
||||
* 使用 @esengine/rapier2d 标准版（独立 WASM 文件）
|
||||
*/
|
||||
|
||||
import type {
|
||||
IWasmLibraryLoader,
|
||||
WasmLibraryConfig,
|
||||
PlatformInfo
|
||||
} from '@esengine/platform-common';
|
||||
import { PlatformType, isEditorEnvironment } from '@esengine/platform-common';
|
||||
|
||||
/**
|
||||
* Rapier2D 模块类型
|
||||
*/
|
||||
type RapierModule = typeof import('@esengine/rapier2d');
|
||||
|
||||
/**
|
||||
* Web 平台 Rapier2D 加载器
|
||||
*
|
||||
* 使用标准版，需要配置 WASM 路径
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* const loader = new WebRapier2DLoader(config);
|
||||
* if (loader.isSupported()) {
|
||||
* const RAPIER = await loader.load();
|
||||
* // 使用 RAPIER...
|
||||
* }
|
||||
* ```
|
||||
*/
|
||||
export class WebRapier2DLoader implements IWasmLibraryLoader<RapierModule> {
|
||||
private _config: WasmLibraryConfig;
|
||||
|
||||
/**
|
||||
* 创建 Web 平台 Rapier2D 加载器
|
||||
*
|
||||
* @param config - 加载器配置
|
||||
*/
|
||||
constructor(config: WasmLibraryConfig) {
|
||||
this._config = config;
|
||||
}
|
||||
|
||||
/**
|
||||
* 加载 Rapier2D 模块
|
||||
*
|
||||
* @returns 初始化完成的 Rapier2D 模块
|
||||
*/
|
||||
async load(): Promise<RapierModule> {
|
||||
console.log(`[${this._config.name}] 正在加载 Web 版本...`);
|
||||
|
||||
// 动态导入标准版
|
||||
const RAPIER = await import('@esengine/rapier2d');
|
||||
|
||||
// 初始化 WASM - 标准版需要提供 WASM 路径
|
||||
// 构建时 WASM 文件会被复制到 wasm/ 目录
|
||||
const wasmPath = this._config.web?.wasmPath || 'wasm/rapier_wasm2d_bg.wasm';
|
||||
await RAPIER.init(wasmPath);
|
||||
|
||||
console.log(`[${this._config.name}] 加载完成`);
|
||||
return RAPIER;
|
||||
}
|
||||
|
||||
/**
|
||||
* 检查是否支持 WebAssembly
|
||||
*
|
||||
* @returns 是否支持
|
||||
*/
|
||||
isSupported(): boolean {
|
||||
return typeof WebAssembly !== 'undefined';
|
||||
}
|
||||
|
||||
/**
|
||||
* 获取平台信息
|
||||
* Get platform information
|
||||
*/
|
||||
getPlatformInfo(): PlatformInfo {
|
||||
return {
|
||||
type: PlatformType.Web,
|
||||
supportsWasm: typeof WebAssembly !== 'undefined',
|
||||
supportsSharedArrayBuffer: typeof SharedArrayBuffer !== 'undefined',
|
||||
needsPolyfills: [],
|
||||
isEditor: isEditorEnvironment()
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* 获取加载器配置
|
||||
*
|
||||
* @returns 配置对象
|
||||
*/
|
||||
getConfig(): WasmLibraryConfig {
|
||||
return this._config;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,58 @@
|
||||
/**
|
||||
* Rapier2D 加载器
|
||||
*
|
||||
* 提供跨平台的 Rapier2D 物理引擎加载支持
|
||||
*/
|
||||
|
||||
export { Rapier2DLoaderConfig } from './Rapier2DLoaderConfig';
|
||||
export { WebRapier2DLoader } from './WebRapier2DLoader';
|
||||
export { WeChatRapier2DLoader } from './WeChatRapier2DLoader';
|
||||
|
||||
import { PlatformType, WasmLibraryLoaderFactory } from '@esengine/platform-common';
|
||||
import { Rapier2DLoaderConfig } from './Rapier2DLoaderConfig';
|
||||
import { WebRapier2DLoader } from './WebRapier2DLoader';
|
||||
import { WeChatRapier2DLoader } from './WeChatRapier2DLoader';
|
||||
|
||||
/**
|
||||
* 注册 Rapier2D 加载器到工厂
|
||||
*
|
||||
* 在模块加载时自动执行
|
||||
*/
|
||||
export function registerRapier2DLoaders(): void {
|
||||
// Web 平台加载器
|
||||
WasmLibraryLoaderFactory.registerLoader(
|
||||
'rapier2d',
|
||||
PlatformType.Web,
|
||||
() => new WebRapier2DLoader(Rapier2DLoaderConfig)
|
||||
);
|
||||
|
||||
// 微信小游戏平台加载器
|
||||
WasmLibraryLoaderFactory.registerLoader(
|
||||
'rapier2d',
|
||||
PlatformType.WeChatMiniGame,
|
||||
() => new WeChatRapier2DLoader(Rapier2DLoaderConfig)
|
||||
);
|
||||
|
||||
// 其他小游戏平台可以复用微信加载器（API 类似）
|
||||
// 如果需要特殊处理，可以创建专门的加载器
|
||||
WasmLibraryLoaderFactory.registerLoader(
|
||||
'rapier2d',
|
||||
PlatformType.ByteDanceMiniGame,
|
||||
() => new WeChatRapier2DLoader(Rapier2DLoaderConfig)
|
||||
);
|
||||
|
||||
WasmLibraryLoaderFactory.registerLoader(
|
||||
'rapier2d',
|
||||
PlatformType.AlipayMiniGame,
|
||||
() => new WeChatRapier2DLoader(Rapier2DLoaderConfig)
|
||||
);
|
||||
|
||||
WasmLibraryLoaderFactory.registerLoader(
|
||||
'rapier2d',
|
||||
PlatformType.BaiduMiniGame,
|
||||
() => new WeChatRapier2DLoader(Rapier2DLoaderConfig)
|
||||
);
|
||||
}
|
||||
|
||||
// 模块加载时自动注册
|
||||
registerRapier2DLoaders();
|
||||
Reference in New Issue
Block a user