@kotori-bot/core 1.6.5 → 1.7.1

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<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/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,12 +0,0 @@
-import 'reflect-metadata';
-export * from './app';
-export * from './components';
-export * from './decorators';
-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 {};

package/lib/types/api.d.ts

@@ -1,72 +0,0 @@
-/// <reference types="node" />
-/** Response for sending message */
-export interface SendMessageResponse {
-    /** Message id */
-    messageId: string;
-    /** Send time (milliseconds timestamp) */
-    time: number;
-}
-/** Response for bot self information */
-export interface SelfInfoResponse {
-    /** User id */
-    userId: string;
-    /** User name or nickname */
-    username: string;
-    /** The display name, or empty string if none */
-    userDisplayname: string;
-}
-/** Response for user information */
-export interface UserInfoResponse extends SelfInfoResponse {
-    /** The remark name set set by current bot account, or empty string if none */
-    userRemark: string;
-}
-/** Response for group information */
-export interface GroupInfoResponse {
-    /** Group id */
-    groupId: string;
-    /** Group name */
-    groupName: string;
-}
-/** Response for guild information */
-export interface GuildInfoResponse {
-    /** Guild id */
-    guildId: string;
-    /** Guild name */
-    guildName: string;
-}
-/** Response for channel information */
-export interface ChannelInfoResponse {
-    /** Channel id */
-    channelId: string;
-    /** Channel name */
-    channelName: string;
-}
-/** Response for file upload */
-export interface UploadFileResponse {
-    /** File id */
-    filedId: string;
-}
-/** Response for file get */
-export interface GetFileResponse {
-    /** File name */
-    name: string;
-    /** File data (origin binary)'s SHA256 checksum, all lowercase, optional  */
-    sha256?: string;
-}
-/** Response for file get url */
-export interface GetFileUrlResponse extends GetFileResponse {
-    /** File url */
-    url: string;
-    /** File download url headers, or empty object if none */
-    headers: Record<string, string>;
-}
-/** Response for file get path */
-export interface GetFilePathResponse extends GetFileResponse {
-    /** File path */
-    path: string;
-}
-/** Response for file get data */
-export interface GetFileDataResponse extends GetFileResponse {
-    /** File data */
-    data: Buffer;
-}

package/lib/types/command.d.ts

@@ -1,78 +0,0 @@
-import Tsu from 'tsukiko';
-import type { TsuError } from 'tsukiko';
-import type { MessageQuick, MessageScope, UserAccess } from './message';
-import type { SessionMsg, SessionMsgChannel, SessionMsgGroup, SessionMsgPrivate } from '../components';
-export type ArgsOrigin = CommandArgType[];
-export type OptsOrigin = Record<string, CommandArgType>;
-export type CommandAction<Args = ArgsOrigin, Opts = OptsOrigin, Scope = 'all'> = (data: {
-    args: Args;
-    options: Opts;
-}, session: Scope extends MessageScope.PRIVATE ? SessionMsgPrivate : Scope extends MessageScope.GROUP ? SessionMsgGroup : Scope extends MessageScope.CHANNEL ? SessionMsgChannel : SessionMsg) => MessageQuick;
-export type CommandArgType = string | number | boolean;
-export declare const commandArgTypeSignSchema: import("tsukiko").UnionParser<[import("tsukiko").LiteralParser<"string">, import("tsukiko").LiteralParser<"number">, import("tsukiko").LiteralParser<"boolean">]>;
-export type CommandArgTypeSign = Tsu.infer<typeof commandArgTypeSignSchema>;
-/** Command instance config */
-export interface CommandConfig {
-    /** Command alias (need bring command prefix) */
-    alias?: string[];
-    /** Command shortcut (needn't bring command prefix) */
-    shortcut?: string[];
-    /** Command required message scope (session type) */
-    scope?: MessageScope | 'all';
-    /** Command required user access level */
-    access?: UserAccess;
-    /** Command help message (have more details than command description) */
-    help?: string;
-    /** Command action */
-    action?: CommandAction;
-}
-interface CommandParseResult {
-    option_error: {
-        expected: CommandArgTypeSign;
-        reality: CommandArgTypeSign;
-        target: string;
-    };
-    arg_error: {
-        expected: CommandArgTypeSign;
-        reality: CommandArgTypeSign;
-        index: number;
-    };
-    arg_many: {
-        expected: number;
-        reality: number;
-    };
-    arg_few: CommandParseResult['arg_many'];
-    syntax: {
-        index: number;
-        char: string;
-    };
-    unknown: {
-        input: string;
-    };
-}
-export interface CommandResult extends CommandParseResult {
-    error: {
-        error: unknown;
-    };
-    data_error: {
-        target: string | number;
-    };
-    res_error: {
-        error: TsuError;
-    };
-    num_error: null;
-    no_access_manger: null;
-    no_access_admin: null;
-    disable: null;
-    exists: {
-        target: string;
-    };
-    no_exists: CommandResult['exists'];
-}
-type CommandResultNoArgs = 'num_error' | 'no_access_manger' | 'no_access_admin' | 'disable';
-export type CommandResultExtra = {
-    [K in keyof CommandResult]: {
-        type: K;
-    } & (K extends CommandResultNoArgs ? object : CommandResult[K]);
-};
-export {};

package/lib/types/config.d.ts

@@ -1,21 +0,0 @@
-import type { LocaleType } from '@kotori-bot/i18n';
-import type { ModuleConfig } from 'fluoro';
-export interface CoreConfig {
-    global: GlobalConfig;
-    adapter: {
-        [propName: string]: AdapterConfig;
-    };
-    plugin: {
-        [propName: string]: ModuleConfig;
-    };
-}
-export interface GlobalConfig {
-    lang: LocaleType;
-    commandPrefix: string;
-}
-export interface AdapterConfig {
-    extends: string;
-    master: string;
-    lang: LocaleType;
-    commandPrefix: string;
-}

package/lib/types/events.d.ts

@@ -1,3 +0,0 @@
-import type { EventsMapping as EventsMappingFluoro } from 'fluoro';
-export interface EventsMapping extends EventsMappingFluoro {
-}

package/lib/types/filter.d.ts

@@ -1,51 +0,0 @@
-export declare enum FilterTestList {
-    PLATFORM = "platform",
-    USER_ID = "userId",
-    GROUP_ID = "groupId",
-    OPERATOR_ID = "operatorId",
-    MESSAGE_ID = "messageId",
-    SCOPE = "scope",
-    ACCESS = "access",
-    IDENTITY = "identity",
-    LOCALE_TYPE = "localeType",
-    SELF_ID = "selfId"
-}
-export type FilterOption = FilterOptionBase | FilterOptionGroup;
-/** Single filter option  */
-export interface FilterOptionBase {
-    test: FilterTestList;
-    operator: '==' | '!=' | '>' | '<' | '>=' | '<=';
-    value: string | number | boolean;
-}
-/** Group filters option */
-export interface FilterOptionGroup {
-    /** Match type, filters of all passed, filter of any one passed, filters of none passed  */
-    type: 'all_of' | 'any_of' | 'none_of';
-    /** Filters list */
-    filters: FilterOption[];
-}
-export declare const filterOptionBaseSchema: import("tsukiko").ObjectParser<{
-    test: import("tsukiko").CustomParser<FilterTestList>;
-    operator: import("tsukiko").UnionParser<[import("tsukiko").LiteralParser<"==">, import("tsukiko").LiteralParser<"!=">, import("tsukiko").LiteralParser<">">, import("tsukiko").LiteralParser<"<">, import("tsukiko").LiteralParser<">=">, import("tsukiko").LiteralParser<"<=">]>;
-    value: import("tsukiko").UnionParser<[import("tsukiko").StringParser, import("tsukiko").NumberParser, import("tsukiko").BooleanParser]>;
-}>;
-export declare const filterOptionGroupSchema: import("tsukiko").ObjectParser<{
-    type: import("tsukiko").UnionParser<[import("tsukiko").LiteralParser<"all_of">, import("tsukiko").LiteralParser<"any_of">, import("tsukiko").LiteralParser<"none_of">]>;
-    filters: import("tsukiko").ArrayParser<import("tsukiko").ObjectParser<{
-        test: import("tsukiko").CustomParser<FilterTestList>;
-        operator: import("tsukiko").UnionParser<[import("tsukiko").LiteralParser<"==">, import("tsukiko").LiteralParser<"!=">, import("tsukiko").LiteralParser<">">, import("tsukiko").LiteralParser<"<">, import("tsukiko").LiteralParser<">=">, import("tsukiko").LiteralParser<"<=">]>;
-        value: import("tsukiko").UnionParser<[import("tsukiko").StringParser, import("tsukiko").NumberParser, import("tsukiko").BooleanParser]>;
-    }>>;
-}>;
-export declare const filterOptionSchema: import("tsukiko").UnionParser<[import("tsukiko").ObjectParser<{
-    test: import("tsukiko").CustomParser<FilterTestList>;
-    operator: import("tsukiko").UnionParser<[import("tsukiko").LiteralParser<"==">, import("tsukiko").LiteralParser<"!=">, import("tsukiko").LiteralParser<">">, import("tsukiko").LiteralParser<"<">, import("tsukiko").LiteralParser<">=">, import("tsukiko").LiteralParser<"<=">]>;
-    value: import("tsukiko").UnionParser<[import("tsukiko").StringParser, import("tsukiko").NumberParser, import("tsukiko").BooleanParser]>;
-}>, import("tsukiko").ObjectParser<{
-    type: import("tsukiko").UnionParser<[import("tsukiko").LiteralParser<"all_of">, import("tsukiko").LiteralParser<"any_of">, import("tsukiko").LiteralParser<"none_of">]>;
-    filters: import("tsukiko").ArrayParser<import("tsukiko").ObjectParser<{
-        test: import("tsukiko").CustomParser<FilterTestList>;
-        operator: import("tsukiko").UnionParser<[import("tsukiko").LiteralParser<"==">, import("tsukiko").LiteralParser<"!=">, import("tsukiko").LiteralParser<">">, import("tsukiko").LiteralParser<"<">, import("tsukiko").LiteralParser<">=">, import("tsukiko").LiteralParser<"<=">]>;
-        value: import("tsukiko").UnionParser<[import("tsukiko").StringParser, import("tsukiko").NumberParser, import("tsukiko").BooleanParser]>;
-    }>>;
-}>]>;

package/lib/types/index.d.ts

@@ -1,7 +0,0 @@
-export * from './config';
-export * from './message';
-export * from './adapter';
-export * from './api';
-export * from './filter';
-export * from './session';
-export * from './command';