alemonjs 2.1.0-alpha.7 → 2.1.0-alpha.9

package/lib/app/define-bot.d.ts

@@ -0,0 +1,17 @@
+import { DefinePlatformFunc } from '../typing/event/index.js'
+import '../global.js'
+
+/**
+ * 定义机器人
+ * @param callback
+ * @throws {Error} - 如果 callback 无效，抛出错误。
+ * @returns
+ */
+declare const definePlatform: DefinePlatformFunc
+/**
+ * 废弃，请使用 definePlatform
+ * @deprecated
+ */
+declare const defineBot: DefinePlatformFunc
+
+export { defineBot, definePlatform }

package/lib/app/define-bot.js

@@ -0,0 +1,39 @@
+import { ResultCode } from '../core/code.js'
+
+/**
+ * 定义机器人
+ * @param callback
+ * @throws {Error} - 如果 callback 无效，抛出错误。
+ * @returns
+ */
+const definePlatform = callback => {
+  // 判断是否是函数
+  if (typeof callback !== 'function') {
+    logger.error({
+      code: ResultCode.FailParams,
+      message: 'Invalid callback: callback must be a function',
+      data: null
+    })
+    throw new Error('Invalid callback: callback must be a function')
+  }
+  return {
+    _name: 'platform',
+    callback
+  }
+}
+global.definePlatform = definePlatform
+/**
+ * 废弃，请使用 definePlatform
+ * @deprecated
+ */
+const defineBot = callback => {
+  logger.warn({
+    code: ResultCode.Warn,
+    message: 'defineBot is deprecated, please use definePlatform',
+    data: null
+  })
+  return definePlatform(callback)
+}
+global.defineBot = defineBot
+
+export { defineBot, definePlatform }

package/lib/app/event-processor-event.js

@@ -1,6 +1,6 @@
 import { isAsyncFunction } from 'util/types';
 import { useState } from './hook-use-state.js';
-import { showErrorModule } from './utils.js';
+import { showErrorModule } from '../core/utils.js';
 import { Response } from './store.js';
 import { useMessage } from './hook-use-api.js';
 import { EventMessageText } from '../core/variable.js';

package/lib/app/event-processor-middleware.js

@@ -1,6 +1,6 @@
 import { isAsyncFunction } from 'util/types';
 import { useState } from './hook-use-state.js';
-import { showErrorModule } from './utils.js';
+import { showErrorModule } from '../core/utils.js';
 import { Middleware } from './store.js';
 import { useMessage } from './hook-use-api.js';
 import { EventMessageText } from '../core/variable.js';

package/lib/app/event-processor.js

@@ -2,7 +2,7 @@ import { getConfigValue } from '../core/config.js';
 import { processor_repeated_clear_time_min, processor_repeated_clear_time_max, processor_repeated_event_time, processor_repeated_user_time, processor_repeated_clear_size } from '../core/variable.js';
 import { expendCycle } from './event-processor-cycle.js';
 import { ProcessorEventAutoClearMap, ProcessorEventUserAudoClearMap } from './store.js';
-import { createHash } from './utils.js';
+import { createHash } from '../core/utils.js';
 
 /**
  * 过滤掉重复消息

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

@@ -1,5 +1,5 @@
 import { EventKeys, Events } from '../typing/event/map.js';
-import { Result } from './utils.js';
+import { Result } from '../core/utils.js';
 import '../global.js';
 import { DataEnums } from '../typing/message/index.js';
 
@@ -91,5 +91,12 @@ declare const onSelects: <T extends EventKeys[] | EventKeys>(values: T) => T;
  * @deprecated
  */
 declare const createSelects: <T extends EventKeys[] | EventKeys>(values: T) => T;
+/**
+ * 使用客户端
+ * @param event
+ * @param _ApiClass
+ * @returns
+ */
+declare const useClient: <T extends object>(event: any, _ApiClass: new (...args: any[]) => T) => T[];
 
-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-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';
 
 /**
  * 使用提及。
@@ -339,5 +340,28 @@ global.onSelects = onSelects;
  * @deprecated
  */
 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/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';

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

@@ -1,7 +1,7 @@
-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';
 
 /**
  * 创建数据格式。

package/lib/cbp/actions.js

@@ -1,5 +1,5 @@
 import { ResultCode } from '../core/code.js';
-import { createResult } from '../app/utils.js';
+import { createResult } from '../core/utils.js';
 import { generateUniqueId, actionResolves, deviceId, actionTimeouts, timeoutTime } from './config.js';
 
 /**
@@ -11,20 +11,23 @@ const sendAction = (data) => {
     return new Promise(resolve => {
         actionResolves.set(actionId, resolve);
         // 设置唯一标识符
-        data.actionID = actionId;
+        data.actionId = actionId;
         // 设置设备 ID
         data.DeviceId = deviceId;
+        // 发送消息
         global.chatbotClient.send(JSON.stringify(data));
         // 12 秒后超时
         const timeout = setTimeout(() => {
-            // 不会当错误进行处理
-            resolve([createResult(ResultCode.Fail, '请求超时', null)]);
-            // 手动清理
-            clearTimeout(timeout);
+            // 被清理了
+            if (!actionResolves.has(actionId) || !actionTimeouts.has(actionId)) {
+                return;
+            }
             // 删除回调
             actionResolves.delete(actionId);
             // 删除超时器
             actionTimeouts.delete(actionId);
+            // 不会当错误进行处理。而是传入错误码
+            resolve([createResult(ResultCode.Fail, '行为超时', null)]);
         }, timeoutTime);
         actionTimeouts.set(actionId, timeout);
     });

package/lib/cbp/api.js

@@ -0,0 +1,36 @@
+import { ResultCode } from '../core/code.js';
+import { createResult } from '../core/utils.js';
+import { generateUniqueId, apiResolves, deviceId, apiTimeouts, timeoutTime } from './config.js';
+
+/**
+ * 发送行为
+ * @param data
+ */
+const sendAPI = (data) => {
+    const ApiId = generateUniqueId();
+    return new Promise(resolve => {
+        apiResolves.set(ApiId, resolve);
+        // 设置唯一标识符
+        data.apiId = ApiId;
+        // 设置设备 ID
+        data.DeviceId = deviceId;
+        // 发送消息
+        global.chatbotClient.send(JSON.stringify(data));
+        // 12 秒后超时
+        const timeout = setTimeout(() => {
+            // 被清理了
+            if (!apiResolves.has(ApiId) || !apiTimeouts.has(ApiId)) {
+                return;
+            }
+            // 删除回调
+            apiResolves.delete(ApiId);
+            // 删除超时器
+            apiTimeouts.delete(ApiId);
+            // 不会当错误进行处理。而是传入错误码
+            resolve([createResult(ResultCode.Fail, '接口超时', null)]);
+        }, timeoutTime);
+        apiTimeouts.set(ApiId, timeout);
+    });
+};
+
+export { sendAPI };

package/lib/cbp/config.js

@@ -15,8 +15,12 @@ const DEVICE_ID_HEADER = 'x-device-id';
 const FULL_RECEIVE_HEADER = 'x-full-receive';
 // 行为回调
 const actionResolves = new Map();
+// 接口回调
+const apiResolves = new Map();
 // 超时器
 const actionTimeouts = new Map();
+// 接口超时器
+const apiTimeouts = new Map();
 // 分配绑定记录
 const childrenBind = new Map();
 // 生成唯一标识符
@@ -30,4 +34,4 @@ const reconnectInterval = 1000 * 6; // 6秒
 // 心跳间隔
 const HEARTBEAT_INTERVAL = 1000 * 18; // 18秒
 
-export { DEVICE_ID_HEADER, FULL_RECEIVE_HEADER, HEARTBEAT_INTERVAL, USER_AGENT_HEADER, actionResolves, actionTimeouts, childrenBind, childrenClient, deviceId, fullClient, generateUniqueId, platformClient, reconnectInterval, timeoutTime };
+export { DEVICE_ID_HEADER, FULL_RECEIVE_HEADER, HEARTBEAT_INTERVAL, USER_AGENT_HEADER, actionResolves, actionTimeouts, apiResolves, apiTimeouts, childrenBind, childrenClient, deviceId, fullClient, generateUniqueId, platformClient, reconnectInterval, timeoutTime };

package/lib/cbp/connect.d.ts

@@ -1,7 +1,8 @@
 import { Actions } from '../typing/actions.js';
 import { EventsEnum } from '../typing/event/map.js';
-import { Result } from '../app/utils.js';
+import { Result } from '../core/utils.js';
 import '../global.js';
+import { Apis } from '../typing/apis.js';
 
 type CBPClientOptions = {
     open?: () => void;
@@ -13,12 +14,14 @@ type CBPClientOptions = {
  * @param onopen
  */
 declare const cbpClient: (url: string, options?: CBPClientOptions) => void;
-type ReplyFunc = (data: Actions, consume: (payload: Result[]) => void) => void;
+type ActionReplyFunc = (data: Actions, consume: (payload: Result[]) => void) => void;
+type ApiReplyFunc = (data: Apis, consume: (payload: Result[]) => void) => void;
 declare const cbpPlatform: (url: string, options?: {
     open: () => void;
 }) => {
     send: (data: EventsEnum) => void;
-    onactions: (reply: ReplyFunc) => void;
+    onactions: (reply: ActionReplyFunc) => void;
+    onapis: (reply: ApiReplyFunc) => void;
 };
 
 export { cbpClient, cbpPlatform };

package/lib/cbp/connect.js

@@ -1,24 +1,11 @@
 import { WebSocket } from 'ws';
 import { onProcessor } from '../app/event-processor.js';
 import { ResultCode } from '../core/code.js';
-import { deviceId, FULL_RECEIVE_HEADER, DEVICE_ID_HEADER, USER_AGENT_HEADER, actionResolves, actionTimeouts, reconnectInterval, HEARTBEAT_INTERVAL } from './config.js';
-import '../app/define-chidren.js';
-import '../app/event-middleware.js';
-import '../app/event-response.js';
-import '../app/hook-use-api.js';
-import '../typing/event/actions.js';
-import 'fs';
-import 'path';
-import 'yaml';
-import 'node:fs';
-import 'log4js';
-import '../app/load.js';
-import '../app/message-api.js';
-import '../app/message-format.js';
-import { createResult } from '../app/utils.js';
+import { deviceId, FULL_RECEIVE_HEADER, DEVICE_ID_HEADER, USER_AGENT_HEADER, apiResolves, apiTimeouts, actionResolves, actionTimeouts, reconnectInterval, HEARTBEAT_INTERVAL } from './config.js';
+import { createResult } from '../core/utils.js';
 
 // 心跳
-const useHeartbeat = ({ ping, isConnected, terminate, }) => {
+const useHeartbeat = ({ ping, isConnected, terminate }) => {
     let heartbeatTimer = null;
     let lastPong = Date.now();
     const stopHeartbeat = () => {
@@ -145,15 +132,37 @@ const cbpClient = (url, options = {}) => {
                         }
                     }
                 }
-                else if (parsedMessage?.actionID) {
-                    // 如果有 actionID，说明要消费掉本地的行为请求
-                    const resolve = actionResolves.get(parsedMessage.actionID);
+                else if (parsedMessage?.apiId) {
+                    // 如果有 apiId，说明是一个接口请求。要进行处理
+                    const resolve = apiResolves.get(parsedMessage.apiId);
                     if (resolve) {
+                        apiResolves.delete(parsedMessage.apiId);
                         // 清除超时器
-                        const timeout = actionTimeouts.get(parsedMessage.actionID);
+                        const timeout = apiTimeouts.get(parsedMessage.apiId);
                         if (timeout) {
+                            apiTimeouts.delete(parsedMessage.apiId);
+                            clearTimeout(timeout);
+                        }
+                        // 调用回调函数
+                        if (Array.isArray(parsedMessage.payload)) {
+                            resolve(parsedMessage.payload);
+                        }
+                        else {
+                            // 错误处理
+                            resolve([createResult(ResultCode.Fail, '接口处理错误', null)]);
+                        }
+                    }
+                }
+                else if (parsedMessage?.actionId) {
+                    // 如果有 actionId
+                    const resolve = actionResolves.get(parsedMessage.actionId);
+                    if (resolve) {
+                        actionResolves.delete(parsedMessage.actionId);
+                        // 清除超时器
+                        const timeout = actionTimeouts.get(parsedMessage.actionId);
+                        if (timeout) {
+                            actionTimeouts.delete(parsedMessage.actionId);
                             clearTimeout(timeout);
-                            actionTimeouts.delete(parsedMessage.actionID);
                         }
                         // 调用回调函数
                         if (Array.isArray(parsedMessage.payload)) {
@@ -163,7 +172,6 @@ const cbpClient = (url, options = {}) => {
                             // 错误处理
                             resolve([createResult(ResultCode.Fail, '消费处理错误', null)]);
                         }
-                        actionResolves.delete(parsedMessage.actionID);
                     }
                 }
                 else if (parsedMessage.name) {
@@ -239,29 +247,47 @@ const cbpPlatform = (url, options = {
             global.chatbotPlatform.send(JSON.stringify(data));
         }
     };
-    const msg = [];
+    const actionReplys = [];
+    const apiReplys = [];
     /**
      * 消费数据
      * @param data
      * @param payload
      */
-    const reply = (data, payload) => {
+    const replyAction = (data, payload) => {
         if (global.chatbotPlatform && global.chatbotPlatform.readyState === WebSocket.OPEN) {
+            // 透传消费。也就是对应的设备进行处理消费。
             global.chatbotPlatform.send(JSON.stringify({
                 action: data.action,
                 payload: payload,
-                actionID: data.actionID,
-                // 透传消费。也就是对应的设备进行处理消费。
+                actionId: data.actionId,
                 DeviceId: data.DeviceId
             }));
         }
     };
+    const replyApi = (data, payload) => {
+        if (global.chatbotPlatform && global.chatbotPlatform.readyState === WebSocket.OPEN) {
+            // 透传消费。也就是对应的设备进行处理消费。
+            global.chatbotPlatform.send(JSON.stringify({
+                action: data.action,
+                apiId: data.apiId,
+                DeviceId: data.DeviceId,
+                payload: payload
+            }));
+        }
+    };
     /**
      * 接收行为
      * @param reply
      */
     const onactions = (reply) => {
-        msg.push(reply);
+        actionReplys.push(reply);
+    };
+    /**
+     * 接收接口
+     */
+    const onapis = (reply) => {
+        apiReplys.push(reply);
     };
     /**
      * 启动 WebSocket 连接
@@ -288,10 +314,19 @@ const cbpPlatform = (url, options = {
                     message: '平台端接收消息',
                     data: data
                 });
-                for (const cb of msg) {
-                    cb(data, 
-                    // 传入一个消费函数
-                    val => reply(data, val));
+                if (data.apiId) {
+                    for (const cb of apiReplys) {
+                        cb(data, 
+                        // 传入一个消费函数
+                        val => replyApi(data, val));
+                    }
+                }
+                else if (data.actionId) {
+                    for (const cb of actionReplys) {
+                        cb(data, 
+                        // 传入一个消费函数
+                        val => replyAction(data, val));
+                    }
                 }
             }
             catch (error) {
@@ -326,7 +361,8 @@ const cbpPlatform = (url, options = {
     start();
     const client = {
         send,
-        onactions
+        onactions,
+        onapis
     };
     return client;
 };

package/lib/cbp/index.d.ts

@@ -1,3 +1,32 @@
+import { Actions } from '../typing/actions.js'
+import { EventsEnum } from '../typing/event/map.js'
+import '../global.js'
+
 declare const cbpServer: (port: number, listeningListener?: () => void) => void
+/**
+ * 发送行为
+ * @param data
+ */
+declare const sendAction: (data: Actions) => Promise<any>
+type CBPClientOptions = {
+  open?: () => void
+  isFullReceive?: boolean
+}
+/**
+ * CBP 客户端
+ * @param url
+ * @param onopen
+ */
+declare const cbpClient: (url: string, options?: CBPClientOptions) => void
+type ReplyFunc = (data: Actions, consume: (payload: any) => void) => void
+declare const cbpPlatform: (
+  url: string,
+  options?: {
+    open: () => void
+  }
+) => {
+  send: (data: EventsEnum) => void
+  onactions: (reply: ReplyFunc) => void
+}
 
-export { cbpServer }
+export { cbpClient, cbpPlatform, cbpServer, sendAction }

package/lib/cbp/index.js

@@ -47,14 +47,41 @@ const cbpServer = (port, listeningListener) => {
             try {
                 // 解析消息
                 const parsedMessage = JSON.parse(message.toString());
-                // 1. 解析得到 actionID ，说明是消费行为请求。要广播告诉所有客户端。
+                // 1. 解析得到 actionId ，说明是消费行为请求。要广播告诉所有客户端。
                 // 2. 解析得到 name ，说明是一个事件请求。
+                // 3. 解析得到 apiId ，说明是一个接口请求。
                 logger.debug({
                     code: ResultCode.Ok,
                     message: '服务端接收到消息',
                     data: parsedMessage
                 });
-                if (parsedMessage?.actionID) {
+                if (!parsedMessage.apiId) {
+                    // 指定的设备 处理消费。终端有记录每个客户端是谁
+                    const DeviceId = parsedMessage.DeviceId;
+                    if (childrenClient.has(DeviceId)) {
+                        const clientWs = childrenClient.get(DeviceId);
+                        if (clientWs && clientWs.readyState === WebSocket.OPEN) {
+                            // 发送消息到指定的子客户端
+                            clientWs.send(message);
+                        }
+                        else {
+                            // 如果连接已关闭，删除该客户端
+                            childrenClient.delete(DeviceId);
+                        }
+                    }
+                    else if (fullClient.has(DeviceId)) {
+                        const clientWs = fullClient.get(DeviceId);
+                        if (clientWs && clientWs.readyState === WebSocket.OPEN) {
+                            // 发送消息到指定的全量客户端
+                            clientWs.send(message);
+                        }
+                        else {
+                            // 如果连接已关闭，删除该客户端
+                            fullClient.delete(DeviceId);
+                        }
+                    }
+                }
+                else if (parsedMessage?.actionId) {
                     // 指定的设备 处理消费。终端有记录每个客户端是谁
                     const DeviceId = parsedMessage.DeviceId;
                     if (childrenClient.has(DeviceId)) {

package/lib/cbp/message.js

@@ -0,0 +1,9 @@
+import KoaRouter from 'koa-router'
+
+const router = new KoaRouter({
+  prefix: '/message'
+})
+// 消息发送
+router.post('/send', () => {})
+
+export { router as default }

package/lib/core/utils.d.ts

@@ -0,0 +1,77 @@
+import { Dirent } from 'fs';
+import { ResultCode } from './code.js';
+
+/**
+ * 将字符串转为定长字符串
+ * @param str 输入字符串
+ * @param options 可选项
+ * @returns 固定长度的哈希值
+ */
+declare const createHash: (str: string, options?: {
+    length?: number;
+    algorithm?: string;
+}) => string;
+/**
+ * 使用用户的哈希键
+ * @param e
+ * @returns
+ */
+declare const useUserHashKey: (event: {
+    UserId: string;
+    Platform: string;
+}) => string;
+/**
+ * 创建app名称
+ * @param url
+ * @param app 模块名
+ * @param select 选择事件类型,默认 res
+ * @returns
+ */
+declare const createEventName: (url: string, appKey: string) => string;
+/**
+ * 将字符串转为数字
+ * @param str
+ * @returns
+ */
+declare const stringToNumber: (str: string, size?: number) => number;
+/**
+ * 递归获取所有文件
+ * @param dir
+ * @param condition
+ * @returns
+ */
+declare const getRecursiveDirFiles: (dir: string, condition?: (func: Dirent) => boolean) => {
+    path: string;
+    name: string;
+}[];
+/**
+ * 解析错误并提示缺失的模块
+ * @param e
+ * @returns
+ */
+declare const showErrorModule: (e: Error) => void;
+declare const getInputExportPath: (input?: string) => any;
+/**
+ * 属于直接调用的函数
+ * 参数错误直接抛出错误
+ * 如果函数内部有错误，则使用 Result 进行返回
+ */
+/**
+ * 异步方法。且需要读取返回值的进行判断的，
+ * 都要以 Result 作为返回值
+ */
+type Result = {
+    code: ResultCode;
+    message: string | Object;
+    data: any;
+};
+/**
+ * 创建结果
+ * @param code
+ * @param message
+ * @returns
+ */
+declare const createResult: (code: ResultCode, message: string | Object, data?: any) => Result;
+
+export { createEventName, createHash, createResult, getInputExportPath, getRecursiveDirFiles, showErrorModule, stringToNumber, useUserHashKey };
+export type { Result };