@serenity-js/protractor 2.32.7 → 3.0.0-rc.10

package/lib/screenplay/questions/ProtractorParam.d.ts

@@ -1,4 +1,4 @@
-import { Answerable, AnswersQuestions, Question, UsesAbilities } from '@serenity-js/core';
+import { Answerable, QuestionAdapter } from '@serenity-js/core';
 /**
  * @desc
  *  Returns a Protractor configuration parameter specified in `protractor.conf.js`.
@@ -13,52 +13,47 @@ import { Answerable, AnswersQuestions, Question, UsesAbilities } from '@serenity
  *        }
  *    }
  *    // ...
- * }
+ *  }
  *
  * @example <caption>Overriding configuration parameter via the command line</caption>
  *  protractor ./protractor.conf.js --params.login.username="bob@example.org"
  *
- * @example <caption>Using in a test scenario</caption>
+ * @example <caption>Using as Screenplay Adapter</caption>
  *  import { actorCalled } from '@serenity-js/core';
- *  import { BrowseTheWeb, Enter, ProtractorParam } from '@serenity-js/protractor';
+ *  import { BrowseTheWebWithProtractor, ProtractorParam } from '@serenity-js/protractor';
+ *  import { Enter } from '@serenity-js/web';
  *  import { protractor } from 'protractor';
  *
  *  actorCalled('Jane')
- *      .whoCan(BrowseTheWeb.using(protractor.browser))
+ *      .whoCan( BrowseTheWebWithProtractor.using(protractor.browser))
  *      .attemptsTo(
- *          Enter.theValue(ProtractorParam.called('login.username').into(Form.exampleInput),
+ *          Enter.theValue(ProtractorParam.called('login').username).into(Form.exampleInput),
  *      );
  *
- * @extends {@serenity-js/core/lib/screenplay~Question<Promise<T>>}
+ * @example <caption>Specifying path to param as string</caption>
+ *  import { actorCalled } from '@serenity-js/core';
+ *  import { BrowseTheWebWithProtractor, ProtractorParam } from '@serenity-js/protractor';
+ *  import { Enter } from '@serenity-js/web';
+ *  import { protractor } from 'protractor';
+ *
+ *  actorCalled('Jane')
+ *      .whoCan( BrowseTheWebWithProtractor.using(protractor.browser))
+ *      .attemptsTo(
+ *          Enter.theValue(ProtractorParam.called('login.username')).into(Form.exampleInput),
+ *      );
  *
- * @see {@link BrowseTheWeb#param}
+ * @extends {@serenity-js/core/lib/screenplay~Question<Promise<T>>}
+ *g
+ * @see {@link BrowseTheWebWithProtractor#param}
  */
-export declare class ProtractorParam<T = any> extends Question<Promise<T>> {
-    private readonly name;
+export declare class ProtractorParam {
     /**
      * @desc
      *  Name of the parameter to retrieve. This could also be a dot-delimited path,
      *  i.e. `login.username`
      *
      * @param {@serenity-js/core/lib/screenplay~Answerable<string>} name
-     * @returns {ProtractorParam<R>}
-     */
-    static called<R>(name: Answerable<string>): ProtractorParam;
-    /**
-     * @param {@serenity-js/core/lib/screenplay~Answerable<string>} name
-     */
-    constructor(name: Answerable<string>);
-    /**
-     * @desc
-     *  Makes the provided {@link @serenity-js/core/lib/screenplay/actor~Actor}
-     *  answer this {@link @serenity-js/core/lib/screenplay~Question}.
-     *
-     * @param {AnswersQuestions & UsesAbilities} actor
-     * @returns {Promise<void>}
-     *
-     * @see {@link @serenity-js/core/lib/screenplay/actor~Actor}
-     * @see {@link @serenity-js/core/lib/screenplay/actor~AnswersQuestions}
-     * @see {@link @serenity-js/core/lib/screenplay/actor~UsesAbilities}
+     * @returns {Question<Promise<R>> & Adapter<R>}
      */
-    answeredBy(actor: AnswersQuestions & UsesAbilities): Promise<T>;
+    static called<R>(name: Answerable<string>): QuestionAdapter<R>;
 }

package/lib/screenplay/questions/ProtractorParam.js

@@ -19,60 +19,53 @@ const abilities_1 = require("../abilities");
  *        }
  *    }
  *    // ...
- * }
+ *  }
  *
  * @example <caption>Overriding configuration parameter via the command line</caption>
  *  protractor ./protractor.conf.js --params.login.username="bob@example.org"
  *
- * @example <caption>Using in a test scenario</caption>
+ * @example <caption>Using as Screenplay Adapter</caption>
  *  import { actorCalled } from '@serenity-js/core';
- *  import { BrowseTheWeb, Enter, ProtractorParam } from '@serenity-js/protractor';
+ *  import { BrowseTheWebWithProtractor, ProtractorParam } from '@serenity-js/protractor';
+ *  import { Enter } from '@serenity-js/web';
  *  import { protractor } from 'protractor';
  *
  *  actorCalled('Jane')
- *      .whoCan(BrowseTheWeb.using(protractor.browser))
+ *      .whoCan( BrowseTheWebWithProtractor.using(protractor.browser))
  *      .attemptsTo(
- *          Enter.theValue(ProtractorParam.called('login.username').into(Form.exampleInput),
+ *          Enter.theValue(ProtractorParam.called('login').username).into(Form.exampleInput),
  *      );
  *
- * @extends {@serenity-js/core/lib/screenplay~Question<Promise<T>>}
+ * @example <caption>Specifying path to param as string</caption>
+ *  import { actorCalled } from '@serenity-js/core';
+ *  import { BrowseTheWebWithProtractor, ProtractorParam } from '@serenity-js/protractor';
+ *  import { Enter } from '@serenity-js/web';
+ *  import { protractor } from 'protractor';
  *
- * @see {@link BrowseTheWeb#param}
+ *  actorCalled('Jane')
+ *      .whoCan( BrowseTheWebWithProtractor.using(protractor.browser))
+ *      .attemptsTo(
+ *          Enter.theValue(ProtractorParam.called('login.username')).into(Form.exampleInput),
+ *      );
+ *
+ * @extends {@serenity-js/core/lib/screenplay~Question<Promise<T>>}
+ *g
+ * @see {@link BrowseTheWebWithProtractor#param}
  */
-class ProtractorParam extends core_1.Question {
-    /**
-     * @param {@serenity-js/core/lib/screenplay~Answerable<string>} name
-     */
-    constructor(name) {
-        super((0, io_1.formatted) `the ${name} param specified in Protractor config`);
-        this.name = name;
-    }
+class ProtractorParam {
     /**
      * @desc
      *  Name of the parameter to retrieve. This could also be a dot-delimited path,
      *  i.e. `login.username`
      *
      * @param {@serenity-js/core/lib/screenplay~Answerable<string>} name
-     * @returns {ProtractorParam<R>}
+     * @returns {Question<Promise<R>> & Adapter<R>}
      */
     static called(name) {
-        return new ProtractorParam(name);
-    }
-    /**
-     * @desc
-     *  Makes the provided {@link @serenity-js/core/lib/screenplay/actor~Actor}
-     *  answer this {@link @serenity-js/core/lib/screenplay~Question}.
-     *
-     * @param {AnswersQuestions & UsesAbilities} actor
-     * @returns {Promise<void>}
-     *
-     * @see {@link @serenity-js/core/lib/screenplay/actor~Actor}
-     * @see {@link @serenity-js/core/lib/screenplay/actor~AnswersQuestions}
-     * @see {@link @serenity-js/core/lib/screenplay/actor~UsesAbilities}
-     */
-    answeredBy(actor) {
-        return actor.answer(this.name)
-            .then(name => abilities_1.BrowseTheWeb.as(actor).param(name));
+        return core_1.Question.about((0, io_1.formatted) `the ${name} param specified in Protractor config`, actor => {
+            return actor.answer(name)
+                .then(name => actor.abilityTo(abilities_1.BrowseTheWebWithProtractor).param(name));
+        });
     }
 }
 exports.ProtractorParam = ProtractorParam;

package/lib/screenplay/questions/ProtractorParam.js.map

@@ -1 +1 @@
-{"version":3,"file":"ProtractorParam.js","sourceRoot":"","sources":["../../../src/screenplay/questions/ProtractorParam.ts"],"names":[],"mappings":";;;AAAA,kDAAkD;AAClD,4CAA0F;AAC1F,iDAAqD;AAErD,4CAA4C;AAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAa,eACT,SAAQ,eAAoB;IAc5B;;OAEG;IACH,YAA6B,IAAwB;QACjD,KAAK,CAAC,IAAA,cAAS,EAAC,OAAQ,IAAK,uCAAuC,CAAC,CAAC;QAD7C,SAAI,GAAJ,IAAI,CAAoB;IAErD,CAAC;IAjBD;;;;;;;OAOG;IACH,MAAM,CAAC,MAAM,CAAI,IAAwB;QACrC,OAAO,IAAI,eAAe,CAAI,IAAI,CAAC,CAAC;IACxC,CAAC;IASD;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,KAAuC;QAC9C,OAAO,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;aACzB,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,wBAAY,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;IAC1D,CAAC;CACJ;AAtCD,0CAsCC"}
+{"version":3,"file":"ProtractorParam.js","sourceRoot":"","sources":["../../../src/screenplay/questions/ProtractorParam.ts"],"names":[],"mappings":";;;AAAA,kDAAkD;AAClD,4CAA0E;AAC1E,iDAAqD;AAErD,4CAA0D;AAE1D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,MAAa,eAAe;IAExB;;;;;;;OAOG;IACH,MAAM,CAAC,MAAM,CAAI,IAAwB;QACrC,OAAO,eAAQ,CAAC,KAAK,CAAI,IAAA,cAAS,EAAC,OAAQ,IAAK,uCAAuC,EAAE,KAAK,CAAC,EAAE;YAC7F,OAAO,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC;iBACpB,IAAI,CAAC,IAAI,CAAC,EAAE,CAAE,KAAK,CAAC,SAAS,CAAC,sCAA0B,CAAgC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;QAC/G,CAAC,CAAC,CAAC;IACP,CAAC;CACJ;AAhBD,0CAgBC"}

package/lib/screenplay/questions/index.d.ts

@@ -1,14 +1 @@
-export * from './Attribute';
-export * from './Browser';
-export * from './Cookie';
-export * from './CSSClasses';
-export * from './LastScriptExecution';
-export * from './ModalDialog';
-export { Pick } from './Pick';
 export * from './ProtractorParam';
-export * from './Selected';
-export { Target } from './targets';
-export * from './text';
-export * from './Value';
-export * from './Website';
-export * from './Window';

package/lib/screenplay/questions/index.js

@@ -10,21 +10,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Target = exports.Pick = void 0;
-__exportStar(require("./Attribute"), exports);
-__exportStar(require("./Browser"), exports);
-__exportStar(require("./Cookie"), exports);
-__exportStar(require("./CSSClasses"), exports);
-__exportStar(require("./LastScriptExecution"), exports);
-__exportStar(require("./ModalDialog"), exports);
-var Pick_1 = require("./Pick");
-Object.defineProperty(exports, "Pick", { enumerable: true, get: function () { return Pick_1.Pick; } });
 __exportStar(require("./ProtractorParam"), exports);
-__exportStar(require("./Selected"), exports);
-var targets_1 = require("./targets");
-Object.defineProperty(exports, "Target", { enumerable: true, get: function () { return targets_1.Target; } });
-__exportStar(require("./text"), exports);
-__exportStar(require("./Value"), exports);
-__exportStar(require("./Website"), exports);
-__exportStar(require("./Window"), exports);
 //# sourceMappingURL=index.js.map

package/lib/screenplay/questions/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/screenplay/questions/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAAA,8CAA4B;AAC5B,4CAA0B;AAC1B,2CAAyB;AACzB,+CAA6B;AAC7B,wDAAsC;AACtC,gDAA8B;AAC9B,+BAA8B;AAArB,4FAAA,IAAI,OAAA;AACb,oDAAkC;AAClC,6CAA2B;AAC3B,qCAAmC;AAA1B,iGAAA,MAAM,OAAA;AACf,yCAAuB;AACvB,0CAAwB;AACxB,4CAA0B;AAC1B,2CAAyB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/screenplay/questions/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,oDAAkC"}

package/lib/screenplay/unpromisedWebElement.d.ts

@@ -0,0 +1,11 @@
+import { WebElement } from 'protractor';
+/**
+ * @desc
+ *  Wraps Webdriver then-ables into a Node-native promise to allow for correct promise chaining.
+ *
+ * @private
+ *
+ * @param promiseLike
+ * @returns {Promise<T>}
+ */
+export declare function unpromisedWebElement<T extends WebElement>(promiseLike: T): T;

package/lib/screenplay/unpromisedWebElement.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.unpromisedWebElement = void 0;
+/**
+ * @desc
+ *  Wraps Webdriver then-ables into a Node-native promise to allow for correct promise chaining.
+ *
+ * @private
+ *
+ * @param promiseLike
+ * @returns {Promise<T>}
+ */
+function unpromisedWebElement(promiseLike) {
+    return new Proxy(promiseLike, {
+        has: (target, property) => property !== 'then',
+        ownKeys: (target) => Reflect.ownKeys(target)
+            .filter(property => property !== 'then'),
+        get: (target, property, receiver) => (property in receiver)
+            ? target[property]
+            : undefined,
+    });
+}
+exports.unpromisedWebElement = unpromisedWebElement;
+//# sourceMappingURL=unpromisedWebElement.js.map

package/lib/screenplay/unpromisedWebElement.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"unpromisedWebElement.js","sourceRoot":"","sources":["../../src/screenplay/unpromisedWebElement.ts"],"names":[],"mappings":";;;AAEA;;;;;;;;GAQG;AACH,SAAgB,oBAAoB,CAAuB,WAAc;IAErE,OAAO,IAAI,KAAK,CAAC,WAAW,EAAE;QAC1B,GAAG,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE,CACtB,QAAQ,KAAK,MAAM;QACvB,OAAO,EAAE,CAAC,MAAM,EAAE,EAAE,CAChB,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC;aAClB,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,KAAK,MAAM,CAAC;QAChD,GAAG,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE,CAChC,CAAC,QAAQ,IAAI,QAAQ,CAAC;YAClB,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC;YAClB,CAAC,CAAC,SAAS;KACtB,CAAC,CAAC;AACP,CAAC;AAbD,oDAaC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serenity-js/protractor",
-  "version": "2.32.7",
+  "version": "3.0.0-rc.10",
   "description": "Test your web apps with Serenity/JS",
   "author": {
     "name": "Jan Molak",
@@ -31,12 +31,10 @@
   ],
   "scripts": {
     "clean": "rimraf .nyc_output lib target",
-    "lint": "eslint --ext ts --config ../../.eslintrc.js .",
+    "lint": "eslint --ext ts --config ../../.eslintrc.yml .",
     "lint:fix": "npm run lint -- --fix",
     "debug": "node --inspect-brk node_modules/.bin/protractor ./spec/protractor.conf.js",
-    "test": "cross-env PORT=8081 start-server-and-test test:start-server http://localhost:8081 test:protractor",
-    "test:start-server": "static-content-server",
-    "test:protractor": "nyc --report-dir ../../target/coverage/protractor protractor ./spec/protractor.conf.js",
+    "test": "nyc --report-dir ../../target/coverage/protractor protractor ./spec/protractor.conf.js",
     "compile": "tsc --project tsconfig.json",
     "site": "esdoc -c .esdoc.js"
   },
@@ -48,20 +46,21 @@
     "url": "https://github.com/serenity-js/serenity-js/issues"
   },
   "engines": {
-    "node": "^12 || ^14 || ^16",
+    "node": "^14 || ^16",
     "npm": "^6 || ^7 || ^8"
   },
   "dependencies": {
-    "@serenity-js/assertions": "2.32.7",
-    "@serenity-js/core": "2.32.7",
+    "@serenity-js/assertions": "3.0.0-rc.10",
+    "@serenity-js/core": "3.0.0-rc.10",
     "deepmerge": "^4.2.2",
     "is-plain-object": "^5.0.0",
-    "tiny-types": "^1.16.1"
+    "query-selector-shadow-dom": "^1.0.0",
+    "tiny-types": "^1.17.0"
   },
   "peerDependencies": {
-    "@serenity-js/cucumber": "^2.29.0",
-    "@serenity-js/jasmine": "^2.29.0",
-    "@serenity-js/mocha": "^2.29.0",
+    "@serenity-js/cucumber": "^3.0.0-rc",
+    "@serenity-js/jasmine": "^3.0.0-rc",
+    "@serenity-js/mocha": "^3.0.0-rc",
     "protractor": "^5.0.0 || ^7.0.0",
     "selenium-webdriver": "^3.6.0"
   },
@@ -77,17 +76,17 @@
     }
   },
   "devDependencies": {
-    "@documentation/esdoc-template": "2.0.0",
-    "@integration/testing-tools": "2.0.0",
-    "@integration/web-testing-tools": "2.0.0",
-    "@serenity-js/cucumber": "2.32.7",
-    "@serenity-js/jasmine": "2.32.7",
-    "@serenity-js/local-server": "2.32.7",
-    "@serenity-js/mocha": "2.32.7",
-    "@serenity-js/rest": "2.32.7",
+    "@documentation/esdoc-template": "3.0.0",
+    "@integration/testing-tools": "3.0.0",
+    "@serenity-js/cucumber": "3.0.0-rc.10",
+    "@serenity-js/jasmine": "3.0.0-rc.10",
+    "@serenity-js/local-server": "3.0.0-rc.10",
+    "@serenity-js/mocha": "3.0.0-rc.10",
+    "@serenity-js/rest": "3.0.0-rc.10",
+    "@serenity-js/web": "3.0.0-rc.10",
     "@types/chai": "^4.3.0",
     "@types/express": "^4.17.13",
-    "@types/html-minifier": "^4.0.1",
+    "@types/html-minifier": "^4.0.2",
     "@types/mocha": "^9.0.0",
     "@types/selenium-webdriver": "^3.0.19",
     "axios": "^0.21.4",
@@ -124,5 +123,5 @@
     "cache": true,
     "all": true
   },
-  "gitHead": "93f54f9919b74d66f10cdd7acbadba5927d728f7"
+  "gitHead": "7e8570d412348980c22a6e189ebc4c4f0157919d"
 }

package/src/adapter/ProtractorFrameworkAdapter.ts

@@ -2,6 +2,7 @@ import { ArtifactArchiver, Serenity } from '@serenity-js/core';
 import { isPlainObject } from 'is-plain-object'; // fails when using default import
 import { protractor, Runner } from 'protractor';
 import deepmerge = require('deepmerge');
+const querySelectorShadowDomPlugin = require('query-selector-shadow-dom/plugins/protractor');   // eslint-disable-line @typescript-eslint/no-var-requires
 
 import { BrowserDetector, StandardisedCapabilities } from './browser-detector';
 import { Config } from './Config';
@@ -27,6 +28,10 @@ export class ProtractorFrameworkAdapter {
      */
     run(specs: string[]): Promise<ProtractorReport> {
 
+        if (! this.protractorRunner.plugins_?.pluginObjs?.some(plugin => plugin.name === querySelectorShadowDomPlugin.name)) {
+            this.protractorRunner.plugins_?.pluginObjs?.push(querySelectorShadowDomPlugin);
+        }
+
         const runner    = this.detector.runnerFor(this.protractorRunner.getConfig());
         const reporter  = new ProtractorReporter(this.protractorRunner, runner.successThreshold());
 

package/src/index.ts

@@ -1,3 +1 @@
-export * from './expectations';
 export * from './screenplay';
-export * from './stage';