@remotion/renderer 3.0.31 → 3.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 (93) hide show
  1. package/dist/browser/NetworkManager.js +1 -5
  2. package/dist/combine-videos.d.ts +2 -1
  3. package/dist/combine-videos.js +8 -2
  4. package/dist/convert-number-of-gif-loops-to-ffmpeg.d.ts +1 -0
  5. package/dist/convert-number-of-gif-loops-to-ffmpeg.js +17 -0
  6. package/dist/ensure-frames-in-order.d.ts +1 -1
  7. package/dist/ensure-frames-in-order.js +3 -2
  8. package/dist/ensure-presentation-timestamp.d.ts +1 -1
  9. package/dist/ensure-presentation-timestamp.js +9 -10
  10. package/dist/extract-frame-from-video.js +4 -2
  11. package/dist/get-codec-name.js +3 -0
  12. package/dist/get-duration-from-frame-range.d.ts +1 -2
  13. package/dist/get-duration-from-frame-range.js +13 -9
  14. package/dist/get-extension-from-codec.d.ts +1 -1
  15. package/dist/get-extension-from-codec.js +5 -0
  16. package/dist/index.d.ts +4 -3
  17. package/dist/index.js +3 -1
  18. package/dist/mime-types.d.ts +1 -1
  19. package/dist/mime-types.js +2 -2
  20. package/dist/prespawn-ffmpeg.js +2 -2
  21. package/dist/render-frames.d.ts +1 -0
  22. package/dist/render-frames.js +12 -16
  23. package/dist/render-media.d.ts +2 -0
  24. package/dist/render-media.js +11 -4
  25. package/dist/render-still.js +1 -1
  26. package/dist/stitch-frames-to-video.d.ts +1 -0
  27. package/dist/stitch-frames-to-video.js +32 -22
  28. package/dist/validate-output-filename.js +5 -0
  29. package/package.json +8 -10
  30. package/tsconfig.json +2 -1
  31. package/vitest.config.ts +8 -0
  32. package/dist/abort.d.ts +0 -7
  33. package/dist/abort.js +0 -20
  34. package/dist/assets/cleanup-assets.d.ts +0 -2
  35. package/dist/assets/cleanup-assets.js +0 -2
  36. package/dist/browser/ConnectionTransport.d.ts +0 -21
  37. package/dist/browser/ConnectionTransport.js +0 -17
  38. package/dist/browser/EmulationManager.d.ts +0 -7
  39. package/dist/browser/EmulationManager.js +0 -40
  40. package/dist/browser/Page.d.ts +0 -74
  41. package/dist/browser/Page.js +0 -283
  42. package/dist/browser/compat.d.ts +0 -2
  43. package/dist/browser/compat.js +0 -17
  44. package/dist/browser/environment.d.ts +0 -16
  45. package/dist/browser/environment.js +0 -19
  46. package/dist/browser/ws.d.ts +0 -287
  47. package/dist/browser/ws.js +0 -21
  48. package/dist/cancel.d.ts +0 -7
  49. package/dist/cancel.js +0 -25
  50. package/dist/ensure-faststart.d.ts +0 -1
  51. package/dist/ensure-faststart.js +0 -14
  52. package/dist/faststart/atom.d.ts +0 -35
  53. package/dist/faststart/atom.js +0 -138
  54. package/dist/faststart/index.d.ts +0 -0
  55. package/dist/faststart/index.js +0 -1
  56. package/dist/faststart/options.d.ts +0 -6
  57. package/dist/faststart/options.js +0 -2
  58. package/dist/faststart/qt-faststart.d.ts +0 -18
  59. package/dist/faststart/qt-faststart.js +0 -66
  60. package/dist/faststart/update-chunk-offsets.d.ts +0 -10
  61. package/dist/faststart/update-chunk-offsets.js +0 -114
  62. package/dist/faststart/util.d.ts +0 -9
  63. package/dist/faststart/util.js +0 -34
  64. package/dist/get-duration-of-asset.d.ts +0 -7
  65. package/dist/get-duration-of-asset.js +0 -36
  66. package/dist/is-vp9-video.d.ts +0 -3
  67. package/dist/is-vp9-video.js +0 -24
  68. package/dist/offthread/index.d.ts +0 -0
  69. package/dist/offthread/index.js +0 -1
  70. package/dist/render-gif.d.ts +0 -2
  71. package/dist/render-gif.js +0 -242
  72. package/dist/serve-handler/glob-slash.d.ts +0 -1
  73. package/dist/serve-handler/glob-slash.js +0 -12
  74. package/dist/should-use-vp9-decoder.d.ts +0 -0
  75. package/dist/should-use-vp9-decoder.js +0 -1
  76. package/dist/stitch-frames-to-gif.d.ts +0 -8
  77. package/dist/stitch-frames-to-gif.js +0 -128
  78. package/dist/validate-fps-for-gif.d.ts +0 -2
  79. package/dist/validate-fps-for-gif.js +0 -9
  80. package/dist/validate-offthreadvideo-image-format.d.ts +0 -1
  81. package/dist/validate-offthreadvideo-image-format.js +0 -15
  82. package/dist/ws/buffer-util.d.ts +0 -10
  83. package/dist/ws/buffer-util.js +0 -123
  84. package/dist/ws/constants.d.ts +0 -10
  85. package/dist/ws/constants.js +0 -13
  86. package/dist/ws/event-target.d.ts +0 -155
  87. package/dist/ws/event-target.js +0 -203
  88. package/dist/ws/extension.d.ts +0 -16
  89. package/dist/ws/extension.js +0 -232
  90. package/dist/ws/limiter.d.ts +0 -34
  91. package/dist/ws/limiter.js +0 -41
  92. package/dist/ws/permessage_deflate.d.ts +0 -152
  93. package/dist/ws/permessage_deflate.js +0 -409
@@ -1,283 +0,0 @@
1
- "use strict";
2
- /**
3
- * Copyright 2017 Google Inc. All rights reserved.
4
- *
5
- * Licensed under the Apache License, Version 2.0 (the "License");
6
- * you may not use this file except in compliance with the License.
7
- * You may obtain a copy of the License at
8
- *
9
- * http://www.apache.org/licenses/LICENSE-2.0
10
- *
11
- * Unless required by applicable law or agreed to in writing, software
12
- * distributed under the License is distributed on an "AS IS" BASIS,
13
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
- * See the License for the specific language governing permissions and
15
- * limitations under the License.
16
- */
17
- var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
18
- if (kind === "m") throw new TypeError("Private method is not writable");
19
- if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
20
- if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
21
- return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
22
- };
23
- var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
24
- if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
25
- if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
26
- return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
27
- };
28
- var _Page_instances, _Page_closed, _Page_client, _Page_target, _Page_timeoutSettings, _Page_frameManager, _Page_pageBindings, _Page_initialize, _Page_onTargetCrashed, _Page_onLogEntryAdded, _Page_onConsoleAPI, _Page_onBindingCalled, _Page_addConsoleMessage;
29
- Object.defineProperty(exports, "__esModule", { value: true });
30
- exports.Page = void 0;
31
- const assert_1 = require("./assert");
32
- const ConsoleMessage_1 = require("./ConsoleMessage");
33
- const EventEmitter_1 = require("./EventEmitter");
34
- const FrameManager_1 = require("./FrameManager");
35
- const JSHandle_1 = require("./JSHandle");
36
- const TaskQueue_1 = require("./TaskQueue");
37
- const TimeoutSettings_1 = require("./TimeoutSettings");
38
- const util_1 = require("./util");
39
- class Page extends EventEmitter_1.EventEmitter {
40
- constructor(client, target, browser) {
41
- super();
42
- _Page_instances.add(this);
43
- _Page_closed.set(this, false);
44
- _Page_client.set(this, void 0);
45
- _Page_target.set(this, void 0);
46
- _Page_timeoutSettings.set(this, new TimeoutSettings_1.TimeoutSettings());
47
- _Page_frameManager.set(this, void 0);
48
- _Page_pageBindings.set(this, new Map());
49
- __classPrivateFieldSet(this, _Page_client, client, "f");
50
- __classPrivateFieldSet(this, _Page_target, target, "f");
51
- __classPrivateFieldSet(this, _Page_frameManager, new FrameManager_1.FrameManager(client, this, __classPrivateFieldGet(this, _Page_timeoutSettings, "f")), "f");
52
- this.screenshotTaskQueue = new TaskQueue_1.TaskQueue();
53
- this.browser = browser;
54
- client.on('Target.attachedToTarget', (event) => {
55
- switch (event.targetInfo.type) {
56
- case 'iframe':
57
- break;
58
- case 'worker':
59
- break;
60
- default:
61
- // If we don't detach from service workers, they will never die.
62
- // We still want to attach to workers for emitting events.
63
- // We still want to attach to iframes so sessions may interact with them.
64
- // We detach from all other types out of an abundance of caution.
65
- // See https://source.chromium.org/chromium/chromium/src/+/main:content/browser/devtools/devtools_agent_host_impl.cc?ss=chromium&q=f:devtools%20-f:out%20%22::kTypePage%5B%5D%22
66
- // for the complete list of available types.
67
- client
68
- .send('Target.detachFromTarget', {
69
- sessionId: event.sessionId,
70
- })
71
- .catch((err) => console.log(err));
72
- }
73
- });
74
- client.on('Runtime.consoleAPICalled', (event) => {
75
- return __classPrivateFieldGet(this, _Page_instances, "m", _Page_onConsoleAPI).call(this, event);
76
- });
77
- client.on('Runtime.bindingCalled', (event) => {
78
- return __classPrivateFieldGet(this, _Page_instances, "m", _Page_onBindingCalled).call(this, event);
79
- });
80
- client.on('Inspector.targetCrashed', () => {
81
- return __classPrivateFieldGet(this, _Page_instances, "m", _Page_onTargetCrashed).call(this);
82
- });
83
- client.on('Log.entryAdded', (event) => {
84
- return __classPrivateFieldGet(this, _Page_instances, "m", _Page_onLogEntryAdded).call(this, event);
85
- });
86
- }
87
- static async _create(client, target, defaultViewport, browser) {
88
- const page = new Page(client, target, browser);
89
- await __classPrivateFieldGet(page, _Page_instances, "m", _Page_initialize).call(page);
90
- await page.setViewport(defaultViewport);
91
- return page;
92
- }
93
- /**
94
- * Listen to page events.
95
- */
96
- // Note: this method exists to define event typings and handle
97
- // proper wireup of cooperative request interception. Actual event listening and
98
- // dispatching is delegated to EventEmitter.
99
- on(eventName, handler) {
100
- return super.on(eventName, handler);
101
- }
102
- once(eventName, handler) {
103
- // Note: this method only exists to define the types; we delegate the impl
104
- // to EventEmitter.
105
- return super.once(eventName, handler);
106
- }
107
- off(eventName, handler) {
108
- return super.off(eventName, handler);
109
- }
110
- /**
111
- * @returns A target this page was created from.
112
- */
113
- target() {
114
- return __classPrivateFieldGet(this, _Page_target, "f");
115
- }
116
- _client() {
117
- return __classPrivateFieldGet(this, _Page_client, "f");
118
- }
119
- /**
120
- * @returns The page's main frame.
121
- * @remarks
122
- * Page is guaranteed to have a main frame which persists during navigations.
123
- */
124
- mainFrame() {
125
- return __classPrivateFieldGet(this, _Page_frameManager, "f").mainFrame();
126
- }
127
- setViewport(viewport) {
128
- return __classPrivateFieldGet(this, _Page_client, "f").send('Emulation.setDeviceMetricsOverride', {
129
- mobile: false,
130
- width: viewport.width,
131
- height: viewport.height,
132
- deviceScaleFactor: viewport.deviceScaleFactor,
133
- screenOrientation: {
134
- angle: 0,
135
- type: 'portraitPrimary',
136
- },
137
- });
138
- }
139
- setDefaultNavigationTimeout(timeout) {
140
- __classPrivateFieldGet(this, _Page_timeoutSettings, "f").setDefaultNavigationTimeout(timeout);
141
- }
142
- setDefaultTimeout(timeout) {
143
- __classPrivateFieldGet(this, _Page_timeoutSettings, "f").setDefaultTimeout(timeout);
144
- }
145
- async evaluateHandle(pageFunction, ...args) {
146
- const context = await this.mainFrame().executionContext();
147
- return context.evaluateHandle(pageFunction, ...args);
148
- }
149
- url() {
150
- return this.mainFrame().url();
151
- }
152
- goto(url, options = {}) {
153
- return __classPrivateFieldGet(this, _Page_frameManager, "f").mainFrame().goto(url, options);
154
- }
155
- async bringToFront() {
156
- await __classPrivateFieldGet(this, _Page_client, "f").send('Page.bringToFront');
157
- }
158
- evaluate(pageFunction, ...args) {
159
- return __classPrivateFieldGet(this, _Page_frameManager, "f").mainFrame().evaluate(pageFunction, ...args);
160
- }
161
- async evaluateOnNewDocument(pageFunction, ...args) {
162
- const source = (0, util_1.evaluationString)(pageFunction, ...args);
163
- await __classPrivateFieldGet(this, _Page_client, "f").send('Page.addScriptToEvaluateOnNewDocument', {
164
- source,
165
- });
166
- }
167
- async close(options = { runBeforeUnload: undefined }) {
168
- const connection = __classPrivateFieldGet(this, _Page_client, "f").connection();
169
- (0, assert_1.assert)(connection, 'Protocol error: Connection closed. Most likely the page has been closed.');
170
- const runBeforeUnload = Boolean(options.runBeforeUnload);
171
- if (runBeforeUnload) {
172
- await __classPrivateFieldGet(this, _Page_client, "f").send('Page.close');
173
- }
174
- else {
175
- await connection.send('Target.closeTarget', {
176
- targetId: __classPrivateFieldGet(this, _Page_target, "f")._targetId,
177
- });
178
- await __classPrivateFieldGet(this, _Page_target, "f")._isClosedPromise;
179
- }
180
- }
181
- isClosed() {
182
- return __classPrivateFieldGet(this, _Page_closed, "f");
183
- }
184
- waitForFunction(browser, pageFunction, ...args) {
185
- return this.mainFrame().waitForFunction(browser, pageFunction, ...args);
186
- }
187
- }
188
- exports.Page = Page;
189
- _Page_closed = new WeakMap(), _Page_client = new WeakMap(), _Page_target = new WeakMap(), _Page_timeoutSettings = new WeakMap(), _Page_frameManager = new WeakMap(), _Page_pageBindings = new WeakMap(), _Page_instances = new WeakSet(), _Page_initialize = async function _Page_initialize() {
190
- await Promise.all([
191
- __classPrivateFieldGet(this, _Page_frameManager, "f").initialize(),
192
- __classPrivateFieldGet(this, _Page_client, "f").send('Target.setAutoAttach', {
193
- autoAttach: true,
194
- waitForDebuggerOnStart: false,
195
- flatten: true,
196
- }),
197
- __classPrivateFieldGet(this, _Page_client, "f").send('Performance.enable'),
198
- __classPrivateFieldGet(this, _Page_client, "f").send('Log.enable'),
199
- ]);
200
- }, _Page_onTargetCrashed = function _Page_onTargetCrashed() {
201
- this.emit('error', new Error('Page crashed!'));
202
- }, _Page_onLogEntryAdded = function _Page_onLogEntryAdded(event) {
203
- const { level, text, args, source, url, lineNumber } = event.entry;
204
- if (args) {
205
- args.map((arg) => {
206
- return (0, util_1.releaseObject)(__classPrivateFieldGet(this, _Page_client, "f"), arg);
207
- });
208
- }
209
- if (source !== 'worker') {
210
- this.emit("console" /* PageEmittedEvents.Console */, new ConsoleMessage_1.ConsoleMessage(level, text, [], [{ url, lineNumber }]));
211
- }
212
- }, _Page_onConsoleAPI = function _Page_onConsoleAPI(event) {
213
- if (event.executionContextId === 0) {
214
- return;
215
- }
216
- const context = __classPrivateFieldGet(this, _Page_frameManager, "f").executionContextById(event.executionContextId, __classPrivateFieldGet(this, _Page_client, "f"));
217
- const values = event.args.map((arg) => {
218
- return (0, JSHandle_1._createJSHandle)(context, arg);
219
- });
220
- __classPrivateFieldGet(this, _Page_instances, "m", _Page_addConsoleMessage).call(this, event.type, values, event.stackTrace);
221
- }, _Page_onBindingCalled = async function _Page_onBindingCalled(event) {
222
- let payload;
223
- try {
224
- payload = JSON.parse(event.payload);
225
- }
226
- catch (_a) {
227
- // The binding was either called by something in the page or it was
228
- // called before our wrapper was initialized.
229
- return;
230
- }
231
- const { type, name, seq, args } = payload;
232
- if (type !== 'exposedFun' || !__classPrivateFieldGet(this, _Page_pageBindings, "f").has(name)) {
233
- return;
234
- }
235
- let expression = null;
236
- try {
237
- const pageBinding = __classPrivateFieldGet(this, _Page_pageBindings, "f").get(name);
238
- (0, assert_1.assert)(pageBinding);
239
- const result = await pageBinding(...args);
240
- expression = (0, util_1.pageBindingDeliverResultString)(name, seq, result);
241
- }
242
- catch (_error) {
243
- if ((0, util_1.isErrorLike)(_error)) {
244
- expression = (0, util_1.pageBindingDeliverErrorString)(name, seq, _error.message, _error.stack);
245
- }
246
- else {
247
- expression = (0, util_1.pageBindingDeliverErrorValueString)(name, seq, _error);
248
- }
249
- }
250
- __classPrivateFieldGet(this, _Page_client, "f").send('Runtime.evaluate', {
251
- expression,
252
- contextId: event.executionContextId,
253
- });
254
- }, _Page_addConsoleMessage = function _Page_addConsoleMessage(eventType, args, stackTrace) {
255
- if (!this.listenerCount("console" /* PageEmittedEvents.Console */)) {
256
- args.forEach((arg) => {
257
- return arg.dispose();
258
- });
259
- return;
260
- }
261
- const textTokens = [];
262
- for (const arg of args) {
263
- const remoteObject = arg._remoteObject;
264
- if (remoteObject.objectId) {
265
- textTokens.push(arg.toString());
266
- }
267
- else {
268
- textTokens.push((0, util_1.valueFromRemoteObject)(remoteObject));
269
- }
270
- }
271
- const stackTraceLocations = [];
272
- if (stackTrace) {
273
- for (const callFrame of stackTrace.callFrames) {
274
- stackTraceLocations.push({
275
- url: callFrame.url,
276
- lineNumber: callFrame.lineNumber,
277
- columnNumber: callFrame.columnNumber,
278
- });
279
- }
280
- }
281
- const message = new ConsoleMessage_1.ConsoleMessage(eventType, textTokens.join(' '), args, stackTraceLocations);
282
- this.emit("console" /* PageEmittedEvents.Console */, message);
283
- };
@@ -1,2 +0,0 @@
1
- declare let puppeteerDirname: string;
2
- export { puppeteerDirname };
@@ -1,17 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.puppeteerDirname = void 0;
4
- const path_1 = require("path");
5
- let puppeteerDirname;
6
- exports.puppeteerDirname = puppeteerDirname;
7
- try {
8
- // In some environments, like esbuild, this will throw an error.
9
- // We suppress the error since the bundled binary is not expected
10
- // to be used or installed in this case and, therefore, the
11
- // root directory does not have to be known.
12
- exports.puppeteerDirname = puppeteerDirname = (0, path_1.dirname)(require.resolve('./compat'));
13
- }
14
- catch (error) {
15
- // Fallback to __dirname.
16
- exports.puppeteerDirname = puppeteerDirname = __dirname;
17
- }
@@ -1,16 +0,0 @@
1
- /**
2
- * Copyright 2020 Google Inc. All rights reserved.
3
- *
4
- * Licensed under the Apache License, Version 2.0 (the "License");
5
- * you may not use this file except in compliance with the License.
6
- * You may obtain a copy of the License at
7
- *
8
- * http://www.apache.org/licenses/LICENSE-2.0
9
- *
10
- * Unless required by applicable law or agreed to in writing, software
11
- * distributed under the License is distributed on an "AS IS" BASIS,
12
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
- * See the License for the specific language governing permissions and
14
- * limitations under the License.
15
- */
16
- export declare const isNode: boolean;
@@ -1,19 +0,0 @@
1
- "use strict";
2
- /**
3
- * Copyright 2020 Google Inc. All rights reserved.
4
- *
5
- * Licensed under the Apache License, Version 2.0 (the "License");
6
- * you may not use this file except in compliance with the License.
7
- * You may obtain a copy of the License at
8
- *
9
- * http://www.apache.org/licenses/LICENSE-2.0
10
- *
11
- * Unless required by applicable law or agreed to in writing, software
12
- * distributed under the License is distributed on an "AS IS" BASIS,
13
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
- * See the License for the specific language governing permissions and
15
- * limitations under the License.
16
- */
17
- Object.defineProperty(exports, "__esModule", { value: true });
18
- exports.isNode = void 0;
19
- exports.isNode = Boolean(typeof process !== 'undefined' && process.version);
@@ -1,287 +0,0 @@
1
- /// <reference types="node" />
2
- /// <reference types="node" />
3
- /// <reference types="node" />
4
- /// <reference types="node" />
5
- /// <reference types="node" />
6
- /// <reference types="node" />
7
- /// <reference types="node" />
8
- /// <reference types="node" />
9
- import { EventEmitter } from 'events';
10
- import type { Agent, ClientRequest, ClientRequestArgs, IncomingMessage, OutgoingHttpHeaders, Server as HTTPServer } from 'http';
11
- import type { Server as HTTPSServer } from 'https';
12
- import type { Duplex, DuplexOptions } from 'stream';
13
- import type { SecureContextOptions } from 'tls';
14
- import type { URL } from 'url';
15
- import type { ZlibOptions } from 'zlib';
16
- declare class WebSocket extends EventEmitter {
17
- /** The connection is not yet open. */
18
- static readonly CONNECTING: 0;
19
- /** The connection is open and ready to communicate. */
20
- static readonly OPEN: 1;
21
- /** The connection is in the process of closing. */
22
- static readonly CLOSING: 2;
23
- /** The connection is closed. */
24
- static readonly CLOSED: 3;
25
- binaryType: 'nodebuffer' | 'arraybuffer' | 'fragments';
26
- readonly bufferedAmount: number;
27
- readonly extensions: string;
28
- /** Indicates whether the websocket is paused */
29
- readonly isPaused: boolean;
30
- readonly protocol: string;
31
- /** The current state of the connection */
32
- readonly readyState: typeof WebSocket.CONNECTING | typeof WebSocket.OPEN | typeof WebSocket.CLOSING | typeof WebSocket.CLOSED;
33
- readonly url: string;
34
- /** The connection is not yet open. */
35
- readonly CONNECTING: 0;
36
- /** The connection is open and ready to communicate. */
37
- readonly OPEN: 1;
38
- /** The connection is in the process of closing. */
39
- readonly CLOSING: 2;
40
- /** The connection is closed. */
41
- readonly CLOSED: 3;
42
- onopen: ((event: WebSocket.Event) => void) | null;
43
- onerror: ((event: WebSocket.ErrorEvent) => void) | null;
44
- onclose: ((event: WebSocket.CloseEvent) => void) | null;
45
- onmessage: ((event: WebSocket.MessageEvent) => void) | null;
46
- constructor(address: null);
47
- constructor(address: string | URL, options?: WebSocket.ClientOptions | ClientRequestArgs);
48
- constructor(address: string | URL, protocols?: string | string[], options?: WebSocket.ClientOptions | ClientRequestArgs);
49
- close(code?: number, data?: string | Buffer): void;
50
- ping(data?: any, mask?: boolean, cb?: (err: Error) => void): void;
51
- pong(data?: any, mask?: boolean, cb?: (err: Error) => void): void;
52
- send(data: any, cb?: (err?: Error) => void): void;
53
- send(data: any, options: {
54
- mask?: boolean | undefined;
55
- binary?: boolean | undefined;
56
- compress?: boolean | undefined;
57
- fin?: boolean | undefined;
58
- }, cb?: (err?: Error) => void): void;
59
- terminate(): void;
60
- /**
61
- * Pause the websocket causing it to stop emitting events. Some events can still be
62
- * emitted after this is called, until all buffered data is consumed. This method
63
- * is a noop if the ready state is `CONNECTING` or `CLOSED`.
64
- */
65
- pause(): void;
66
- /**
67
- * Make a paused socket resume emitting events. This method is a noop if the ready
68
- * state is `CONNECTING` or `CLOSED`.
69
- */
70
- resume(): void;
71
- addEventListener(method: 'message', cb: (event: WebSocket.MessageEvent) => void, options?: WebSocket.EventListenerOptions): void;
72
- addEventListener(method: 'close', cb: (event: WebSocket.CloseEvent) => void, options?: WebSocket.EventListenerOptions): void;
73
- addEventListener(method: 'error', cb: (event: WebSocket.ErrorEvent) => void, options?: WebSocket.EventListenerOptions): void;
74
- addEventListener(method: 'open', cb: (event: WebSocket.Event) => void, options?: WebSocket.EventListenerOptions): void;
75
- removeEventListener(method: 'message', cb: (event: WebSocket.MessageEvent) => void): void;
76
- removeEventListener(method: 'close', cb: (event: WebSocket.CloseEvent) => void): void;
77
- removeEventListener(method: 'error', cb: (event: WebSocket.ErrorEvent) => void): void;
78
- removeEventListener(method: 'open', cb: (event: WebSocket.Event) => void): void;
79
- on(event: 'close', listener: (this: WebSocket, code: number, reason: Buffer) => void): this;
80
- on(event: 'error', listener: (this: WebSocket, err: Error) => void): this;
81
- on(event: 'upgrade', listener: (this: WebSocket, request: IncomingMessage) => void): this;
82
- on(event: 'message', listener: (this: WebSocket, data: WebSocket.RawData, isBinary: boolean) => void): this;
83
- on(event: 'open', listener: (this: WebSocket) => void): this;
84
- on(event: 'ping' | 'pong', listener: (this: WebSocket, data: Buffer) => void): this;
85
- on(event: 'unexpected-response', listener: (this: WebSocket, request: ClientRequest, response: IncomingMessage) => void): this;
86
- on(event: string | symbol, listener: (this: WebSocket, ...args: any[]) => void): this;
87
- once(event: 'close', listener: (this: WebSocket, code: number, reason: Buffer) => void): this;
88
- once(event: 'error', listener: (this: WebSocket, err: Error) => void): this;
89
- once(event: 'upgrade', listener: (this: WebSocket, request: IncomingMessage) => void): this;
90
- once(event: 'message', listener: (this: WebSocket, data: WebSocket.RawData, isBinary: boolean) => void): this;
91
- once(event: 'open', listener: (this: WebSocket) => void): this;
92
- once(event: 'ping' | 'pong', listener: (this: WebSocket, data: Buffer) => void): this;
93
- once(event: 'unexpected-response', listener: (this: WebSocket, request: ClientRequest, response: IncomingMessage) => void): this;
94
- once(event: string | symbol, listener: (this: WebSocket, ...args: any[]) => void): this;
95
- off(event: 'close', listener: (this: WebSocket, code: number, reason: Buffer) => void): this;
96
- off(event: 'error', listener: (this: WebSocket, err: Error) => void): this;
97
- off(event: 'upgrade', listener: (this: WebSocket, request: IncomingMessage) => void): this;
98
- off(event: 'message', listener: (this: WebSocket, data: WebSocket.RawData, isBinary: boolean) => void): this;
99
- off(event: 'open', listener: (this: WebSocket) => void): this;
100
- off(event: 'ping' | 'pong', listener: (this: WebSocket, data: Buffer) => void): this;
101
- off(event: 'unexpected-response', listener: (this: WebSocket, request: ClientRequest, response: IncomingMessage) => void): this;
102
- off(event: string | symbol, listener: (this: WebSocket, ...args: any[]) => void): this;
103
- addListener(event: 'close', listener: (code: number, reason: Buffer) => void): this;
104
- addListener(event: 'error', listener: (err: Error) => void): this;
105
- addListener(event: 'upgrade', listener: (request: IncomingMessage) => void): this;
106
- addListener(event: 'message', listener: (data: WebSocket.RawData, isBinary: boolean) => void): this;
107
- addListener(event: 'open', listener: () => void): this;
108
- addListener(event: 'ping' | 'pong', listener: (data: Buffer) => void): this;
109
- addListener(event: 'unexpected-response', listener: (request: ClientRequest, response: IncomingMessage) => void): this;
110
- addListener(event: string | symbol, listener: (...args: any[]) => void): this;
111
- removeListener(event: 'close', listener: (code: number, reason: Buffer) => void): this;
112
- removeListener(event: 'error', listener: (err: Error) => void): this;
113
- removeListener(event: 'upgrade', listener: (request: IncomingMessage) => void): this;
114
- removeListener(event: 'message', listener: (data: WebSocket.RawData, isBinary: boolean) => void): this;
115
- removeListener(event: 'open', listener: () => void): this;
116
- removeListener(event: 'ping' | 'pong', listener: (data: Buffer) => void): this;
117
- removeListener(event: 'unexpected-response', listener: (request: ClientRequest, response: IncomingMessage) => void): this;
118
- removeListener(event: string | symbol, listener: (...args: any[]) => void): this;
119
- }
120
- declare const WebSocketAlias: typeof WebSocket;
121
- declare type WebSocketAlias = WebSocket;
122
- declare namespace WebSocket {
123
- /**
124
- * Data represents the raw message payload received over the WebSocket.
125
- */
126
- type RawData = Buffer | ArrayBuffer | Buffer[];
127
- /**
128
- * Data represents the message payload received over the WebSocket.
129
- */
130
- type Data = string | Buffer | ArrayBuffer | Buffer[];
131
- /**
132
- * CertMeta represents the accepted types for certificate & key data.
133
- */
134
- type CertMeta = string | string[] | Buffer | Buffer[];
135
- /**
136
- * VerifyClientCallbackSync is a synchronous callback used to inspect the
137
- * incoming message. The return value (boolean) of the function determines
138
- * whether or not to accept the handshake.
139
- */
140
- type VerifyClientCallbackSync = (info: {
141
- origin: string;
142
- secure: boolean;
143
- req: IncomingMessage;
144
- }) => boolean;
145
- /**
146
- * VerifyClientCallbackAsync is an asynchronous callback used to inspect the
147
- * incoming message. The return value (boolean) of the function determines
148
- * whether or not to accept the handshake.
149
- */
150
- type VerifyClientCallbackAsync = (info: {
151
- origin: string;
152
- secure: boolean;
153
- req: IncomingMessage;
154
- }, callback: (res: boolean, code?: number, message?: string, headers?: OutgoingHttpHeaders) => void) => void;
155
- interface ClientOptions extends SecureContextOptions {
156
- protocol?: string | undefined;
157
- followRedirects?: boolean | undefined;
158
- generateMask?(mask: Buffer): void;
159
- handshakeTimeout?: number | undefined;
160
- maxRedirects?: number | undefined;
161
- perMessageDeflate?: boolean | PerMessageDeflateOptions | undefined;
162
- localAddress?: string | undefined;
163
- protocolVersion?: number | undefined;
164
- headers?: {
165
- [key: string]: string;
166
- } | undefined;
167
- origin?: string | undefined;
168
- agent?: Agent | undefined;
169
- host?: string | undefined;
170
- family?: number | undefined;
171
- checkServerIdentity?(servername: string, cert: CertMeta): boolean;
172
- rejectUnauthorized?: boolean | undefined;
173
- maxPayload?: number | undefined;
174
- skipUTF8Validation?: boolean | undefined;
175
- }
176
- interface PerMessageDeflateOptions {
177
- serverNoContextTakeover?: boolean | undefined;
178
- clientNoContextTakeover?: boolean | undefined;
179
- serverMaxWindowBits?: number | undefined;
180
- clientMaxWindowBits?: number | undefined;
181
- zlibDeflateOptions?: {
182
- flush?: number | undefined;
183
- finishFlush?: number | undefined;
184
- chunkSize?: number | undefined;
185
- windowBits?: number | undefined;
186
- level?: number | undefined;
187
- memLevel?: number | undefined;
188
- strategy?: number | undefined;
189
- dictionary?: Buffer | Buffer[] | DataView | undefined;
190
- info?: boolean | undefined;
191
- } | undefined;
192
- zlibInflateOptions?: ZlibOptions | undefined;
193
- threshold?: number | undefined;
194
- concurrencyLimit?: number | undefined;
195
- }
196
- interface Event {
197
- type: string;
198
- target: WebSocket;
199
- }
200
- interface ErrorEvent {
201
- error: any;
202
- message: string;
203
- type: string;
204
- target: WebSocket;
205
- }
206
- interface CloseEvent {
207
- wasClean: boolean;
208
- code: number;
209
- reason: string;
210
- type: string;
211
- target: WebSocket;
212
- }
213
- interface MessageEvent {
214
- data: Data;
215
- type: string;
216
- target: WebSocket;
217
- }
218
- interface EventListenerOptions {
219
- once?: boolean | undefined;
220
- }
221
- interface ServerOptions {
222
- host?: string | undefined;
223
- port?: number | undefined;
224
- backlog?: number | undefined;
225
- server?: HTTPServer | HTTPSServer | undefined;
226
- verifyClient?: VerifyClientCallbackAsync | VerifyClientCallbackSync | undefined;
227
- handleProtocols?: (protocols: Set<string>, request: IncomingMessage) => string | false;
228
- path?: string | undefined;
229
- noServer?: boolean | undefined;
230
- clientTracking?: boolean | undefined;
231
- perMessageDeflate?: boolean | PerMessageDeflateOptions | undefined;
232
- maxPayload?: number | undefined;
233
- skipUTF8Validation?: boolean | undefined;
234
- WebSocket?: typeof WebSocket.WebSocket | undefined;
235
- }
236
- interface AddressInfo {
237
- address: string;
238
- family: string;
239
- port: number;
240
- }
241
- class Server<T extends WebSocket = WebSocket> extends EventEmitter {
242
- options: ServerOptions;
243
- path: string;
244
- clients: Set<T>;
245
- constructor(options?: ServerOptions, callback?: () => void);
246
- address(): AddressInfo | string;
247
- close(cb?: (err?: Error) => void): void;
248
- handleUpgrade(request: IncomingMessage, socket: Duplex, upgradeHead: Buffer, callback: (client: T, request: IncomingMessage) => void): void;
249
- shouldHandle(request: IncomingMessage): boolean | Promise<boolean>;
250
- on(event: 'connection', cb: (this: Server<T>, socket: T, request: IncomingMessage) => void): this;
251
- on(event: 'error', cb: (this: Server<T>, error: Error) => void): this;
252
- on(event: 'headers', cb: (this: Server<T>, headers: string[], request: IncomingMessage) => void): this;
253
- on(event: 'close' | 'listening', cb: (this: Server<T>) => void): this;
254
- on(event: string | symbol, listener: (this: Server<T>, ...args: any[]) => void): this;
255
- once(event: 'connection', cb: (this: Server<T>, socket: T, request: IncomingMessage) => void): this;
256
- once(event: 'error', cb: (this: Server<T>, error: Error) => void): this;
257
- once(event: 'headers', cb: (this: Server<T>, headers: string[], request: IncomingMessage) => void): this;
258
- once(event: 'close' | 'listening', cb: (this: Server<T>) => void): this;
259
- once(event: string | symbol, listener: (this: Server<T>, ...args: any[]) => void): this;
260
- off(event: 'connection', cb: (this: Server<T>, socket: T, request: IncomingMessage) => void): this;
261
- off(event: 'error', cb: (this: Server<T>, error: Error) => void): this;
262
- off(event: 'headers', cb: (this: Server<T>, headers: string[], request: IncomingMessage) => void): this;
263
- off(event: 'close' | 'listening', cb: (this: Server<T>) => void): this;
264
- off(event: string | symbol, listener: (this: Server<T>, ...args: any[]) => void): this;
265
- addListener(event: 'connection', cb: (client: T, request: IncomingMessage) => void): this;
266
- addListener(event: 'error', cb: (err: Error) => void): this;
267
- addListener(event: 'headers', cb: (headers: string[], request: IncomingMessage) => void): this;
268
- addListener(event: 'close' | 'listening', cb: () => void): this;
269
- addListener(event: string | symbol, listener: (...args: any[]) => void): this;
270
- removeListener(event: 'connection', cb: (client: T) => void): this;
271
- removeListener(event: 'error', cb: (err: Error) => void): this;
272
- removeListener(event: 'headers', cb: (headers: string[], request: IncomingMessage) => void): this;
273
- removeListener(event: 'close' | 'listening', cb: () => void): this;
274
- removeListener(event: string | symbol, listener: (...args: any[]) => void): this;
275
- }
276
- const WebSocketServer: typeof Server;
277
- interface WebSocketServer extends Server {
278
- }
279
- const WebSocket: typeof WebSocketAlias;
280
- interface WebSocket extends WebSocketAlias {
281
- }
282
- function createWebSocketStream(websocket: WebSocket, options?: DuplexOptions): Duplex;
283
- }
284
- declare module 'ws' {
285
- export = WebSocket;
286
- }
287
- export {};
@@ -1,21 +0,0 @@
1
- "use strict";
2
- /* eslint-disable @typescript-eslint/no-shadow */
3
- /* eslint-disable @typescript-eslint/no-empty-interface */
4
- /* eslint-disable no-redeclare */
5
- /* eslint-disable @typescript-eslint/no-explicit-any */
6
- /* eslint-disable lines-between-class-members */
7
- /* eslint-disable no-dupe-class-members */
8
- // Type definitions for ws 8.5
9
- // Project: https://github.com/websockets/ws
10
- // Definitions by: Paul Loyd <https://github.com/loyd>
11
- // Margus Lamp <https://github.com/mlamp>
12
- // Philippe D'Alva <https://github.com/TitaneBoy>
13
- // reduckted <https://github.com/reduckted>
14
- // teidesu <https://github.com/teidesu>
15
- // Bartosz Wojtkowiak <https://github.com/wojtkowiak>
16
- // Kyle Hensel <https://github.com/k-yle>
17
- // Samuel Skeen <https://github.com/cwadrupldijjit>
18
- // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
19
- Object.defineProperty(exports, "__esModule", { value: true });
20
- /// <reference types="node" />
21
- const events_1 = require("events");
package/dist/cancel.d.ts DELETED
@@ -1,7 +0,0 @@
1
- declare type Callback = () => void;
2
- export declare type CancelSignal = (callback: Callback) => void;
3
- export declare const makeCancelSignal: () => {
4
- cancelSignal: CancelSignal;
5
- cancel: () => void;
6
- };
7
- export {};