@kotori-bot/core 1.5.1 → 1.6.0

package/lib/types/api.d.ts

@@ -0,0 +1,72 @@
+/// <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/{utils/jsxFactory.js → types/api.js}

@@ -1,12 +1,12 @@
 
 /**
  * @Package @kotori-bot/core
- * @Version 1.5.0
- * @Author Hotaru <biyuehuya@gmail.com>
+ * @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/6/7 11:22:22
+ * @Date 2024/8/9 17:33:05
  */
 
 "use strict";
@@ -23,5 +23,5 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var jsxFactory_exports = {};
-module.exports = __toCommonJS(jsxFactory_exports);
+var api_exports = {};
+module.exports = __toCommonJS(api_exports);

package/lib/types/command.d.ts

@@ -0,0 +1,78 @@
+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/command.js

@@ -0,0 +1,50 @@
+
+/**
+ * @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 __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+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 __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var command_exports = {};
+__export(command_exports, {
+  commandArgTypeSignSchema: () => commandArgTypeSignSchema
+});
+module.exports = __toCommonJS(command_exports);
+var import_tsukiko = __toESM(require("tsukiko"));
+const commandArgTypeSignSchema = import_tsukiko.default.Union(import_tsukiko.default.Literal("string"), import_tsukiko.default.Literal("number"), import_tsukiko.default.Literal("boolean"));
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  commandArgTypeSignSchema
+});

package/lib/types/config.d.ts

@@ -1,6 +1,5 @@
 import type { LocaleType } from '@kotori-bot/i18n';
-import { ModuleConfig } from 'fluoro';
-import type { EventDataTargetId } from './message';
+import type { ModuleConfig } from 'fluoro';
 export interface CoreConfig {
     global: GlobalConfig;
     adapter: {
@@ -11,13 +10,12 @@ export interface CoreConfig {
     };
 }
 export interface GlobalConfig {
-    level?: number;
     lang: LocaleType;
-    'command-prefix': string;
+    commandPrefix: string;
 }
 export interface AdapterConfig {
     extends: string;
-    master: EventDataTargetId;
+    master: string;
     lang: LocaleType;
-    'command-prefix': string;
+    commandPrefix: string;
 }

package/lib/types/config.js

@@ -1,12 +1,12 @@
 
 /**
  * @Package @kotori-bot/core
- * @Version 1.5.0
- * @Author Hotaru <biyuehuya@gmail.com>
+ * @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/6/7 11:22:22
+ * @Date 2024/8/9 17:33:05
  */
 
 "use strict";

package/lib/types/filter.d.ts

@@ -0,0 +1,51 @@
+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/filter.js

@@ -0,0 +1,87 @@
+
+/**
+ * @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 __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+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 __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var filter_exports = {};
+__export(filter_exports, {
+  FilterTestList: () => FilterTestList,
+  filterOptionBaseSchema: () => filterOptionBaseSchema,
+  filterOptionGroupSchema: () => filterOptionGroupSchema,
+  filterOptionSchema: () => filterOptionSchema
+});
+module.exports = __toCommonJS(filter_exports);
+var import_tsukiko = __toESM(require("tsukiko"));
+var FilterTestList = /* @__PURE__ */ ((FilterTestList2) => {
+  FilterTestList2["PLATFORM"] = "platform";
+  FilterTestList2["USER_ID"] = "userId";
+  FilterTestList2["GROUP_ID"] = "groupId";
+  FilterTestList2["OPERATOR_ID"] = "operatorId";
+  FilterTestList2["MESSAGE_ID"] = "messageId";
+  FilterTestList2["SCOPE"] = "scope";
+  FilterTestList2["ACCESS"] = "access";
+  FilterTestList2["IDENTITY"] = "identity";
+  FilterTestList2["LOCALE_TYPE"] = "localeType";
+  FilterTestList2["SELF_ID"] = "selfId";
+  return FilterTestList2;
+})(FilterTestList || {});
+const filterOptionBaseSchema = import_tsukiko.default.Object({
+  test: import_tsukiko.default.Custom(
+    (value) => typeof value === "string" && Object.values(FilterTestList).includes(value)
+  ).describe("Testing item"),
+  operator: import_tsukiko.default.Union(
+    import_tsukiko.default.Literal("=="),
+    import_tsukiko.default.Literal("!="),
+    import_tsukiko.default.Literal(">"),
+    import_tsukiko.default.Literal("<"),
+    import_tsukiko.default.Literal(">="),
+    import_tsukiko.default.Literal("<=")
+  ).describe("Testing operation"),
+  value: import_tsukiko.default.Union(import_tsukiko.default.String(), import_tsukiko.default.Number(), import_tsukiko.default.Boolean()).describe("Expect value")
+});
+const filterOptionGroupSchema = import_tsukiko.default.Object({
+  type: import_tsukiko.default.Union(import_tsukiko.default.Literal("all_of"), import_tsukiko.default.Literal("any_of"), import_tsukiko.default.Literal("none_of")).describe("Match type"),
+  filters: import_tsukiko.default.Array(filterOptionBaseSchema).describe("Filters list")
+});
+const filterOptionSchema = import_tsukiko.default.Union(filterOptionBaseSchema, filterOptionGroupSchema);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  FilterTestList,
+  filterOptionBaseSchema,
+  filterOptionGroupSchema,
+  filterOptionSchema
+});

package/lib/types/index.d.ts

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

package/lib/types/index.js

@@ -1,12 +1,12 @@
 
 /**
  * @Package @kotori-bot/core
- * @Version 1.5.0
- * @Author Hotaru <biyuehuya@gmail.com>
+ * @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/6/7 11:22:22
+ * @Date 2024/8/9 17:33:05
  */
 
 "use strict";
@@ -29,9 +29,17 @@ module.exports = __toCommonJS(types_exports);
 __reExport(types_exports, require("./config"), module.exports);
 __reExport(types_exports, require("./message"), module.exports);
 __reExport(types_exports, require("./adapter"), module.exports);
+__reExport(types_exports, require("./api"), module.exports);
+__reExport(types_exports, require("./filter"), module.exports);
+__reExport(types_exports, require("./session"), module.exports);
+__reExport(types_exports, require("./command"), module.exports);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   ...require("./config"),
   ...require("./message"),
-  ...require("./adapter")
+  ...require("./adapter"),
+  ...require("./api"),
+  ...require("./filter"),
+  ...require("./session"),
+  ...require("./command")
 });