feat(testplane): fixes

Author: rocketraccoon

docs/commands/browser/restoreState.mdx

@@ -1,23 +1,18 @@
-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.
+You can restore the browser state from either a file (using the `path` parameter) or directly from an object (using the `data` parameter).
+
+**Important:** If you provide both `path` and `data` parameters, the file specified in `path` will take priority.
+
+You can optionally specify which storage types to restore using the `cookies`, `localStorage`, and `sessionStorage` parameters. This allows you to restore only the specific data you need.
+
+The state data for restoration can be obtained from the [saveState](../saveState) command.
 
 ```typescript
 await browser.restoreState({
@@ -36,12 +31,12 @@ await browser.restoreState({
     <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>
+    <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>
 

docs/commands/browser/saveState.mdx

@@ -1,23 +1,16 @@
-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.
+This command returns a state of the page state, including cookies, localStorage, and sessionStorage.
+You can use parameters to exclude specific types of data if needed.
+
+If you provide the `path` parameter, the state dump will be saved to a file.
+The saved state can later be restored using the [restoreState](../restoreState) command.
 
 ```typescript
 import type { SaveStateData } from "testplane";
@@ -37,11 +30,11 @@ const stateDump: SaveStateData = await browser.saveState({
     <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>
+    <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>
 

docs/config/after-all.mdx

@@ -8,43 +8,15 @@ The context of the function is the Testplane config. Also function receive confi
 
 ## Usage Example {#example}
 
-Here is an example of suing this hook for logout.
+Here is an example of using this hook to remove a file with a page state.
 
 ```typescript title="testplane.config.ts"
-import { launchBrowser } from "testplane/unstable";
+import * as fs from "fs";
 
 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();
+        await fs.unlink("./dump.json");
     },
 };
 ```

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

@@ -1,23 +1,18 @@
-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).
+Вы можете восстановить состояние браузера из файла (с помощью параметра `path`) или непосредственно из объекта (с помощью параметра `data`).
+
+**Важно:** Если вы указали оба параметра `path` и `data`, приоритет будет у файла, указанного в `path`.
+
+При необходимости вы можете указать, какие типы данных восстановить, используя параметры `cookies`, `localStorage` и `sessionStorage`. Это позволяет восстановить только те данные, которые вам нужны.
+
+Данные для восстановления состояния можно получить с помощью команды [saveState](../saveState).
 
 ## Параметры команды {#parameters}
 
@@ -26,12 +21,12 @@ import Admonition from "@theme/Admonition";
     <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>
+    <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>
 

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

@@ -1,23 +1,16 @@
-import Admonition from "@theme/Admonition";
-
 # saveState
 
 ## Обзор {#overview}
 
 Команда для сохранения состояния страницы (cookies, local и session storages).
 
-<Admonition type="warning">
-    Если вы используете `webdriver` automation protocol вы должны установить `webSocketUrl: true` в
-    `desiredCapabilities` для браузера в конфиге. Для `devtools` protocol не нужно дополнительных
-    настроек.
-</Admonition>
-
 ## Использование {#usage}
 
-Команда вернёт объект включающий cookie, localStorage и sessionStorage.
-Используя параметры вы можете выключить сохранение отдельных данных.
-Так же вы можете указать параметр `path` и получить файл с данными.
-После сохранения вы можете использовать результат в команде [restoreState](../restoreState).
+Эта команда возвращает снимок состояния страницы, включая cookies, localStorage и sessionStorage.
+С помощью параметров вы можете при необходимости исключить определённые типы данных.
+
+Если вы укажете параметр `path`, снимок состояния будет сохранён в файл.
+Сохранённое состояние можно впоследствии восстановить с помощью команды [restoreState](../restoreState).
 
 ```typescript
 import type { SaveStateData } from "testplane";
@@ -37,11 +30,11 @@ const stateDump: SaveStateData = await browser.saveState({
     <tr><td>**Имя**</td><td>**Тип**</td><td>**Описание**</td></tr>
     </thead>
     <tbody>
-    <tr><td>path</td><td>String</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>
+    <tr><td>path</td><td>`string`</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>
 

i18n/ru/docusaurus-plugin-content-docs/current/config/after-all.mdx

@@ -8,43 +8,15 @@
 
 ## Пример использования {#example}
 
-Пример разлогина после выполнения тестов.
+Пример удаления файла с состоянием страницы после выполнения тестов.
 
 ```typescript title="testplane.config.ts"
-import { launchBrowser } from "testplane/unstable";
+import * as fs from "fs";
 
 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();
+        fs.unlinkSync("dump.json");
     },
 };
 ```