browser-debugger-cli 0.8.0 → 0.10.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.
- package/README.md +7 -1
- package/dist/cdp/schema.d.ts +4 -1
- package/dist/cdp/schema.js +48 -7
- package/dist/commands/cdp.js +3 -2
- package/dist/commands/cleanup.d.ts +11 -0
- package/dist/commands/cleanup.js +161 -57
- package/dist/commands/console.d.ts +20 -1
- package/dist/commands/console.js +57 -17
- package/dist/commands/details.js +3 -2
- package/dist/commands/dom/DomElementResolver.d.ts +10 -3
- package/dist/commands/dom/DomElementResolver.js +35 -17
- package/dist/commands/dom/a11y.d.ts +10 -0
- package/dist/commands/dom/a11y.js +29 -6
- package/dist/commands/dom/eval.d.ts +3 -1
- package/dist/commands/dom/eval.js +29 -4
- package/dist/commands/dom/form.js +16 -62
- package/dist/commands/dom/formInteraction.js +189 -119
- package/dist/commands/dom/formSummary.d.ts +49 -0
- package/dist/commands/dom/formSummary.js +180 -0
- package/dist/commands/dom/frames.d.ts +2 -1
- package/dist/commands/dom/frames.js +17 -2
- package/dist/commands/dom/get.d.ts +6 -5
- package/dist/commands/dom/get.js +92 -82
- package/dist/commands/dom/helpers/index.d.ts +1 -1
- package/dist/commands/dom/helpers/index.js +1 -1
- package/dist/commands/dom/helpers/keyAttributes.d.ts +20 -0
- package/dist/commands/dom/helpers/keyAttributes.js +54 -0
- package/dist/commands/dom/helpers/query.d.ts +44 -17
- package/dist/commands/dom/helpers/query.js +300 -106
- package/dist/commands/dom/helpers/runElementCommand.d.ts +10 -2
- package/dist/commands/dom/helpers/runElementCommand.js +98 -30
- package/dist/commands/dom/helpers/screenshot.d.ts +4 -1
- package/dist/commands/dom/helpers/screenshot.js +239 -51
- package/dist/commands/dom/index.d.ts +4 -1
- package/dist/commands/dom/index.js +22 -7
- package/dist/commands/dom/inspect.d.ts +15 -0
- package/dist/commands/dom/inspect.js +82 -0
- package/dist/commands/dom/layout.d.ts +14 -0
- package/dist/commands/dom/layout.js +54 -0
- package/dist/commands/dom/listeners.d.ts +5 -1
- package/dist/commands/dom/listeners.js +15 -5
- package/dist/commands/dom/query.js +2 -3
- package/dist/commands/dom/screenshot.d.ts +12 -2
- package/dist/commands/dom/screenshot.js +27 -3
- package/dist/commands/dom/semanticUtils.d.ts +16 -10
- package/dist/commands/dom/semanticUtils.js +53 -16
- package/dist/commands/dom/wait.d.ts +13 -0
- package/dist/commands/dom/wait.js +83 -0
- package/dist/commands/helpJson.js +2 -2
- package/dist/commands/network/list.js +17 -13
- package/dist/commands/optionBehaviors.js +154 -21
- package/dist/commands/page.d.ts +3 -2
- package/dist/commands/page.js +100 -5
- package/dist/commands/peek.js +4 -11
- package/dist/commands/sessions.d.ts +8 -0
- package/dist/commands/sessions.js +19 -0
- package/dist/commands/shared/CommandRunner.js +4 -4
- package/dist/commands/shared/commonOptions.d.ts +4 -0
- package/dist/commands/shared/commonOptions.js +9 -0
- package/dist/commands/shared/dataFetcher.js +2 -2
- package/dist/commands/shared/followMode.d.ts +21 -1
- package/dist/commands/shared/followMode.js +29 -2
- package/dist/commands/shared/handleValidationError.d.ts +2 -2
- package/dist/commands/shared/handleValidationError.js +12 -3
- package/dist/commands/shared/optionTypes.d.ts +61 -5
- package/dist/commands/shared/startHelpers.d.ts +66 -0
- package/dist/commands/shared/startHelpers.js +103 -13
- package/dist/commands/shared/validation.d.ts +14 -2
- package/dist/commands/shared/validation.js +20 -3
- package/dist/commands/start.d.ts +63 -0
- package/dist/commands/start.js +115 -15
- package/dist/commands/status.js +29 -7
- package/dist/commands/stop.js +7 -6
- package/dist/commands/tail.js +4 -11
- package/dist/commands/types.d.ts +2 -0
- package/dist/commands.js +2 -0
- package/dist/connection/chromeIdentity.d.ts +65 -0
- package/dist/connection/chromeIdentity.js +143 -0
- package/dist/connection/launcher/profilePreferences.d.ts +47 -0
- package/dist/connection/launcher/profilePreferences.js +151 -0
- package/dist/connection/launcher.d.ts +21 -2
- package/dist/connection/launcher.js +42 -16
- package/dist/connection/portReservation.d.ts +14 -4
- package/dist/connection/portReservation.js +21 -6
- package/dist/connection/startupExit.d.ts +8 -0
- package/dist/connection/startupExit.js +15 -6
- package/dist/constants.d.ts +6 -2
- package/dist/constants.js +9 -2
- package/dist/daemon/SessionController.js +23 -7
- package/dist/daemon/errors.d.ts +1 -1
- package/dist/daemon/errors.js +1 -1
- package/dist/daemon/launcher.d.ts +10 -2
- package/dist/daemon/launcher.js +8 -7
- package/dist/daemon/server/SocketServer.js +1 -2
- package/dist/daemon/session/Session.d.ts +20 -0
- package/dist/daemon/session/Session.js +80 -9
- package/dist/daemon/session/chromeConnection.d.ts +9 -0
- package/dist/daemon/session/chromeConnection.js +45 -8
- package/dist/daemon/session/commandRegistry.d.ts +14 -1
- package/dist/daemon/session/commandRegistry.js +113 -67
- package/dist/daemon/session/interactions.d.ts +48 -9
- package/dist/daemon/session/interactions.js +46 -9
- package/dist/daemon/session/triggeredRequests.d.ts +67 -0
- package/dist/daemon/session/triggeredRequests.js +157 -0
- package/dist/daemon/session/types.d.ts +5 -1
- package/dist/daemon.js +10630 -3601
- package/dist/errors/messages.d.ts +456 -24
- package/dist/errors/messages.js +862 -67
- package/dist/index.js +6915 -3401
- package/dist/ipc/client.d.ts +21 -1
- package/dist/ipc/client.js +35 -3
- package/dist/ipc/protocol/commands.d.ts +145 -5
- package/dist/ipc/protocol/commands.js +4 -0
- package/dist/ipc/protocol/domTypes.d.ts +291 -7
- package/dist/ipc/protocol/inspectTypes.d.ts +388 -0
- package/dist/ipc/protocol/inspectTypes.js +10 -0
- package/dist/ipc/session/lifecycle.d.ts +8 -1
- package/dist/ipc/session/queries.d.ts +5 -1
- package/dist/ipc/session/types.d.ts +5 -0
- package/dist/ipc/transport/index.d.ts +2 -1
- package/dist/ipc/transport/index.js +2 -2
- package/dist/runtime/dom/actionEffects.d.ts +185 -0
- package/dist/runtime/dom/actionEffects.js +402 -0
- package/dist/runtime/dom/actionEffectsScripts.d.ts +90 -0
- package/dist/runtime/dom/actionEffectsScripts.js +426 -0
- package/dist/runtime/dom/elementGeometry.d.ts +170 -0
- package/dist/runtime/dom/elementGeometry.js +553 -0
- package/dist/runtime/dom/elementInfo.d.ts +103 -0
- package/dist/runtime/dom/elementInfo.js +256 -0
- package/dist/runtime/dom/evalHelpers.d.ts +51 -6
- package/dist/runtime/dom/evalHelpers.js +136 -26
- package/dist/runtime/dom/eventListeners.d.ts +2 -1
- package/dist/runtime/dom/eventListeners.js +184 -47
- package/dist/runtime/dom/formDiscovery.d.ts +1 -1
- package/dist/runtime/dom/formDiscovery.js +116 -16
- package/dist/runtime/dom/formFillHelpers/fill.d.ts +9 -0
- package/dist/runtime/dom/formFillHelpers/fill.js +178 -14
- package/dist/runtime/dom/formFillHelpers/index.d.ts +2 -2
- package/dist/runtime/dom/formFillHelpers/index.js +2 -2
- package/dist/runtime/dom/formFillHelpers/pressKey.js +14 -3
- package/dist/runtime/dom/formFillHelpers/scroll.d.ts +3 -0
- package/dist/runtime/dom/formFillHelpers/scroll.js +60 -18
- package/dist/runtime/dom/formFillHelpers/shared.d.ts +17 -0
- package/dist/runtime/dom/formFillHelpers/shared.js +25 -1
- package/dist/runtime/dom/formFillHelpers/stability.d.ts +20 -6
- package/dist/runtime/dom/formFillHelpers/stability.js +50 -19
- package/dist/runtime/dom/formSubmitHelpers.d.ts +3 -0
- package/dist/runtime/dom/formSubmitHelpers.js +89 -15
- package/dist/runtime/dom/frameLayout.d.ts +60 -0
- package/dist/runtime/dom/frameLayout.js +140 -0
- package/dist/runtime/dom/frameOrigin.d.ts +50 -0
- package/dist/runtime/dom/frameOrigin.js +62 -0
- package/dist/runtime/dom/frameScopedConnection.d.ts +92 -0
- package/dist/runtime/dom/frameScopedConnection.js +252 -0
- package/dist/runtime/dom/frameSelection.d.ts +12 -1
- package/dist/runtime/dom/frameSelection.js +22 -3
- package/dist/runtime/dom/frames.d.ts +61 -5
- package/dist/runtime/dom/frames.js +329 -75
- package/dist/runtime/dom/inspect.d.ts +28 -0
- package/dist/runtime/dom/inspect.js +557 -0
- package/dist/runtime/dom/inspectAllStyles.d.ts +62 -0
- package/dist/runtime/dom/inspectAllStyles.js +385 -0
- package/dist/runtime/dom/inspectCascade.d.ts +94 -0
- package/dist/runtime/dom/inspectCascade.js +371 -0
- package/dist/runtime/dom/inspectCascadeModel.d.ts +39 -0
- package/dist/runtime/dom/inspectCascadeModel.js +232 -0
- package/dist/runtime/dom/inspectHints.d.ts +62 -0
- package/dist/runtime/dom/inspectHints.js +305 -0
- package/dist/runtime/dom/inspectLayoutModel.d.ts +87 -0
- package/dist/runtime/dom/inspectLayoutModel.js +346 -0
- package/dist/runtime/dom/inspectModel.d.ts +74 -0
- package/dist/runtime/dom/inspectModel.js +184 -0
- package/dist/runtime/dom/inspectPaintModel.d.ts +157 -0
- package/dist/runtime/dom/inspectPaintModel.js +461 -0
- package/dist/runtime/dom/inspectRules.d.ts +37 -0
- package/dist/runtime/dom/inspectRules.js +101 -0
- package/dist/runtime/dom/inspectScripts.d.ts +132 -0
- package/dist/runtime/dom/inspectScripts.js +263 -0
- package/dist/runtime/dom/inspectTree.d.ts +40 -0
- package/dist/runtime/dom/inspectTree.js +134 -0
- package/dist/runtime/dom/inspectVariables.d.ts +33 -0
- package/dist/runtime/dom/inspectVariables.js +94 -0
- package/dist/runtime/dom/inspectWhyModel.d.ts +20 -0
- package/dist/runtime/dom/inspectWhyModel.js +134 -0
- package/dist/runtime/dom/layout.d.ts +71 -0
- package/dist/runtime/dom/layout.js +340 -0
- package/dist/runtime/dom/listenerPageScripts.d.ts +72 -0
- package/dist/runtime/dom/listenerPageScripts.js +365 -0
- package/dist/runtime/dom/listenerSummary.d.ts +136 -11
- package/dist/runtime/dom/listenerSummary.js +361 -22
- package/dist/runtime/dom/pageActivity.d.ts +41 -0
- package/dist/runtime/dom/pageActivity.js +123 -0
- package/dist/runtime/dom/reactEventHelpers.d.ts +63 -2
- package/dist/runtime/dom/reactEventHelpers.js +220 -41
- package/dist/runtime/dom/targetNode.d.ts +80 -27
- package/dist/runtime/dom/targetNode.js +249 -33
- package/dist/runtime/dom/wait.d.ts +25 -0
- package/dist/runtime/dom/wait.js +199 -0
- package/dist/runtime/dom/waitCondition.d.ts +71 -0
- package/dist/runtime/dom/waitCondition.js +75 -0
- package/dist/runtime/page/emulation.d.ts +71 -0
- package/dist/runtime/page/emulation.js +117 -0
- package/dist/runtime/page/loadingState.d.ts +36 -0
- package/dist/runtime/page/loadingState.js +86 -0
- package/dist/runtime/page/navigation.d.ts +46 -2
- package/dist/runtime/page/navigation.js +69 -33
- package/dist/session/QueryCacheManager.d.ts +11 -1
- package/dist/session/QueryCacheManager.js +25 -3
- package/dist/session/chromeOwners.d.ts +34 -0
- package/dist/session/chromeOwners.js +51 -0
- package/dist/session/cleanup/staleSession.d.ts +11 -1
- package/dist/session/cleanup/staleSession.js +17 -6
- package/dist/session/cleanup/userCommands.js +2 -4
- package/dist/session/metadata.d.ts +5 -1
- package/dist/session/metadata.js +2 -1
- package/dist/session/paths.d.ts +77 -3
- package/dist/session/paths.js +111 -5
- package/dist/session/port.d.ts +31 -7
- package/dist/session/port.js +50 -43
- package/dist/session/portClaims.d.ts +66 -0
- package/dist/session/portClaims.js +284 -0
- package/dist/session/sessionList.d.ts +58 -0
- package/dist/session/sessionList.js +199 -0
- package/dist/session/sessionName.d.ts +46 -0
- package/dist/session/sessionName.js +97 -0
- package/dist/telemetry/a11y.d.ts +18 -3
- package/dist/telemetry/a11y.js +170 -29
- package/dist/telemetry/console.d.ts +1 -0
- package/dist/telemetry/console.js +100 -5
- package/dist/telemetry/network.js +3 -1
- package/dist/telemetry/requestKinds.d.ts +32 -0
- package/dist/telemetry/requestKinds.js +61 -0
- package/dist/telemetry/requestState.d.ts +31 -0
- package/dist/telemetry/requestState.js +38 -0
- package/dist/types.d.ts +112 -3
- package/dist/ui/formatters/a11y.js +3 -0
- package/dist/ui/formatters/console/chronological.d.ts +8 -0
- package/dist/ui/formatters/console/chronological.js +17 -4
- package/dist/ui/formatters/console/json.js +3 -4
- package/dist/ui/formatters/console/shared.d.ts +12 -0
- package/dist/ui/formatters/console.d.ts +2 -2
- package/dist/ui/formatters/console.js +1 -1
- package/dist/ui/formatters/details.d.ts +8 -0
- package/dist/ui/formatters/details.js +61 -4
- package/dist/ui/formatters/dom.d.ts +27 -14
- package/dist/ui/formatters/dom.js +88 -59
- package/dist/ui/formatters/form.js +29 -18
- package/dist/ui/formatters/inspect.d.ts +39 -0
- package/dist/ui/formatters/inspect.js +596 -0
- package/dist/ui/formatters/keyAttributes.d.ts +19 -0
- package/dist/ui/formatters/keyAttributes.js +84 -0
- package/dist/ui/formatters/layout.d.ts +31 -0
- package/dist/ui/formatters/layout.js +53 -0
- package/dist/ui/formatters/listeners.d.ts +3 -2
- package/dist/ui/formatters/listeners.js +73 -9
- package/dist/ui/formatters/networkHeaders.d.ts +13 -0
- package/dist/ui/formatters/networkHeaders.js +36 -3
- package/dist/ui/formatters/networkList.d.ts +29 -1
- package/dist/ui/formatters/networkList.js +86 -20
- package/dist/ui/formatters/preview.js +2 -1
- package/dist/ui/formatters/requestStatus.d.ts +1 -17
- package/dist/ui/formatters/requestStatus.js +2 -30
- package/dist/ui/formatters/sessions.d.ts +12 -0
- package/dist/ui/formatters/sessions.js +40 -0
- package/dist/ui/formatters/status.d.ts +21 -2
- package/dist/ui/formatters/status.js +47 -10
- package/dist/ui/formatters/triggeredRequests.d.ts +36 -0
- package/dist/ui/formatters/triggeredRequests.js +65 -0
- package/dist/ui/formatting.d.ts +19 -0
- package/dist/ui/formatting.js +31 -36
- package/dist/ui/messages/chrome.d.ts +9 -0
- package/dist/ui/messages/chrome.js +17 -5
- package/dist/ui/messages/commands.d.ts +504 -14
- package/dist/ui/messages/commands.js +835 -21
- package/dist/ui/messages/consoleMessages.d.ts +10 -0
- package/dist/ui/messages/consoleMessages.js +17 -0
- package/dist/ui/messages/hints.js +2 -1
- package/dist/ui/messages/networkMessages.d.ts +14 -0
- package/dist/ui/messages/networkMessages.js +18 -0
- package/dist/ui/messages/preview.js +5 -4
- package/dist/ui/messages/session.d.ts +30 -21
- package/dist/ui/messages/session.js +48 -26
- package/dist/ui/messages/sessionCommand.d.ts +43 -0
- package/dist/ui/messages/sessionCommand.js +52 -0
- package/dist/utils/async.d.ts +17 -0
- package/dist/utils/async.js +36 -0
- package/dist/utils/color.d.ts +84 -0
- package/dist/utils/color.js +376 -0
- package/dist/utils/cssValues.d.ts +109 -0
- package/dist/utils/cssValues.js +236 -0
- package/dist/utils/http.d.ts +22 -1
- package/dist/utils/http.js +28 -9
- package/dist/utils/selectorFilters.d.ts +48 -8
- package/dist/utils/selectorFilters.js +296 -53
- package/dist/utils/shellDetection.d.ts +8 -2
- package/dist/utils/shellDetection.js +120 -33
- package/dist/utils/suggestions.d.ts +26 -0
- package/dist/utils/suggestions.js +73 -0
- package/dist/utils/taskMappings.js +10 -0
- package/dist/utils/url.d.ts +12 -2
- package/dist/utils/url.js +69 -7
- package/package.json +1 -1
- package/dist/ui/formatters/sessionFormatters.d.ts +0 -58
- package/dist/ui/formatters/sessionFormatters.js +0 -121
|
@@ -4,7 +4,12 @@
|
|
|
4
4
|
* User-facing messages for command-specific operations like stopping sessions,
|
|
5
5
|
* cleaning up stale files, and validating command arguments.
|
|
6
6
|
*/
|
|
7
|
-
import type { DomFrame } from '../../ipc/protocol/commands.js';
|
|
7
|
+
import type { DomFrame, PageLoadingState, PendingRequestInfo } from '../../ipc/protocol/commands.js';
|
|
8
|
+
import type { ElementLayout, FillValueMismatch, LayoutSize, NewMessage, PageLayout, PageNavigation, PendingChanges, ShownElement } from '../../ipc/protocol/domTypes.js';
|
|
9
|
+
import type { InspectVisibility } from '../../ipc/protocol/inspectTypes.js';
|
|
10
|
+
import type { DelegationNote } from '../../runtime/dom/listenerSummary.js';
|
|
11
|
+
import type { WaitCondition, WaitSnapshot } from '../../runtime/dom/waitCondition.js';
|
|
12
|
+
import type { DocumentRequestState, ViewportPosition } from '../../types.js';
|
|
8
13
|
/**
|
|
9
14
|
* Chrome closed by `bdg stop` (gracefully, so the profile is saved).
|
|
10
15
|
*
|
|
@@ -26,13 +31,268 @@ export declare function orphanedDaemonsCleanedMessage(count: number): string;
|
|
|
26
31
|
* @returns Warning text
|
|
27
32
|
*/
|
|
28
33
|
export declare function domClickFallbackWarning(reason: string | null | undefined): string;
|
|
34
|
+
/** Reason of a `bdg dom form` blocker for a required field left empty */
|
|
35
|
+
export declare const REQUIRED_FIELD_EMPTY_REASON = "Required field is empty";
|
|
36
|
+
/**
|
|
37
|
+
* Part of the `bdg dom form` summary naming the required fields left empty.
|
|
38
|
+
*
|
|
39
|
+
* @param labels - Labels of the empty required fields
|
|
40
|
+
* @returns e.g. "2 required fields empty: Last Name, Zip"
|
|
41
|
+
*/
|
|
42
|
+
export declare function requiredFieldsEmptyMessage(labels: string[]): string;
|
|
43
|
+
/**
|
|
44
|
+
* Readiness at the end of the `bdg dom form` summary.
|
|
45
|
+
*
|
|
46
|
+
* @param summary - Whether the form is ready, how many fields are filled and
|
|
47
|
+
* required, and the labels of the empty ones
|
|
48
|
+
* @returns e.g. "READY to submit", "NOT ready (no fields filled)"
|
|
49
|
+
*/
|
|
50
|
+
export declare function formReadinessMessage(summary: {
|
|
51
|
+
readyToSubmit: boolean;
|
|
52
|
+
filledFields: number;
|
|
53
|
+
requiredTotal: number;
|
|
54
|
+
emptyFieldLabels: string[];
|
|
55
|
+
}): string;
|
|
56
|
+
/** Why an action's status line is not a clean success when nothing changed */
|
|
57
|
+
export declare const NO_VISIBLE_EFFECT = "no visible effect observed: no DOM change, requests or navigation within 300 ms";
|
|
58
|
+
/**
|
|
59
|
+
* Status line of a DOM action: a check mark only for a clean success.
|
|
60
|
+
*
|
|
61
|
+
* @param done - What was done, e.g. "Element Clicked"
|
|
62
|
+
* @param state - Whether the action has warnings (shown right below), had no
|
|
63
|
+
* visible effect, or returned while the page was still changing
|
|
64
|
+
* @returns e.g. "✓ Element Clicked", "⚠ Element Clicked (with warnings)",
|
|
65
|
+
* "⚠ Element Clicked (page still changing)" or
|
|
66
|
+
* "⚠ Element Clicked (no visible effect observed: no DOM change, requests or navigation within 300 ms)"
|
|
67
|
+
*/
|
|
68
|
+
export declare function actionStatusLine(done: string, state: {
|
|
69
|
+
warned: boolean;
|
|
70
|
+
noEffect?: boolean;
|
|
71
|
+
stillChanging?: boolean;
|
|
72
|
+
}): string;
|
|
73
|
+
/**
|
|
74
|
+
* Note under the status line of an action that returned while the page was
|
|
75
|
+
* still changing.
|
|
76
|
+
*
|
|
77
|
+
* @param action - What returned, e.g. "click", "key press"
|
|
78
|
+
* @param pending - What the page was still working on
|
|
79
|
+
* @returns e.g. "The page was still changing when the click returned (2 requests pending); wait for the result with bdg dom wait <selector>"
|
|
80
|
+
*/
|
|
81
|
+
export declare function stillChangingNote(action: string, pending: PendingChanges): string;
|
|
82
|
+
/**
|
|
83
|
+
* An element an action showed, for its `Shown:` rows.
|
|
84
|
+
*
|
|
85
|
+
* @param element - Shown element
|
|
86
|
+
* @returns e.g. `div.figcaption "name: user2 View profile"`
|
|
87
|
+
*/
|
|
88
|
+
export declare function shownElementText(element: ShownElement): string;
|
|
89
|
+
/**
|
|
90
|
+
* How an action changed the page's location, for its `Page:` row.
|
|
91
|
+
*
|
|
92
|
+
* @param navigation - Navigation the action caused
|
|
93
|
+
* @returns e.g. "navigated to https://example.com/secure (200)" or
|
|
94
|
+
* "URL changed to https://example.com/#/active (same document)"
|
|
95
|
+
*/
|
|
96
|
+
export declare function pageNavigationText(navigation: PageNavigation): string;
|
|
97
|
+
/**
|
|
98
|
+
* A message an action made appear, for its `New text:` rows.
|
|
99
|
+
*
|
|
100
|
+
* @param message - New message
|
|
101
|
+
* @returns e.g. `"Your password is invalid!" (div#flash.flash.error)`
|
|
102
|
+
*/
|
|
103
|
+
export declare function newMessageText(message: NewMessage): string;
|
|
104
|
+
/**
|
|
105
|
+
* Warning shown when a filled field's value read back is not the one given:
|
|
106
|
+
* cut to its maxlength, a password of another length (values never shown),
|
|
107
|
+
* or another value (naming the field the value went to, when one has it).
|
|
108
|
+
*
|
|
109
|
+
* @param mismatch - Value given and value found (masked for passwords)
|
|
110
|
+
* @returns Warning text
|
|
111
|
+
*/
|
|
112
|
+
export declare function valueMismatchWarning(mismatch: FillValueMismatch): string;
|
|
113
|
+
/**
|
|
114
|
+
* Warning shown when a mouse press was dispatched but the target never
|
|
115
|
+
* received it (e.g. a browser dialog or bubble captured the input).
|
|
116
|
+
*/
|
|
117
|
+
export declare const CLICK_NOT_RECEIVED_WARNING = "The click may not have reached the element: the page saw no mouse press (the browser may be showing a dialog or bubble that captures input)";
|
|
29
118
|
/**
|
|
30
119
|
* Note under a shortened list of matches.
|
|
31
120
|
*
|
|
32
121
|
* @param hidden - Matches not listed
|
|
33
|
-
* @
|
|
122
|
+
* @param jsonLimit - How many JSON output lists, when it leaves some out too
|
|
123
|
+
* @returns e.g. "... and 1174 more (use --json for all)",
|
|
124
|
+
* "... and 8980 more (--json lists the first 100)"
|
|
125
|
+
*/
|
|
126
|
+
export declare function moreMatchesNote(hidden: number, jsonLimit?: number): string;
|
|
127
|
+
/**
|
|
128
|
+
* Note under a list of a11y query matches cut by `--limit`.
|
|
129
|
+
*
|
|
130
|
+
* @param omitted - Matches not listed
|
|
131
|
+
* @returns e.g. "... and 213 more (--limit 0 lists all; their indices work too)"
|
|
132
|
+
*/
|
|
133
|
+
export declare function a11yMoreMatchesNote(omitted: number): string;
|
|
134
|
+
/**
|
|
135
|
+
* Note under a shortened list of requests an action triggered when JSON
|
|
136
|
+
* output left some out too (they are only in the network telemetry then).
|
|
137
|
+
*
|
|
138
|
+
* @param hidden - Requests not listed
|
|
139
|
+
* @returns e.g. "... and 50 more (see bdg network list)"
|
|
140
|
+
*/
|
|
141
|
+
export declare function moreRequestsNote(hidden: number): string;
|
|
142
|
+
/**
|
|
143
|
+
* Title of the list of requests that started while an action ran (they are
|
|
144
|
+
* attributed by time, so a page poller's requests are listed too: the title
|
|
145
|
+
* doesn't claim the action caused them).
|
|
146
|
+
*
|
|
147
|
+
* @param total - Requests in all
|
|
148
|
+
* @returns e.g. "Requests during the action (18):"
|
|
149
|
+
*/
|
|
150
|
+
export declare function triggeredRequestsTitle(total: number): string;
|
|
151
|
+
/**
|
|
152
|
+
* Line counting the static assets an action loaded instead of listing them.
|
|
153
|
+
*
|
|
154
|
+
* @param count - Asset requests
|
|
155
|
+
* @param types - Short type names, e.g. ["css", "js", "images"]
|
|
156
|
+
* @returns e.g. "+ 97 assets (css, js, fonts, images)"
|
|
157
|
+
*/
|
|
158
|
+
export declare function assetRequestsNote(count: number, types: string[]): string;
|
|
159
|
+
/**
|
|
160
|
+
* Pieces of the reasons `bdg dom layout` gives for hidden and invisible
|
|
161
|
+
* elements. The page-side measurement builds the reasons from them, e.g.
|
|
162
|
+
* `clipped by div#acc: zero height`, `opacity: 0 on div#menu`.
|
|
163
|
+
*/
|
|
164
|
+
export declare const LAYOUT_REASONS: {
|
|
165
|
+
/** Hidden: an `<option>` of a closed `<select>` has no box */
|
|
166
|
+
readonly option: "not rendered (an <option> is shown by its <select>)";
|
|
167
|
+
/** Hidden: start of the reason for a clipping container with no area, followed by it */
|
|
168
|
+
readonly clippedBy: "clipped by ";
|
|
169
|
+
/** Which size of that container is zero */
|
|
170
|
+
readonly zeroHeight: "zero height";
|
|
171
|
+
readonly zeroWidth: "zero width";
|
|
172
|
+
/** Invisible: fully transparent */
|
|
173
|
+
readonly transparent: "opacity: 0";
|
|
174
|
+
/** Joins an invisible reason to the ancestor causing it */
|
|
175
|
+
readonly on: " on ";
|
|
176
|
+
};
|
|
177
|
+
/**
|
|
178
|
+
* Off-screen reason for an element out of view on a page whose scrolling is
|
|
179
|
+
* locked, naming the visible dialog that likely locked it when there is one.
|
|
180
|
+
*
|
|
181
|
+
* @param lock - What locks it, e.g. `overflow: hidden on body`
|
|
182
|
+
* @param dialog - Visible dialog on the page, e.g. `div#consent` (null: none)
|
|
183
|
+
* @returns e.g. `page scrolling is locked (overflow: hidden on body), likely by dialog div#consent`,
|
|
184
|
+
* or `page scrolling is locked (overflow: hidden on body)`
|
|
185
|
+
*/
|
|
186
|
+
export declare function scrollLockedReason(lock: string, dialog?: string | null): string;
|
|
187
|
+
/**
|
|
188
|
+
* Location hint for an element outside the viewport or hidden.
|
|
189
|
+
*
|
|
190
|
+
* @param position - Where the element is
|
|
191
|
+
* @param clippedBy - Ancestor or iframe cutting it off, if any
|
|
192
|
+
* @returns e.g. "below fold", "out of view in ul#list"; undefined for
|
|
193
|
+
* elements (partly) in view
|
|
194
|
+
*/
|
|
195
|
+
export declare function viewportPositionHint(position: ViewportPosition, clippedBy?: string): string | undefined;
|
|
196
|
+
/** What {@link layoutPositionLabel} reads of an element */
|
|
197
|
+
type LabelledLayout = Pick<ElementLayout, 'inViewport' | 'percentVisible' | 'hiddenReason' | 'scrollBy' | 'clippedBy' | 'offScreenReason' | 'bounds'>;
|
|
198
|
+
/**
|
|
199
|
+
* Where an element is relative to the viewport, for `bdg dom layout`.
|
|
200
|
+
*
|
|
201
|
+
* @param element - Element layout
|
|
202
|
+
* @param viewport - Viewport size, when known
|
|
203
|
+
* @returns e.g. "visible", "partly visible (40%); scroll down 302px to see all of it",
|
|
204
|
+
* "below fold (scroll down 760px to centre it)",
|
|
205
|
+
* "out of view in ul#list (below)", "hidden (display: none)",
|
|
206
|
+
* "left of viewport (off-screen: beyond the page's scroll range)",
|
|
207
|
+
* "below fold; page scrolling is locked (overflow: hidden on body), likely by dialog div#consent"
|
|
208
|
+
*/
|
|
209
|
+
export declare function layoutPositionLabel(element: LabelledLayout, viewport?: LayoutSize): string;
|
|
210
|
+
/**
|
|
211
|
+
* The `prefers-color-scheme` media feature the page sees, labelled as the
|
|
212
|
+
* preference it is (the page may still render its own theme), and where it
|
|
213
|
+
* comes from.
|
|
214
|
+
*
|
|
215
|
+
* @param scheme - Light or dark
|
|
216
|
+
* @param emulated - Set with `--color-scheme` or `page emulate` (otherwise the system setting)
|
|
217
|
+
* @returns e.g. `prefers-color-scheme: dark (from the system setting)`
|
|
218
|
+
*/
|
|
219
|
+
export declare function colorSchemeLabel(scheme: string, emulated: boolean): string;
|
|
220
|
+
/**
|
|
221
|
+
* First line of `bdg status` for a running session.
|
|
222
|
+
*
|
|
223
|
+
* @param page - URL and title of the page, when the session reported them
|
|
224
|
+
* @returns e.g. `Session active: https://example.com/ — Example Domain`
|
|
225
|
+
*/
|
|
226
|
+
export declare function sessionActiveLine(page?: {
|
|
227
|
+
url: string;
|
|
228
|
+
title: string;
|
|
229
|
+
}): string;
|
|
230
|
+
/**
|
|
231
|
+
* Page dimensions line of `bdg dom layout`.
|
|
232
|
+
*
|
|
233
|
+
* @param page - Viewport, scroll position, document size and the color scheme the page is told to prefer
|
|
234
|
+
* @returns e.g. "Page: viewport 1280×720, scrolled to 0,0, document 1280×2400, prefers-color-scheme: dark"
|
|
235
|
+
*/
|
|
236
|
+
export declare function pageLayoutLine(page: PageLayout): string;
|
|
237
|
+
/**
|
|
238
|
+
* Headline of `bdg dom layout`.
|
|
239
|
+
*
|
|
240
|
+
* @param count - Elements matched
|
|
241
|
+
* @param listed - Elements reported (fewer with --index)
|
|
242
|
+
* @param selector - Selector they matched
|
|
243
|
+
* @returns e.g. '3 elements match "button" (page x,y and size in CSS px):',
|
|
244
|
+
* '1 of 3 elements matching "button" (...)'
|
|
245
|
+
*/
|
|
246
|
+
export declare function layoutHeadline(count: number, listed: number, selector: string): string;
|
|
247
|
+
/**
|
|
248
|
+
* Headline of `bdg dom layout` for a cached index.
|
|
249
|
+
*
|
|
250
|
+
* @param target - The index and the list it refers to, in words
|
|
251
|
+
* @returns e.g. `Element at index 0 of the last dom query "h3" (page x,y and size in CSS px):`
|
|
252
|
+
*/
|
|
253
|
+
export declare function indexLayoutHeadline(target: string): string;
|
|
254
|
+
/** Help text explaining `bdg dom inspect`'s output notation */
|
|
255
|
+
export declare const INSPECT_OUTPUT_LEGEND = "\nOutput notation:\n WxH @x,y rendered border box size and page position (CSS px, no unit)\n m / p / b margin / padding / border widths, 1-4 values in CSS order (top right bottom left)\n in-parent distances to the parent's content edges (l t r b); sib: gaps to the sibling on each side\n scroll WxH the content (pseudo-elements too) is larger than the box\n 16/24 font size / line height; 'webfont loaded' = drawn with a downloaded font;\n (rendered \"X\") = drawn with another font than declared (a fallback)\n contrast 4.47 WCAG ratio, rounded down, against the background behind the text\n (+N not rendered) children with display: none (or not in the layout)\n hints declarations on this element that have no effect, why, the fix and where they are\n ('none': checked, nothing found)\n \u2190 sel (file:N) --rules: the declaration that sets the value (file:line, or file:line:column in\n minified files); 'over X': rules it beats; '= v': the value of a var() expression\n \u2713 / \u2717 --why: the winning declaration / ones it beats, highest precedence first;\n [0,2,0]: selector specificity (ids, classes, types); indented --name lines: where\n the winner's custom properties are set\nSessions follow the system color scheme; start with --color-scheme light|dark to choose.";
|
|
256
|
+
/**
|
|
257
|
+
* What covers an element: a cover that paints nothing at that point (a
|
|
258
|
+
* transparent box over it) does not hide it, but takes its clicks.
|
|
259
|
+
*
|
|
260
|
+
* @param cover - Description of the covering element
|
|
261
|
+
* @param transparent - The cover paints nothing there
|
|
262
|
+
* @returns e.g. `covered by div#modal`, `under transparent ul.filters (clicks land on it)`
|
|
263
|
+
*/
|
|
264
|
+
export declare function coverText(cover: string, transparent: boolean | undefined): string;
|
|
265
|
+
/**
|
|
266
|
+
* Note when `bdg dom inspect` could not read the element's matched rules, so
|
|
267
|
+
* no hints, rules or why were computed.
|
|
268
|
+
*
|
|
269
|
+
* @param reason - `timeout` (very large stylesheets) or `failed` (Chrome reported an error)
|
|
270
|
+
* @returns Note
|
|
271
|
+
*/
|
|
272
|
+
export declare function inspectCascadeNote(reason: 'timeout' | 'failed'): string;
|
|
273
|
+
/**
|
|
274
|
+
* Header badge of `bdg dom inspect` when the page is shown in its dark theme
|
|
275
|
+
* because the session follows the system's dark preference: the colors are
|
|
276
|
+
* the dark theme's, not what a light-mode visitor sees.
|
|
277
|
+
*
|
|
278
|
+
* @returns Badge
|
|
279
|
+
*/
|
|
280
|
+
export declare function inspectDarkThemeBadge(): string;
|
|
281
|
+
/**
|
|
282
|
+
* Header badges of `bdg dom inspect` for what keeps an element from being seen.
|
|
283
|
+
*
|
|
284
|
+
* @param visibility - Not rendered, hidden, offscreen, covered
|
|
285
|
+
* @returns e.g. `[not rendered: display: none]`, `[offscreen: below]`, `[covered by div#modal]`
|
|
34
286
|
*/
|
|
35
|
-
export declare function
|
|
287
|
+
export declare function inspectVisibilityBadges(visibility: InspectVisibility): string[];
|
|
288
|
+
/**
|
|
289
|
+
* What `bdg dom inspect` did when several elements matched and no --index was given.
|
|
290
|
+
*
|
|
291
|
+
* @param picked - How the match was chosen
|
|
292
|
+
* @param index - Index of the inspected match
|
|
293
|
+
* @returns e.g. "inspected the first visible one ([2])"
|
|
294
|
+
*/
|
|
295
|
+
export declare function inspectedMatchAction(picked: 'first-visible' | 'first', index: number): string;
|
|
36
296
|
/**
|
|
37
297
|
* Warning when a selector matched several elements and no --index was given.
|
|
38
298
|
*
|
|
@@ -41,14 +301,55 @@ export declare function moreMatchesNote(hidden: number): string;
|
|
|
41
301
|
* @returns Warning text
|
|
42
302
|
*/
|
|
43
303
|
export declare function multipleMatchesWarning(count: number, action: string): string;
|
|
304
|
+
/** Listeners found, by where they are attached */
|
|
305
|
+
export interface ListenerCounts {
|
|
306
|
+
target: number;
|
|
307
|
+
ancestor: number;
|
|
308
|
+
/** On the document and the window */
|
|
309
|
+
global: number;
|
|
310
|
+
}
|
|
44
311
|
/**
|
|
45
|
-
* Headline of `bdg dom listeners
|
|
312
|
+
* Headline of `bdg dom listeners`, saying where the counted listeners are:
|
|
313
|
+
* the list covers the element, its ancestors, its document and window.
|
|
46
314
|
*
|
|
47
315
|
* @param element - Inspected element, e.g. "button#save"
|
|
48
|
-
* @param
|
|
49
|
-
* @
|
|
316
|
+
* @param counts - Listeners found, by placement
|
|
317
|
+
* @param context - Index of the element and the iframe it is in, if any
|
|
318
|
+
* @returns e.g. "Event listeners for button#save (156: 3 on the element, 120 on ancestors, 33 on document and window)"
|
|
50
319
|
*/
|
|
51
|
-
export declare function listenersHeadline(element: string,
|
|
320
|
+
export declare function listenersHeadline(element: string, counts: ListenerCounts, context?: {
|
|
321
|
+
index?: number | undefined;
|
|
322
|
+
frame?: string | undefined;
|
|
323
|
+
}): string;
|
|
324
|
+
/** Heading of the collapsed framework root listeners */
|
|
325
|
+
export declare const COLLAPSED_LISTENERS_HEADING = "Framework roots (one line per node; --all lists each listener):";
|
|
326
|
+
/**
|
|
327
|
+
* One collapsed framework root.
|
|
328
|
+
*
|
|
329
|
+
* @param root - Framework label, event types, phases and dispatcher names
|
|
330
|
+
* @returns e.g. "React root: 90 event types, capture and bubble (dispatchEvent, …)"
|
|
331
|
+
*/
|
|
332
|
+
export declare function collapsedListenersSummary(root: {
|
|
333
|
+
framework?: string | undefined;
|
|
334
|
+
types: string[];
|
|
335
|
+
capture: boolean;
|
|
336
|
+
bubble: boolean;
|
|
337
|
+
handlers: string[];
|
|
338
|
+
}): string;
|
|
339
|
+
/**
|
|
340
|
+
* jQuery handlers left unresolved because there were too many.
|
|
341
|
+
*
|
|
342
|
+
* @param count - Handlers not resolved
|
|
343
|
+
* @returns One-line note
|
|
344
|
+
*/
|
|
345
|
+
export declare function jqueryHandlersSkippedNote(count: number): string;
|
|
346
|
+
/**
|
|
347
|
+
* Event types a mistyped `--type` probably meant.
|
|
348
|
+
*
|
|
349
|
+
* @param types - Suggested types
|
|
350
|
+
* @returns e.g. "Did you mean: --type click?"
|
|
351
|
+
*/
|
|
352
|
+
export declare function eventTypeSuggestion(types: string[]): string;
|
|
52
353
|
/**
|
|
53
354
|
* `bdg dom listeners` found nothing.
|
|
54
355
|
*
|
|
@@ -60,12 +361,19 @@ export declare function noListenersMessage(element: string, types?: string[]): s
|
|
|
60
361
|
/** What `bdg dom listeners` covers, shown when it found nothing */
|
|
61
362
|
export declare const NO_LISTENERS_HINT = "Inline on\u2026 attributes and on\u2026 properties are included, and so are handlers frameworks delegate to ancestors (React, jQuery)";
|
|
62
363
|
/**
|
|
63
|
-
* Note for event types
|
|
364
|
+
* Note for interaction event types the element has no listener of its own for.
|
|
365
|
+
*
|
|
366
|
+
* @param note - How the types reach their handlers
|
|
367
|
+
* @returns One-line note, or undefined when the listed handlers say it all
|
|
368
|
+
*/
|
|
369
|
+
export declare function delegationNote(note: DelegationNote): string | undefined;
|
|
370
|
+
/**
|
|
371
|
+
* React prop handlers left unresolved because there were too many.
|
|
64
372
|
*
|
|
65
|
-
* @param
|
|
373
|
+
* @param count - Handlers not resolved
|
|
66
374
|
* @returns One-line note
|
|
67
375
|
*/
|
|
68
|
-
export declare function
|
|
376
|
+
export declare function reactHandlersSkippedNote(count: number): string;
|
|
69
377
|
/**
|
|
70
378
|
* A JavaScript dialog bdg accepted, as one line.
|
|
71
379
|
*
|
|
@@ -83,6 +391,13 @@ export declare const POINTER_ACTION_DONE: {
|
|
|
83
391
|
readonly right: "Right-clicked";
|
|
84
392
|
readonly hover: "Hovered";
|
|
85
393
|
};
|
|
394
|
+
/** What each pointer action is called in notes ("when the click returned") */
|
|
395
|
+
export declare const POINTER_ACTION_NOUN: {
|
|
396
|
+
readonly click: "click";
|
|
397
|
+
readonly double: "double-click";
|
|
398
|
+
readonly right: "right-click";
|
|
399
|
+
readonly hover: "hover";
|
|
400
|
+
};
|
|
86
401
|
/** Headline of each `bdg page` action */
|
|
87
402
|
export declare const PAGE_ACTION_DONE: {
|
|
88
403
|
readonly navigate: "Navigated";
|
|
@@ -90,6 +405,10 @@ export declare const PAGE_ACTION_DONE: {
|
|
|
90
405
|
readonly back: "Went back";
|
|
91
406
|
readonly forward: "Went forward";
|
|
92
407
|
};
|
|
408
|
+
/** Description of `bdg page info` */
|
|
409
|
+
export declare const PAGE_INFO_DESCRIPTION = "Show the URL and title of the session page";
|
|
410
|
+
/** Description of `bdg page emulate` */
|
|
411
|
+
export declare const PAGE_EMULATE_DESCRIPTION = "Change the viewport or color scheme mid-session (like --viewport and --color-scheme at start), or --reset both";
|
|
93
412
|
/** Help text of the `bdg page` history commands */
|
|
94
413
|
export declare const PAGE_ACTION_DESCRIPTIONS: {
|
|
95
414
|
readonly reload: "Reload the page";
|
|
@@ -97,12 +416,18 @@ export declare const PAGE_ACTION_DESCRIPTIONS: {
|
|
|
97
416
|
readonly forward: "Go forward one page (like the browser button)";
|
|
98
417
|
};
|
|
99
418
|
/**
|
|
100
|
-
* `bdg page navigate`
|
|
419
|
+
* `bdg page navigate|reload|back|forward` when the document answered with an
|
|
420
|
+
* error status, or the page then loaded another document that answered
|
|
421
|
+
* differently (a 404 page whose script loads the app).
|
|
101
422
|
*
|
|
102
|
-
* @param status - HTTP status
|
|
103
|
-
* @
|
|
423
|
+
* @param status - HTTP status of the navigation's document
|
|
424
|
+
* @param later - The last document the page loaded afterwards, if any
|
|
425
|
+
* @returns Warning, or undefined when there is nothing to report
|
|
104
426
|
*/
|
|
105
|
-
export declare function
|
|
427
|
+
export declare function documentStatusWarning(status: number, later?: {
|
|
428
|
+
status: number;
|
|
429
|
+
url: string;
|
|
430
|
+
}): string | undefined;
|
|
106
431
|
/**
|
|
107
432
|
* `bdg page navigate` to a URL that loaded no page.
|
|
108
433
|
*
|
|
@@ -116,6 +441,60 @@ export declare function notAPageWarning(): string;
|
|
|
116
441
|
* @returns Warning
|
|
117
442
|
*/
|
|
118
443
|
export declare function stillLoadingWarning(ms: number): string;
|
|
444
|
+
/**
|
|
445
|
+
* Requests still running, the longest-running first, in words.
|
|
446
|
+
*
|
|
447
|
+
* @param pending - The requests to name
|
|
448
|
+
* @param count - All requests still running
|
|
449
|
+
* @returns e.g. `GET …/app.js (pending 30s) and 2 more`
|
|
450
|
+
*/
|
|
451
|
+
export declare function pendingRequestsText(pending: PendingRequestInfo[], count: number): string;
|
|
452
|
+
/**
|
|
453
|
+
* How far a page request got, in words.
|
|
454
|
+
*
|
|
455
|
+
* @param request - The page request
|
|
456
|
+
* @returns e.g. `POST …/authenticate pending for 30s`, `POST …/authenticate returned 503 Service Unavailable`,
|
|
457
|
+
* `POST …/authenticate failed (net::ERR_CONNECTION_REFUSED)`
|
|
458
|
+
*/
|
|
459
|
+
export declare function documentRequestText(request: DocumentRequestState): string;
|
|
460
|
+
/**
|
|
461
|
+
* Start and `bdg page` when the document has not finished loading within
|
|
462
|
+
* the readiness wait: its readyState and the requests it is waiting on.
|
|
463
|
+
*
|
|
464
|
+
* @param state - Loading state of the page
|
|
465
|
+
* @returns Warning, e.g. `The page is still loading (document.readyState: loading); waiting on: GET …/jquery-ui.js (pending 30s)`
|
|
466
|
+
*/
|
|
467
|
+
export declare function pageLoadingWarning(state: PageLoadingState): string;
|
|
468
|
+
/**
|
|
469
|
+
* Help of `dom click`/`submit`: they wait for the network only, so results a
|
|
470
|
+
* page shows later (timers, spinners, animations) are waited for with `dom wait`.
|
|
471
|
+
*/
|
|
472
|
+
export declare const CLICK_RESULT_WAIT_HELP: string;
|
|
473
|
+
/** Examples in the help of `bdg dom wait` */
|
|
474
|
+
export declare const WAIT_HELP_EXAMPLES: string;
|
|
475
|
+
/**
|
|
476
|
+
* The elements `bdg dom wait` waits for.
|
|
477
|
+
*
|
|
478
|
+
* @param condition - What is waited for
|
|
479
|
+
* @returns e.g. `#finish with text "hello world"`
|
|
480
|
+
*/
|
|
481
|
+
export declare function waitTargetLabel(condition: WaitCondition): string;
|
|
482
|
+
/**
|
|
483
|
+
* One-line result of `bdg dom wait`.
|
|
484
|
+
*
|
|
485
|
+
* @param condition - What was waited for
|
|
486
|
+
* @param elapsedMs - How long it took
|
|
487
|
+
* @returns e.g. `✓ div#finish visible after 5.1s`
|
|
488
|
+
*/
|
|
489
|
+
export declare function waitMetMessage(condition: WaitCondition, elapsedMs: number): string;
|
|
490
|
+
/**
|
|
491
|
+
* What the page showed, for a `bdg dom wait` that timed out.
|
|
492
|
+
*
|
|
493
|
+
* @param snapshot - Last thing the page reported
|
|
494
|
+
* @param condition - What was waited for
|
|
495
|
+
* @returns e.g. `2 matches, none visible` or `document.readyState: loading`
|
|
496
|
+
*/
|
|
497
|
+
export declare function waitSnapshotSummary(snapshot: WaitSnapshot, condition: WaitCondition): string;
|
|
119
498
|
/**
|
|
120
499
|
* One line describing an iframe: index, URL, name/id, and how it is isolated.
|
|
121
500
|
*
|
|
@@ -123,12 +502,65 @@ export declare function stillLoadingWarning(ms: number): string;
|
|
|
123
502
|
* @returns e.g. `[1] https://pay.example/ #checkout cross-origin, out-of-process`
|
|
124
503
|
*/
|
|
125
504
|
export declare function frameLabel(frame: DomFrame): string;
|
|
505
|
+
/**
|
|
506
|
+
* A frame URL for human output: shortened, and named when empty.
|
|
507
|
+
*
|
|
508
|
+
* @param url - Frame URL
|
|
509
|
+
* @returns e.g. `https://pay.example/checkout?…`, or `(no URL)`
|
|
510
|
+
*/
|
|
511
|
+
export declare function frameUrlLabel(url: string): string;
|
|
126
512
|
/**
|
|
127
513
|
* `bdg dom frames` on a page without iframes.
|
|
128
514
|
*
|
|
129
515
|
* @returns Message
|
|
130
516
|
*/
|
|
131
517
|
export declare function noFramesMessage(): string;
|
|
518
|
+
/**
|
|
519
|
+
* `bdg dom frames` while the page is still loading: its iframes may not
|
|
520
|
+
* exist yet.
|
|
521
|
+
*
|
|
522
|
+
* @param empty - No iframe was found
|
|
523
|
+
* @returns e.g. `No iframes yet; the page is still loading, so the list may be incomplete (bdg dom wait --load)`
|
|
524
|
+
*/
|
|
525
|
+
export declare function framesStillLoadingNote(empty: boolean): string;
|
|
526
|
+
/**
|
|
527
|
+
* Text of an element in `bdg dom get` output.
|
|
528
|
+
*
|
|
529
|
+
* @param text - Collapsed text, ending in `...` when it was cut
|
|
530
|
+
* @returns e.g. `Text: Welcome to ... (cut at 500 characters; --full shows all of it)`
|
|
531
|
+
*/
|
|
532
|
+
export declare function elementTextLine(text: string): string;
|
|
533
|
+
/**
|
|
534
|
+
* What an element without text holds, in `bdg dom get` output.
|
|
535
|
+
*
|
|
536
|
+
* @param children - First child elements, e.g. `iframe#app`
|
|
537
|
+
* @param count - Number of child elements
|
|
538
|
+
* @returns e.g. `No text; holds 1 element: iframe (see its HTML with --raw)`
|
|
539
|
+
*/
|
|
540
|
+
export declare function emptyElementLine(children: string[], count: number): string;
|
|
541
|
+
/**
|
|
542
|
+
* Note on an element screenshot that captured more than the element's border
|
|
543
|
+
* box, because content (floats, positioned children) overflows it.
|
|
544
|
+
*
|
|
545
|
+
* @param box - Border box
|
|
546
|
+
* @param captured - Area captured
|
|
547
|
+
* @returns e.g. `grown from 940×37 to 940×285 to include content overflowing the element`
|
|
548
|
+
*/
|
|
549
|
+
export declare function screenshotGrownNote(box: {
|
|
550
|
+
width: number;
|
|
551
|
+
height: number;
|
|
552
|
+
}, captured: {
|
|
553
|
+
width: number;
|
|
554
|
+
height: number;
|
|
555
|
+
}): string;
|
|
556
|
+
/**
|
|
557
|
+
* Next commands after `bdg dom query`, by index so they reach matches in
|
|
558
|
+
* shadow roots and iframes too.
|
|
559
|
+
*
|
|
560
|
+
* @param index - Match to use in the examples
|
|
561
|
+
* @returns One line
|
|
562
|
+
*/
|
|
563
|
+
export declare function queryNextSteps(index: number): string;
|
|
132
564
|
/**
|
|
133
565
|
* Header of `bdg dom eval --frame` output naming the frame the script ran in.
|
|
134
566
|
*
|
|
@@ -161,6 +593,13 @@ export declare function sessionOutputRemovedMessage(): string;
|
|
|
161
593
|
* @returns Formatted success message
|
|
162
594
|
*/
|
|
163
595
|
export declare function sessionDirectoryCleanMessage(): string;
|
|
596
|
+
/**
|
|
597
|
+
* `bdg cleanup --purge` deleted a named session's directory.
|
|
598
|
+
*
|
|
599
|
+
* @param dir - Deleted directory
|
|
600
|
+
* @returns Message
|
|
601
|
+
*/
|
|
602
|
+
export declare function sessionDirectoryPurgedMessage(dir: string): string;
|
|
164
603
|
/**
|
|
165
604
|
* Generate no session files found message.
|
|
166
605
|
*
|
|
@@ -174,6 +613,13 @@ export declare function noSessionFilesMessage(): string;
|
|
|
174
613
|
* @returns Formatted error message
|
|
175
614
|
*/
|
|
176
615
|
export declare function sessionStillActiveError(pid: number): string;
|
|
616
|
+
/**
|
|
617
|
+
* How to clean up a session that is still running.
|
|
618
|
+
*
|
|
619
|
+
* @param session - Name of a named session, or null for the default session
|
|
620
|
+
* @returns Suggestion lines
|
|
621
|
+
*/
|
|
622
|
+
export declare function sessionStillActiveSuggestion(session: string | null): string;
|
|
177
623
|
/**
|
|
178
624
|
* Generate help message when no URL is provided to start command.
|
|
179
625
|
*
|
|
@@ -189,4 +635,48 @@ export declare function sessionStillActiveError(pid: number): string;
|
|
|
189
635
|
* @returns Multi-line help message with examples
|
|
190
636
|
* */
|
|
191
637
|
export declare function startCommandHelpMessage(): string;
|
|
638
|
+
/**
|
|
639
|
+
* `bdg page emulate` without anything to change.
|
|
640
|
+
*
|
|
641
|
+
* @returns Message and suggestion
|
|
642
|
+
*/
|
|
643
|
+
export declare function pageEmulateNothingError(): {
|
|
644
|
+
message: string;
|
|
645
|
+
suggestion: string;
|
|
646
|
+
};
|
|
647
|
+
/**
|
|
648
|
+
* Lines of `bdg page emulate`: what is emulated and what the page now has.
|
|
649
|
+
*
|
|
650
|
+
* @param result - Emulation and page appearance
|
|
651
|
+
* @returns Label/value pairs
|
|
652
|
+
*/
|
|
653
|
+
export declare function pageEmulationLines(result: {
|
|
654
|
+
emulated: {
|
|
655
|
+
viewport?: {
|
|
656
|
+
width: number;
|
|
657
|
+
height: number;
|
|
658
|
+
};
|
|
659
|
+
colorScheme?: string;
|
|
660
|
+
};
|
|
661
|
+
viewport?: {
|
|
662
|
+
width: number;
|
|
663
|
+
height: number;
|
|
664
|
+
};
|
|
665
|
+
colorScheme?: string;
|
|
666
|
+
}): Array<[string, string]>;
|
|
667
|
+
/**
|
|
668
|
+
* Header badge of `bdg dom inspect` while CSS transitions or animations run
|
|
669
|
+
* on the element: the values read are mid-way.
|
|
670
|
+
*
|
|
671
|
+
* @param animating - Transitioned properties and animation names
|
|
672
|
+
* @returns e.g. `[animating: background-color; values are mid-way, inspect again]`
|
|
673
|
+
*/
|
|
674
|
+
export declare function inspectAnimatingBadge(animating: readonly string[]): string;
|
|
675
|
+
/**
|
|
676
|
+
* `--why` note on a computed value read during its transition.
|
|
677
|
+
*
|
|
678
|
+
* @returns Note
|
|
679
|
+
*/
|
|
680
|
+
export declare function inspectMidTransitionNote(): string;
|
|
681
|
+
export {};
|
|
192
682
|
//# sourceMappingURL=commands.d.ts.map
|