@remotion/renderer 3.0.27 → 3.0.28
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/assets/calculate-asset-positions.d.ts.map +1 -0
- package/dist/assets/calculate-asset-positions.js.map +1 -0
- package/dist/assets/calculate-atempo.d.ts.map +1 -0
- package/dist/assets/calculate-atempo.js.map +1 -0
- package/dist/assets/convert-assets-to-file-urls.d.ts.map +1 -0
- package/dist/assets/convert-assets-to-file-urls.js.map +1 -0
- package/dist/assets/download-and-map-assets-to-file.d.ts +0 -11
- package/dist/assets/download-and-map-assets-to-file.d.ts.map +1 -0
- package/dist/assets/download-and-map-assets-to-file.js +3 -5
- package/dist/assets/download-and-map-assets-to-file.js.map +1 -0
- package/dist/assets/download-file.d.ts.map +1 -0
- package/dist/assets/download-file.js.map +1 -0
- package/dist/assets/ffmpeg-volume-expression.d.ts.map +1 -0
- package/dist/assets/ffmpeg-volume-expression.js.map +1 -0
- package/dist/assets/flatten-volume-array.d.ts.map +1 -0
- package/dist/assets/flatten-volume-array.js.map +1 -0
- package/dist/assets/get-audio-channels.d.ts.map +1 -0
- package/dist/assets/get-audio-channels.js.map +1 -0
- package/dist/assets/read-file.d.ts.map +1 -0
- package/dist/assets/read-file.js.map +1 -0
- package/dist/assets/round-volume-to-avoid-stack-overflow.d.ts.map +1 -0
- package/dist/assets/round-volume-to-avoid-stack-overflow.js.map +1 -0
- package/dist/assets/sanitize-filename.d.ts.map +1 -0
- package/dist/assets/sanitize-filename.js.map +1 -0
- package/dist/assets/sanitize-filepath.d.ts.map +1 -0
- package/dist/assets/sanitize-filepath.js.map +1 -0
- package/dist/assets/truncate-utf8-bytes.d.ts.map +1 -0
- package/dist/assets/truncate-utf8-bytes.js.map +1 -0
- package/dist/assets/types.d.ts.map +1 -0
- package/dist/assets/types.js.map +1 -0
- package/dist/browser/Accessibility.d.ts +175 -0
- package/dist/browser/Accessibility.js +423 -0
- package/dist/browser/AriaQueryHandler.d.ts +20 -0
- package/dist/browser/AriaQueryHandler.js +108 -0
- package/dist/browser/Connection.d.ts +5 -5
- package/dist/browser/Coverage.d.ts +180 -0
- package/dist/browser/Coverage.js +371 -0
- package/dist/browser/Debug.d.ts +19 -0
- package/dist/browser/Debug.js +42 -0
- package/dist/browser/DeviceDescriptors.d.ts +40 -0
- package/dist/browser/DeviceDescriptors.js +1407 -0
- package/dist/browser/ExecutionContext.d.ts +2 -2
- package/dist/browser/FileChooser.d.ts +56 -0
- package/dist/browser/FileChooser.js +86 -0
- package/dist/browser/FrameManager.d.ts +2 -2
- package/dist/browser/HTTPRequest.d.ts +2 -2
- package/dist/browser/HTTPResponse.d.ts +2 -2
- package/dist/browser/HTTPResponse.js +15 -0
- package/dist/browser/Input.d.ts +355 -0
- package/dist/browser/Input.js +592 -0
- package/dist/browser/JSHandle.d.ts +4 -4
- package/dist/browser/LaunchOptions.d.ts +0 -1
- package/dist/browser/Launcher.js +1 -1
- package/dist/browser/NetworkConditions.d.ts +26 -0
- package/dist/browser/NetworkConditions.js +33 -0
- package/dist/browser/NetworkEventManager.d.ts +9 -9
- package/dist/browser/NetworkManager.d.ts +2 -2
- package/dist/browser/NetworkManager.js +1 -14
- package/dist/browser/NodeWebSocketTransport.d.ts +2 -2
- package/dist/browser/NodeWebSocketTransport.js +2 -5
- package/dist/browser/PDFOptions.d.ts +165 -0
- package/dist/browser/PDFOptions.js +34 -0
- package/dist/browser/PipeTransport.d.ts +10 -0
- package/dist/browser/PipeTransport.js +86 -0
- package/dist/browser/Puppeteer.d.ts +35 -0
- package/dist/browser/Puppeteer.js +17 -0
- package/dist/browser/QueryHandler.d.ts +64 -0
- package/dist/browser/QueryHandler.js +183 -0
- package/dist/browser/SecurityDetails.d.ts +55 -0
- package/dist/browser/SecurityDetails.js +95 -0
- package/dist/browser/Target.d.ts +4 -4
- package/dist/browser/Tracing.d.ts +45 -0
- package/dist/browser/Tracing.js +136 -0
- package/dist/browser/USKeyboardLayout.d.ts +39 -0
- package/dist/browser/USKeyboardLayout.js +406 -0
- package/dist/browser/WebWorker.d.ts +96 -0
- package/dist/browser/WebWorker.js +122 -0
- package/dist/browser/devtools-commands.d.ts +270 -0
- package/dist/{faststart/options.js → browser/devtools-commands.js} +0 -0
- package/dist/browser/devtools-types.d.ts +1122 -0
- package/dist/browser/devtools-types.js +2 -0
- package/dist/browser/dialog.d.ts +70 -0
- package/dist/browser/dialog.js +114 -0
- package/dist/browser/fetch.d.ts +16 -0
- package/dist/browser/fetch.js +46 -0
- package/dist/browser/find-up.d.ts +4 -0
- package/dist/browser/find-up.js +85 -0
- package/dist/browser/{Page.d.ts → page.d.ts} +0 -0
- package/dist/browser/{Page.js → page.js} +0 -0
- package/dist/browser/pkg-dir.d.ts +3 -0
- package/dist/browser/pkg-dir.js +13 -0
- package/dist/browser/util.d.ts +4 -4
- package/dist/browser-log.d.ts.map +1 -0
- package/dist/browser-log.js.map +1 -0
- package/dist/calculate-ffmpeg-filters.d.ts.map +1 -0
- package/dist/calculate-ffmpeg-filters.js.map +1 -0
- package/dist/can-use-parallel-encoding.d.ts.map +1 -0
- package/dist/can-use-parallel-encoding.js.map +1 -0
- package/dist/chunk.d.ts.map +1 -0
- package/dist/chunk.js.map +1 -0
- package/dist/combine-videos.d.ts.map +1 -0
- package/dist/combine-videos.js.map +1 -0
- package/dist/convert-to-pcm.d.ts.map +1 -0
- package/dist/convert-to-pcm.js.map +1 -0
- package/dist/create-ffmpeg-complex-filter.d.ts.map +1 -0
- package/dist/create-ffmpeg-complex-filter.js.map +1 -0
- package/dist/create-ffmpeg-merge-filter.d.ts.map +1 -0
- package/dist/create-ffmpeg-merge-filter.js.map +1 -0
- package/dist/create-silent-audio.d.ts.map +1 -0
- package/dist/create-silent-audio.js.map +1 -0
- package/dist/cycle-browser-tabs.d.ts.map +1 -0
- package/dist/cycle-browser-tabs.js.map +1 -0
- package/dist/delay-render-embedded-stack.d.ts.map +1 -0
- package/dist/delay-render-embedded-stack.js.map +1 -0
- package/dist/delete-directory.d.ts.map +1 -0
- package/dist/delete-directory.js.map +1 -0
- package/dist/ensure-frames-in-order.d.ts.map +1 -0
- package/dist/ensure-frames-in-order.js.map +1 -0
- package/dist/ensure-output-directory.d.ts.map +1 -0
- package/dist/ensure-output-directory.js.map +1 -0
- package/dist/error-handling/handle-javascript-exception.d.ts.map +1 -0
- package/dist/error-handling/handle-javascript-exception.js +1 -2
- package/dist/error-handling/handle-javascript-exception.js.map +1 -0
- package/dist/error-handling/symbolicate-error.d.ts.map +1 -0
- package/dist/error-handling/symbolicate-error.js.map +1 -0
- package/dist/error-handling/symbolicateable-error.d.ts.map +1 -0
- package/dist/error-handling/symbolicateable-error.js.map +1 -0
- package/dist/extract-frame-from-video.d.ts +0 -2
- package/dist/extract-frame-from-video.js +4 -5
- package/dist/ffmpeg-filter-file.d.ts.map +1 -0
- package/dist/ffmpeg-filter-file.js.map +1 -0
- package/dist/ffmpeg-flags.d.ts.map +1 -0
- package/dist/ffmpeg-flags.js.map +1 -0
- package/dist/get-audio-codec-name.d.ts.map +1 -0
- package/dist/get-audio-codec-name.js.map +1 -0
- package/dist/get-browser-instance.d.ts.map +1 -0
- package/dist/get-browser-instance.js.map +1 -0
- package/dist/get-codec-name.d.ts.map +1 -0
- package/dist/get-codec-name.js.map +1 -0
- package/dist/get-compositions.d.ts.map +1 -0
- package/dist/get-compositions.js.map +1 -0
- package/dist/get-concurrency.d.ts.map +1 -0
- package/dist/get-concurrency.js.map +1 -0
- package/dist/get-duration-from-frame-range.d.ts.map +1 -0
- package/dist/get-duration-from-frame-range.js.map +1 -0
- package/dist/get-extension-from-codec.d.ts.map +1 -0
- package/dist/get-extension-from-codec.js.map +1 -0
- package/dist/get-format-for-codec.d.ts +2 -0
- package/dist/get-format-for-codec.js +34 -0
- package/dist/get-frame-to-render.d.ts.map +1 -0
- package/dist/get-frame-to-render.js.map +1 -0
- package/dist/get-local-browser-executable.d.ts.map +1 -0
- package/dist/get-local-browser-executable.js.map +1 -0
- package/dist/get-port.d.ts.map +1 -0
- package/dist/get-port.js.map +1 -0
- package/dist/get-prores-profile-name.d.ts.map +1 -0
- package/dist/get-prores-profile-name.js.map +1 -0
- package/dist/image-format.d.ts.map +1 -0
- package/dist/image-format.js.map +1 -0
- package/dist/index.d.ts +3 -2
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +3 -2
- package/dist/index.js.map +1 -0
- package/dist/is-serve-url.d.ts.map +1 -0
- package/dist/is-serve-url.js.map +1 -0
- package/dist/last-frame-from-video-cache.d.ts +0 -1
- package/dist/legacy-webpack-config.d.ts.map +1 -0
- package/dist/legacy-webpack-config.js.map +1 -0
- package/dist/make-assets-download-dir.d.ts.map +1 -0
- package/dist/make-assets-download-dir.js.map +1 -0
- package/dist/merge-audio-track.d.ts.map +1 -0
- package/dist/merge-audio-track.js.map +1 -0
- package/dist/mime-db.d.ts +6 -0
- package/dist/mime-db.js +8636 -0
- package/dist/mime-types.d.ts +2 -0
- package/dist/mime-types.js +89 -0
- package/dist/normalize-serve-url.d.ts.map +1 -0
- package/dist/normalize-serve-url.js.map +1 -0
- package/dist/open-browser.d.ts.map +1 -0
- package/dist/open-browser.js.map +1 -0
- package/dist/p-limit.d.ts.map +1 -0
- package/dist/p-limit.js.map +1 -0
- package/dist/parse-browser-error-stack.d.ts.map +1 -0
- package/dist/parse-browser-error-stack.js.map +1 -0
- package/dist/parse-ffmpeg-progress.d.ts.map +1 -0
- package/dist/parse-ffmpeg-progress.js.map +1 -0
- package/dist/pool.d.ts.map +1 -0
- package/dist/pool.js.map +1 -0
- package/dist/prepare-server.d.ts.map +1 -0
- package/dist/prepare-server.js.map +1 -0
- package/dist/preprocess-audio-track.d.ts.map +1 -0
- package/dist/preprocess-audio-track.js.map +1 -0
- package/dist/prespawn-ffmpeg.d.ts.map +1 -0
- package/dist/prespawn-ffmpeg.js.map +1 -0
- package/dist/provide-screenshot.d.ts +0 -1
- package/dist/provide-screenshot.d.ts.map +1 -0
- package/dist/provide-screenshot.js.map +1 -0
- package/dist/puppeteer-evaluate.d.ts.map +1 -0
- package/dist/puppeteer-evaluate.js.map +1 -0
- package/dist/puppeteer-screenshot.d.ts +0 -1
- package/dist/puppeteer-screenshot.d.ts.map +1 -0
- package/dist/puppeteer-screenshot.js.map +1 -0
- package/dist/render-frames.d.ts.map +1 -0
- package/dist/render-frames.js.map +1 -0
- package/dist/render-media.d.ts +0 -1
- package/dist/render-media.d.ts.map +1 -0
- package/dist/render-media.js.map +1 -0
- package/dist/render-still.d.ts.map +1 -0
- package/dist/render-still.js.map +1 -0
- package/dist/resolve-asset-src.d.ts.map +1 -0
- package/dist/resolve-asset-src.js.map +1 -0
- package/dist/sample-rate.d.ts.map +1 -0
- package/dist/sample-rate.js.map +1 -0
- package/dist/screenshot-dom-element.d.ts +0 -1
- package/dist/screenshot-dom-element.d.ts.map +1 -0
- package/dist/screenshot-dom-element.js.map +1 -0
- package/dist/screenshot-task.d.ts +0 -1
- package/dist/screenshot-task.d.ts.map +1 -0
- package/dist/screenshot-task.js.map +1 -0
- package/dist/seek-to-frame.d.ts.map +1 -0
- package/dist/seek-to-frame.js.map +1 -0
- package/dist/serve-handler/index.js +6 -6
- package/dist/serve-static.d.ts.map +1 -0
- package/dist/serve-static.js.map +1 -0
- package/dist/set-props-and-env.d.ts.map +1 -0
- package/dist/set-props-and-env.js +3 -1
- package/dist/set-props-and-env.js.map +1 -0
- package/dist/stitch-frames-to-video.d.ts.map +1 -0
- package/dist/stitch-frames-to-video.js.map +1 -0
- package/dist/stringify-ffmpeg-filter.d.ts.map +1 -0
- package/dist/stringify-ffmpeg-filter.js.map +1 -0
- package/dist/symbolicate-stacktrace.d.ts.map +1 -0
- package/dist/symbolicate-stacktrace.js.map +1 -0
- package/dist/tmp-dir.d.ts.map +1 -0
- package/dist/tmp-dir.js.map +1 -0
- package/dist/types.d.ts.map +1 -0
- package/dist/types.js.map +1 -0
- package/dist/validate-even-dimensions-with-codec.d.ts.map +1 -0
- package/dist/validate-even-dimensions-with-codec.js.map +1 -0
- package/dist/validate-ffmpeg.d.ts.map +1 -0
- package/dist/validate-ffmpeg.js.map +1 -0
- package/dist/validate-puppeteer-timeout.d.ts.map +1 -0
- package/dist/validate-puppeteer-timeout.js.map +1 -0
- package/dist/validate-scale.d.ts.map +1 -0
- package/dist/validate-scale.js.map +1 -0
- package/dist/ws/ws-types.d.ts +14 -0
- package/dist/ws/ws-types.js +10 -0
- package/package.json +3 -7
- package/tsconfig.json +0 -1
- package/types/ws/index.d.ts +509 -0
- package/dist/abort.d.ts +0 -7
- package/dist/abort.js +0 -20
- package/dist/cancel.d.ts +0 -7
- package/dist/cancel.js +0 -25
- package/dist/ensure-faststart.d.ts +0 -1
- package/dist/ensure-faststart.js +0 -14
- package/dist/faststart/atom.d.ts +0 -35
- package/dist/faststart/atom.js +0 -138
- package/dist/faststart/index.d.ts +0 -0
- package/dist/faststart/index.js +0 -1
- package/dist/faststart/options.d.ts +0 -6
- package/dist/faststart/qt-faststart.d.ts +0 -18
- package/dist/faststart/qt-faststart.js +0 -66
- package/dist/faststart/update-chunk-offsets.d.ts +0 -10
- package/dist/faststart/update-chunk-offsets.js +0 -114
- package/dist/faststart/util.d.ts +0 -9
- package/dist/faststart/util.js +0 -34
- package/dist/offthread/index.d.ts +0 -0
- package/dist/offthread/index.js +0 -1
- package/dist/render-gif.d.ts +0 -2
- package/dist/render-gif.js +0 -242
- package/dist/should-use-vp9-decoder.d.ts +0 -0
- package/dist/should-use-vp9-decoder.js +0 -1
- package/dist/stitch-frames-to-gif.d.ts +0 -8
- package/dist/stitch-frames-to-gif.js +0 -128
- package/dist/validate-offthreadvideo-image-format.d.ts +0 -1
- package/dist/validate-offthreadvideo-image-format.js +0 -15
|
@@ -0,0 +1,183 @@
|
|
|
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._getQueryHandlerAndSelector = exports._clearCustomQueryHandlers = exports._customQueryHandlerNames = exports._unregisterCustomQueryHandler = exports._registerCustomQueryHandler = void 0;
|
|
19
|
+
const AriaQueryHandler_1 = require("./AriaQueryHandler");
|
|
20
|
+
function makeQueryHandler(handler) {
|
|
21
|
+
const internalHandler = {};
|
|
22
|
+
if (handler.queryOne) {
|
|
23
|
+
const { queryOne } = handler;
|
|
24
|
+
internalHandler.queryOne = async (element, selector) => {
|
|
25
|
+
const jsHandle = await element.evaluateHandle(queryOne, selector);
|
|
26
|
+
const elementHandle = jsHandle.asElement();
|
|
27
|
+
if (elementHandle) {
|
|
28
|
+
return elementHandle;
|
|
29
|
+
}
|
|
30
|
+
await jsHandle.dispose();
|
|
31
|
+
return null;
|
|
32
|
+
};
|
|
33
|
+
internalHandler.waitFor = (domWorld, selector, options) => {
|
|
34
|
+
return domWorld._waitForSelectorInPage(queryOne, selector, options);
|
|
35
|
+
};
|
|
36
|
+
}
|
|
37
|
+
if (handler.queryAll) {
|
|
38
|
+
const { queryAll } = handler;
|
|
39
|
+
internalHandler.queryAll = async (element, selector) => {
|
|
40
|
+
const jsHandle = await element.evaluateHandle(queryAll, selector);
|
|
41
|
+
const properties = await jsHandle.getProperties();
|
|
42
|
+
await jsHandle.dispose();
|
|
43
|
+
const result = [];
|
|
44
|
+
for (const property of properties.values()) {
|
|
45
|
+
const elementHandle = property.asElement();
|
|
46
|
+
if (elementHandle) {
|
|
47
|
+
result.push(elementHandle);
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
return result;
|
|
51
|
+
};
|
|
52
|
+
internalHandler.queryAllArray = async (element, selector) => {
|
|
53
|
+
const resultHandle = await element.evaluateHandle(queryAll, selector);
|
|
54
|
+
const arrayHandle = await resultHandle.evaluateHandle((res) => {
|
|
55
|
+
return Array.from(res);
|
|
56
|
+
});
|
|
57
|
+
return arrayHandle;
|
|
58
|
+
};
|
|
59
|
+
}
|
|
60
|
+
return internalHandler;
|
|
61
|
+
}
|
|
62
|
+
const _defaultHandler = makeQueryHandler({
|
|
63
|
+
queryOne: (element, selector) => {
|
|
64
|
+
return element.querySelector(selector);
|
|
65
|
+
},
|
|
66
|
+
queryAll: (element, selector) => {
|
|
67
|
+
return element.querySelectorAll(selector);
|
|
68
|
+
},
|
|
69
|
+
});
|
|
70
|
+
const pierceHandler = makeQueryHandler({
|
|
71
|
+
queryOne: (element, selector) => {
|
|
72
|
+
let found = null;
|
|
73
|
+
const search = (root) => {
|
|
74
|
+
const iter = document.createTreeWalker(root, NodeFilter.SHOW_ELEMENT);
|
|
75
|
+
do {
|
|
76
|
+
const currentNode = iter.currentNode;
|
|
77
|
+
if (currentNode.shadowRoot) {
|
|
78
|
+
search(currentNode.shadowRoot);
|
|
79
|
+
}
|
|
80
|
+
if (currentNode instanceof ShadowRoot) {
|
|
81
|
+
continue;
|
|
82
|
+
}
|
|
83
|
+
if (currentNode !== root && !found && currentNode.matches(selector)) {
|
|
84
|
+
found = currentNode;
|
|
85
|
+
}
|
|
86
|
+
} while (!found && iter.nextNode());
|
|
87
|
+
};
|
|
88
|
+
if (element instanceof Document) {
|
|
89
|
+
element = element.documentElement;
|
|
90
|
+
}
|
|
91
|
+
search(element);
|
|
92
|
+
return found;
|
|
93
|
+
},
|
|
94
|
+
queryAll: (element, selector) => {
|
|
95
|
+
const result = [];
|
|
96
|
+
const collect = (root) => {
|
|
97
|
+
const iter = document.createTreeWalker(root, NodeFilter.SHOW_ELEMENT);
|
|
98
|
+
do {
|
|
99
|
+
const currentNode = iter.currentNode;
|
|
100
|
+
if (currentNode.shadowRoot) {
|
|
101
|
+
collect(currentNode.shadowRoot);
|
|
102
|
+
}
|
|
103
|
+
if (currentNode instanceof ShadowRoot) {
|
|
104
|
+
continue;
|
|
105
|
+
}
|
|
106
|
+
if (currentNode !== root && currentNode.matches(selector)) {
|
|
107
|
+
result.push(currentNode);
|
|
108
|
+
}
|
|
109
|
+
} while (iter.nextNode());
|
|
110
|
+
};
|
|
111
|
+
if (element instanceof Document) {
|
|
112
|
+
element = element.documentElement;
|
|
113
|
+
}
|
|
114
|
+
collect(element);
|
|
115
|
+
return result;
|
|
116
|
+
},
|
|
117
|
+
});
|
|
118
|
+
const builtInHandlers = new Map([
|
|
119
|
+
['aria', AriaQueryHandler_1._ariaHandler],
|
|
120
|
+
['pierce', pierceHandler],
|
|
121
|
+
]);
|
|
122
|
+
const queryHandlers = new Map(builtInHandlers);
|
|
123
|
+
/**
|
|
124
|
+
* @internal
|
|
125
|
+
*/
|
|
126
|
+
function _registerCustomQueryHandler(name, handler) {
|
|
127
|
+
if (queryHandlers.get(name)) {
|
|
128
|
+
throw new Error(`A custom query handler named "${name}" already exists`);
|
|
129
|
+
}
|
|
130
|
+
const isValidName = /^[a-zA-Z]+$/.test(name);
|
|
131
|
+
if (!isValidName) {
|
|
132
|
+
throw new Error(`Custom query handler names may only contain [a-zA-Z]`);
|
|
133
|
+
}
|
|
134
|
+
const internalHandler = makeQueryHandler(handler);
|
|
135
|
+
queryHandlers.set(name, internalHandler);
|
|
136
|
+
}
|
|
137
|
+
exports._registerCustomQueryHandler = _registerCustomQueryHandler;
|
|
138
|
+
/**
|
|
139
|
+
* @internal
|
|
140
|
+
*/
|
|
141
|
+
function _unregisterCustomQueryHandler(name) {
|
|
142
|
+
if (queryHandlers.has(name) && !builtInHandlers.has(name)) {
|
|
143
|
+
queryHandlers.delete(name);
|
|
144
|
+
}
|
|
145
|
+
}
|
|
146
|
+
exports._unregisterCustomQueryHandler = _unregisterCustomQueryHandler;
|
|
147
|
+
/**
|
|
148
|
+
* @internal
|
|
149
|
+
*/
|
|
150
|
+
function _customQueryHandlerNames() {
|
|
151
|
+
return [...queryHandlers.keys()].filter((name) => {
|
|
152
|
+
return !builtInHandlers.has(name);
|
|
153
|
+
});
|
|
154
|
+
}
|
|
155
|
+
exports._customQueryHandlerNames = _customQueryHandlerNames;
|
|
156
|
+
/**
|
|
157
|
+
* @internal
|
|
158
|
+
*/
|
|
159
|
+
function _clearCustomQueryHandlers() {
|
|
160
|
+
_customQueryHandlerNames().forEach(_unregisterCustomQueryHandler);
|
|
161
|
+
}
|
|
162
|
+
exports._clearCustomQueryHandlers = _clearCustomQueryHandlers;
|
|
163
|
+
/**
|
|
164
|
+
* @internal
|
|
165
|
+
*/
|
|
166
|
+
function _getQueryHandlerAndSelector(selector) {
|
|
167
|
+
const hasCustomQueryHandler = /^[a-zA-Z]+\//.test(selector);
|
|
168
|
+
if (!hasCustomQueryHandler) {
|
|
169
|
+
return { updatedSelector: selector, queryHandler: _defaultHandler };
|
|
170
|
+
}
|
|
171
|
+
const index = selector.indexOf('/');
|
|
172
|
+
const name = selector.slice(0, index);
|
|
173
|
+
const updatedSelector = selector.slice(index + 1);
|
|
174
|
+
const queryHandler = queryHandlers.get(name);
|
|
175
|
+
if (!queryHandler) {
|
|
176
|
+
throw new Error(`Query set to use "${name}", but no query handler of that name was found`);
|
|
177
|
+
}
|
|
178
|
+
return {
|
|
179
|
+
updatedSelector,
|
|
180
|
+
queryHandler,
|
|
181
|
+
};
|
|
182
|
+
}
|
|
183
|
+
exports._getQueryHandlerAndSelector = _getQueryHandlerAndSelector;
|
|
@@ -0,0 +1,55 @@
|
|
|
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
|
+
import { Protocol } from 'devtools-protocol';
|
|
17
|
+
/**
|
|
18
|
+
* The SecurityDetails class represents the security details of a
|
|
19
|
+
* response that was received over a secure connection.
|
|
20
|
+
*
|
|
21
|
+
* @public
|
|
22
|
+
*/
|
|
23
|
+
export declare class SecurityDetails {
|
|
24
|
+
#private;
|
|
25
|
+
/**
|
|
26
|
+
* @internal
|
|
27
|
+
*/
|
|
28
|
+
constructor(securityPayload: Protocol.Network.SecurityDetails);
|
|
29
|
+
/**
|
|
30
|
+
* @returns The name of the issuer of the certificate.
|
|
31
|
+
*/
|
|
32
|
+
issuer(): string;
|
|
33
|
+
/**
|
|
34
|
+
* @returns {@link https://en.wikipedia.org/wiki/Unix_time | Unix timestamp}
|
|
35
|
+
* marking the start of the certificate's validity.
|
|
36
|
+
*/
|
|
37
|
+
validFrom(): number;
|
|
38
|
+
/**
|
|
39
|
+
* @returns {@link https://en.wikipedia.org/wiki/Unix_time | Unix timestamp}
|
|
40
|
+
* marking the end of the certificate's validity.
|
|
41
|
+
*/
|
|
42
|
+
validTo(): number;
|
|
43
|
+
/**
|
|
44
|
+
* @returns The security protocol being used, e.g. "TLS 1.2".
|
|
45
|
+
*/
|
|
46
|
+
protocol(): string;
|
|
47
|
+
/**
|
|
48
|
+
* @returns The name of the subject to which the certificate was issued.
|
|
49
|
+
*/
|
|
50
|
+
subjectName(): string;
|
|
51
|
+
/**
|
|
52
|
+
* @returns The list of {@link https://en.wikipedia.org/wiki/Subject_Alternative_Name | subject alternative names (SANs)} of the certificate.
|
|
53
|
+
*/
|
|
54
|
+
subjectAlternativeNames(): string[];
|
|
55
|
+
}
|
|
@@ -0,0 +1,95 @@
|
|
|
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
|
+
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 _SecurityDetails_subjectName, _SecurityDetails_issuer, _SecurityDetails_validFrom, _SecurityDetails_validTo, _SecurityDetails_protocol, _SecurityDetails_sanList;
|
|
29
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
30
|
+
exports.SecurityDetails = void 0;
|
|
31
|
+
/**
|
|
32
|
+
* The SecurityDetails class represents the security details of a
|
|
33
|
+
* response that was received over a secure connection.
|
|
34
|
+
*
|
|
35
|
+
* @public
|
|
36
|
+
*/
|
|
37
|
+
class SecurityDetails {
|
|
38
|
+
/**
|
|
39
|
+
* @internal
|
|
40
|
+
*/
|
|
41
|
+
constructor(securityPayload) {
|
|
42
|
+
_SecurityDetails_subjectName.set(this, void 0);
|
|
43
|
+
_SecurityDetails_issuer.set(this, void 0);
|
|
44
|
+
_SecurityDetails_validFrom.set(this, void 0);
|
|
45
|
+
_SecurityDetails_validTo.set(this, void 0);
|
|
46
|
+
_SecurityDetails_protocol.set(this, void 0);
|
|
47
|
+
_SecurityDetails_sanList.set(this, void 0);
|
|
48
|
+
__classPrivateFieldSet(this, _SecurityDetails_subjectName, securityPayload.subjectName, "f");
|
|
49
|
+
__classPrivateFieldSet(this, _SecurityDetails_issuer, securityPayload.issuer, "f");
|
|
50
|
+
__classPrivateFieldSet(this, _SecurityDetails_validFrom, securityPayload.validFrom, "f");
|
|
51
|
+
__classPrivateFieldSet(this, _SecurityDetails_validTo, securityPayload.validTo, "f");
|
|
52
|
+
__classPrivateFieldSet(this, _SecurityDetails_protocol, securityPayload.protocol, "f");
|
|
53
|
+
__classPrivateFieldSet(this, _SecurityDetails_sanList, securityPayload.sanList, "f");
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
* @returns The name of the issuer of the certificate.
|
|
57
|
+
*/
|
|
58
|
+
issuer() {
|
|
59
|
+
return __classPrivateFieldGet(this, _SecurityDetails_issuer, "f");
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
* @returns {@link https://en.wikipedia.org/wiki/Unix_time | Unix timestamp}
|
|
63
|
+
* marking the start of the certificate's validity.
|
|
64
|
+
*/
|
|
65
|
+
validFrom() {
|
|
66
|
+
return __classPrivateFieldGet(this, _SecurityDetails_validFrom, "f");
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* @returns {@link https://en.wikipedia.org/wiki/Unix_time | Unix timestamp}
|
|
70
|
+
* marking the end of the certificate's validity.
|
|
71
|
+
*/
|
|
72
|
+
validTo() {
|
|
73
|
+
return __classPrivateFieldGet(this, _SecurityDetails_validTo, "f");
|
|
74
|
+
}
|
|
75
|
+
/**
|
|
76
|
+
* @returns The security protocol being used, e.g. "TLS 1.2".
|
|
77
|
+
*/
|
|
78
|
+
protocol() {
|
|
79
|
+
return __classPrivateFieldGet(this, _SecurityDetails_protocol, "f");
|
|
80
|
+
}
|
|
81
|
+
/**
|
|
82
|
+
* @returns The name of the subject to which the certificate was issued.
|
|
83
|
+
*/
|
|
84
|
+
subjectName() {
|
|
85
|
+
return __classPrivateFieldGet(this, _SecurityDetails_subjectName, "f");
|
|
86
|
+
}
|
|
87
|
+
/**
|
|
88
|
+
* @returns The list of {@link https://en.wikipedia.org/wiki/Subject_Alternative_Name | subject alternative names (SANs)} of the certificate.
|
|
89
|
+
*/
|
|
90
|
+
subjectAlternativeNames() {
|
|
91
|
+
return __classPrivateFieldGet(this, _SecurityDetails_sanList, "f");
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
exports.SecurityDetails = SecurityDetails;
|
|
95
|
+
_SecurityDetails_subjectName = new WeakMap(), _SecurityDetails_issuer = new WeakMap(), _SecurityDetails_validFrom = new WeakMap(), _SecurityDetails_validTo = new WeakMap(), _SecurityDetails_protocol = new WeakMap(), _SecurityDetails_sanList = new WeakMap();
|
package/dist/browser/Target.d.ts
CHANGED
|
@@ -13,9 +13,9 @@
|
|
|
13
13
|
* See the License for the specific language governing permissions and
|
|
14
14
|
* limitations under the License.
|
|
15
15
|
*/
|
|
16
|
-
import type { Protocol } from 'devtools-protocol';
|
|
17
16
|
import type { Browser, BrowserContext } from './Browser';
|
|
18
17
|
import type { CDPSession } from './Connection';
|
|
18
|
+
import type { TargetInfo } from './devtools-types';
|
|
19
19
|
import { Page } from './Page';
|
|
20
20
|
import type { Viewport } from './PuppeteerViewport';
|
|
21
21
|
export declare class Target {
|
|
@@ -26,12 +26,12 @@ export declare class Target {
|
|
|
26
26
|
_closedCallback: () => void;
|
|
27
27
|
_isInitialized: boolean;
|
|
28
28
|
_targetId: string;
|
|
29
|
-
constructor(targetInfo:
|
|
29
|
+
constructor(targetInfo: TargetInfo, browserContext: BrowserContext, sessionFactory: () => Promise<CDPSession>, defaultViewport: Viewport);
|
|
30
30
|
/**
|
|
31
31
|
* Creates a Chrome Devtools Protocol session attached to the target.
|
|
32
32
|
*/
|
|
33
33
|
createCDPSession(): Promise<CDPSession>;
|
|
34
|
-
_getTargetInfo():
|
|
34
|
+
_getTargetInfo(): TargetInfo;
|
|
35
35
|
/**
|
|
36
36
|
* If the target is not of type `"page"` or `"background_page"`, returns `null`.
|
|
37
37
|
*/
|
|
@@ -57,5 +57,5 @@ export declare class Target {
|
|
|
57
57
|
* Get the target that opened this target. Top-level targets return `null`.
|
|
58
58
|
*/
|
|
59
59
|
opener(): Target | undefined;
|
|
60
|
-
_targetInfoChanged(targetInfo:
|
|
60
|
+
_targetInfoChanged(targetInfo: TargetInfo): void;
|
|
61
61
|
}
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
/// <reference types="node" />
|
|
2
|
+
import { CDPSession } from './Connection';
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export interface TracingOptions {
|
|
7
|
+
path?: string;
|
|
8
|
+
screenshots?: boolean;
|
|
9
|
+
categories?: string[];
|
|
10
|
+
}
|
|
11
|
+
/**
|
|
12
|
+
* The Tracing class exposes the tracing audit interface.
|
|
13
|
+
* @remarks
|
|
14
|
+
* You can use `tracing.start` and `tracing.stop` to create a trace file
|
|
15
|
+
* which can be opened in Chrome DevTools or {@link https://chromedevtools.github.io/timeline-viewer/ | timeline viewer}.
|
|
16
|
+
*
|
|
17
|
+
* @example
|
|
18
|
+
* ```js
|
|
19
|
+
* await page.tracing.start({path: 'trace.json'});
|
|
20
|
+
* await page.goto('https://www.google.com');
|
|
21
|
+
* await page.tracing.stop();
|
|
22
|
+
* ```
|
|
23
|
+
*
|
|
24
|
+
* @public
|
|
25
|
+
*/
|
|
26
|
+
export declare class Tracing {
|
|
27
|
+
#private;
|
|
28
|
+
/**
|
|
29
|
+
* @internal
|
|
30
|
+
*/
|
|
31
|
+
constructor(client: CDPSession);
|
|
32
|
+
/**
|
|
33
|
+
* Starts a trace for the current page.
|
|
34
|
+
* @remarks
|
|
35
|
+
* Only one trace can be active at a time per browser.
|
|
36
|
+
*
|
|
37
|
+
* @param options - Optional `TracingOptions`.
|
|
38
|
+
*/
|
|
39
|
+
start(options?: TracingOptions): Promise<void>;
|
|
40
|
+
/**
|
|
41
|
+
* Stops a trace started with the `start` method.
|
|
42
|
+
* @returns Promise which resolves to buffer with trace data.
|
|
43
|
+
*/
|
|
44
|
+
stop(): Promise<Buffer | undefined>;
|
|
45
|
+
}
|
|
@@ -0,0 +1,136 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
|
|
3
|
+
if (kind === "m") throw new TypeError("Private method is not writable");
|
|
4
|
+
if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
|
|
5
|
+
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");
|
|
6
|
+
return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
|
|
7
|
+
};
|
|
8
|
+
var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
|
|
9
|
+
if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
|
|
10
|
+
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");
|
|
11
|
+
return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
|
|
12
|
+
};
|
|
13
|
+
var _Tracing_client, _Tracing_recording, _Tracing_path;
|
|
14
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
15
|
+
exports.Tracing = void 0;
|
|
16
|
+
/**
|
|
17
|
+
* Copyright 2017 Google Inc. All rights reserved.
|
|
18
|
+
*
|
|
19
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
20
|
+
* you may not use this file except in compliance with the License.
|
|
21
|
+
* You may obtain a copy of the License at
|
|
22
|
+
*
|
|
23
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
24
|
+
*
|
|
25
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
26
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
27
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
28
|
+
* See the License for the specific language governing permissions and
|
|
29
|
+
* limitations under the License.
|
|
30
|
+
*/
|
|
31
|
+
const assert_1 = require("./assert");
|
|
32
|
+
const util_1 = require("./util");
|
|
33
|
+
/**
|
|
34
|
+
* The Tracing class exposes the tracing audit interface.
|
|
35
|
+
* @remarks
|
|
36
|
+
* You can use `tracing.start` and `tracing.stop` to create a trace file
|
|
37
|
+
* which can be opened in Chrome DevTools or {@link https://chromedevtools.github.io/timeline-viewer/ | timeline viewer}.
|
|
38
|
+
*
|
|
39
|
+
* @example
|
|
40
|
+
* ```js
|
|
41
|
+
* await page.tracing.start({path: 'trace.json'});
|
|
42
|
+
* await page.goto('https://www.google.com');
|
|
43
|
+
* await page.tracing.stop();
|
|
44
|
+
* ```
|
|
45
|
+
*
|
|
46
|
+
* @public
|
|
47
|
+
*/
|
|
48
|
+
class Tracing {
|
|
49
|
+
/**
|
|
50
|
+
* @internal
|
|
51
|
+
*/
|
|
52
|
+
constructor(client) {
|
|
53
|
+
_Tracing_client.set(this, void 0);
|
|
54
|
+
_Tracing_recording.set(this, false);
|
|
55
|
+
_Tracing_path.set(this, void 0);
|
|
56
|
+
__classPrivateFieldSet(this, _Tracing_client, client, "f");
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* Starts a trace for the current page.
|
|
60
|
+
* @remarks
|
|
61
|
+
* Only one trace can be active at a time per browser.
|
|
62
|
+
*
|
|
63
|
+
* @param options - Optional `TracingOptions`.
|
|
64
|
+
*/
|
|
65
|
+
async start(options = {}) {
|
|
66
|
+
(0, assert_1.assert)(!__classPrivateFieldGet(this, _Tracing_recording, "f"), 'Cannot start recording trace while already recording trace.');
|
|
67
|
+
const defaultCategories = [
|
|
68
|
+
'-*',
|
|
69
|
+
'devtools.timeline',
|
|
70
|
+
'v8.execute',
|
|
71
|
+
'disabled-by-default-devtools.timeline',
|
|
72
|
+
'disabled-by-default-devtools.timeline.frame',
|
|
73
|
+
'toplevel',
|
|
74
|
+
'blink.console',
|
|
75
|
+
'blink.user_timing',
|
|
76
|
+
'latencyInfo',
|
|
77
|
+
'disabled-by-default-devtools.timeline.stack',
|
|
78
|
+
'disabled-by-default-v8.cpu_profiler',
|
|
79
|
+
];
|
|
80
|
+
const { path, screenshots = false, categories = defaultCategories } = options;
|
|
81
|
+
if (screenshots) {
|
|
82
|
+
categories.push('disabled-by-default-devtools.screenshot');
|
|
83
|
+
}
|
|
84
|
+
const excludedCategories = categories
|
|
85
|
+
.filter((cat) => {
|
|
86
|
+
return cat.startsWith('-');
|
|
87
|
+
})
|
|
88
|
+
.map((cat) => {
|
|
89
|
+
return cat.slice(1);
|
|
90
|
+
});
|
|
91
|
+
const includedCategories = categories.filter((cat) => {
|
|
92
|
+
return !cat.startsWith('-');
|
|
93
|
+
});
|
|
94
|
+
__classPrivateFieldSet(this, _Tracing_path, path, "f");
|
|
95
|
+
__classPrivateFieldSet(this, _Tracing_recording, true, "f");
|
|
96
|
+
await __classPrivateFieldGet(this, _Tracing_client, "f").send('Tracing.start', {
|
|
97
|
+
transferMode: 'ReturnAsStream',
|
|
98
|
+
traceConfig: {
|
|
99
|
+
excludedCategories,
|
|
100
|
+
includedCategories,
|
|
101
|
+
},
|
|
102
|
+
});
|
|
103
|
+
}
|
|
104
|
+
/**
|
|
105
|
+
* Stops a trace started with the `start` method.
|
|
106
|
+
* @returns Promise which resolves to buffer with trace data.
|
|
107
|
+
*/
|
|
108
|
+
async stop() {
|
|
109
|
+
let resolve;
|
|
110
|
+
let reject;
|
|
111
|
+
const contentPromise = new Promise((x, y) => {
|
|
112
|
+
resolve = x;
|
|
113
|
+
reject = y;
|
|
114
|
+
});
|
|
115
|
+
__classPrivateFieldGet(this, _Tracing_client, "f").once('Tracing.tracingComplete', async (event) => {
|
|
116
|
+
try {
|
|
117
|
+
const readable = await (0, util_1.getReadableFromProtocolStream)(__classPrivateFieldGet(this, _Tracing_client, "f"), event.stream);
|
|
118
|
+
const buffer = await (0, util_1.getReadableAsBuffer)(readable, __classPrivateFieldGet(this, _Tracing_path, "f"));
|
|
119
|
+
resolve(buffer !== null && buffer !== void 0 ? buffer : undefined);
|
|
120
|
+
}
|
|
121
|
+
catch (error) {
|
|
122
|
+
if ((0, util_1.isErrorLike)(error)) {
|
|
123
|
+
reject(error);
|
|
124
|
+
}
|
|
125
|
+
else {
|
|
126
|
+
reject(new Error(`Unknown error: ${error}`));
|
|
127
|
+
}
|
|
128
|
+
}
|
|
129
|
+
});
|
|
130
|
+
await __classPrivateFieldGet(this, _Tracing_client, "f").send('Tracing.end');
|
|
131
|
+
__classPrivateFieldSet(this, _Tracing_recording, false, "f");
|
|
132
|
+
return contentPromise;
|
|
133
|
+
}
|
|
134
|
+
}
|
|
135
|
+
exports.Tracing = Tracing;
|
|
136
|
+
_Tracing_client = new WeakMap(), _Tracing_recording = new WeakMap(), _Tracing_path = new WeakMap();
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright 2017 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
|
+
/**
|
|
17
|
+
* @internal
|
|
18
|
+
*/
|
|
19
|
+
export interface KeyDefinition {
|
|
20
|
+
keyCode?: number;
|
|
21
|
+
shiftKeyCode?: number;
|
|
22
|
+
key?: string;
|
|
23
|
+
shiftKey?: string;
|
|
24
|
+
code?: string;
|
|
25
|
+
text?: string;
|
|
26
|
+
shiftText?: string;
|
|
27
|
+
location?: number;
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* All the valid keys that can be passed to functions that take user input, such
|
|
31
|
+
* as {@link Keyboard.press | keyboard.press }
|
|
32
|
+
*
|
|
33
|
+
* @public
|
|
34
|
+
*/
|
|
35
|
+
export declare type KeyInput = '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'Power' | 'Eject' | 'Abort' | 'Help' | 'Backspace' | 'Tab' | 'Numpad5' | 'NumpadEnter' | 'Enter' | '\r' | '\n' | 'ShiftLeft' | 'ShiftRight' | 'ControlLeft' | 'ControlRight' | 'AltLeft' | 'AltRight' | 'Pause' | 'CapsLock' | 'Escape' | 'Convert' | 'NonConvert' | 'Space' | 'Numpad9' | 'PageUp' | 'Numpad3' | 'PageDown' | 'End' | 'Numpad1' | 'Home' | 'Numpad7' | 'ArrowLeft' | 'Numpad4' | 'Numpad8' | 'ArrowUp' | 'ArrowRight' | 'Numpad6' | 'Numpad2' | 'ArrowDown' | 'Select' | 'Open' | 'PrintScreen' | 'Insert' | 'Numpad0' | 'Delete' | 'NumpadDecimal' | 'Digit0' | 'Digit1' | 'Digit2' | 'Digit3' | 'Digit4' | 'Digit5' | 'Digit6' | 'Digit7' | 'Digit8' | 'Digit9' | 'KeyA' | 'KeyB' | 'KeyC' | 'KeyD' | 'KeyE' | 'KeyF' | 'KeyG' | 'KeyH' | 'KeyI' | 'KeyJ' | 'KeyK' | 'KeyL' | 'KeyM' | 'KeyN' | 'KeyO' | 'KeyP' | 'KeyQ' | 'KeyR' | 'KeyS' | 'KeyT' | 'KeyU' | 'KeyV' | 'KeyW' | 'KeyX' | 'KeyY' | 'KeyZ' | 'MetaLeft' | 'MetaRight' | 'ContextMenu' | 'NumpadMultiply' | 'NumpadAdd' | 'NumpadSubtract' | 'NumpadDivide' | 'F1' | 'F2' | 'F3' | 'F4' | 'F5' | 'F6' | 'F7' | 'F8' | 'F9' | 'F10' | 'F11' | 'F12' | 'F13' | 'F14' | 'F15' | 'F16' | 'F17' | 'F18' | 'F19' | 'F20' | 'F21' | 'F22' | 'F23' | 'F24' | 'NumLock' | 'ScrollLock' | 'AudioVolumeMute' | 'AudioVolumeDown' | 'AudioVolumeUp' | 'MediaTrackNext' | 'MediaTrackPrevious' | 'MediaStop' | 'MediaPlayPause' | 'Semicolon' | 'Equal' | 'NumpadEqual' | 'Comma' | 'Minus' | 'Period' | 'Slash' | 'Backquote' | 'BracketLeft' | 'Backslash' | 'BracketRight' | 'Quote' | 'AltGraph' | 'Props' | 'Cancel' | 'Clear' | 'Shift' | 'Control' | 'Alt' | 'Accept' | 'ModeChange' | ' ' | 'Print' | 'Execute' | '\u0000' | 'a' | 'b' | 'c' | 'd' | 'e' | 'f' | 'g' | 'h' | 'i' | 'j' | 'k' | 'l' | 'm' | 'n' | 'o' | 'p' | 'q' | 'r' | 's' | 't' | 'u' | 'v' | 'w' | 'x' | 'y' | 'z' | 'Meta' | '*' | '+' | '-' | '/' | ';' | '=' | ',' | '.' | '`' | '[' | '\\' | ']' | "'" | 'Attn' | 'CrSel' | 'ExSel' | 'EraseEof' | 'Play' | 'ZoomOut' | ')' | '!' | '@' | '#' | '$' | '%' | '^' | '&' | '(' | 'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'H' | 'I' | 'J' | 'K' | 'L' | 'M' | 'N' | 'O' | 'P' | 'Q' | 'R' | 'S' | 'T' | 'U' | 'V' | 'W' | 'X' | 'Y' | 'Z' | ':' | '<' | '_' | '>' | '?' | '~' | '{' | '|' | '}' | '"' | 'SoftLeft' | 'SoftRight' | 'Camera' | 'Call' | 'EndCall' | 'VolumeDown' | 'VolumeUp';
|
|
36
|
+
/**
|
|
37
|
+
* @internal
|
|
38
|
+
*/
|
|
39
|
+
export declare const _keyDefinitions: Readonly<Record<KeyInput, KeyDefinition>>;
|