sapdon 3.0.1 → 3.0.3

package/dist/oc/index.d.ts

@@ -0,0 +1,142 @@
+import * as _minecraft_server from '@minecraft/server';
+import { Entity, Player, InputButton } from '@minecraft/server';
+
+declare class Optional<T = any> {
+    private value;
+    static none<T>(): Optional<T>;
+    static some<T>(value: T): Optional<T>;
+    constructor(value: T);
+    unwrap(): T;
+    isEmpty(): boolean;
+    orElse(other: T): T;
+    use(fn: (v: T) => void, self?: any): boolean;
+}
+
+interface Component {
+    onTick(manager: ComponentManager, en: Optional<Entity>): void;
+    detach(manager: ComponentManager): void;
+    getManager(): ComponentManager;
+    getEntity(): Optional<Entity>;
+}
+interface BasicComponent extends Component {
+    onAttach(manager: ComponentManager): boolean | void | Promise<boolean | void>;
+    onDetach(manager: ComponentManager): void | Promise<void>;
+}
+declare const REFLECT_MANAGER: unique symbol;
+declare const REFLECT_ENTITY: unique symbol;
+declare class CustomComponent implements Component {
+    [REFLECT_MANAGER]?: ComponentManager;
+    [REFLECT_ENTITY]: Optional<Entity>;
+    onTick(manager: ComponentManager, en: Optional<Entity>): void;
+    detach(manager: ComponentManager): Promise<boolean>;
+    getManager(): ComponentManager;
+    getEntity(): Optional<Entity>;
+}
+declare class BaseComponent extends CustomComponent implements BasicComponent {
+    onAttach(manager: ComponentManager): boolean | void | Promise<boolean | void>;
+    onDetach(manager: ComponentManager): void | Promise<void>;
+}
+interface ComponentCtor<T extends Component | BasicComponent = Component> {
+    new (...args: any[]): T;
+}
+declare class ComponentManager {
+    #private;
+    static profilerEnable: boolean;
+    static readonly global: ComponentManager;
+    getComponentUnsafe(ctor: ComponentCtor): Component | undefined;
+    getComponent<T extends Component>(ctor: ComponentCtor<T>): Optional<T>;
+    getComponents(...ctor: ComponentCtor[]): (Component | undefined)[];
+    attachComponent(...component: Component[]): Promise<Optional<Component>[]>;
+    getOrCreate<T extends Component>(ctor: ComponentCtor<T>, ...args: any[]): Promise<Optional<T>>;
+    detachComponent(ctor: ComponentCtor): Promise<boolean>;
+    clear(): void;
+    getComponentKeys(): MapIterator<ComponentCtor<Component>>;
+    has(ctor: ComponentCtor): boolean;
+    afterTick(fn: (en: Optional<Entity>) => void): void;
+    beforeTick(fn: (en: Optional<Entity>) => void): void;
+    handleTicks(en: Entity): void;
+    update<T extends Component>(ctor: ComponentCtor<T>, fn: (component: T) => void): boolean;
+    profiler(fn: Function, component?: Component, name?: string): any;
+}
+type RequireComponentsParam = ComponentCtor | [ComponentCtor, ...any[]];
+declare const REQUIRED_COMPONENTS: unique symbol;
+interface RequiredComponent extends BasicComponent {
+    getComponent<T extends Component>(ctor: ComponentCtor): T;
+}
+declare function RequireComponents(...params: RequireComponentsParam[]): {
+    new (): {
+        getComponent<T extends Component>(ctor: ComponentCtor): T;
+        [REQUIRED_COMPONENTS]: Map<ComponentCtor<Component>, Component>;
+        onAttach(manager: ComponentManager): boolean | void | Promise<boolean | void>;
+        onDetach(manager: ComponentManager): void | Promise<void>;
+        onTick(manager: ComponentManager, en: Optional<Entity>): void;
+        detach(manager: ComponentManager): Promise<boolean>;
+        getManager(): ComponentManager;
+        getEntity(): Optional<Entity>;
+        [REFLECT_MANAGER]?: ComponentManager;
+        [REFLECT_ENTITY]: Optional<Entity>;
+    };
+};
+declare namespace oc {
+    function addEntity(entityId: string): ComponentManager;
+    function removeEntity(entityId: string): void;
+    function getManager(entityId: string): ComponentManager;
+    function tick(): void;
+    function start(): void;
+    function toPlayer(entity: Entity): Optional<Player>;
+}
+
+type ComponentDescriptor = string | ComponentCtor;
+declare class Actor {
+    readonly target: Entity;
+    readonly manager: ComponentManager;
+    constructor(target: Entity, manager: ComponentManager);
+    static from(target: Entity, manager: ComponentManager): Actor;
+    /**
+     * 优先使用 `Actor.getComponent`
+     * @param ctors
+     * @returns
+     */
+    getMinecraftComponent(...ids: string[]): (_minecraft_server.EntityComponent | undefined)[];
+    /**
+     * 优先使用 `Actor.getComponent`
+     * @param ctors
+     * @returns
+     */
+    getCustomComponent(...ctors: ComponentCtor[]): (Component | undefined)[];
+    getComponent<T extends readonly ComponentDescriptor[] | []>(...descs: T): {
+        -readonly [K in keyof T]: Component;
+    };
+    addComponent(...components: Component[]): Promise<Optional<Component>[]>;
+    removeComponent(ctor: ComponentCtor): Promise<boolean>;
+    updateComponent<T extends Component>(ctor: ComponentCtor<T>, fn: (component: T) => void): boolean;
+}
+
+declare enum InputChangeState {
+    Press = 0,
+    Release = 1,
+    None = 2
+}
+/**
+ * `@minecraft/server` version 2.0.0-beta
+ * 低于此版本请不要使用此组件
+ */
+declare class PlayerInputComponent extends BaseComponent {
+    [InputButton.Jump]: InputChangeState;
+    [InputButton.Sneak]: InputChangeState;
+    static setup(): void;
+}
+/**
+ * `@minecraft/server` version 1.17.0-beta
+ * 有 1tick 延迟
+ * 条件允许请使用 `PlayerInputComponent`
+ */
+declare class PlayerInputCompatibilityComponent extends BaseComponent {
+    [InputButton.Jump]: InputChangeState;
+    [InputButton.Sneak]: InputChangeState;
+    private _lastJump;
+    private _lastSneak;
+    onTick(manager: ComponentManager, en: Optional<Entity>): void;
+}
+
+export { Actor, BaseComponent, type BasicComponent, type Component, type ComponentCtor, type ComponentDescriptor, ComponentManager, CustomComponent, InputChangeState, Optional, PlayerInputCompatibilityComponent, PlayerInputComponent, RequireComponents, type RequiredComponent, oc };

package/dist/oc/index.js

@@ -0,0 +1 @@
+import{world as t,system as e,InputButton as n,ButtonState as s}from"@minecraft/server";class o{target;manager;constructor(t,e){this.target=t,this.manager=e}static from(t,e){return new o(t,e)}getMinecraftComponent(...t){return t.map((t=>this.target.getComponent(t)))}getCustomComponent(...t){return this.manager.getComponents(...t)}getComponent(...t){return t.map((t=>"string"==typeof t?this.target.getComponent(t):this.manager.getComponentUnsafe(t)))}addComponent(...t){return this.manager.attachComponent(...t)}removeComponent(t){return this.manager.detachComponent(t)}updateComponent(t,e){return this.manager.update(t,e)}}class r{value;static none(){return new r(null)}static some(t){return new r(t)}constructor(t){this.value=t}unwrap(){if(!this.isEmpty())return this.value;throw new Error("Optional is empty")}isEmpty(){return void 0===this.value||null===this.value}orElse(t){return this.value??t}use(t,e){return!this.isEmpty()&&(t.call(e,this.value),!0)}}const a=Symbol("reflect-manager"),i=Symbol("reflect-entity");class c{[a];[i]=r.none();onTick(t,e){}detach(t){const e=Object.getPrototypeOf(this).constructor;return t.detachComponent(e)}getManager(){return this[a]}getEntity(){return this[i]}}class p extends c{onAttach(t){}onDetach(t){}}class u{static profilerEnable=!1;static global=new u;#t=new Map;#e=[];#n=[];getComponentUnsafe(t){return this.#t.get(t)}getComponent(t){return r.some(this.#t.get(t))}getComponents(...t){return t.map((t=>this.#t.get(t)))}async#s(t,e,n=!0){let s=!this.#t.get(t);if(!s&&n&&(await this.detachComponent(t),s=!0),l in e)for(const[t,n]of e[l])this.#s(t,n,!1);return s&&"onAttach"in e&&await e.onAttach(this),this.#t.set(t,e),r.some(e)}async attachComponent(...t){const e=[];for(const n of t)e.push(await this.#s(Object.getPrototypeOf(n).constructor,n));return e}async getOrCreate(t,...e){let n=this.#t.get(t);return n?r.some(n):this.#s(t,new t(...e))}async detachComponent(t){const e=this.#t.get(t);return e&&"onDetach"in e&&await e.onDetach(this),this.#t.delete(t)}clear(){this.#t.clear()}getComponentKeys(){return this.#t.keys()}has(t){return this.#t.has(t)}afterTick(t){this.#n.push(t)}beforeTick(t){this.#e.unshift(t)}handleTicks(t){for(const e of this.#e)this.profiler((()=>e.call(null,r.some(t))));this.#e.length=0;for(const e of this.#t.values()){e[i]||(e[i]=r.some(t)),e[a]||(e[a]=this);const{onTick:n}=e;n&&this.profiler((()=>n.call(e,this,r.some(t))),e)}for(const e of this.#n)this.profiler((()=>e.call(null,r.some(t))));this.#n.length=0}update(t,e){const n=this.#t.get(t);return!!n&&(e(n),!0)}profiler(t,e,n){if(!u.profilerEnable)return t();const s=e?Object.getPrototypeOf(e).constructor.name:"",o=n||(s?`${s}.${t.name}`:t.name),r=performance.now(),a=t();return console.log(`[Profiler] ${o} took ${performance.now()-r}ms`),a}}const l=Symbol("REQUIRED_COMPONENTS");function h(...t){return class extends p{[l]=new Map;constructor(){super();for(const e of t)if(Array.isArray(e)){const[t,...n]=e;this[l].set(t,Reflect.construct(t,n))}else this[l].set(e,Reflect.construct(e,[]))}getComponent(t){return this[l].get(t)}}}var m,f;!function(n){const s=new Map;function o(t){const e=new u;return s.set(t,e),e}function a(){for(const[e,n]of s.entries()){const s=t.getEntity(e);s&&n.handleTicks(s)}}n.addEntity=o,n.removeEntity=function(t){const e=t,n=s.get(e);n?.clear(),s.delete(e)},n.getManager=function(t){return s.get(t)??o(t)},n.tick=a,n.start=function(){e.runInterval(a)},n.toPlayer=function(e){return r.some(t.getAllPlayers().find((t=>t.id===e.id)))}}(m||(m={})),function(t){t[t.Press=0]="Press",t[t.Release=1]="Release",t[t.None=2]="None"}(f||(f={}));class g extends p{[n.Jump]=f.None;[n.Sneak]=f.None;static setup(){t.afterEvents.playerButtonInput.subscribe((t=>{const e=m.getManager(t.player.id);e.getComponent(g).use((n=>{n[t.button]=t.newButtonState===s.Pressed?f.Press:f.Release,e.afterTick((()=>{n[t.button]=f.None}))}))}))}}class d extends p{[n.Jump]=f.None;[n.Sneak]=f.None;_lastJump=s.Released;_lastSneak=s.Released;onTick(t,e){const o=m.toPlayer(e.unwrap()).unwrap(),r=o.inputInfo.getButtonState(n.Jump),a=o.inputInfo.getButtonState(n.Sneak);r===s.Pressed&&this._lastJump===s.Released?this[n.Jump]=f.Press:r===s.Released&&this._lastJump===s.Pressed?this[n.Jump]=f.Release:this[n.Jump]=f.None,a===s.Pressed&&this._lastSneak===s.Released?this[n.Sneak]=f.Press:a===s.Released&&this._lastSneak===s.Pressed?this[n.Sneak]=f.Release:this[n.Sneak]=f.None,this._lastJump=r,this._lastSneak=a}}export{o as Actor,p as BaseComponent,u as ComponentManager,c as CustomComponent,f as InputChangeState,r as Optional,d as PlayerInputCompatibilityComponent,g as PlayerInputComponent,h as RequireComponents,m as oc};

package/doc/cli.md

@@ -0,0 +1,24 @@
+# `@sapdon/cli` 包
+
+## 自定义处理器
+```ts
+import { devServer } from '@sapdon/cli'
+devServer.handle('ping', () => {
+    console.log('pong')
+})
+```
+
+## 拦截cli处理器
+```ts
+import { devServer, ServerHandles } from '@sapdon/cli'
+
+devServer.interceptHandler(ServerHandles.WRITE_ADDON, handler => {
+    return (...args: any[]) => {
+        const now = peformance.now()
+        handler.apply(args)
+        const dt = peformance.now() - now
+        console.log(`执行耗时 ${dt}ms.`)
+    }
+})
+```
+

package/doc/sapdon-ts.md

@@ -1,16 +1,62 @@
 # sapdon with typescript
 在使用脚手架创建项目时，默认使用的语言将会是 `ts`
 
-但这并不意味着你需要手动去调整 tsconfig 和打包工具，我们提供了一套默认能用的ts设置，并深度集成在了 `@core` 包中
+但这并不意味着你需要手动去调整 tsconfig 和打包工具，我们提供了一套默认能用的ts设置
 
 ## 和 js 版本相比有什么区别？
-ts版本拥有更好的类型提示，更严格的类型检查，拥有paths的映射，也可以直接使用node_modules里的库（只能是纯js）
+ts版本拥有更好的类型提示，更严格的类型检查，也可以直接使用node_modules里的库（只能是js/ts）
 
 ## 听起来太酷了我们开始吧！
-比如我们需要注册一个物品，可能你会想去找它在哪，但在ts版本中，你只需要 `@core` 就可以了
+比如我们需要注册一个物品，可能你会想去找它在哪，但在ts版本中，你只需要 `@sapdon/core` 就可以了
 
 ```ts
-import { ItemAPI } from '@core/index.js'
+import { ItemAPI } from '@sapdon/core'
 ```
 
-如果你需要更高级的功能，比如你需要一个ts打包器，或者添加命令行的功能，你可以使用 `@cli`
+如果你需要更高级的功能，比如你需要一个ts打包器，或者添加命令行的功能，你可以使用 `@sapdon/cli`
+
+## 从js迁移到ts
+js 的 `main.mjs` 包含了一些预定义的代码：
+```js
+import { startDevServer } from '@sapdon/cli'
+import { GRegistry, UISystemRegistry } from '@sapdon/core'
+
+// 开启开发服务器, 不开启开发服务器无法使用文件同步和热更新
+startDevServer(GRegistry, UISystemRegistry)
+```
+如果需要从js迁移到ts，删除 `startDevServer` 那行即可（不删也没事）
+
+
+## OC (Object - Component)
+sapdon通过 `@sapdon/oc` 为sapi提供了一些高级功能, 比如:
+- 实体组件系统
+- 组件间通信
+
+传统的书写方式是通过事件和tick回调来实现功能, 而OC提供了更适合游戏的组件化开发方式
+
+```ts
+import { world, system } from '@minecraft/server'
+import { oc, CustomComponent } from '@sapdon/oc'
+
+world.afterEvents.worldInitialize.subscribe(oc.start)
+
+class MyComponent extends CustomComponent {
+    onTick() {
+        world.sendMessage('tick')
+    }
+}
+```
+
+是的, 我们得到了一个MyComponent, 它每刻都会给玩家发送 'tick'
+但是如果你进入游戏, 会发现它毫无作用, 没错! 因为我们还没有把它到绑定在实体身上!
+
+```ts
+const manager = oc.addEntity(id)
+manager.attachComponent(new MyComponent())
+```
+
+这样就可以了, 我们已经把MyComponent绑定到了entityId为id的实体身上
+
+你也可以动态增删改查组件! 这很方便!
+
+如果你想看它到底是怎么回事,可以从 `examples/oc-core` 开始了解

package/package.json

@@ -1,13 +1,9 @@
 {
     "name": "sapdon",
-    "version": "3.0.1",
-    "main": "dist/core/index.js",
-    "types": "dist/core/index.d.ts",
+    "version": "3.0.3",
     "scripts": {
-        "sapdon": "node dist/cli/index.js",
-        "create": "node dist/cli/index.js create",
-        "build": "node dist/cli/index.js build",
-        "dist": "tsc"
+        "build": "rollup -c",
+        "pub": "rollup -c && npm publish"
     },
     "keywords": [
         "bedrock",
@@ -22,15 +18,17 @@
     },
     "description": "Sapdon is a Node.js toolkit designed for building Bedrock Edition Minecraft addon packs.",
     "devDependencies": {
-        "@minecraft/server": "^1.17.0",
+        "@minecraft/server": "^2.0.0-beta.1.21.80-preview.20",
         "@minecraft/server-ui": "^1.3.0",
         "@rollup/plugin-commonjs": "^28.0.2",
         "@rollup/plugin-json": "^6.1.0",
         "@rollup/plugin-node-resolve": "^16.0.0",
+        "@rollup/plugin-terser": "^0.4.4",
         "@rollup/plugin-typescript": "^12.1.2",
         "@types/lodash": "^4.17.16",
         "@types/node": "^22.13.8",
         "rollup": "^4.30.1",
+        "rollup-plugin-dts": "^6.1.1",
         "rollup-plugin-typescript-paths": "^1.5.0",
         "rollup-plugin-typescript2": "^0.36.0",
         "rollup-plugin-visualizer": "^5.14.0",