release: [email protected]

Author: NickVolynkin

package-lock.json

@@ -1,11 +1,25 @@
 # Qase JavaScript Commons
 
-This package contains common classes and functions for working with Qase TMS API.
+This module is an SDK for developing test reporters for Qase TMS.
+It's using `qaseio` as an API client, and all Qase reporters are, in turn,
+using this package.
+You should use it if you're developing your own test reporter for a special-purpose framework.
+
+To report results from tests using a popular framework or test runner,
+don't install this module directly and
+use the corresponding reporter module instead:
+
+* [CucumberJS](https://github.com/qase-tms/qase-javascript/tree/main/qase-cucumberjs#readme)
+* [Cypress](https://github.com/qase-tms/qase-javascript/tree/main/qase-cypress#readme)
+* [Jest](https://github.com/qase-tms/qase-javascript/tree/main/qase-jest#readme)
+* [Newman](https://github.com/qase-tms/qase-javascript/tree/main/qase-newman#readme)
+* [Playwright](https://github.com/qase-tms/qase-javascript/tree/main/qase-playwright#readme)
+* [TestCafe](https://github.com/qase-tms/qase-javascript/tree/main/qase-testcafe#readme)
 
 ## Installation
 
 ```bash
-npm install qase-javascript-commons@beta
+npm install qase-javascript-commons
 ```
 
 ## Configuration

qase-javascript-commons/README.md

@@ -1,3 +1,56 @@
+# [email protected]
+
+## What's new
+
+This is the first release version of the Qase JavaScript SDK.
+It is numbered `2.0.0` (and not `1.0.0`) to match the release series of 
+test reporters for Playwright, Cypress, Jest and other frameworks.
+
+### Annotating test with field data
+
+Tests can now be annotated with data for system and custom fields in Qase.
+This feature is already implemented in the Playwright reporter:
+
+```js
+test('Test with annotated fields', () => {
+    qase.id(1);
+    qase.fields({ 'severity': 'high', 'priority': 'medium' })
+    // ...
+});
+```
+
+### Parametrized tests
+
+Qase JavaScript SDK enables annotating tests with parameters, and passing parameter values to Qase.
+Parameterized tests can report to a single test case, but each parameter variation is registered as
+a standalone result, with its own run history.
+
+### Attachments from files and variables
+
+Reporters can now upload attachments of various data types to Qase,
+both from files and from variables.
+It enables flexible and meticulous logging, such as collecting full HTTP request data,
+including URL, headers, and payload.
+
+### Uploading results in flexible batches, asynchronously
+
+Test reporters can now upload results in batches, while tests are still running.
+It helps bring test results faster and enables acting on them long before the test run is complete.
+
+### Uniform configuration
+
+Qase JavaScript SDK brings configuration with config files and environment variables
+to a common standard, used with Qase reporters in all languages and frameworks.
+
+For details, see the Configuration section in the README.
+
+### Latest API
+
+Qase JavaScript SDK is using the latest Qase API client,
+employing the full power of the stable v1 API version,
+and enabling the use of experimental v2 API, tailored for uploading
+huge amounts of test results.
+
 # [email protected]
 
 ## What's new

qase-javascript-commons/changelog.md

@@ -1,6 +1,6 @@
 {
   "name": "qase-javascript-commons",
-  "version": "2.0.0-beta.12",
+  "version": "2.0.0",
   "description": "Qase JS Reporters",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -21,7 +21,7 @@
     "test": "jest --passWithNoTests",
     "clean": "rm -rf dist"
   },
-  "author": "Dimitri Harding <[email protected]>",
+  "author": "Qase Team <[email protected]>",
   "license": "Apache-2.0",
   "dependencies": {
     "ajv": "^8.12.0",
@@ -33,7 +33,7 @@
     "lodash.merge": "^4.6.2",
     "lodash.mergewith": "^4.6.2",
     "mime-types": "^2.1.33",
-    "qaseio": "^2.1.0-beta.1",
+    "qaseio": "^2.1.0",
     "strip-ansi": "^6.0.1",
     "uuid": "^9.0.0"
   },