@serenity-js/web 3.15.0 → 3.16.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. package/CHANGELOG.md +19 -0
  2. package/lib/screenplay/interactions/Enter.d.ts +17 -0
  3. package/lib/screenplay/interactions/Enter.d.ts.map +1 -1
  4. package/lib/screenplay/interactions/Enter.js +17 -0
  5. package/lib/screenplay/interactions/Enter.js.map +1 -1
  6. package/package.json +5 -5
  7. package/src/screenplay/interactions/Enter.ts +17 -0
package/CHANGELOG.md CHANGED
@@ -3,6 +3,25 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ # [3.16.0](https://github.com/serenity-js/serenity-js/compare/v3.15.1...v3.16.0) (2024-02-01)
7
+
8
+
9
+ ### Features
10
+
11
+ * **core:** added Masked.valueOf() Question ([e9ff5ab](https://github.com/serenity-js/serenity-js/commit/e9ff5ab62e8b305aa7ef2238f482be5369d890c1)), closes [#2165](https://github.com/serenity-js/serenity-js/issues/2165)
12
+
13
+
14
+
15
+
16
+
17
+ ## [3.15.1](https://github.com/serenity-js/serenity-js/compare/v3.15.0...v3.15.1) (2024-01-19)
18
+
19
+ **Note:** Version bump only for package @serenity-js/web
20
+
21
+
22
+
23
+
24
+
6
25
  # [3.15.0](https://github.com/serenity-js/serenity-js/compare/v3.14.2...v3.15.0) (2024-01-12)
7
26
 
8
27
  **Note:** Version bump only for package @serenity-js/web
package/lib/screenplay/interactions/Enter.d.ts CHANGED
@@ -36,6 +36,23 @@ import { PageElementInteraction } from './PageElementInteraction';
36
36
  * )
37
37
  * ```
38
38
  *
39
+ * ## Handling sensitive information
40
+ *
41
+ * By design, any data handled by an actor appears in Serenity/JS reports.
42
+ * To prevent the exposure of any sensitive information, such as passwords or tokens, you should use {@apilink Masked}.
43
+ *
44
+ * ```ts
45
+ * import { actorCalled, Masked } from '@serenity-js/core'
46
+ * import { Enter } from '@serenity-js/web'
47
+ *
48
+ * await actorCalled('Esme')
49
+ * .attemptsTo(
50
+ * Enter.theValue(Masked.valueOf('your little secret').into(Form.exampleInputField()),
51
+ * )
52
+ *
53
+ * // Gets reported as: "Esme enters [a masked value] into the example input field"
54
+ * ```
55
+ *
39
56
  * ## Learn more
40
57
  *
41
58
  * - {@apilink BrowseTheWeb}
package/lib/screenplay/interactions/Enter.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"Enter.d.ts","sourceRoot":"","sources":["../../../src/screenplay/interactions/Enter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,gBAAgB,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAIlG,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAElE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,qBAAa,KAAM,SAAQ,sBAAsB;IAgBzC,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,KAAK;IAf1B;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,CAAC,GAAG,MAAM,EAAE,KAAK,CAAC,UAAU,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC,GAAG;QAAE,IAAI,EAAE,CAAC,KAAK,EAAE,UAAU,CAAC,WAAW,CAAC,KAAK,WAAW,CAAA;KAAE;IAO/I,SAAS,aACY,MAAM,EAAE,KAAK,CAAC,UAAU,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC,EAChE,KAAK,EAAE,UAAU,CAAC,WAAW,CAAC;IAKnD;;OAEG;IACG,SAAS,CAAC,KAAK,EAAE,aAAa,GAAG,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;CAO1E"}
1
+ {"version":3,"file":"Enter.d.ts","sourceRoot":"","sources":["../../../src/screenplay/interactions/Enter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,gBAAgB,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAIlG,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAElE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0DG;AACH,qBAAa,KAAM,SAAQ,sBAAsB;IAgBzC,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,KAAK;IAf1B;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,CAAC,GAAG,MAAM,EAAE,KAAK,CAAC,UAAU,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC,GAAG;QAAE,IAAI,EAAE,CAAC,KAAK,EAAE,UAAU,CAAC,WAAW,CAAC,KAAK,WAAW,CAAA;KAAE;IAO/I,SAAS,aACY,MAAM,EAAE,KAAK,CAAC,UAAU,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC,EAChE,KAAK,EAAE,UAAU,CAAC,WAAW,CAAC;IAKnD;;OAEG;IACG,SAAS,CAAC,KAAK,EAAE,aAAa,GAAG,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;CAO1E"}
package/lib/screenplay/interactions/Enter.js CHANGED
@@ -39,6 +39,23 @@ const PageElementInteraction_1 = require("./PageElementInteraction");
39
39
  * )
40
40
  * ```
41
41
  *
42
+ * ## Handling sensitive information
43
+ *
44
+ * By design, any data handled by an actor appears in Serenity/JS reports.
45
+ * To prevent the exposure of any sensitive information, such as passwords or tokens, you should use {@apilink Masked}.
46
+ *
47
+ * ```ts
48
+ * import { actorCalled, Masked } from '@serenity-js/core'
49
+ * import { Enter } from '@serenity-js/web'
50
+ *
51
+ * await actorCalled('Esme')
52
+ * .attemptsTo(
53
+ * Enter.theValue(Masked.valueOf('your little secret').into(Form.exampleInputField()),
54
+ * )
55
+ *
56
+ * // Gets reported as: "Esme enters [a masked value] into the example input field"
57
+ * ```
58
+ *
42
59
  * ## Learn more
43
60
  *
44
61
  * - {@apilink BrowseTheWeb}
package/lib/screenplay/interactions/Enter.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"Enter.js","sourceRoot":"","sources":["../../../src/screenplay/interactions/Enter.ts"],"names":[],"mappings":";;;AACA,4CAAsC;AACtC,iDAAoD;AAGpD,qEAAkE;AAElE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,MAAa,KAAM,SAAQ,+CAAsB;IAgBxB;IACA;IAfrB;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,CAAC,GAAG,MAAgE;QAC/E,OAAO;YACH,IAAI,EAAE,CAAC,KAA8B,CAAE,gDAAgD,EAAE,EAAE,CACvF,IAAI,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC;SAC/B,CAAC;IACN,CAAC;IAED,YACqB,MAAgE,EAChE,KAA8B,CAAC,kDAAkD;QAElG,KAAK,CAAC,IAAA,QAAC,EAAC,iBAAkB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAE,SAAU,KAAM,EAAE,CAAC,CAAC;QAH/C,WAAM,GAAN,MAAM,CAA0D;QAChE,UAAK,GAAL,KAAK,CAAyB;IAGnD,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,KAAuC;QACnD,MAAM,KAAK,GAAI,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;QAErD,MAAM,aAAa,GAAG,MAAM,IAAA,aAAQ,EAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;QAE/E,OAAO,KAAK,CAAC,UAAU,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC,CAAC;IAClD,CAAC;CACJ;AAhCD,sBAgCC"}
1
+ {"version":3,"file":"Enter.js","sourceRoot":"","sources":["../../../src/screenplay/interactions/Enter.ts"],"names":[],"mappings":";;;AACA,4CAAsC;AACtC,iDAAoD;AAGpD,qEAAkE;AAElE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0DG;AACH,MAAa,KAAM,SAAQ,+CAAsB;IAgBxB;IACA;IAfrB;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,CAAC,GAAG,MAAgE;QAC/E,OAAO;YACH,IAAI,EAAE,CAAC,KAA8B,CAAE,gDAAgD,EAAE,EAAE,CACvF,IAAI,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC;SAC/B,CAAC;IACN,CAAC;IAED,YACqB,MAAgE,EAChE,KAA8B,CAAC,kDAAkD;QAElG,KAAK,CAAC,IAAA,QAAC,EAAC,iBAAkB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAE,SAAU,KAAM,EAAE,CAAC,CAAC;QAH/C,WAAM,GAAN,MAAM,CAA0D;QAChE,UAAK,GAAL,KAAK,CAAyB;IAGnD,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,KAAuC;QACnD,MAAM,KAAK,GAAI,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;QAErD,MAAM,aAAa,GAAG,MAAM,IAAA,aAAQ,EAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;QAE/E,OAAO,KAAK,CAAC,UAAU,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC,CAAC;IAClD,CAAC;CACJ;AAhCD,sBAgCC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@serenity-js/web",
3
- "version": "3.15.0",
3
+ "version": "3.16.0",
4
4
  "description": "Serenity/JS Screenplay Pattern APIs for the Web",
5
5
  "author": {
6
6
  "name": "Jan Molak",
@@ -45,19 +45,19 @@
45
45
  "node": "^16.13 || ^18.12 || ^20"
46
46
  },
47
47
  "dependencies": {
48
- "@serenity-js/assertions": "3.15.0",
49
- "@serenity-js/core": "3.15.0",
48
+ "@serenity-js/assertions": "3.16.0",
49
+ "@serenity-js/core": "3.16.0",
50
50
  "tiny-types": "1.21.0"
51
51
  },
52
52
  "devDependencies": {
53
53
  "@integration/testing-tools": "3.0.0",
54
54
  "@types/chai": "4.3.11",
55
55
  "@types/mocha": "10.0.6",
56
- "c8": "9.0.0",
56
+ "c8": "9.1.0",
57
57
  "mocha": "10.2.0",
58
58
  "mocha-multi": "1.1.7",
59
59
  "ts-node": "10.9.2",
60
60
  "typescript": "5.1.6"
61
61
  },
62
- "gitHead": "f3580d6b6380e9f175544929b9504a85c1d204ad"
62
+ "gitHead": "242771e55bd6becc5baeaac03edf945e4cdaf7a4"
63
63
  }
package/src/screenplay/interactions/Enter.ts CHANGED
@@ -40,6 +40,23 @@ import { PageElementInteraction } from './PageElementInteraction';
40
40
  * )
41
41
  * ```
42
42
  *
43
+ * ## Handling sensitive information
44
+ *
45
+ * By design, any data handled by an actor appears in Serenity/JS reports.
46
+ * To prevent the exposure of any sensitive information, such as passwords or tokens, you should use {@apilink Masked}.
47
+ *
48
+ * ```ts
49
+ * import { actorCalled, Masked } from '@serenity-js/core'
50
+ * import { Enter } from '@serenity-js/web'
51
+ *
52
+ * await actorCalled('Esme')
53
+ * .attemptsTo(
54
+ * Enter.theValue(Masked.valueOf('your little secret').into(Form.exampleInputField()),
55
+ * )
56
+ *
57
+ * // Gets reported as: "Esme enters [a masked value] into the example input field"
58
+ * ```
59
+ *
43
60
  * ## Learn more
44
61
  *
45
62
  * - {@apilink BrowseTheWeb}