feat: XPath and Text selector types are now supported (#309)

puppeteer · Sep 21, 2022 · bc066e5 · bc066e5
1 parent 3385cf0
commit bc066e5
Show file tree

Hide file tree

Showing 39 changed files with 684 additions and 261 deletions.
diff --git a/docs/api/README.md b/docs/api/README.md
@@ -98,7 +98,7 @@
 
 #### Defined in
 
-[Schema.ts:241](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L241)
+[Schema.ts:247](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L247)
 
 ---
 
@@ -108,7 +108,7 @@
 
 #### Defined in
 
-[Schema.ts:175](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L175)
+[Schema.ts:181](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L181)
 
 ---
 
@@ -128,7 +128,7 @@
 
 #### Defined in
 
-[Schema.ts:263](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L263)
+[Schema.ts:269](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L269)
 
 ---
 
@@ -148,7 +148,7 @@
 
 #### Defined in
 
-[Schema.ts:67](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L67)
+[Schema.ts:73](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L73)
 
 ---
 
@@ -158,7 +158,7 @@
 
 #### Defined in
 
-[Schema.ts:66](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L66)
+[Schema.ts:72](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L72)
 
 ---
 
@@ -168,7 +168,7 @@
 
 #### Defined in
 
-[Schema.ts:160](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L160)
+[Schema.ts:166](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L166)
 
 ---
 
@@ -178,7 +178,7 @@
 
 #### Defined in
 
-[Schema.ts:162](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L162)
+[Schema.ts:168](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L168)
 
 ---
 
@@ -198,7 +198,7 @@
 
 #### Defined in
 
-[Schema.ts:243](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L243)
+[Schema.ts:249](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L249)
 
 ---
 
@@ -232,7 +232,7 @@ limitations under the License.
 
 #### Defined in
 
-[Schema.ts:179](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L179)
+[Schema.ts:185](https://github.com/puppeteer/replay/blob/main/src/Schema.ts#L185)
 
 ## Variables
 

diff --git a/docs/api/classes/LighthouseRunnerExtension.md b/docs/api/classes/LighthouseRunnerExtension.md
@@ -0,0 +1,184 @@
+[@puppeteer/replay](../README.md) / LighthouseRunnerExtension
+
+# Class: LighthouseRunnerExtension
+
+## Hierarchy
+
+- [`PuppeteerRunnerExtension`](PuppeteerRunnerExtension.md)
+
+  ↳ **`LighthouseRunnerExtension`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](LighthouseRunnerExtension.md#constructor)
+
+### Methods
+
+- [afterAllSteps](LighthouseRunnerExtension.md#afterallsteps)
+- [afterEachStep](LighthouseRunnerExtension.md#aftereachstep)
+- [beforeAllSteps](LighthouseRunnerExtension.md#beforeallsteps)
+- [beforeEachStep](LighthouseRunnerExtension.md#beforeeachstep)
+- [createFlowResult](LighthouseRunnerExtension.md#createflowresult)
+- [runStep](LighthouseRunnerExtension.md#runstep)
+
+## Constructors
+
+### constructor
+
+• **new LighthouseRunnerExtension**(`browser`, `page`, `opts?`)
+
+#### Parameters
+
+| Name            | Type      |
+| :-------------- | :-------- |
+| `browser`       | `Browser` |
+| `page`          | `Page`    |
+| `opts?`         | `Object`  |
+| `opts.timeout?` | `number`  |
+
+#### Inherited from
+
+[PuppeteerRunnerExtension](PuppeteerRunnerExtension.md).[constructor](PuppeteerRunnerExtension.md#constructor)
+
+#### Defined in
+
+[PuppeteerRunnerExtension.ts:39](https://github.com/puppeteer/replay/blob/main/src/PuppeteerRunnerExtension.ts#L39)
+
+## Methods
+
+### afterAllSteps
+
+▸ **afterAllSteps**(`flow`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name   | Type                                           |
+| :----- | :--------------------------------------------- |
+| `flow` | [`UserFlow`](../interfaces/Schema.UserFlow.md) |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Overrides
+
+[PuppeteerRunnerExtension](PuppeteerRunnerExtension.md).[afterAllSteps](PuppeteerRunnerExtension.md#afterallsteps)
+
+#### Defined in
+
+[lighthouse/LighthouseRunnerExtension.ts:79](https://github.com/puppeteer/replay/blob/main/src/lighthouse/LighthouseRunnerExtension.ts#L79)
+
+---
+
+### afterEachStep
+
+▸ **afterEachStep**(`step`, `flow`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name   | Type                                           |
+| :----- | :--------------------------------------------- |
+| `step` | [`Step`](../modules/Schema.md#step)            |
+| `flow` | [`UserFlow`](../interfaces/Schema.UserFlow.md) |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Overrides
+
+[PuppeteerRunnerExtension](PuppeteerRunnerExtension.md).[afterEachStep](PuppeteerRunnerExtension.md#aftereachstep)
+
+#### Defined in
+
+[lighthouse/LighthouseRunnerExtension.ts:71](https://github.com/puppeteer/replay/blob/main/src/lighthouse/LighthouseRunnerExtension.ts#L71)
+
+---
+
+### beforeAllSteps
+
+▸ **beforeAllSteps**(`flow`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name   | Type                                           |
+| :----- | :--------------------------------------------- |
+| `flow` | [`UserFlow`](../interfaces/Schema.UserFlow.md) |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Overrides
+
+[PuppeteerRunnerExtension](PuppeteerRunnerExtension.md).[beforeAllSteps](PuppeteerRunnerExtension.md#beforeallsteps)
+
+#### Defined in
+
+[lighthouse/LighthouseRunnerExtension.ts:34](https://github.com/puppeteer/replay/blob/main/src/lighthouse/LighthouseRunnerExtension.ts#L34)
+
+---
+
+### beforeEachStep
+
+▸ **beforeEachStep**(`step`, `flow`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name   | Type                                           |
+| :----- | :--------------------------------------------- |
+| `step` | [`Step`](../modules/Schema.md#step)            |
+| `flow` | [`UserFlow`](../interfaces/Schema.UserFlow.md) |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Overrides
+
+[PuppeteerRunnerExtension](PuppeteerRunnerExtension.md).[beforeEachStep](PuppeteerRunnerExtension.md#beforeeachstep)
+
+#### Defined in
+
+[lighthouse/LighthouseRunnerExtension.ts:54](https://github.com/puppeteer/replay/blob/main/src/lighthouse/LighthouseRunnerExtension.ts#L54)
+
+---
+
+### createFlowResult
+
+▸ **createFlowResult**(): `Promise`<`any`\>
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[lighthouse/LighthouseRunnerExtension.ts:27](https://github.com/puppeteer/replay/blob/main/src/lighthouse/LighthouseRunnerExtension.ts#L27)
+
+---
+
+### runStep
+
+▸ **runStep**(`step`, `flow`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name   | Type                                           |
+| :----- | :--------------------------------------------- |
+| `step` | [`Step`](../modules/Schema.md#step)            |
+| `flow` | [`UserFlow`](../interfaces/Schema.UserFlow.md) |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Inherited from
+
+[PuppeteerRunnerExtension](PuppeteerRunnerExtension.md).[runStep](PuppeteerRunnerExtension.md#runstep)
+
+#### Defined in
+
+[PuppeteerRunnerExtension.ts:60](https://github.com/puppeteer/replay/blob/main/src/PuppeteerRunnerExtension.ts#L60)