feat: add FastMessage type

Author: zhangfisher

docs/zh/guide/use/typescript.md

@@ -64,6 +64,66 @@ declare module 'fastevent' {
 }
 ```
 
+
+## 消息类型
+
+`FastEvent`监听器接收到的是`FastEventMessage`类型，该类型具有类型推断能力。
+
+
+```ts twoslash
+import { FastEvent } from 'fastevent';
+
+type CustomEvents = {
+    click: { x: number; y: number };
+    mousemove: boolean;
+    scroll: number;
+    focus: string;
+};
+const emitter = new FastEvent<CustomEvents>();
+
+emitter.on('click', (message) => {
+    type MessageType = typeof message;
+    message.type; // 'click'
+    message.payload; // { x: number; y: number }
+});
+
+```
+
+`FastEvent`还额外提供了一个`FastMessage`类型用于不需要类型约束的场景。
+
+```ts twoslash
+import { FastEvent,FastMessage } from 'fastevent';
+
+type CustomEvents = {
+    click: { x: number; y: number };
+    mousemove: boolean;
+    scroll: number;
+    focus: string;
+};
+const emitter = new FastEvent<CustomEvents>(); 
+
+// 构建类型推断和约束的消息
+type MessageType = typeof emitter.types.message
+const typedMessage:MessageType = {
+    type:"click",
+    payload: {
+        x:100,
+        y:100
+    }
+}
+// 构建通用的消息
+const message:FastMessage = {
+    type:"click",
+    payload: 100
+}
+emitter.emit(message)
+
+emitter.on('click', (message) => {
+
+})
+
+```
+
 ## 元数据类型
 
 **`FastEvent`可以能自动推断全局元数据类型。**
@@ -191,6 +251,7 @@ const emitter = new FastEvent<CustomEvents, CustomMeta, CustomContext>({
 type EventType = typeof emitter.types.events;
 type MetaType = typeof emitter.types.meta;
 type ContextType = typeof emitter.types.context;
+type MessageType = typeof emitter.types.message;
 
 ```
 

packages/native/src/__tests__/meta.test.ts

@@ -2,6 +2,16 @@ import { describe, test, expect } from "vitest"
 import { FastEvent } from "../event"
 
 describe("传递Meta数据", async () => {
+    test("没有meta数据", () => {
+        const emitter = new FastEvent()
+        emitter.on("x", ({ payload, type, meta }, args) => {
+            expect(type).toBe("x")
+            expect(payload).toBe(1)
+            expect(meta).toBeUndefined()
+            expect(args.meta).toBeUndefined()
+        })
+        emitter.emit("x", 1)
+    })
     test("全局meta数据", () => {
         const emitter = new FastEvent({
             meta: { a: 1 }

packages/native/src/__tests__/types/emit.types.test.ts

@@ -3,6 +3,7 @@ import { describe, test, expect } from "vitest"
 import type { Equal, Expect, NotAny } from '@type-challenges/utils'
 import { FastEvent } from "../../event"
 import { FastEventScopeMeta } from "../../scope"
+import { FastMessage } from "../../types"
 
 describe("emit类型系统测试", () => {
     interface CustomEvents {

packages/native/src/__tests__/types/scope.types.test.ts

@@ -4,7 +4,7 @@ import { describe, test, expect } from "vitest"
 import type { Equal, Expect, NotAny } from '@type-challenges/utils'
 import { FastEvent } from "../../event"
 import { FastEventScope, FastEventScopeMeta, FastEventScopeOptions } from "../../scope"
-import { ChangeFieldType, FastEventMeta, FastEventOptions, FastEvents, PickScopeEvents, RequiredItems } from "../../types"
+import { ChangeFieldType, FastEventMeta, FastEventOptions, FastEvents, FastMessage, PickScopeEvents, RequiredItems } from "../../types"
 
 declare module "../../types" {
     interface FastEventMeta {
@@ -38,6 +38,7 @@ describe("事件作用域类型测试", () => {
         })
 
 
+
     })
     test("scope事件类型测试", () => {
         type CustomScopeEvents = {

packages/native/src/__tests__/types/types.test.ts

@@ -3,7 +3,7 @@
 import { describe, test, expect } from "vitest"
 import type { Equal, Expect } from '@type-challenges/utils'
 import { FastEvent } from "../../event"
-import { FastEvents } from "../../types"
+import { FastEvents, FastMessage } from "../../types"
 
 
 describe("types", () => {
@@ -39,7 +39,49 @@ describe("types", () => {
             Expect<Equal<typeof emitter.types.context, CustomContext>>,
         ]
     })
+    test("消息类型约束", () => {
 
+        type CustomEvents = {
+            click: { x: number; y: number };
+            mousemove: boolean;
+            scroll: number;
+            focus: string;
+        };
+        const emitter = new FastEvent<CustomEvents>();
+
+        // 构建类型推断和约束的消息
+        type MessageType = typeof emitter.types.message
+        const typedMessage: MessageType = {
+            type: "click",
+            payload: {
+                x: 100,
+                y: 100
+            },
+            meta: {} as any
+        }
+
+
+        emitter.emit({
+            type: "click",
+            payload: {
+                x: 100,
+                y: 100
+            }
+        })
+
+
+
+        // 构建通用的消息
+        const message: FastMessage = {
+            type: "click",
+            payload: 100
+        }
+        emitter.emit(message)
+
+        emitter.on('click', (message) => {
+
+        })
+    })
 })
 
 

packages/native/src/event.ts

@@ -16,7 +16,8 @@ import {
     DeepPartial,
     FastEventMeta,
     Expand,
-    Dict
+    Dict,
+    OptionalItems
 } from './types';
 import { parseEmitArgs } from './utils/parseEmitArgs';
 import { isPathMatched } from './utils/isPathMatched';
@@ -68,7 +69,8 @@ export class FastEvent<
     types = {
         events: undefined as unknown as AllEvents,
         meta: undefined as unknown as Expand<FastEventMeta & Meta & Record<string, any>>,
-        context: undefined as unknown as Expand<Fallback<Context, typeof this>>
+        context: undefined as unknown as Expand<Fallback<Context, typeof this>>,
+        message: undefined as unknown as FastEventMessage<AllEvents, Expand<FastEventMeta & Meta & Record<string, any>>>
     }
 
     /**

packages/native/src/scope.ts

@@ -30,7 +30,8 @@ export class FastEventScope<
     types = {
         events: undefined as unknown as Events,
         meta: undefined as unknown as FinalMeta,
-        context: undefined as unknown as Fallback<Context, typeof this>
+        context: undefined as unknown as Fallback<Context, typeof this>,
+        message: undefined as unknown as FastEventMessage<Events, FinalMeta>
     }
     prefix: string = ''
     emitter!: FastEvent<Events>

packages/native/src/types.ts

@@ -10,6 +10,13 @@ export interface FaseEventMessageExtends {
 export interface FastEventMeta {
 
 }
+
+export type FastMessage<P = any> = {
+    type: string
+    payload: P
+    meta?: Record<string, any>
+}
+
 export type FastEventMessage<
     Events extends Record<string, any> = Record<string, any>,
     M = any