micup.ts 1.0.0 → 1.1.0

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.
Files changed (94) hide show
  1. package/README.md +93 -38
  2. package/README.tr.md +137 -0
  3. package/dist/bot/client.d.ts +79 -0
  4. package/dist/bot/client.js +299 -0
  5. package/dist/events/background.d.ts +7 -0
  6. package/dist/events/background.js +23 -0
  7. package/dist/events/catalog.d.ts +243 -0
  8. package/dist/events/catalog.js +1 -0
  9. package/dist/events/guild-tag.d.ts +9 -0
  10. package/dist/events/guild-tag.js +38 -0
  11. package/dist/events/mux.d.ts +20 -5
  12. package/dist/events/names.d.ts +1 -0
  13. package/dist/events/names.js +71 -0
  14. package/dist/events/safe.d.ts +9 -0
  15. package/dist/events/safe.js +27 -0
  16. package/dist/gateway/compression.d.ts +9 -0
  17. package/dist/gateway/compression.js +119 -0
  18. package/dist/gateway/connection.js +42 -17
  19. package/dist/gateway/protocol.d.ts +4 -1
  20. package/dist/gateway/protocol.js +9 -3
  21. package/dist/gateway/subscription.d.ts +10 -0
  22. package/dist/gateway/subscription.js +26 -0
  23. package/dist/index.d.ts +48 -4
  24. package/dist/index.js +19 -3
  25. package/dist/model/components.d.ts +82 -0
  26. package/dist/model/components.js +74 -0
  27. package/dist/model/constants.d.ts +330 -0
  28. package/dist/model/constants.js +330 -0
  29. package/dist/model/embed.d.ts +59 -0
  30. package/dist/model/embed.js +40 -0
  31. package/dist/model/entities.d.ts +125 -0
  32. package/dist/model/entities.js +12 -0
  33. package/dist/model/format.d.ts +32 -0
  34. package/dist/model/format.js +61 -0
  35. package/dist/model/guild.d.ts +114 -1
  36. package/dist/model/helpers.d.ts +88 -0
  37. package/dist/model/helpers.js +185 -0
  38. package/dist/model/interaction.d.ts +1 -1
  39. package/dist/model/locale.d.ts +15 -0
  40. package/dist/model/locale.js +55 -0
  41. package/dist/model/media.d.ts +23 -0
  42. package/dist/model/media.js +65 -0
  43. package/dist/model/permissions.d.ts +5 -0
  44. package/dist/model/permissions.js +31 -0
  45. package/dist/rest/attachments.d.ts +26 -0
  46. package/dist/rest/attachments.js +82 -0
  47. package/dist/rest/channels.d.ts +87 -3
  48. package/dist/rest/channels.js +181 -2
  49. package/dist/rest/commands.d.ts +1 -0
  50. package/dist/rest/commands.js +17 -0
  51. package/dist/rest/discovery.d.ts +35 -0
  52. package/dist/rest/discovery.js +33 -0
  53. package/dist/rest/errors.d.ts +38 -0
  54. package/dist/rest/errors.js +46 -0
  55. package/dist/rest/expressions.d.ts +65 -0
  56. package/dist/rest/expressions.js +89 -0
  57. package/dist/rest/guilds.d.ts +102 -1
  58. package/dist/rest/guilds.js +127 -0
  59. package/dist/rest/identity.d.ts +1 -0
  60. package/dist/rest/identity.js +15 -0
  61. package/dist/rest/interactions.d.ts +1 -1
  62. package/dist/rest/messages.d.ts +54 -30
  63. package/dist/rest/messages.js +32 -12
  64. package/dist/rest/rooms.d.ts +142 -0
  65. package/dist/rest/rooms.js +133 -0
  66. package/dist/rest/sounds.d.ts +44 -0
  67. package/dist/rest/sounds.js +89 -0
  68. package/dist/rest/transport.d.ts +8 -2
  69. package/dist/rest/transport.js +38 -5
  70. package/dist/rest/users.d.ts +65 -0
  71. package/dist/rest/users.js +63 -0
  72. package/dist/rest/webhooks.d.ts +56 -0
  73. package/dist/rest/webhooks.js +94 -0
  74. package/dist/session/inventory.d.ts +22 -0
  75. package/dist/session/inventory.js +159 -0
  76. package/dist/session/session.d.ts +21 -2
  77. package/dist/session/session.js +61 -4
  78. package/dist/session/voice.d.ts +1 -0
  79. package/dist/session/voice.js +25 -17
  80. package/dist/shard/manager.d.ts +38 -1
  81. package/dist/shard/manager.js +87 -0
  82. package/dist/state/cache.d.ts +6 -1
  83. package/dist/state/cache.js +45 -1
  84. package/docs/README.md +13 -0
  85. package/docs/commands-and-interactions.md +120 -0
  86. package/docs/errors-and-limits.md +79 -0
  87. package/docs/gateway-and-sharding.md +102 -0
  88. package/docs/getting-started.md +79 -0
  89. package/docs/migrating.md +44 -0
  90. package/docs/rest-reference.md +101 -0
  91. package/docs/voice.md +95 -0
  92. package/package.json +25 -7
  93. package/dist/rest/client.d.ts +0 -48
  94. package/dist/rest/client.js +0 -151
@@ -0,0 +1 @@
1
+ export declare const knownGatewayEvents: readonly ["APPLICATION_COMMANDS_UPDATE", "CALL_CREATE", "CALL_DELETE", "CALL_UPDATE", "CHANNEL_CREATE", "CHANNEL_DELETE", "CHANNEL_MEMBER_COUNTS_UPDATE", "CHANNEL_PINS_UPDATE", "CHANNEL_RECIPIENT_ADD", "CHANNEL_RECIPIENT_REMOVE", "CHANNEL_UPDATE", "CHANNEL_UPDATE_BULK", "ENTRANCE_SOUND_PLAY", "GATEWAY_ROLLOUT_UPDATE", "GUILD_AUDIT_LOG_ENTRY_CREATE", "GUILD_BAN_ADD", "GUILD_BAN_REMOVE", "GUILD_COUNTS_UPDATE", "GUILD_CREATE", "GUILD_DELETE", "GUILD_EMOJIS_UPDATE", "GUILD_MEMBER_ADD", "GUILD_MEMBER_LIST_UPDATE", "GUILD_MEMBER_REMOVE", "GUILD_MEMBER_UPDATE", "GUILD_MEMBERS_CHUNK", "GUILD_ROLE_CREATE", "GUILD_ROLE_DELETE", "GUILD_ROLE_UPDATE", "GUILD_ROLE_UPDATE_BULK", "GUILD_SOUNDBOARD_SOUND_PLAY", "GUILD_SOUNDBOARD_SOUNDS_UPDATE", "GUILD_STICKERS_UPDATE", "GUILD_SYNC", "GUILD_UPDATE", "INTERACTION_CREATE", "INVITE_CREATE", "INVITE_DELETE", "MESSAGE_CREATE", "MESSAGE_DELETE", "MESSAGE_DELETE_BULK", "MESSAGE_REACTION_ADD", "MESSAGE_REACTION_ADD_MANY", "MESSAGE_REACTION_REMOVE", "MESSAGE_REACTION_REMOVE_ALL", "MESSAGE_REACTION_REMOVE_EMOJI", "MESSAGE_UPDATE", "PASSIVE_UPDATES", "PRESENCE_UPDATE", "PRESENCE_UPDATE_BULK", "RATE_LIMITED", "READY", "RELATIONSHIP_ADD", "RELATIONSHIP_REMOVE", "RELATIONSHIP_UPDATE", "RESUMED", "SESSIONS_REPLACE", "THREAD_CREATE", "THREAD_DELETE", "THREAD_LIST_SYNC", "THREAD_MEMBER_LIST_UPDATE", "THREAD_MEMBER_UPDATE", "THREAD_MEMBERS_UPDATE", "THREAD_UPDATE", "TYPING_START", "USER_UPDATE", "VOICE_SERVER_UPDATE", "VOICE_STATE_UPDATE", "WEBHOOKS_UPDATE"];
@@ -0,0 +1,71 @@
1
+ export const knownGatewayEvents = Object.freeze([
2
+ 'APPLICATION_COMMANDS_UPDATE',
3
+ 'CALL_CREATE',
4
+ 'CALL_DELETE',
5
+ 'CALL_UPDATE',
6
+ 'CHANNEL_CREATE',
7
+ 'CHANNEL_DELETE',
8
+ 'CHANNEL_MEMBER_COUNTS_UPDATE',
9
+ 'CHANNEL_PINS_UPDATE',
10
+ 'CHANNEL_RECIPIENT_ADD',
11
+ 'CHANNEL_RECIPIENT_REMOVE',
12
+ 'CHANNEL_UPDATE',
13
+ 'CHANNEL_UPDATE_BULK',
14
+ 'ENTRANCE_SOUND_PLAY',
15
+ 'GATEWAY_ROLLOUT_UPDATE',
16
+ 'GUILD_AUDIT_LOG_ENTRY_CREATE',
17
+ 'GUILD_BAN_ADD',
18
+ 'GUILD_BAN_REMOVE',
19
+ 'GUILD_COUNTS_UPDATE',
20
+ 'GUILD_CREATE',
21
+ 'GUILD_DELETE',
22
+ 'GUILD_EMOJIS_UPDATE',
23
+ 'GUILD_MEMBER_ADD',
24
+ 'GUILD_MEMBER_LIST_UPDATE',
25
+ 'GUILD_MEMBER_REMOVE',
26
+ 'GUILD_MEMBER_UPDATE',
27
+ 'GUILD_MEMBERS_CHUNK',
28
+ 'GUILD_ROLE_CREATE',
29
+ 'GUILD_ROLE_DELETE',
30
+ 'GUILD_ROLE_UPDATE',
31
+ 'GUILD_ROLE_UPDATE_BULK',
32
+ 'GUILD_SOUNDBOARD_SOUND_PLAY',
33
+ 'GUILD_SOUNDBOARD_SOUNDS_UPDATE',
34
+ 'GUILD_STICKERS_UPDATE',
35
+ 'GUILD_SYNC',
36
+ 'GUILD_UPDATE',
37
+ 'INTERACTION_CREATE',
38
+ 'INVITE_CREATE',
39
+ 'INVITE_DELETE',
40
+ 'MESSAGE_CREATE',
41
+ 'MESSAGE_DELETE',
42
+ 'MESSAGE_DELETE_BULK',
43
+ 'MESSAGE_REACTION_ADD',
44
+ 'MESSAGE_REACTION_ADD_MANY',
45
+ 'MESSAGE_REACTION_REMOVE',
46
+ 'MESSAGE_REACTION_REMOVE_ALL',
47
+ 'MESSAGE_REACTION_REMOVE_EMOJI',
48
+ 'MESSAGE_UPDATE',
49
+ 'PASSIVE_UPDATES',
50
+ 'PRESENCE_UPDATE',
51
+ 'PRESENCE_UPDATE_BULK',
52
+ 'RATE_LIMITED',
53
+ 'READY',
54
+ 'RELATIONSHIP_ADD',
55
+ 'RELATIONSHIP_REMOVE',
56
+ 'RELATIONSHIP_UPDATE',
57
+ 'RESUMED',
58
+ 'SESSIONS_REPLACE',
59
+ 'THREAD_CREATE',
60
+ 'THREAD_DELETE',
61
+ 'THREAD_LIST_SYNC',
62
+ 'THREAD_MEMBER_LIST_UPDATE',
63
+ 'THREAD_MEMBER_UPDATE',
64
+ 'THREAD_MEMBERS_UPDATE',
65
+ 'THREAD_UPDATE',
66
+ 'TYPING_START',
67
+ 'USER_UPDATE',
68
+ 'VOICE_SERVER_UPDATE',
69
+ 'VOICE_STATE_UPDATE',
70
+ 'WEBHOOKS_UPDATE',
71
+ ]);
@@ -0,0 +1,9 @@
1
+ import type { GatewayDispatch } from '../gateway/protocol.js';
2
+ export interface SafeHandlerOptions {
3
+ timeoutMs?: number;
4
+ onError?: (error: unknown, event: GatewayDispatch) => void;
5
+ retry?: (error: unknown, event: GatewayDispatch) => boolean;
6
+ }
7
+ type Handler = (event: GatewayDispatch, signal: AbortSignal) => void | Promise<void>;
8
+ export declare function safeHandler(handler: Handler, options?: SafeHandlerOptions): Handler;
9
+ export {};
@@ -0,0 +1,27 @@
1
+ export function safeHandler(handler, options = {}) {
2
+ const { timeoutMs, onError, retry } = options;
3
+ if (timeoutMs !== undefined && (!Number.isInteger(timeoutMs) || timeoutMs < 1 || timeoutMs > 2_147_483_647)) {
4
+ throw new RangeError('Gateway handler timeout must be a positive timer duration');
5
+ }
6
+ return async (event, parent) => {
7
+ parent.throwIfAborted();
8
+ const deadline = timeoutMs === undefined ? undefined : AbortSignal.timeout(timeoutMs);
9
+ const signal = deadline ? AbortSignal.any([parent, deadline]) : parent;
10
+ try {
11
+ await new Promise((resolve, reject) => {
12
+ const stop = () => reject(signal.reason);
13
+ signal.addEventListener('abort', stop, { once: true });
14
+ const execute = async () => {
15
+ signal.throwIfAborted();
16
+ await handler(event, signal);
17
+ };
18
+ void execute().then(resolve, reject).finally(() => signal.removeEventListener('abort', stop));
19
+ });
20
+ }
21
+ catch (error) {
22
+ if (parent.aborted || retry?.(error, event))
23
+ throw error;
24
+ onError?.(error, event);
25
+ }
26
+ };
27
+ }
@@ -0,0 +1,9 @@
1
+ import type { RawData } from 'ws';
2
+ export declare function assertZstdAvailable(): void;
3
+ export declare class GatewayCompression {
4
+ #private;
5
+ constructor(signal: AbortSignal, receive: (packet: string) => void, error: (error: unknown) => void, resume: () => void);
6
+ receive(data: RawData): boolean;
7
+ send(text: string, write: (data: Buffer) => void, caller?: AbortSignal): Promise<void>;
8
+ destroy(): void;
9
+ }
@@ -0,0 +1,119 @@
1
+ import * as zlib from 'node:zlib';
2
+ const maxPacketBytes = 8 * 1024 * 1024;
3
+ const utf8 = new TextDecoder('utf-8', { fatal: true });
4
+ class JsonPackets {
5
+ #parts = [];
6
+ #length = 0;
7
+ #depth = 0;
8
+ #quoted = false;
9
+ #escape = false;
10
+ push(chunk, emit, signal) {
11
+ let start = 0;
12
+ for (let i = 0; i < chunk.length && !signal.aborted; i++) {
13
+ const byte = chunk[i];
14
+ if (this.#depth === 0) {
15
+ if (byte === 32 || byte === 9 || byte === 10 || byte === 13) {
16
+ start = i + 1;
17
+ continue;
18
+ }
19
+ if (byte !== 123)
20
+ throw new Error('Invalid Micup Gateway JSON stream');
21
+ this.#depth = 1;
22
+ }
23
+ else if (this.#quoted) {
24
+ if (this.#escape)
25
+ this.#escape = false;
26
+ else if (byte === 92)
27
+ this.#escape = true;
28
+ else if (byte === 34)
29
+ this.#quoted = false;
30
+ }
31
+ else if (byte === 34) {
32
+ this.#quoted = true;
33
+ }
34
+ else if (byte === 123 || byte === 91) {
35
+ this.#depth++;
36
+ }
37
+ else if (byte === 125 || byte === 93) {
38
+ this.#depth--;
39
+ if (this.#depth === 0) {
40
+ this.#append(chunk.subarray(start, i + 1));
41
+ const packet = utf8.decode(Buffer.concat(this.#parts, this.#length));
42
+ this.#parts = [];
43
+ this.#length = 0;
44
+ start = i + 1;
45
+ emit(packet);
46
+ }
47
+ }
48
+ }
49
+ if (this.#depth !== 0 && !signal.aborted)
50
+ this.#append(chunk.subarray(start));
51
+ }
52
+ #append(slice) {
53
+ this.#length += slice.length;
54
+ if (this.#length > maxPacketBytes)
55
+ throw new RangeError('Micup Gateway packet exceeds 8 MiB after decompression');
56
+ if (slice.length)
57
+ this.#parts.push(slice);
58
+ }
59
+ }
60
+ export function assertZstdAvailable() {
61
+ if (typeof zlib.createZstdCompress !== 'function' || typeof zlib.createZstdDecompress !== 'function') {
62
+ throw new Error('Micup zstd-stream requires Node.js with native Zstandard support (22.15+ on Node.js 22)');
63
+ }
64
+ }
65
+ export class GatewayCompression {
66
+ #encoder = zlib.createZstdCompress();
67
+ #decoder = zlib.createZstdDecompress({
68
+ params: { [zlib.constants.ZSTD_d_windowLogMax]: 26 },
69
+ });
70
+ #packets = new JsonPackets();
71
+ #chunks = [];
72
+ #signal;
73
+ #sending = Promise.resolve();
74
+ constructor(signal, receive, error, resume) {
75
+ this.#signal = signal;
76
+ this.#encoder.on('data', (chunk) => this.#chunks.push(chunk));
77
+ this.#encoder.on('error', error);
78
+ this.#decoder.on('error', error);
79
+ this.#decoder.on('drain', resume);
80
+ this.#decoder.on('data', (chunk) => {
81
+ try {
82
+ this.#packets.push(chunk, receive, signal);
83
+ }
84
+ catch (cause) {
85
+ error(cause);
86
+ }
87
+ });
88
+ }
89
+ receive(data) {
90
+ const input = Array.isArray(data) ? Buffer.concat(data) : Buffer.isBuffer(data) ? data : Buffer.from(data);
91
+ return this.#decoder.write(input);
92
+ }
93
+ send(text, write, caller) {
94
+ const task = this.#sending.then(async () => {
95
+ this.#signal.throwIfAborted();
96
+ caller?.throwIfAborted();
97
+ await new Promise((resolve, reject) => {
98
+ const abort = () => reject(this.#signal.reason);
99
+ this.#signal.addEventListener('abort', abort, { once: true });
100
+ this.#encoder.write(text);
101
+ this.#encoder.flush(zlib.constants.ZSTD_e_flush, () => {
102
+ this.#signal.removeEventListener('abort', abort);
103
+ resolve();
104
+ });
105
+ });
106
+ this.#signal.throwIfAborted();
107
+ const frame = Buffer.concat(this.#chunks);
108
+ this.#chunks = [];
109
+ write(frame);
110
+ });
111
+ this.#sending = task.catch(() => { });
112
+ return task;
113
+ }
114
+ destroy() {
115
+ this.#encoder.destroy();
116
+ this.#decoder.destroy();
117
+ this.#chunks = [];
118
+ }
119
+ }
@@ -1,5 +1,6 @@
1
1
  import { setTimeout as delay } from 'node:timers/promises';
2
2
  import WebSocket from 'ws';
3
+ import { GatewayCompression } from './compression.js';
3
4
  import { decodePacket, GatewayCloseError, GatewayOpcode } from './protocol.js';
4
5
  class CommandWindow {
5
6
  capacity;
@@ -29,6 +30,7 @@ export class GatewayConnection {
29
30
  #socket;
30
31
  #lifetime = new AbortController();
31
32
  #commands = new CommandWindow(540, 60_000);
33
+ #compression;
32
34
  #presence = new CommandWindow(5, 20_000);
33
35
  #dispatches = [];
34
36
  #helloTimer;
@@ -71,7 +73,7 @@ export class GatewayConnection {
71
73
  }
72
74
  await this.#commands.acquire(combined);
73
75
  combined.throwIfAborted();
74
- this.#write(payload);
76
+ await this.#write(payload, combined);
75
77
  }
76
78
  #read(signal) {
77
79
  return new Promise((resolve, reject) => {
@@ -84,6 +86,7 @@ export class GatewayConnection {
84
86
  this.#dispatches.length = 0;
85
87
  clearTimeout(this.#helloTimer);
86
88
  clearInterval(this.#heartbeat);
89
+ this.#compression?.destroy();
87
90
  this.#socket.terminate();
88
91
  if (error === undefined || signal.aborted)
89
92
  resolve();
@@ -93,11 +96,25 @@ export class GatewayConnection {
93
96
  const onAbort = () => finish();
94
97
  this.#socket.on('error', () => finish(new Error('Micup Gateway connection failed')));
95
98
  this.#socket.on('close', (code, reason) => finish(new GatewayCloseError(code, reason.toString())));
99
+ const receive = (packet) => this.#receive(packet, finish);
100
+ if (this.options.endpoint.searchParams.get('compress') === 'zstd-stream') {
101
+ this.#compression = new GatewayCompression(this.#lifetime.signal, receive, finish, () => this.#socket.resume());
102
+ }
96
103
  this.#socket.on('message', (data, binary) => {
97
104
  if (this.#lifetime.signal.aborted)
98
105
  return;
99
106
  try {
100
- this.#receive(data, binary, finish);
107
+ if (this.#compression) {
108
+ if (!binary)
109
+ throw new Error('Unexpected text packet on compressed Micup Gateway connection');
110
+ if (!this.#compression.receive(data))
111
+ this.#socket.pause();
112
+ }
113
+ else {
114
+ if (binary)
115
+ throw new Error('Unexpected binary Micup Gateway packet');
116
+ receive(data.toString());
117
+ }
101
118
  }
102
119
  catch (error) {
103
120
  finish(error);
@@ -109,10 +126,8 @@ export class GatewayConnection {
109
126
  onAbort();
110
127
  });
111
128
  }
112
- #receive(raw, binary, finish) {
113
- if (binary)
114
- throw new Error('Unexpected binary Micup Gateway packet');
115
- const packet = decodePacket(raw.toString());
129
+ #receive(text, finish) {
130
+ const packet = decodePacket(text);
116
131
  const op = GatewayOpcode;
117
132
  switch (packet.op) {
118
133
  case op.Hello: {
@@ -128,7 +143,7 @@ export class GatewayConnection {
128
143
  try {
129
144
  if (this.#pendingHeartbeat !== undefined)
130
145
  throw new Error('Micup Gateway heartbeat timed out');
131
- this.#beat();
146
+ void this.#beat().catch(finish);
132
147
  }
133
148
  catch (error) {
134
149
  finish(error);
@@ -138,7 +153,7 @@ export class GatewayConnection {
138
153
  break;
139
154
  }
140
155
  case op.Heartbeat:
141
- this.#beat();
156
+ void this.#beat().catch(finish);
142
157
  break;
143
158
  case op.HeartbeatAck:
144
159
  if (this.#pendingHeartbeat !== undefined) {
@@ -182,7 +197,7 @@ export class GatewayConnection {
182
197
  try {
183
198
  const { resume, token, shard, flags, ignoredEvents } = this.options;
184
199
  if (resume.sessionId && resume.sequence !== null) {
185
- this.#write(this.#encode(GatewayOpcode.Resume, {
200
+ await this.#write(this.#encode(GatewayOpcode.Resume, {
186
201
  token, session_id: resume.sessionId, seq: resume.sequence,
187
202
  }));
188
203
  }
@@ -191,7 +206,7 @@ export class GatewayConnection {
191
206
  await this.options.beforeIdentify?.(this.#lifetime.signal);
192
207
  this.#lifetime.signal.throwIfAborted();
193
208
  const presence = this.options.presence();
194
- this.#write(this.#encode(GatewayOpcode.Identify, {
209
+ await this.#write(this.#encode(GatewayOpcode.Identify, {
195
210
  token,
196
211
  properties: { os: process.platform, browser: 'micup.ts', device: 'micup.ts' },
197
212
  shard,
@@ -250,11 +265,15 @@ export class GatewayConnection {
250
265
  }
251
266
  }
252
267
  #dispatch(packet) {
253
- return { name: packet.t, sequence: packet.s ?? null, data: packet.d, shardId: this.options.shard[0] };
268
+ const generation = this.#generation.signal;
269
+ return {
270
+ name: packet.t, sequence: packet.s ?? null, data: packet.d, shardId: this.options.shard[0],
271
+ send: (opcode, data, { signal } = {}) => this.send(opcode, data, signal ? AbortSignal.any([signal, generation]) : generation),
272
+ };
254
273
  }
255
- #beat() {
274
+ async #beat() {
256
275
  this.#pendingHeartbeat ??= performance.now();
257
- this.#write(this.#encode(GatewayOpcode.Heartbeat, this.options.resume.sequence));
276
+ await this.#write(this.#encode(GatewayOpcode.Heartbeat, this.options.resume.sequence));
258
277
  }
259
278
  #encode(op, d) {
260
279
  if (!Number.isSafeInteger(op) || op < 0)
@@ -264,9 +283,15 @@ export class GatewayConnection {
264
283
  throw new RangeError('Micup Gateway payload exceeds 16,384 bytes');
265
284
  return payload;
266
285
  }
267
- #write(payload) {
268
- if (this.#socket.readyState !== WebSocket.OPEN)
269
- throw new Error('Micup Gateway is disconnected');
270
- this.#socket.send(payload);
286
+ async #write(payload, signal) {
287
+ const write = (data) => {
288
+ if (this.#socket.readyState !== WebSocket.OPEN)
289
+ throw new Error('Micup Gateway is disconnected');
290
+ this.#socket.send(data);
291
+ };
292
+ if (this.#compression)
293
+ await this.#compression.send(payload, write, signal);
294
+ else
295
+ write(payload);
271
296
  }
272
297
  }
@@ -29,6 +29,9 @@ export interface GatewayDispatch {
29
29
  readonly data: unknown;
30
30
  readonly sequence: number | null;
31
31
  readonly shardId: number;
32
+ readonly send?: (opcode: number, data: unknown, options?: {
33
+ signal?: AbortSignal;
34
+ }) => Promise<void>;
32
35
  }
33
36
  export interface GatewayPacket {
34
37
  op: number;
@@ -37,4 +40,4 @@ export interface GatewayPacket {
37
40
  t?: string;
38
41
  }
39
42
  export declare function decodePacket(data: string): GatewayPacket;
40
- export declare function gatewayEndpoint(raw: string): URL;
43
+ export declare function gatewayEndpoint(raw: string, compress?: boolean): URL;
@@ -45,7 +45,7 @@ export function decodePacket(data) {
45
45
  }
46
46
  return packet;
47
47
  }
48
- export function gatewayEndpoint(raw) {
48
+ export function gatewayEndpoint(raw, compress = false) {
49
49
  const endpoint = new URL(raw);
50
50
  if (!['ws:', 'wss:'].includes(endpoint.protocol) || endpoint.username ||
51
51
  endpoint.password || endpoint.hash) {
@@ -53,7 +53,13 @@ export function gatewayEndpoint(raw) {
53
53
  }
54
54
  endpoint.searchParams.set('v', '1');
55
55
  endpoint.searchParams.set('encoding', 'json');
56
- endpoint.searchParams.delete('compress');
57
- endpoint.searchParams.delete('stream');
56
+ if (compress) {
57
+ endpoint.searchParams.set('compress', 'zstd-stream');
58
+ endpoint.searchParams.set('stream', '1');
59
+ }
60
+ else {
61
+ endpoint.searchParams.delete('compress');
62
+ endpoint.searchParams.delete('stream');
63
+ }
58
64
  return endpoint;
59
65
  }
@@ -0,0 +1,10 @@
1
+ export interface GatewaySubscription {
2
+ active?: boolean;
3
+ sync?: boolean;
4
+ typing?: boolean;
5
+ member_list_channels?: Readonly<Record<string, readonly (readonly [start: number, end: number])[]>>;
6
+ members?: readonly string[];
7
+ threads?: boolean;
8
+ thread_member_lists?: readonly string[];
9
+ }
10
+ export declare function validateSubscriptions(subscriptions: Readonly<Record<string, GatewaySubscription>>): void;
@@ -0,0 +1,26 @@
1
+ const validId = (value) => typeof value === 'string' && /^\d+$/.test(value);
2
+ export function validateSubscriptions(subscriptions) {
3
+ const entries = Object.entries(subscriptions ?? {});
4
+ if (!entries.length)
5
+ throw new TypeError('At least one guild subscription is required');
6
+ for (const [id, subscription] of entries) {
7
+ if (!validId(id) || !subscription || typeof subscription !== 'object')
8
+ throw new TypeError('Invalid guild subscription');
9
+ if ((subscription.members?.length ?? 0) > 1000 || subscription.members?.some((member) => !validId(member)) ||
10
+ (subscription.thread_member_lists?.length ?? 0) > 10 ||
11
+ subscription.thread_member_lists?.some((thread) => !validId(thread))) {
12
+ throw new RangeError('Invalid subscription member or thread IDs');
13
+ }
14
+ for (const [channel, ranges] of Object.entries(subscription.member_list_channels ?? {})) {
15
+ if (!validId(channel) || !Array.isArray(ranges) || ranges.length > 10) {
16
+ throw new RangeError('Invalid member list subscription');
17
+ }
18
+ for (const range of ranges) {
19
+ if (range.length !== 2 || !Number.isSafeInteger(range[0]) || !Number.isSafeInteger(range[1]) ||
20
+ range[0] < 0 || range[1] < range[0] || range[1] > 100000 || range[1] - range[0] >= 100) {
21
+ throw new RangeError('Member list ranges must cover at most 100 members within 0 to 100000');
22
+ }
23
+ }
24
+ }
25
+ }
26
+ }
package/dist/index.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- export { MicupClient } from './rest/client.js';
2
- export type { MicupClientOptions, MicupMessage, MicupUser } from './rest/client.js';
1
+ export { MicupClient } from './bot/client.js';
2
+ export type { MicupClientOptions } from './bot/client.js';
3
3
  export { EventMux } from './events/mux.js';
4
4
  export type { MicupEvents } from './events/mux.js';
5
5
  export { GatewayCloseError, GatewayOpcode } from './gateway/protocol.js';
@@ -10,12 +10,14 @@ export { ShardManager, shardForGuild } from './shard/manager.js';
10
10
  export type { ShardManagerOptions } from './shard/manager.js';
11
11
  export { VoiceRefusedError } from './session/voice.js';
12
12
  export type { VoiceJoinOptions, VoiceServerUpdate, VoiceSessionOptions } from './session/voice.js';
13
- export { MicupAPIError } from './rest/errors.js';
13
+ export { MicupAPIError, MicupErrorCode } from './rest/errors.js';
14
14
  export type { MicupFieldError } from './rest/errors.js';
15
15
  export type { MicupRequestOptions, RestMethod, RestRequestOptions } from './rest/transport.js';
16
16
  export type { AllowedMentions, ListMessageOptions, MessageInput, MicupEmbed, MicupFile } from './rest/messages.js';
17
17
  export { GatewayState } from './state/cache.js';
18
- export { Permission, computePermissions, hasPermissions } from './model/permissions.js';
18
+ export { ElevatedPermissions, Permission, computePermissions, hasPermissions, missingPermissions, parsePermission, permissionNames } from './model/permissions.js';
19
+ export * from './model/constants.js';
20
+ export * from './model/helpers.js';
19
21
  export type { MicupChannel, MicupGuild, MicupGuildCreate, MicupMember, MicupMembersChunk, MicupRole, MicupVoiceState, PermissionOverwrite } from './model/guild.js';
20
22
  export { InteractionRouter } from './events/router.js';
21
23
  export { CommandOptionType, CommandType, InteractionType, commandPath } from './model/interaction.js';
@@ -27,3 +29,45 @@ export type { ChannelEdit, MicupChannels, MicupInvite, ThreadList, ThreadStart }
27
29
  export type { CustomStatus, Presence, PresenceStatus } from './model/presence.js';
28
30
  export { GatewayRequestError } from './session/requests.js';
29
31
  export type { ChannelMemberCount, GuildCount, GuildMembersRequest } from './session/requests.js';
32
+ export { MessageFlag } from './model/entities.js';
33
+ export type { ChannelMention, MessageAttachment, MessageCall, MessageReactionCount, MessageReference, MessageSnapshotContent, MicupMessage, MicupUser, StickerItem } from './model/entities.js';
34
+ export type { EmbedMedia } from './model/embed.js';
35
+ export type { ForumTagRecord, ThreadMetadata } from './model/guild.js';
36
+ export type { AttachmentUpload, MicupAttachments, RefreshedAttachmentURL, UploadedAttachment } from './rest/attachments.js';
37
+ export type { MicupWebhook, MicupWebhooks, WebhookEdit, WebhookExecuteOptions } from './rest/webhooks.js';
38
+ export type { MessageForward, MessageSearch, MessageSearchResult } from './rest/messages.js';
39
+ export type { MicupApplication, MicupUserProfile, MicupUsers, UserProfileOptions } from './rest/users.js';
40
+ export type { GatewaySubscription } from './gateway/subscription.js';
41
+ export type { ChannelLookup } from './session/session.js';
42
+ export { TimestampStyle, compareSnowflakes, escapeMarkdown, formatEmoji, formatTimestamp, memberDisplayName, mentionChannel, mentionRole, mentionUser, parseSnowflake, reactionEmoji, snowflakeAt, snowflakeEpoch, snowflakeTime, userDisplayName, userTag } from './model/format.js';
43
+ export type { Emoji } from './model/format.js';
44
+ export { MessageCatalog } from './model/locale.js';
45
+ export type { LocalizedMessages } from './model/locale.js';
46
+ export { EmbedBuilder, attachmentURL, validateEmbed } from './model/embed.js';
47
+ export { knownGatewayEvents } from './events/names.js';
48
+ export type { AdditionalGatewayEvents, MessageReaction, PresenceUpdate, ThreadMember } from './events/catalog.js';
49
+ export { ButtonStyle, ComponentType, TextInputStyle, actionRow, disableComponents, modalRows, selectRow } from './model/components.js';
50
+ export type { ActionRow, Button, ModalRow, SelectMenu, SelectOption, TextInput } from './model/components.js';
51
+ export type { EmojiInput, ExpressionBulkResult, ExpressionMetadata, MicupExpressions, MicupSticker, StickerInput } from './rest/expressions.js';
52
+ export type { GuildMemberInventory, MemberPageLookup } from './session/inventory.js';
53
+ export { MicupMedia, inviteURL } from './model/media.js';
54
+ export type { MediaOptions } from './model/media.js';
55
+ export type { ArchivedThreadOptions, ForumPost, ForumPostInput, ForumTag, ReactionUsersPage } from './rest/channels.js';
56
+ export { safeHandler } from './events/safe.js';
57
+ export { background } from './events/background.js';
58
+ export type { BackgroundOptions } from './events/background.js';
59
+ export { tokenId } from './rest/identity.js';
60
+ export type { MicupLogger } from './rest/transport.js';
61
+ export type { SafeHandlerOptions } from './events/safe.js';
62
+ export { onGuildTagChange } from './events/guild-tag.js';
63
+ export type { GuildTagChange } from './events/guild-tag.js';
64
+ export type { ChannelPosition, CurrentMemberEdit, GuildMemberSearch, GuildMemberSearchPage, SudoProof } from './rest/guilds.js';
65
+ export type { CrosspostSource } from './rest/channels.js';
66
+ export type { ExpressionSourceGuild } from './rest/expressions.js';
67
+ export type { BotProfileEdit, MicupPublicApplication } from './rest/users.js';
68
+ export { MicupDiscovery } from './rest/discovery.js';
69
+ export type { DiscoveryApplication, DiscoveryApplicationEdit, DiscoveryApplicationInput, DiscoveryApplicationStatus, DiscoveryStatus } from './rest/discovery.js';
70
+ export { MicupSounds, encodeAudio } from './rest/sounds.js';
71
+ export type { AudioInput, MicupSoundboardSound, SoundboardPlayOptions, SoundboardSoundEdit, SoundboardSoundInput } from './rest/sounds.js';
72
+ export { MicupVoiceRooms } from './rest/rooms.js';
73
+ export type { RoomTournament, StageBoardInput, StageBoardStyle, StageEffect, StageEffectType, StageHostCharacter, StageHostInput, StageScore, StageVideoInput, TournamentCurrentMatch, TournamentGame, TournamentInput, TournamentMatch, TournamentReadOptions, TournamentSize, TournamentTable, VoiceRoomStage, VoiceRoomStageInput, } from './rest/rooms.js';
package/dist/index.js CHANGED
@@ -1,12 +1,28 @@
1
- export { MicupClient } from './rest/client.js';
1
+ export { MicupClient } from './bot/client.js';
2
2
  export { EventMux } from './events/mux.js';
3
3
  export { GatewayCloseError, GatewayOpcode } from './gateway/protocol.js';
4
4
  export { GatewaySession } from './session/session.js';
5
5
  export { ShardManager, shardForGuild } from './shard/manager.js';
6
6
  export { VoiceRefusedError } from './session/voice.js';
7
- export { MicupAPIError } from './rest/errors.js';
7
+ export { MicupAPIError, MicupErrorCode } from './rest/errors.js';
8
8
  export { GatewayState } from './state/cache.js';
9
- export { Permission, computePermissions, hasPermissions } from './model/permissions.js';
9
+ export { ElevatedPermissions, Permission, computePermissions, hasPermissions, missingPermissions, parsePermission, permissionNames } from './model/permissions.js';
10
+ export * from './model/constants.js';
11
+ export * from './model/helpers.js';
10
12
  export { InteractionRouter } from './events/router.js';
11
13
  export { CommandOptionType, CommandType, InteractionType, commandPath } from './model/interaction.js';
12
14
  export { GatewayRequestError } from './session/requests.js';
15
+ export { MessageFlag } from './model/entities.js';
16
+ export { TimestampStyle, compareSnowflakes, escapeMarkdown, formatEmoji, formatTimestamp, memberDisplayName, mentionChannel, mentionRole, mentionUser, parseSnowflake, reactionEmoji, snowflakeAt, snowflakeEpoch, snowflakeTime, userDisplayName, userTag } from './model/format.js';
17
+ export { MessageCatalog } from './model/locale.js';
18
+ export { EmbedBuilder, attachmentURL, validateEmbed } from './model/embed.js';
19
+ export { knownGatewayEvents } from './events/names.js';
20
+ export { ButtonStyle, ComponentType, TextInputStyle, actionRow, disableComponents, modalRows, selectRow } from './model/components.js';
21
+ export { MicupMedia, inviteURL } from './model/media.js';
22
+ export { safeHandler } from './events/safe.js';
23
+ export { background } from './events/background.js';
24
+ export { tokenId } from './rest/identity.js';
25
+ export { onGuildTagChange } from './events/guild-tag.js';
26
+ export { MicupDiscovery } from './rest/discovery.js';
27
+ export { MicupSounds, encodeAudio } from './rest/sounds.js';
28
+ export { MicupVoiceRooms } from './rest/rooms.js';
@@ -0,0 +1,82 @@
1
+ import type { Emoji } from './format.js';
2
+ export declare const ComponentType: {
3
+ readonly ActionRow: 1;
4
+ readonly Button: 2;
5
+ readonly StringSelect: 3;
6
+ readonly TextInput: 4;
7
+ readonly UserSelect: 5;
8
+ readonly RoleSelect: 6;
9
+ readonly MentionableSelect: 7;
10
+ readonly ChannelSelect: 8;
11
+ };
12
+ export declare const ButtonStyle: {
13
+ readonly Primary: 1;
14
+ readonly Secondary: 2;
15
+ readonly Success: 3;
16
+ readonly Danger: 4;
17
+ readonly Link: 5;
18
+ };
19
+ export declare const TextInputStyle: {
20
+ readonly Short: 1;
21
+ readonly Paragraph: 2;
22
+ };
23
+ export type Button = {
24
+ type: 2;
25
+ label?: string;
26
+ emoji?: Emoji;
27
+ disabled?: boolean;
28
+ } & ({
29
+ style: 1 | 2 | 3 | 4;
30
+ custom_id: string;
31
+ url?: never;
32
+ } | {
33
+ style: 5;
34
+ url: string;
35
+ custom_id?: never;
36
+ });
37
+ export interface SelectOption {
38
+ label: string;
39
+ value: string;
40
+ description?: string;
41
+ emoji?: Emoji;
42
+ default?: boolean;
43
+ }
44
+ export interface SelectMenu {
45
+ type: 3 | 5 | 6 | 7 | 8;
46
+ custom_id: string;
47
+ placeholder?: string;
48
+ min_values?: number;
49
+ max_values?: number;
50
+ disabled?: boolean;
51
+ options?: readonly SelectOption[];
52
+ channel_types?: readonly number[];
53
+ default_values?: readonly {
54
+ id: string;
55
+ type: 'user' | 'role' | 'channel';
56
+ }[];
57
+ }
58
+ export interface ActionRow {
59
+ [key: string]: unknown;
60
+ type: 1;
61
+ components: readonly Button[] | readonly [SelectMenu];
62
+ }
63
+ export interface TextInput {
64
+ type: 4;
65
+ style: 1 | 2;
66
+ custom_id: string;
67
+ label: string;
68
+ placeholder?: string;
69
+ value?: string;
70
+ min_length?: number;
71
+ max_length?: number;
72
+ required?: boolean;
73
+ }
74
+ export interface ModalRow {
75
+ [key: string]: unknown;
76
+ type: 1;
77
+ components: readonly [TextInput];
78
+ }
79
+ export declare function actionRow(...buttons: readonly Button[]): ActionRow;
80
+ export declare function selectRow(menu: SelectMenu): ActionRow;
81
+ export declare function disableComponents(rows: readonly ActionRow[]): ActionRow[];
82
+ export declare function modalRows(...inputs: readonly TextInput[]): ModalRow[];