Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(main): release 3.0.0 #748

Merged
merged 2 commits into from
Feb 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .release-please-manifest.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
".": "2.13.4"
".": "3.0.0"
}
22 changes: 22 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,28 @@

All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.

## [3.0.0](https://github.com/puppeteer/replay/compare/v2.13.4...v3.0.0) (2024-02-05)


### ⚠ BREAKING CHANGES

* make replay compatible with Puppeteer v22 ([#758](https://github.com/puppeteer/replay/issues/758))
* update min version to Node 18 ([#755](https://github.com/puppeteer/replay/issues/755))

### Features

* update min version to Node 18 ([#755](https://github.com/puppeteer/replay/issues/755)) ([41c3d10](https://github.com/puppeteer/replay/commit/41c3d1060ed35a47f790c6c35dd7251fb763fe37))


### Bug Fixes

* remove deprecated waitForTimeout ([#747](https://github.com/puppeteer/replay/issues/747)) ([23613b8](https://github.com/puppeteer/replay/commit/23613b87b171087ee9efbf8bbcd6e178e0dd1cac))


### Code Refactoring

* make replay compatible with Puppeteer v22 ([#758](https://github.com/puppeteer/replay/issues/758)) ([e594f50](https://github.com/puppeteer/replay/commit/e594f50174507c03dfd2e04fe70b2bc04f69773d))

## [2.13.4](https://github.com/puppeteer/replay/compare/v2.13.3...v2.13.4) (2023-09-19)


Expand Down
30 changes: 15 additions & 15 deletions docs/api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -359,7 +359,7 @@ The format is [version, [lineNo, length], [lineNo, length] ... [lineNo, length]]

### mouseButtonMap

• `Const` **mouseButtonMap**: `ReadonlyMap`<`string`, `"left"` \| `"middle"` \| `"right"` \| `"back"` \| `"forward"`\>
• `Const` **mouseButtonMap**: `ReadonlyMap`\<`string`, `"left"` \| `"middle"` \| `"right"` \| `"back"` \| `"forward"`\>

#### Defined in

Expand All @@ -369,7 +369,7 @@ The format is [version, [lineNo, length], [lineNo, length] ... [lineNo, length]]

### pointerDeviceTypes

• `Const` **pointerDeviceTypes**: `ReadonlySet`<`string`\>
• `Const` **pointerDeviceTypes**: `ReadonlySet`\<`string`\>

#### Defined in

Expand All @@ -379,7 +379,7 @@ The format is [version, [lineNo, length], [lineNo, length] ... [lineNo, length]]

### typeableInputTypes

• `Const` **typeableInputTypes**: `ReadonlySet`<`string`\>
• `Const` **typeableInputTypes**: `ReadonlySet`\<`string`\>

#### Defined in

Expand Down Expand Up @@ -409,17 +409,17 @@ The format is [version, [lineNo, length], [lineNo, length] ... [lineNo, length]]

### createRunner

▸ **createRunner**(): `Promise`<[`Runner`](classes/Runner.md)\>
▸ **createRunner**(): `Promise`\<[`Runner`](classes/Runner.md)\>

#### Returns

`Promise`<[`Runner`](classes/Runner.md)\>
`Promise`\<[`Runner`](classes/Runner.md)\>

#### Defined in

[Runner.ts:102](https://github.com/puppeteer/replay/blob/main/src/Runner.ts#L102)

▸ **createRunner**(`flow`): `Promise`<[`Runner`](classes/Runner.md)\>
▸ **createRunner**(`flow`): `Promise`\<[`Runner`](classes/Runner.md)\>

#### Parameters

Expand All @@ -429,13 +429,13 @@ The format is [version, [lineNo, length], [lineNo, length] ... [lineNo, length]]

#### Returns

`Promise`<[`Runner`](classes/Runner.md)\>
`Promise`\<[`Runner`](classes/Runner.md)\>

#### Defined in

[Runner.ts:103](https://github.com/puppeteer/replay/blob/main/src/Runner.ts#L103)

▸ **createRunner**(`extension`): `Promise`<[`Runner`](classes/Runner.md)\>
▸ **createRunner**(`extension`): `Promise`\<[`Runner`](classes/Runner.md)\>

#### Parameters

Expand All @@ -445,13 +445,13 @@ The format is [version, [lineNo, length], [lineNo, length] ... [lineNo, length]]

#### Returns

`Promise`<[`Runner`](classes/Runner.md)\>
`Promise`\<[`Runner`](classes/Runner.md)\>

#### Defined in

[Runner.ts:104](https://github.com/puppeteer/replay/blob/main/src/Runner.ts#L104)

▸ **createRunner**(`flow`, `extension`): `Promise`<[`Runner`](classes/Runner.md)\>
▸ **createRunner**(`flow`, `extension`): `Promise`\<[`Runner`](classes/Runner.md)\>

#### Parameters

Expand All @@ -462,7 +462,7 @@ The format is [version, [lineNo, length], [lineNo, length] ... [lineNo, length]]

#### Returns

`Promise`<[`Runner`](classes/Runner.md)\>
`Promise`\<[`Runner`](classes/Runner.md)\>

#### Defined in

Expand Down Expand Up @@ -632,7 +632,7 @@ https://pptr.dev/guides/query-selectors#p-elements

### stringify

▸ **stringify**(`flow`, `opts?`): `Promise`<`string`\>
▸ **stringify**(`flow`, `opts?`): `Promise`\<`string`\>

Stringifes an entire recording. The following hooks are invoked with the `flow` parameter containing the entire flow:

Expand All @@ -651,7 +651,7 @@ Stringifes an entire recording. The following hooks are invoked with the `flow`

#### Returns

`Promise`<`string`\>
`Promise`\<`string`\>

#### Defined in

Expand All @@ -661,7 +661,7 @@ Stringifes an entire recording. The following hooks are invoked with the `flow`

### stringifyStep

▸ **stringifyStep**(`step`, `opts?`): `Promise`<`string`\>
▸ **stringifyStep**(`step`, `opts?`): `Promise`\<`string`\>

Stringifes a single step. Only the following hooks are invoked with the `flow` parameter as undefined:

Expand All @@ -678,7 +678,7 @@ Stringifes a single step. Only the following hooks are invoked with the `flow` p

#### Returns

`Promise`<`string`\>
`Promise`\<`string`\>

#### Defined in

Expand Down
26 changes: 15 additions & 11 deletions docs/api/classes/JSONStringifyExtension.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,11 @@ parsers support comments in JSON.

### constructor

• **new JSONStringifyExtension**()
• **new JSONStringifyExtension**(): [`JSONStringifyExtension`](JSONStringifyExtension.md)

#### Returns

[`JSONStringifyExtension`](JSONStringifyExtension.md)

#### Inherited from

Expand All @@ -41,7 +45,7 @@ parsers support comments in JSON.

### afterAllSteps

▸ **afterAllSteps**(`out`): `Promise`<`void`\>
▸ **afterAllSteps**(`out`): `Promise`\<`void`\>

#### Parameters

Expand All @@ -51,7 +55,7 @@ parsers support comments in JSON.

#### Returns

`Promise`<`void`\>
`Promise`\<`void`\>

#### Overrides

Expand All @@ -65,7 +69,7 @@ parsers support comments in JSON.

### afterEachStep

`Optional` **afterEachStep**(`out`, `step`, `flow?`): `Promise`<`void`\>
▸ **afterEachStep**(`out`, `step`, `flow?`): `Promise`\<`void`\>

#### Parameters

Expand All @@ -77,7 +81,7 @@ parsers support comments in JSON.

#### Returns

`Promise`<`void`\>
`Promise`\<`void`\>

#### Inherited from

Expand All @@ -91,7 +95,7 @@ parsers support comments in JSON.

### beforeAllSteps

▸ **beforeAllSteps**(`out`, `flow`): `Promise`<`void`\>
▸ **beforeAllSteps**(`out`, `flow`): `Promise`\<`void`\>

#### Parameters

Expand All @@ -102,7 +106,7 @@ parsers support comments in JSON.

#### Returns

`Promise`<`void`\>
`Promise`\<`void`\>

#### Overrides

Expand All @@ -116,7 +120,7 @@ parsers support comments in JSON.

### beforeEachStep

`Optional` **beforeEachStep**(`out`, `step`, `flow?`): `Promise`<`void`\>
▸ **beforeEachStep**(`out`, `step`, `flow?`): `Promise`\<`void`\>

#### Parameters

Expand All @@ -128,7 +132,7 @@ parsers support comments in JSON.

#### Returns

`Promise`<`void`\>
`Promise`\<`void`\>

#### Inherited from

Expand All @@ -142,7 +146,7 @@ parsers support comments in JSON.

### stringifyStep

▸ **stringifyStep**(`out`, `step`, `flow?`): `Promise`<`void`\>
▸ **stringifyStep**(`out`, `step`, `flow?`): `Promise`\<`void`\>

#### Parameters

Expand All @@ -154,7 +158,7 @@ parsers support comments in JSON.

#### Returns

`Promise`<`void`\>
`Promise`\<`void`\>

#### Overrides

Expand Down
34 changes: 19 additions & 15 deletions docs/api/classes/LighthouseRunnerExtension.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@

### constructor

• **new LighthouseRunnerExtension**(`browser`, `page`, `opts?`)
• **new LighthouseRunnerExtension**(`browser`, `page`, `opts?`): [`LighthouseRunnerExtension`](LighthouseRunnerExtension.md)

#### Parameters

Expand All @@ -38,19 +38,23 @@
| `opts?` | `Object` |
| `opts.timeout?` | `number` |

#### Returns

[`LighthouseRunnerExtension`](LighthouseRunnerExtension.md)

#### Inherited from

[PuppeteerRunnerExtension](PuppeteerRunnerExtension.md).[constructor](PuppeteerRunnerExtension.md#constructor)

#### Defined in

[PuppeteerRunnerExtension.ts:45](https://github.com/puppeteer/replay/blob/main/src/PuppeteerRunnerExtension.ts#L45)
[PuppeteerRunnerExtension.ts:51](https://github.com/puppeteer/replay/blob/main/src/PuppeteerRunnerExtension.ts#L51)

## Methods

### afterAllSteps

▸ **afterAllSteps**(`flow`): `Promise`<`void`\>
▸ **afterAllSteps**(`flow`): `Promise`\<`void`\>

#### Parameters

Expand All @@ -60,7 +64,7 @@

#### Returns

`Promise`<`void`\>
`Promise`\<`void`\>

#### Overrides

Expand All @@ -74,7 +78,7 @@

### afterEachStep

▸ **afterEachStep**(`step`, `flow?`): `Promise`<`void`\>
▸ **afterEachStep**(`step`, `flow?`): `Promise`\<`void`\>

#### Parameters

Expand All @@ -85,7 +89,7 @@

#### Returns

`Promise`<`void`\>
`Promise`\<`void`\>

#### Overrides

Expand All @@ -99,7 +103,7 @@

### beforeAllSteps

▸ **beforeAllSteps**(`flow`): `Promise`<`void`\>
▸ **beforeAllSteps**(`flow`): `Promise`\<`void`\>

#### Parameters

Expand All @@ -109,7 +113,7 @@

#### Returns

`Promise`<`void`\>
`Promise`\<`void`\>

#### Overrides

Expand All @@ -123,7 +127,7 @@

### beforeEachStep

▸ **beforeEachStep**(`step`, `flow?`): `Promise`<`void`\>
▸ **beforeEachStep**(`step`, `flow?`): `Promise`\<`void`\>

#### Parameters

Expand All @@ -134,7 +138,7 @@

#### Returns

`Promise`<`void`\>
`Promise`\<`void`\>

#### Overrides

Expand All @@ -148,11 +152,11 @@

### createFlowResult

▸ **createFlowResult**(): `Promise`<`FlowResult`\>
▸ **createFlowResult**(): `Promise`\<`FlowResult`\>

#### Returns

`Promise`<`FlowResult`\>
`Promise`\<`FlowResult`\>

#### Defined in

Expand All @@ -162,7 +166,7 @@

### runStep

▸ **runStep**(`step`, `flow?`): `Promise`<`void`\>
▸ **runStep**(`step`, `flow?`): `Promise`\<`void`\>

#### Parameters

Expand All @@ -173,12 +177,12 @@

#### Returns

`Promise`<`void`\>
`Promise`\<`void`\>

#### Inherited from

[PuppeteerRunnerExtension](PuppeteerRunnerExtension.md).[runStep](PuppeteerRunnerExtension.md#runstep)

#### Defined in

[PuppeteerRunnerExtension.ts:66](https://github.com/puppeteer/replay/blob/main/src/PuppeteerRunnerExtension.ts#L66)
[PuppeteerRunnerExtension.ts:72](https://github.com/puppeteer/replay/blob/main/src/PuppeteerRunnerExtension.ts#L72)
Loading