@kotori-bot/core 1.5.1 → 1.6.0

package/lib/components/messages.js

@@ -0,0 +1,218 @@
+
+/**
+ * @Package @kotori-bot/core
+ * @Version 1.6.0-rc.1
+ * @Author Arimura Sena <me@hotaru.icu>
+ * @Copyright 2024 Hotaru. All rights reserved.
+ * @License GPL-3.0
+ * @Link https://github.com/kotorijs/kotori
+ * @Date 2024/8/9 17:33:05
+ */
+
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var messages_exports = {};
+__export(messages_exports, {
+  MessageList: () => MessageList,
+  MessageSingle: () => MessageSingle,
+  Messages: () => Messages,
+  default: () => messages_default
+});
+module.exports = __toCommonJS(messages_exports);
+class MessageSingle extends String {
+  /**
+   * Message data.
+   *
+   * @readonly
+   */
+  data;
+  /**
+   * Create a single message
+   *
+   * @param type - Message type
+   * @param data - Message data
+   */
+  constructor(type, data) {
+    super(Messages.stringify(type, data, false));
+    this.data = { type, ...data };
+  }
+  /**
+   * Convert message to string.
+   *
+   * @param isStrict - Whether to strictly convert message, strict convert will ignore the elements else text
+   * @returns Message string
+   */
+  toString(isStrict = true) {
+    return Messages.stringify(this.data.type, this.data, isStrict);
+  }
+  /**
+   * Check whether the message is text.
+   *
+   * @returns Whether the message is text
+   */
+  isText() {
+    return this.data.type === "text";
+  }
+}
+class MessageListOrigin extends Array {
+  /**
+   * Create a message list.
+   *
+   * @param messages - Message list
+   */
+  constructor(...messages) {
+    const handleMessage = [];
+    for (const value of messages) {
+      if (typeof value === "string") handleMessage.push(Messages.text(value));
+      else handleMessage.push(...value instanceof MessageListOrigin ? [...value] : [value]);
+    }
+    super(...handleMessage);
+    Object.setPrototypeOf(this, MessageList.prototype);
+  }
+  /**
+   * Convert message list to string.
+   *
+   * @param isStrict - Whether to strictly convert message, strict convert will ignore the elements else text
+   * @returns Message string
+   */
+  toString(isStrict = true) {
+    return Array.from(this).map((value) => value.toString(isStrict)).join("");
+  }
+  /**
+   * Check whether the message list is pure.
+   *
+   * @param keys - Message type list
+   *
+   * @returns Whether the message list is pure
+   */
+  isPure(...keys) {
+    return this.every((value) => keys.includes(value.data.type));
+  }
+  /**
+   * Check whether the message list is text.
+   *
+   * @returns Whether the message list is text
+   */
+  isText() {
+    return this.isPure("text");
+  }
+  /**
+   * Pick message list.
+   *
+   * @param keys - Message type list
+   * @returns Message list
+   */
+  pick(...keys) {
+    return Messages(
+      ...this.filter((value) => keys.includes(value.data.type))
+    );
+  }
+  /**
+   * Omit message list.
+   *
+   * @param keys - Message type list
+   * @returns Message list
+   */
+  omit(...keys) {
+    return Messages(
+      ...this.filter((value) => !keys.includes(value.data.type))
+    );
+  }
+}
+const MessageList = new Proxy(MessageListOrigin, {
+  construct: (target, argArray, newTarget) => new Proxy(Reflect.construct(target, argArray, newTarget), {
+    get: (target2, prop, receiver) => {
+      if (prop in target2) return Reflect.get(target2, prop, receiver);
+      const func = String.prototype[target2];
+      if (func instanceof Function) func.bind(void 0);
+      return void 0;
+    }
+  })
+});
+function Messages(...messages) {
+  return new MessageList(...messages);
+}
+((Messages2) => {
+  function text(text2) {
+    return new MessageSingle("text", { text: text2 });
+  }
+  Messages2.text = text;
+  function mention(userId) {
+    return new MessageSingle("mention", { userId });
+  }
+  Messages2.mention = mention;
+  function mentionAll() {
+    return new MessageSingle("mentionAll", {});
+  }
+  Messages2.mentionAll = mentionAll;
+  function image(content) {
+    return new MessageSingle("image", { content });
+  }
+  Messages2.image = image;
+  function voice(content) {
+    return new MessageSingle("voice", { content });
+  }
+  Messages2.voice = voice;
+  function audio(content) {
+    return new MessageSingle("audio", { content });
+  }
+  Messages2.audio = audio;
+  function video(content) {
+    return new MessageSingle("video", { content });
+  }
+  Messages2.video = video;
+  function file(content) {
+    return new MessageSingle("file", { content });
+  }
+  Messages2.file = file;
+  function location(latitude, longitude, title, content) {
+    return new MessageSingle("location", { latitude, longitude, title, content });
+  }
+  Messages2.location = location;
+  function reply(messageId) {
+    return new MessageSingle("reply", { messageId });
+  }
+  Messages2.reply = reply;
+  function stringify(type, data, isStrict = true) {
+    if (isStrict) {
+      if (type === "text") return data.text;
+      return "";
+    }
+    switch (type) {
+      case "text":
+        return data.text;
+      case "mention":
+        return `@${data.userId}`;
+      case "mentionAll":
+        return "@all";
+      case "location":
+        return "[Location]";
+      default:
+        return `[${type.charAt(0).toUpperCase()}${type.slice(1)}]`;
+    }
+  }
+  Messages2.stringify = stringify;
+})(Messages || (Messages = {}));
+var messages_default = Messages;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  MessageList,
+  MessageSingle,
+  Messages
+});

package/lib/components/session.d.ts

@@ -0,0 +1,177 @@
+import { type EventDataApiBase, type Message, MessageScope, type MessageQuick, type CommandResult, type EventDataPrivateMsg, type EventDataGroupMsg, type EventDataChannelMsg } from '../types';
+import type { Adapter } from './adapter';
+import { formatFactory } from '../utils/factory';
+import { CommandError } from '../utils/error';
+import type { Api } from './api';
+import type { Elements } from './elements';
+import type { I18n } from '@kotori-bot/i18n';
+declare class SessionOrigin<T extends EventDataApiBase = EventDataApiBase> implements EventDataApiBase {
+    /**
+     * Api instance of current session.
+     *
+     * @readonly
+     */
+    readonly api: Api;
+    /**
+     * Elements instance of current session.
+     *
+     * @readonly
+     */
+    readonly el: Elements;
+    /**
+     * I18n instance of current session.
+     *
+     * @readonly
+     */
+    readonly i18n: I18n;
+    /**
+     * Session unique id, generated base on `type`. `userId`, `groupId`, `guildId`, `channelId`.
+     *
+     * @readonly
+     */
+    readonly id: string;
+    /**
+     * Send message to current session.
+     *
+     * @param message - Message to send
+     * @returns Message id and sent time
+     */
+    send(message: Message): Promise<import("../types").SendMessageResponse>;
+    /**
+     * Format message template with data.
+     *
+     * @param template - Message template
+     * @param data - Data to format
+     * @returns Formatted message
+     */
+    readonly format: ReturnType<typeof formatFactory>;
+    /**
+     * Send message to current session, it's packed base on `session.send()`, `session.i18n` and `session.format()`.
+     *
+     * @param message - Message to send
+     * @returns Message id and sent time
+     *
+     * @async
+     */
+    quick(message: MessageQuick): Promise<void>;
+    /**
+     * Get message from current session.
+     *
+     * @param message - Message to get
+     * @returns Message id and sent time
+     */
+    json(message: unknown): Promise<string | import("../types").SendMessageResponse>;
+    /**
+     * Prompt message to current session.
+     *
+     * @param message - Message to prompt
+     * @returns Message from current session
+     *
+     * @async
+     */
+    prompt(message?: Message): Promise<Message>;
+    /**
+     * Confirm message to current session.
+     *
+     * @param options - Options to confirm
+     * @returns Message from current session
+     *
+     * @async
+     */
+    confirm(options?: {
+        message: Message;
+        sure: Message;
+    }): Promise<boolean>;
+    /**
+     * Create a command error.
+     *
+     * @param type - Error type
+     * @param data - Error data
+     * @returns Command error
+     */
+    error<K extends keyof CommandResult>(type: K, data?: CommandResult[K]): CommandError;
+    readonly t: I18n['t'];
+    /**
+     * Session type
+     *
+     * @readonly
+     */
+    readonly type: EventDataApiBase['type'];
+    /**
+     * Session time, milliseconds timestamp.
+     *
+     * @readonly
+     */
+    readonly time: number;
+    /**
+     * Session related user id if exists.
+     *
+     * @readonly
+     */
+    readonly userId?: string;
+    /**
+     * Session related operator id if exists.
+     *
+     * @readonly
+     */
+    readonly operatorId?: string;
+    /**
+     * Session related message id if exists.
+     *
+     * @readonly
+     */
+    readonly messageId?: string;
+    /**
+     * Session related group id if exists.
+     *
+     * @readonly
+     */
+    readonly groupId?: string;
+    /**
+     * Session related channel id if exists.
+     *
+     * @readonly
+     */
+    readonly channelId?: string;
+    /**
+     * Session related guild id if exists.
+     *
+     * @readonly
+     */
+    readonly guildId?: string;
+    /**
+     * Session related meta data if exists, it is customized by the specific adapter.
+     *
+     * @readonly
+     */
+    readonly meta?: EventDataApiBase['meta'];
+    /**
+     * Create a session instance.
+     *
+     * @param data - Session data
+     * @param adapter - Adapter instance
+     *
+     * @constructor
+     */
+    constructor(data: T, adapter: Adapter);
+}
+/**
+ * Session instance.
+ *
+ * @class Session
+ * @extends {SessionOrigin}
+ * @template T
+ */
+export type Session<T extends EventDataApiBase = EventDataApiBase> = SessionOrigin<T> & T;
+export type SessionMsg = Session<EventDataPrivateMsg | EventDataGroupMsg | EventDataChannelMsg>;
+export type SessionMsgPrivate = Session<EventDataPrivateMsg>;
+export type SessionMsgGroup = Session<EventDataGroupMsg>;
+export type SessionMsgChannel = Session<EventDataChannelMsg>;
+/**
+ * Session event.
+ *
+ * @class
+ * @template T - Session event data type
+ */
+export declare const Session: new <T extends EventDataApiBase<MessageScope> = EventDataApiBase<MessageScope>>(data: T, bot: Adapter) => Session<T>;
+export {};

package/lib/components/session.js

@@ -0,0 +1,275 @@
+
+/**
+ * @Package @kotori-bot/core
+ * @Version 1.6.0-rc.1
+ * @Author Arimura Sena <me@hotaru.icu>
+ * @Copyright 2024 Hotaru. All rights reserved.
+ * @License GPL-3.0
+ * @Link https://github.com/kotorijs/kotori
+ * @Date 2024/8/9 17:33:05
+ */
+
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var session_exports = {};
+__export(session_exports, {
+  Session: () => Session
+});
+module.exports = __toCommonJS(session_exports);
+var import_types = require("../types");
+var import_factory = require("../utils/factory");
+var import_error = require("../utils/error");
+var import_global = require("../global");
+var import_messages = require("./messages");
+class SessionOrigin {
+  /**
+   * Api instance of current session.
+   *
+   * @readonly
+   */
+  api;
+  /**
+   * Elements instance of current session.
+   *
+   * @readonly
+   */
+  el;
+  /**
+   * I18n instance of current session.
+   *
+   * @readonly
+   */
+  i18n;
+  /**
+   * Session unique id, generated base on `type`. `userId`, `groupId`, `guildId`, `channelId`.
+   *
+   * @readonly
+   */
+  id;
+  /**
+   * Send message to current session.
+   *
+   * @param message - Message to send
+   * @returns Message id and sent time
+   */
+  async send(message) {
+    if (this.type === import_types.MessageScope.GROUP) {
+      return await this.api.sendGroupMsg(message, this.groupId, this.meta);
+    }
+    if (this.type === import_types.MessageScope.CHANNEL) {
+      return await this.api.sendChannelMsg(message, this.guildId, this.channelId, this.meta);
+    }
+    if (this.type === import_types.MessageScope.PRIVATE) {
+      return await this.api.sendPrivateMsg(message, this.userId, this.meta);
+    }
+    return { messageId: "", time: 0 };
+  }
+  /**
+   * Format message template with data.
+   *
+   * @param template - Message template
+   * @param data - Data to format
+   * @returns Formatted message
+   */
+  format;
+  /**
+   * Send message to current session, it's packed base on `session.send()`, `session.i18n` and `session.format()`.
+   *
+   * @param message - Message to send
+   * @returns Message id and sent time
+   *
+   * @async
+   */
+  async quick(message) {
+    const msg = await message;
+    if (!msg || msg instanceof import_error.CommandError) return;
+    if (msg instanceof import_messages.MessageList && (msg.toString() === "" || msg.pick("text").length === 0)) {
+      this.send(msg);
+      return;
+    }
+    if (Array.isArray(msg) && !(msg instanceof import_messages.MessageList) && msg.length === 2) {
+      this.send(this.format(msg[0], msg[1]));
+      return;
+    }
+    this.send(typeof msg === "string" ? this.i18n.locale(msg) : msg);
+  }
+  /**
+   * Get message from current session.
+   *
+   * @param message - Message to get
+   * @returns Message id and sent time
+   */
+  async json(message) {
+    if (typeof message === "string") return this.send(message);
+    if (message && typeof message === "object") {
+      const result = JSON.stringify(message, void 0, 2);
+      if (result === "{}") return this.send(String(message));
+      return result;
+    }
+    if (typeof message === "function") {
+      return `[${message.toString().slice(0, 5) === "class" ? "class" : "Function"} ${message.name || "(anonymous)"}]`;
+    }
+    return this.send(String(message));
+  }
+  /**
+   * Prompt message to current session.
+   *
+   * @param message - Message to prompt
+   * @returns Message from current session
+   *
+   * @async
+   */
+  prompt(message) {
+    return new Promise((resolve) => {
+      this.api.adapter.ctx[import_global.Symbols.promise].set(this.id, [
+        ...this.api.adapter.ctx[import_global.Symbols.promise].get(this.id) ?? [],
+        resolve
+      ]);
+      this.quick(message ?? "corei18n.template.prompt").then(() => {
+      });
+    }).finally(() => this.api.adapter.ctx[import_global.Symbols.promise].delete(this.id));
+  }
+  /**
+   * Confirm message to current session.
+   *
+   * @param options - Options to confirm
+   * @returns Message from current session
+   *
+   * @async
+   */
+  confirm(options) {
+    return new Promise((resolve) => {
+      this.api.adapter.ctx[import_global.Symbols.promise].set(this.id, [
+        ...this.api.adapter.ctx[import_global.Symbols.promise].get(this.id) ?? [],
+        (message) => resolve(message === (options?.sure ?? "corei18n.template.confirm.sure"))
+      ]);
+      this.quick(options?.message ?? "corei18n.template.confirm").then(() => {
+      });
+    }).finally(() => this.api.adapter.ctx[import_global.Symbols.promise].delete(this.id));
+  }
+  /**
+   * Create a command error.
+   *
+   * @param type - Error type
+   * @param data - Error data
+   * @returns Command error
+   */
+  error(type, data) {
+    return new import_error.CommandError(Object.assign(data ?? {}, { type }));
+  }
+  t;
+  /**
+   * Session type
+   *
+   * @readonly
+   */
+  type;
+  /**
+   * Session time, milliseconds timestamp.
+   *
+   * @readonly
+   */
+  time;
+  /**
+   * Session related user id if exists.
+   *
+   * @readonly
+   */
+  userId;
+  /**
+   * Session related operator id if exists.
+   *
+   * @readonly
+   */
+  operatorId;
+  /**
+   * Session related message id if exists.
+   *
+   * @readonly
+   */
+  messageId;
+  /**
+   * Session related group id if exists.
+   *
+   * @readonly
+   */
+  groupId;
+  /**
+   * Session related channel id if exists.
+   *
+   * @readonly
+   */
+  channelId;
+  /**
+   * Session related guild id if exists.
+   *
+   * @readonly
+   */
+  guildId;
+  /**
+   * Session related meta data if exists, it is customized by the specific adapter.
+   *
+   * @readonly
+   */
+  meta;
+  /**
+   * Create a session instance.
+   *
+   * @param data - Session data
+   * @param adapter - Adapter instance
+   *
+   * @constructor
+   */
+  constructor(data, adapter) {
+    this.api = adapter.api;
+    this.el = adapter.elements;
+    this.i18n = adapter.ctx.i18n.extends(adapter.config.lang);
+    this.type = data.type;
+    this.userId = data.userId;
+    this.groupId = data.groupId;
+    this.operatorId = data.operatorId;
+    this.time = data.time;
+    this.meta = data.meta;
+    switch (this.type) {
+      case import_types.MessageScope.PRIVATE:
+        this.id = `${import_types.MessageScope.PRIVATE}|${this.userId}`;
+        break;
+      case import_types.MessageScope.GROUP:
+        this.id = `${import_types.MessageScope.GROUP}|${this.groupId}|${this.userId}`;
+        break;
+      case import_types.MessageScope.CHANNEL:
+        this.id = `${import_types.MessageScope.CHANNEL}|${this.channelId}|${this.guildId}|${this.userId}`;
+        break;
+    }
+    this.format = (0, import_factory.formatFactory)(this.i18n);
+    this.t = this.i18n.t.bind(this.i18n);
+  }
+}
+const Session = new Proxy(SessionOrigin, {
+  construct: (target, args, newTarget) => new Proxy(Reflect.construct(target, args, newTarget), {
+    get: (target2, prop, receiver) => {
+      const result = Reflect.get(target2, prop, receiver);
+      return result === void 0 ? args[0][prop] : result;
+    }
+  })
+});
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Session
+});

package/lib/decorators/index.d.ts

@@ -0,0 +1,7 @@
+import Decorators from './utils';
+export * from './plugin';
+export * from './utils';
+export declare function plugins(plugin: string | string[] | {
+    name: string;
+}): Decorators;
+export default plugins;