alemonjs 2.1.41 → 2.1.43

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

@@ -0,0 +1,143 @@
+import { ResultCode } from '../../core/variable.js';
+import { SubscribeList } from '../../store/store.js';
+import { SubscribeStatus } from '../config.js';
+
+/**
+ * 订阅事件
+ * @param event
+ * @param select
+ * @returns
+ */
+const useSubscribe = (event, selects) => {
+    // 检查参数
+    if (typeof event !== 'object') {
+        logger.error({
+            code: ResultCode.FailParams,
+            message: 'event is not object',
+            data: null
+        });
+        throw new Error('event is not object');
+    }
+    if (typeof selects !== 'string' && !Array.isArray(selects)) {
+        logger.error({
+            code: ResultCode.FailParams,
+            message: 'select is not string or array',
+            data: null
+        });
+        throw new Error('select is not string or array');
+    }
+    /**
+     * 运行订阅
+     * @param callback
+     * @param keys
+     * @param choose
+     * @returns
+     */
+    const register = (callback, keys, choose) => {
+        const curSelects = Array.isArray(selects) ? selects : [selects];
+        // 分配id
+        const ID = Date.now().toString(36) + Math.random().toString(36).substring(2, 15);
+        // 没有选择任何 key，无法绑定订阅
+        if (keys.length === 0) {
+            logger.warn({
+                code: ResultCode.FailParams,
+                message: 'subscribe keys is empty',
+                data: null
+            });
+            return { selects: curSelects, choose, id: ID };
+        }
+        // 创建 订阅 列表
+        for (const select of curSelects) {
+            const subList = new SubscribeList(choose, select);
+            // 只能选择基础数据类型的key
+            const values = {};
+            for (const key of keys) {
+                if (typeof key === 'string' && (typeof event[key] === 'string' || typeof event[key] === 'number' || typeof event[key] === 'boolean')) {
+                    values[key] = event[key];
+                }
+                else {
+                    logger.warn({
+                        code: ResultCode.FailParams,
+                        message: `Invalid key: ${key?.toString()} must be a string, number or boolean`,
+                        data: null
+                    });
+                }
+            }
+            subList.value.append({
+                choose,
+                selects: curSelects,
+                keys: values,
+                current: callback,
+                status: SubscribeStatus.active,
+                id: ID
+            });
+        }
+        return {
+            selects: curSelects,
+            choose,
+            id: ID
+        };
+    };
+    /**
+     * res 创建时 运行订阅
+     * @param callback
+     * @param keys
+     */
+    const create = (callback, keys) => {
+        return register(callback, keys, 'create');
+    };
+    /**
+     * res 挂载时 运行订阅
+     * @param callback
+     * @param keys
+     */
+    const mountBefore = (callback, keys) => {
+        return register(callback, keys, 'mount');
+    };
+    /**
+     * res 卸载时 运行订阅
+     * @param callback
+     * @param keys
+     */
+    const unmount = (callback, keys) => {
+        return register(callback, keys, 'unmount');
+    };
+    /**
+     * 清除订阅
+     * @param id
+     */
+    const cancel = (value) => {
+        const selects = value.selects;
+        const ID = value.id; // 订阅的 ID
+        for (const select of selects) {
+            const subList = new SubscribeList(value.choose, select);
+            subList.value.forEach(node => {
+                if (node.data.id === ID) {
+                    node.data.status = SubscribeStatus.paused; // 标记为已暂停
+                    return true; // break
+                }
+            });
+        }
+    };
+    const subscribe = {
+        create,
+        mount: mountBefore,
+        unmount,
+        cancel
+    };
+    return [subscribe];
+};
+/**
+ * 使用观察者模式订阅事件
+ * @param event
+ * @param selects
+ * @returns
+ * 废弃，请使用 useSubscribe
+ * @deprecated
+ */
+const useObserver = (event, selects) => {
+    const [subscribe] = useSubscribe(event, selects);
+    return [subscribe.mount, subscribe.cancel];
+};
+
+export { useObserver, useSubscribe };

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

@@ -19,9 +19,8 @@ export declare const useMention: <T extends EventKeys>(event: Events[T]) => [{
 export declare const useMessage: <T extends EventKeys>(event: Events[T]) => readonly [{
     send(params?: {
         format: Format | DataEnums[];
-    } | DataEnums[], param2?: {
         replyId?: string;
-    }): Promise<Result[]>;
+    } | DataEnums[]): Promise<Result[]>;
 }];
 export declare const useMember: <T extends EventKeys>(event: Events[T]) => readonly [{
     information: (params: {
@@ -32,7 +31,6 @@ export declare const useChannel: <T extends EventKeys>(event: Events[T]) => read
 export declare const useSend: <T extends EventKeys>(event: Events[T]) => (...val: DataEnums[]) => Promise<Result[]>;
 export declare const useSends: <T extends EventKeys>(event: Events[T]) => readonly [(params?: DataEnums[] | {
     format: Format | DataEnums[];
-}, param2?: {
     replyId?: string;
 }) => Promise<Result[]>];
 export declare const unChildren: (name?: string) => void;

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

@@ -125,11 +125,11 @@ const useMessage = (event) => {
         return Array.isArray(result) ? result : [result];
     };
     const lightweight = {
-        send(params, param2) {
+        send(params) {
             if (Array.isArray(params)) {
-                return sendRaw(params.length > 0 ? params : [], param2?.replyId ?? event.MessageId);
+                return sendRaw(params.length > 0 ? params : []);
             }
-            return sendRaw(resolveFormat(params), param2?.replyId ?? event.MessageId);
+            return sendRaw(resolveFormat(params), params?.replyId ?? event.MessageId);
         }
     };
     return [lightweight];

package/lib/app/index.js

@@ -17,6 +17,6 @@ export { expendSubscribe, expendSubscribeCreate, expendSubscribeMount, expendSub
 export { createSelects, onSelects, unChildren, useChannel, useClient, useMe, useMember, useMention, useMessage, useSend, useSends } from './hook-use-api.js';
 export { onState, unState, useState } from './hook-use-state.js';
 export { useObserver, useSubscribe } from './hook-use-subscribe.js';
-export { createDataFormat, createEventValue, format, getMessageIntent, sendToChannel, sendToUser } from './message-api.js';
+export { MessageDirect, createDataFormat, createEventValue, format, getMessageIntent, sendToChannel, sendToUser } from './message-api.js';
 export { Format, FormatButtonGroup, FormatMarkDown, createEvent } from './message-format.js';
 export { Attachment, Audio, BT, Button, Image, ImageFile, ImageURL, Link, MD, Markdown, MarkdownOriginal, Mention, Text, Video } from './message-format-old.js';

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

@@ -0,0 +1,69 @@
+import { DataEnums, OnDataFormatFunc } from '../../types';
+import { Result } from '../../core/utils';
+type BaseMap = {
+    [key: string]: unknown;
+};
+/**
+ * 创建原生value映射
+ * @param event
+ * @returns
+ */
+export declare const createEventValue: <T extends keyof R, R extends BaseMap>(event: {
+    value: R[T];
+}) => R[T];
+/**
+ * 创建数据格式。
+ * @param {...DataEnums[]} data - 要格式化的数据。
+ * @returns {DataEnums[]} - 返回格式化后的数据数组。
+ * @throws {Error} - 如果 data 无效，抛出错误。
+ */
+export declare const format: OnDataFormatFunc;
+/**
+ * 创建数据格式。
+ * @param {...DataEnums[]} data - 要格式化的数据。
+ * @returns {DataEnums[]} - 返回格式化后的数据数组。
+ * @throws {Error} - 如果 data 无效，抛出错误。
+ * 废弃，请使用 format
+ * @deprecated
+ */
+export declare const createDataFormat: OnDataFormatFunc;
+/**
+ * 向指定频道发送消息。
+ * @param {string} SpaceId - 空间ID，可能是服务器ID、频道ID、群ID、聊天ID，或者是复合ID。总之，是框架给指定空间的唯一标识。也就是说，不能使用ChannelId作为该参数。
+ * @param {DataEnums[]} data - 要发送的数据。
+ * @throws {Error} - 如果 SpaceId 无效或发送失败，抛出错误。
+ */
+export declare const sendToChannel: (SpaceId: string, data: DataEnums[]) => Promise<Result[]>;
+/**
+ * 向指定用户发送消息。
+ * @param {string} OpenID - 开放ID，可能是用户ID、聊天ID，或是复合ID。总之，是框架给指定用户的唯一标识。也就说，不能使用UserId作为该参数。
+ * @param {DataEnums[]} data - 要发送的数据。
+ * @throws {Error} - 如果 user_id 无效或发送失败，抛出错误。
+ */
+export declare const sendToUser: (OpenID: string, data: DataEnums[]) => Promise<Result[]>;
+type IntentResult = {
+    [key: string]: boolean | number;
+    maxImageCount?: number;
+    maxImageSize?: number;
+    maxTextLength?: number;
+    maxMarkdownLength?: number;
+    allowMarkdownLink?: boolean;
+    allowMarkdownImage?: boolean;
+    allowMarkdownMention?: boolean;
+    maxFileCount?: number;
+    maxFileSize?: number;
+    maxVideoCount?: number;
+    maxVideoSize?: number;
+    allowButton?: boolean;
+    allowMixImageText?: boolean;
+    allowMixMarkdownButton?: boolean;
+};
+/**
+ * 得到消息意图。
+ * 用于多平台下的降级消费。
+ * @param event
+ * @param data
+ * @returns
+ */
+export declare const getMessageIntent: () => Promise<Result<IntentResult>>;
+export {};

package/lib/app/message/message-api.js

@@ -0,0 +1,105 @@
+import { ResultCode } from '../../core/variable.js';
+import { sendAction } from '../../cbp/processor/actions.js';
+import { createResult } from '../../core/utils.js';
+
+/**
+ * 创建原生value映射
+ * @param event
+ * @returns
+ */
+const createEventValue = (event) => {
+    return event.value;
+};
+/**
+ * 创建数据格式。
+ * @param {...DataEnums[]} data - 要格式化的数据。
+ * @returns {DataEnums[]} - 返回格式化后的数据数组。
+ * @throws {Error} - 如果 data 无效，抛出错误。
+ */
+const format = (...data) => {
+    if (!data || data.length === 0) {
+        logger.error({
+            code: ResultCode.FailParams,
+            message: 'Invalid data: data cannot be empty',
+            data: null
+        });
+        throw new Error('Invalid data: data cannot be empty');
+    }
+    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作为该参数。
+ * @param {DataEnums[]} data - 要发送的数据。
+ * @throws {Error} - 如果 SpaceId 无效或发送失败，抛出错误。
+ */
+const sendToChannel = async (SpaceId, data) => {
+    if (!SpaceId || typeof SpaceId !== 'string') {
+        logger.error({
+            code: ResultCode.FailParams,
+            message: 'Invalid SpaceId: SpaceId must be a string',
+            data: null
+        });
+        throw new Error('Invalid SpaceId: SpaceId must be a string');
+    }
+    return await sendAction({
+        action: 'message.send.channel',
+        payload: {
+            ChannelId: SpaceId,
+            params: {
+                format: data
+            }
+        }
+    });
+};
+/**
+ * 向指定用户发送消息。
+ * @param {string} OpenID - 开放ID，可能是用户ID、聊天ID，或是复合ID。总之，是框架给指定用户的唯一标识。也就说，不能使用UserId作为该参数。
+ * @param {DataEnums[]} data - 要发送的数据。
+ * @throws {Error} - 如果 user_id 无效或发送失败，抛出错误。
+ */
+const sendToUser = async (OpenID, data) => {
+    if (!OpenID || typeof OpenID !== 'string') {
+        logger.error({
+            code: ResultCode.FailParams,
+            message: 'Invalid OpenID: OpenID must be a string',
+            data: null
+        });
+        throw new Error('Invalid OpenID: OpenID must be a string');
+    }
+    return await sendAction({
+        action: 'message.send.user',
+        payload: {
+            UserId: OpenID,
+            params: {
+                format: data
+            }
+        }
+    });
+};
+/**
+ * 得到消息意图。
+ * 用于多平台下的降级消费。
+ * @param event
+ * @param data
+ * @returns
+ */
+const getMessageIntent = async () => {
+    const results = await sendAction({
+        action: 'message.intent',
+        payload: {}
+    });
+    return createResult(ResultCode.Ok, '获取成功', results[0]?.data ?? null);
+};
+
+export { createDataFormat, createEventValue, format, getMessageIntent, sendToChannel, sendToUser };

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

@@ -0,0 +1,143 @@
+import { DataMention, DataImage, DataText, DataImageURL, DataImageFile, DataButtonRow, DataButtonGroup, DataButton, DataMarkDown, DataMarkdownTitle, DataMarkdownSubtitle, DataMarkdownBold, DataMarkdownItalic, DataMarkdownItalicStar, DataMarkdownStrikethrough, DataMarkdownLink, DataMarkdownImage, DataMarkdownList, DataMarkdownListItem, DataMarkdownBlockquote, DataMarkdownDivider, DataMarkdownNewline, DataLink, DataMarkdownText, DataMarkdownCode, DataMarkdownOriginal, DataAttachment, DataAudio, DataVideo, DataMarkdownMention, DataMarkdownContent, DataMarkdownButton } from '../../types';
+/**
+ * 文本消息
+ * @param val
+ * @param options
+ * @returns
+ */
+export declare const Text: (val: DataText["value"], options?: DataText["options"]) => DataText;
+/**
+ * 链接消息
+ * @deprecated 废弃，这个应该是md语法里的
+ * @param val 要显示的文本
+ * @param options 内容选项
+ * @returns
+ */
+export declare const Link: (val: DataLink["value"], options?: DataText["options"]) => DataText;
+/**
+ * 图片链接，http 或 https 开头
+ * @deprecated 废弃，推荐使用 Image
+ * @param val
+ * @returns
+ */
+export declare const ImageURL: (val: DataImageURL["value"]) => DataImageURL;
+/**
+ * 本地图片文件
+ * @deprecated 废弃，推荐使用 Image
+ * @param val
+ * @returns
+ */
+export declare const ImageFile: (val: DataImageFile["value"]) => DataImageFile;
+/**
+ * 图片消息
+ * @param val Buffer 或带协议的字符串（https:// | http:// | file:// | base64://）
+ * @returns
+ */
+declare const Image: {
+    (val: Buffer | string): DataImage;
+    /**
+     * @deprecated 废弃，推荐使用 Image
+     */
+    url: (val: DataImageURL["value"]) => DataImageURL;
+    /**
+     * @deprecated 废弃，推荐使用 Image
+     */
+    file: (val: DataImageFile["value"]) => DataImageFile;
+};
+export { Image };
+/**
+ * 提及
+ * @param UserId 默认 @ 所有人
+ * @param options 默认 user
+ * @returns
+ */
+export declare const Mention: (UserId?: DataMention["value"], options?: DataMention["options"]) => DataMention;
+export declare const Button: {
+    (title: string, data: DataButton["options"]["data"], options?: Omit<DataButton["options"], "data">): DataButton;
+    group: (...rows: DataButtonRow[]) => DataButtonGroup;
+    row: (...buttons: DataButton[]) => DataButtonRow;
+};
+export declare const BT: {
+    (title: string, data: DataButton["options"]["data"], options?: Omit<DataButton["options"], "data">): DataButton;
+    group: (...rows: DataButtonRow[]) => DataButtonGroup;
+    row: (...buttons: DataButton[]) => DataButtonRow;
+};
+/**
+ *
+ * @param values 要显示的文本
+ * @returns
+ */
+declare const Markdown: {
+    (...values: DataMarkDown["value"]): DataMarkDown;
+    text(text: string): DataMarkdownText;
+    mention(uid?: string, options?: DataMarkdownMention["options"]): DataMarkdownMention;
+    button(title: string, data: DataMarkdownButton["options"]): DataMarkdownButton;
+    content(text: string): DataMarkdownContent;
+    title(text: string): DataMarkdownTitle;
+    subtitle(text: string): DataMarkdownSubtitle;
+    bold(text: string): DataMarkdownBold;
+    italic(text: string): DataMarkdownItalic;
+    italicStar(text: string): DataMarkdownItalicStar;
+    strikethrough(text: string): DataMarkdownStrikethrough;
+    link(text: string, url: string): DataMarkdownLink;
+    image(url: string, options?: {
+        width?: number;
+        height?: number;
+    }): DataMarkdownImage;
+    list(...items: any[]): DataMarkdownList;
+    listItem(indexOrText: number | string, text?: string): DataMarkdownListItem;
+    blockquote(text: string): DataMarkdownBlockquote;
+    divider(): DataMarkdownDivider;
+    newline(value?: boolean): DataMarkdownNewline;
+    code(value: DataMarkdownCode["value"], options?: DataMarkdownCode["options"]): DataMarkdownCode;
+};
+export declare const MD: {
+    (...values: DataMarkDown["value"]): DataMarkDown;
+    text(text: string): DataMarkdownText;
+    mention(uid?: string, options?: DataMarkdownMention["options"]): DataMarkdownMention;
+    button(title: string, data: DataMarkdownButton["options"]): DataMarkdownButton;
+    content(text: string): DataMarkdownContent;
+    title(text: string): DataMarkdownTitle;
+    subtitle(text: string): DataMarkdownSubtitle;
+    bold(text: string): DataMarkdownBold;
+    italic(text: string): DataMarkdownItalic;
+    italicStar(text: string): DataMarkdownItalicStar;
+    strikethrough(text: string): DataMarkdownStrikethrough;
+    link(text: string, url: string): DataMarkdownLink;
+    image(url: string, options?: {
+        width?: number;
+        height?: number;
+    }): DataMarkdownImage;
+    list(...items: any[]): DataMarkdownList;
+    listItem(indexOrText: number | string, text?: string): DataMarkdownListItem;
+    blockquote(text: string): DataMarkdownBlockquote;
+    divider(): DataMarkdownDivider;
+    newline(value?: boolean): DataMarkdownNewline;
+    code(value: DataMarkdownCode["value"], options?: DataMarkdownCode["options"]): DataMarkdownCode;
+};
+export { Markdown };
+/**
+ * 纯 Markdown 文本
+ * @param val 原始 Markdown 字符串
+ * @returns
+ */
+export declare const MarkdownOriginal: (val: string) => DataMarkdownOriginal;
+/**
+ * 附件消息
+ * @param val 带协议的字符串（https:// | http:// | file:// | base64://）
+ * @param options 附件选项
+ * @returns
+ */
+export declare const Attachment: (val: string, options?: DataAttachment["options"]) => DataAttachment;
+/**
+ * 音频消息
+ * @param val 带协议的字符串（https:// | http:// | file:// | base64://）
+ * @returns
+ */
+export declare const Audio: (val: string) => DataAudio;
+/**
+ * 视频消息
+ * @param val 带协议的字符串（https:// | http:// | file:// | base64://）
+ * @returns
+ */
+export declare const Video: (val: string) => DataVideo;