node-karin 0.6.18 → 0.6.20

package/lib/types/event/notice.js

@@ -0,0 +1,52 @@
+import { EventType, NoticeSubType } from './event.js';
+/**
+ * - 创建一个通知事件
+ */
+export class KarinNotice {
+    self_id;
+    user_id;
+    group_id;
+    event;
+    sub_event;
+    event_id;
+    time;
+    contact;
+    sender;
+    isMaster;
+    isAdmin;
+    isPrivate;
+    isGroup;
+    isGuild;
+    isGroupTemp;
+    logFnc;
+    logText;
+    store;
+    raw_message;
+    raw_event;
+    reply;
+    replyCallback;
+    bot;
+    content;
+    constructor({ event_id, self_id, user_id, group_id = '', time, contact, sender, sub_event, content, }) {
+        this.self_id = self_id;
+        this.user_id = user_id;
+        this.group_id = contact.scene === 'group' ? (contact.peer || group_id) : group_id;
+        this.time = time;
+        this.event = EventType.Notice;
+        this.event_id = event_id;
+        this.contact = contact;
+        this.sender = sender;
+        this.sub_event = sub_event;
+        this.isMaster = false;
+        this.isAdmin = false;
+        this.isPrivate = false;
+        this.isGroup = false;
+        this.isGuild = false;
+        this.isGroupTemp = false;
+        this.logFnc = '';
+        this.logText = '';
+        this.store = new Map();
+        this.raw_message = '';
+        this.content = content;
+    }
+}

package/lib/types/{reply.d.ts → event/reply.d.ts}

@@ -1,4 +1,4 @@
-import { KarinElement, KarinNodeElement } from './element.js';
+import { KarinElement, NodeElement } from '../element.js';
 export type Reply = (
 /**
  * 发送的消息
@@ -38,6 +38,6 @@ elements: KarinElement[],
 retry_count?: number) => Promise<{
     message_id?: string;
 }>;
-export type replyForward = (msg: KarinNodeElement[]) => Promise<{
+export type replyForward = (msg: NodeElement[]) => Promise<{
     message_id?: string;
 }>;

package/lib/types/event/reply.js

@@ -0,0 +1 @@
+export {};

package/lib/types/event/request.d.ts

@@ -0,0 +1,126 @@
+import { KarinEventType, BaseEventDataType, EventType, RequestSubType } from './event.js';
+/**
+ * - 好友申请
+ */
+export interface PrivateApplyType {
+    /**
+     * - 申请者uid
+     */
+    applier_uid: string;
+    /**
+     * - 申请者uin
+     */
+    applier_uin: string;
+    /**
+     * - 申请理由
+     */
+    message: string;
+}
+/**
+ * - 群申请
+ */
+export interface GroupApply {
+    /**
+     * - 群ID
+     */
+    group_id: string;
+    /**
+     * - 申请者uid
+     */
+    applier_uid: string;
+    /**
+     * - 申请者uin
+     */
+    applier_uin: string;
+    /**
+     * - 邀请者uid
+     */
+    inviter_uid: string;
+    /**
+     * - 邀请者uin
+     */
+    inviter_uin: string;
+    /**
+     * - 申请理由
+     */
+    reason: string;
+}
+/**
+ * - 邀请入群
+ */
+export interface GroupInvite {
+    /**
+     * - 群ID
+     */
+    group_id: string;
+    /**
+     * - 邀请者uid
+     */
+    inviter_uid: string;
+    /**
+     * - 邀请者uin
+     */
+    inviter_uin: string;
+}
+/**
+ * - 通知事件子类型
+ */
+export interface RequestType {
+    [RequestSubType.PrivateApply]: PrivateApplyType;
+    [RequestSubType.GroupApply]: GroupApply;
+    [RequestSubType.InvitedGroup]: GroupInvite;
+}
+/**
+ * - 请求事件基类
+ */
+export interface KarinRequestEventBase extends KarinEventType {
+    event: EventType.Request;
+}
+/**
+ * - 辅助类型，用于生成 KarinRequestEvent 的联合类型来自动推导content的类型
+ */
+type RequestEvent<T extends RequestSubType> = KarinRequestEventBase & {
+    sub_event: T;
+    content: RequestType[T];
+};
+/**
+ * - 请求事件定义
+ */
+export type KarinRequestType = RequestEvent<RequestSubType.GroupApply> | RequestEvent<RequestSubType.InvitedGroup> | RequestEvent<RequestSubType.PrivateApply>;
+/**
+ * - 创建一个请求事件
+ */
+export declare class KarinRequest implements KarinRequestEventBase {
+    self_id: KarinRequestType['self_id'];
+    user_id: KarinRequestType['user_id'];
+    group_id: KarinRequestType['group_id'];
+    event: KarinRequestType['event'];
+    sub_event: KarinRequestType['sub_event'];
+    event_id: KarinRequestType['event_id'];
+    time: KarinRequestType['time'];
+    contact: KarinRequestType['contact'];
+    sender: KarinRequestType['sender'];
+    isMaster: KarinRequestType['isMaster'];
+    isAdmin: KarinRequestType['isAdmin'];
+    isPrivate: KarinRequestType['isPrivate'];
+    isGroup: KarinRequestType['isGroup'];
+    isGuild: KarinRequestType['isGuild'];
+    isGroupTemp: KarinRequestType['isGroupTemp'];
+    logFnc: KarinRequestType['logFnc'];
+    logText: KarinRequestType['logText'];
+    store: KarinRequestType['store'];
+    raw_message: KarinRequestType['raw_message'];
+    reply: KarinRequestType['reply'];
+    replyCallback: KarinRequestType['replyCallback'];
+    bot: KarinRequestType['bot'];
+    content: RequestType[RequestSubType];
+    raw_event: KarinRequestType['raw_event'];
+    constructor({ self_id, user_id, group_id, time, contact, sender, sub_event, event_id, content, }: BaseEventDataType & {
+        sub_event: KarinRequestType['sub_event'];
+        /**
+         * - 事件对应的内容参数
+         */
+        content: KarinRequestType['content'];
+    });
+}
+export {};

package/lib/types/event/request.js

@@ -0,0 +1,52 @@
+import { EventType, RequestSubType } from './event.js';
+/**
+ * - 创建一个请求事件
+ */
+export class KarinRequest {
+    self_id;
+    user_id;
+    group_id;
+    event;
+    sub_event;
+    event_id;
+    time;
+    contact;
+    sender;
+    isMaster;
+    isAdmin;
+    isPrivate;
+    isGroup;
+    isGuild;
+    isGroupTemp;
+    logFnc;
+    logText;
+    store;
+    raw_message;
+    reply;
+    replyCallback;
+    bot;
+    content;
+    raw_event;
+    constructor({ self_id, user_id, group_id = '', time, contact, sender, sub_event, event_id, content, }) {
+        this.self_id = self_id;
+        this.user_id = user_id;
+        this.group_id = contact.scene === 'group' ? (contact.peer || group_id) : group_id;
+        this.time = time;
+        this.event = EventType.Request;
+        this.event_id = event_id;
+        this.contact = contact;
+        this.sender = sender;
+        this.sub_event = sub_event;
+        this.content = content;
+        this.isMaster = false;
+        this.isAdmin = false;
+        this.isPrivate = false;
+        this.isGroup = false;
+        this.isGuild = false;
+        this.isGroupTemp = false;
+        this.logFnc = '';
+        this.logText = '';
+        this.store = new Map();
+        this.raw_message = '';
+    }
+}

package/lib/types/event/sender.d.ts

@@ -0,0 +1,44 @@
+/**
+ * - 群身份枚举 值不存在时为unknown
+ */
+export declare enum Role {
+    Owner = "owner",
+    Admin = "admin",
+    Member = "member",
+    Unknown = "unknown"
+}
+/**
+ * - 权限类型枚举
+ */
+export declare enum Permission {
+    All = "all",
+    Master = "master",
+    Admin = "admin",
+    GroupOwner = "group.owner",
+    GroupAdmin = "group.admin"
+}
+/**
+ * - 权限类型 纯文本
+ */
+export type PermissionType = 'all' | 'master' | 'admin' | 'group.owner' | 'group.admin';
+/**
+ * - 事件发送者信息
+ */
+export interface Sender {
+    /**
+     * - 发送者uid
+     */
+    uid: string;
+    /**
+     * - 发送者uin
+     */
+    uin: string;
+    /**
+     * - 发送者昵称
+     */
+    nick: string | '';
+    /**
+     * - 发送者在群的角色身份
+     */
+    role: Role;
+}

package/lib/types/event/sender.js

@@ -0,0 +1,22 @@
+/* eslint-disable no-unused-vars */
+/**
+ * - 群身份枚举 值不存在时为unknown
+ */
+export var Role;
+(function (Role) {
+    Role["Owner"] = "owner";
+    Role["Admin"] = "admin";
+    Role["Member"] = "member";
+    Role["Unknown"] = "unknown";
+})(Role || (Role = {}));
+/**
+ * - 权限类型枚举
+ */
+export var Permission;
+(function (Permission) {
+    Permission["All"] = "all";
+    Permission["Master"] = "master";
+    Permission["Admin"] = "admin";
+    Permission["GroupOwner"] = "group.owner";
+    Permission["GroupAdmin"] = "group.admin";
+})(Permission || (Permission = {}));

package/lib/types/index.d.ts

@@ -1,10 +1,11 @@
-export * from './adapter.js';
+export * from './adapter/adapter.js';
 export * from './config.js';
 export * from './element.js';
-export * from './event.js';
+export * from './event/index.js';
 export * from './logger.js';
-export * from './onebots11.js';
 export * from './render.js';
 export * from './plugin.js';
-export * from './reply.js';
-export * from './api.js';
+export * from './event/reply.js';
+export * from './adapter/api.js';
+export * from './onebot11/index.js';
+export * from './event/index.js';

package/lib/types/index.js

@@ -1,10 +1,11 @@
-export * from './adapter.js'
+export * from './adapter/adapter.js'
 export * from './config.js'
 export * from './element.js'
-export * from './event.js'
+export * from './event/index.js'
 export * from './logger.js'
-export * from './onebots11.js'
 export * from './render.js'
 export * from './plugin.js'
-export * from './reply.js'
-export * from './api.js'
+export * from './event/reply.js'
+export * from './adapter/api.js'
+export * from './onebot11/index.js'
+export * from './event/index.js'

package/lib/types/onebot11/api.d.ts

@@ -0,0 +1,53 @@
+/**
+ * - OneBot11公开Api
+ */
+export declare enum OB11Api {
+    'send_private_msg' = "send_private_msg",
+    'send_group_msg' = "send_group_msg",
+    'send_msg' = "send_msg",
+    'delete_msg' = "delete_msg",
+    'get_msg' = "get_msg",
+    'get_forward_msg' = "get_forward_msg",
+    'send_like' = "send_like",
+    'set_group_kick' = "set_group_kick",
+    'set_group_ban' = "set_group_ban",
+    'set_group_anonymous_ban' = "set_group_anonymous_ban",
+    'set_group_whole_ban' = "set_group_whole_ban",
+    'set_group_admin' = "set_group_admin",
+    'set_group_anonymous' = "set_group_anonymous",
+    'set_group_card' = "set_group_card",
+    'set_group_name' = "set_group_name",
+    'set_group_leave' = "set_group_leave",
+    'set_group_special_title' = "set_group_special_title",
+    'set_friend_add_request' = "set_friend_add_request",
+    'set_group_add_request' = "set_group_add_request",
+    'get_login_info' = "get_login_info",
+    'get_stranger_info' = "get_stranger_info",
+    'get_friend_list' = "get_friend_list",
+    'get_group_info' = "get_group_info",
+    'get_group_list' = "get_group_list",
+    'get_group_member_info' = "get_group_member_info",
+    'get_group_member_list' = "get_group_member_list",
+    'get_group_honor_info' = "get_group_honor_info",
+    'get_cookies' = "get_cookies",
+    'get_csrf_token' = "get_csrf_token",
+    'get_credentials' = "get_credentials",
+    'get_record' = "get_record",
+    'get_image' = "get_image",
+    'can_send_image' = "can_send_image",
+    'can_send_record' = "can_send_record",
+    'get_status' = "get_status",
+    'get_version_info' = "get_version_info",
+    'set_restart' = "set_restart",
+    'clean_cache' = "clean_cache",
+    'get_version' = "get_version",
+    'send_forward_msg' = "send_forward_msg",
+    'get_friend_msg_history' = "get_friend_msg_history",
+    'get_group_msg_history' = "get_group_msg_history",
+    'set_msg_emoji_like' = "set_msg_emoji_like",
+    'upload_group_file' = "upload_group_file",
+    'upload_private_file' = "upload_private_file",
+    'get_essence_msg_list' = "get_essence_msg_list",
+    'set_essence_msg' = "set_essence_msg",
+    'delete_essence_msg' = "delete_essence_msg"
+}

package/lib/types/onebot11/api.js

@@ -0,0 +1,54 @@
+/**
+ * - OneBot11公开Api
+ */
+export var OB11Api;
+(function (OB11Api) {
+    OB11Api["send_private_msg"] = "send_private_msg";
+    OB11Api["send_group_msg"] = "send_group_msg";
+    OB11Api["send_msg"] = "send_msg";
+    OB11Api["delete_msg"] = "delete_msg";
+    OB11Api["get_msg"] = "get_msg";
+    OB11Api["get_forward_msg"] = "get_forward_msg";
+    OB11Api["send_like"] = "send_like";
+    OB11Api["set_group_kick"] = "set_group_kick";
+    OB11Api["set_group_ban"] = "set_group_ban";
+    OB11Api["set_group_anonymous_ban"] = "set_group_anonymous_ban";
+    OB11Api["set_group_whole_ban"] = "set_group_whole_ban";
+    OB11Api["set_group_admin"] = "set_group_admin";
+    OB11Api["set_group_anonymous"] = "set_group_anonymous";
+    OB11Api["set_group_card"] = "set_group_card";
+    OB11Api["set_group_name"] = "set_group_name";
+    OB11Api["set_group_leave"] = "set_group_leave";
+    OB11Api["set_group_special_title"] = "set_group_special_title";
+    OB11Api["set_friend_add_request"] = "set_friend_add_request";
+    OB11Api["set_group_add_request"] = "set_group_add_request";
+    OB11Api["get_login_info"] = "get_login_info";
+    OB11Api["get_stranger_info"] = "get_stranger_info";
+    OB11Api["get_friend_list"] = "get_friend_list";
+    OB11Api["get_group_info"] = "get_group_info";
+    OB11Api["get_group_list"] = "get_group_list";
+    OB11Api["get_group_member_info"] = "get_group_member_info";
+    OB11Api["get_group_member_list"] = "get_group_member_list";
+    OB11Api["get_group_honor_info"] = "get_group_honor_info";
+    OB11Api["get_cookies"] = "get_cookies";
+    OB11Api["get_csrf_token"] = "get_csrf_token";
+    OB11Api["get_credentials"] = "get_credentials";
+    OB11Api["get_record"] = "get_record";
+    OB11Api["get_image"] = "get_image";
+    OB11Api["can_send_image"] = "can_send_image";
+    OB11Api["can_send_record"] = "can_send_record";
+    OB11Api["get_status"] = "get_status";
+    OB11Api["get_version_info"] = "get_version_info";
+    OB11Api["set_restart"] = "set_restart";
+    OB11Api["clean_cache"] = "clean_cache";
+    OB11Api["get_version"] = "get_version";
+    OB11Api["send_forward_msg"] = "send_forward_msg";
+    OB11Api["get_friend_msg_history"] = "get_friend_msg_history";
+    OB11Api["get_group_msg_history"] = "get_group_msg_history";
+    OB11Api["set_msg_emoji_like"] = "set_msg_emoji_like";
+    OB11Api["upload_group_file"] = "upload_group_file";
+    OB11Api["upload_private_file"] = "upload_private_file";
+    OB11Api["get_essence_msg_list"] = "get_essence_msg_list";
+    OB11Api["set_essence_msg"] = "set_essence_msg";
+    OB11Api["delete_essence_msg"] = "delete_essence_msg";
+})(OB11Api || (OB11Api = {}));