@serenity-js/assertions 3.3.0 → 3.3.1

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [3.3.1](https://github.com/serenity-js/serenity-js/compare/v3.3.0...v3.3.1) (2023-06-08)
+
+**Note:** Version bump only for package @serenity-js/assertions
+
+
+
+
+
 # [3.3.0](https://github.com/serenity-js/serenity-js/compare/v3.2.1...v3.3.0) (2023-06-01)
 
 **Note:** Version bump only for package @serenity-js/assertions

package/lib/expectations/includes.d.ts

@@ -14,6 +14,25 @@ import { Expectation } from '@serenity-js/core';
  * )
  * ```
  *
+ * ## Ensuring that page URL includes the expected substring
+ *
+ * {@apilink Page.url|Page.current().url()} returns a {@apilink QuestionAdapter|`QuestionAdapter<URL>`},
+ * a proxy object around the standard Node.js [URL](https://nodejs.org/api/url.html) class,
+ * offering access to `string` properties such as [`hostname`](https://nodejs.org/api/url.html#urlobjecthostname),
+ * [`pathname`](https://nodejs.org/api/url.html#urlobjectpathname), and so on.
+ *
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core'
+ * import { Ensure, includes } from '@serenity-js/assertions'
+ * import { Navigate, Page } from '@serenity-js/web'
+ *
+ * await actorCalled('Ester').attemptsTo(
+ *   Navigate.to('https://serenity-js.org/handbook'),
+ *   Ensure.that(Page.current().url().hostname, includes('serenity-js')),
+ *   Ensure.that(Page.current().url().pathname, includes('book')),
+ * )
+ * ```
+ *
  * @param expected
  *
  * @group Expectations

package/lib/expectations/includes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"includes.d.ts","sourceRoot":"","sources":["../../src/expectations/includes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,QAAQ,mFAIpB,CAAC"}
+{"version":3,"file":"includes.d.ts","sourceRoot":"","sources":["../../src/expectations/includes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,eAAO,MAAM,QAAQ,mFAIpB,CAAC"}

package/lib/expectations/includes.js

@@ -17,6 +17,25 @@ const core_1 = require("@serenity-js/core");
  * )
  * ```
  *
+ * ## Ensuring that page URL includes the expected substring
+ *
+ * {@apilink Page.url|Page.current().url()} returns a {@apilink QuestionAdapter|`QuestionAdapter<URL>`},
+ * a proxy object around the standard Node.js [URL](https://nodejs.org/api/url.html) class,
+ * offering access to `string` properties such as [`hostname`](https://nodejs.org/api/url.html#urlobjecthostname),
+ * [`pathname`](https://nodejs.org/api/url.html#urlobjectpathname), and so on.
+ *
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core'
+ * import { Ensure, includes } from '@serenity-js/assertions'
+ * import { Navigate, Page } from '@serenity-js/web'
+ *
+ * await actorCalled('Ester').attemptsTo(
+ *   Navigate.to('https://serenity-js.org/handbook'),
+ *   Ensure.that(Page.current().url().hostname, includes('serenity-js')),
+ *   Ensure.that(Page.current().url().pathname, includes('book')),
+ * )
+ * ```
+ *
  * @param expected
  *
  * @group Expectations

package/lib/expectations/includes.js.map

@@ -1 +1 @@
-{"version":3,"file":"includes.js","sourceRoot":"","sources":["../../src/expectations/includes.ts"],"names":[],"mappings":";;;AAAA,4CAAgD;AAEhD;;;;;;;;;;;;;;;;;;GAkBG;AACU,QAAA,QAAQ,GAAG,kBAAW,CAAC,MAAM,CACtC,UAAU,EAAE,SAAS,EACrB,CAAC,MAAc,EAAE,QAAgB,EAAE,EAAE,CACjC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAChC,CAAC"}
+{"version":3,"file":"includes.js","sourceRoot":"","sources":["../../src/expectations/includes.ts"],"names":[],"mappings":";;;AAAA,4CAAgD;AAEhD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACU,QAAA,QAAQ,GAAG,kBAAW,CAAC,MAAM,CACtC,UAAU,EAAE,SAAS,EACrB,CAAC,MAAc,EAAE,QAAgB,EAAE,EAAE,CACjC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAChC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serenity-js/assertions",
-  "version": "3.3.0",
+  "version": "3.3.1",
   "description": "Screenplay-style assertion library",
   "author": {
     "name": "Jan Molak",
@@ -43,18 +43,18 @@
     "node": "^16.13 || ^18.12 || ^20"
   },
   "dependencies": {
-    "@serenity-js/core": "3.3.0",
+    "@serenity-js/core": "3.3.1",
     "tiny-types": "^1.19.1"
   },
   "devDependencies": {
     "@integration/testing-tools": "3.0.0",
     "@types/chai": "^4.3.5",
     "@types/mocha": "^10.0.1",
-    "c8": "7.13.0",
+    "c8": "7.14.0",
     "mocha": "^10.2.0",
     "mocha-multi": "^1.1.7",
     "ts-node": "^10.9.1",
     "typescript": "^5.0.4"
   },
-  "gitHead": "c4a2bb6aef7b087dc9bc37269fd999d1cdc15088"
+  "gitHead": "d036ce75c1eb131d3cde28b04e668dc24f959e2f"
 }

package/src/expectations/includes.ts

@@ -15,6 +15,25 @@ import { Expectation } from '@serenity-js/core';
  * )
  * ```
  *
+ * ## Ensuring that page URL includes the expected substring
+ *
+ * {@apilink Page.url|Page.current().url()} returns a {@apilink QuestionAdapter|`QuestionAdapter<URL>`},
+ * a proxy object around the standard Node.js [URL](https://nodejs.org/api/url.html) class,
+ * offering access to `string` properties such as [`hostname`](https://nodejs.org/api/url.html#urlobjecthostname),
+ * [`pathname`](https://nodejs.org/api/url.html#urlobjectpathname), and so on.
+ *
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core'
+ * import { Ensure, includes } from '@serenity-js/assertions'
+ * import { Navigate, Page } from '@serenity-js/web'
+ *
+ * await actorCalled('Ester').attemptsTo(
+ *   Navigate.to('https://serenity-js.org/handbook'),
+ *   Ensure.that(Page.current().url().hostname, includes('serenity-js')),
+ *   Ensure.that(Page.current().url().pathname, includes('book')),
+ * )
+ * ```
+ *
  * @param expected
  *
  * @group Expectations