@serenity-js/web - npm Package Compare versions

Comparing version 3.10.2 to 3.10.3

CHANGELOG.md

@@ -6,2 +6,10 @@ # Change Log
 
+## [3.10.3](https://github.com/serenity-js/serenity-js/compare/v3.10.2...v3.10.3) (2023-09-15)
+
+**Note:** Version bump only for package @serenity-js/web
+
+
+
+
+
 ## [3.10.2](https://github.com/serenity-js/serenity-js/compare/v3.10.1...v3.10.2) (2023-09-10)
@@ -8,0 +16,0 @@

lib/stage/crew/photographer/Photographer.d.ts

@@ -8,3 +8,3 @@ import type { DomainEvent } from '@serenity-js/core/lib/events';
  *
- * ## Programmatically assigning the `Photographer` to the {@apilink Stage}
+ * ## Registering Photographer programmatically
  *
@@ -23,2 +23,34 @@ * ```ts
  *
+ * ## Using Photographer with Playwright Test
+ *
+ * ```ts
+ * // playwright.config.ts
+ * import type { PlaywrightTestConfig } from '@serenity-js/playwright-test'
+ *
+ * const config: PlaywrightTestConfig = {
+ *   reporter: [
+ *       [ '@serenity-js/playwright-test', {
+ *           crew: [
+ *               '@serenity-js/serenity-bdd',
+ *               [ '@serenity-js/core:ArtifactArchiver', { outputDirectory: 'target/site/serenity' } ],
+ *           ]
+ *           // other Serenity/JS config
+ *       }]
+ *   ],
+ *
+ *   use: {
+ *     crew: [
+ *       [ '@serenity-js/web:Photographer', {
+ *         strategy: 'TakePhotosOfFailures',
+ *         // strategy: 'TakePhotosOfInteractions',
+ *       } ]
+ *     ],
+ *   },
+ * };
+ * export default config;
+ * ```
+ *
+ * #### Learn more
+ * - {@apilink SerenityOptions}
+ *
  * ## Using `Photographer` with WebdriverIO
@@ -29,3 +61,2 @@ *
  * import { ArtifactArchiver } from '@serenity-js/core'
- * import { Photographer, TakePhotosOfFailures } from '@serenity-js/web'
  * import { WebdriverIOConfig } from '@serenity-js/webdriverio'
@@ -49,4 +80,8 @@ *
  *     crew: [
- *       ArtifactArchiver.storingArtifactsAt(process.cwd(), 'target/site/serenity'),
- *       Photographer.whoWill(TakePhotosOfFailures),
+ *       '@serenity-js/serenity-bdd',
+ *       [ '@serenity-js/core:ArtifactArchiver', { outputDirectory: 'target/site/serenity' } ],
+ *       [ '@serenity-js/web:Photographer', {
+ *         strategy: 'TakePhotosOfFailures',
+ *         // strategy: 'TakePhotosOfInteractions',
+ *       } ]
  *     ]
@@ -59,21 +94,2 @@ *   },
  *
- * ## Using `Photographer` with Playwright Test
- *
- * ```ts
- * // playwright.config.ts
- * import type { PlaywrightTestConfig } from '@serenity-js/playwright-test'
- *
- * const config: PlaywrightTestConfig = {
- *     use: {
- *         crew: [
- *             [ '@serenity-js/web:Photographer', { strategy: 'TakePhotosOfFailures' } ] // or 'TakePhotosOfInteractions'
- *         ],
- *     },
- * };
- * export default config;
- * ```
- *
- * #### Learn more
- * - {@apilink SerenityOptions}
- *
  * ## Using `Photographer` with Protractor
@@ -83,5 +99,2 @@ *
  * // protractor.conf.js
- * const { ArtifactArchiver } = require('@serenity-js/core')
- * const { Photographer, TakePhotosOfFailures } = require('@serenity-js/web')
- *
  * exports.config = {
@@ -94,12 +107,16 @@ *
  *   serenity: {
- *         runner: 'jasmine',
- *         // runner: 'cucumber',
- *         // runner: 'mocha',
- *         crew: [
- *             ArtifactArchiver.storingArtifactsAt('./target/site/serenity'),
- *             Photographer.whoWill(TakePhotosOfFailures),
- *         ]
- *     },
+ *     runner: 'jasmine',
+ *     // runner: 'cucumber',
+ *     // runner: 'mocha',
+ *     crew: [
+ *       @serenity-js/serenity-bdd',
+ *        '@serenity-js/core:ArtifactArchiver', { outputDirectory: 'target/site/serenity' } ],
+ *        '@serenity-js/web:Photographer', {
+ *          strategy: 'TakePhotosOfFailures',
+ *          // strategy: 'TakePhotosOfInteractions',
+ *        ]
+ *     ]
+ *   },
  *
- *     // ... rest of the config omitted for brevity
+ *   // ... rest of the config omitted for brevity
  * }
@@ -106,0 +123,0 @@ * ```

lib/stage/crew/photographer/Photographer.js

@@ -34,3 +34,3 @@ "use strict";
  *
- * ## Programmatically assigning the `Photographer` to the {@apilink Stage}
+ * ## Registering Photographer programmatically
  *
@@ -49,2 +49,34 @@ * ```ts
  *
+ * ## Using Photographer with Playwright Test
+ *
+ * ```ts
+ * // playwright.config.ts
+ * import type { PlaywrightTestConfig } from '@serenity-js/playwright-test'
+ *
+ * const config: PlaywrightTestConfig = {
+ *   reporter: [
+ *       [ '@serenity-js/playwright-test', {
+ *           crew: [
+ *               '@serenity-js/serenity-bdd',
+ *               [ '@serenity-js/core:ArtifactArchiver', { outputDirectory: 'target/site/serenity' } ],
+ *           ]
+ *           // other Serenity/JS config
+ *       }]
+ *   ],
+ *
+ *   use: {
+ *     crew: [
+ *       [ '@serenity-js/web:Photographer', {
+ *         strategy: 'TakePhotosOfFailures',
+ *         // strategy: 'TakePhotosOfInteractions',
+ *       } ]
+ *     ],
+ *   },
+ * };
+ * export default config;
+ * ```
+ *
+ * #### Learn more
+ * - {@apilink SerenityOptions}
+ *
  * ## Using `Photographer` with WebdriverIO
@@ -55,3 +87,2 @@ *
  * import { ArtifactArchiver } from '@serenity-js/core'
- * import { Photographer, TakePhotosOfFailures } from '@serenity-js/web'
  * import { WebdriverIOConfig } from '@serenity-js/webdriverio'
@@ -75,4 +106,8 @@ *
  *     crew: [
- *       ArtifactArchiver.storingArtifactsAt(process.cwd(), 'target/site/serenity'),
- *       Photographer.whoWill(TakePhotosOfFailures),
+ *       '@serenity-js/serenity-bdd',
+ *       [ '@serenity-js/core:ArtifactArchiver', { outputDirectory: 'target/site/serenity' } ],
+ *       [ '@serenity-js/web:Photographer', {
+ *         strategy: 'TakePhotosOfFailures',
+ *         // strategy: 'TakePhotosOfInteractions',
+ *       } ]
  *     ]
@@ -85,21 +120,2 @@ *   },
  *
- * ## Using `Photographer` with Playwright Test
- *
- * ```ts
- * // playwright.config.ts
- * import type { PlaywrightTestConfig } from '@serenity-js/playwright-test'
- *
- * const config: PlaywrightTestConfig = {
- *     use: {
- *         crew: [
- *             [ '@serenity-js/web:Photographer', { strategy: 'TakePhotosOfFailures' } ] // or 'TakePhotosOfInteractions'
- *         ],
- *     },
- * };
- * export default config;
- * ```
- *
- * #### Learn more
- * - {@apilink SerenityOptions}
- *
  * ## Using `Photographer` with Protractor
@@ -109,5 +125,2 @@ *
  * // protractor.conf.js
- * const { ArtifactArchiver } = require('@serenity-js/core')
- * const { Photographer, TakePhotosOfFailures } = require('@serenity-js/web')
- *
  * exports.config = {
@@ -120,12 +133,16 @@ *
  *   serenity: {
- *         runner: 'jasmine',
- *         // runner: 'cucumber',
- *         // runner: 'mocha',
- *         crew: [
- *             ArtifactArchiver.storingArtifactsAt('./target/site/serenity'),
- *             Photographer.whoWill(TakePhotosOfFailures),
- *         ]
- *     },
+ *     runner: 'jasmine',
+ *     // runner: 'cucumber',
+ *     // runner: 'mocha',
+ *     crew: [
+ *       @serenity-js/serenity-bdd',
+ *        '@serenity-js/core:ArtifactArchiver', { outputDirectory: 'target/site/serenity' } ],
+ *        '@serenity-js/web:Photographer', {
+ *          strategy: 'TakePhotosOfFailures',
+ *          // strategy: 'TakePhotosOfInteractions',
+ *        ]
+ *     ]
+ *   },
  *
- *     // ... rest of the config omitted for brevity
+ *   // ... rest of the config omitted for brevity
  * }
@@ -132,0 +149,0 @@ * ```

package.json

 {
   "name": "@serenity-js/web",
-  "version": "3.10.2",
+  "version": "3.10.3",
   "description": "Serenity/JS Screenplay Pattern APIs for the Web",
@@ -47,4 +47,4 @@ "author": {
   "dependencies": {
-    "@serenity-js/assertions": "3.10.2",
-    "@serenity-js/core": "3.10.2",
+    "@serenity-js/assertions": "3.10.3",
+    "@serenity-js/core": "3.10.3",
     "tiny-types": "^1.20.0"
@@ -62,3 +62,3 @@ },
   },
-  "gitHead": "6834827fffe5dd8dd3d2f39d2fea2c4039ab1d3d"
+  "gitHead": "064edb63e8d4dee447feaab63cf61cbcf6414fdf"
 }

src/stage/crew/photographer/Photographer.ts

@@ -12,3 +12,3 @@ import { ConfigurationError, LogicError } from '@serenity-js/core';
  *
- * ## Programmatically assigning the `Photographer` to the {@apilink Stage}
+ * ## Registering Photographer programmatically
  *
@@ -27,2 +27,34 @@ * ```ts
  *
+ * ## Using Photographer with Playwright Test
+ *
+ * ```ts
+ * // playwright.config.ts
+ * import type { PlaywrightTestConfig } from '@serenity-js/playwright-test'
+ *
+ * const config: PlaywrightTestConfig = {
+ *   reporter: [
+ *       [ '@serenity-js/playwright-test', {
+ *           crew: [
+ *               '@serenity-js/serenity-bdd',
+ *               [ '@serenity-js/core:ArtifactArchiver', { outputDirectory: 'target/site/serenity' } ],
+ *           ]
+ *           // other Serenity/JS config
+ *       }]
+ *   ],
+ *
+ *   use: {
+ *     crew: [
+ *       [ '@serenity-js/web:Photographer', {
+ *         strategy: 'TakePhotosOfFailures',
+ *         // strategy: 'TakePhotosOfInteractions',
+ *       } ]
+ *     ],
+ *   },
+ * };
+ * export default config;
+ * ```
+ *
+ * #### Learn more
+ * - {@apilink SerenityOptions}
+ *
  * ## Using `Photographer` with WebdriverIO
@@ -33,3 +65,2 @@ *
  * import { ArtifactArchiver } from '@serenity-js/core'
- * import { Photographer, TakePhotosOfFailures } from '@serenity-js/web'
  * import { WebdriverIOConfig } from '@serenity-js/webdriverio'
@@ -53,4 +84,8 @@ *
  *     crew: [
- *       ArtifactArchiver.storingArtifactsAt(process.cwd(), 'target/site/serenity'),
- *       Photographer.whoWill(TakePhotosOfFailures),
+ *       '@serenity-js/serenity-bdd',
+ *       [ '@serenity-js/core:ArtifactArchiver', { outputDirectory: 'target/site/serenity' } ],
+ *       [ '@serenity-js/web:Photographer', {
+ *         strategy: 'TakePhotosOfFailures',
+ *         // strategy: 'TakePhotosOfInteractions',
+ *       } ]
  *     ]
@@ -63,21 +98,2 @@ *   },
  *
- * ## Using `Photographer` with Playwright Test
- *
- * ```ts
- * // playwright.config.ts
- * import type { PlaywrightTestConfig } from '@serenity-js/playwright-test'
- *
- * const config: PlaywrightTestConfig = {
- *     use: {
- *         crew: [
- *             [ '@serenity-js/web:Photographer', { strategy: 'TakePhotosOfFailures' } ] // or 'TakePhotosOfInteractions'
- *         ],
- *     },
- * };
- * export default config;
- * ```
- *
- * #### Learn more
- * - {@apilink SerenityOptions}
- *
  * ## Using `Photographer` with Protractor
@@ -87,5 +103,2 @@ *
  * // protractor.conf.js
- * const { ArtifactArchiver } = require('@serenity-js/core')
- * const { Photographer, TakePhotosOfFailures } = require('@serenity-js/web')
- *
  * exports.config = {
@@ -98,12 +111,16 @@ *
  *   serenity: {
- *         runner: 'jasmine',
- *         // runner: 'cucumber',
- *         // runner: 'mocha',
- *         crew: [
- *             ArtifactArchiver.storingArtifactsAt('./target/site/serenity'),
- *             Photographer.whoWill(TakePhotosOfFailures),
- *         ]
- *     },
+ *     runner: 'jasmine',
+ *     // runner: 'cucumber',
+ *     // runner: 'mocha',
+ *     crew: [
+ *       @serenity-js/serenity-bdd',
+ *        '@serenity-js/core:ArtifactArchiver', { outputDirectory: 'target/site/serenity' } ],
+ *        '@serenity-js/web:Photographer', {
+ *          strategy: 'TakePhotosOfFailures',
+ *          // strategy: 'TakePhotosOfInteractions',
+ *        ]
+ *     ]
+ *   },
  *
- *     // ... rest of the config omitted for brevity
+ *   // ... rest of the config omitted for brevity
  * }
@@ -110,0 +127,0 @@ * ```

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

686479

increased by0.19%

Lines of code

14625

increased by0.35%

Dependency changes

• + Added@serenity-js/assertions@3.10.3(transitive)

• + Added@serenity-js/core@3.10.3(transitive)

• - Removed@serenity-js/assertions@3.10.2(transitive)

• - Removed@serenity-js/core@3.10.2(transitive)

• Updated@serenity-js/assertions@3.10.3

• Updated@serenity-js/core@3.10.3