diff --git a/docs/api/README.md b/docs/api/README.md index 51cddb2f..43e7becf 100644 --- a/docs/api/README.md +++ b/docs/api/README.md @@ -4,15 +4,50 @@ ## Table of contents -### Namespaces +### References -- [Schema](modules/Schema.md) +- [AssertedEvent](README.md#assertedevent) +- [AssertedEventType](README.md#assertedeventtype) +- [AssertionStep](README.md#assertionstep) +- [BaseStep](README.md#basestep) +- [ChangeStep](README.md#changestep) +- [ClickAttributes](README.md#clickattributes) +- [ClickStep](README.md#clickstep) +- [CloseStep](README.md#closestep) +- [CustomStep](README.md#customstep) +- [CustomStepParams](README.md#customstepparams) +- [DoubleClickStep](README.md#doubleclickstep) +- [EmulateNetworkConditionsStep](README.md#emulatenetworkconditionsstep) +- [FrameSelector](README.md#frameselector) +- [HoverStep](README.md#hoverstep) +- [Key](README.md#key) +- [KeyDownStep](README.md#keydownstep) +- [KeyUpStep](README.md#keyupstep) +- [NavigateStep](README.md#navigatestep) +- [NavigationEvent](README.md#navigationevent) +- [Pattern](README.md#pattern) +- [PointerButtonType](README.md#pointerbuttontype) +- [PointerDeviceType](README.md#pointerdevicetype) +- [ScrollElementStep](README.md#scrollelementstep) +- [ScrollPageStep](README.md#scrollpagestep) +- [ScrollStep](README.md#scrollstep) +- [Selector](README.md#selector) +- [SelectorType](README.md#selectortype) +- [SetViewportStep](README.md#setviewportstep) +- [Step](README.md#step) +- [StepType](README.md#steptype) +- [StepWithFrame](README.md#stepwithframe) +- [StepWithSelectors](README.md#stepwithselectors) +- [StepWithTarget](README.md#stepwithtarget) +- [Target](README.md#target) +- [UserFlow](README.md#userflow) +- [UserStep](README.md#userstep) +- [WaitForElementStep](README.md#waitforelementstep) +- [WaitForExpressionStep](README.md#waitforexpressionstep) -### Enumerations +### Namespaces -- [AssertedEventType](enums/AssertedEventType.md) -- [SelectorType](enums/SelectorType.md) -- [StepType](enums/StepType.md) +- [Schema](modules/Schema.md) ### Classes @@ -29,47 +64,12 @@ ### Interfaces -- [BaseStep](interfaces/BaseStep.md) -- [ChangeStep](interfaces/ChangeStep.md) -- [ClickAttributes](interfaces/ClickAttributes.md) -- [ClickStep](interfaces/ClickStep.md) -- [CloseStep](interfaces/CloseStep.md) -- [CustomStepParams](interfaces/CustomStepParams.md) -- [DoubleClickStep](interfaces/DoubleClickStep.md) -- [EmulateNetworkConditionsStep](interfaces/EmulateNetworkConditionsStep.md) -- [HoverStep](interfaces/HoverStep.md) -- [KeyDownStep](interfaces/KeyDownStep.md) -- [KeyUpStep](interfaces/KeyUpStep.md) - [LineWriter](interfaces/LineWriter.md) -- [NavigateStep](interfaces/NavigateStep.md) -- [NavigationEvent](interfaces/NavigationEvent.md) -- [ScrollPageStep](interfaces/ScrollPageStep.md) -- [SetViewportStep](interfaces/SetViewportStep.md) -- [StepWithFrame](interfaces/StepWithFrame.md) -- [StepWithSelectors](interfaces/StepWithSelectors.md) -- [StepWithTarget](interfaces/StepWithTarget.md) - [StringifyOptions](interfaces/StringifyOptions.md) -- [UserFlow](interfaces/UserFlow.md) -- [WaitForElementStep](interfaces/WaitForElementStep.md) -- [WaitForExpressionStep](interfaces/WaitForExpressionStep.md) ### Type Aliases -- [AssertedEvent](README.md#assertedevent) -- [AssertionStep](README.md#assertionstep) -- [CustomStep](README.md#customstep) -- [FrameSelector](README.md#frameselector) -- [Key](README.md#key) -- [Pattern](README.md#pattern) -- [PointerButtonType](README.md#pointerbuttontype) -- [PointerDeviceType](README.md#pointerdevicetype) -- [ScrollElementStep](README.md#scrollelementstep) -- [ScrollStep](README.md#scrollstep) -- [Selector](README.md#selector) - [SourceMap](README.md#sourcemap) -- [Step](README.md#step) -- [Target](README.md#target) -- [UserStep](README.md#userstep) ### Variables @@ -95,157 +95,245 @@ - [stripSourceMap](README.md#stripsourcemap) - [validTimeout](README.md#validtimeout) -## Type Aliases +## References ### AssertedEvent -Ƭ **AssertedEvent**: [`NavigationEvent`](interfaces/Schema.NavigationEvent.md) +Re-exports [AssertedEvent](modules/Schema.md#assertedevent) -#### Defined in +--- + +### AssertedEventType -[Schema.ts:59](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L59) +Re-exports [AssertedEventType](enums/Schema.AssertedEventType.md) --- ### AssertionStep -Ƭ **AssertionStep**: [`WaitForElementStep`](interfaces/Schema.WaitForElementStep.md) \| [`WaitForExpressionStep`](interfaces/Schema.WaitForExpressionStep.md) +Re-exports [AssertionStep](modules/Schema.md#assertionstep) -#### Defined in +--- + +### BaseStep + +Re-exports [BaseStep](interfaces/Schema.BaseStep.md) + +--- + +### ChangeStep + +Re-exports [ChangeStep](interfaces/Schema.ChangeStep.md) + +--- + +### ClickAttributes -[Schema.ts:296](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L296) +Re-exports [ClickAttributes](interfaces/Schema.ClickAttributes.md) + +--- + +### ClickStep + +Re-exports [ClickStep](interfaces/Schema.ClickStep.md) + +--- + +### CloseStep + +Re-exports [CloseStep](interfaces/Schema.CloseStep.md) --- ### CustomStep -Ƭ **CustomStep**: [`CustomStepParams`](interfaces/Schema.CustomStepParams.md) & [`StepWithTarget`](interfaces/Schema.StepWithTarget.md) \| [`CustomStepParams`](interfaces/Schema.CustomStepParams.md) & [`StepWithFrame`](interfaces/Schema.StepWithFrame.md) +Re-exports [CustomStep](modules/Schema.md#customstep) -#### Defined in +--- -[Schema.ts:213](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L213) +### CustomStepParams + +Re-exports [CustomStepParams](interfaces/Schema.CustomStepParams.md) + +--- + +### DoubleClickStep + +Re-exports [DoubleClickStep](interfaces/Schema.DoubleClickStep.md) + +--- + +### EmulateNetworkConditionsStep + +Re-exports [EmulateNetworkConditionsStep](interfaces/Schema.EmulateNetworkConditionsStep.md) --- ### FrameSelector -Ƭ **FrameSelector**: `number`[] +Re-exports [FrameSelector](modules/Schema.md#frameselector) -#### Defined in +--- + +### HoverStep -[Schema.ts:22](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L22) +Re-exports [HoverStep](interfaces/Schema.HoverStep.md) --- ### Key -Ƭ **Key**: `"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"` +Re-exports [Key](modules/Schema.md#key) -#### Defined in +--- -[Schema.ts:318](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L318) +### KeyDownStep + +Re-exports [KeyDownStep](interfaces/Schema.KeyDownStep.md) --- -### Pattern +### KeyUpStep -Ƭ **Pattern**: `string` +Re-exports [KeyUpStep](interfaces/Schema.KeyUpStep.md) -#### Defined in +--- + +### NavigateStep -[Schema.ts:20](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L20) +Re-exports [NavigateStep](interfaces/Schema.NavigateStep.md) --- -### PointerButtonType +### NavigationEvent -Ƭ **PointerButtonType**: `"primary"` \| `"auxiliary"` \| `"secondary"` \| `"back"` \| `"forward"` +Re-exports [NavigationEvent](interfaces/Schema.NavigationEvent.md) -#### Defined in +--- + +### Pattern -[Schema.ts:104](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L104) +Re-exports [Pattern](modules/Schema.md#pattern) --- -### PointerDeviceType +### PointerButtonType -Ƭ **PointerDeviceType**: `"mouse"` \| `"pen"` \| `"touch"` +Re-exports [PointerButtonType](modules/Schema.md#pointerbuttontype) -#### Defined in +--- -[Schema.ts:103](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L103) +### PointerDeviceType + +Re-exports [PointerDeviceType](modules/Schema.md#pointerdevicetype) --- ### ScrollElementStep -Ƭ **ScrollElementStep**: [`ScrollPageStep`](interfaces/Schema.ScrollPageStep.md) & [`StepWithSelectors`](interfaces/Schema.StepWithSelectors.md) +Re-exports [ScrollElementStep](modules/Schema.md#scrollelementstep) -#### Defined in +--- -[Schema.ts:198](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L198) +### ScrollPageStep + +Re-exports [ScrollPageStep](interfaces/Schema.ScrollPageStep.md) --- ### ScrollStep -Ƭ **ScrollStep**: [`ScrollPageStep`](interfaces/Schema.ScrollPageStep.md) \| [`ScrollElementStep`](modules/Schema.md#scrollelementstep) +Re-exports [ScrollStep](modules/Schema.md#scrollstep) -#### Defined in +--- + +### Selector -[Schema.ts:200](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L200) +Re-exports [Selector](modules/Schema.md#selector) --- -### Selector +### SelectorType -Ƭ **Selector**: `string` \| `string`[] +Re-exports [SelectorType](enums/Schema.SelectorType.md) -#### Defined in +--- + +### SetViewportStep -[Schema.ts:21](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L21) +Re-exports [SetViewportStep](interfaces/Schema.SetViewportStep.md) --- -### SourceMap +### Step -Ƭ **SourceMap**: `number`[] +Re-exports [Step](modules/Schema.md#step) -The format is [version, [lineNo, length], [lineNo, length] ... [lineNo, length]]. +--- -#### Defined in +### StepType -[stringify.ts:35](https://github.com/puppeteer/replay/blob/main/src/stringify.ts#L35) +Re-exports [StepType](enums/Schema.StepType.md) --- -### Step +### StepWithFrame -Ƭ **Step**: [`UserStep`](modules/Schema.md#userstep) \| [`AssertionStep`](modules/Schema.md#assertionstep) +Re-exports [StepWithFrame](interfaces/Schema.StepWithFrame.md) -#### Defined in +--- + +### StepWithSelectors -[Schema.ts:298](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L298) +Re-exports [StepWithSelectors](interfaces/Schema.StepWithSelectors.md) + +--- + +### StepWithTarget + +Re-exports [StepWithTarget](interfaces/Schema.StepWithTarget.md) --- ### Target -Ƭ **Target**: `string` +Re-exports [Target](modules/Schema.md#target) -#### Defined in +--- -[Schema.ts:19](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L19) +### UserFlow + +Re-exports [UserFlow](interfaces/Schema.UserFlow.md) --- ### UserStep -Ƭ **UserStep**: [`ChangeStep`](interfaces/Schema.ChangeStep.md) \| [`ClickStep`](interfaces/Schema.ClickStep.md) \| [`HoverStep`](interfaces/Schema.HoverStep.md) \| [`CloseStep`](interfaces/Schema.CloseStep.md) \| [`CustomStep`](modules/Schema.md#customstep) \| [`DoubleClickStep`](interfaces/Schema.DoubleClickStep.md) \| [`EmulateNetworkConditionsStep`](interfaces/Schema.EmulateNetworkConditionsStep.md) \| [`KeyDownStep`](interfaces/Schema.KeyDownStep.md) \| [`KeyUpStep`](interfaces/Schema.KeyUpStep.md) \| [`NavigateStep`](interfaces/Schema.NavigateStep.md) \| [`ScrollStep`](modules/Schema.md#scrollstep) \| [`SetViewportStep`](interfaces/Schema.SetViewportStep.md) +Re-exports [UserStep](modules/Schema.md#userstep) + +--- + +### WaitForElementStep + +Re-exports [WaitForElementStep](interfaces/Schema.WaitForElementStep.md) + +--- + +### WaitForExpressionStep + +Re-exports [WaitForExpressionStep](interfaces/Schema.WaitForExpressionStep.md) + +## Type Aliases + +### SourceMap + +Ƭ **SourceMap**: `number`[] + +The format is [version, [lineNo, length], [lineNo, length] ... [lineNo, length]]. #### Defined in -[Schema.ts:217](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L217) +[stringify.ts:35](https://github.com/puppeteer/replay/blob/main/src/stringify.ts#L35) ## Variables @@ -522,10 +610,6 @@ Extracts a source map from a text. Converts a selector or an array of selector parts into a Puppeteer selector. -**`See`** - -https://pptr.dev/guides/query-selectors#p-elements - #### Parameters | Name | Type | @@ -536,6 +620,10 @@ https://pptr.dev/guides/query-selectors#p-elements `string` +**`See`** + +https://pptr.dev/guides/query-selectors#p-elements + #### Defined in [SchemaUtils.ts:629](https://github.com/puppeteer/replay/blob/main/src/SchemaUtils.ts#L629) diff --git a/docs/api/classes/LighthouseRunnerExtension.md b/docs/api/classes/LighthouseRunnerExtension.md index 83aea877..5c75d7ad 100644 --- a/docs/api/classes/LighthouseRunnerExtension.md +++ b/docs/api/classes/LighthouseRunnerExtension.md @@ -44,7 +44,7 @@ #### Defined in -[PuppeteerRunnerExtension.ts:51](https://github.com/puppeteer/replay/blob/main/src/PuppeteerRunnerExtension.ts#L51) +[PuppeteerRunnerExtension.ts:45](https://github.com/puppeteer/replay/blob/main/src/PuppeteerRunnerExtension.ts#L45) ## Methods @@ -181,4 +181,4 @@ #### Defined in -[PuppeteerRunnerExtension.ts:72](https://github.com/puppeteer/replay/blob/main/src/PuppeteerRunnerExtension.ts#L72) +[PuppeteerRunnerExtension.ts:66](https://github.com/puppeteer/replay/blob/main/src/PuppeteerRunnerExtension.ts#L66) diff --git a/docs/api/classes/PuppeteerRunnerExtension.md b/docs/api/classes/PuppeteerRunnerExtension.md index cd74b04f..41f59c57 100644 --- a/docs/api/classes/PuppeteerRunnerExtension.md +++ b/docs/api/classes/PuppeteerRunnerExtension.md @@ -47,7 +47,7 @@ #### Defined in -[PuppeteerRunnerExtension.ts:51](https://github.com/puppeteer/replay/blob/main/src/PuppeteerRunnerExtension.ts#L51) +[PuppeteerRunnerExtension.ts:45](https://github.com/puppeteer/replay/blob/main/src/PuppeteerRunnerExtension.ts#L45) ## Methods @@ -170,4 +170,4 @@ #### Defined in -[PuppeteerRunnerExtension.ts:72](https://github.com/puppeteer/replay/blob/main/src/PuppeteerRunnerExtension.ts#L72) +[PuppeteerRunnerExtension.ts:66](https://github.com/puppeteer/replay/blob/main/src/PuppeteerRunnerExtension.ts#L66) diff --git a/docs/api/classes/PuppeteerRunnerOwningBrowserExtension.md b/docs/api/classes/PuppeteerRunnerOwningBrowserExtension.md index 1dc306af..6aa6324e 100644 --- a/docs/api/classes/PuppeteerRunnerOwningBrowserExtension.md +++ b/docs/api/classes/PuppeteerRunnerOwningBrowserExtension.md @@ -43,7 +43,7 @@ #### Defined in -[PuppeteerRunnerExtension.ts:51](https://github.com/puppeteer/replay/blob/main/src/PuppeteerRunnerExtension.ts#L51) +[PuppeteerRunnerExtension.ts:45](https://github.com/puppeteer/replay/blob/main/src/PuppeteerRunnerExtension.ts#L45) ## Methods @@ -61,7 +61,7 @@ #### Defined in -[PuppeteerRunnerExtension.ts:301](https://github.com/puppeteer/replay/blob/main/src/PuppeteerRunnerExtension.ts#L301) +[PuppeteerRunnerExtension.ts:285](https://github.com/puppeteer/replay/blob/main/src/PuppeteerRunnerExtension.ts#L285) --- @@ -160,4 +160,4 @@ #### Defined in -[PuppeteerRunnerExtension.ts:72](https://github.com/puppeteer/replay/blob/main/src/PuppeteerRunnerExtension.ts#L72) +[PuppeteerRunnerExtension.ts:66](https://github.com/puppeteer/replay/blob/main/src/PuppeteerRunnerExtension.ts#L66) diff --git a/docs/api/enums/AssertedEventType.md b/docs/api/enums/AssertedEventType.md deleted file mode 100644 index 4888a31f..00000000 --- a/docs/api/enums/AssertedEventType.md +++ /dev/null @@ -1,19 +0,0 @@ -[@puppeteer/replay](../README.md) / AssertedEventType - -# Enumeration: AssertedEventType - -## Table of contents - -### Enumeration Members - -- [Navigation](AssertedEventType.md#navigation) - -## Enumeration Members - -### Navigation - -• **Navigation** = `"navigation"` - -#### Defined in - -[Schema.ts:50](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L50) diff --git a/docs/api/enums/SelectorType.md b/docs/api/enums/SelectorType.md deleted file mode 100644 index a520a41e..00000000 --- a/docs/api/enums/SelectorType.md +++ /dev/null @@ -1,63 +0,0 @@ -[@puppeteer/replay](../README.md) / SelectorType - -# Enumeration: SelectorType - -## Table of contents - -### Enumeration Members - -- [ARIA](SelectorType.md#aria) -- [CSS](SelectorType.md#css) -- [Pierce](SelectorType.md#pierce) -- [Text](SelectorType.md#text) -- [XPath](SelectorType.md#xpath) - -## Enumeration Members - -### ARIA - -• **ARIA** = `"aria"` - -#### Defined in - -[Schema.ts:26](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L26) - ---- - -### CSS - -• **CSS** = `"css"` - -#### Defined in - -[Schema.ts:25](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L25) - ---- - -### Pierce - -• **Pierce** = `"pierce"` - -#### Defined in - -[Schema.ts:29](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L29) - ---- - -### Text - -• **Text** = `"text"` - -#### Defined in - -[Schema.ts:27](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L27) - ---- - -### XPath - -• **XPath** = `"xpath"` - -#### Defined in - -[Schema.ts:28](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L28) diff --git a/docs/api/enums/StepType.md b/docs/api/enums/StepType.md deleted file mode 100644 index 63ef4f9f..00000000 --- a/docs/api/enums/StepType.md +++ /dev/null @@ -1,162 +0,0 @@ -[@puppeteer/replay](../README.md) / StepType - -# Enumeration: StepType - -## Table of contents - -### Enumeration Members - -- [Change](StepType.md#change) -- [Click](StepType.md#click) -- [Close](StepType.md#close) -- [CustomStep](StepType.md#customstep) -- [DoubleClick](StepType.md#doubleclick) -- [EmulateNetworkConditions](StepType.md#emulatenetworkconditions) -- [Hover](StepType.md#hover) -- [KeyDown](StepType.md#keydown) -- [KeyUp](StepType.md#keyup) -- [Navigate](StepType.md#navigate) -- [Scroll](StepType.md#scroll) -- [SetViewport](StepType.md#setviewport) -- [WaitForElement](StepType.md#waitforelement) -- [WaitForExpression](StepType.md#waitforexpression) - -## Enumeration Members - -### Change - -• **Change** = `"change"` - -#### Defined in - -[Schema.ts:33](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L33) - ---- - -### Click - -• **Click** = `"click"` - -#### Defined in - -[Schema.ts:34](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L34) - ---- - -### Close - -• **Close** = `"close"` - -#### Defined in - -[Schema.ts:35](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L35) - ---- - -### CustomStep - -• **CustomStep** = `"customStep"` - -#### Defined in - -[Schema.ts:36](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L36) - ---- - -### DoubleClick - -• **DoubleClick** = `"doubleClick"` - -#### Defined in - -[Schema.ts:37](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L37) - ---- - -### EmulateNetworkConditions - -• **EmulateNetworkConditions** = `"emulateNetworkConditions"` - -#### Defined in - -[Schema.ts:38](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L38) - ---- - -### Hover - -• **Hover** = `"hover"` - -#### Defined in - -[Schema.ts:39](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L39) - ---- - -### KeyDown - -• **KeyDown** = `"keyDown"` - -#### Defined in - -[Schema.ts:40](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L40) - ---- - -### KeyUp - -• **KeyUp** = `"keyUp"` - -#### Defined in - -[Schema.ts:41](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L41) - ---- - -### Navigate - -• **Navigate** = `"navigate"` - -#### Defined in - -[Schema.ts:42](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L42) - ---- - -### Scroll - -• **Scroll** = `"scroll"` - -#### Defined in - -[Schema.ts:43](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L43) - ---- - -### SetViewport - -• **SetViewport** = `"setViewport"` - -#### Defined in - -[Schema.ts:44](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L44) - ---- - -### WaitForElement - -• **WaitForElement** = `"waitForElement"` - -#### Defined in - -[Schema.ts:45](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L45) - ---- - -### WaitForExpression - -• **WaitForExpression** = `"waitForExpression"` - -#### Defined in - -[Schema.ts:46](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L46) diff --git a/docs/api/interfaces/BaseStep.md b/docs/api/interfaces/BaseStep.md deleted file mode 100644 index d61a2e79..00000000 --- a/docs/api/interfaces/BaseStep.md +++ /dev/null @@ -1,41 +0,0 @@ -[@puppeteer/replay](../README.md) / BaseStep - -# Interface: BaseStep - -## Table of contents - -### Properties - -- [assertedEvents](BaseStep.md#assertedevents) -- [timeout](BaseStep.md#timeout) -- [type](BaseStep.md#type) - -## Properties - -### assertedEvents - -• `Optional` **assertedEvents**: [`NavigationEvent`](Schema.NavigationEvent.md)[] - -#### Defined in - -[Schema.ts:64](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L64) - ---- - -### timeout - -• `Optional` **timeout**: `number` - -#### Defined in - -[Schema.ts:63](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L63) - ---- - -### type - -• **type**: [`StepType`](../enums/Schema.StepType.md) - -#### Defined in - -[Schema.ts:62](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L62) diff --git a/docs/api/interfaces/ChangeStep.md b/docs/api/interfaces/ChangeStep.md deleted file mode 100644 index d39838f5..00000000 --- a/docs/api/interfaces/ChangeStep.md +++ /dev/null @@ -1,136 +0,0 @@ -[@puppeteer/replay](../README.md) / ChangeStep - -# Interface: ChangeStep - -## Hierarchy - -- [`StepWithSelectors`](Schema.StepWithSelectors.md) - - ↳ **`ChangeStep`** - -## Table of contents - -### Properties - -- [assertedEvents](ChangeStep.md#assertedevents) -- [frame](ChangeStep.md#frame) -- [selectors](ChangeStep.md#selectors) -- [target](ChangeStep.md#target) -- [timeout](ChangeStep.md#timeout) -- [type](ChangeStep.md#type) -- [value](ChangeStep.md#value) - -## Properties - -### assertedEvents - -• `Optional` **assertedEvents**: [`NavigationEvent`](Schema.NavigationEvent.md)[] - -#### Inherited from - -[StepWithSelectors](Schema.StepWithSelectors.md).[assertedEvents](Schema.StepWithSelectors.md#assertedevents) - -#### Defined in - -[Schema.ts:64](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L64) - ---- - -### frame - -• `Optional` **frame**: [`FrameSelector`](../modules/Schema.md#frameselector) - -Defaults to main frame - -#### Inherited from - -[StepWithSelectors](Schema.StepWithSelectors.md).[frame](Schema.StepWithSelectors.md#frame) - -#### Defined in - -[Schema.ts:78](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L78) - ---- - -### selectors - -• **selectors**: [`Selector`](../modules/Schema.md#selector)[] - -A list of alternative selectors that lead to selection of a single element -to perform the step on. Currently, we support CSS selectors, ARIA selectors -(start with 'aria/'), XPath selectors (start with `xpath/`) and text -selectors (start with `text/`). Each selector could be a string or an array -of strings. If it's a string, it means that the selector points directly to -the target element. If it's an array, the last element is the selector for -the target element and the preceding selectors point to the ancestor -elements. If the parent element is a shadow root host, the subsequent -selector is evaluated only against the shadow DOM of the host (i.e., -`parent.shadowRoot.querySelector`). If the parent element is not a shadow -root host, the subsequent selector is evaluated in the regular DOM (i.e., -`parent.querySelector`). - -During the execution, it's recommended that the implementation tries out -all of the alternative selectors to improve reliability of the replay as -some selectors might get outdated over time. - -#### Inherited from - -[StepWithSelectors](Schema.StepWithSelectors.md).[selectors](Schema.StepWithSelectors.md#selectors) - -#### Defined in - -[Schema.ts:100](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L100) - ---- - -### target - -• `Optional` **target**: `string` - -Defaults to main - -#### Inherited from - -[StepWithSelectors](Schema.StepWithSelectors.md).[target](Schema.StepWithSelectors.md#target) - -#### Defined in - -[Schema.ts:71](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L71) - ---- - -### timeout - -• `Optional` **timeout**: `number` - -#### Inherited from - -[StepWithSelectors](Schema.StepWithSelectors.md).[timeout](Schema.StepWithSelectors.md#timeout) - -#### Defined in - -[Schema.ts:63](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L63) - ---- - -### type - -• **type**: [`Change`](../enums/Schema.StepType.md#change) - -#### Overrides - -[StepWithSelectors](Schema.StepWithSelectors.md).[type](Schema.StepWithSelectors.md#type) - -#### Defined in - -[Schema.ts:151](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L151) - ---- - -### value - -• **value**: `string` - -#### Defined in - -[Schema.ts:152](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L152) diff --git a/docs/api/interfaces/ClickAttributes.md b/docs/api/interfaces/ClickAttributes.md deleted file mode 100644 index 11d54ed3..00000000 --- a/docs/api/interfaces/ClickAttributes.md +++ /dev/null @@ -1,79 +0,0 @@ -[@puppeteer/replay](../README.md) / ClickAttributes - -# Interface: ClickAttributes - -## Table of contents - -### Properties - -- [button](ClickAttributes.md#button) -- [deviceType](ClickAttributes.md#devicetype) -- [duration](ClickAttributes.md#duration) -- [offsetX](ClickAttributes.md#offsetx) -- [offsetY](ClickAttributes.md#offsety) - -## Properties - -### button - -• `Optional` **button**: [`PointerButtonType`](../modules/Schema.md#pointerbuttontype) - -Defaults to 'primary' if the device type is a mouse. - -#### Defined in - -[Schema.ts:119](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L119) - ---- - -### deviceType - -• `Optional` **deviceType**: [`PointerDeviceType`](../modules/Schema.md#pointerdevicetype) - -Pointer type for the event. Defaults to 'mouse'. - -#### Defined in - -[Schema.ts:115](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L115) - ---- - -### duration - -• `Optional` **duration**: `number` - -Delay (in ms) between the mouse up and mouse down of the click. - -**`Default Value`** - -`50` - -#### Defined in - -[Schema.ts:135](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L135) - ---- - -### offsetX - -• **offsetX**: `number` - -in px, relative to the top-left corner of the element content box. Defaults -to the center of the element - -#### Defined in - -[Schema.ts:124](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L124) - ---- - -### offsetY - -• **offsetY**: `number` - -in px, relative to the top-left corner of the element content box. Defaults -to the center of the element - -#### Defined in - -[Schema.ts:129](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L129) diff --git a/docs/api/interfaces/ClickStep.md b/docs/api/interfaces/ClickStep.md deleted file mode 100644 index a7711af1..00000000 --- a/docs/api/interfaces/ClickStep.md +++ /dev/null @@ -1,218 +0,0 @@ -[@puppeteer/replay](../README.md) / ClickStep - -# Interface: ClickStep - -## Hierarchy - -- [`ClickAttributes`](Schema.ClickAttributes.md) - -- [`StepWithSelectors`](Schema.StepWithSelectors.md) - - ↳ **`ClickStep`** - -## Table of contents - -### Properties - -- [assertedEvents](ClickStep.md#assertedevents) -- [button](ClickStep.md#button) -- [deviceType](ClickStep.md#devicetype) -- [duration](ClickStep.md#duration) -- [frame](ClickStep.md#frame) -- [offsetX](ClickStep.md#offsetx) -- [offsetY](ClickStep.md#offsety) -- [selectors](ClickStep.md#selectors) -- [target](ClickStep.md#target) -- [timeout](ClickStep.md#timeout) -- [type](ClickStep.md#type) - -## Properties - -### assertedEvents - -• `Optional` **assertedEvents**: [`NavigationEvent`](Schema.NavigationEvent.md)[] - -#### Inherited from - -[StepWithSelectors](Schema.StepWithSelectors.md).[assertedEvents](Schema.StepWithSelectors.md#assertedevents) - -#### Defined in - -[Schema.ts:64](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L64) - ---- - -### button - -• `Optional` **button**: [`PointerButtonType`](../modules/Schema.md#pointerbuttontype) - -Defaults to 'primary' if the device type is a mouse. - -#### Inherited from - -[ClickAttributes](Schema.ClickAttributes.md).[button](Schema.ClickAttributes.md#button) - -#### Defined in - -[Schema.ts:119](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L119) - ---- - -### deviceType - -• `Optional` **deviceType**: [`PointerDeviceType`](../modules/Schema.md#pointerdevicetype) - -Pointer type for the event. Defaults to 'mouse'. - -#### Inherited from - -[ClickAttributes](Schema.ClickAttributes.md).[deviceType](Schema.ClickAttributes.md#devicetype) - -#### Defined in - -[Schema.ts:115](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L115) - ---- - -### duration - -• `Optional` **duration**: `number` - -Delay (in ms) between the mouse up and mouse down of the click. - -**`Default Value`** - -`50` - -#### Inherited from - -[ClickAttributes](Schema.ClickAttributes.md).[duration](Schema.ClickAttributes.md#duration) - -#### Defined in - -[Schema.ts:135](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L135) - ---- - -### frame - -• `Optional` **frame**: [`FrameSelector`](../modules/Schema.md#frameselector) - -Defaults to main frame - -#### Inherited from - -[StepWithSelectors](Schema.StepWithSelectors.md).[frame](Schema.StepWithSelectors.md#frame) - -#### Defined in - -[Schema.ts:78](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L78) - ---- - -### offsetX - -• **offsetX**: `number` - -in px, relative to the top-left corner of the element content box. Defaults -to the center of the element - -#### Inherited from - -[ClickAttributes](Schema.ClickAttributes.md).[offsetX](Schema.ClickAttributes.md#offsetx) - -#### Defined in - -[Schema.ts:124](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L124) - ---- - -### offsetY - -• **offsetY**: `number` - -in px, relative to the top-left corner of the element content box. Defaults -to the center of the element - -#### Inherited from - -[ClickAttributes](Schema.ClickAttributes.md).[offsetY](Schema.ClickAttributes.md#offsety) - -#### Defined in - -[Schema.ts:129](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L129) - ---- - -### selectors - -• **selectors**: [`Selector`](../modules/Schema.md#selector)[] - -A list of alternative selectors that lead to selection of a single element -to perform the step on. Currently, we support CSS selectors, ARIA selectors -(start with 'aria/'), XPath selectors (start with `xpath/`) and text -selectors (start with `text/`). Each selector could be a string or an array -of strings. If it's a string, it means that the selector points directly to -the target element. If it's an array, the last element is the selector for -the target element and the preceding selectors point to the ancestor -elements. If the parent element is a shadow root host, the subsequent -selector is evaluated only against the shadow DOM of the host (i.e., -`parent.shadowRoot.querySelector`). If the parent element is not a shadow -root host, the subsequent selector is evaluated in the regular DOM (i.e., -`parent.querySelector`). - -During the execution, it's recommended that the implementation tries out -all of the alternative selectors to improve reliability of the replay as -some selectors might get outdated over time. - -#### Inherited from - -[StepWithSelectors](Schema.StepWithSelectors.md).[selectors](Schema.StepWithSelectors.md#selectors) - -#### Defined in - -[Schema.ts:100](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L100) - ---- - -### target - -• `Optional` **target**: `string` - -Defaults to main - -#### Inherited from - -[StepWithSelectors](Schema.StepWithSelectors.md).[target](Schema.StepWithSelectors.md#target) - -#### Defined in - -[Schema.ts:71](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L71) - ---- - -### timeout - -• `Optional` **timeout**: `number` - -#### Inherited from - -[StepWithSelectors](Schema.StepWithSelectors.md).[timeout](Schema.StepWithSelectors.md#timeout) - -#### Defined in - -[Schema.ts:63](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L63) - ---- - -### type - -• **type**: [`Click`](../enums/Schema.StepType.md#click) - -#### Overrides - -[StepWithSelectors](Schema.StepWithSelectors.md).[type](Schema.StepWithSelectors.md#type) - -#### Defined in - -[Schema.ts:143](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L143) diff --git a/docs/api/interfaces/CloseStep.md b/docs/api/interfaces/CloseStep.md deleted file mode 100644 index 2cbfff23..00000000 --- a/docs/api/interfaces/CloseStep.md +++ /dev/null @@ -1,76 +0,0 @@ -[@puppeteer/replay](../README.md) / CloseStep - -# Interface: CloseStep - -## Hierarchy - -- [`StepWithTarget`](Schema.StepWithTarget.md) - - ↳ **`CloseStep`** - -## Table of contents - -### Properties - -- [assertedEvents](CloseStep.md#assertedevents) -- [target](CloseStep.md#target) -- [timeout](CloseStep.md#timeout) -- [type](CloseStep.md#type) - -## Properties - -### assertedEvents - -• `Optional` **assertedEvents**: [`NavigationEvent`](Schema.NavigationEvent.md)[] - -#### Inherited from - -[StepWithTarget](Schema.StepWithTarget.md).[assertedEvents](Schema.StepWithTarget.md#assertedevents) - -#### Defined in - -[Schema.ts:64](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L64) - ---- - -### target - -• `Optional` **target**: `string` - -Defaults to main - -#### Inherited from - -[StepWithTarget](Schema.StepWithTarget.md).[target](Schema.StepWithTarget.md#target) - -#### Defined in - -[Schema.ts:71](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L71) - ---- - -### timeout - -• `Optional` **timeout**: `number` - -#### Inherited from - -[StepWithTarget](Schema.StepWithTarget.md).[timeout](Schema.StepWithTarget.md#timeout) - -#### Defined in - -[Schema.ts:63](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L63) - ---- - -### type - -• **type**: [`Close`](../enums/Schema.StepType.md#close) - -#### Overrides - -[StepWithTarget](Schema.StepWithTarget.md).[type](Schema.StepWithTarget.md#type) - -#### Defined in - -[Schema.ts:173](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L173) diff --git a/docs/api/interfaces/CustomStepParams.md b/docs/api/interfaces/CustomStepParams.md deleted file mode 100644 index df798cb1..00000000 --- a/docs/api/interfaces/CustomStepParams.md +++ /dev/null @@ -1,41 +0,0 @@ -[@puppeteer/replay](../README.md) / CustomStepParams - -# Interface: CustomStepParams - -## Table of contents - -### Properties - -- [name](CustomStepParams.md#name) -- [parameters](CustomStepParams.md#parameters) -- [type](CustomStepParams.md#type) - -## Properties - -### name - -• **name**: `string` - -#### Defined in - -[Schema.ts:209](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L209) - ---- - -### parameters - -• **parameters**: `unknown` - -#### Defined in - -[Schema.ts:210](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L210) - ---- - -### type - -• **type**: [`CustomStep`](../enums/Schema.StepType.md#customstep) - -#### Defined in - -[Schema.ts:208](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L208) diff --git a/docs/api/interfaces/DoubleClickStep.md b/docs/api/interfaces/DoubleClickStep.md deleted file mode 100644 index de18f87b..00000000 --- a/docs/api/interfaces/DoubleClickStep.md +++ /dev/null @@ -1,218 +0,0 @@ -[@puppeteer/replay](../README.md) / DoubleClickStep - -# Interface: DoubleClickStep - -## Hierarchy - -- [`ClickAttributes`](Schema.ClickAttributes.md) - -- [`StepWithSelectors`](Schema.StepWithSelectors.md) - - ↳ **`DoubleClickStep`** - -## Table of contents - -### Properties - -- [assertedEvents](DoubleClickStep.md#assertedevents) -- [button](DoubleClickStep.md#button) -- [deviceType](DoubleClickStep.md#devicetype) -- [duration](DoubleClickStep.md#duration) -- [frame](DoubleClickStep.md#frame) -- [offsetX](DoubleClickStep.md#offsetx) -- [offsetY](DoubleClickStep.md#offsety) -- [selectors](DoubleClickStep.md#selectors) -- [target](DoubleClickStep.md#target) -- [timeout](DoubleClickStep.md#timeout) -- [type](DoubleClickStep.md#type) - -## Properties - -### assertedEvents - -• `Optional` **assertedEvents**: [`NavigationEvent`](Schema.NavigationEvent.md)[] - -#### Inherited from - -[StepWithSelectors](Schema.StepWithSelectors.md).[assertedEvents](Schema.StepWithSelectors.md#assertedevents) - -#### Defined in - -[Schema.ts:64](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L64) - ---- - -### button - -• `Optional` **button**: [`PointerButtonType`](../modules/Schema.md#pointerbuttontype) - -Defaults to 'primary' if the device type is a mouse. - -#### Inherited from - -[ClickAttributes](Schema.ClickAttributes.md).[button](Schema.ClickAttributes.md#button) - -#### Defined in - -[Schema.ts:119](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L119) - ---- - -### deviceType - -• `Optional` **deviceType**: [`PointerDeviceType`](../modules/Schema.md#pointerdevicetype) - -Pointer type for the event. Defaults to 'mouse'. - -#### Inherited from - -[ClickAttributes](Schema.ClickAttributes.md).[deviceType](Schema.ClickAttributes.md#devicetype) - -#### Defined in - -[Schema.ts:115](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L115) - ---- - -### duration - -• `Optional` **duration**: `number` - -Delay (in ms) between the mouse up and mouse down of the click. - -**`Default Value`** - -`50` - -#### Inherited from - -[ClickAttributes](Schema.ClickAttributes.md).[duration](Schema.ClickAttributes.md#duration) - -#### Defined in - -[Schema.ts:135](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L135) - ---- - -### frame - -• `Optional` **frame**: [`FrameSelector`](../modules/Schema.md#frameselector) - -Defaults to main frame - -#### Inherited from - -[StepWithSelectors](Schema.StepWithSelectors.md).[frame](Schema.StepWithSelectors.md#frame) - -#### Defined in - -[Schema.ts:78](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L78) - ---- - -### offsetX - -• **offsetX**: `number` - -in px, relative to the top-left corner of the element content box. Defaults -to the center of the element - -#### Inherited from - -[ClickAttributes](Schema.ClickAttributes.md).[offsetX](Schema.ClickAttributes.md#offsetx) - -#### Defined in - -[Schema.ts:124](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L124) - ---- - -### offsetY - -• **offsetY**: `number` - -in px, relative to the top-left corner of the element content box. Defaults -to the center of the element - -#### Inherited from - -[ClickAttributes](Schema.ClickAttributes.md).[offsetY](Schema.ClickAttributes.md#offsety) - -#### Defined in - -[Schema.ts:129](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L129) - ---- - -### selectors - -• **selectors**: [`Selector`](../modules/Schema.md#selector)[] - -A list of alternative selectors that lead to selection of a single element -to perform the step on. Currently, we support CSS selectors, ARIA selectors -(start with 'aria/'), XPath selectors (start with `xpath/`) and text -selectors (start with `text/`). Each selector could be a string or an array -of strings. If it's a string, it means that the selector points directly to -the target element. If it's an array, the last element is the selector for -the target element and the preceding selectors point to the ancestor -elements. If the parent element is a shadow root host, the subsequent -selector is evaluated only against the shadow DOM of the host (i.e., -`parent.shadowRoot.querySelector`). If the parent element is not a shadow -root host, the subsequent selector is evaluated in the regular DOM (i.e., -`parent.querySelector`). - -During the execution, it's recommended that the implementation tries out -all of the alternative selectors to improve reliability of the replay as -some selectors might get outdated over time. - -#### Inherited from - -[StepWithSelectors](Schema.StepWithSelectors.md).[selectors](Schema.StepWithSelectors.md#selectors) - -#### Defined in - -[Schema.ts:100](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L100) - ---- - -### target - -• `Optional` **target**: `string` - -Defaults to main - -#### Inherited from - -[StepWithSelectors](Schema.StepWithSelectors.md).[target](Schema.StepWithSelectors.md#target) - -#### Defined in - -[Schema.ts:71](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L71) - ---- - -### timeout - -• `Optional` **timeout**: `number` - -#### Inherited from - -[StepWithSelectors](Schema.StepWithSelectors.md).[timeout](Schema.StepWithSelectors.md#timeout) - -#### Defined in - -[Schema.ts:63](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L63) - ---- - -### type - -• **type**: [`DoubleClick`](../enums/Schema.StepType.md#doubleclick) - -#### Overrides - -[StepWithSelectors](Schema.StepWithSelectors.md).[type](Schema.StepWithSelectors.md#type) - -#### Defined in - -[Schema.ts:139](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L139) diff --git a/docs/api/interfaces/EmulateNetworkConditionsStep.md b/docs/api/interfaces/EmulateNetworkConditionsStep.md deleted file mode 100644 index 9d617570..00000000 --- a/docs/api/interfaces/EmulateNetworkConditionsStep.md +++ /dev/null @@ -1,109 +0,0 @@ -[@puppeteer/replay](../README.md) / EmulateNetworkConditionsStep - -# Interface: EmulateNetworkConditionsStep - -## Hierarchy - -- [`StepWithTarget`](Schema.StepWithTarget.md) - - ↳ **`EmulateNetworkConditionsStep`** - -## Table of contents - -### Properties - -- [assertedEvents](EmulateNetworkConditionsStep.md#assertedevents) -- [download](EmulateNetworkConditionsStep.md#download) -- [latency](EmulateNetworkConditionsStep.md#latency) -- [target](EmulateNetworkConditionsStep.md#target) -- [timeout](EmulateNetworkConditionsStep.md#timeout) -- [type](EmulateNetworkConditionsStep.md#type) -- [upload](EmulateNetworkConditionsStep.md#upload) - -## Properties - -### assertedEvents - -• `Optional` **assertedEvents**: [`NavigationEvent`](Schema.NavigationEvent.md)[] - -#### Inherited from - -[StepWithTarget](Schema.StepWithTarget.md).[assertedEvents](Schema.StepWithTarget.md#assertedevents) - -#### Defined in - -[Schema.ts:64](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L64) - ---- - -### download - -• **download**: `number` - -#### Defined in - -[Schema.ts:157](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L157) - ---- - -### latency - -• **latency**: `number` - -#### Defined in - -[Schema.ts:159](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L159) - ---- - -### target - -• `Optional` **target**: `string` - -Defaults to main - -#### Inherited from - -[StepWithTarget](Schema.StepWithTarget.md).[target](Schema.StepWithTarget.md#target) - -#### Defined in - -[Schema.ts:71](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L71) - ---- - -### timeout - -• `Optional` **timeout**: `number` - -#### Inherited from - -[StepWithTarget](Schema.StepWithTarget.md).[timeout](Schema.StepWithTarget.md#timeout) - -#### Defined in - -[Schema.ts:63](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L63) - ---- - -### type - -• **type**: [`EmulateNetworkConditions`](../enums/Schema.StepType.md#emulatenetworkconditions) - -#### Overrides - -[StepWithTarget](Schema.StepWithTarget.md).[type](Schema.StepWithTarget.md#type) - -#### Defined in - -[Schema.ts:156](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L156) - ---- - -### upload - -• **upload**: `number` - -#### Defined in - -[Schema.ts:158](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L158) diff --git a/docs/api/interfaces/HoverStep.md b/docs/api/interfaces/HoverStep.md deleted file mode 100644 index 235d7f93..00000000 --- a/docs/api/interfaces/HoverStep.md +++ /dev/null @@ -1,125 +0,0 @@ -[@puppeteer/replay](../README.md) / HoverStep - -# Interface: HoverStep - -## Hierarchy - -- [`StepWithSelectors`](Schema.StepWithSelectors.md) - - ↳ **`HoverStep`** - -## Table of contents - -### Properties - -- [assertedEvents](HoverStep.md#assertedevents) -- [frame](HoverStep.md#frame) -- [selectors](HoverStep.md#selectors) -- [target](HoverStep.md#target) -- [timeout](HoverStep.md#timeout) -- [type](HoverStep.md#type) - -## Properties - -### assertedEvents - -• `Optional` **assertedEvents**: [`NavigationEvent`](Schema.NavigationEvent.md)[] - -#### Inherited from - -[StepWithSelectors](Schema.StepWithSelectors.md).[assertedEvents](Schema.StepWithSelectors.md#assertedevents) - -#### Defined in - -[Schema.ts:64](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L64) - ---- - -### frame - -• `Optional` **frame**: [`FrameSelector`](../modules/Schema.md#frameselector) - -Defaults to main frame - -#### Inherited from - -[StepWithSelectors](Schema.StepWithSelectors.md).[frame](Schema.StepWithSelectors.md#frame) - -#### Defined in - -[Schema.ts:78](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L78) - ---- - -### selectors - -• **selectors**: [`Selector`](../modules/Schema.md#selector)[] - -A list of alternative selectors that lead to selection of a single element -to perform the step on. Currently, we support CSS selectors, ARIA selectors -(start with 'aria/'), XPath selectors (start with `xpath/`) and text -selectors (start with `text/`). Each selector could be a string or an array -of strings. If it's a string, it means that the selector points directly to -the target element. If it's an array, the last element is the selector for -the target element and the preceding selectors point to the ancestor -elements. If the parent element is a shadow root host, the subsequent -selector is evaluated only against the shadow DOM of the host (i.e., -`parent.shadowRoot.querySelector`). If the parent element is not a shadow -root host, the subsequent selector is evaluated in the regular DOM (i.e., -`parent.querySelector`). - -During the execution, it's recommended that the implementation tries out -all of the alternative selectors to improve reliability of the replay as -some selectors might get outdated over time. - -#### Inherited from - -[StepWithSelectors](Schema.StepWithSelectors.md).[selectors](Schema.StepWithSelectors.md#selectors) - -#### Defined in - -[Schema.ts:100](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L100) - ---- - -### target - -• `Optional` **target**: `string` - -Defaults to main - -#### Inherited from - -[StepWithSelectors](Schema.StepWithSelectors.md).[target](Schema.StepWithSelectors.md#target) - -#### Defined in - -[Schema.ts:71](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L71) - ---- - -### timeout - -• `Optional` **timeout**: `number` - -#### Inherited from - -[StepWithSelectors](Schema.StepWithSelectors.md).[timeout](Schema.StepWithSelectors.md#timeout) - -#### Defined in - -[Schema.ts:63](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L63) - ---- - -### type - -• **type**: [`Hover`](../enums/Schema.StepType.md#hover) - -#### Overrides - -[StepWithSelectors](Schema.StepWithSelectors.md).[type](Schema.StepWithSelectors.md#type) - -#### Defined in - -[Schema.ts:147](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L147) diff --git a/docs/api/interfaces/KeyDownStep.md b/docs/api/interfaces/KeyDownStep.md deleted file mode 100644 index 52393dc5..00000000 --- a/docs/api/interfaces/KeyDownStep.md +++ /dev/null @@ -1,87 +0,0 @@ -[@puppeteer/replay](../README.md) / KeyDownStep - -# Interface: KeyDownStep - -## Hierarchy - -- [`StepWithTarget`](Schema.StepWithTarget.md) - - ↳ **`KeyDownStep`** - -## Table of contents - -### Properties - -- [assertedEvents](KeyDownStep.md#assertedevents) -- [key](KeyDownStep.md#key) -- [target](KeyDownStep.md#target) -- [timeout](KeyDownStep.md#timeout) -- [type](KeyDownStep.md#type) - -## Properties - -### assertedEvents - -• `Optional` **assertedEvents**: [`NavigationEvent`](Schema.NavigationEvent.md)[] - -#### Inherited from - -[StepWithTarget](Schema.StepWithTarget.md).[assertedEvents](Schema.StepWithTarget.md#assertedevents) - -#### Defined in - -[Schema.ts:64](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L64) - ---- - -### key - -• **key**: [`Key`](../modules/Schema.md#key) - -#### Defined in - -[Schema.ts:164](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L164) - ---- - -### target - -• `Optional` **target**: `string` - -Defaults to main - -#### Inherited from - -[StepWithTarget](Schema.StepWithTarget.md).[target](Schema.StepWithTarget.md#target) - -#### Defined in - -[Schema.ts:71](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L71) - ---- - -### timeout - -• `Optional` **timeout**: `number` - -#### Inherited from - -[StepWithTarget](Schema.StepWithTarget.md).[timeout](Schema.StepWithTarget.md#timeout) - -#### Defined in - -[Schema.ts:63](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L63) - ---- - -### type - -• **type**: [`KeyDown`](../enums/Schema.StepType.md#keydown) - -#### Overrides - -[StepWithTarget](Schema.StepWithTarget.md).[type](Schema.StepWithTarget.md#type) - -#### Defined in - -[Schema.ts:163](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L163) diff --git a/docs/api/interfaces/KeyUpStep.md b/docs/api/interfaces/KeyUpStep.md deleted file mode 100644 index e249e4cb..00000000 --- a/docs/api/interfaces/KeyUpStep.md +++ /dev/null @@ -1,87 +0,0 @@ -[@puppeteer/replay](../README.md) / KeyUpStep - -# Interface: KeyUpStep - -## Hierarchy - -- [`StepWithTarget`](Schema.StepWithTarget.md) - - ↳ **`KeyUpStep`** - -## Table of contents - -### Properties - -- [assertedEvents](KeyUpStep.md#assertedevents) -- [key](KeyUpStep.md#key) -- [target](KeyUpStep.md#target) -- [timeout](KeyUpStep.md#timeout) -- [type](KeyUpStep.md#type) - -## Properties - -### assertedEvents - -• `Optional` **assertedEvents**: [`NavigationEvent`](Schema.NavigationEvent.md)[] - -#### Inherited from - -[StepWithTarget](Schema.StepWithTarget.md).[assertedEvents](Schema.StepWithTarget.md#assertedevents) - -#### Defined in - -[Schema.ts:64](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L64) - ---- - -### key - -• **key**: [`Key`](../modules/Schema.md#key) - -#### Defined in - -[Schema.ts:169](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L169) - ---- - -### target - -• `Optional` **target**: `string` - -Defaults to main - -#### Inherited from - -[StepWithTarget](Schema.StepWithTarget.md).[target](Schema.StepWithTarget.md#target) - -#### Defined in - -[Schema.ts:71](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L71) - ---- - -### timeout - -• `Optional` **timeout**: `number` - -#### Inherited from - -[StepWithTarget](Schema.StepWithTarget.md).[timeout](Schema.StepWithTarget.md#timeout) - -#### Defined in - -[Schema.ts:63](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L63) - ---- - -### type - -• **type**: [`KeyUp`](../enums/Schema.StepType.md#keyup) - -#### Overrides - -[StepWithTarget](Schema.StepWithTarget.md).[type](Schema.StepWithTarget.md#type) - -#### Defined in - -[Schema.ts:168](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L168) diff --git a/docs/api/interfaces/NavigateStep.md b/docs/api/interfaces/NavigateStep.md deleted file mode 100644 index 1e429ea0..00000000 --- a/docs/api/interfaces/NavigateStep.md +++ /dev/null @@ -1,87 +0,0 @@ -[@puppeteer/replay](../README.md) / NavigateStep - -# Interface: NavigateStep - -## Hierarchy - -- [`StepWithTarget`](Schema.StepWithTarget.md) - - ↳ **`NavigateStep`** - -## Table of contents - -### Properties - -- [assertedEvents](NavigateStep.md#assertedevents) -- [target](NavigateStep.md#target) -- [timeout](NavigateStep.md#timeout) -- [type](NavigateStep.md#type) -- [url](NavigateStep.md#url) - -## Properties - -### assertedEvents - -• `Optional` **assertedEvents**: [`NavigationEvent`](Schema.NavigationEvent.md)[] - -#### Inherited from - -[StepWithTarget](Schema.StepWithTarget.md).[assertedEvents](Schema.StepWithTarget.md#assertedevents) - -#### Defined in - -[Schema.ts:64](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L64) - ---- - -### target - -• `Optional` **target**: `string` - -Defaults to main - -#### Inherited from - -[StepWithTarget](Schema.StepWithTarget.md).[target](Schema.StepWithTarget.md#target) - -#### Defined in - -[Schema.ts:71](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L71) - ---- - -### timeout - -• `Optional` **timeout**: `number` - -#### Inherited from - -[StepWithTarget](Schema.StepWithTarget.md).[timeout](Schema.StepWithTarget.md#timeout) - -#### Defined in - -[Schema.ts:63](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L63) - ---- - -### type - -• **type**: [`Navigate`](../enums/Schema.StepType.md#navigate) - -#### Overrides - -[StepWithTarget](Schema.StepWithTarget.md).[type](Schema.StepWithTarget.md#type) - -#### Defined in - -[Schema.ts:203](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L203) - ---- - -### url - -• **url**: `string` - -#### Defined in - -[Schema.ts:204](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L204) diff --git a/docs/api/interfaces/NavigationEvent.md b/docs/api/interfaces/NavigationEvent.md deleted file mode 100644 index be8319c9..00000000 --- a/docs/api/interfaces/NavigationEvent.md +++ /dev/null @@ -1,41 +0,0 @@ -[@puppeteer/replay](../README.md) / NavigationEvent - -# Interface: NavigationEvent - -## Table of contents - -### Properties - -- [title](NavigationEvent.md#title) -- [type](NavigationEvent.md#type) -- [url](NavigationEvent.md#url) - -## Properties - -### title - -• `Optional` **title**: `string` - -#### Defined in - -[Schema.ts:56](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L56) - ---- - -### type - -• **type**: [`Navigation`](../enums/Schema.AssertedEventType.md#navigation) - -#### Defined in - -[Schema.ts:54](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L54) - ---- - -### url - -• `Optional` **url**: `string` - -#### Defined in - -[Schema.ts:55](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L55) diff --git a/docs/api/interfaces/Schema.BaseStep.md b/docs/api/interfaces/Schema.BaseStep.md index 7f803de1..0b9d40bb 100644 --- a/docs/api/interfaces/Schema.BaseStep.md +++ b/docs/api/interfaces/Schema.BaseStep.md @@ -10,8 +10,6 @@ ↳ [`StepWithTarget`](Schema.StepWithTarget.md) - ↳ [`StepWithTarget`](StepWithTarget.md) - ## Table of contents ### Properties diff --git a/docs/api/interfaces/Schema.ClickAttributes.md b/docs/api/interfaces/Schema.ClickAttributes.md index da6cf012..8a3a0fbc 100644 --- a/docs/api/interfaces/Schema.ClickAttributes.md +++ b/docs/api/interfaces/Schema.ClickAttributes.md @@ -12,10 +12,6 @@ ↳ [`ClickStep`](Schema.ClickStep.md) - ↳ [`DoubleClickStep`](DoubleClickStep.md) - - ↳ [`ClickStep`](ClickStep.md) - ## Table of contents ### Properties diff --git a/docs/api/interfaces/Schema.StepWithFrame.md b/docs/api/interfaces/Schema.StepWithFrame.md index 5daf17cd..4dabfa1b 100644 --- a/docs/api/interfaces/Schema.StepWithFrame.md +++ b/docs/api/interfaces/Schema.StepWithFrame.md @@ -16,12 +16,6 @@ ↳↳ [`WaitForExpressionStep`](Schema.WaitForExpressionStep.md) - ↳↳ [`StepWithSelectors`](StepWithSelectors.md) - - ↳↳ [`ScrollPageStep`](ScrollPageStep.md) - - ↳↳ [`WaitForExpressionStep`](WaitForExpressionStep.md) - ## Table of contents ### Properties diff --git a/docs/api/interfaces/Schema.StepWithSelectors.md b/docs/api/interfaces/Schema.StepWithSelectors.md index 0d29f8b4..0dfa82fa 100644 --- a/docs/api/interfaces/Schema.StepWithSelectors.md +++ b/docs/api/interfaces/Schema.StepWithSelectors.md @@ -20,16 +20,6 @@ ↳↳ [`WaitForElementStep`](Schema.WaitForElementStep.md) - ↳↳ [`DoubleClickStep`](DoubleClickStep.md) - - ↳↳ [`ClickStep`](ClickStep.md) - - ↳↳ [`HoverStep`](HoverStep.md) - - ↳↳ [`ChangeStep`](ChangeStep.md) - - ↳↳ [`WaitForElementStep`](WaitForElementStep.md) - ## Table of contents ### Properties diff --git a/docs/api/interfaces/Schema.StepWithTarget.md b/docs/api/interfaces/Schema.StepWithTarget.md index ae093a61..3123ae91 100644 --- a/docs/api/interfaces/Schema.StepWithTarget.md +++ b/docs/api/interfaces/Schema.StepWithTarget.md @@ -24,20 +24,6 @@ ↳↳ [`NavigateStep`](Schema.NavigateStep.md) - ↳↳ [`StepWithFrame`](StepWithFrame.md) - - ↳↳ [`EmulateNetworkConditionsStep`](EmulateNetworkConditionsStep.md) - - ↳↳ [`KeyDownStep`](KeyDownStep.md) - - ↳↳ [`KeyUpStep`](KeyUpStep.md) - - ↳↳ [`CloseStep`](CloseStep.md) - - ↳↳ [`SetViewportStep`](SetViewportStep.md) - - ↳↳ [`NavigateStep`](NavigateStep.md) - ## Table of contents ### Properties diff --git a/docs/api/interfaces/ScrollPageStep.md b/docs/api/interfaces/ScrollPageStep.md deleted file mode 100644 index d7afda23..00000000 --- a/docs/api/interfaces/ScrollPageStep.md +++ /dev/null @@ -1,119 +0,0 @@ -[@puppeteer/replay](../README.md) / ScrollPageStep - -# Interface: ScrollPageStep - -## Hierarchy - -- [`StepWithFrame`](Schema.StepWithFrame.md) - - ↳ **`ScrollPageStep`** - -## Table of contents - -### Properties - -- [assertedEvents](ScrollPageStep.md#assertedevents) -- [frame](ScrollPageStep.md#frame) -- [target](ScrollPageStep.md#target) -- [timeout](ScrollPageStep.md#timeout) -- [type](ScrollPageStep.md#type) -- [x](ScrollPageStep.md#x) -- [y](ScrollPageStep.md#y) - -## Properties - -### assertedEvents - -• `Optional` **assertedEvents**: [`NavigationEvent`](Schema.NavigationEvent.md)[] - -#### Inherited from - -[StepWithFrame](Schema.StepWithFrame.md).[assertedEvents](Schema.StepWithFrame.md#assertedevents) - -#### Defined in - -[Schema.ts:64](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L64) - ---- - -### frame - -• `Optional` **frame**: [`FrameSelector`](../modules/Schema.md#frameselector) - -Defaults to main frame - -#### Inherited from - -[StepWithFrame](Schema.StepWithFrame.md).[frame](Schema.StepWithFrame.md#frame) - -#### Defined in - -[Schema.ts:78](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L78) - ---- - -### target - -• `Optional` **target**: `string` - -Defaults to main - -#### Inherited from - -[StepWithFrame](Schema.StepWithFrame.md).[target](Schema.StepWithFrame.md#target) - -#### Defined in - -[Schema.ts:71](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L71) - ---- - -### timeout - -• `Optional` **timeout**: `number` - -#### Inherited from - -[StepWithFrame](Schema.StepWithFrame.md).[timeout](Schema.StepWithFrame.md#timeout) - -#### Defined in - -[Schema.ts:63](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L63) - ---- - -### type - -• **type**: [`Scroll`](../enums/Schema.StepType.md#scroll) - -#### Overrides - -[StepWithFrame](Schema.StepWithFrame.md).[type](Schema.StepWithFrame.md#type) - -#### Defined in - -[Schema.ts:187](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L187) - ---- - -### x - -• `Optional` **x**: `number` - -Absolute scroll x position in px. Defaults to 0 - -#### Defined in - -[Schema.ts:191](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L191) - ---- - -### y - -• `Optional` **y**: `number` - -Absolute scroll y position in px. Defaults to 0 - -#### Defined in - -[Schema.ts:195](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L195) diff --git a/docs/api/interfaces/SetViewportStep.md b/docs/api/interfaces/SetViewportStep.md deleted file mode 100644 index bd7676f9..00000000 --- a/docs/api/interfaces/SetViewportStep.md +++ /dev/null @@ -1,142 +0,0 @@ -[@puppeteer/replay](../README.md) / SetViewportStep - -# Interface: SetViewportStep - -## Hierarchy - -- [`StepWithTarget`](Schema.StepWithTarget.md) - - ↳ **`SetViewportStep`** - -## Table of contents - -### Properties - -- [assertedEvents](SetViewportStep.md#assertedevents) -- [deviceScaleFactor](SetViewportStep.md#devicescalefactor) -- [hasTouch](SetViewportStep.md#hastouch) -- [height](SetViewportStep.md#height) -- [isLandscape](SetViewportStep.md#islandscape) -- [isMobile](SetViewportStep.md#ismobile) -- [target](SetViewportStep.md#target) -- [timeout](SetViewportStep.md#timeout) -- [type](SetViewportStep.md#type) -- [width](SetViewportStep.md#width) - -## Properties - -### assertedEvents - -• `Optional` **assertedEvents**: [`NavigationEvent`](Schema.NavigationEvent.md)[] - -#### Inherited from - -[StepWithTarget](Schema.StepWithTarget.md).[assertedEvents](Schema.StepWithTarget.md#assertedevents) - -#### Defined in - -[Schema.ts:64](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L64) - ---- - -### deviceScaleFactor - -• **deviceScaleFactor**: `number` - -#### Defined in - -[Schema.ts:180](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L180) - ---- - -### hasTouch - -• **hasTouch**: `boolean` - -#### Defined in - -[Schema.ts:182](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L182) - ---- - -### height - -• **height**: `number` - -#### Defined in - -[Schema.ts:179](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L179) - ---- - -### isLandscape - -• **isLandscape**: `boolean` - -#### Defined in - -[Schema.ts:183](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L183) - ---- - -### isMobile - -• **isMobile**: `boolean` - -#### Defined in - -[Schema.ts:181](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L181) - ---- - -### target - -• `Optional` **target**: `string` - -Defaults to main - -#### Inherited from - -[StepWithTarget](Schema.StepWithTarget.md).[target](Schema.StepWithTarget.md#target) - -#### Defined in - -[Schema.ts:71](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L71) - ---- - -### timeout - -• `Optional` **timeout**: `number` - -#### Inherited from - -[StepWithTarget](Schema.StepWithTarget.md).[timeout](Schema.StepWithTarget.md#timeout) - -#### Defined in - -[Schema.ts:63](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L63) - ---- - -### type - -• **type**: [`SetViewport`](../enums/Schema.StepType.md#setviewport) - -#### Overrides - -[StepWithTarget](Schema.StepWithTarget.md).[type](Schema.StepWithTarget.md#type) - -#### Defined in - -[Schema.ts:177](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L177) - ---- - -### width - -• **width**: `number` - -#### Defined in - -[Schema.ts:178](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L178) diff --git a/docs/api/interfaces/StepWithFrame.md b/docs/api/interfaces/StepWithFrame.md deleted file mode 100644 index 200dfad9..00000000 --- a/docs/api/interfaces/StepWithFrame.md +++ /dev/null @@ -1,89 +0,0 @@ -[@puppeteer/replay](../README.md) / StepWithFrame - -# Interface: StepWithFrame - -## Hierarchy - -- [`StepWithTarget`](Schema.StepWithTarget.md) - - ↳ **`StepWithFrame`** - -## Table of contents - -### Properties - -- [assertedEvents](StepWithFrame.md#assertedevents) -- [frame](StepWithFrame.md#frame) -- [target](StepWithFrame.md#target) -- [timeout](StepWithFrame.md#timeout) -- [type](StepWithFrame.md#type) - -## Properties - -### assertedEvents - -• `Optional` **assertedEvents**: [`NavigationEvent`](Schema.NavigationEvent.md)[] - -#### Inherited from - -[StepWithTarget](Schema.StepWithTarget.md).[assertedEvents](Schema.StepWithTarget.md#assertedevents) - -#### Defined in - -[Schema.ts:64](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L64) - ---- - -### frame - -• `Optional` **frame**: [`FrameSelector`](../modules/Schema.md#frameselector) - -Defaults to main frame - -#### Defined in - -[Schema.ts:78](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L78) - ---- - -### target - -• `Optional` **target**: `string` - -Defaults to main - -#### Inherited from - -[StepWithTarget](Schema.StepWithTarget.md).[target](Schema.StepWithTarget.md#target) - -#### Defined in - -[Schema.ts:71](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L71) - ---- - -### timeout - -• `Optional` **timeout**: `number` - -#### Inherited from - -[StepWithTarget](Schema.StepWithTarget.md).[timeout](Schema.StepWithTarget.md#timeout) - -#### Defined in - -[Schema.ts:63](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L63) - ---- - -### type - -• **type**: [`StepType`](../enums/Schema.StepType.md) - -#### Inherited from - -[StepWithTarget](Schema.StepWithTarget.md).[type](Schema.StepWithTarget.md#type) - -#### Defined in - -[Schema.ts:62](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L62) diff --git a/docs/api/interfaces/StepWithSelectors.md b/docs/api/interfaces/StepWithSelectors.md deleted file mode 100644 index 2412c437..00000000 --- a/docs/api/interfaces/StepWithSelectors.md +++ /dev/null @@ -1,121 +0,0 @@ -[@puppeteer/replay](../README.md) / StepWithSelectors - -# Interface: StepWithSelectors - -## Hierarchy - -- [`StepWithFrame`](Schema.StepWithFrame.md) - - ↳ **`StepWithSelectors`** - -## Table of contents - -### Properties - -- [assertedEvents](StepWithSelectors.md#assertedevents) -- [frame](StepWithSelectors.md#frame) -- [selectors](StepWithSelectors.md#selectors) -- [target](StepWithSelectors.md#target) -- [timeout](StepWithSelectors.md#timeout) -- [type](StepWithSelectors.md#type) - -## Properties - -### assertedEvents - -• `Optional` **assertedEvents**: [`NavigationEvent`](Schema.NavigationEvent.md)[] - -#### Inherited from - -[StepWithFrame](Schema.StepWithFrame.md).[assertedEvents](Schema.StepWithFrame.md#assertedevents) - -#### Defined in - -[Schema.ts:64](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L64) - ---- - -### frame - -• `Optional` **frame**: [`FrameSelector`](../modules/Schema.md#frameselector) - -Defaults to main frame - -#### Inherited from - -[StepWithFrame](Schema.StepWithFrame.md).[frame](Schema.StepWithFrame.md#frame) - -#### Defined in - -[Schema.ts:78](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L78) - ---- - -### selectors - -• **selectors**: [`Selector`](../modules/Schema.md#selector)[] - -A list of alternative selectors that lead to selection of a single element -to perform the step on. Currently, we support CSS selectors, ARIA selectors -(start with 'aria/'), XPath selectors (start with `xpath/`) and text -selectors (start with `text/`). Each selector could be a string or an array -of strings. If it's a string, it means that the selector points directly to -the target element. If it's an array, the last element is the selector for -the target element and the preceding selectors point to the ancestor -elements. If the parent element is a shadow root host, the subsequent -selector is evaluated only against the shadow DOM of the host (i.e., -`parent.shadowRoot.querySelector`). If the parent element is not a shadow -root host, the subsequent selector is evaluated in the regular DOM (i.e., -`parent.querySelector`). - -During the execution, it's recommended that the implementation tries out -all of the alternative selectors to improve reliability of the replay as -some selectors might get outdated over time. - -#### Defined in - -[Schema.ts:100](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L100) - ---- - -### target - -• `Optional` **target**: `string` - -Defaults to main - -#### Inherited from - -[StepWithFrame](Schema.StepWithFrame.md).[target](Schema.StepWithFrame.md#target) - -#### Defined in - -[Schema.ts:71](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L71) - ---- - -### timeout - -• `Optional` **timeout**: `number` - -#### Inherited from - -[StepWithFrame](Schema.StepWithFrame.md).[timeout](Schema.StepWithFrame.md#timeout) - -#### Defined in - -[Schema.ts:63](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L63) - ---- - -### type - -• **type**: [`StepType`](../enums/Schema.StepType.md) - -#### Inherited from - -[StepWithFrame](Schema.StepWithFrame.md).[type](Schema.StepWithFrame.md#type) - -#### Defined in - -[Schema.ts:62](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L62) diff --git a/docs/api/interfaces/StepWithTarget.md b/docs/api/interfaces/StepWithTarget.md deleted file mode 100644 index 39a56f1b..00000000 --- a/docs/api/interfaces/StepWithTarget.md +++ /dev/null @@ -1,72 +0,0 @@ -[@puppeteer/replay](../README.md) / StepWithTarget - -# Interface: StepWithTarget - -## Hierarchy - -- [`BaseStep`](Schema.BaseStep.md) - - ↳ **`StepWithTarget`** - -## Table of contents - -### Properties - -- [assertedEvents](StepWithTarget.md#assertedevents) -- [target](StepWithTarget.md#target) -- [timeout](StepWithTarget.md#timeout) -- [type](StepWithTarget.md#type) - -## Properties - -### assertedEvents - -• `Optional` **assertedEvents**: [`NavigationEvent`](Schema.NavigationEvent.md)[] - -#### Inherited from - -[BaseStep](Schema.BaseStep.md).[assertedEvents](Schema.BaseStep.md#assertedevents) - -#### Defined in - -[Schema.ts:64](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L64) - ---- - -### target - -• `Optional` **target**: `string` - -Defaults to main - -#### Defined in - -[Schema.ts:71](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L71) - ---- - -### timeout - -• `Optional` **timeout**: `number` - -#### Inherited from - -[BaseStep](Schema.BaseStep.md).[timeout](Schema.BaseStep.md#timeout) - -#### Defined in - -[Schema.ts:63](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L63) - ---- - -### type - -• **type**: [`StepType`](../enums/Schema.StepType.md) - -#### Inherited from - -[BaseStep](Schema.BaseStep.md).[type](Schema.BaseStep.md#type) - -#### Defined in - -[Schema.ts:62](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L62) diff --git a/docs/api/interfaces/UserFlow.md b/docs/api/interfaces/UserFlow.md deleted file mode 100644 index f968c18b..00000000 --- a/docs/api/interfaces/UserFlow.md +++ /dev/null @@ -1,60 +0,0 @@ -[@puppeteer/replay](../README.md) / UserFlow - -# Interface: UserFlow - -## Table of contents - -### Properties - -- [selectorAttribute](UserFlow.md#selectorattribute) -- [steps](UserFlow.md#steps) -- [timeout](UserFlow.md#timeout) -- [title](UserFlow.md#title) - -## Properties - -### selectorAttribute - -• `Optional` **selectorAttribute**: `string` - -The name of the attribute to use to generate selectors instead of regular -CSS selectors. For example, specifying `data-testid` would generate the -selector `[data-testid=value]` for the element `
`. - -#### Defined in - -[Schema.ts:314](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L314) - ---- - -### steps - -• **steps**: [`Step`](../modules/Schema.md#step)[] - -#### Defined in - -[Schema.ts:315](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L315) - ---- - -### timeout - -• `Optional` **timeout**: `number` - -Timeout in milliseconds. - -#### Defined in - -[Schema.ts:308](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L308) - ---- - -### title - -• **title**: `string` - -Human-readble title describing the recorder user flow. - -#### Defined in - -[Schema.ts:304](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L304) diff --git a/docs/api/interfaces/WaitForElementStep.md b/docs/api/interfaces/WaitForElementStep.md deleted file mode 100644 index 789a6eb6..00000000 --- a/docs/api/interfaces/WaitForElementStep.md +++ /dev/null @@ -1,218 +0,0 @@ -[@puppeteer/replay](../README.md) / WaitForElementStep - -# Interface: WaitForElementStep - -`waitForElement` allows waiting for the presence (or absence) of the number -of elements identified by the selector. - -For example, the following step would wait for less than three elements -to be on the page that match the selector `.my-class`. - -``` -{ - "type": "waitForElement", - "selectors": [".my-class"], - "operator": "<=", - "count": 2, -} -``` - -## Hierarchy - -- [`StepWithSelectors`](Schema.StepWithSelectors.md) - - ↳ **`WaitForElementStep`** - -## Table of contents - -### Properties - -- [assertedEvents](WaitForElementStep.md#assertedevents) -- [attributes](WaitForElementStep.md#attributes) -- [count](WaitForElementStep.md#count) -- [frame](WaitForElementStep.md#frame) -- [operator](WaitForElementStep.md#operator) -- [properties](WaitForElementStep.md#properties) -- [selectors](WaitForElementStep.md#selectors) -- [target](WaitForElementStep.md#target) -- [timeout](WaitForElementStep.md#timeout) -- [type](WaitForElementStep.md#type) -- [visible](WaitForElementStep.md#visible) - -## Properties - -### assertedEvents - -• `Optional` **assertedEvents**: [`NavigationEvent`](Schema.NavigationEvent.md)[] - -#### Inherited from - -[StepWithSelectors](Schema.StepWithSelectors.md).[assertedEvents](Schema.StepWithSelectors.md#assertedevents) - -#### Defined in - -[Schema.ts:64](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L64) - ---- - -### attributes - -• `Optional` **attributes**: `Object` - -Whether to also check the element(s) for the given attributes. - -#### Index signature - -▪ [name: `string`]: `string` - -#### Defined in - -[Schema.ts:273](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L273) - ---- - -### count - -• `Optional` **count**: `number` - -**`Default Value`** - -`1` - -#### Defined in - -[Schema.ts:256](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L256) - ---- - -### frame - -• `Optional` **frame**: [`FrameSelector`](../modules/Schema.md#frameselector) - -Defaults to main frame - -#### Inherited from - -[StepWithSelectors](Schema.StepWithSelectors.md).[frame](Schema.StepWithSelectors.md#frame) - -#### Defined in - -[Schema.ts:78](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L78) - ---- - -### operator - -• `Optional` **operator**: `">="` \| `"=="` \| `"<="` - -**`Default Value`** - -`'=='` - -#### Defined in - -[Schema.ts:252](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L252) - ---- - -### properties - -• `Optional` **properties**: `Partial`<`JSONSerializable`<`HTMLElement`\>\> & { `[key: string]`: `JSONValue`; } - -Whether to also check the element(s) for the given properties. - -#### Defined in - -[Schema.ts:267](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L267) - ---- - -### selectors - -• **selectors**: [`Selector`](../modules/Schema.md#selector)[] - -A list of alternative selectors that lead to selection of a single element -to perform the step on. Currently, we support CSS selectors, ARIA selectors -(start with 'aria/'), XPath selectors (start with `xpath/`) and text -selectors (start with `text/`). Each selector could be a string or an array -of strings. If it's a string, it means that the selector points directly to -the target element. If it's an array, the last element is the selector for -the target element and the preceding selectors point to the ancestor -elements. If the parent element is a shadow root host, the subsequent -selector is evaluated only against the shadow DOM of the host (i.e., -`parent.shadowRoot.querySelector`). If the parent element is not a shadow -root host, the subsequent selector is evaluated in the regular DOM (i.e., -`parent.querySelector`). - -During the execution, it's recommended that the implementation tries out -all of the alternative selectors to improve reliability of the replay as -some selectors might get outdated over time. - -#### Inherited from - -[StepWithSelectors](Schema.StepWithSelectors.md).[selectors](Schema.StepWithSelectors.md#selectors) - -#### Defined in - -[Schema.ts:100](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L100) - ---- - -### target - -• `Optional` **target**: `string` - -Defaults to main - -#### Inherited from - -[StepWithSelectors](Schema.StepWithSelectors.md).[target](Schema.StepWithSelectors.md#target) - -#### Defined in - -[Schema.ts:71](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L71) - ---- - -### timeout - -• `Optional` **timeout**: `number` - -#### Inherited from - -[StepWithSelectors](Schema.StepWithSelectors.md).[timeout](Schema.StepWithSelectors.md#timeout) - -#### Defined in - -[Schema.ts:63](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L63) - ---- - -### type - -• **type**: [`WaitForElement`](../enums/Schema.StepType.md#waitforelement) - -#### Overrides - -[StepWithSelectors](Schema.StepWithSelectors.md).[type](Schema.StepWithSelectors.md#type) - -#### Defined in - -[Schema.ts:248](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L248) - ---- - -### visible - -• `Optional` **visible**: `boolean` - -Whether to wait for elements matching this step to be hidden. This can be -thought of as an inversion of this step. - -**`Default Value`** - -`true` - -#### Defined in - -[Schema.ts:263](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L263) diff --git a/docs/api/interfaces/WaitForExpressionStep.md b/docs/api/interfaces/WaitForExpressionStep.md deleted file mode 100644 index 7beaf977..00000000 --- a/docs/api/interfaces/WaitForExpressionStep.md +++ /dev/null @@ -1,118 +0,0 @@ -[@puppeteer/replay](../README.md) / WaitForExpressionStep - -# Interface: WaitForExpressionStep - -`waitForExpression` allows for a JavaScript expression to resolve to truthy -value. - -For example, the following step pauses for two seconds and then resolves to -true allowing the replay to continue. - -``` -{ - "type": "waitForExpression", - "expression": "new Promise(resolve => setTimeout(() => resolve(true), -2000))", -} -``` - -## Hierarchy - -- [`StepWithFrame`](Schema.StepWithFrame.md) - - ↳ **`WaitForExpressionStep`** - -## Table of contents - -### Properties - -- [assertedEvents](WaitForExpressionStep.md#assertedevents) -- [expression](WaitForExpressionStep.md#expression) -- [frame](WaitForExpressionStep.md#frame) -- [target](WaitForExpressionStep.md#target) -- [timeout](WaitForExpressionStep.md#timeout) -- [type](WaitForExpressionStep.md#type) - -## Properties - -### assertedEvents - -• `Optional` **assertedEvents**: [`NavigationEvent`](Schema.NavigationEvent.md)[] - -#### Inherited from - -[StepWithFrame](Schema.StepWithFrame.md).[assertedEvents](Schema.StepWithFrame.md#assertedevents) - -#### Defined in - -[Schema.ts:64](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L64) - ---- - -### expression - -• **expression**: `string` - -#### Defined in - -[Schema.ts:293](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L293) - ---- - -### frame - -• `Optional` **frame**: [`FrameSelector`](../modules/Schema.md#frameselector) - -Defaults to main frame - -#### Inherited from - -[StepWithFrame](Schema.StepWithFrame.md).[frame](Schema.StepWithFrame.md#frame) - -#### Defined in - -[Schema.ts:78](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L78) - ---- - -### target - -• `Optional` **target**: `string` - -Defaults to main - -#### Inherited from - -[StepWithFrame](Schema.StepWithFrame.md).[target](Schema.StepWithFrame.md#target) - -#### Defined in - -[Schema.ts:71](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L71) - ---- - -### timeout - -• `Optional` **timeout**: `number` - -#### Inherited from - -[StepWithFrame](Schema.StepWithFrame.md).[timeout](Schema.StepWithFrame.md#timeout) - -#### Defined in - -[Schema.ts:63](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L63) - ---- - -### type - -• **type**: [`WaitForExpression`](../enums/Schema.StepType.md#waitforexpression) - -#### Overrides - -[StepWithFrame](Schema.StepWithFrame.md).[type](Schema.StepWithFrame.md#type) - -#### Defined in - -[Schema.ts:292](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L292)