@tencent-connect/openclaw-qqbot 1.7.1 → 2.0.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 (283) hide show
  1. package/README.md +206 -4
  2. package/README.zh.md +207 -4
  3. package/bin/qqbot-cli.js +5 -2
  4. package/dist/index.cjs +15549 -0
  5. package/dist/index.cjs.map +1 -0
  6. package/dist/index.d.cts +890 -0
  7. package/index.ts +56 -18
  8. package/openclaw.plugin.json +19 -3
  9. package/package.json +14 -23
  10. package/preload.cjs +17 -14
  11. package/scripts/link-sdk-core.cjs +133 -50
  12. package/scripts/upgrade-via-npm.sh +400 -73
  13. package/scripts/upgrade-via-source.sh +126 -89
  14. package/skills/qqbot-channel/SKILL.md +34 -12
  15. package/src/adapter/contract.ts +69 -0
  16. package/src/adapter/gateway.ts +61 -0
  17. package/src/adapter/index.ts +15 -0
  18. package/src/adapter/lint.ts +144 -0
  19. package/src/adapter/media.ts +112 -0
  20. package/src/adapter/pairing.ts +99 -0
  21. package/src/adapter/resolve.ts +333 -0
  22. package/src/adapter/setup.ts +55 -0
  23. package/src/adapter/webhook.ts +248 -0
  24. package/src/adapter/workspace.ts +29 -0
  25. package/src/bot-instance.ts +60 -0
  26. package/src/channel.ts +202 -413
  27. package/src/commands/bot-approve.ts +143 -0
  28. package/src/commands/bot-clear-storage.ts +114 -0
  29. package/src/commands/bot-group-always.ts +62 -0
  30. package/src/commands/bot-help.ts +40 -0
  31. package/src/commands/bot-logs.ts +248 -0
  32. package/src/commands/bot-me.ts +18 -0
  33. package/src/commands/bot-pairing.ts +57 -0
  34. package/src/commands/bot-ping.ts +33 -0
  35. package/src/commands/bot-streaming.ts +55 -0
  36. package/src/commands/bot-upgrade.ts +56 -0
  37. package/src/commands/bot-version.ts +41 -0
  38. package/src/commands/config-util.ts +96 -0
  39. package/src/commands/index.ts +49 -0
  40. package/src/config.ts +59 -19
  41. package/src/dispatch/body-assembler.ts +356 -0
  42. package/src/dispatch/ctx-builder.ts +110 -0
  43. package/src/dispatch/dispatch.ts +352 -0
  44. package/src/dispatch/envelope-builder.ts +112 -0
  45. package/src/dispatch/index.ts +2 -0
  46. package/src/{approval-handler.ts → features/approval-handler.ts} +40 -94
  47. package/src/features/approval-utils.ts +41 -0
  48. package/src/features/credential-backup.ts +82 -0
  49. package/src/features/history-store.ts +19 -0
  50. package/src/features/msgid-cache.ts +55 -0
  51. package/src/features/onboarding.ts +38 -0
  52. package/src/{proactive.ts → features/proactive.ts} +68 -49
  53. package/src/features/ref-index-store.ts +282 -0
  54. package/src/{update-checker.ts → features/update-checker.ts} +15 -35
  55. package/src/gateway/event-handlers.ts +241 -0
  56. package/src/gateway/index.ts +3 -0
  57. package/src/gateway/lifecycle.ts +221 -0
  58. package/src/gateway/middleware-setup.ts +139 -0
  59. package/src/gateway/qqbot-gateway.ts +342 -0
  60. package/src/middleware/access-control.ts +130 -0
  61. package/src/middleware/attachment.ts +314 -0
  62. package/src/middleware/policy-injector.ts +66 -0
  63. package/src/openclaw-plugin-sdk.d.ts +81 -10
  64. package/src/outbound/cron-scheduler.ts +130 -0
  65. package/src/outbound/debounce.ts +102 -0
  66. package/src/outbound/deliver-pipeline.ts +235 -0
  67. package/src/outbound/image-size.ts +123 -0
  68. package/src/outbound/index.ts +3 -0
  69. package/src/outbound/local-file-router.ts +145 -0
  70. package/src/outbound/media-send.ts +377 -0
  71. package/src/outbound/outbound-service.ts +222 -0
  72. package/src/outbound/reply-limiter.ts +128 -0
  73. package/src/outbound/sanitize.ts +32 -0
  74. package/src/outbound/streaming-controller.ts +228 -0
  75. package/src/outbound/target.ts +63 -0
  76. package/src/outbound/tts-provider.ts +84 -0
  77. package/src/request-context.ts +9 -8
  78. package/src/runtime.ts +31 -6
  79. package/src/setup/account-key.ts +41 -0
  80. package/src/setup/finalize.ts +110 -0
  81. package/src/setup/login.ts +197 -0
  82. package/src/setup/surface.ts +40 -0
  83. package/src/tools/platform.ts +149 -0
  84. package/src/tools/remind.ts +1 -1
  85. package/src/types-augment.d.ts +54 -0
  86. package/src/types.ts +71 -8
  87. package/src/typings/openclaw-webhook-ingress.d.ts +66 -0
  88. package/src/utils/mention.ts +52 -0
  89. package/src/utils/pkg-version.ts +84 -47
  90. package/src/utils/platform.ts +31 -7
  91. package/src/utils/plugin-logger.ts +104 -0
  92. package/src/utils/ssrf-guard.ts +32 -2
  93. package/src/utils/stt.ts +137 -0
  94. package/src/utils/voice-text.ts +61 -0
  95. package/tsconfig.json +2 -1
  96. package/tsup.config.ts +57 -0
  97. package/dist/index.d.ts +0 -17
  98. package/dist/index.js +0 -26
  99. package/dist/src/admin-resolver.d.ts +0 -33
  100. package/dist/src/admin-resolver.js +0 -157
  101. package/dist/src/api.d.ts +0 -307
  102. package/dist/src/api.js +0 -910
  103. package/dist/src/approval-handler.d.ts +0 -47
  104. package/dist/src/approval-handler.js +0 -372
  105. package/dist/src/channel.d.ts +0 -29
  106. package/dist/src/channel.js +0 -528
  107. package/dist/src/config.d.ts +0 -56
  108. package/dist/src/config.js +0 -278
  109. package/dist/src/credential-backup.d.ts +0 -31
  110. package/dist/src/credential-backup.js +0 -66
  111. package/dist/src/deliver-debounce.d.ts +0 -74
  112. package/dist/src/deliver-debounce.js +0 -174
  113. package/dist/src/gateway.d.ts +0 -18
  114. package/dist/src/gateway.js +0 -2063
  115. package/dist/src/group-history.d.ts +0 -136
  116. package/dist/src/group-history.js +0 -226
  117. package/dist/src/image-server.d.ts +0 -87
  118. package/dist/src/image-server.js +0 -570
  119. package/dist/src/inbound-attachments.d.ts +0 -60
  120. package/dist/src/inbound-attachments.js +0 -248
  121. package/dist/src/known-users.d.ts +0 -100
  122. package/dist/src/known-users.js +0 -263
  123. package/dist/src/message-gating.d.ts +0 -53
  124. package/dist/src/message-gating.js +0 -107
  125. package/dist/src/message-queue.d.ts +0 -91
  126. package/dist/src/message-queue.js +0 -257
  127. package/dist/src/onboarding.d.ts +0 -10
  128. package/dist/src/onboarding.js +0 -203
  129. package/dist/src/outbound-deliver.d.ts +0 -48
  130. package/dist/src/outbound-deliver.js +0 -392
  131. package/dist/src/outbound.d.ts +0 -220
  132. package/dist/src/outbound.js +0 -975
  133. package/dist/src/proactive.d.ts +0 -170
  134. package/dist/src/proactive.js +0 -399
  135. package/dist/src/ref-index-store.d.ts +0 -101
  136. package/dist/src/ref-index-store.js +0 -298
  137. package/dist/src/reply-dispatcher.d.ts +0 -35
  138. package/dist/src/reply-dispatcher.js +0 -311
  139. package/dist/src/request-context.d.ts +0 -25
  140. package/dist/src/request-context.js +0 -37
  141. package/dist/src/runtime.d.ts +0 -3
  142. package/dist/src/runtime.js +0 -13
  143. package/dist/src/session-store.d.ts +0 -52
  144. package/dist/src/session-store.js +0 -254
  145. package/dist/src/slash-commands.d.ts +0 -82
  146. package/dist/src/slash-commands.js +0 -2117
  147. package/dist/src/startup-greeting.d.ts +0 -30
  148. package/dist/src/startup-greeting.js +0 -97
  149. package/dist/src/streaming.d.ts +0 -247
  150. package/dist/src/streaming.js +0 -899
  151. package/dist/src/stt.d.ts +0 -21
  152. package/dist/src/stt.js +0 -70
  153. package/dist/src/tools/channel.d.ts +0 -16
  154. package/dist/src/tools/channel.js +0 -234
  155. package/dist/src/tools/remind.d.ts +0 -2
  156. package/dist/src/tools/remind.js +0 -256
  157. package/dist/src/types.d.ts +0 -443
  158. package/dist/src/types.js +0 -22
  159. package/dist/src/typing-keepalive.d.ts +0 -27
  160. package/dist/src/typing-keepalive.js +0 -64
  161. package/dist/src/update-checker.d.ts +0 -36
  162. package/dist/src/update-checker.js +0 -171
  163. package/dist/src/utils/audio-convert.d.ts +0 -98
  164. package/dist/src/utils/audio-convert.js +0 -755
  165. package/dist/src/utils/chunked-upload.d.ts +0 -68
  166. package/dist/src/utils/chunked-upload.js +0 -341
  167. package/dist/src/utils/file-utils.d.ts +0 -61
  168. package/dist/src/utils/file-utils.js +0 -172
  169. package/dist/src/utils/image-size.d.ts +0 -51
  170. package/dist/src/utils/image-size.js +0 -234
  171. package/dist/src/utils/media-send.d.ts +0 -158
  172. package/dist/src/utils/media-send.js +0 -502
  173. package/dist/src/utils/media-tags.d.ts +0 -14
  174. package/dist/src/utils/media-tags.js +0 -165
  175. package/dist/src/utils/payload.d.ts +0 -112
  176. package/dist/src/utils/payload.js +0 -186
  177. package/dist/src/utils/pkg-version.d.ts +0 -5
  178. package/dist/src/utils/pkg-version.js +0 -61
  179. package/dist/src/utils/platform.d.ts +0 -137
  180. package/dist/src/utils/platform.js +0 -390
  181. package/dist/src/utils/ssrf-guard.d.ts +0 -25
  182. package/dist/src/utils/ssrf-guard.js +0 -91
  183. package/dist/src/utils/text-parsing.d.ts +0 -31
  184. package/dist/src/utils/text-parsing.js +0 -74
  185. package/dist/src/utils/upload-cache.d.ts +0 -34
  186. package/dist/src/utils/upload-cache.js +0 -93
  187. package/node_modules/@eshaz/web-worker/LICENSE +0 -201
  188. package/node_modules/@eshaz/web-worker/README.md +0 -134
  189. package/node_modules/@eshaz/web-worker/browser.js +0 -17
  190. package/node_modules/@eshaz/web-worker/cjs/browser.js +0 -16
  191. package/node_modules/@eshaz/web-worker/cjs/node.js +0 -219
  192. package/node_modules/@eshaz/web-worker/index.d.ts +0 -4
  193. package/node_modules/@eshaz/web-worker/node.js +0 -223
  194. package/node_modules/@eshaz/web-worker/package.json +0 -54
  195. package/node_modules/@wasm-audio-decoders/common/index.js +0 -5
  196. package/node_modules/@wasm-audio-decoders/common/package.json +0 -36
  197. package/node_modules/@wasm-audio-decoders/common/src/WASMAudioDecoderCommon.js +0 -231
  198. package/node_modules/@wasm-audio-decoders/common/src/WASMAudioDecoderWorker.js +0 -129
  199. package/node_modules/@wasm-audio-decoders/common/src/puff/README +0 -67
  200. package/node_modules/@wasm-audio-decoders/common/src/puff/build_puff.js +0 -31
  201. package/node_modules/@wasm-audio-decoders/common/src/puff/puff.c +0 -863
  202. package/node_modules/@wasm-audio-decoders/common/src/puff/puff.h +0 -35
  203. package/node_modules/@wasm-audio-decoders/common/src/utilities.js +0 -3
  204. package/node_modules/@wasm-audio-decoders/common/types.d.ts +0 -7
  205. package/node_modules/mpg123-decoder/README.md +0 -265
  206. package/node_modules/mpg123-decoder/dist/mpg123-decoder.min.js +0 -185
  207. package/node_modules/mpg123-decoder/dist/mpg123-decoder.min.js.map +0 -1
  208. package/node_modules/mpg123-decoder/index.js +0 -8
  209. package/node_modules/mpg123-decoder/package.json +0 -58
  210. package/node_modules/mpg123-decoder/src/EmscriptenWasm.js +0 -464
  211. package/node_modules/mpg123-decoder/src/MPEGDecoder.js +0 -200
  212. package/node_modules/mpg123-decoder/src/MPEGDecoderWebWorker.js +0 -21
  213. package/node_modules/mpg123-decoder/types.d.ts +0 -30
  214. package/node_modules/silk-wasm/LICENSE +0 -21
  215. package/node_modules/silk-wasm/README.md +0 -85
  216. package/node_modules/silk-wasm/lib/index.cjs +0 -16
  217. package/node_modules/silk-wasm/lib/index.d.ts +0 -70
  218. package/node_modules/silk-wasm/lib/index.mjs +0 -16
  219. package/node_modules/silk-wasm/lib/silk.wasm +0 -0
  220. package/node_modules/silk-wasm/lib/utils.d.ts +0 -4
  221. package/node_modules/silk-wasm/package.json +0 -39
  222. package/node_modules/simple-yenc/.github/FUNDING.yml +0 -1
  223. package/node_modules/simple-yenc/.prettierignore +0 -1
  224. package/node_modules/simple-yenc/LICENSE +0 -7
  225. package/node_modules/simple-yenc/README.md +0 -163
  226. package/node_modules/simple-yenc/dist/esm.js +0 -1
  227. package/node_modules/simple-yenc/dist/index.js +0 -1
  228. package/node_modules/simple-yenc/package.json +0 -50
  229. package/node_modules/simple-yenc/rollup.config.js +0 -27
  230. package/node_modules/simple-yenc/src/simple-yenc.js +0 -302
  231. package/node_modules/ws/LICENSE +0 -20
  232. package/node_modules/ws/README.md +0 -548
  233. package/node_modules/ws/browser.js +0 -8
  234. package/node_modules/ws/index.js +0 -13
  235. package/node_modules/ws/lib/buffer-util.js +0 -131
  236. package/node_modules/ws/lib/constants.js +0 -19
  237. package/node_modules/ws/lib/event-target.js +0 -292
  238. package/node_modules/ws/lib/extension.js +0 -203
  239. package/node_modules/ws/lib/limiter.js +0 -55
  240. package/node_modules/ws/lib/permessage-deflate.js +0 -528
  241. package/node_modules/ws/lib/receiver.js +0 -706
  242. package/node_modules/ws/lib/sender.js +0 -602
  243. package/node_modules/ws/lib/stream.js +0 -161
  244. package/node_modules/ws/lib/subprotocol.js +0 -62
  245. package/node_modules/ws/lib/validation.js +0 -152
  246. package/node_modules/ws/lib/websocket-server.js +0 -554
  247. package/node_modules/ws/lib/websocket.js +0 -1393
  248. package/node_modules/ws/package.json +0 -69
  249. package/node_modules/ws/wrapper.mjs +0 -8
  250. package/scripts/postinstall-link-sdk.js +0 -126
  251. package/skills/qqbot-media/SKILL.md +0 -60
  252. package/src/admin-resolver.ts +0 -181
  253. package/src/api.ts +0 -1319
  254. package/src/credential-backup.ts +0 -72
  255. package/src/deliver-debounce.ts +0 -229
  256. package/src/gateway.ts +0 -2304
  257. package/src/group-history.ts +0 -328
  258. package/src/image-server.ts +0 -675
  259. package/src/inbound-attachments.ts +0 -321
  260. package/src/known-users.ts +0 -353
  261. package/src/message-gating.ts +0 -190
  262. package/src/message-queue.ts +0 -354
  263. package/src/onboarding.ts +0 -274
  264. package/src/outbound-deliver.ts +0 -486
  265. package/src/outbound.ts +0 -1179
  266. package/src/ref-index-store.ts +0 -412
  267. package/src/reply-dispatcher.ts +0 -334
  268. package/src/session-store.ts +0 -303
  269. package/src/slash-commands.ts +0 -2297
  270. package/src/startup-greeting.ts +0 -120
  271. package/src/streaming.ts +0 -1077
  272. package/src/stt.ts +0 -86
  273. package/src/tools/channel.ts +0 -281
  274. package/src/typing-keepalive.ts +0 -59
  275. package/src/utils/audio-convert.ts +0 -859
  276. package/src/utils/chunked-upload.ts +0 -483
  277. package/src/utils/file-utils.ts +0 -193
  278. package/src/utils/image-size.ts +0 -266
  279. package/src/utils/media-send.ts +0 -636
  280. package/src/utils/media-tags.ts +0 -183
  281. package/src/utils/payload.ts +0 -265
  282. package/src/utils/text-parsing.ts +0 -85
  283. package/src/utils/upload-cache.ts +0 -128
@@ -1,602 +0,0 @@
1
- /* eslint no-unused-vars: ["error", { "varsIgnorePattern": "^Duplex" }] */
2
-
3
- 'use strict';
4
-
5
- const { Duplex } = require('stream');
6
- const { randomFillSync } = require('crypto');
7
-
8
- const PerMessageDeflate = require('./permessage-deflate');
9
- const { EMPTY_BUFFER, kWebSocket, NOOP } = require('./constants');
10
- const { isBlob, isValidStatusCode } = require('./validation');
11
- const { mask: applyMask, toBuffer } = require('./buffer-util');
12
-
13
- const kByteLength = Symbol('kByteLength');
14
- const maskBuffer = Buffer.alloc(4);
15
- const RANDOM_POOL_SIZE = 8 * 1024;
16
- let randomPool;
17
- let randomPoolPointer = RANDOM_POOL_SIZE;
18
-
19
- const DEFAULT = 0;
20
- const DEFLATING = 1;
21
- const GET_BLOB_DATA = 2;
22
-
23
- /**
24
- * HyBi Sender implementation.
25
- */
26
- class Sender {
27
- /**
28
- * Creates a Sender instance.
29
- *
30
- * @param {Duplex} socket The connection socket
31
- * @param {Object} [extensions] An object containing the negotiated extensions
32
- * @param {Function} [generateMask] The function used to generate the masking
33
- * key
34
- */
35
- constructor(socket, extensions, generateMask) {
36
- this._extensions = extensions || {};
37
-
38
- if (generateMask) {
39
- this._generateMask = generateMask;
40
- this._maskBuffer = Buffer.alloc(4);
41
- }
42
-
43
- this._socket = socket;
44
-
45
- this._firstFragment = true;
46
- this._compress = false;
47
-
48
- this._bufferedBytes = 0;
49
- this._queue = [];
50
- this._state = DEFAULT;
51
- this.onerror = NOOP;
52
- this[kWebSocket] = undefined;
53
- }
54
-
55
- /**
56
- * Frames a piece of data according to the HyBi WebSocket protocol.
57
- *
58
- * @param {(Buffer|String)} data The data to frame
59
- * @param {Object} options Options object
60
- * @param {Boolean} [options.fin=false] Specifies whether or not to set the
61
- * FIN bit
62
- * @param {Function} [options.generateMask] The function used to generate the
63
- * masking key
64
- * @param {Boolean} [options.mask=false] Specifies whether or not to mask
65
- * `data`
66
- * @param {Buffer} [options.maskBuffer] The buffer used to store the masking
67
- * key
68
- * @param {Number} options.opcode The opcode
69
- * @param {Boolean} [options.readOnly=false] Specifies whether `data` can be
70
- * modified
71
- * @param {Boolean} [options.rsv1=false] Specifies whether or not to set the
72
- * RSV1 bit
73
- * @return {(Buffer|String)[]} The framed data
74
- * @public
75
- */
76
- static frame(data, options) {
77
- let mask;
78
- let merge = false;
79
- let offset = 2;
80
- let skipMasking = false;
81
-
82
- if (options.mask) {
83
- mask = options.maskBuffer || maskBuffer;
84
-
85
- if (options.generateMask) {
86
- options.generateMask(mask);
87
- } else {
88
- if (randomPoolPointer === RANDOM_POOL_SIZE) {
89
- /* istanbul ignore else */
90
- if (randomPool === undefined) {
91
- //
92
- // This is lazily initialized because server-sent frames must not
93
- // be masked so it may never be used.
94
- //
95
- randomPool = Buffer.alloc(RANDOM_POOL_SIZE);
96
- }
97
-
98
- randomFillSync(randomPool, 0, RANDOM_POOL_SIZE);
99
- randomPoolPointer = 0;
100
- }
101
-
102
- mask[0] = randomPool[randomPoolPointer++];
103
- mask[1] = randomPool[randomPoolPointer++];
104
- mask[2] = randomPool[randomPoolPointer++];
105
- mask[3] = randomPool[randomPoolPointer++];
106
- }
107
-
108
- skipMasking = (mask[0] | mask[1] | mask[2] | mask[3]) === 0;
109
- offset = 6;
110
- }
111
-
112
- let dataLength;
113
-
114
- if (typeof data === 'string') {
115
- if (
116
- (!options.mask || skipMasking) &&
117
- options[kByteLength] !== undefined
118
- ) {
119
- dataLength = options[kByteLength];
120
- } else {
121
- data = Buffer.from(data);
122
- dataLength = data.length;
123
- }
124
- } else {
125
- dataLength = data.length;
126
- merge = options.mask && options.readOnly && !skipMasking;
127
- }
128
-
129
- let payloadLength = dataLength;
130
-
131
- if (dataLength >= 65536) {
132
- offset += 8;
133
- payloadLength = 127;
134
- } else if (dataLength > 125) {
135
- offset += 2;
136
- payloadLength = 126;
137
- }
138
-
139
- const target = Buffer.allocUnsafe(merge ? dataLength + offset : offset);
140
-
141
- target[0] = options.fin ? options.opcode | 0x80 : options.opcode;
142
- if (options.rsv1) target[0] |= 0x40;
143
-
144
- target[1] = payloadLength;
145
-
146
- if (payloadLength === 126) {
147
- target.writeUInt16BE(dataLength, 2);
148
- } else if (payloadLength === 127) {
149
- target[2] = target[3] = 0;
150
- target.writeUIntBE(dataLength, 4, 6);
151
- }
152
-
153
- if (!options.mask) return [target, data];
154
-
155
- target[1] |= 0x80;
156
- target[offset - 4] = mask[0];
157
- target[offset - 3] = mask[1];
158
- target[offset - 2] = mask[2];
159
- target[offset - 1] = mask[3];
160
-
161
- if (skipMasking) return [target, data];
162
-
163
- if (merge) {
164
- applyMask(data, mask, target, offset, dataLength);
165
- return [target];
166
- }
167
-
168
- applyMask(data, mask, data, 0, dataLength);
169
- return [target, data];
170
- }
171
-
172
- /**
173
- * Sends a close message to the other peer.
174
- *
175
- * @param {Number} [code] The status code component of the body
176
- * @param {(String|Buffer)} [data] The message component of the body
177
- * @param {Boolean} [mask=false] Specifies whether or not to mask the message
178
- * @param {Function} [cb] Callback
179
- * @public
180
- */
181
- close(code, data, mask, cb) {
182
- let buf;
183
-
184
- if (code === undefined) {
185
- buf = EMPTY_BUFFER;
186
- } else if (typeof code !== 'number' || !isValidStatusCode(code)) {
187
- throw new TypeError('First argument must be a valid error code number');
188
- } else if (data === undefined || !data.length) {
189
- buf = Buffer.allocUnsafe(2);
190
- buf.writeUInt16BE(code, 0);
191
- } else {
192
- const length = Buffer.byteLength(data);
193
-
194
- if (length > 123) {
195
- throw new RangeError('The message must not be greater than 123 bytes');
196
- }
197
-
198
- buf = Buffer.allocUnsafe(2 + length);
199
- buf.writeUInt16BE(code, 0);
200
-
201
- if (typeof data === 'string') {
202
- buf.write(data, 2);
203
- } else {
204
- buf.set(data, 2);
205
- }
206
- }
207
-
208
- const options = {
209
- [kByteLength]: buf.length,
210
- fin: true,
211
- generateMask: this._generateMask,
212
- mask,
213
- maskBuffer: this._maskBuffer,
214
- opcode: 0x08,
215
- readOnly: false,
216
- rsv1: false
217
- };
218
-
219
- if (this._state !== DEFAULT) {
220
- this.enqueue([this.dispatch, buf, false, options, cb]);
221
- } else {
222
- this.sendFrame(Sender.frame(buf, options), cb);
223
- }
224
- }
225
-
226
- /**
227
- * Sends a ping message to the other peer.
228
- *
229
- * @param {*} data The message to send
230
- * @param {Boolean} [mask=false] Specifies whether or not to mask `data`
231
- * @param {Function} [cb] Callback
232
- * @public
233
- */
234
- ping(data, mask, cb) {
235
- let byteLength;
236
- let readOnly;
237
-
238
- if (typeof data === 'string') {
239
- byteLength = Buffer.byteLength(data);
240
- readOnly = false;
241
- } else if (isBlob(data)) {
242
- byteLength = data.size;
243
- readOnly = false;
244
- } else {
245
- data = toBuffer(data);
246
- byteLength = data.length;
247
- readOnly = toBuffer.readOnly;
248
- }
249
-
250
- if (byteLength > 125) {
251
- throw new RangeError('The data size must not be greater than 125 bytes');
252
- }
253
-
254
- const options = {
255
- [kByteLength]: byteLength,
256
- fin: true,
257
- generateMask: this._generateMask,
258
- mask,
259
- maskBuffer: this._maskBuffer,
260
- opcode: 0x09,
261
- readOnly,
262
- rsv1: false
263
- };
264
-
265
- if (isBlob(data)) {
266
- if (this._state !== DEFAULT) {
267
- this.enqueue([this.getBlobData, data, false, options, cb]);
268
- } else {
269
- this.getBlobData(data, false, options, cb);
270
- }
271
- } else if (this._state !== DEFAULT) {
272
- this.enqueue([this.dispatch, data, false, options, cb]);
273
- } else {
274
- this.sendFrame(Sender.frame(data, options), cb);
275
- }
276
- }
277
-
278
- /**
279
- * Sends a pong message to the other peer.
280
- *
281
- * @param {*} data The message to send
282
- * @param {Boolean} [mask=false] Specifies whether or not to mask `data`
283
- * @param {Function} [cb] Callback
284
- * @public
285
- */
286
- pong(data, mask, cb) {
287
- let byteLength;
288
- let readOnly;
289
-
290
- if (typeof data === 'string') {
291
- byteLength = Buffer.byteLength(data);
292
- readOnly = false;
293
- } else if (isBlob(data)) {
294
- byteLength = data.size;
295
- readOnly = false;
296
- } else {
297
- data = toBuffer(data);
298
- byteLength = data.length;
299
- readOnly = toBuffer.readOnly;
300
- }
301
-
302
- if (byteLength > 125) {
303
- throw new RangeError('The data size must not be greater than 125 bytes');
304
- }
305
-
306
- const options = {
307
- [kByteLength]: byteLength,
308
- fin: true,
309
- generateMask: this._generateMask,
310
- mask,
311
- maskBuffer: this._maskBuffer,
312
- opcode: 0x0a,
313
- readOnly,
314
- rsv1: false
315
- };
316
-
317
- if (isBlob(data)) {
318
- if (this._state !== DEFAULT) {
319
- this.enqueue([this.getBlobData, data, false, options, cb]);
320
- } else {
321
- this.getBlobData(data, false, options, cb);
322
- }
323
- } else if (this._state !== DEFAULT) {
324
- this.enqueue([this.dispatch, data, false, options, cb]);
325
- } else {
326
- this.sendFrame(Sender.frame(data, options), cb);
327
- }
328
- }
329
-
330
- /**
331
- * Sends a data message to the other peer.
332
- *
333
- * @param {*} data The message to send
334
- * @param {Object} options Options object
335
- * @param {Boolean} [options.binary=false] Specifies whether `data` is binary
336
- * or text
337
- * @param {Boolean} [options.compress=false] Specifies whether or not to
338
- * compress `data`
339
- * @param {Boolean} [options.fin=false] Specifies whether the fragment is the
340
- * last one
341
- * @param {Boolean} [options.mask=false] Specifies whether or not to mask
342
- * `data`
343
- * @param {Function} [cb] Callback
344
- * @public
345
- */
346
- send(data, options, cb) {
347
- const perMessageDeflate = this._extensions[PerMessageDeflate.extensionName];
348
- let opcode = options.binary ? 2 : 1;
349
- let rsv1 = options.compress;
350
-
351
- let byteLength;
352
- let readOnly;
353
-
354
- if (typeof data === 'string') {
355
- byteLength = Buffer.byteLength(data);
356
- readOnly = false;
357
- } else if (isBlob(data)) {
358
- byteLength = data.size;
359
- readOnly = false;
360
- } else {
361
- data = toBuffer(data);
362
- byteLength = data.length;
363
- readOnly = toBuffer.readOnly;
364
- }
365
-
366
- if (this._firstFragment) {
367
- this._firstFragment = false;
368
- if (
369
- rsv1 &&
370
- perMessageDeflate &&
371
- perMessageDeflate.params[
372
- perMessageDeflate._isServer
373
- ? 'server_no_context_takeover'
374
- : 'client_no_context_takeover'
375
- ]
376
- ) {
377
- rsv1 = byteLength >= perMessageDeflate._threshold;
378
- }
379
- this._compress = rsv1;
380
- } else {
381
- rsv1 = false;
382
- opcode = 0;
383
- }
384
-
385
- if (options.fin) this._firstFragment = true;
386
-
387
- const opts = {
388
- [kByteLength]: byteLength,
389
- fin: options.fin,
390
- generateMask: this._generateMask,
391
- mask: options.mask,
392
- maskBuffer: this._maskBuffer,
393
- opcode,
394
- readOnly,
395
- rsv1
396
- };
397
-
398
- if (isBlob(data)) {
399
- if (this._state !== DEFAULT) {
400
- this.enqueue([this.getBlobData, data, this._compress, opts, cb]);
401
- } else {
402
- this.getBlobData(data, this._compress, opts, cb);
403
- }
404
- } else if (this._state !== DEFAULT) {
405
- this.enqueue([this.dispatch, data, this._compress, opts, cb]);
406
- } else {
407
- this.dispatch(data, this._compress, opts, cb);
408
- }
409
- }
410
-
411
- /**
412
- * Gets the contents of a blob as binary data.
413
- *
414
- * @param {Blob} blob The blob
415
- * @param {Boolean} [compress=false] Specifies whether or not to compress
416
- * the data
417
- * @param {Object} options Options object
418
- * @param {Boolean} [options.fin=false] Specifies whether or not to set the
419
- * FIN bit
420
- * @param {Function} [options.generateMask] The function used to generate the
421
- * masking key
422
- * @param {Boolean} [options.mask=false] Specifies whether or not to mask
423
- * `data`
424
- * @param {Buffer} [options.maskBuffer] The buffer used to store the masking
425
- * key
426
- * @param {Number} options.opcode The opcode
427
- * @param {Boolean} [options.readOnly=false] Specifies whether `data` can be
428
- * modified
429
- * @param {Boolean} [options.rsv1=false] Specifies whether or not to set the
430
- * RSV1 bit
431
- * @param {Function} [cb] Callback
432
- * @private
433
- */
434
- getBlobData(blob, compress, options, cb) {
435
- this._bufferedBytes += options[kByteLength];
436
- this._state = GET_BLOB_DATA;
437
-
438
- blob
439
- .arrayBuffer()
440
- .then((arrayBuffer) => {
441
- if (this._socket.destroyed) {
442
- const err = new Error(
443
- 'The socket was closed while the blob was being read'
444
- );
445
-
446
- //
447
- // `callCallbacks` is called in the next tick to ensure that errors
448
- // that might be thrown in the callbacks behave like errors thrown
449
- // outside the promise chain.
450
- //
451
- process.nextTick(callCallbacks, this, err, cb);
452
- return;
453
- }
454
-
455
- this._bufferedBytes -= options[kByteLength];
456
- const data = toBuffer(arrayBuffer);
457
-
458
- if (!compress) {
459
- this._state = DEFAULT;
460
- this.sendFrame(Sender.frame(data, options), cb);
461
- this.dequeue();
462
- } else {
463
- this.dispatch(data, compress, options, cb);
464
- }
465
- })
466
- .catch((err) => {
467
- //
468
- // `onError` is called in the next tick for the same reason that
469
- // `callCallbacks` above is.
470
- //
471
- process.nextTick(onError, this, err, cb);
472
- });
473
- }
474
-
475
- /**
476
- * Dispatches a message.
477
- *
478
- * @param {(Buffer|String)} data The message to send
479
- * @param {Boolean} [compress=false] Specifies whether or not to compress
480
- * `data`
481
- * @param {Object} options Options object
482
- * @param {Boolean} [options.fin=false] Specifies whether or not to set the
483
- * FIN bit
484
- * @param {Function} [options.generateMask] The function used to generate the
485
- * masking key
486
- * @param {Boolean} [options.mask=false] Specifies whether or not to mask
487
- * `data`
488
- * @param {Buffer} [options.maskBuffer] The buffer used to store the masking
489
- * key
490
- * @param {Number} options.opcode The opcode
491
- * @param {Boolean} [options.readOnly=false] Specifies whether `data` can be
492
- * modified
493
- * @param {Boolean} [options.rsv1=false] Specifies whether or not to set the
494
- * RSV1 bit
495
- * @param {Function} [cb] Callback
496
- * @private
497
- */
498
- dispatch(data, compress, options, cb) {
499
- if (!compress) {
500
- this.sendFrame(Sender.frame(data, options), cb);
501
- return;
502
- }
503
-
504
- const perMessageDeflate = this._extensions[PerMessageDeflate.extensionName];
505
-
506
- this._bufferedBytes += options[kByteLength];
507
- this._state = DEFLATING;
508
- perMessageDeflate.compress(data, options.fin, (_, buf) => {
509
- if (this._socket.destroyed) {
510
- const err = new Error(
511
- 'The socket was closed while data was being compressed'
512
- );
513
-
514
- callCallbacks(this, err, cb);
515
- return;
516
- }
517
-
518
- this._bufferedBytes -= options[kByteLength];
519
- this._state = DEFAULT;
520
- options.readOnly = false;
521
- this.sendFrame(Sender.frame(buf, options), cb);
522
- this.dequeue();
523
- });
524
- }
525
-
526
- /**
527
- * Executes queued send operations.
528
- *
529
- * @private
530
- */
531
- dequeue() {
532
- while (this._state === DEFAULT && this._queue.length) {
533
- const params = this._queue.shift();
534
-
535
- this._bufferedBytes -= params[3][kByteLength];
536
- Reflect.apply(params[0], this, params.slice(1));
537
- }
538
- }
539
-
540
- /**
541
- * Enqueues a send operation.
542
- *
543
- * @param {Array} params Send operation parameters.
544
- * @private
545
- */
546
- enqueue(params) {
547
- this._bufferedBytes += params[3][kByteLength];
548
- this._queue.push(params);
549
- }
550
-
551
- /**
552
- * Sends a frame.
553
- *
554
- * @param {(Buffer | String)[]} list The frame to send
555
- * @param {Function} [cb] Callback
556
- * @private
557
- */
558
- sendFrame(list, cb) {
559
- if (list.length === 2) {
560
- this._socket.cork();
561
- this._socket.write(list[0]);
562
- this._socket.write(list[1], cb);
563
- this._socket.uncork();
564
- } else {
565
- this._socket.write(list[0], cb);
566
- }
567
- }
568
- }
569
-
570
- module.exports = Sender;
571
-
572
- /**
573
- * Calls queued callbacks with an error.
574
- *
575
- * @param {Sender} sender The `Sender` instance
576
- * @param {Error} err The error to call the callbacks with
577
- * @param {Function} [cb] The first callback
578
- * @private
579
- */
580
- function callCallbacks(sender, err, cb) {
581
- if (typeof cb === 'function') cb(err);
582
-
583
- for (let i = 0; i < sender._queue.length; i++) {
584
- const params = sender._queue[i];
585
- const callback = params[params.length - 1];
586
-
587
- if (typeof callback === 'function') callback(err);
588
- }
589
- }
590
-
591
- /**
592
- * Handles a `Sender` error.
593
- *
594
- * @param {Sender} sender The `Sender` instance
595
- * @param {Error} err The error
596
- * @param {Function} [cb] The first pending callback
597
- * @private
598
- */
599
- function onError(sender, err, cb) {
600
- callCallbacks(sender, err, cb);
601
- sender.onerror(err);
602
- }