alemonjs 2.1.0-alpha.18 → 2.1.0-alpha.19

package/lib/app/event-middleware.d.ts

@@ -1,4 +1,4 @@
-import { OnMiddlewareReversalFunc } from '../typing/event/index.js';
+import { OnMiddlewareReversalFunc, OnMiddlewareReversalFuncBack } from '../typing/event/index.js';
 import '../global.js';
 
 /**
@@ -16,5 +16,13 @@ import '../global.js';
  * @returns
  */
 declare const onMiddleware: OnMiddlewareReversalFunc;
+/**
+ * 废弃，请使用 onMiddleware
+ * @deprecated
+ * @param select
+ * @param callback
+ * @returns
+ */
+declare const OnMiddleware: OnMiddlewareReversalFuncBack;
 
-export { onMiddleware };
+export { OnMiddleware, onMiddleware };

package/lib/app/event-middleware.js

@@ -29,5 +29,15 @@ const onMiddleware = (select, callback) => {
     throw new Error('Invalid select: select must be a string or object');
 };
 global.onMiddleware = onMiddleware;
+/**
+ * 废弃，请使用 onMiddleware
+ * @deprecated
+ * @param select
+ * @param callback
+ * @returns
+ */
+const OnMiddleware = (select, callback) => {
+    return onMiddleware(callback, select);
+};
 
-export { onMiddleware };
+export { OnMiddleware, onMiddleware };

package/lib/app/event-response.d.ts

@@ -1,4 +1,4 @@
-import { OnResponseReversalFunc } from '../typing/event/index.js';
+import { OnResponseReversalFunc, OnResponseReversalFuncBack } from '../typing/event/index.js';
 import '../global.js';
 
 /**
@@ -8,5 +8,13 @@ import '../global.js';
  * @returns 回调函数的执行结果
  */
 declare const onResponse: OnResponseReversalFunc;
+/**
+ * 废弃，请使用 onResponse
+ * @deprecated
+ * @param callback
+ * @param select
+ * @returns
+ */
+declare const OnResponse: OnResponseReversalFuncBack;
 
-export { onResponse };
+export { OnResponse, onResponse };

package/lib/app/event-response.js

@@ -8,5 +8,16 @@ const onResponse = (select, callback) => {
     return { current: callback, select };
 };
 global.onResponse = onResponse;
+/**
+ * 废弃，请使用 onResponse
+ * @deprecated
+ * @param callback
+ * @param select
+ * @returns
+ */
+const OnResponse = (callback, select) => {
+    return onResponse(select, callback);
+};
+global.OnResponse = OnResponse;
 
-export { onResponse };
+export { OnResponse, onResponse };

package/lib/app/hook-use-api.d.ts

@@ -55,6 +55,7 @@ declare const useChannel: <T extends EventKeys>(event: Events[T]) => readonly [{
 declare const useSend: <T extends EventKeys>(event: Events[T]) => (...val: DataEnums[]) => Promise<Result[]>;
 /**
  * 废弃，请使用 useMessage
+ * @deprecated
  * @param event
  * @returns
  */
@@ -74,6 +75,8 @@ declare const onSelects: <T extends EventKeys[] | EventKeys>(values: T) => T;
 /**
  * 废弃,请使用onSelects
  * @deprecated
+ * @param values
+ * @returns
  */
 declare const createSelects: <T extends EventKeys[] | EventKeys>(values: T) => T;
 /**

package/lib/app/hook-use-api.js

@@ -304,6 +304,7 @@ const useSend = (event) => {
 };
 /**
  * 废弃，请使用 useMessage
+ * @deprecated
  * @param event
  * @returns
  */
@@ -338,6 +339,8 @@ global.onSelects = onSelects;
 /**
  * 废弃,请使用onSelects
  * @deprecated
+ * @param values
+ * @returns
  */
 const createSelects = onSelects;
 /**

package/lib/app/hook-use-subscribe.d.ts

@@ -31,5 +31,22 @@ declare const useSubscribe: <T extends EventKeys>(event: Events[T], selects: T |
         choose: EventCycleEnum;
     }) => void;
 }[];
+/**
+ * 使用观察者模式订阅事件
+ * @param event
+ * @param selects
+ * @returns
+ * 废弃，请使用 useSubscribe
+ * @deprecated
+ */
+declare const useObserver: <T extends EventKeys>(event: Events[T], selects: T | T[]) => (((callback: Current<T>, keys: (keyof Events[T])[]) => {
+    selects: T[];
+    choose: EventCycleEnum;
+    id: string;
+}) | ((value: {
+    id: string;
+    selects: T[];
+    choose: EventCycleEnum;
+}) => void))[];
 
-export { useSubscribe };
+export { useObserver, useSubscribe };

package/lib/app/hook-use-subscribe.js

@@ -126,5 +126,17 @@ const useSubscribe = (event, selects) => {
     };
     return [subscribe];
 };
+/**
+ * 使用观察者模式订阅事件
+ * @param event
+ * @param selects
+ * @returns
+ * 废弃，请使用 useSubscribe
+ * @deprecated
+ */
+const useObserver = (event, selects) => {
+    const [sub] = useSubscribe(event, selects);
+    return [sub.mount, sub.cancel];
+};
 
-export { useSubscribe };
+export { useObserver, useSubscribe };

package/lib/app/message-api.d.ts

@@ -21,6 +21,15 @@ declare const createEventValue: <T extends keyof R, R extends BaseMap>(event: {
  * @throws {Error} - 如果 data 无效，抛出错误。
  */
 declare const format: OnDataFormatFunc;
+/**
+ * 创建数据格式。
+ * @param {...DataEnums[]} data - 要格式化的数据。
+ * @returns {DataEnums[]} - 返回格式化后的数据数组。
+ * @throws {Error} - 如果 data 无效，抛出错误。
+ * 废弃，请使用 format
+ * @deprecated
+ */
+declare const createDataFormat: OnDataFormatFunc;
 /**
  * 向指定频道发送消息。
  * @param {string} SpaceId - 空间ID，可能是服务器ID、频道ID、群ID、聊天ID，或者是复合ID。总之，是框架给指定空间的唯一标识。也就是说，不能使用ChannelId作为该参数。
@@ -36,4 +45,4 @@ declare const sendToChannel: (SpaceId: string, data: DataEnums[]) => Promise<Res
  */
 declare const sendToUser: (OpenID: string, data: DataEnums[]) => Promise<Result[]>;
 
-export { createEventValue, format, sendToChannel, sendToUser };
+export { createDataFormat, createEventValue, format, sendToChannel, sendToUser };

package/lib/app/message-api.js

@@ -27,6 +27,15 @@ const format = (...data) => {
     return data;
 };
 global.format = format;
+/**
+ * 创建数据格式。
+ * @param {...DataEnums[]} data - 要格式化的数据。
+ * @returns {DataEnums[]} - 返回格式化后的数据数组。
+ * @throws {Error} - 如果 data 无效，抛出错误。
+ * 废弃，请使用 format
+ * @deprecated
+ */
+const createDataFormat = format;
 /**
  * 向指定频道发送消息。
  * @param {string} SpaceId - 空间ID，可能是服务器ID、频道ID、群ID、聊天ID，或者是复合ID。总之，是框架给指定空间的唯一标识。也就是说，不能使用ChannelId作为该参数。
@@ -78,4 +87,4 @@ const sendToUser = async (OpenID, data) => {
     });
 };
 
-export { createEventValue, format, sendToChannel, sendToUser };
+export { createDataFormat, createEventValue, format, sendToChannel, sendToUser };

package/lib/global.d.ts

@@ -1,4 +1,4 @@
-import { OnResponseReversalFunc, OnMiddlewareReversalFunc, DefineChildrenFunc, OnSelectsFunc, OnDataFormatFunc } from './typing/event/index.js';
+import { OnResponseReversalFunc, OnResponseReversalFuncBack, OnMiddlewareReversalFunc, DefineChildrenFunc, OnSelectsFunc, OnDataFormatFunc } from './typing/event/index.js';
 import { StoreChildrenApp } from './typing/store/res.js';
 import { StateSubscribeMap, SubscribeKeysMap } from './typing/subscribe/index.js';
 import { LoggerUtils } from './typing/logger/index.js';
@@ -44,6 +44,11 @@ declare global {
      * 定义响应体
      */
     var onResponse: OnResponseReversalFunc;
+    /**
+     * 废弃，请使用 onResponse
+     * @deprecated
+     */
+    var OnResponse: OnResponseReversalFuncBack;
     /**
      * 定义中间件
      */

package/lib/index.d.ts

@@ -11,7 +11,7 @@ export { PublicEventMessageCreate, PublicEventMessageDelete, PublicEventMessageR
 export { PrivateEventMessageCreate, PrivateEventMessageDelete, PrivateEventMessageUpdate } from './typing/event/message/private.message.js';
 export { PrivateEventRequestFriendAdd, PrivateEventRequestGuildAdd } from './typing/event/request/index.js';
 export { ActionsEventEnum } from './typing/event/actions.js';
-export { Current, CurrentResult, CurrentResultValue, DefineChildrenCallback, DefineChildrenFunc, DefineChildrenValue, DefinePlatformCallback, DefinePlatformFunc, DefinePlatformValue, OnDataFormatFunc, OnMiddlewareFunc, OnMiddlewareReversalFunc, OnMiddlewareValue, OnResponseFunc, OnResponseReversalFunc, OnResponseValue, OnSelectsFunc } from './typing/event/index.js';
+export { Current, CurrentResult, CurrentResultValue, DefineChildrenCallback, DefineChildrenFunc, DefineChildrenValue, DefinePlatformCallback, DefinePlatformFunc, DefinePlatformValue, OnDataFormatFunc, OnMiddlewareFunc, OnMiddlewareReversalFunc, OnMiddlewareReversalFuncBack, OnMiddlewareValue, OnResponseFunc, OnResponseReversalFunc, OnResponseReversalFuncBack, OnResponseValue, OnSelectsFunc } from './typing/event/index.js';
 export { EventKeys, Events, EventsEnum, EventsMessageCreate, EventsMessageCreateEnum, EventsMessageCreateKeys } from './typing/event/map.js';
 export { LoggerUtils } from './typing/logger/index.js';
 export { ClientAPI, ClientAPIMessageResult } from './typing/client/index.js';
@@ -21,14 +21,14 @@ export { StateSubscribeMap, SubscribeKeysMap, SubscribeMap, SubscribeValue } fro
 export { core, logger } from './global.js';
 export { ConfigCore, getConfig, getConfigValue } from './core/config.js';
 export { defineChildren } from './app/define-chidren.js';
-export { onMiddleware } from './app/event-middleware.js';
+export { OnMiddleware, onMiddleware } from './app/event-middleware.js';
 export { OnProcessor, onProcessor } from './app/event-processor.js';
-export { onResponse } from './app/event-response.js';
+export { OnResponse, onResponse } from './app/event-response.js';
 export { createSelects, onSelects, unChildren, useChannel, useClient, useMenber, useMention, useMessage, useSend, useSends } from './app/hook-use-api.js';
 export { onState, unState, useState } from './app/hook-use-state.js';
-export { useSubscribe } from './app/hook-use-subscribe.js';
+export { useObserver, useSubscribe } from './app/hook-use-subscribe.js';
 export { loadChildren, loadChildrenFile } from './app/load.js';
-export { createEventValue, format, sendToChannel, sendToUser } from './app/message-api.js';
+export { createDataFormat, createEventValue, format, sendToChannel, sendToUser } from './app/message-api.js';
 export { Ark, BT, Image, ImageFile, ImageURL, Link, MD, Mention, Text } from './app/message-format.js';
 export { ChildrenApp, Core, Logger, Middleware, ProcessorEventAutoClearMap, ProcessorEventUserAudoClearMap, Response, State, StateSubscribe, SubscribeList } from './app/store.js';
 export { Result, createEventName, createHash, createResult, getInputExportPath, getRecursiveDirFiles, showErrorModule, stringToNumber, useUserHashKey } from './core/utils.js';

package/lib/index.js

@@ -2,14 +2,14 @@ export { ActionsEventEnum } from './typing/event/actions.js';
 export { core, logger } from './global.js';
 export { ConfigCore, getConfig, getConfigValue } from './core/config.js';
 export { defineChildren } from './app/define-chidren.js';
-export { onMiddleware } from './app/event-middleware.js';
+export { OnMiddleware, onMiddleware } from './app/event-middleware.js';
 export { OnProcessor, onProcessor } from './app/event-processor.js';
-export { onResponse } from './app/event-response.js';
+export { OnResponse, onResponse } from './app/event-response.js';
 export { createSelects, onSelects, unChildren, useChannel, useClient, useMenber, useMention, useMessage, useSend, useSends } from './app/hook-use-api.js';
 export { onState, unState, useState } from './app/hook-use-state.js';
-export { useSubscribe } from './app/hook-use-subscribe.js';
+export { useObserver, useSubscribe } from './app/hook-use-subscribe.js';
 export { loadChildren, loadChildrenFile } from './app/load.js';
-export { createEventValue, format, sendToChannel, sendToUser } from './app/message-api.js';
+export { createDataFormat, createEventValue, format, sendToChannel, sendToUser } from './app/message-api.js';
 export { Ark, BT, Image, ImageFile, ImageURL, Link, MD, Mention, Text } from './app/message-format.js';
 export { ChildrenApp, Core, Logger, Middleware, ProcessorEventAutoClearMap, ProcessorEventUserAudoClearMap, Response, State, StateSubscribe, SubscribeList } from './app/store.js';
 export { createEventName, createHash, createResult, getInputExportPath, getRecursiveDirFiles, showErrorModule, stringToNumber, useUserHashKey } from './core/utils.js';

package/lib/typing/event/index.d.ts

@@ -25,6 +25,11 @@ type OnResponseValue<C, T extends EventKeys> = {
  */
 type OnResponseFunc = <T extends EventKeys, C extends Current<T> | Current<T>[]>(callback: C, select: T | T[]) => OnResponseValue<C, T>;
 type OnResponseReversalFunc = <T extends EventKeys, C extends Current<T> | Current<T>[]>(select: T | T[], callback: C) => OnResponseValue<C, T>;
+/**
+ * 废弃
+ * @deprecated
+ */
+type OnResponseReversalFuncBack = <T extends EventKeys, C extends Current<T> | Current<T>[]>(callback: C, select: T | T[]) => OnResponseValue<C, T>;
 /**
  * 定义一个中间件
  */
@@ -33,6 +38,11 @@ type OnMiddlewareFunc = <T extends EventKeys, C extends Current<T> | Current<T>[
  *
  */
 type OnMiddlewareReversalFunc = <T extends EventKeys, C extends Current<T> | Current<T>[]>(select: T | T[], callback: C) => OnMiddlewareValue<C, T>;
+/**
+ * 废弃
+ * @deprecated
+ */
+type OnMiddlewareReversalFuncBack = <T extends EventKeys, C extends Current<T> | Current<T>[]>(callback: C, select: T | T[]) => OnMiddlewareValue<C, T>;
 /**
  *
  */
@@ -79,4 +89,4 @@ type OnSelectsFunc = <T extends EventKeys[] | EventKeys>(values: T) => T;
  */
 type OnDataFormatFunc = (...data: DataEnums[]) => DataEnums[];
 
-export type { Current, CurrentResult, CurrentResultValue, DefineChildrenCallback, DefineChildrenFunc, DefineChildrenValue, DefinePlatformCallback, DefinePlatformFunc, DefinePlatformValue, OnDataFormatFunc, OnMiddlewareFunc, OnMiddlewareReversalFunc, OnMiddlewareValue, OnResponseFunc, OnResponseReversalFunc, OnResponseValue, OnSelectsFunc };
+export type { Current, CurrentResult, CurrentResultValue, DefineChildrenCallback, DefineChildrenFunc, DefineChildrenValue, DefinePlatformCallback, DefinePlatformFunc, DefinePlatformValue, OnDataFormatFunc, OnMiddlewareFunc, OnMiddlewareReversalFunc, OnMiddlewareReversalFuncBack, OnMiddlewareValue, OnResponseFunc, OnResponseReversalFunc, OnResponseReversalFuncBack, OnResponseValue, OnSelectsFunc };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "alemonjs",
-  "version": "2.1.0-alpha.18",
+  "version": "2.1.0-alpha.19",
   "description": "bot script",
   "author": "lemonade",
   "license": "MIT",