added memory value parameter type (#192) (#193)

* added memory value parameter type (#192)
* added _validation_ parameter type (#194)
* added validation to world (#195)
* updated validation parameter type (#196)
* fixed d.ts for new _MemoryValue_ and _Validation_ types (#201)
* added memory to world (#202)
* made getValue as any

---------

Co-authored-by: Alexandr Legchilov <[email protected]>

Author: AlexGalichenko

.github/workflows/pull-request.yml

@@ -4,6 +4,8 @@ on:
   pull_request:
     branches:
       - main
+      - v1
+      - v2
 
 jobs:
   unix:

CHANGELOG.MD

@@ -10,12 +10,23 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
 :pencil: - chore  
 :microscope: - experimental
 
-## [unreleased]
-- :beetle: fixed publishing workflow
-- :pencil: updated dependencies
+## 2.1.1
+- :pencil: bump memory version
 
-## 2.0.0 
-- :rocket: added v2 implementation
+## 2.1.0
+- :rocket: added memory to world
+- :rocket: updated `world.getValue` and `world.setValue` to use bound memory
+
+## 2.0.2
+- :beetle: fixed d.ts for new _MemoryValue_ and _Validation_ types
+
+## 2.0.1
+- :rocket: adjust dependencies
+
+## 2.0.0
+- :rocket: package renamed to @qavajs/core
+- :rocket: added _value_ parameter type
+- :rocket: added _validation_ parameter type
 
 ## 0.40.0
 - :rocket: added config type definition

README.MD

@@ -1,10 +1,10 @@
-[![npm version](https://badge.fury.io/js/@qavajs%2Fcli.svg)](https://badge.fury.io/js/@qavajs%2Fcli)
+[![npm version](https://badge.fury.io/js/@qavajs%2Fcore.svg)](https://badge.fury.io/js/@qavajs%2Fcore)
 
-## @qavajs/cli
+## @qavajs/core
 
-Cli for @qavajs framework.
+@qavajs framework core
 
-`npm install @qavajs/cli`
+`npm install @qavajs/core`
 
 Run tests
 
@@ -51,12 +51,34 @@ All params that you passed to qavajs cli will be available in CLI_ARGV environme
 
 ### Override step definition
 ```javascript
-const { Override } = require('@qavajs/cli/utils');
+const { Override } = require('@qavajs/core/utils');
 
 When('I do test', async function() {});
 
 Override('I do test', async function() {
-    console.log('I am overridden')
+    console.log('I am overridden');
+});
+```
+
+### Memory value parameter type
+_value_ parameter type provides API to access memory
+
+```javascript
+When('Read memory {value}', async function(memoryValue) {
+    expect(memoryValue.value()).to.equal('ts');
+});
+
+When('Set memory {value} as {string}', async function(memoryKey, value) {
+    memoryKey.set(value);
+});
+```
+
+### Validation parameter type
+_validation_ parameter type provides API to verify values by certain condition
+
+```javascript
+When('I expect {string} {validation} {string}', async function(value1, validate, value2) {
+    validate(value1, value2);
 });
 ```
 
@@ -92,3 +114,4 @@ Module extends CucumberJS world with additional entities
 | executeStep | function | programmatically execute certain step definition | `await this.executeStep("I type 'username' to 'Username Input'");` |
 | setValue    | function | set memory value                                 | `await this.setValue('key', 'value');`                             |
 | getValue    | function | get memory value or expression                   | `await this.getValue('$key');`                                     |
+| validation  | function | get validation function based                    | `await this.getValue('to equal');`                                 |

index.d.ts

@@ -1,2 +1,152 @@
-export * from './src/IQavajsWorld';
-export * from './src/IQavajsConfig';
+import { DataTable, IWorld } from '@cucumber/cucumber';
+import { IConfiguration, IRunResult } from '@cucumber/cucumber/api';
+
+/**
+ * Validation function
+ * @example
+ * expect(actualValue, expectedValue);
+ * expect.poll(actualValue, expectedValue)
+ */
+export interface Validation {
+    /**
+     * Perform polling validation
+     * @param {any} actualResult - actual result
+     * @param {any} expectedResult - expected result
+     */
+    (actualResult: any, expectedResult: any): void;
+    /**
+     * @property
+     * original expression passed to memory value
+     */
+    type: string;
+    /**
+     * Perform polling validation
+     * @param {any} actualResult - actual result
+     * @param {any} expectedResult - expected result
+     * @param {number} options.timeout - timeout to poll
+     * @param {number} options.interval - interval to poll
+     */
+    poll: (AR: any, ER: any, options?: {timeout?: number, interval?: number}) => Promise<unknown>
+}
+
+/**
+ * Memory value
+ * @example
+ * memoryValue.value();
+ * memoryValue.set('some data')
+ */
+export interface MemoryValue {
+    /**
+     * @property
+     * original expression passed to memory value
+     */
+    expression: string;
+    /**
+     * Return resolved value
+     * @example
+     * url.value()
+     * @return Promise<any>
+     */
+    value(): any;
+
+    /**
+     * Set value to memory with provided key
+     * @param {any} value - value to set
+     * @example
+     * url.set('https://qavajs.github.io/')
+     */
+    set(value: any): void;
+}
+
+export interface IQavajsWorld extends IWorld {
+    /**
+     * Get value from memory
+     * @param {any} expression - expression to parse
+     */
+    getValue(expression: any): any;
+
+    /**
+     * Save value to memory
+     * @param {string} key - key to store
+     * @param {any} value - value to store
+     */
+    setValue(key: string, value: any): void;
+
+    /**
+     * Execute existing step definition
+     * @param {string} step - cucumber expression to execute
+     * @param {DataTable | string} extraParam - extra data table or multiline string
+     */
+    executeStep(step: string, extraParam?: DataTable | string): Promise<void>;
+
+    /**
+     * Return validation function by provided type
+     * @param {string} type - type of validation
+     */
+    validation(type: string): Validation;
+
+    /**
+     * qavajs config
+     */
+    config: any;
+}
+
+export interface IQavajsConfig extends Partial<IConfiguration> {
+    /**
+     * instance of memory object
+     *
+     * default: {}
+     * @example
+     * import Memory from './memory/Memory';
+     *
+     * export default {
+     *     memory: new Memory()
+     * }
+     */
+    memory?: Object,
+    /**
+     * Cucumber steps timeout
+     *
+     * default: 10_000
+     * @example
+     * export default {
+     *     defaultTimeout: 20_000
+     * }
+     */
+    defaultTimeout?: number,
+    /**
+     * Qavajs services
+     *
+     * default: []
+     * @example
+     * export default {
+     *     service: [{
+     *         before() {
+     *             console.log('service started');
+     *         },
+     *         after(result: IRunResult) {
+     *             console.log(result.success);
+     *         }
+     *     }]
+     * }
+     */
+    service?: Array<{ before?: () => void, after: (result: IRunResult) => void }>,
+    /**
+     * Qavajs service timeout
+     *
+     * default: []
+     * @example
+     * export default {
+     *     service: [{
+     *         before() {
+     *             console.log('service started');
+     *         },
+     *         after(result: IRunResult) {
+     *             console.log(result.success);
+     *         }
+     *     }],
+     *     serviceTimeout: 30_000
+     * }
+     */
+    serviceTimeout?: number
+}