alemonjs 2.1.0-alpha.2 → 2.1.0-alpha.21

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

@@ -1,7 +1,8 @@
 import { ResultCode } from '../core/code.js';
 import { ChildrenApp } from './store.js';
-import { createResult } from './utils.js';
+import { createResult } from '../core/utils.js';
 import { sendAction } from '../cbp/actions.js';
+import { sendAPI } from '../cbp/api.js';
 
 /**
  * 使用提及。
@@ -22,20 +23,16 @@ const useMention = (event) => {
         find: async (options) => {
             try {
                 if (!res) {
-                    const result = await sendAction({
+                    const results = await sendAction({
                         action: 'mention.get',
                         payload: {
                             event
                         }
                     });
-                    // mention 不能是 数组
-                    if (Array.isArray(result)) {
-                        return createResult(ResultCode.Ok, 'Successfully retrieved mention data', null);
+                    const result = results.find(item => item.code === ResultCode.Ok);
+                    if (result) {
+                        res = result.data;
                     }
-                    if (result.code !== ResultCode.Ok) {
-                        return createResult(result.code, result.message, null);
-                    }
-                    res = result.data;
                 }
             }
             catch (err) {
@@ -70,20 +67,16 @@ const useMention = (event) => {
         }) => {
             try {
                 if (!res) {
-                    const result = await sendAction({
+                    const results = await sendAction({
                         action: 'mention.get',
                         payload: {
                             event
                         }
                     });
-                    // mention 不能是 数组
-                    if (Array.isArray(result)) {
-                        return createResult(ResultCode.Ok, 'Successfully retrieved mention data', null);
-                    }
-                    if (result.code !== ResultCode.Ok) {
-                        return createResult(result.code, result.message, null);
+                    const result = results.find(item => item.code === ResultCode.Ok);
+                    if (result) {
+                        res = result.data;
                     }
-                    res = result.data;
                 }
             }
             catch (err) {
@@ -155,60 +148,60 @@ const useMessage = (event) => {
         });
         return Array.isArray(result) ? result : [result];
     };
-    /**
-     * 撤回消息
-     */
-    const withdraw = async (message_id) => {
-        return [createResult(ResultCode.Warn, '暂未支持', message_id)];
-    };
-    /**
-     * 转发消息
-     */
-    const forward = async (message_id) => {
-        return [createResult(ResultCode.Warn, '暂未支持', message_id)];
-    };
-    /**
-     * 回复 quote
-     * ***
-     * 和send区别在于，
-     * 如果对应的平台支持引用时，进行引用回复
-     */
-    const reply = async (message_id) => {
-        return [createResult(ResultCode.Warn, '暂未支持', message_id)];
-    };
-    /**
-     * 更新消息
-     */
-    const update = async (message_id) => {
-        return [createResult(ResultCode.Warn, '暂未支持', message_id)];
-    };
-    /**
-     * 置顶消息
-     */
-    const pinning = async (message_id) => {
-        return [createResult(ResultCode.Warn, '暂未支持', message_id)];
-    };
-    /**
-     * 警告消息
-     */
-    const horn = async (message_id) => {
-        return [createResult(ResultCode.Warn, '暂未支持', message_id)];
-    };
-    /**
-     * 表态
-     */
-    const reaction = async (message_id) => {
-        return [createResult(ResultCode.Warn, '暂未支持', message_id)];
-    };
+    // /**
+    //  * 撤回消息
+    //  */
+    // const withdraw = async (message_id?: string) => {
+    //   return [createResult(ResultCode.Warn, '暂未支持', message_id)]
+    // }
+    // /**
+    //  * 转发消息
+    //  */
+    // const forward = async (message_id?: string) => {
+    //   return [createResult(ResultCode.Warn, '暂未支持', message_id)]
+    // }
+    // /**
+    //  * 回复 quote
+    //  * ***
+    //  * 和send区别在于，
+    //  * 如果对应的平台支持引用时，进行引用回复
+    //  */
+    // const reply = async (message_id?: string) => {
+    //   return [createResult(ResultCode.Warn, '暂未支持', message_id)]
+    // }
+    // /**
+    //  * 更新消息
+    //  */
+    // const update = async (message_id?: string) => {
+    //   return [createResult(ResultCode.Warn, '暂未支持', message_id)]
+    // }
+    // /**
+    //  * 置顶消息
+    //  */
+    // const pinning = async (message_id?: string) => {
+    //   return [createResult(ResultCode.Warn, '暂未支持', message_id)]
+    // }
+    // /**
+    //  * 警告消息
+    //  */
+    // const horn = async (message_id?: string) => {
+    //   return [createResult(ResultCode.Warn, '暂未支持', message_id)]
+    // }
+    // /**
+    //  * 表态
+    //  */
+    // const reaction = async (message_id?: string) => {
+    //   return [createResult(ResultCode.Warn, '暂未支持', message_id)]
+    // }
     const message = {
-        send,
-        withdraw,
-        forward,
-        reply,
-        update,
-        pinning,
-        horn,
-        reaction
+        send
+        // withdraw,
+        // forward,
+        // reply,
+        // update,
+        // pinning,
+        // horn,
+        // reaction
     };
     return [message];
 };
@@ -227,43 +220,43 @@ const useMenber = (event) => {
         });
         throw new Error('Invalid event: event must be an object');
     }
-    /**
-     * 获取用户信息
-     * @param user_id
-     * @returns
-     */
-    const information = async (user_id) => {
-        return createResult(ResultCode.Warn, '暂未支持', user_id);
-    };
-    /**
-     * 禁言
-     * @param all 是否是全体
-     * @returns
-     */
-    const mute = async (all = false) => {
-        return createResult(ResultCode.Warn, '暂未支持', all);
-    };
-    /**
-     * 解除禁言
-     * @param all 是否是全体
-     * @returns
-     */
-    const unmute = async (all = false) => {
-        return createResult(ResultCode.Warn, '暂未支持', all);
-    };
-    /**
-     * 移除用户
-     * @param user_id
-     * @returns
-     */
-    const remove = async (user_id) => {
-        return createResult(ResultCode.Warn, '暂未支持', user_id);
-    };
+    // /**
+    //  * 获取用户信息
+    //  * @param user_id
+    //  * @returns
+    //  */
+    // const information = async (user_id?: string) => {
+    //   return createResult(ResultCode.Warn, '暂未支持', user_id)
+    // }
+    // /**
+    //  * 禁言
+    //  * @param all 是否是全体
+    //  * @returns
+    //  */
+    // const mute = async (all: boolean = false) => {
+    //   return createResult(ResultCode.Warn, '暂未支持', all)
+    // }
+    // /**
+    //  * 解除禁言
+    //  * @param all 是否是全体
+    //  * @returns
+    //  */
+    // const unmute = async (all: boolean = false) => {
+    //   return createResult(ResultCode.Warn, '暂未支持', all)
+    // }
+    // /**
+    //  * 移除用户
+    //  * @param user_id
+    //  * @returns
+    //  */
+    // const remove = async (user_id?: string) => {
+    //   return createResult(ResultCode.Warn, '暂未支持', user_id)
+    // }
     const member = {
-        information,
-        mute,
-        unmute,
-        remove
+    // information,
+    // mute,
+    // unmute,
+    // remove
     };
     return [member];
 };
@@ -282,17 +275,17 @@ const useChannel = (event) => {
         });
         throw new Error('Invalid event: event must be an object');
     }
-    // 退出
-    const exit = async (channel_id) => {
-        return createResult(ResultCode.Warn, '暂未支持', channel_id);
-    };
-    // 加入
-    const join = async (channel_id) => {
-        return createResult(ResultCode.Warn, '暂未支持', channel_id);
-    };
+    // // 退出
+    // const exit = async (channel_id?: string) => {
+    //   return createResult(ResultCode.Warn, '暂未支持', channel_id)
+    // }
+    // // 加入
+    // const join = async (channel_id?: string) => {
+    //   return createResult(ResultCode.Warn, '暂未支持', channel_id)
+    // }
     const channel = {
-        exit,
-        join
+    // exit,
+    // join
     };
     return [channel];
 };
@@ -311,6 +304,7 @@ const useSend = (event) => {
 };
 /**
  * 废弃，请使用 useMessage
+ * @deprecated
  * @param event
  * @returns
  */
@@ -345,7 +339,32 @@ global.onSelects = onSelects;
 /**
  * 废弃,请使用onSelects
  * @deprecated
+ * @param values
+ * @returns
  */
 const createSelects = onSelects;
+/**
+ * 使用客户端
+ * @param event
+ * @param _ApiClass
+ * @returns
+ */
+const useClient = (event, _ApiClass) => {
+    const client = new Proxy({}, {
+        get(_target, prop) {
+            return (...args) => {
+                return sendAPI({
+                    action: 'client.api',
+                    payload: {
+                        event,
+                        key: String(prop),
+                        params: args
+                    }
+                });
+            };
+        }
+    });
+    return [client];
+};
 
-export { createSelects, onSelects, unChildren, useChannel, useMenber, useMention, useMessage, useSend, useSends };
+export { createSelects, onSelects, unChildren, useChannel, useClient, useMenber, useMention, useMessage, useSend, useSends };

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

@@ -9,7 +9,7 @@ import '../global.js';
  * @param select
  * @returns
  */
-declare const useSubscribe: <T extends EventKeys>(event: Events[T], selects: T | T[]) => {
+declare const useSubscribe: <T extends EventKeys>(event: Events[T], selects: T | T[]) => readonly [{
     create: (callback: Current<T>, keys: (keyof Events[T])[]) => {
         selects: T[];
         choose: EventCycleEnum;
@@ -30,6 +30,23 @@ declare const useSubscribe: <T extends EventKeys>(event: Events[T], selects: 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[]) => readonly [(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 [subscribe] = useSubscribe(event, selects);
+    return [subscribe.mount, subscribe.cancel];
+};
 
-export { useSubscribe };
+export { useObserver, useSubscribe };

package/lib/app/load.js

@@ -1,6 +1,6 @@
 import { dirname, join } from 'path';
 import { existsSync } from 'fs';
-import { showErrorModule, getRecursiveDirFiles, createEventName } from './utils.js';
+import { showErrorModule, getRecursiveDirFiles, createEventName } from '../core/utils.js';
 import { createRequire } from 'module';
 import { ChildrenApp } from './store.js';
 import { ResultCode } from '../core/code.js';
@@ -51,7 +51,7 @@ const loadChildren = async (mainPath, appName) => {
             // 卸载
             App.un();
             try {
-                await app?.unMounted(e);
+                app?.unMounted && (await app.unMounted(e));
             }
             catch (e) {
                 // 卸载周期出意外，不需要进行卸载
@@ -59,15 +59,13 @@ const loadChildren = async (mainPath, appName) => {
             }
         };
         // onCreated 创建
-        if (typeof app?.onCreated == 'function') {
-            try {
-                await app?.onCreated();
-            }
-            catch (e) {
-                unMounted(e);
-                // 出错了，结束后续的操作。
-                return;
-            }
+        try {
+            app?.onCreated && (await app?.onCreated());
+        }
+        catch (e) {
+            unMounted(e);
+            // 出错了，结束后续的操作。
+            return;
         }
         // onMounted 加载
         try {
@@ -119,9 +117,7 @@ const loadChildren = async (mainPath, appName) => {
             App.pushMiddleware(mwData);
             App.on();
             try {
-                if (typeof app?.onMounted == 'function') {
-                    await app?.onMounted({ response: resData, middleware: mwData });
-                }
+                app?.onMounted && (await app.onMounted({ response: resData, middleware: mwData }));
             }
             catch (e) {
                 unMounted(e);

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

@@ -1,8 +1,19 @@
-import { Result } from './utils.js';
 import { OnDataFormatFunc } from '../typing/event/index.js';
-import '../global.js';
+import { Result } from '../core/utils.js';
 import { DataEnums } from '../typing/message/index.js';
+import '../global.js';
 
+type BaseMap = {
+    [key: string]: any;
+};
+/**
+ * 创建原生value映射
+ * @param event
+ * @returns
+ */
+declare const createEventValue: <T extends keyof R, R extends BaseMap>(event: {
+    value: R[T];
+}) => R[T] | undefined;
 /**
  * 创建数据格式。
  * @param {...DataEnums[]} data - 要格式化的数据。
@@ -10,19 +21,28 @@ import { DataEnums } from '../typing/message/index.js';
  * @throws {Error} - 如果 data 无效，抛出错误。
  */
 declare const format: OnDataFormatFunc;
+/**
+ * 创建数据格式。
+ * @param {...DataEnums[]} data - 要格式化的数据。
+ * @returns {DataEnums[]} - 返回格式化后的数据数组。
+ * @throws {Error} - 如果 data 无效，抛出错误。
+ * 废弃，请使用 format
+ * @deprecated
+ */
+declare const createDataFormat: OnDataFormatFunc;
 /**
  * 向指定频道发送消息。
- * @param {string} channel_id - 目标频道的 ID。
+ * @param {string} SpaceId - 空间ID，可能是服务器ID、频道ID、群ID、聊天ID，或者是复合ID。总之，是框架给指定空间的唯一标识。也就是说，不能使用ChannelId作为该参数。
  * @param {DataEnums[]} data - 要发送的数据。
- * @throws {Error} - 如果 channel_id 无效或发送失败，抛出错误。
+ * @throws {Error} - 如果 SpaceId 无效或发送失败，抛出错误。
  */
-declare const sendToChannel: (channel_id: string, data: DataEnums[]) => Promise<Result | Result[]>;
+declare const sendToChannel: (SpaceId: string, data: DataEnums[]) => Promise<Result[]>;
 /**
  * 向指定用户发送消息。
- * @param {string} user_id - 目标用户的 ID。
+ * @param {string} OpenID - 开放ID，可能是用户ID、聊天ID，或是复合ID。总之，是框架给指定用户的唯一标识。也就说，不能使用UserId作为该参数。
  * @param {DataEnums[]} data - 要发送的数据。
  * @throws {Error} - 如果 user_id 无效或发送失败，抛出错误。
  */
-declare const sendToUser: (user_id: string, data: DataEnums[]) => Promise<Result | Result[]>;
+declare const sendToUser: (OpenID: string, data: DataEnums[]) => Promise<Result[]>;
 
-export { format, sendToChannel, sendToUser };
+export { createDataFormat, createEventValue, format, sendToChannel, sendToUser };

package/lib/app/message-api.js

@@ -1,6 +1,14 @@
 import { ResultCode } from '../core/code.js';
 import { sendAction } from '../cbp/actions.js';
 
+/**
+ * 创建原生value映射
+ * @param event
+ * @returns
+ */
+const createEventValue = (event) => {
+    return event.value;
+};
 /**
  * 创建数据格式。
  * @param {...DataEnums[]} data - 要格式化的数据。
@@ -19,25 +27,34 @@ const format = (...data) => {
     return data;
 };
 global.format = format;
+/**
+ * 创建数据格式。
+ * @param {...DataEnums[]} data - 要格式化的数据。
+ * @returns {DataEnums[]} - 返回格式化后的数据数组。
+ * @throws {Error} - 如果 data 无效，抛出错误。
+ * 废弃，请使用 format
+ * @deprecated
+ */
+const createDataFormat = format;
 /**
  * 向指定频道发送消息。
- * @param {string} channel_id - 目标频道的 ID。
+ * @param {string} SpaceId - 空间ID，可能是服务器ID、频道ID、群ID、聊天ID，或者是复合ID。总之，是框架给指定空间的唯一标识。也就是说，不能使用ChannelId作为该参数。
  * @param {DataEnums[]} data - 要发送的数据。
- * @throws {Error} - 如果 channel_id 无效或发送失败，抛出错误。
+ * @throws {Error} - 如果 SpaceId 无效或发送失败，抛出错误。
  */
-const sendToChannel = async (channel_id, data) => {
-    if (!channel_id || typeof channel_id !== 'string') {
+const sendToChannel = async (SpaceId, data) => {
+    if (!SpaceId || typeof SpaceId !== 'string') {
         logger.error({
             code: ResultCode.FailParams,
-            message: 'Invalid channel_id: channel_id must be a string',
+            message: 'Invalid SpaceId: SpaceId must be a string',
             data: null
         });
-        throw new Error('Invalid channel_id: channel_id must be a string');
+        throw new Error('Invalid SpaceId: SpaceId must be a string');
     }
     return await sendAction({
         action: 'message.send.channel',
         payload: {
-            ChannelId: channel_id,
+            ChannelId: SpaceId,
             params: {
                 format: data
             }
@@ -46,23 +63,23 @@ const sendToChannel = async (channel_id, data) => {
 };
 /**
  * 向指定用户发送消息。
- * @param {string} user_id - 目标用户的 ID。
+ * @param {string} OpenID - 开放ID，可能是用户ID、聊天ID，或是复合ID。总之，是框架给指定用户的唯一标识。也就说，不能使用UserId作为该参数。
  * @param {DataEnums[]} data - 要发送的数据。
  * @throws {Error} - 如果 user_id 无效或发送失败，抛出错误。
  */
-const sendToUser = async (user_id, data) => {
-    if (!user_id || typeof user_id !== 'string') {
+const sendToUser = async (OpenID, data) => {
+    if (!OpenID || typeof OpenID !== 'string') {
         logger.error({
             code: ResultCode.FailParams,
-            message: 'Invalid user_id: user_id must be a string',
+            message: 'Invalid OpenID: OpenID must be a string',
             data: null
         });
-        throw new Error('Invalid user_id: user_id must be a string');
+        throw new Error('Invalid OpenID: OpenID must be a string');
     }
     return await sendAction({
         action: 'message.send.user',
         payload: {
-            UserId: user_id,
+            UserId: OpenID,
             params: {
                 format: data
             }
@@ -70,4 +87,4 @@ const sendToUser = async (user_id, data) => {
     });
 };
 
-export { format, sendToChannel, sendToUser };
+export { createDataFormat, createEventValue, format, sendToChannel, sendToUser };

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

@@ -1,7 +1,7 @@
 import '../global.js';
-import { DataButton, ButtonRow, DataButtonGroup } from '../typing/message/button.js';
+import { DataButton, ButtonRow, DataButtonGroup, DataButtonTemplate } from '../typing/message/button.js';
 import { DataArkListTip, DataArkListContent, DataArkList, DataArkListItem, DataArkCard, DataArkBigCard } from '../typing/message/ark.js';
-import { DataMarkDown, DataMarkdownTemplate, DataMarkdownText, DataMarkdownTitle, DataMarkdownSubtitle, DataMarkdownBold, DataMarkdownItalic, DataMarkdownItalicStar, DataMarkdownStrikethrough, DataMarkdownLink, DataMarkdownImage, DataMarkdownList, DataMarkdownListItem, DataMarkdownBlockquote, DataMarkdownDivider, DataMarkdownNewline } from '../typing/message/markdown.js';
+import { DataMarkDown, DataMarkdownTemplate, DataMarkdownText, DataMarkdownTitle, DataMarkdownSubtitle, DataMarkdownBold, DataMarkdownItalic, DataMarkdownItalicStar, DataMarkdownStrikethrough, DataMarkdownLink, DataMarkdownImage, DataMarkdownList, DataMarkdownListItem, DataMarkdownBlockquote, DataMarkdownDivider, DataMarkdownNewline, DataMarkdownCode } from '../typing/message/markdown.js';
 import { DataImage, DataImageURL, DataImageFile } from '../typing/message/image.js';
 import { DataText } from '../typing/message/text.js';
 import { DataMention } from '../typing/message/mention.js';
@@ -54,7 +54,7 @@ declare const Mention: (UserId?: DataMention["value"], options?: DataMention["op
 declare const BT: {
     (title: string, data: DataButton["options"]["data"], options?: Omit<DataButton["options"], "data">): DataButton;
     group(...rows: ButtonRow[]): DataButtonGroup;
-    template(value: DataButtonGroup["options"]["template_id"]): DataButtonGroup;
+    template(templateId: DataButtonTemplate["value"]): DataButtonTemplate;
     row(...buttons: DataButton[]): ButtonRow;
 };
 
@@ -101,15 +101,7 @@ declare const Ark: {
  */
 declare const MD: {
     (...values: DataMarkDown["value"]): DataMarkDown;
-    template(templateId: DataMarkdownTemplate["value"], params?: DataMarkdownTemplate["options"]["params"]): {
-        type: string;
-        value: string;
-        options: {
-            params: {
-                [key: string]: string;
-            };
-        };
-    };
+    template(templateId: DataMarkdownTemplate["value"], params?: DataMarkdownTemplate["options"]["params"]): DataMarkdownTemplate;
     text(text: string): DataMarkdownText;
     title(text: string): DataMarkdownTitle;
     subtitle(text: string): DataMarkdownSubtitle;
@@ -127,6 +119,7 @@ declare const MD: {
     blockquote(text: string): DataMarkdownBlockquote;
     divider(): DataMarkdownDivider;
     newline(value?: boolean): DataMarkdownNewline;
+    code(value: DataMarkdownCode["value"], options?: DataMarkdownCode["options"]): DataMarkdownCode;
 };
 
 export { Ark, BT, Image, ImageFile, ImageURL, Link, MD, Mention, Text };

package/lib/app/message-format.js

@@ -90,13 +90,15 @@ BT.group = function Group(...rows) {
         value: rows
     };
 };
-BT.template = function Template(value) {
+/**
+ * 创建一个按钮模板
+ * @param templateId  模板 ID
+ * @returns
+ */
+BT.template = function Template(templateId) {
     return {
-        type: 'BT.group',
-        value: [],
-        options: {
-            template_id: value
-        }
+        type: 'ButtonTemplate',
+        value: templateId
     };
 };
 BT.row = function Row(...buttons) {
@@ -191,7 +193,7 @@ const MD = (...values) => {
  */
 MD.template = (templateId, params) => {
     return {
-        type: 'MD.template',
+        type: 'MarkdownTemplate',
         value: templateId,
         options: {
             params
@@ -353,5 +355,12 @@ MD.newline = (value = false) => {
         value: value
     };
 };
+MD.code = (value, options) => {
+    return {
+        type: 'MD.code',
+        value: value,
+        options: options
+    };
+};
 
 export { Ark, BT, Image, ImageFile, ImageURL, Link, MD, Mention, Text };