@zhin.js/adapter-discord 1.0.7 → 1.0.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,21 @@
1
1
  # @zhin.js/adapter-discord
2
2
 
3
+ ## 1.0.9
4
+
5
+ ### Patch Changes
6
+
7
+ - c490260: fix: 更新脚手架结构,优化包依赖
8
+ - zhin.js@1.0.9
9
+
10
+ ## 1.0.8
11
+
12
+ ### Patch Changes
13
+
14
+ - 551c4d2: fix: 插件支持配置文件读取,优化 test 用例
15
+ - Updated dependencies [551c4d2]
16
+ - @zhin.js/types@1.0.3
17
+ - zhin.js@1.0.8
18
+
3
19
  ## 1.0.7
4
20
 
5
21
  ### Patch Changes
package/README.md CHANGED
@@ -13,29 +13,41 @@ pnpm add @zhin.js/adapter-discord
13
13
  ### Gateway 模式配置(推荐常规使用)
14
14
 
15
15
  ```typescript
16
- import { DiscordBotConfig } from '@zhin.js/adapter-discord';
16
+ // zhin.config.ts
17
+ import { defineConfig } from 'zhin.js'
17
18
 
18
- const config: DiscordBotConfig = {
19
- context: 'discord',
20
- name: 'my-discord-bot',
21
- token: 'YOUR_BOT_TOKEN', // 从 Discord Developer Portal 获取的 Bot Token
22
- }
19
+ export default defineConfig({
20
+ bots: [
21
+ {
22
+ context: 'discord',
23
+ name: 'my-discord-bot',
24
+ token: process.env.DISCORD_TOKEN, // 从 Discord Developer Portal 获取的 Bot Token
25
+ }
26
+ ],
27
+ plugins: ['adapter-discord']
28
+ })
23
29
  ```
24
30
 
25
31
  ### Interactions 端点模式配置(推荐高性能场景)
26
32
 
27
33
  ```typescript
28
- import { DiscordInteractionsConfig } from '@zhin.js/adapter-discord';
34
+ // zhin.config.ts
35
+ import { defineConfig } from 'zhin.js'
29
36
 
30
- const config: DiscordInteractionsConfig = {
31
- context: 'discord-interactions',
32
- name: 'my-discord-bot',
33
- token: 'YOUR_BOT_TOKEN',
34
- applicationId: 'YOUR_APPLICATION_ID', // Discord 应用 ID
35
- publicKey: 'YOUR_PUBLIC_KEY', // Discord 应用的 Public Key
36
- interactionsPath: '/discord/interactions', // 交互端点路径
37
- useGateway: false // 是否同时使用 Gateway(可选)
38
- }
37
+ export default defineConfig({
38
+ bots: [
39
+ {
40
+ context: 'discord-interactions',
41
+ name: 'my-discord-bot',
42
+ token: process.env.DISCORD_TOKEN,
43
+ applicationId: process.env.DISCORD_APPLICATION_ID, // Discord 应用 ID
44
+ publicKey: process.env.DISCORD_PUBLIC_KEY, // Discord 应用的 Public Key
45
+ interactionsPath: '/discord/interactions', // 交互端点路径
46
+ useGateway: false // 是否同时使用 Gateway(可选)
47
+ }
48
+ ],
49
+ plugins: ['adapter-discord']
50
+ })
39
51
  ```
40
52
 
41
53
  ### 通用配置参数
package/lib/index.d.ts CHANGED
@@ -1,13 +1,13 @@
1
- import { Client, GatewayIntentBits, Message as DiscordMessage, TextChannel, DMChannel, NewsChannel, ThreadChannel, EmbedBuilder, AttachmentBuilder, MessageCreateOptions, ApplicationCommandData, ChatInputCommandInteraction } from 'discord.js';
2
- import { Bot, BotConfig, Adapter, Plugin, Message, SendOptions, SendContent, MessageSegment } from "zhin.js";
3
- declare module '@zhin.js/types' {
1
+ import { Client, GatewayIntentBits, Message as DiscordMessage, TextChannel, DMChannel, NewsChannel, ThreadChannel, EmbedBuilder, AttachmentBuilder, MessageCreateOptions, ApplicationCommandData, ChatInputCommandInteraction } from "discord.js";
2
+ import { Bot, Adapter, Message, SendOptions, SendContent, MessageSegment } from "zhin.js";
3
+ declare module "@zhin.js/types" {
4
4
  interface RegisteredAdapters {
5
5
  discord: Adapter<DiscordBot>;
6
- 'discord-interactions': Adapter<DiscordInteractionsBot>;
6
+ "discord-interactions": Adapter<DiscordInteractionsBot>;
7
7
  }
8
8
  }
9
- export type DiscordBotConfig = BotConfig & {
10
- context: 'discord';
9
+ export type DiscordBotConfig = Bot.Config & {
10
+ context: "discord";
11
11
  token: string;
12
12
  name: string;
13
13
  intents?: GatewayIntentBits[];
@@ -15,13 +15,13 @@ export type DiscordBotConfig = BotConfig & {
15
15
  globalCommands?: boolean;
16
16
  defaultActivity?: {
17
17
  name: string;
18
- type: 'PLAYING' | 'STREAMING' | 'LISTENING' | 'WATCHING' | 'COMPETING';
18
+ type: "PLAYING" | "STREAMING" | "LISTENING" | "WATCHING" | "COMPETING";
19
19
  url?: string;
20
20
  };
21
21
  slashCommands?: ApplicationCommandData[];
22
22
  };
23
- export interface DiscordInteractionsConfig extends BotConfig {
24
- context: 'discord-interactions';
23
+ export interface DiscordInteractionsConfig extends Bot.Config {
24
+ context: "discord-interactions";
25
25
  token: string;
26
26
  name: string;
27
27
  applicationId: string;
@@ -33,7 +33,7 @@ export interface DiscordInteractionsConfig extends BotConfig {
33
33
  globalCommands?: boolean;
34
34
  defaultActivity?: {
35
35
  name: string;
36
- type: 'PLAYING' | 'STREAMING' | 'LISTENING' | 'WATCHING' | 'COMPETING';
36
+ type: "PLAYING" | "STREAMING" | "LISTENING" | "WATCHING" | "COMPETING";
37
37
  url?: string;
38
38
  };
39
39
  }
@@ -45,11 +45,10 @@ export interface DiscordInteractionsBot {
45
45
  }
46
46
  type DiscordChannelMessage = DiscordMessage<boolean>;
47
47
  export declare class DiscordBot extends Client implements Bot<DiscordChannelMessage, DiscordBotConfig> {
48
- private plugin;
49
48
  $config: DiscordBotConfig;
50
49
  $connected?: boolean;
51
50
  private slashCommandHandlers;
52
- constructor(plugin: Plugin, $config: DiscordBotConfig);
51
+ constructor($config: DiscordBotConfig);
53
52
  private handleDiscordMessage;
54
53
  private handleSlashCommand;
55
54
  $connect(): Promise<void>;
@@ -71,12 +70,11 @@ export declare class DiscordBot extends Client implements Bot<DiscordChannelMess
71
70
  static formatContentToText(content: SendContent): string;
72
71
  }
73
72
  export declare class DiscordInteractionsBot extends Client implements Bot<any, DiscordInteractionsConfig> {
74
- private plugin;
75
73
  $config: DiscordInteractionsConfig;
76
74
  $connected?: boolean;
77
75
  private router;
78
76
  private slashCommandHandlers;
79
- constructor(plugin: Plugin, router: any, $config: DiscordInteractionsConfig);
77
+ constructor(router: any, $config: DiscordInteractionsConfig);
80
78
  private setupInteractionsEndpoint;
81
79
  private handleInteraction;
82
80
  private verifyDiscordSignature;
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,MAAM,EACN,iBAAiB,EACjB,OAAO,IAAI,cAAc,EACzB,WAAW,EACX,SAAS,EACT,WAAW,EACX,aAAa,EACb,YAAY,EACZ,iBAAiB,EACjB,oBAAoB,EAIpB,sBAAsB,EACtB,2BAA2B,EAG9B,MAAM,YAAY,CAAC;AACpB,OAAO,EACH,GAAG,EACH,SAAS,EACT,OAAO,EACP,MAAM,EAEN,OAAO,EACP,WAAW,EACX,WAAW,EACX,cAAc,EAGjB,MAAM,SAAS,CAAC;AAOjB,OAAO,QAAQ,gBAAgB,CAAA;IAC3B,UAAU,kBAAkB;QACxB,OAAO,EAAC,OAAO,CAAC,UAAU,CAAC,CAAA;QAC3B,sBAAsB,EAAC,OAAO,CAAC,sBAAsB,CAAC,CAAA;KACzD;CACJ;AAGD,MAAM,MAAM,gBAAgB,GAAG,SAAS,GAAG;IACvC,OAAO,EAAE,SAAS,CAAA;IAClB,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,CAAC,EAAE,iBAAiB,EAAE,CAAA;IAE7B,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,eAAe,CAAC,EAAE;QACd,IAAI,EAAE,MAAM,CAAA;QACZ,IAAI,EAAE,SAAS,GAAG,WAAW,GAAG,WAAW,GAAG,UAAU,GAAG,WAAW,CAAA;QACtE,GAAG,CAAC,EAAE,MAAM,CAAA;KACf,CAAA;IAED,aAAa,CAAC,EAAE,sBAAsB,EAAE,CAAA;CAC3C,CAAA;AAGD,MAAM,WAAW,yBAA0B,SAAQ,SAAS;IACxD,OAAO,EAAE,sBAAsB,CAAA;IAC/B,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,aAAa,EAAE,MAAM,CAAA;IACrB,SAAS,EAAE,MAAM,CAAA;IACjB,gBAAgB,EAAE,MAAM,CAAA;IAExB,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,OAAO,CAAC,EAAE,iBAAiB,EAAE,CAAA;IAE7B,aAAa,CAAC,EAAE,sBAAsB,EAAE,CAAA;IACxC,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,eAAe,CAAC,EAAE;QACd,IAAI,EAAE,MAAM,CAAA;QACZ,IAAI,EAAE,SAAS,GAAG,WAAW,GAAG,WAAW,GAAG,UAAU,GAAG,WAAW,CAAA;QACtE,GAAG,CAAC,EAAE,MAAM,CAAA;KACf,CAAA;CACJ;AAGD,MAAM,WAAW,UAAU;IACvB,OAAO,EAAE,gBAAgB,CAAA;CAC5B;AAED,MAAM,WAAW,sBAAsB;IACnC,OAAO,EAAE,yBAAyB,CAAA;CACrC;AAGD,KAAK,qBAAqB,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;AAGrD,qBAAa,UAAW,SAAQ,MAAO,YAAW,GAAG,CAAC,qBAAqB,EAAE,gBAAgB,CAAC;IAI9E,OAAO,CAAC,MAAM;IAAiB,OAAO,EAAE,gBAAgB;IAHpE,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,OAAO,CAAC,oBAAoB,CAAsF;gBAE9F,MAAM,EAAE,MAAM,EAAS,OAAO,EAAE,gBAAgB;YActD,oBAAoB;YAUpB,kBAAkB;IA6B1B,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAmDzB,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IAWlC,cAAc,CAAC,GAAG,EAAE,qBAAqB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IA2D1E,mBAAmB,CAAC,GAAG,EAAE,qBAAqB,GAAG,cAAc,EAAE;IA8DjE,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,qBAAqB,GAAG,cAAc,EAAE;IA0H/E,eAAe,CAAC,UAAU,EAAE,GAAG,GAAG,cAAc,EAAE;IA4D5C,YAAY,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC;IAmBnD,oBAAoB,CACtB,OAAO,EAAE,WAAW,GAAG,SAAS,GAAG,WAAW,GAAG,aAAa,EAC9D,OAAO,EAAE,WAAW,EACpB,YAAY,GAAE,oBAAyB,GACxC,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IAsE7B,cAAc,CAAC,EAAE,EAAC,MAAM,GAAE,OAAO,CAAC,IAAI,CAAC;IAIvC,iBAAiB,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,iBAAiB,EAAE,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAoBlG,mBAAmB,CAAC,IAAI,EAAE,GAAG,GAAG,YAAY;IAoB5C,OAAO,CAAC,eAAe;YAYT,qBAAqB;IA6BnC,sBAAsB,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,WAAW,EAAE,2BAA2B,KAAK,OAAO,CAAC,IAAI,CAAC;IAKhH,yBAAyB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO;YAKzC,UAAU;IAUxB,MAAM,CAAC,mBAAmB,CAAC,OAAO,EAAE,WAAW,GAAG,MAAM;CAgC3D;AAQD,qBAAa,sBAAuB,SAAQ,MAAO,YAAW,GAAG,CAAC,GAAG,EAAE,yBAAyB,CAAC;IAKjF,OAAO,CAAC,MAAM;IAA8B,OAAO,EAAE,yBAAyB;IAJ1F,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,OAAO,CAAC,MAAM,CAAK;IACnB,OAAO,CAAC,oBAAoB,CAA8D;gBAEtE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAS,OAAO,EAAE,yBAAyB;IAe1F,OAAO,CAAC,yBAAyB;YAOnB,iBAAiB;IAqC/B,OAAO,CAAC,sBAAsB;YAahB,wBAAwB;IA4BtC,OAAO,CAAC,0BAA0B;IAoClC,OAAO,CAAC,iBAAiB;IAuCnB,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IA8BzB,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;YAapB,qBAAqB;IAqBnC,sBAAsB,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,WAAW,EAAE,GAAG,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI;IAK/F,yBAAyB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO;IAKvD,OAAO,CAAC,eAAe;IAYvB,cAAc,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAIhC,YAAY,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC;IAenD,cAAc,CAAC,EAAE,EAAC,MAAM,GAAE,OAAO,CAAC,IAAI,CAAC;CAGhD"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,MAAM,EACN,iBAAiB,EACjB,OAAO,IAAI,cAAc,EACzB,WAAW,EACX,SAAS,EACT,WAAW,EACX,aAAa,EACb,YAAY,EACZ,iBAAiB,EACjB,oBAAoB,EAIpB,sBAAsB,EACtB,2BAA2B,EAG5B,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,GAAG,EACH,OAAO,EAGP,OAAO,EACP,WAAW,EACX,WAAW,EACX,cAAc,EAIf,MAAM,SAAS,CAAC;AAOjB,OAAO,QAAQ,gBAAgB,CAAC;IAC9B,UAAU,kBAAkB;QAC1B,OAAO,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;QAC7B,sBAAsB,EAAE,OAAO,CAAC,sBAAsB,CAAC,CAAC;KACzD;CACF;AAGD,MAAM,MAAM,gBAAgB,GAAG,GAAG,CAAC,MAAM,GAAG;IAC1C,OAAO,EAAE,SAAS,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAE9B,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,eAAe,CAAC,EAAE;QAChB,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,SAAS,GAAG,WAAW,GAAG,WAAW,GAAG,UAAU,GAAG,WAAW,CAAC;QACvE,GAAG,CAAC,EAAE,MAAM,CAAC;KACd,CAAC;IAEF,aAAa,CAAC,EAAE,sBAAsB,EAAE,CAAC;CAC1C,CAAC;AAGF,MAAM,WAAW,yBAA0B,SAAQ,GAAG,CAAC,MAAM;IAC3D,OAAO,EAAE,sBAAsB,CAAC;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,MAAM,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,gBAAgB,EAAE,MAAM,CAAC;IAEzB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,OAAO,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAE9B,aAAa,CAAC,EAAE,sBAAsB,EAAE,CAAC;IACzC,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,eAAe,CAAC,EAAE;QAChB,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,SAAS,GAAG,WAAW,GAAG,WAAW,GAAG,UAAU,GAAG,WAAW,CAAC;QACvE,GAAG,CAAC,EAAE,MAAM,CAAC;KACd,CAAC;CACH;AAGD,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,gBAAgB,CAAC;CAC3B;AAED,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,yBAAyB,CAAC;CACpC;AAGD,KAAK,qBAAqB,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;AAGrD,qBAAa,UACX,SAAQ,MACR,YAAW,GAAG,CAAC,qBAAqB,EAAE,gBAAgB,CAAC;IAQpC,OAAO,EAAE,gBAAgB;IAN5C,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,OAAO,CAAC,oBAAoB,CAGd;gBAEK,OAAO,EAAE,gBAAgB;YAc9B,oBAAoB;YAgBpB,kBAAkB;IAuC1B,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAqDzB,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IAWlC,cAAc,CAAC,GAAG,EAAE,qBAAqB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAoE1E,mBAAmB,CAAC,GAAG,EAAE,qBAAqB,GAAG,cAAc,EAAE;IAgEjE,gBAAgB,CACd,OAAO,EAAE,MAAM,EACf,GAAG,EAAE,qBAAqB,GACzB,cAAc,EAAE;IA8HnB,eAAe,CAAC,UAAU,EAAE,GAAG,GAAG,cAAc,EAAE;IA4D5C,YAAY,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC;IAwBnD,oBAAoB,CACxB,OAAO,EAAE,WAAW,GAAG,SAAS,GAAG,WAAW,GAAG,aAAa,EAC9D,OAAO,EAAE,WAAW,EACpB,YAAY,GAAE,oBAAyB,GACtC,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IAwE7B,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAEzC,iBAAiB,CACrB,IAAI,EAAE,GAAG,EACT,KAAK,EAAE,iBAAiB,EAAE,EAC1B,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,IAAI,CAAC;IA0BhB,mBAAmB,CAAC,IAAI,EAAE,GAAG,GAAG,YAAY;IAoB5C,OAAO,CAAC,eAAe;YAYT,qBAAqB;IA4BnC,sBAAsB,CACpB,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,CAAC,WAAW,EAAE,2BAA2B,KAAK,OAAO,CAAC,IAAI,CAAC;IAMtE,yBAAyB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO;YAKzC,UAAU;IAUxB,MAAM,CAAC,mBAAmB,CAAC,OAAO,EAAE,WAAW,GAAG,MAAM;CAkCzD;AAQD,qBAAa,sBACX,SAAQ,MACR,YAAW,GAAG,CAAC,GAAG,EAAE,yBAAyB,CAAC;IASd,OAAO,EAAE,yBAAyB;IAPlE,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,OAAO,CAAC,MAAM,CAAM;IACpB,OAAO,CAAC,oBAAoB,CAGd;gBAEF,MAAM,EAAE,GAAG,EAAS,OAAO,EAAE,yBAAyB;IAelE,OAAO,CAAC,yBAAyB;YAOnB,iBAAiB;IAoC/B,OAAO,CAAC,sBAAsB;YAiBhB,wBAAwB;IA+BtC,OAAO,CAAC,0BAA0B;IAoClC,OAAO,CAAC,iBAAiB;IAuCnB,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAiCzB,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;YAgBpB,qBAAqB;IAsBnC,sBAAsB,CACpB,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,CAAC,WAAW,EAAE,GAAG,KAAK,OAAO,CAAC,IAAI,CAAC,GAC3C,IAAI;IAKP,yBAAyB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO;IAKvD,OAAO,CAAC,eAAe;IAYvB,cAAc,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAIhC,YAAY,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC;IAcnD,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAChD"}