chore(main): release 2.6.0 (#394)

* chore(main): release 2.6.0 * chore: generate docs Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
puppeteer · Nov 24, 2022 · 0cdacd0 · 0cdacd0
1 parent d74e793
commit 0cdacd0
Show file tree

Hide file tree

Showing 10 changed files with 236 additions and 13 deletions.
diff --git a/.release-please-manifest.json b/.release-please-manifest.json
@@ -1,3 +1,3 @@
 {
-  ".": "2.5.0"
+  ".": "2.6.0"
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,14 @@
 
 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.
 
+## [2.6.0](https://github.com/puppeteer/replay/compare/v2.5.0...v2.6.0) (2022-11-23)
+
+
+### Features
+
+* add JSONStringifyExtension with source map support ([#393](https://github.com/puppeteer/replay/issues/393)) ([92cf062](https://github.com/puppeteer/replay/commit/92cf06233f97f57ad0e29f2dd69e27dd1267e544))
+* format JSON as JS ([#395](https://github.com/puppeteer/replay/issues/395)) ([d74e793](https://github.com/puppeteer/replay/commit/d74e793abeaf1aecdb124ee4451a183eefe4b5b9))
+
 ## [2.5.0](https://github.com/puppeteer/replay/compare/v2.4.0...v2.5.0) (2022-11-22)
 
 

diff --git a/docs/api/README.md b/docs/api/README.md
@@ -16,6 +16,7 @@
 
 ### Classes
 
+- [JSONStringifyExtension](classes/JSONStringifyExtension.md)
 - [LighthouseStringifyExtension](classes/LighthouseStringifyExtension.md)
 - [PuppeteerReplayStringifyExtension](classes/PuppeteerReplayStringifyExtension.md)
 - [PuppeteerRunnerExtension](classes/PuppeteerRunnerExtension.md)
@@ -81,6 +82,8 @@
 
 - [assertAllStepTypesAreHandled](README.md#assertallsteptypesarehandled)
 - [createRunner](README.md#createrunner)
+- [formatAsJSLiteral](README.md#formatasjsliteral)
+- [formatJSONAsJS](README.md#formatjsonasjs)
 - [getSelectorType](README.md#getselectortype)
 - [parse](README.md#parse)
 - [parseSourceMap](README.md#parsesourcemap)
@@ -391,6 +394,51 @@ limitations under the License.
 
 ---
 
+### formatAsJSLiteral
+
+▸ **formatAsJSLiteral**(`content`): `string`
+
+#### Parameters
+
+| Name      | Type     |
+| :-------- | :------- |
+| `content` | `string` |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[JSONUtils.ts:111](https://github.com/puppeteer/replay/blob/main/src/JSONUtils.ts#L111)
+
+---
+
+### formatJSONAsJS
+
+▸ **formatJSONAsJS**(`json`, `indent`): `string`
+
+Copyright (c) 2020 The Chromium Authors. All rights reserved.
+Use of this source code is governed by a BSD-style license that can be
+found in the LICENSE file.
+
+#### Parameters
+
+| Name     | Type      |
+| :------- | :-------- |
+| `json`   | `unknown` |
+| `indent` | `string`  |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[JSONUtils.ts:23](https://github.com/puppeteer/replay/blob/main/src/JSONUtils.ts#L23)
+
+---
+
 ### getSelectorType
 
 ▸ **getSelectorType**(`selector`): [`SelectorType`](enums/Schema.SelectorType.md)

diff --git a/docs/api/classes/JSONStringifyExtension.md b/docs/api/classes/JSONStringifyExtension.md
@@ -0,0 +1,165 @@
+[@puppeteer/replay](../README.md) / JSONStringifyExtension
+
+# Class: JSONStringifyExtension
+
+Stringifies a user flow to JSON with source maps.
+
+You probably want to strip the source map because not all
+parsers support comments in JSON.
+
+## Hierarchy
+
+- [`StringifyExtension`](StringifyExtension.md)
+
+  ↳ **`JSONStringifyExtension`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](JSONStringifyExtension.md#constructor)
+
+### Methods
+
+- [afterAllSteps](JSONStringifyExtension.md#afterallsteps)
+- [afterEachStep](JSONStringifyExtension.md#aftereachstep)
+- [beforeAllSteps](JSONStringifyExtension.md#beforeallsteps)
+- [beforeEachStep](JSONStringifyExtension.md#beforeeachstep)
+- [stringifyStep](JSONStringifyExtension.md#stringifystep)
+
+## Constructors
+
+### constructor
+
+• **new JSONStringifyExtension**()
+
+#### Inherited from
+
+[StringifyExtension](StringifyExtension.md).[constructor](StringifyExtension.md#constructor)
+
+## Methods
+
+### afterAllSteps
+
+▸ **afterAllSteps**(`out`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name  | Type                                        |
+| :---- | :------------------------------------------ |
+| `out` | [`LineWriter`](../interfaces/LineWriter.md) |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Overrides
+
+[StringifyExtension](StringifyExtension.md).[afterAllSteps](StringifyExtension.md#afterallsteps)
+
+#### Defined in
+
+[JSONStringifyExtension.ts:42](https://github.com/puppeteer/replay/blob/main/src/JSONStringifyExtension.ts#L42)
+
+---
+
+### afterEachStep
+
+▸ `Optional` **afterEachStep**(`out`, `step`, `flow?`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name    | Type                                           |
+| :------ | :--------------------------------------------- |
+| `out`   | [`LineWriter`](../interfaces/LineWriter.md)    |
+| `step`  | [`Step`](../modules/Schema.md#step)            |
+| `flow?` | [`UserFlow`](../interfaces/Schema.UserFlow.md) |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Inherited from
+
+[StringifyExtension](StringifyExtension.md).[afterEachStep](StringifyExtension.md#aftereachstep)
+
+#### Defined in
+
+[StringifyExtension.ts:33](https://github.com/puppeteer/replay/blob/main/src/StringifyExtension.ts#L33)
+
+---
+
+### beforeAllSteps
+
+▸ **beforeAllSteps**(`out`, `flow`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name   | Type                                           |
+| :----- | :--------------------------------------------- |
+| `out`  | [`LineWriter`](../interfaces/LineWriter.md)    |
+| `flow` | [`UserFlow`](../interfaces/Schema.UserFlow.md) |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Overrides
+
+[StringifyExtension](StringifyExtension.md).[beforeAllSteps](StringifyExtension.md#beforeallsteps)
+
+#### Defined in
+
+[JSONStringifyExtension.ts:28](https://github.com/puppeteer/replay/blob/main/src/JSONStringifyExtension.ts#L28)
+
+---
+
+### beforeEachStep
+
+▸ `Optional` **beforeEachStep**(`out`, `step`, `flow?`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name    | Type                                           |
+| :------ | :--------------------------------------------- |
+| `out`   | [`LineWriter`](../interfaces/LineWriter.md)    |
+| `step`  | [`Step`](../modules/Schema.md#step)            |
+| `flow?` | [`UserFlow`](../interfaces/Schema.UserFlow.md) |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Inherited from
+
+[StringifyExtension](StringifyExtension.md).[beforeEachStep](StringifyExtension.md#beforeeachstep)
+
+#### Defined in
+
+[StringifyExtension.ts:23](https://github.com/puppeteer/replay/blob/main/src/StringifyExtension.ts#L23)
+
+---
+
+### stringifyStep
+
+▸ **stringifyStep**(`out`, `step`, `flow?`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name    | Type                                           |
+| :------ | :--------------------------------------------- |
+| `out`   | [`LineWriter`](../interfaces/LineWriter.md)    |
+| `step`  | [`Step`](../modules/Schema.md#step)            |
+| `flow?` | [`UserFlow`](../interfaces/Schema.UserFlow.md) |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Overrides
+
+[StringifyExtension](StringifyExtension.md).[stringifyStep](StringifyExtension.md#stringifystep)
+
+#### Defined in
+
+[JSONStringifyExtension.ts:50](https://github.com/puppeteer/replay/blob/main/src/JSONStringifyExtension.ts#L50)
diff --git a/docs/api/classes/LighthouseStringifyExtension.md b/docs/api/classes/LighthouseStringifyExtension.md
@@ -55,7 +55,7 @@
 
 #### Defined in
 
-[lighthouse/LighthouseStringifyExtension.ts:82](https://github.com/puppeteer/replay/blob/main/src/lighthouse/LighthouseStringifyExtension.ts#L82)
+[lighthouse/LighthouseStringifyExtension.ts:84](https://github.com/puppeteer/replay/blob/main/src/lighthouse/LighthouseStringifyExtension.ts#L84)
 
 ---
 
@@ -106,7 +106,7 @@
 
 #### Defined in
 
-[lighthouse/LighthouseStringifyExtension.ts:27](https://github.com/puppeteer/replay/blob/main/src/lighthouse/LighthouseStringifyExtension.ts#L27)
+[lighthouse/LighthouseStringifyExtension.ts:28](https://github.com/puppeteer/replay/blob/main/src/lighthouse/LighthouseStringifyExtension.ts#L28)
 
 ---
 
@@ -158,4 +158,4 @@
 
 #### Defined in
 
-[lighthouse/LighthouseStringifyExtension.ts:56](https://github.com/puppeteer/replay/blob/main/src/lighthouse/LighthouseStringifyExtension.ts#L56)
+[lighthouse/LighthouseStringifyExtension.ts:58](https://github.com/puppeteer/replay/blob/main/src/lighthouse/LighthouseStringifyExtension.ts#L58)
diff --git a/docs/api/classes/PuppeteerReplayStringifyExtension.md b/docs/api/classes/PuppeteerReplayStringifyExtension.md
@@ -56,7 +56,7 @@ Stringifies a user flow to a script that uses @puppeteer/replay's own API.
 
 #### Defined in
 
-[PuppeteerReplayStringifyExtension.ts:36](https://github.com/puppeteer/replay/blob/main/src/PuppeteerReplayStringifyExtension.ts#L36)
+[PuppeteerReplayStringifyExtension.ts:37](https://github.com/puppeteer/replay/blob/main/src/PuppeteerReplayStringifyExtension.ts#L37)
 
 ---
 
@@ -106,7 +106,7 @@ Stringifies a user flow to a script that uses @puppeteer/replay's own API.
 
 #### Defined in
 
-[PuppeteerReplayStringifyExtension.ts:25](https://github.com/puppeteer/replay/blob/main/src/PuppeteerReplayStringifyExtension.ts#L25)
+[PuppeteerReplayStringifyExtension.ts:26](https://github.com/puppeteer/replay/blob/main/src/PuppeteerReplayStringifyExtension.ts#L26)
 
 ---
 
@@ -157,4 +157,4 @@ Stringifies a user flow to a script that uses @puppeteer/replay's own API.
 
 #### Defined in
 
-[PuppeteerReplayStringifyExtension.ts:53](https://github.com/puppeteer/replay/blob/main/src/PuppeteerReplayStringifyExtension.ts#L53)
+[PuppeteerReplayStringifyExtension.ts:54](https://github.com/puppeteer/replay/blob/main/src/PuppeteerReplayStringifyExtension.ts#L54)
diff --git a/docs/api/classes/PuppeteerStringifyExtension.md b/docs/api/classes/PuppeteerStringifyExtension.md
@@ -57,7 +57,7 @@
 
 #### Defined in
 
-[PuppeteerStringifyExtension.ts:60](https://github.com/puppeteer/replay/blob/main/src/PuppeteerStringifyExtension.ts#L60)
+[PuppeteerStringifyExtension.ts:61](https://github.com/puppeteer/replay/blob/main/src/PuppeteerStringifyExtension.ts#L61)
 
 ---
 
@@ -108,7 +108,7 @@
 
 #### Defined in
 
-[PuppeteerStringifyExtension.ts:47](https://github.com/puppeteer/replay/blob/main/src/PuppeteerStringifyExtension.ts#L47)
+[PuppeteerStringifyExtension.ts:48](https://github.com/puppeteer/replay/blob/main/src/PuppeteerStringifyExtension.ts#L48)
 
 ---
 
@@ -160,4 +160,4 @@
 
 #### Defined in
 
-[PuppeteerStringifyExtension.ts:73](https://github.com/puppeteer/replay/blob/main/src/PuppeteerStringifyExtension.ts#L73)
+[PuppeteerStringifyExtension.ts:74](https://github.com/puppeteer/replay/blob/main/src/PuppeteerStringifyExtension.ts#L74)
diff --git a/docs/api/classes/StringifyExtension.md b/docs/api/classes/StringifyExtension.md
@@ -6,6 +6,8 @@
 
 - **`StringifyExtension`**
 
+  ↳ [`JSONStringifyExtension`](JSONStringifyExtension.md)
+
   ↳ [`PuppeteerStringifyExtension`](PuppeteerStringifyExtension.md)
 
   ↳ [`PuppeteerReplayStringifyExtension`](PuppeteerReplayStringifyExtension.md)

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@puppeteer/replay",
-  "version": "2.5.0",
+  "version": "2.6.0",
   "description": "Replay is a library which provides an API to replay and stringify recordings created using Chrome DevTools Recorder](https://developer.chrome.com/docs/devtools/recorder/)",
   "main": "lib/cjs/main.cjs",
   "types": "lib/main.d.ts",