Docs for saveState and restoreState

docs/command-line/index.mdx

@@ -192,6 +192,7 @@ testplane --repl --grep 'my test name' --browser chrome
 -   `--keep-browser-on-fail` - the same as the `--keep-browser` option, but the browser will only remain open if the tests fail.
 
 Example of console output with connection information to the browser:
+
 ```
 [15:44:38 +0700] Testplane run has finished, but the browser won't be closed, because you passed the --keep-browser argument.
 [15:44:38 +0700] You may attach to this browser using the following capabilities:

docs/commands/browser/restoreState.mdx

@@ -0,0 +1,70 @@
+import Admonition from "@theme/Admonition";
+
+# restoreState
+
+## Overview {#overview}
+
+Browser command that restores session state (cookies, local and session storages) from a file or variable.
+
+<Admonition type="warning">
+    If you are using the `webdriver` automation protocol, you have to provide `webSocketUrl: true`
+    in `desiredCapabilities` in config browser settings. For the `devtools` protocol, you don't need
+    additional settings.
+</Admonition>
+
+## Usage {#usage}
+
+You can restore state from file (using the `path` param) or from object (using the `data` param).
+But if you provide both, the file will have the highest priority.
+Also, you can provide `cookies`, `localStorage` and `sessionStorage` params to restore only what you need.
+Data for restore state you can get from the [saveState](../saveState) command.
+
+```typescript
+await browser.restoreState({
+    path: "./stateDump.json",
+    data: stateDump,
+    cookies: true,
+    localStorage: true,
+    sessionStorage: true,
+});
+```
+
+## Command Parameters {#parameters}
+
+<table>
+    <thead>
+    <tr><td>**Name**</td><td>**Type**</td><td>**Description**</td></tr>
+    </thead>
+    <tbody>
+    <tr><td>path</td><td>String</td><td>Path to file with state.</td></tr>
+    <tr><td>data</td><td>SaveStateData</td><td>Object with state.</td></tr>
+    <tr><td>cookies</td><td>Boolean</td><td>Enable restore cookies (true by default).</td></tr>
+    <tr><td>localStorage</td><td>Boolean</td><td>Enable restore localStorage (true by default).</td></tr>
+    <tr><td>sessionStorage</td><td>Boolean</td><td>Enable restore sessionStorage (true by default).</td></tr>
+    <tr><td>cookieFilter</td><td>(cookie: Cookie) => boolean</td><td>Function for filtering cookies, receiving cookie objects, and returning boolean.</td></tr>
+
+    </tbody>
+
+</table>
+
+## Usage Examples {#examples}
+
+Restore state from file.
+
+```typescript
+it("test", async ({ browser }) => {
+    await browser.url("https://github.com/gemini-testing/testplane");
+
+    await browser.restoreState({
+        path: "./stateDump.json",
+        cookieFilter: ({ domain }) => domain === ".example.com",
+    });
+
+    // Reload page for see auth result.
+    await browser.refresh();
+});
+```
+
+## Related Commands {#related}
+
+-   [saveState](../saveState)

docs/commands/browser/saveState.mdx

@@ -0,0 +1,67 @@
+import Admonition from "@theme/Admonition";
+
+# saveState
+
+## Overview {#overview}
+
+Browser command that saves session state (cookies, local and session storages).
+
+<Admonition type="warning">
+    If you are using the `webdriver` automation protocol, you have to provide `webSocketUrl: true`
+    in `desiredCapabilities` in config browser settings. For the `devtools` protocol, you don't need
+    additional settings.
+</Admonition>
+
+## Usage {#usage}
+
+Command return state dump from page; it will include cookie, localStorage, and sessionStorage.
+But using params, you can disable some data.
+Also, if you provide the `path` param, you can get a dump in a file.
+After saving the state, you can use it in the [restoreState](../restoreState) command.
+
+```typescript
+import type { SaveStateData } from "testplane";
+
+const stateDump: SaveStateData = await browser.saveState({
+    path: "./stateDump.json",
+    cookies: true,
+    localStorage: true,
+    sessionStorage: true,
+});
+```
+
+## Command Parameters {#parameters}
+
+<table>
+    <thead>
+    <tr><td>**Name**</td><td>**Type**</td><td>**Description**</td></tr>
+    </thead>
+    <tbody>
+    <tr><td>path</td><td>String</td><td>Path to file where state will be saved.</td></tr>
+    <tr><td>cookies</td><td>Boolean</td><td>Enable save cookies (true by default).</td></tr>
+    <tr><td>localStorage</td><td>Boolean</td><td>Enable save localStorage (true by default).</td></tr>
+    <tr><td>sessionStorage</td><td>Boolean</td><td>Enable save sessionStorage (true by default).</td></tr>
+    <tr><td>cookieFilter</td><td>(cookie: Cookie) => boolean</td><td>Function for filtering cookies, receiving cookie objects, and returning boolean.</td></tr>
+
+    </tbody>
+
+</table>
+
+## Usage Examples {#examples}
+
+Save state in file.
+
+```typescript
+it("test", async ({ browser }) => {
+    await browser.url("https://github.com/gemini-testing/testplane");
+
+    await browser.saveState({
+        path: "./stateDump.json",
+        cookieFilter: ({ domain }) => domain === ".example.com",
+    });
+});
+```
+
+## Related Commands {#related}
+
+-   [restoreState](../restoreState)

docs/config/after-all.mdx

@@ -0,0 +1,54 @@
+# afterAll
+
+## Overview {#overview}
+
+This parameter is a hook. The function specified for this parameter will be automatically called after tests are completed.
+
+The context of the function is the Testplane config. Also function receive config in arguments.
+
+## Usage Example {#example}
+
+Here is an example of suing this hook for logout.
+
+```typescript title="testplane.config.ts"
+import { launchBrowser } from "testplane/unstable";
+
+export default {
+    // ...
+    browsers: {
+        chrome: {
+            headless: true,
+            desiredCapabilities: {
+                webSocketUrl: true,
+                browserName: "chrome",
+            },
+        },
+        firefox: {
+            headless: true,
+            desiredCapabilities: {
+                webSocketUrl: true,
+                browserName: "firefox",
+            },
+        },
+    },
+    afterAll: async () => {
+        // launch a new browser with existing config
+        const browser = await launchBrowser(this.config.browsers.chrome);
+
+        await browser.url("https://example.com");
+
+        // login using saved state
+        await browser.restoreState({
+            path: "./dump.json",
+        });
+
+        // do logout things (press logout button etc.)
+
+        await browser.deleteSession();
+    },
+};
+```
+
+## Related {#related}
+
+-   [beforeAll](../before-all)

docs/config/before-all.mdx

@@ -0,0 +1,54 @@
+# beforeAll
+
+## Overview {#overview}
+
+This parameter is a hook. The function specified for this parameter will be automatically called before tests running.
+
+The context of the function is the Testplane config. Also function receive config in arguments.
+
+## Usage Example {#example}
+
+Here is an example of using this hook for logging in and getting session data for use in tests.
+
+```typescript title="testplane.config.ts"
+import { launchBrowser } from "testplane/unstable";
+
+export default {
+    // ...
+    browsers: {
+        chrome: {
+            headless: true,
+            desiredCapabilities: {
+                webSocketUrl: true,
+                browserName: "chrome",
+            },
+        },
+        firefox: {
+            headless: true,
+            desiredCapabilities: {
+                webSocketUrl: true,
+                browserName: "firefox",
+            },
+        },
+    },
+    beforeAll: async () => {
+        // launch a new browser with existing config
+        const browser = await launchBrowser(this.config.browsers.chrome);
+
+        await browser.url("https://example.com");
+
+        // do login things, type username/password etc.
+
+        // save dump with state (cookies, localStorage) for using in tests
+        await browser.saveState({
+            path: "./dump.json",
+        });
+
+        await browser.deleteSession();
+    },
+};
+```
+
+## Related {#related}
+
+-   [afterAll](../after-all)

docs/reference/testplane-standalone-api.mdx

@@ -18,7 +18,7 @@ import { launchBrowser } from "testplane/unstable";
 // Launch a new browser with the given settings
 const browser = await launchBrowser({
     desiredCapabilities: {
-        browserName: 'chrome',
+        browserName: "chrome",
     },
     headless: false,
 });

i18n/ru/docusaurus-plugin-content-docs/current/command-line/index.mdx

@@ -193,6 +193,7 @@ testplane --repl --grep 'my test name' --browser chrome
 -   `--keep-browser-on-fail` - то же, что и опция `--keep-browser`, только браузер останется только в том случае, если тесты завершатся неуспешно
 
 Пример вывода в консоли c информацией для подключения к браузеру
+
 ```
 [15:44:38 +0700] Testplane run has finished, but the browser won't be closed, because you passed the --keep-browser argument.
 [15:44:38 +0700] You may attach to this browser using the following capabilities:

i18n/ru/docusaurus-plugin-content-docs/current/commands/browser/restoreState.mdx

@@ -0,0 +1,70 @@
+import Admonition from "@theme/Admonition";
+
+# restoreState
+
+## Обзор {#overview}
+
+Команда для восстановления данных (cookies, local and session storages) из файла или объекта.
+
+<Admonition type="warning">
+    Если вы используете `webdriver` automation protocol вы должны установить `webSocketUrl: true` в
+    `desiredCapabilities` для браузера в конфиге. Для `devtools` protocol не нужно дополнительных
+    настроек.
+</Admonition>
+
+## Использование {#usage}
+
+Вы можете восстановить данные из файла (используя параметр `path`) или из объекта (используя параметр`data`)
+Но если вы укажете оба параметра то данные восстановятся из файла.
+Так же вы можете указать параметры `cookies`, `localStorage` и `sessionStorage` что бы восстановить только нужные данные.
+Данные для восстановления вы можете получить из команды [saveState](../saveState).
+
+## Параметры команды {#parameters}
+
+<table>
+    <thead>
+    <tr><td>**Имя**</td><td>**Тип**</td><td>**Описание**</td></tr>
+    </thead>
+    <tbody>
+    <tr><td>path</td><td>String</td><td>Путь к файлу с данными.</td></tr>
+    <tr><td>data</td><td>SaveStateData</td><td>Объект с данными.</td></tr>
+    <tr><td>cookies</td><td>Boolean</td><td>Включить восстановление кук (true по умолчанию).</td></tr>
+    <tr><td>localStorage</td><td>Boolean</td><td>Включить восстановление localStorage (true по умолчанию).</td></tr>
+    <tr><td>sessionStorage</td><td>Boolean</td><td>Включить восстановление sessionStorage (true по умолчанию).</td></tr>
+    <tr><td>cookieFilter</td><td>(cookie: Cookie) => boolean</td><td>Функция для фильтрации кук, принимает объект куки и возвращает boolean.</td></tr>
+
+    </tbody>
+
+</table>
+
+```typescript
+await browser.restoreState({
+    path: "./stateDump.json",
+    data: stateDump,
+    cookies: true,
+    localStorage: true,
+    sessionStorage: true,
+});
+```
+
+## Примеры использования {#examples}
+
+Восстановление данных из файла.
+
+```typescript
+it("test", async ({ browser }) => {
+    await browser.url("https://github.com/gemini-testing/testplane");
+
+    await browser.restoreState({
+        path: "./stateDump.json",
+        cookieFilter: ({ domain }) => domain === ".example.com",
+    });
+
+    // Reload page for see auth result.
+    await browser.refresh();
+});
+```
+
+## Связанные команды {#related}
+
+-   [saveState](../saveState)