fixed whitespacs, updaetd docs

Author: DavertMik

docs/changelog.md

@@ -7,6 +7,81 @@ layout: Section
 
 # Releases
 
+## 3.3.5
+
+🛩️ Features
+
+* Added **[TypeScript option](/typescript)** for installation via `codeceptjs init` to initialize new projects in TS (by **[PeterNgTr](https://github.com/PeterNgTr)** and **[davertmik](https://github.com/davertmik)**)
+* Include `node-ts` automatically when using TypeScript setup
+* Added TS types for CodeceptJS config. Update `codecept.conf.js` to get intellisense when writing config file: 
+
+```js
+// inside codecept.conf.js
+/** **[type](https://github.com/type)** {CodeceptJS.MainConfig} */
+exports.config = {
+  //...
+}
+```
+* Added TS types for helpers config:
+  * Playwright
+  * Puppeteer
+  * WebDriver
+  * REST
+
+🐛 Bugfixes
+
+* **[Puppeteer]** Fixed support for Puppeteer > 14.4 by **[PeterNgTr](https://github.com/PeterNgTr)** 
+* Don't report files as existing when non-directory is in path by **[jonathanperret](https://github.com/jonathanperret)**. See [#3374](https://github.com/codeceptjs/CodeceptJS/issues/3374)
+* Fixed TS type for `secret` function by **[PeterNgTr](https://github.com/PeterNgTr)** 
+* Fixed wrong order for async MetaSteps by **[dwentland24](https://github.com/dwentland24)**. See [#3393](https://github.com/codeceptjs/CodeceptJS/issues/3393)
+* Fixed same param substitution in BDD step. See [#3385](https://github.com/codeceptjs/CodeceptJS/issues/3385) by **[snehabhandge](https://github.com/snehabhandge)** 
+
+📖 Documentation
+
+* Updated [configuration options](https://codecept.io/configuration/) to match TypeScript types
+* Updated [TypeScript documentation](https://codecept.io/typescript/) on simplifying TS installation
+* Added codecept-tesults plugin documentation by **[ajeetd](https://github.com/ajeetd)** 
+
+
+
+## 3.3.4
+
+* Added support for masking fields in objects via `secret` function:
+
+```js
+I.sendPostRequest('/auth', secret({ name: 'jon', password: '123456' }, 'password'));
+```
+* Added [a guide about using of `secret`](/secrets) function
+* **[Appium]** Use `touchClick` when interacting with elements in iOS. See [#3317](https://github.com/codeceptjs/CodeceptJS/issues/3317) by **[mikk150](https://github.com/mikk150)**
+* **[Playwright]** Added `cdpConnection` option to connect over CDP. See [#3309](https://github.com/codeceptjs/CodeceptJS/issues/3309) by **[Hmihaly](https://github.com/Hmihaly)** 
+* [customLocator plugin] Allowed to specify multiple attributes for custom locator. Thanks to **[aruiz-caritsqa](https://github.com/aruiz-caritsqa)**
+
+```js
+plugins: {
+ customLocator: {
+   enabled: true,
+   prefix: '$',
+   attribute: ['data-qa', 'data-test'],
+ }
+}
+```
+* [retryTo plugin] Fixed [#3147](https://github.com/codeceptjs/CodeceptJS/issues/3147) using `pollInterval` option. See [#3351](https://github.com/codeceptjs/CodeceptJS/issues/3351) by **[cyonkee](https://github.com/cyonkee)**
+* **[Playwright]** Fixed grabbing of browser console messages and window resize in new tab. Thanks to **[mirao](https://github.com/mirao)**
+* **[REST]** Added `prettyPrintJson` option to print JSON in nice way by **[PeterNgTr](https://github.com/PeterNgTr)** 
+* **[JSONResponse]** Updated response validation to iterate over array items if response is array. Thanks to **[PeterNgTr](https://github.com/PeterNgTr)**
+
+```js
+// response.data == [
+//   { user: { name: 'jon', email: 'jon@doe.com' } },
+//   { user: { name: 'matt', email: 'matt@doe.com' } },
+//]
+
+I.seeResponseContainsKeys(['user']);
+I.seeResponseContainsJson({ user: { email: 'jon@doe.com' } });
+I.seeResponseContainsJson({ user: { email: 'matt@doe.com' } });
+I.dontSeeResponseContainsJson({ user: 2 });
+```
+
 ## 3.3.3
 
 * Fixed `DataCloneError: () => could not be cloned` when running data tests in run-workers

docs/community-helpers.md

@@ -9,11 +9,16 @@ editLink: false
 
 Here is the list of helpers created by our community.
 Please **add your own** by editing this page.
+## Webhooks
+
+* [codeceptjs-webhook-helper](https://github.com/onemolegames/codeceptjs-webhook-helper) - to check webhook calls during the tests.
 
 ## Email Checking
 
 * [MailCatcher](https://gist.github.com/schmkr/026732dfa1627b927ff3a08dc31ee884) - to check emails via Mailcatcher locally.
 * [codeceptjs-mailhog-helper](https://github.com/tsuemura/codeceptjs-mailhog-helper) - to check emails via Mailhog locally.
+* [codeceptjs-testmailapp-helper](https://github.com/pavkam/codeceptjs-testmailapp-helper) - to check emails via Testmail.app service.
+* [codeceptjs-mailosaurhelper](https://github.com/yurkovychv/codeceptjs-mailosaur) - to check emails via [Mailosaur](https://mailosaur.com/) service.
 
 ## Data Sources
 
@@ -32,15 +37,13 @@ Please **add your own** by editing this page.
 ## Visual-Testing
 * [codeceptjs-resemblehelper](https://github.com/puneet0191/codeceptjs-resemblehelper) - a helper which helps with visual testing using resemble.js. 
 * [codeceptjs-applitoolshelper](https://www.npmjs.com/package/codeceptjs-applitoolshelper) - a helper which helps interaction with [Applitools](https://applitools.com)
+* [codeceptjs-pixelmatchhelper](https://github.com/stracker-phil/codeceptjs-pixelmatchhelper) - a helper that integrates pixelmatch for visual testing. 
 
 ## Reporters
 * [codeceptjs-rphelper](https://github.com/reportportal/agent-js-codecept) is a CodeceptJS helper which can publish tests results on ReportPortal after execution.
 * [codeceptjs-xray-helper](https://www.npmjs.com/package/codeceptjs-xray-helper) is a CodeceptJS helper which can publish tests results on [XRAY](https://confluence.xpand-it.com/display/XRAYCLOUD/Import+Execution+Results+-+REST).
 * [codeceptjs-slack-reporter](https://www.npmjs.com/package/codeceptjs-slack-reporter) Get a Slack notification when one or more scenarios fail.
-* [codeceptjs-tesults](https://www.npmjs.com/package/codeceptjs-tesults) Report test results data from CodeceptJS to Tesults with this plugin.
-
-## Page Object Code Generator
-* [codeceptjs-CodeGenerator](https://github.com/senthillkumar/CodeCeptJS-PageObject) is a CodeceptJS custom wrapper which can create page class with action methods from the page object file(JSON) and project setup(Folder Structure).
+* [codeceptjs-browserlogs-plugin](https://github.com/pavkam/codeceptjs-browserlogs-plugin) Record the browser logs for failed tests.
 
 ## Browser request control
 * [codeceptjs-resources-check](https://github.com/luarmr/codeceptjs-resources-check) Load a URL with Puppeteer and listen to the requests while the page is loading. Enabling count the number or check the sizes of the requests.

docs/examples.md

@@ -29,11 +29,35 @@ CodeceptJS repo contains basic tests (both failing and passing) just to show how
 Our team uses it to test new features and run simple scenarios.
 
 
-## [Testing Single Page Application](https://github.com/bugiratracker/codeceptjs-demo)
+## [CodeceptJS Cucumber E2E Framework](https://github.com/gkushang/codeceptjs-e2e)
 
-![](https://user-images.githubusercontent.com/220264/56353972-56975080-61db-11e9-8b23-06e8b4620995.png)
+This repository contains complete E2E framework for CodeceptJS with Cucumber and SauceLabs Integration
 
-End 2 end tests for [Bugira Bugtracker](https://bugira.com) app built with Rails & EmberJS. Bugira is a SaaS application that helps collecting users' feedbacks and transforming them into professional bug reports.
+* CodecepJS-Cucumber E2E Framework
+* Saucelabs Integration
+* Run Cross Browser tests in Parallel on SauceLabs with a simple command
+* Run tests on `chrome:headless`
+* Page Objects
+* `Should.js` Assertion Library
+* Uses `wdio` service (selenium-standalone, sauce)
+* Allure HTML Reports
+* Uses shared Master configuration
+* Sample example and feature files of GitHub Features
+
+## [Enterprise Grade Tests](https://github.com/uc-cdis/gen3-qa)
+
+Complex testing solution by [Gen3](https://github.com/uc-cdis/gen3-qa) 
+
+Includes 
+
+* classical CodeceptJS tests
+* BDD tests
+* Jenkins integration
+* Complex Before/BeforeSuite scripts and more
+
+## [Testing Single Page Application](https://github.com/bugiratracker/codeceptjs-demo)
+
+End 2 end tests for Task management app (currently offline).
 
 Tests repository demonstrate usage of
 
@@ -52,21 +76,6 @@ This repository demonstrates usage of:
 * testing WYSIWYG editor
 * GitLab CI
 
-## [CodeceptJS Cucumber E2E Framework](https://github.com/gkushang/codeceptjs-e2e)
-
-This repository contains complete E2E framework for CodeceptJS with Cucumber and SauceLabs Integration
-
-* CodecepJS-Cucumber E2E Framework
-* Saucelabs Integration
-* Run Cross Browser tests in Parallel on SauceLabs with a simple command
-* Run tests on `chrome:headless`
-* Page Objects
-* `Should.js` Assertion Library
-* Uses `wdio` service (selenium-standalone, sauce)
-* Allure HTML Reports
-* Uses shared Master configuration
-* Sample example and feature files of GitHub Features
-
 ## [Amazon Tests v2](https://gitlab.com/thanhnguyendh/codeceptjs-wdio-services)
 
 Testing Amazon website using Selenium WebDriver.
@@ -79,17 +88,6 @@ This repository demonstrates usage of:
 * Parallel execution
 * GitLab CI setup
 
-## [Amazon Tests v1](https://github.com/PeterNgTr/amazon-ui-tests)
-
-Previous version of Amazon Tests, still valid but quite different.
-
-This repository demonstrates usage of:
-
-* WebDriver helper
-* Page Objects
-* Bootstrap and teardown
-* Parallel execution
-
 ## [Tests with Docker Compose](https://github.com/mathesouza/codeceptjs-docker-compose)
 
 Running CodeceptJS tests with Docker Compose
@@ -101,17 +99,6 @@ This repository demonstrates usage of:
 * Allure plugin
 
 
-## [ModusCreate Tests](https://github.com/ModusCreateOrg/codeceptjs-nightmare-harness)
-
-Test automation by ModusCreate agency with NightmareJS.
-
-This repository demonstrates usage of:
-
-* Nightmare helper
-* Reports with Mochawesome
-* Docker
-* Page objects and page fragments
-
 ## [AngularJS Example Tests](https://github.com/armno/angular-e2e-codeceptjs-example)
 
 Based on [Setting up End-to-End Testing in Angular Project with CodeceptJS](https://medium.com/@armno/setting-up-end-to-end-testing-in-angular-project-with-codeceptjs-ac1784de3420) post by Armno Prommarak.
@@ -147,12 +134,16 @@ This is a ready to use example that shows how to integrate CodeceptJS with Puppe
 * examples for sequential and parallel execution
 * generation of allure test results  
 
-## [Framework with UI and API test support : CodeceptJS , Puppeteer , REST , ESLint](https://github.com/avighub/CodeceptJS-puppeteer)
-This is a basic framework with Puppeteer , REST helpers which can support both UI and API actions within same test.
-More improvements and features will be added and will be updated. 
-Suggestions and improvements are welcome , please raise a ticket in Issue tab.
+## [Example for Advanced REST API testing: TypeScript, Axios, CodeceptJS, Jest Expect, Docker, Allure, Mock-Server, Prettier + Eslint, pre-commit, Jest Unit Tests ](https://github.com/EgorBodnar/rest-axios-codeceptjs-allure-docker-test-example)
+One button example with built-in mocked backend. 
+
+If you already have a UI testing solution based on the CodeceptJS and you need to implement advanced REST API testing you can just extend your existing framework. Use this implementation as an example.
+This is necessary if all integrations with TMS and CI/CD are already configured, and you do not want to reconnect and configure the plugins and libraries used for the new test runner. Use CodeceptJS!
 
-* Step by step setup in README
-* Two helpers are added. UI - Puppeteer , API - REST and chai-codeceptJS for assetion
-* ESLint for code check
-* Upcoming : API generic functions , Adaptor design pattern , More utilities
+* Easy run
+* Detailed README
+* Well documented mocked backend's REST API endpoints
+* HTTP request client with session support and unit tests
+* Exemplary code control
+* Ready to launch in a CI/CD system as is
+* OOP, Test data models and builders, endpoint decorators