From c2f3ce851b8da76e1a65ca9ca895b822890993d1 Mon Sep 17 00:00:00 2001
From: Alex Rudenko <OrKoN@users.noreply.github.com>
Date: Mon, 13 Feb 2023 20:30:54 +0100
Subject: [PATCH] feat: Lighthouse extension (#467)

Documentation update to trigger a new release. The implementation has
been already there but not released.
---
 docs/api/README.md                            |   1 +
 docs/api/classes/LighthouseRunnerExtension.md | 184 ++++++++++++++++++
 docs/api/classes/PuppeteerRunnerExtension.md  |   2 +
 3 files changed, 187 insertions(+)
 create mode 100644 docs/api/classes/LighthouseRunnerExtension.md

diff --git a/docs/api/README.md b/docs/api/README.md
index 76ec1729..e8661911 100644
--- a/docs/api/README.md
+++ b/docs/api/README.md
@@ -17,6 +17,7 @@
 ### Classes
 
 - [JSONStringifyExtension](classes/JSONStringifyExtension.md)
+- [LighthouseRunnerExtension](classes/LighthouseRunnerExtension.md)
 - [LighthouseStringifyExtension](classes/LighthouseStringifyExtension.md)
 - [PuppeteerReplayStringifyExtension](classes/PuppeteerReplayStringifyExtension.md)
 - [PuppeteerRunnerExtension](classes/PuppeteerRunnerExtension.md)
diff --git a/docs/api/classes/LighthouseRunnerExtension.md b/docs/api/classes/LighthouseRunnerExtension.md
new file mode 100644
index 00000000..c0a0accf
--- /dev/null
+++ 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:47](https://github.com/puppeteer/replay/blob/main/src/PuppeteerRunnerExtension.ts#L47)
+
+## 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:76](https://github.com/puppeteer/replay/blob/main/src/lighthouse/LighthouseRunnerExtension.ts#L76)
+
+---
+
+### 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:68](https://github.com/puppeteer/replay/blob/main/src/lighthouse/LighthouseRunnerExtension.ts#L68)
+
+---
+
+### 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:51](https://github.com/puppeteer/replay/blob/main/src/lighthouse/LighthouseRunnerExtension.ts#L51)
+
+---
+
+### createFlowResult
+
+▸ **createFlowResult**(): `Promise`<`FlowResult`\>
+
+#### Returns
+
+`Promise`<`FlowResult`\>
+
+#### 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:68](https://github.com/puppeteer/replay/blob/main/src/PuppeteerRunnerExtension.ts#L68)
diff --git a/docs/api/classes/PuppeteerRunnerExtension.md b/docs/api/classes/PuppeteerRunnerExtension.md
index ad295263..e99ddd4e 100644
--- a/docs/api/classes/PuppeteerRunnerExtension.md
+++ b/docs/api/classes/PuppeteerRunnerExtension.md
@@ -10,6 +10,8 @@
 
   ↳↳ [`PuppeteerRunnerOwningBrowserExtension`](PuppeteerRunnerOwningBrowserExtension.md)
 
+  ↳↳ [`LighthouseRunnerExtension`](LighthouseRunnerExtension.md)
+
 ## Table of contents
 
 ### Constructors