@kotori-bot/core 1.7.0 → 1.7.1

package/lib/components/elements.d.ts

@@ -1,144 +0,0 @@
-import type { Adapter } from './adapter';
-import type { Message, MessageMapping } from '../types';
-/**
- * Elements handler base class.
- *
- * @abstract
- */
-export declare abstract class Elements {
-    /**
-     * Adapter instance.
-     *
-     * @readonly
-     */
-    readonly adapter: Adapter<any, any, any>;
-    /**
-     * Decode a elements handler.
-     *
-     * @param adapter - Adapter instance
-     */
-    constructor(adapter: Adapter<any, any, any>);
-    /**
-     * Encode raw message string to `Message`.
-     *
-     * @param raw - Raw message
-     * @param meta - Message metadata
-     * @returns Encoded message
-     *
-     * @abstract
-     */
-    abstract encode(raw: string, meta?: object): Message;
-    /**
-     * Decode `Message` elements to string.
-     *
-     * @param message - Message to decode
-     * @param meta - Message metadata
-     * @returns Decoded message
-     *
-     * @abstract
-     */
-    abstract decode(message: Message, meta?: object): string;
-    /**
-     * Decode a mention message.
-     *
-     * @param userId - User id
-     * @param meta - Message metadata
-     * @returns Mention message
-     *
-     * @deprecated
-     */
-    mention(userId: string, meta?: object): string;
-    /**
-     * Decode a mention all message.
-     *
-     * @param meta - Message metadata
-     * @returns Mention all message
-     *
-     * @deprecated
-     */
-    mentionAll(meta?: object): string;
-    /**
-     * Decode an image message.
-     *
-     * @param content - Image content
-     * @param meta - Message metadata
-     * @returns Image message
-     *
-     * @deprecated
-     */
-    image(content: string, meta?: object): string;
-    /**
-     * Decode a voice message.
-     *
-     * @param content - Voice content
-     * @param meta - Message metadata
-     * @returns Voice message
-     *
-     * @deprecated
-     */
-    voice(content: string, meta?: object): string;
-    /**
-     * Decode an audio message.
-     *
-     * @param content - Audio content
-     * @param meta - Message metadata
-     * @returns Audio message
-     *
-     * @deprecated
-     */
-    audio(content: string, meta?: object): string;
-    /**
-     * Decode a video message.
-     *
-     * @param content - Video content
-     * @param meta - Message metadata
-     * @returns Video message
-     *
-     * @deprecated
-     */
-    video(content: string, meta?: object): string;
-    /**
-     * Decode a file message.
-     *
-     * @param content - File content
-     * @param meta - Message metadata
-     * @returns File message
-     *
-     * @deprecated
-     */
-    file(content: string, meta?: object): string;
-    /**
-     * Decode a location message.
-     *
-     * @param latitude - Latitude
-     * @param longitude - Longitude
-     * @param title - Title
-     * @param content - Content
-     * @param meta - Message metadata
-     * @returns Location message
-     *
-     * @deprecated
-     */
-    location(latitude: number, longitude: number, title: string, content: string, meta?: object): string;
-    /**
-     * Decode a reply message.
-     *
-     * @param messageId - Message id
-     * @param meta - Message metadata
-     * @returns Reply message
-     *
-     * @deprecated
-     */
-    reply(messageId: string, meta?: object): string;
-    /**
-     * Get supported elements.
-     *
-     * @returns Supported elements
-     *
-     * @abstract
-     *
-     * @deprecated
-     */
-    abstract getSupportsElements(): (keyof MessageMapping)[];
-}
-export default Elements;

package/lib/components/filter.d.ts

@@ -1,22 +0,0 @@
-import type { Session } from '../components';
-import { type FilterOption } from '../types';
-/**
- * Session filter.
- *
- * @class
- */
-export declare class Filter {
-    private static getTestDomain;
-    private static handleFilter;
-    private readonly option;
-    /**
-     * Create a filter.
-     *
-     * @param option - Filter options
-     *
-     * @constructor
-     */
-    constructor(option: FilterOption);
-    test(session: Session): boolean;
-}
-export default Filter;

package/lib/components/index.d.ts

@@ -1,8 +0,0 @@
-export * from './adapter';
-export * from './api';
-export * from './elements';
-export * from './cache';
-export * from './filter';
-export * from './session';
-export * from './command';
-export * from './messages';

package/lib/components/messages.d.ts

@@ -1,186 +0,0 @@
-import type { Message, MessageMapping } from '../types';
-type MessageTypeList = {
-    [K in keyof MessageMapping]: {
-        type: K;
-    } & MessageMapping[K];
-};
-/**
- * Single message class.
- *
- * @template T - Message type
- */
-export declare class MessageSingle<T extends keyof MessageMapping> extends String {
-    /**
-     * Message data.
-     *
-     * @readonly
-     */
-    data: MessageTypeList[T];
-    /**
-     * Create a single message
-     *
-     * @param type - Message type
-     * @param data - Message data
-     */
-    constructor(type: T, data: MessageMapping[T]);
-    /**
-     * Convert message to string.
-     *
-     * @param isStrict - Whether to strictly convert message, strict convert will ignore the elements else text
-     * @returns Message string
-     */
-    toString(isStrict?: boolean): string;
-    /**
-     * Check whether the message is text.
-     *
-     * @returns Whether the message is text
-     */
-    isText(): boolean;
-}
-declare class MessageListOrigin<T extends keyof MessageMapping> extends Array<MessageSingle<T>> {
-    /**
-     * Create a message list.
-     *
-     * @param messages - Message list
-     */
-    constructor(...messages: Message<T>[]);
-    /**
-     * 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?: boolean): string;
-    /**
-     * Check whether the message list is pure.
-     *
-     * @param keys - Message type list
-     *
-     * @returns Whether the message list is pure
-     */
-    isPure<T extends keyof MessageMapping>(...keys: T[]): boolean;
-    /**
-     * Check whether the message list is text.
-     *
-     * @returns Whether the message list is text
-     */
-    isText(): boolean;
-    /**
-     * Pick message list.
-     *
-     * @param keys - Message type list
-     * @returns Message list
-     */
-    pick<T extends keyof MessageMapping>(...keys: T[]): MessageList<T>;
-    /**
-     * Omit message list.
-     *
-     * @param keys - Message type list
-     * @returns Message list
-     */
-    omit<T extends keyof MessageMapping>(...keys: T[]): MessageList<T>;
-}
-/**
- * Message list class.
- *
- * @template T - Message type
- * @class
- */
-export type MessageList<T extends keyof MessageMapping> = (typeof String)['prototype'] & MessageListOrigin<T>;
-export declare const MessageList: new <T extends keyof MessageMapping = keyof MessageMapping>(...args: ConstructorParameters<typeof MessageListOrigin>) => MessageList<T>;
-/**
- * Create a message list.
- *
- * @param messages - Message list
- * @returns Message list
- */
-export declare function Messages<T extends keyof MessageMapping = keyof MessageMapping>(...messages: Message<T>[]): MessageList<keyof MessageMapping>;
-/**
- * Messages namespace
- *
- * @namespace
- */
-export declare namespace Messages {
-    /**
-     * Create a text message.
-     *
-     * @param text - Text string
-     * @returns Text message
-     */
-    function text(text: string): MessageSingle<"text">;
-    /**
-     * Create a mention message.
-     *
-     * @param userId - User id
-     * @returns Mention message
-     */
-    function mention(userId: string): MessageSingle<"mention">;
-    /**
-     * Create a mention all message.
-     *
-     * @returns Mention all message
-     */
-    function mentionAll(): MessageSingle<"mentionAll">;
-    /**
-     * Create an image message.
-     *
-     * @param content - Image content
-     * @returns Image message
-     */
-    function image(content: string): MessageSingle<"image">;
-    /**
-     * Create a voice message.
-     *
-     * @param content - Voice content
-     * @returns Voice message
-     */
-    function voice(content: string): MessageSingle<"voice">;
-    /**
-     * Create an audio message.
-     *
-     * @param content - Audio content
-     * @returns Audio message
-     */
-    function audio(content: string): MessageSingle<"audio">;
-    /**
-     * Create a video message.
-     *
-     * @param content - Video content
-     * @returns Video message
-     */
-    function video(content: string): MessageSingle<"video">;
-    /**
-     * Create a file message.
-     *
-     * @param content - File content
-     * @returns File message
-     */
-    function file(content: string): MessageSingle<"file">;
-    /**
-     * Create a location message.
-     *
-     * @param latitude - Latitude
-     * @param longitude - Longitude
-     * @param title - Title
-     * @param content - Content
-     * @returns Location message
-     */
-    function location(latitude: number, longitude: number, title: string, content: string): MessageSingle<"location">;
-    /**
-     * Create a reply message.
-     *
-     * @param messageId - Message id
-     * @returns Reply message
-     */
-    function reply(messageId: string): MessageSingle<"reply">;
-    /**
-     * Stringify message.
-     *
-     * @param type - Message type
-     * @param data - Message data
-     * @param isStrict - Whether to strictly convert message, strict convert will ignore the elements else text
-     * @returns Message string
-     */
-    function stringify<T extends keyof MessageMapping>(type: T, data: MessageMapping[T], isStrict?: boolean): string;
-}
-export default Messages;

package/lib/components/session.d.ts

@@ -1,177 +0,0 @@
-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<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/decorators/index.d.ts

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

package/lib/decorators/plugin.d.ts

@@ -1,7 +0,0 @@
-import type { Context } from '../app';
-export declare abstract class KotoriPlugin<T extends object | undefined = undefined> {
-    protected readonly ctx: Context;
-    protected readonly config: T;
-    constructor(ctx: Context, config: T);
-}
-export default KotoriPlugin;

package/lib/decorators/utils.d.ts

@@ -1,60 +0,0 @@
-import 'reflect-metadata';
-import { type EventsList, type ModuleConfig } from 'fluoro';
-import { type Constructor, Parser } from 'tsukiko';
-import { Symbols } from '../global';
-import type { CommandConfig } from '../types';
-import type { KotoriPlugin } from './plugin';
-import type { Context } from '../app';
-declare module '../types/events' {
-    interface EventsMapping {
-        literal_ready_module_decorator(name: string, config: ModuleConfig): void;
-    }
-}
-interface EventOption {
-    type: keyof EventsList;
-    isOnce?: boolean;
-}
-interface CommandOption extends Omit<CommandConfig, 'action'> {
-    template: string;
-    options?: [string, string][];
-}
-interface MidwareOption {
-    priority?: number;
-}
-interface RegexpOption {
-    match: RegExp;
-}
-type TaskOption = Exclude<Parameters<Context['task']>[0], string>;
-type Fn = (...args: any[]) => any;
-interface PluginMetaAll {
-    name: string;
-    lang?: string;
-    inject: string[];
-    schema?: Parser<object>;
-    events: [Fn, EventOption, boolean][];
-    midwares: [Fn, MidwareOption, boolean][];
-    commands: [Fn, CommandOption, boolean][];
-    regexps: [Fn, RegexpOption, boolean][];
-    tasks: [Fn, TaskOption, boolean][];
-}
-type KotoriPluginChild = new (...args: ConstructorParameters<typeof KotoriPlugin>) => KotoriPlugin;
-export declare class Decorators {
-    static [Symbols.decorator]: Map<string, KotoriPluginChild>;
-    static getMeta(target: object | string): PluginMetaAll | undefined;
-    static setup(ctx: Context): void;
-    static load(ctx: Context, target: string | Constructor, config: ModuleConfig): boolean;
-    private readonly pkgName;
-    private error;
-    private getMeta;
-    constructor(pkgName: string);
-    readonly import: (target: object) => void;
-    readonly lang: <T extends object>(target: T, name: keyof T) => void;
-    readonly inject: <T extends object>(target: T, name: keyof T) => void;
-    readonly schema: <T extends object>(target: T, name: keyof T) => void;
-    on(options: EventOption): <T extends object>(target: T, key: keyof T) => void;
-    midware(options?: MidwareOption): <T extends object>(target: T, key: keyof T) => void;
-    command(options: CommandOption): <T extends object>(target: T, key: keyof T) => void;
-    regexp(options: RegexpOption): <T extends object>(target: T, key: keyof T) => void;
-    task(options: TaskOption): <T extends object>(target: T, key: keyof T) => void;
-}
-export default Decorators;

package/lib/global/constants.d.ts

@@ -1,8 +0,0 @@
-export declare const DEFAULT_CORE_CONFIG: {
-    global: {
-        lang: "common" | "en_US" | "en_GB" | "en_AU" | "zh_CN" | "zh_HK" | "zh_TW" | "zh_SG" | "es_ES" | "es_MX" | "ar_EG" | "ar_AE" | "ru_RU" | "fr_FR" | "fr_CA" | "de_DE" | "de_CH" | "it_IT" | "it_CH" | "hi_IN" | "pt_BR" | "pt_PT" | "tr_TR" | "ja_JP" | "id_ID" | "uk_UA" | "vi_VN" | "th_TH" | "sv_SE" | "nb_NO" | "da_DK" | "fi_FI" | "he_IL" | "sk_SK" | "bg_BG" | "lt_LT" | "sl_SI" | "sr_RS" | "mk_MK" | "sq_AL" | "et_EE" | "mt_MT";
-        commandPrefix: string;
-    };
-    adapter: {};
-    plugin: {};
-};

package/lib/global/index.d.ts

@@ -1,2 +0,0 @@
-export * from './constants';
-export * from './symbols';

package/lib/global/symbols.d.ts

@@ -1,15 +0,0 @@
-export declare namespace Symbols {
-    const adapter: unique symbol;
-    const bot: unique symbol;
-    const midware: unique symbol;
-    const command: unique symbol;
-    const regexp: unique symbol;
-    const task: unique symbol;
-    const filter: unique symbol;
-    const promise: unique symbol;
-    const decorator: unique symbol;
-    const modules: unique symbol;
-    const getInstance: unique symbol;
-    const setInstance: unique symbol;
-}
-export default Symbols;

package/lib/index.d.ts

@@ -1,13 +0,0 @@
-import 'reflect-metadata';
-export * from './app';
-export * from './components';
-export * from './decorators';
-export * from './utils/jsx';
-export * from './utils/error';
-export * from './utils/factory';
-export * from './utils/container';
-export * from './global';
-export * from './types';
-export * from '@kotori-bot/tools';
-export * from '@kotori-bot/i18n';
-export * from 'tsukiko';

package/lib/types/adapter.d.ts

@@ -1,22 +0,0 @@
-import type { Context } from '../app';
-import type { Adapter } from '../components';
-import type { AdapterConfig } from './config';
-declare module './events' {
-    interface EventsMapping {
-        connect(data: EventDataConnect): void;
-        status(data: EventDataStatus): void;
-    }
-}
-interface EventDataConnect {
-    adapter: Adapter;
-    type: 'connect' | 'disconnect';
-    normal: boolean;
-    mode: 'ws' | 'ws-reverse' | 'other';
-    address: string;
-}
-interface EventDataStatus {
-    adapter: Adapter;
-    status: Adapter['status']['value'];
-}
-export type AdapterClass = new (ctx: Context, config: AdapterConfig, identity: string) => Adapter;
-export {};