docs: add automatically generated API documentation (#13)

.eslintrc.cjs

@@ -11,10 +11,12 @@ module.exports = {
     ecmaVersion: "latest",
     sourceType: "module",
   },
-  plugins: ["@typescript-eslint"],
+  plugins: ["@typescript-eslint", "eslint-plugin-tsdoc"],
   rules: {
     "require-jsdoc": 0,
     "no-redeclare": 0,
     "valid-jsdoc": 0, // Figure jsdoc once we look into documentation.
+    "tsdoc/syntax": "warn"
   },
+  ignorePatterns: ["third_party/**/*"],
 };

docs/.nojekyll

@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

docs/README.md

@@ -0,0 +1,28 @@
+@puppeteer/replay / [Exports](modules.md)
+
+# @puppeteer/replay
+
+> 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/)
+
+## Source Code Headers
+
+Every file containing source code must include copyright and license
+information. This includes any JS/CSS files that you might be serving out to
+browsers. (This is to help well-intentioned people avoid accidental copying that
+doesn't comply with the license.)
+
+Apache header:
+
+    Copyright 2022 Google LLC
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+        https://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.

docs/classes/PuppeteerRunnerExtension.md

@@ -0,0 +1,97 @@
+[@puppeteer/replay](../README.md) / [Exports](../modules.md) / PuppeteerRunnerExtension
+
+# Class: PuppeteerRunnerExtension
+
+## Implements
+
+- [`RunnerExtension`](../interfaces/RunnerExtension.md)
+
+## Table of contents
+
+### Constructors
+
+- [constructor](PuppeteerRunnerExtension.md#constructor)
+
+### Properties
+
+- [browser](PuppeteerRunnerExtension.md#browser)
+- [page](PuppeteerRunnerExtension.md#page)
+- [timeout](PuppeteerRunnerExtension.md#timeout)
+
+### Methods
+
+- [runStep](PuppeteerRunnerExtension.md#runstep)
+
+## Constructors
+
+### constructor
+
+• **new PuppeteerRunnerExtension**(`browser`, `page`, `opts?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `browser` | `Browser` |
+| `page` | `Page` |
+| `opts?` | `Object` |
+| `opts.timeout?` | `number` |
+
+#### Defined in
+
+[PuppeteerRunnerExtension.ts:29](https://github.com/puppeteer/replay/blob/34579ab/src/PuppeteerRunnerExtension.ts#L29)
+
+## Properties
+
+### browser
+
+• `Protected` **browser**: `Browser`
+
+#### Defined in
+
+[PuppeteerRunnerExtension.ts:25](https://github.com/puppeteer/replay/blob/34579ab/src/PuppeteerRunnerExtension.ts#L25)
+
+___
+
+### page
+
+• `Protected` **page**: `Page`
+
+#### Defined in
+
+[PuppeteerRunnerExtension.ts:26](https://github.com/puppeteer/replay/blob/34579ab/src/PuppeteerRunnerExtension.ts#L26)
+
+___
+
+### timeout
+
+• `Protected` **timeout**: `number`
+
+#### Defined in
+
+[PuppeteerRunnerExtension.ts:27](https://github.com/puppeteer/replay/blob/34579ab/src/PuppeteerRunnerExtension.ts#L27)
+
+## Methods
+
+### runStep
+
+▸ **runStep**(`step`, `flow`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `step` | [`Step`](../modules/Schema.md#step) |
+| `flow` | [`UserFlow`](../interfaces/Schema.UserFlow.md) |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Implementation of
+
+[RunnerExtension](../interfaces/RunnerExtension.md).[runStep](../interfaces/RunnerExtension.md#runstep)
+
+#### Defined in
+
+[PuppeteerRunnerExtension.ts:35](https://github.com/puppeteer/replay/blob/34579ab/src/PuppeteerRunnerExtension.ts#L35)

docs/classes/PuppeteerStringifyExtension.md

@@ -0,0 +1,101 @@
+[@puppeteer/replay](../README.md) / [Exports](../modules.md) / PuppeteerStringifyExtension
+
+# Class: PuppeteerStringifyExtension
+
+## Implements
+
+- [`StringifyExtension`](../interfaces/StringifyExtension.md)
+
+## Table of contents
+
+### Constructors
+
+- [constructor](PuppeteerStringifyExtension.md#constructor)
+
+### Methods
+
+- [afterAllSteps](PuppeteerStringifyExtension.md#afterallsteps)
+- [beforeAllSteps](PuppeteerStringifyExtension.md#beforeallsteps)
+- [stringifyStep](PuppeteerStringifyExtension.md#stringifystep)
+
+## Constructors
+
+### constructor
+
+• **new PuppeteerStringifyExtension**()
+
+## Methods
+
+### afterAllSteps
+
+▸ **afterAllSteps**(`out`, `flow`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `out` | [`LineWriter`](../interfaces/LineWriter.md) |
+| `flow` | [`UserFlow`](../interfaces/Schema.UserFlow.md) |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Implementation of
+
+[StringifyExtension](../interfaces/StringifyExtension.md).[afterAllSteps](../interfaces/StringifyExtension.md#afterallsteps)
+
+#### Defined in
+
+[PuppeteerStringifyExtension.ts:60](https://github.com/puppeteer/replay/blob/34579ab/src/PuppeteerStringifyExtension.ts#L60)
+
+___
+
+### beforeAllSteps
+
+▸ **beforeAllSteps**(`out`, `flow`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `out` | [`LineWriter`](../interfaces/LineWriter.md) |
+| `flow` | [`UserFlow`](../interfaces/Schema.UserFlow.md) |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Implementation of
+
+[StringifyExtension](../interfaces/StringifyExtension.md).[beforeAllSteps](../interfaces/StringifyExtension.md#beforeallsteps)
+
+#### Defined in
+
+[PuppeteerStringifyExtension.ts:43](https://github.com/puppeteer/replay/blob/34579ab/src/PuppeteerStringifyExtension.ts#L43)
+
+___
+
+### 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`\>
+
+#### Implementation of
+
+[StringifyExtension](../interfaces/StringifyExtension.md).[stringifyStep](../interfaces/StringifyExtension.md#stringifystep)
+
+#### Defined in
+
+[PuppeteerStringifyExtension.ts:66](https://github.com/puppeteer/replay/blob/34579ab/src/PuppeteerStringifyExtension.ts#L66)

docs/classes/Runner.md

@@ -0,0 +1,29 @@
+[@puppeteer/replay](../README.md) / [Exports](../modules.md) / Runner
+
+# Class: Runner
+
+## Table of contents
+
+### Methods
+
+- [run](Runner.md#run)
+
+## Methods
+
+### run
+
+▸ **run**(`stepIdx?`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `stepIdx?` | `number` | Run the flow up until the step with the `stepIdx` index. |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[Runner.ts:39](https://github.com/puppeteer/replay/blob/34579ab/src/Runner.ts#L39)