@serenity-js/jasmine 3.25.0 → 3.25.2

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 (56) hide show
  1. package/CHANGELOG.md +19 -0
  2. package/README.md +1 -1
  3. package/esm/adapter/JasmineAdapter.d.ts +2 -2
  4. package/esm/adapter/JasmineAdapter.js +2 -2
  5. package/esm/adapter/filters/GrepSpecFilter.d.ts +1 -3
  6. package/esm/adapter/filters/GrepSpecFilter.d.ts.map +1 -1
  7. package/esm/adapter/filters/GrepSpecFilter.js +1 -3
  8. package/esm/adapter/filters/GrepSpecFilter.js.map +1 -1
  9. package/esm/bootstrap.d.ts +4 -8
  10. package/esm/bootstrap.d.ts.map +1 -1
  11. package/esm/bootstrap.js +4 -8
  12. package/esm/bootstrap.js.map +1 -1
  13. package/esm/jasmine/JasmineDoneInfo.d.ts +3 -3
  14. package/esm/jasmine/JasmineReporter.d.ts +11 -38
  15. package/esm/jasmine/JasmineReporter.d.ts.map +1 -1
  16. package/esm/jasmine/JasmineStartedInfo.d.ts +3 -3
  17. package/esm/jasmine/Location.d.ts +1 -2
  18. package/esm/jasmine/Location.d.ts.map +1 -1
  19. package/esm/jasmine/Order.d.ts +1 -2
  20. package/esm/jasmine/Order.d.ts.map +1 -1
  21. package/esm/monkeyPatched.d.ts +3 -4
  22. package/esm/monkeyPatched.d.ts.map +1 -1
  23. package/esm/monkeyPatched.js +5 -10
  24. package/esm/monkeyPatched.js.map +1 -1
  25. package/lib/adapter/JasmineAdapter.d.ts +2 -2
  26. package/lib/adapter/JasmineAdapter.js +2 -2
  27. package/lib/adapter/filters/GrepSpecFilter.d.ts +1 -3
  28. package/lib/adapter/filters/GrepSpecFilter.d.ts.map +1 -1
  29. package/lib/adapter/filters/GrepSpecFilter.js +1 -3
  30. package/lib/adapter/filters/GrepSpecFilter.js.map +1 -1
  31. package/lib/bootstrap.d.ts +4 -8
  32. package/lib/bootstrap.d.ts.map +1 -1
  33. package/lib/bootstrap.js +4 -8
  34. package/lib/bootstrap.js.map +1 -1
  35. package/lib/jasmine/JasmineDoneInfo.d.ts +3 -3
  36. package/lib/jasmine/JasmineReporter.d.ts +11 -38
  37. package/lib/jasmine/JasmineReporter.d.ts.map +1 -1
  38. package/lib/jasmine/JasmineStartedInfo.d.ts +3 -3
  39. package/lib/jasmine/Location.d.ts +1 -2
  40. package/lib/jasmine/Location.d.ts.map +1 -1
  41. package/lib/jasmine/Order.d.ts +1 -2
  42. package/lib/jasmine/Order.d.ts.map +1 -1
  43. package/lib/monkeyPatched.d.ts +3 -4
  44. package/lib/monkeyPatched.d.ts.map +1 -1
  45. package/lib/monkeyPatched.js +5 -10
  46. package/lib/monkeyPatched.js.map +1 -1
  47. package/package.json +4 -4
  48. package/src/adapter/JasmineAdapter.ts +2 -2
  49. package/src/adapter/filters/GrepSpecFilter.ts +1 -3
  50. package/src/bootstrap.ts +4 -8
  51. package/src/jasmine/JasmineDoneInfo.ts +3 -3
  52. package/src/jasmine/JasmineReporter.ts +11 -38
  53. package/src/jasmine/JasmineStartedInfo.ts +3 -3
  54. package/src/jasmine/Location.ts +1 -2
  55. package/src/jasmine/Order.ts +1 -2
  56. package/src/monkeyPatched.ts +5 -10
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.25.2](https://github.com/serenity-js/serenity-js/compare/v3.25.1...v3.25.2) (2024-07-17)
7
+
8
+ **Note:** Version bump only for package @serenity-js/jasmine
9
+
10
+
11
+
12
+
13
+
14
+ ## [3.25.1](https://github.com/serenity-js/serenity-js/compare/v3.25.0...v3.25.1) (2024-07-10)
15
+
16
+
17
+ ### Bug Fixes
18
+
19
+ * **core:** all the API docs now link to the online Serenity/JS API documentation ([f8f451d](https://github.com/serenity-js/serenity-js/commit/f8f451dffdb4caaa2e31a860f59d59470f4856ad))
20
+
21
+
22
+
23
+
24
+
6
25
  # [3.25.0](https://github.com/serenity-js/serenity-js/compare/v3.24.1...v3.25.0) (2024-07-03)
7
26
 
8
27
  **Note:** Version bump only for package @serenity-js/jasmine
package/README.md CHANGED
@@ -17,7 +17,7 @@ of complex software systems faster, more collaborative and easier to scale.
17
17
  👋 Join the Serenity/JS Community!
18
18
  - Meet other Serenity/JS developers and maintainers on the [Serenity/JS Community chat channel](https://matrix.to/#/#serenity-js:gitter.im),
19
19
  - Find answers to your Serenity/JS questions on the [Serenity/JS Forum](https://github.com/orgs/serenity-js/discussions/categories/how-do-i),
20
- - Learn how to [contribute to Serenity/JS](https://serenity-js.org/contributing),
20
+ - Learn how to [contribute to Serenity/JS](https://serenity-js.org/community/contributing/),
21
21
  - Support the project and gain access to [Serenity/JS Playbooks](https://github.com/serenity-js/playbooks) by becoming a [Serenity/JS GitHub Sponsor](https://github.com/sponsors/serenity-js)!
22
22
 
23
23
  ## Serenity/JS Jasmine
@@ -4,10 +4,10 @@ import type { Outcome } from '@serenity-js/core/lib/model/index.js';
4
4
  import type { JasmineConfig } from './JasmineConfig.js';
5
5
  /**
6
6
  * Allows for programmatic execution of Jasmine test scenarios,
7
- * using {@apilink SerenityReporterForJasmine} to report progress.
7
+ * using [`SerenityReporterForJasmine`](https://serenity-js.org/api/jasmine/function/default/) to report progress.
8
8
  *
9
9
  * ## Learn more
10
- * - {@apilink TestRunnerAdapter}
10
+ * - [`TestRunnerAdapter`](https://serenity-js.org/api/core-adapter/interface/TestRunnerAdapter/)
11
11
  *
12
12
  * @group Integration
13
13
  */
@@ -3,10 +3,10 @@ import reporter from '../index.js';
3
3
  import { AcceptingSpecFilter, CustomFunctionSpecFilter, GrepSpecFilter, InvertedGrepSpecFilter } from './filters/index.js';
4
4
  /**
5
5
  * Allows for programmatic execution of Jasmine test scenarios,
6
- * using {@apilink SerenityReporterForJasmine} to report progress.
6
+ * using [`SerenityReporterForJasmine`](https://serenity-js.org/api/jasmine/function/default/) to report progress.
7
7
  *
8
8
  * ## Learn more
9
- * - {@apilink TestRunnerAdapter}
9
+ * - [`TestRunnerAdapter`](https://serenity-js.org/api/core-adapter/interface/TestRunnerAdapter/)
10
10
  *
11
11
  * @group Integration
12
12
  */
@@ -1,8 +1,6 @@
1
1
  import type { SpecFilter } from './SpecFilter.js';
2
2
  /**
3
- * @desc
4
- * https://github.com/jasmine/jasmine-npm/blob/641c33d4765efb0486f68980a8b7d184dd797122/lib/filters/console_spec_filter.js
5
- *
3
+ * @see https://github.com/jasmine/jasmine-npm/blob/641c33d4765efb0486f68980a8b7d184dd797122/lib/filters/console_spec_filter.js
6
4
  * @package
7
5
  */
8
6
  export declare class GrepSpecFilter implements SpecFilter {
@@ -1 +1 @@
1
- {"version":3,"file":"GrepSpecFilter.d.ts","sourceRoot":"","sources":["../../../src/adapter/filters/GrepSpecFilter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAElD;;;;;GAKG;AACH,qBAAa,cAAe,YAAW,UAAU;IAC7C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;gBAErB,OAAO,EAAE,MAAM,GAAG,MAAM;IAIpC,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;CAGrC"}
1
+ {"version":3,"file":"GrepSpecFilter.d.ts","sourceRoot":"","sources":["../../../src/adapter/filters/GrepSpecFilter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAElD;;;GAGG;AACH,qBAAa,cAAe,YAAW,UAAU;IAC7C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;gBAErB,OAAO,EAAE,MAAM,GAAG,MAAM;IAIpC,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;CAGrC"}
@@ -1,7 +1,5 @@
1
1
  /**
2
- * @desc
3
- * https://github.com/jasmine/jasmine-npm/blob/641c33d4765efb0486f68980a8b7d184dd797122/lib/filters/console_spec_filter.js
4
- *
2
+ * @see https://github.com/jasmine/jasmine-npm/blob/641c33d4765efb0486f68980a8b7d184dd797122/lib/filters/console_spec_filter.js
5
3
  * @package
6
4
  */
7
5
  export class GrepSpecFilter {
@@ -1 +1 @@
1
- {"version":3,"file":"GrepSpecFilter.js","sourceRoot":"","sources":["../../../src/adapter/filters/GrepSpecFilter.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,MAAM,OAAO,cAAc;IACN,OAAO,CAAS;IAEjC,YAAY,OAAwB;QAChC,IAAI,CAAC,OAAO,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC,CAAA;IACtC,CAAC;IAED,OAAO,CAAC,QAAgB;QACpB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;CACJ"}
1
+ {"version":3,"file":"GrepSpecFilter.js","sourceRoot":"","sources":["../../../src/adapter/filters/GrepSpecFilter.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,MAAM,OAAO,cAAc;IACN,OAAO,CAAS;IAEjC,YAAY,OAAwB;QAChC,IAAI,CAAC,OAAO,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC,CAAA;IACtC,CAAC;IAED,OAAO,CAAC,QAAgB;QACpB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;CACJ"}
@@ -1,7 +1,7 @@
1
1
  import { SerenityReporterForJasmine } from './SerenityReporterForJasmine.js';
2
2
  /**
3
3
  * Monkey-patches Jasmine's Suite and Spec so that they provide more accurate information,
4
- * and returns a bootstrapped instance of the {@apilink SerenityReporterForJasmine} to be registered with Jasmine.
4
+ * and returns a bootstrapped instance of the [`SerenityReporterForJasmine`](https://serenity-js.org/api/jasmine/function/default/) to be registered with Jasmine.
5
5
  *
6
6
  * ## Registering the reporter from the command line
7
7
  *
@@ -17,13 +17,9 @@ import { SerenityReporterForJasmine } from './SerenityReporterForJasmine.js';
17
17
  * jasmine.getEnv().addReporter(serenityReporterForJasmine);
18
18
  * ```
19
19
  *
20
- * @see {@apilink monkeyPatched}
21
- * @see {@apilink SerenityReporterForJasmine}
22
- *
23
- * @param {SerenityReporterForJasmineConfig} config
24
- * @param {jasmine} jasmine - the global.jasmine instance
25
- *
26
- * @returns {SerenityReporterForJasmine}
20
+ * @param config
21
+ * @param jasmine
22
+ * the global.jasmine instance
27
23
  */
28
24
  export declare function bootstrap(config?: SerenityReporterForJasmineConfig, jasmine?: any): SerenityReporterForJasmine;
29
25
  export interface SerenityReporterForJasmineConfig {
@@ -1 +1 @@
1
- {"version":3,"file":"bootstrap.d.ts","sourceRoot":"","sources":["../src/bootstrap.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,0BAA0B,EAAE,MAAM,iCAAiC,CAAC;AAE7E;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,SAAS,CAAC,MAAM,GAAE,gCAAqC,EAAE,OAAO,MAA0B,GAAG,0BAA0B,CAuBtI;AAED,MAAM,WAAW,gCAAgC;IAC7C,aAAa,CAAC,EAAE,MAAM,CAAC;CAC1B"}
1
+ {"version":3,"file":"bootstrap.d.ts","sourceRoot":"","sources":["../src/bootstrap.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,0BAA0B,EAAE,MAAM,iCAAiC,CAAC;AAE7E;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,SAAS,CAAC,MAAM,GAAE,gCAAqC,EAAE,OAAO,MAA0B,GAAG,0BAA0B,CAuBtI;AAED,MAAM,WAAW,gCAAgC;IAC7C,aAAa,CAAC,EAAE,MAAM,CAAC;CAC1B"}
package/esm/bootstrap.js CHANGED
@@ -4,7 +4,7 @@ import { monkeyPatched } from './monkeyPatched.js';
4
4
  import { SerenityReporterForJasmine } from './SerenityReporterForJasmine.js';
5
5
  /**
6
6
  * Monkey-patches Jasmine's Suite and Spec so that they provide more accurate information,
7
- * and returns a bootstrapped instance of the {@apilink SerenityReporterForJasmine} to be registered with Jasmine.
7
+ * and returns a bootstrapped instance of the [`SerenityReporterForJasmine`](https://serenity-js.org/api/jasmine/function/default/) to be registered with Jasmine.
8
8
  *
9
9
  * ## Registering the reporter from the command line
10
10
  *
@@ -20,13 +20,9 @@ import { SerenityReporterForJasmine } from './SerenityReporterForJasmine.js';
20
20
  * jasmine.getEnv().addReporter(serenityReporterForJasmine);
21
21
  * ```
22
22
  *
23
- * @see {@apilink monkeyPatched}
24
- * @see {@apilink SerenityReporterForJasmine}
25
- *
26
- * @param {SerenityReporterForJasmineConfig} config
27
- * @param {jasmine} jasmine - the global.jasmine instance
28
- *
29
- * @returns {SerenityReporterForJasmine}
23
+ * @param config
24
+ * @param jasmine
25
+ * the global.jasmine instance
30
26
  */
31
27
  export function bootstrap(config = {}, jasmine = global.jasmine) {
32
28
  const wrappers = {
@@ -1 +1 @@
1
- {"version":3,"file":"bootstrap.js","sourceRoot":"","sources":["../src/bootstrap.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAE5F,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,0BAA0B,EAAE,MAAM,iCAAiC,CAAC;AAE7E;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,UAAU,SAAS,CAAC,SAA2C,EAAE,EAAE,UAAW,MAAc,CAAC,OAAO;IACtG,MAAM,QAAQ,GAAG;QACb,wBAAwB,EAAE,gCAAgC,CAAC,EAAE,CAAC,CAAC,CAAC,UAA6C,EAAE,EAAE;YAC7G,MAAM,MAAM,GAAG,gCAAgC,CAAC,UAAU,CAAC,CAAC;YAE5D,IAAI,CAAE,UAAU,CAAC,MAAM,IAAI,UAAU,CAAC,KAAK,YAAY,YAAY,EAAE;gBACjE,MAAM,CAAC,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC;aACzC;YAED,OAAO,MAAM,CAAC;QAClB,CAAC,CAAC;KACL,CAAC;IAEF,OAAO,CAAC,KAAK,GAAG,aAAa,CAAC,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IACvD,OAAO,CAAC,IAAI,GAAG,aAAa,CAAC,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAErD,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;IACrC,MAAM,qBAAqB,GAAG,IAAI,qBAAqB,CACnD,IAAI,UAAU,CAAC,GAAG,CAAC,EACnB,MAAM,EAAE,aAAa,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,CACzE,CAAC;IAEF,OAAO,IAAI,0BAA0B,CAAC,QAAQ,EAAE,qBAAqB,CAAC,CAAC;AAC3E,CAAC"}
1
+ {"version":3,"file":"bootstrap.js","sourceRoot":"","sources":["../src/bootstrap.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAE5F,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,0BAA0B,EAAE,MAAM,iCAAiC,CAAC;AAE7E;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,SAAS,CAAC,SAA2C,EAAE,EAAE,UAAW,MAAc,CAAC,OAAO;IACtG,MAAM,QAAQ,GAAG;QACb,wBAAwB,EAAE,gCAAgC,CAAC,EAAE,CAAC,CAAC,CAAC,UAA6C,EAAE,EAAE;YAC7G,MAAM,MAAM,GAAG,gCAAgC,CAAC,UAAU,CAAC,CAAC;YAE5D,IAAI,CAAE,UAAU,CAAC,MAAM,IAAI,UAAU,CAAC,KAAK,YAAY,YAAY,EAAE;gBACjE,MAAM,CAAC,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC;aACzC;YAED,OAAO,MAAM,CAAC;QAClB,CAAC,CAAC;KACL,CAAC;IAEF,OAAO,CAAC,KAAK,GAAG,aAAa,CAAC,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IACvD,OAAO,CAAC,IAAI,GAAG,aAAa,CAAC,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAErD,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;IACrC,MAAM,qBAAqB,GAAG,IAAI,qBAAqB,CACnD,IAAI,UAAU,CAAC,GAAG,CAAC,EACnB,MAAM,EAAE,aAAa,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,CACzE,CAAC;IAEF,OAAO,IAAI,0BAA0B,CAAC,QAAQ,EAAE,qBAAqB,CAAC,CAAC;AAC3E,CAAC"}
@@ -1,11 +1,11 @@
1
1
  import type { Expectation } from './Expectation.js';
2
2
  import type { Order } from './Order.js';
3
3
  /**
4
- * @desc
5
- * Information passed to the Reporter#jasmineDone event.
4
+ * Information passed to the Reporter#jasmineDone event.
6
5
  *
7
- * @package
8
6
  * @see https://jasmine.github.io/api/edge/global.html#JasmineDoneInfo
7
+ *
8
+ * @package
9
9
  */
10
10
  export interface JasmineDoneInfo {
11
11
  /** The overall result of the suite: 'passed', 'failed', or 'incomplete'. */
@@ -3,77 +3,50 @@ import type { JasmineStartedInfo } from './JasmineStartedInfo.js';
3
3
  import type { SpecResult } from './SpecResult.js';
4
4
  import type { SuiteResult } from './SuiteResult.js';
5
5
  /**
6
- * @desc
7
- * An interface representing an instance of a Jasmine Reporter object
6
+ * An interface representing an instance of a Jasmine Reporter object
8
7
  *
9
8
  * @see https://jasmine.github.io/api/edge/Reporter.html
10
- * @interface
11
9
  */
12
10
  export interface JasmineReporter {
13
11
  /**
14
- * @desc
15
- * Called after all of the specs have been loaded, but just before execution starts.
12
+ * Called after all of the specs have been loaded, but just before execution starts.
16
13
  *
17
14
  * @see https://jasmine.github.io/api/edge/Reporter.html#jasmineStarted
18
- *
19
- * @type {function(suiteInfo: JasmineStartedInfo): Promise<void> | void}
20
- * @public
21
15
  */
22
16
  jasmineStarted?: (suiteInfo: JasmineStartedInfo) => Promise<void> | void;
23
17
  /**
24
- * @desc
25
- * Invoked when an `it` starts to run (including associated `beforeEach` functions)
18
+ * Invoked when an `it` starts to run (including associated `beforeEach` functions)
26
19
  *
27
20
  * @see https://jasmine.github.io/api/edge/Reporter.html#specStarted
28
- *
29
- * @type {function(result: SpecResult): Promise<void> | void}
30
- * @public
31
21
  */
32
22
  specStarted?: (result: SpecResult) => Promise<void> | void;
33
23
  /**
34
- * @desc
35
- * Invoked when an `it` and its associated `beforeEach` and `afterEach` functions have been run.
24
+ * Invoked when an `it` and its associated `beforeEach` and `afterEach` functions have been run.
36
25
  *
37
- * While Jasmine doesn't require any specific functions, not defining a `specDone`
38
- * will make it impossible for a reporter to know when a spec has failed.
26
+ * While Jasmine doesn't require any specific functions, not defining a `specDone`
27
+ * will make it impossible for a reporter to know when a spec has failed.
39
28
  *
40
29
  * @see https://jasmine.github.io/api/edge/Reporter.html#specDone
41
- *
42
- * @type {function(result: SpecResult): Promise<void> | void}
43
- * @public
44
30
  */
45
31
  specDone?: (result: SpecResult) => Promise<void> | void;
46
32
  /**
47
- * @desc
48
- * Invoked when a `describe` starts to run.
33
+ * Invoked when a `describe` starts to run.
49
34
  *
50
35
  * @see https://jasmine.github.io/api/edge/Reporter.html#suiteStarted
51
- *
52
- * @type {function(result: SuiteResult): Promise<void> | void}
53
- * @public
54
36
  */
55
37
  suiteStarted?: (result: SuiteResult) => Promise<void> | void;
56
38
  /**
57
- * @desc
58
- * Invoked when all of the child specs and suites for a given suite have been run.
59
- *
60
- * While Jasmine doesn't require any specific functions, not defining a `suiteDone`
61
- * will make it impossible for a reporter to know when a suite has failures in an `afterAll`.
39
+ * Invoked when all the child specs and suites for a given suite have been run.
40
+ * While Jasmine doesn't require any specific functions, not defining a `suiteDone`
41
+ * will make it impossible for a reporter to know when a suite has failures in an `afterAll`.
62
42
  *
63
43
  * @see https://jasmine.github.io/api/edge/Reporter.html#suiteDone
64
- *
65
- * @type {function(result: SuiteResult): Promise<void> | void}
66
- * @public
67
44
  */
68
45
  suiteDone?: (result: SuiteResult) => Promise<void> | void;
69
46
  /**
70
- * @desc
71
- * Called when the entire suite has finished execution.
47
+ * Called when the entire suite has finished execution.
72
48
  *
73
49
  * @see https://jasmine.github.io/api/edge/Reporter.html#jasmineDone
74
- *
75
- * @type {function(suiteInfo: JasmineDoneInfo): Promise<void> | void}
76
- * @public
77
50
  */
78
51
  jasmineDone?: (suiteInfo: JasmineDoneInfo) => Promise<void> | void;
79
52
  }
@@ -1 +1 @@
1
- {"version":3,"file":"JasmineReporter.d.ts","sourceRoot":"","sources":["../../src/jasmine/JasmineReporter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAClE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAEpD;;;;;;GAMG;AACH,MAAM,WAAW,eAAe;IAE5B;;;;;;;;OAQG;IACH,cAAc,CAAC,EAAE,CAAC,SAAS,EAAE,kBAAkB,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAEzE;;;;;;;;OAQG;IACH,WAAW,CAAC,EAAE,CAAC,MAAM,EAAE,UAAU,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAE3D;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,UAAU,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAExD;;;;;;;;OAQG;IACH,YAAY,CAAC,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAE7D;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAE1D;;;;;;;;OAQG;IACH,WAAW,CAAC,EAAE,CAAC,SAAS,EAAE,eAAe,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;CACtE"}
1
+ {"version":3,"file":"JasmineReporter.d.ts","sourceRoot":"","sources":["../../src/jasmine/JasmineReporter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAClE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAEpD;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAE5B;;;;OAIG;IACH,cAAc,CAAC,EAAE,CAAC,SAAS,EAAE,kBAAkB,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAEzE;;;;OAIG;IACH,WAAW,CAAC,EAAE,CAAC,MAAM,EAAE,UAAU,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAE3D;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,UAAU,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAExD;;;;OAIG;IACH,YAAY,CAAC,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAE7D;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAE1D;;;;OAIG;IACH,WAAW,CAAC,EAAE,CAAC,SAAS,EAAE,eAAe,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;CACtE"}
@@ -1,10 +1,10 @@
1
1
  import type { Order } from './Order.js';
2
2
  /**
3
- * @desc
4
- * Information passed to the Reporter#jasmineStarted event.
3
+ * Information passed to the Reporter#jasmineStarted event.
5
4
  *
6
- * @package
7
5
  * @see https://jasmine.github.io/api/edge/global.html#JasmineStartedInfo
6
+ *
7
+ * @package
8
8
  */
9
9
  export interface JasmineStartedInfo {
10
10
  /** The total number of specs defined in this suite. */
@@ -1,6 +1,5 @@
1
1
  /**
2
- * @desc
3
- * A Serenity/JS-specific customisation - the file system location of the caller of a given `it` and `describe` function.
2
+ * A Serenity/JS-specific customisation - the file system location of the caller of a given `it` and `describe` function.
4
3
  *
5
4
  * @package
6
5
  */
@@ -1 +1 @@
1
- {"version":3,"file":"Location.d.ts","sourceRoot":"","sources":["../../src/jasmine/Location.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,WAAW,QAAQ;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;CAChB"}
1
+ {"version":3,"file":"Location.d.ts","sourceRoot":"","sources":["../../src/jasmine/Location.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,QAAQ;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;CAChB"}
@@ -1,6 +1,5 @@
1
1
  /**
2
- * @desc
3
- * Information about the ordering (random or not) of this execution of the suite.
2
+ * Information about the ordering (random or not) of this execution of the suite.
4
3
  *
5
4
  * @package
6
5
  */
@@ -1 +1 @@
1
- {"version":3,"file":"Order.d.ts","sourceRoot":"","sources":["../../src/jasmine/Order.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,WAAW,KAAK;IAClB,MAAM,EAAE,OAAO,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,CAAC,KAAK,KAAK,CAAC;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CACjE"}
1
+ {"version":3,"file":"Order.d.ts","sourceRoot":"","sources":["../../src/jasmine/Order.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,KAAK;IAClB,MAAM,EAAE,OAAO,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,CAAC,KAAK,KAAK,CAAC;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CACjE"}
@@ -1,9 +1,8 @@
1
1
  /**
2
- * @desc
3
- * Monkey-patches Jasmine domain model constructors so that they
4
- * record information about the file system location of the caller function.
2
+ * Monkey-patches Jasmine domain model constructors so that they
3
+ * record information about the file system location of the caller function.
5
4
  *
6
- * This helps to make reporting more accurate.
5
+ * This helps to make reporting more accurate.
7
6
  *
8
7
  * @param jasmineConstructor - A Jasmine constructor function to be patched
9
8
  * @param {object} wrappers - Attributes to wrap when the monkey-patched Jasmine constructor is invoked
@@ -1 +1 @@
1
- {"version":3,"file":"monkeyPatched.d.ts","sourceRoot":"","sources":["../src/monkeyPatched.ts"],"names":[],"mappings":"AAMA;;;;;;;;;GASG;AACH,wBAAgB,aAAa,CACzB,kBAAkB,EAAE,GAAG,EACvB,QAAQ,GAAE;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,EAAE,MAAM,KAAK,GAAG,CAAA;CAAM,WAE/C,MAAM,SAkBtD"}
1
+ {"version":3,"file":"monkeyPatched.d.ts","sourceRoot":"","sources":["../src/monkeyPatched.ts"],"names":[],"mappings":"AAMA;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CACzB,kBAAkB,EAAE,GAAG,EACvB,QAAQ,GAAE;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,EAAE,MAAM,KAAK,GAAG,CAAA;CAAM,WAE/C,MAAM,SAkBtD"}
@@ -2,11 +2,10 @@ import { ErrorStackParser } from '@serenity-js/core/lib/errors/index.js';
2
2
  const parser = new ErrorStackParser();
3
3
  /* eslint-disable @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/ban-types */
4
4
  /**
5
- * @desc
6
- * Monkey-patches Jasmine domain model constructors so that they
7
- * record information about the file system location of the caller function.
5
+ * Monkey-patches Jasmine domain model constructors so that they
6
+ * record information about the file system location of the caller function.
8
7
  *
9
- * This helps to make reporting more accurate.
8
+ * This helps to make reporting more accurate.
10
9
  *
11
10
  * @param jasmineConstructor - A Jasmine constructor function to be patched
12
11
  * @param {object} wrappers - Attributes to wrap when the monkey-patched Jasmine constructor is invoked
@@ -29,8 +28,7 @@ export function monkeyPatched(jasmineConstructor, wrappers = {}) {
29
28
  }
30
29
  // eslint-enable
31
30
  /**
32
- * @desc
33
- * Retrieves the file system location of the caller function.
31
+ * Retrieves the file system location of the caller function.
34
32
  *
35
33
  * @package
36
34
  */
@@ -47,10 +45,7 @@ function callerLocation() {
47
45
  };
48
46
  }
49
47
  /**
50
- * @desc
51
- * Checks if a given property is likely to be a static method or a static field on the constructor function.
52
- *
53
- * @param {string} property - name of the property to be checked
48
+ * Checks if a given property is likely to be a static method or a static field on the constructor function.
54
49
  *
55
50
  * @package
56
51
  */
@@ -1 +1 @@
1
- {"version":3,"file":"monkeyPatched.js","sourceRoot":"","sources":["../src/monkeyPatched.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uCAAuC,CAAC;AAEzE,MAAM,MAAM,GAAG,IAAI,gBAAgB,EAAE,CAAC;AAEtC,oGAAoG;AAEpG;;;;;;;;;GASG;AACH,MAAM,UAAU,aAAa,CACzB,kBAAuB,EACvB,WAA0F,EAAE;IAE5F,MAAM,MAAM,GAAG,SAAS,aAAa,CAAC,KAAa;QAC/C,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YAChC,KAAK,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,IAAI,kBAAkB,CAAC,KAAK,CAAC,CAAC;QAC/C,QAAQ,CAAC,MAAM,CAAC,QAAQ,GAAG,cAAc,EAAE,CAAC;QAE5C,OAAO,QAAQ,CAAC;IACpB,CAAC,CAAC;IAEF,MAAM,CAAC,mBAAmB,CAAC,kBAAkB,CAAC;SACzC,MAAM,CAAC,iBAAiB,CAAC;SACzB,OAAO,CAAC,QAAQ,CAAC,EAAE;QAChB,MAAM,CAAC,QAAQ,CAAC,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEP,OAAO,MAAM,CAAC;AAClB,CAAC;AAED,gBAAgB;AAEhB;;;;;GAKG;AACH,SAAS,cAAc;IACnB,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC;IAErD,MAAM,KAAK,GAAG,MAAM;SACf,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAE,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;SACxD,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,uBAAuB,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAE,KAAK,CAAC,YAAY,CAAC,CAAC;IAE7F,MAAM,MAAM,GAAG,KAAK,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,CAAC;IAEhF,OAAO;QACH,IAAI,EAAE,MAAM,CAAC,QAAQ;QACrB,IAAI,EAAE,MAAM,CAAC,UAAU;QACvB,MAAM,EAAE,MAAM,CAAC,YAAY;KAC9B,CAAC;AACN,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,iBAAiB,CAAC,QAAgB;IACvC,OAAO,CAAE,CAAC,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;AACvF,CAAC"}
1
+ {"version":3,"file":"monkeyPatched.js","sourceRoot":"","sources":["../src/monkeyPatched.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uCAAuC,CAAC;AAEzE,MAAM,MAAM,GAAG,IAAI,gBAAgB,EAAE,CAAC;AAEtC,oGAAoG;AAEpG;;;;;;;;GAQG;AACH,MAAM,UAAU,aAAa,CACzB,kBAAuB,EACvB,WAA0F,EAAE;IAE5F,MAAM,MAAM,GAAG,SAAS,aAAa,CAAC,KAAa;QAC/C,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YAChC,KAAK,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,IAAI,kBAAkB,CAAC,KAAK,CAAC,CAAC;QAC/C,QAAQ,CAAC,MAAM,CAAC,QAAQ,GAAG,cAAc,EAAE,CAAC;QAE5C,OAAO,QAAQ,CAAC;IACpB,CAAC,CAAC;IAEF,MAAM,CAAC,mBAAmB,CAAC,kBAAkB,CAAC;SACzC,MAAM,CAAC,iBAAiB,CAAC;SACzB,OAAO,CAAC,QAAQ,CAAC,EAAE;QAChB,MAAM,CAAC,QAAQ,CAAC,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEP,OAAO,MAAM,CAAC;AAClB,CAAC;AAED,gBAAgB;AAEhB;;;;GAIG;AACH,SAAS,cAAc;IACnB,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC;IAErD,MAAM,KAAK,GAAG,MAAM;SACf,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAE,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;SACxD,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,uBAAuB,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAE,KAAK,CAAC,YAAY,CAAC,CAAC;IAE7F,MAAM,MAAM,GAAG,KAAK,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,CAAC;IAEhF,OAAO;QACH,IAAI,EAAE,MAAM,CAAC,QAAQ;QACrB,IAAI,EAAE,MAAM,CAAC,UAAU;QACvB,MAAM,EAAE,MAAM,CAAC,YAAY;KAC9B,CAAC;AACN,CAAC;AAED;;;;GAIG;AACH,SAAS,iBAAiB,CAAC,QAAgB;IACvC,OAAO,CAAE,CAAC,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;AACvF,CAAC"}
@@ -4,10 +4,10 @@ import type { Outcome } from '@serenity-js/core/lib/model/index.js';
4
4
  import type { JasmineConfig } from './JasmineConfig.js';
5
5
  /**
6
6
  * Allows for programmatic execution of Jasmine test scenarios,
7
- * using {@apilink SerenityReporterForJasmine} to report progress.
7
+ * using [`SerenityReporterForJasmine`](https://serenity-js.org/api/jasmine/function/default/) to report progress.
8
8
  *
9
9
  * ## Learn more
10
- * - {@apilink TestRunnerAdapter}
10
+ * - [`TestRunnerAdapter`](https://serenity-js.org/api/core-adapter/interface/TestRunnerAdapter/)
11
11
  *
12
12
  * @group Integration
13
13
  */
@@ -9,10 +9,10 @@ const index_js_2 = __importDefault(require("../index.js"));
9
9
  const index_js_3 = require("./filters/index.js");
10
10
  /**
11
11
  * Allows for programmatic execution of Jasmine test scenarios,
12
- * using {@apilink SerenityReporterForJasmine} to report progress.
12
+ * using [`SerenityReporterForJasmine`](https://serenity-js.org/api/jasmine/function/default/) to report progress.
13
13
  *
14
14
  * ## Learn more
15
- * - {@apilink TestRunnerAdapter}
15
+ * - [`TestRunnerAdapter`](https://serenity-js.org/api/core-adapter/interface/TestRunnerAdapter/)
16
16
  *
17
17
  * @group Integration
18
18
  */
@@ -1,8 +1,6 @@
1
1
  import type { SpecFilter } from './SpecFilter.js';
2
2
  /**
3
- * @desc
4
- * https://github.com/jasmine/jasmine-npm/blob/641c33d4765efb0486f68980a8b7d184dd797122/lib/filters/console_spec_filter.js
5
- *
3
+ * @see https://github.com/jasmine/jasmine-npm/blob/641c33d4765efb0486f68980a8b7d184dd797122/lib/filters/console_spec_filter.js
6
4
  * @package
7
5
  */
8
6
  export declare class GrepSpecFilter implements SpecFilter {
@@ -1 +1 @@
1
- {"version":3,"file":"GrepSpecFilter.d.ts","sourceRoot":"","sources":["../../../src/adapter/filters/GrepSpecFilter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAElD;;;;;GAKG;AACH,qBAAa,cAAe,YAAW,UAAU;IAC7C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;gBAErB,OAAO,EAAE,MAAM,GAAG,MAAM;IAIpC,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;CAGrC"}
1
+ {"version":3,"file":"GrepSpecFilter.d.ts","sourceRoot":"","sources":["../../../src/adapter/filters/GrepSpecFilter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAElD;;;GAGG;AACH,qBAAa,cAAe,YAAW,UAAU;IAC7C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;gBAErB,OAAO,EAAE,MAAM,GAAG,MAAM;IAIpC,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;CAGrC"}
@@ -2,9 +2,7 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.GrepSpecFilter = void 0;
4
4
  /**
5
- * @desc
6
- * https://github.com/jasmine/jasmine-npm/blob/641c33d4765efb0486f68980a8b7d184dd797122/lib/filters/console_spec_filter.js
7
- *
5
+ * @see https://github.com/jasmine/jasmine-npm/blob/641c33d4765efb0486f68980a8b7d184dd797122/lib/filters/console_spec_filter.js
8
6
  * @package
9
7
  */
10
8
  class GrepSpecFilter {
@@ -1 +1 @@
1
- {"version":3,"file":"GrepSpecFilter.js","sourceRoot":"","sources":["../../../src/adapter/filters/GrepSpecFilter.ts"],"names":[],"mappings":";;;AAEA;;;;;GAKG;AACH,MAAa,cAAc;IACN,OAAO,CAAS;IAEjC,YAAY,OAAwB;QAChC,IAAI,CAAC,OAAO,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC,CAAA;IACtC,CAAC;IAED,OAAO,CAAC,QAAgB;QACpB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;CACJ;AAVD,wCAUC"}
1
+ {"version":3,"file":"GrepSpecFilter.js","sourceRoot":"","sources":["../../../src/adapter/filters/GrepSpecFilter.ts"],"names":[],"mappings":";;;AAEA;;;GAGG;AACH,MAAa,cAAc;IACN,OAAO,CAAS;IAEjC,YAAY,OAAwB;QAChC,IAAI,CAAC,OAAO,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC,CAAA;IACtC,CAAC;IAED,OAAO,CAAC,QAAgB;QACpB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;CACJ;AAVD,wCAUC"}
@@ -1,7 +1,7 @@
1
1
  import { SerenityReporterForJasmine } from './SerenityReporterForJasmine.js';
2
2
  /**
3
3
  * Monkey-patches Jasmine's Suite and Spec so that they provide more accurate information,
4
- * and returns a bootstrapped instance of the {@apilink SerenityReporterForJasmine} to be registered with Jasmine.
4
+ * and returns a bootstrapped instance of the [`SerenityReporterForJasmine`](https://serenity-js.org/api/jasmine/function/default/) to be registered with Jasmine.
5
5
  *
6
6
  * ## Registering the reporter from the command line
7
7
  *
@@ -17,13 +17,9 @@ import { SerenityReporterForJasmine } from './SerenityReporterForJasmine.js';
17
17
  * jasmine.getEnv().addReporter(serenityReporterForJasmine);
18
18
  * ```
19
19
  *
20
- * @see {@apilink monkeyPatched}
21
- * @see {@apilink SerenityReporterForJasmine}
22
- *
23
- * @param {SerenityReporterForJasmineConfig} config
24
- * @param {jasmine} jasmine - the global.jasmine instance
25
- *
26
- * @returns {SerenityReporterForJasmine}
20
+ * @param config
21
+ * @param jasmine
22
+ * the global.jasmine instance
27
23
  */
28
24
  export declare function bootstrap(config?: SerenityReporterForJasmineConfig, jasmine?: any): SerenityReporterForJasmine;
29
25
  export interface SerenityReporterForJasmineConfig {
@@ -1 +1 @@
1
- {"version":3,"file":"bootstrap.d.ts","sourceRoot":"","sources":["../src/bootstrap.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,0BAA0B,EAAE,MAAM,iCAAiC,CAAC;AAE7E;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,SAAS,CAAC,MAAM,GAAE,gCAAqC,EAAE,OAAO,MAA0B,GAAG,0BAA0B,CAuBtI;AAED,MAAM,WAAW,gCAAgC;IAC7C,aAAa,CAAC,EAAE,MAAM,CAAC;CAC1B"}
1
+ {"version":3,"file":"bootstrap.d.ts","sourceRoot":"","sources":["../src/bootstrap.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,0BAA0B,EAAE,MAAM,iCAAiC,CAAC;AAE7E;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,SAAS,CAAC,MAAM,GAAE,gCAAqC,EAAE,OAAO,MAA0B,GAAG,0BAA0B,CAuBtI;AAED,MAAM,WAAW,gCAAgC;IAC7C,aAAa,CAAC,EAAE,MAAM,CAAC;CAC1B"}
package/lib/bootstrap.js CHANGED
@@ -7,7 +7,7 @@ const monkeyPatched_js_1 = require("./monkeyPatched.js");
7
7
  const SerenityReporterForJasmine_js_1 = require("./SerenityReporterForJasmine.js");
8
8
  /**
9
9
  * Monkey-patches Jasmine's Suite and Spec so that they provide more accurate information,
10
- * and returns a bootstrapped instance of the {@apilink SerenityReporterForJasmine} to be registered with Jasmine.
10
+ * and returns a bootstrapped instance of the [`SerenityReporterForJasmine`](https://serenity-js.org/api/jasmine/function/default/) to be registered with Jasmine.
11
11
  *
12
12
  * ## Registering the reporter from the command line
13
13
  *
@@ -23,13 +23,9 @@ const SerenityReporterForJasmine_js_1 = require("./SerenityReporterForJasmine.js
23
23
  * jasmine.getEnv().addReporter(serenityReporterForJasmine);
24
24
  * ```
25
25
  *
26
- * @see {@apilink monkeyPatched}
27
- * @see {@apilink SerenityReporterForJasmine}
28
- *
29
- * @param {SerenityReporterForJasmineConfig} config
30
- * @param {jasmine} jasmine - the global.jasmine instance
31
- *
32
- * @returns {SerenityReporterForJasmine}
26
+ * @param config
27
+ * @param jasmine
28
+ * the global.jasmine instance
33
29
  */
34
30
  function bootstrap(config = {}, jasmine = global.jasmine) {
35
31
  const wrappers = {
@@ -1 +1 @@
1
- {"version":3,"file":"bootstrap.js","sourceRoot":"","sources":["../src/bootstrap.ts"],"names":[],"mappings":";;;AAAA,4CAA2D;AAC3D,gEAA4F;AAE5F,yDAAmD;AACnD,mFAA6E;AAE7E;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,SAAgB,SAAS,CAAC,SAA2C,EAAE,EAAE,UAAW,MAAc,CAAC,OAAO;IACtG,MAAM,QAAQ,GAAG;QACb,wBAAwB,EAAE,gCAAgC,CAAC,EAAE,CAAC,CAAC,CAAC,UAA6C,EAAE,EAAE;YAC7G,MAAM,MAAM,GAAG,gCAAgC,CAAC,UAAU,CAAC,CAAC;YAE5D,IAAI,CAAE,UAAU,CAAC,MAAM,IAAI,UAAU,CAAC,KAAK,YAAY,mBAAY,EAAE;gBACjE,MAAM,CAAC,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC;aACzC;YAED,OAAO,MAAM,CAAC;QAClB,CAAC,CAAC;KACL,CAAC;IAEF,OAAO,CAAC,KAAK,GAAG,IAAA,gCAAa,EAAC,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IACvD,OAAO,CAAC,IAAI,GAAG,IAAA,gCAAa,EAAC,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAErD,MAAM,GAAG,GAAG,eAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;IACrC,MAAM,qBAAqB,GAAG,IAAI,gCAAqB,CACnD,IAAI,qBAAU,CAAC,GAAG,CAAC,EACnB,MAAM,EAAE,aAAa,IAAI,GAAG,CAAC,OAAO,CAAC,eAAI,CAAC,IAAI,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,CACzE,CAAC;IAEF,OAAO,IAAI,0DAA0B,CAAC,eAAQ,EAAE,qBAAqB,CAAC,CAAC;AAC3E,CAAC;AAvBD,8BAuBC"}
1
+ {"version":3,"file":"bootstrap.js","sourceRoot":"","sources":["../src/bootstrap.ts"],"names":[],"mappings":";;;AAAA,4CAA2D;AAC3D,gEAA4F;AAE5F,yDAAmD;AACnD,mFAA6E;AAE7E;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,SAAgB,SAAS,CAAC,SAA2C,EAAE,EAAE,UAAW,MAAc,CAAC,OAAO;IACtG,MAAM,QAAQ,GAAG;QACb,wBAAwB,EAAE,gCAAgC,CAAC,EAAE,CAAC,CAAC,CAAC,UAA6C,EAAE,EAAE;YAC7G,MAAM,MAAM,GAAG,gCAAgC,CAAC,UAAU,CAAC,CAAC;YAE5D,IAAI,CAAE,UAAU,CAAC,MAAM,IAAI,UAAU,CAAC,KAAK,YAAY,mBAAY,EAAE;gBACjE,MAAM,CAAC,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC;aACzC;YAED,OAAO,MAAM,CAAC;QAClB,CAAC,CAAC;KACL,CAAC;IAEF,OAAO,CAAC,KAAK,GAAG,IAAA,gCAAa,EAAC,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IACvD,OAAO,CAAC,IAAI,GAAG,IAAA,gCAAa,EAAC,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAErD,MAAM,GAAG,GAAG,eAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;IACrC,MAAM,qBAAqB,GAAG,IAAI,gCAAqB,CACnD,IAAI,qBAAU,CAAC,GAAG,CAAC,EACnB,MAAM,EAAE,aAAa,IAAI,GAAG,CAAC,OAAO,CAAC,eAAI,CAAC,IAAI,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,CACzE,CAAC;IAEF,OAAO,IAAI,0DAA0B,CAAC,eAAQ,EAAE,qBAAqB,CAAC,CAAC;AAC3E,CAAC;AAvBD,8BAuBC"}
@@ -1,11 +1,11 @@
1
1
  import type { Expectation } from './Expectation.js';
2
2
  import type { Order } from './Order.js';
3
3
  /**
4
- * @desc
5
- * Information passed to the Reporter#jasmineDone event.
4
+ * Information passed to the Reporter#jasmineDone event.
6
5
  *
7
- * @package
8
6
  * @see https://jasmine.github.io/api/edge/global.html#JasmineDoneInfo
7
+ *
8
+ * @package
9
9
  */
10
10
  export interface JasmineDoneInfo {
11
11
  /** The overall result of the suite: 'passed', 'failed', or 'incomplete'. */
@@ -3,77 +3,50 @@ import type { JasmineStartedInfo } from './JasmineStartedInfo.js';
3
3
  import type { SpecResult } from './SpecResult.js';
4
4
  import type { SuiteResult } from './SuiteResult.js';
5
5
  /**
6
- * @desc
7
- * An interface representing an instance of a Jasmine Reporter object
6
+ * An interface representing an instance of a Jasmine Reporter object
8
7
  *
9
8
  * @see https://jasmine.github.io/api/edge/Reporter.html
10
- * @interface
11
9
  */
12
10
  export interface JasmineReporter {
13
11
  /**
14
- * @desc
15
- * Called after all of the specs have been loaded, but just before execution starts.
12
+ * Called after all of the specs have been loaded, but just before execution starts.
16
13
  *
17
14
  * @see https://jasmine.github.io/api/edge/Reporter.html#jasmineStarted
18
- *
19
- * @type {function(suiteInfo: JasmineStartedInfo): Promise<void> | void}
20
- * @public
21
15
  */
22
16
  jasmineStarted?: (suiteInfo: JasmineStartedInfo) => Promise<void> | void;
23
17
  /**
24
- * @desc
25
- * Invoked when an `it` starts to run (including associated `beforeEach` functions)
18
+ * Invoked when an `it` starts to run (including associated `beforeEach` functions)
26
19
  *
27
20
  * @see https://jasmine.github.io/api/edge/Reporter.html#specStarted
28
- *
29
- * @type {function(result: SpecResult): Promise<void> | void}
30
- * @public
31
21
  */
32
22
  specStarted?: (result: SpecResult) => Promise<void> | void;
33
23
  /**
34
- * @desc
35
- * Invoked when an `it` and its associated `beforeEach` and `afterEach` functions have been run.
24
+ * Invoked when an `it` and its associated `beforeEach` and `afterEach` functions have been run.
36
25
  *
37
- * While Jasmine doesn't require any specific functions, not defining a `specDone`
38
- * will make it impossible for a reporter to know when a spec has failed.
26
+ * While Jasmine doesn't require any specific functions, not defining a `specDone`
27
+ * will make it impossible for a reporter to know when a spec has failed.
39
28
  *
40
29
  * @see https://jasmine.github.io/api/edge/Reporter.html#specDone
41
- *
42
- * @type {function(result: SpecResult): Promise<void> | void}
43
- * @public
44
30
  */
45
31
  specDone?: (result: SpecResult) => Promise<void> | void;
46
32
  /**
47
- * @desc
48
- * Invoked when a `describe` starts to run.
33
+ * Invoked when a `describe` starts to run.
49
34
  *
50
35
  * @see https://jasmine.github.io/api/edge/Reporter.html#suiteStarted
51
- *
52
- * @type {function(result: SuiteResult): Promise<void> | void}
53
- * @public
54
36
  */
55
37
  suiteStarted?: (result: SuiteResult) => Promise<void> | void;
56
38
  /**
57
- * @desc
58
- * Invoked when all of the child specs and suites for a given suite have been run.
59
- *
60
- * While Jasmine doesn't require any specific functions, not defining a `suiteDone`
61
- * will make it impossible for a reporter to know when a suite has failures in an `afterAll`.
39
+ * Invoked when all the child specs and suites for a given suite have been run.
40
+ * While Jasmine doesn't require any specific functions, not defining a `suiteDone`
41
+ * will make it impossible for a reporter to know when a suite has failures in an `afterAll`.
62
42
  *
63
43
  * @see https://jasmine.github.io/api/edge/Reporter.html#suiteDone
64
- *
65
- * @type {function(result: SuiteResult): Promise<void> | void}
66
- * @public
67
44
  */
68
45
  suiteDone?: (result: SuiteResult) => Promise<void> | void;
69
46
  /**
70
- * @desc
71
- * Called when the entire suite has finished execution.
47
+ * Called when the entire suite has finished execution.
72
48
  *
73
49
  * @see https://jasmine.github.io/api/edge/Reporter.html#jasmineDone
74
- *
75
- * @type {function(suiteInfo: JasmineDoneInfo): Promise<void> | void}
76
- * @public
77
50
  */
78
51
  jasmineDone?: (suiteInfo: JasmineDoneInfo) => Promise<void> | void;
79
52
  }
@@ -1 +1 @@
1
- {"version":3,"file":"JasmineReporter.d.ts","sourceRoot":"","sources":["../../src/jasmine/JasmineReporter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAClE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAEpD;;;;;;GAMG;AACH,MAAM,WAAW,eAAe;IAE5B;;;;;;;;OAQG;IACH,cAAc,CAAC,EAAE,CAAC,SAAS,EAAE,kBAAkB,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAEzE;;;;;;;;OAQG;IACH,WAAW,CAAC,EAAE,CAAC,MAAM,EAAE,UAAU,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAE3D;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,UAAU,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAExD;;;;;;;;OAQG;IACH,YAAY,CAAC,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAE7D;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAE1D;;;;;;;;OAQG;IACH,WAAW,CAAC,EAAE,CAAC,SAAS,EAAE,eAAe,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;CACtE"}
1
+ {"version":3,"file":"JasmineReporter.d.ts","sourceRoot":"","sources":["../../src/jasmine/JasmineReporter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAClE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAEpD;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAE5B;;;;OAIG;IACH,cAAc,CAAC,EAAE,CAAC,SAAS,EAAE,kBAAkB,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAEzE;;;;OAIG;IACH,WAAW,CAAC,EAAE,CAAC,MAAM,EAAE,UAAU,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAE3D;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,UAAU,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAExD;;;;OAIG;IACH,YAAY,CAAC,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAE7D;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAE1D;;;;OAIG;IACH,WAAW,CAAC,EAAE,CAAC,SAAS,EAAE,eAAe,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;CACtE"}
@@ -1,10 +1,10 @@
1
1
  import type { Order } from './Order.js';
2
2
  /**
3
- * @desc
4
- * Information passed to the Reporter#jasmineStarted event.
3
+ * Information passed to the Reporter#jasmineStarted event.
5
4
  *
6
- * @package
7
5
  * @see https://jasmine.github.io/api/edge/global.html#JasmineStartedInfo
6
+ *
7
+ * @package
8
8
  */
9
9
  export interface JasmineStartedInfo {
10
10
  /** The total number of specs defined in this suite. */
@@ -1,6 +1,5 @@
1
1
  /**
2
- * @desc
3
- * A Serenity/JS-specific customisation - the file system location of the caller of a given `it` and `describe` function.
2
+ * A Serenity/JS-specific customisation - the file system location of the caller of a given `it` and `describe` function.
4
3
  *
5
4
  * @package
6
5
  */
@@ -1 +1 @@
1
- {"version":3,"file":"Location.d.ts","sourceRoot":"","sources":["../../src/jasmine/Location.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,WAAW,QAAQ;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;CAChB"}
1
+ {"version":3,"file":"Location.d.ts","sourceRoot":"","sources":["../../src/jasmine/Location.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,QAAQ;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;CAChB"}
@@ -1,6 +1,5 @@
1
1
  /**
2
- * @desc
3
- * Information about the ordering (random or not) of this execution of the suite.
2
+ * Information about the ordering (random or not) of this execution of the suite.
4
3
  *
5
4
  * @package
6
5
  */
@@ -1 +1 @@
1
- {"version":3,"file":"Order.d.ts","sourceRoot":"","sources":["../../src/jasmine/Order.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,WAAW,KAAK;IAClB,MAAM,EAAE,OAAO,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,CAAC,KAAK,KAAK,CAAC;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CACjE"}
1
+ {"version":3,"file":"Order.d.ts","sourceRoot":"","sources":["../../src/jasmine/Order.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,KAAK;IAClB,MAAM,EAAE,OAAO,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,CAAC,KAAK,KAAK,CAAC;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CACjE"}
@@ -1,9 +1,8 @@
1
1
  /**
2
- * @desc
3
- * Monkey-patches Jasmine domain model constructors so that they
4
- * record information about the file system location of the caller function.
2
+ * Monkey-patches Jasmine domain model constructors so that they
3
+ * record information about the file system location of the caller function.
5
4
  *
6
- * This helps to make reporting more accurate.
5
+ * This helps to make reporting more accurate.
7
6
  *
8
7
  * @param jasmineConstructor - A Jasmine constructor function to be patched
9
8
  * @param {object} wrappers - Attributes to wrap when the monkey-patched Jasmine constructor is invoked
@@ -1 +1 @@
1
- {"version":3,"file":"monkeyPatched.d.ts","sourceRoot":"","sources":["../src/monkeyPatched.ts"],"names":[],"mappings":"AAMA;;;;;;;;;GASG;AACH,wBAAgB,aAAa,CACzB,kBAAkB,EAAE,GAAG,EACvB,QAAQ,GAAE;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,EAAE,MAAM,KAAK,GAAG,CAAA;CAAM,WAE/C,MAAM,SAkBtD"}
1
+ {"version":3,"file":"monkeyPatched.d.ts","sourceRoot":"","sources":["../src/monkeyPatched.ts"],"names":[],"mappings":"AAMA;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CACzB,kBAAkB,EAAE,GAAG,EACvB,QAAQ,GAAE;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,EAAE,MAAM,KAAK,GAAG,CAAA;CAAM,WAE/C,MAAM,SAkBtD"}
@@ -5,11 +5,10 @@ const index_js_1 = require("@serenity-js/core/lib/errors/index.js");
5
5
  const parser = new index_js_1.ErrorStackParser();
6
6
  /* eslint-disable @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/ban-types */
7
7
  /**
8
- * @desc
9
- * Monkey-patches Jasmine domain model constructors so that they
10
- * record information about the file system location of the caller function.
8
+ * Monkey-patches Jasmine domain model constructors so that they
9
+ * record information about the file system location of the caller function.
11
10
  *
12
- * This helps to make reporting more accurate.
11
+ * This helps to make reporting more accurate.
13
12
  *
14
13
  * @param jasmineConstructor - A Jasmine constructor function to be patched
15
14
  * @param {object} wrappers - Attributes to wrap when the monkey-patched Jasmine constructor is invoked
@@ -33,8 +32,7 @@ function monkeyPatched(jasmineConstructor, wrappers = {}) {
33
32
  exports.monkeyPatched = monkeyPatched;
34
33
  // eslint-enable
35
34
  /**
36
- * @desc
37
- * Retrieves the file system location of the caller function.
35
+ * Retrieves the file system location of the caller function.
38
36
  *
39
37
  * @package
40
38
  */
@@ -51,10 +49,7 @@ function callerLocation() {
51
49
  };
52
50
  }
53
51
  /**
54
- * @desc
55
- * Checks if a given property is likely to be a static method or a static field on the constructor function.
56
- *
57
- * @param {string} property - name of the property to be checked
52
+ * Checks if a given property is likely to be a static method or a static field on the constructor function.
58
53
  *
59
54
  * @package
60
55
  */
@@ -1 +1 @@
1
- {"version":3,"file":"monkeyPatched.js","sourceRoot":"","sources":["../src/monkeyPatched.ts"],"names":[],"mappings":";;;AAAA,oEAAyE;AAEzE,MAAM,MAAM,GAAG,IAAI,2BAAgB,EAAE,CAAC;AAEtC,oGAAoG;AAEpG;;;;;;;;;GASG;AACH,SAAgB,aAAa,CACzB,kBAAuB,EACvB,WAA0F,EAAE;IAE5F,MAAM,MAAM,GAAG,SAAS,aAAa,CAAC,KAAa;QAC/C,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YAChC,KAAK,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,IAAI,kBAAkB,CAAC,KAAK,CAAC,CAAC;QAC/C,QAAQ,CAAC,MAAM,CAAC,QAAQ,GAAG,cAAc,EAAE,CAAC;QAE5C,OAAO,QAAQ,CAAC;IACpB,CAAC,CAAC;IAEF,MAAM,CAAC,mBAAmB,CAAC,kBAAkB,CAAC;SACzC,MAAM,CAAC,iBAAiB,CAAC;SACzB,OAAO,CAAC,QAAQ,CAAC,EAAE;QAChB,MAAM,CAAC,QAAQ,CAAC,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEP,OAAO,MAAM,CAAC;AAClB,CAAC;AAtBD,sCAsBC;AAED,gBAAgB;AAEhB;;;;;GAKG;AACH,SAAS,cAAc;IACnB,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC;IAErD,MAAM,KAAK,GAAG,MAAM;SACf,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAE,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;SACxD,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,uBAAuB,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAE,KAAK,CAAC,YAAY,CAAC,CAAC;IAE7F,MAAM,MAAM,GAAG,KAAK,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,CAAC;IAEhF,OAAO;QACH,IAAI,EAAE,MAAM,CAAC,QAAQ;QACrB,IAAI,EAAE,MAAM,CAAC,UAAU;QACvB,MAAM,EAAE,MAAM,CAAC,YAAY;KAC9B,CAAC;AACN,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,iBAAiB,CAAC,QAAgB;IACvC,OAAO,CAAE,CAAC,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;AACvF,CAAC"}
1
+ {"version":3,"file":"monkeyPatched.js","sourceRoot":"","sources":["../src/monkeyPatched.ts"],"names":[],"mappings":";;;AAAA,oEAAyE;AAEzE,MAAM,MAAM,GAAG,IAAI,2BAAgB,EAAE,CAAC;AAEtC,oGAAoG;AAEpG;;;;;;;;GAQG;AACH,SAAgB,aAAa,CACzB,kBAAuB,EACvB,WAA0F,EAAE;IAE5F,MAAM,MAAM,GAAG,SAAS,aAAa,CAAC,KAAa;QAC/C,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YAChC,KAAK,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,IAAI,kBAAkB,CAAC,KAAK,CAAC,CAAC;QAC/C,QAAQ,CAAC,MAAM,CAAC,QAAQ,GAAG,cAAc,EAAE,CAAC;QAE5C,OAAO,QAAQ,CAAC;IACpB,CAAC,CAAC;IAEF,MAAM,CAAC,mBAAmB,CAAC,kBAAkB,CAAC;SACzC,MAAM,CAAC,iBAAiB,CAAC;SACzB,OAAO,CAAC,QAAQ,CAAC,EAAE;QAChB,MAAM,CAAC,QAAQ,CAAC,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEP,OAAO,MAAM,CAAC;AAClB,CAAC;AAtBD,sCAsBC;AAED,gBAAgB;AAEhB;;;;GAIG;AACH,SAAS,cAAc;IACnB,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC;IAErD,MAAM,KAAK,GAAG,MAAM;SACf,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAE,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;SACxD,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,uBAAuB,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAE,KAAK,CAAC,YAAY,CAAC,CAAC;IAE7F,MAAM,MAAM,GAAG,KAAK,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,CAAC;IAEhF,OAAO;QACH,IAAI,EAAE,MAAM,CAAC,QAAQ;QACrB,IAAI,EAAE,MAAM,CAAC,UAAU;QACvB,MAAM,EAAE,MAAM,CAAC,YAAY;KAC9B,CAAC;AACN,CAAC;AAED;;;;GAIG;AACH,SAAS,iBAAiB,CAAC,QAAgB;IACvC,OAAO,CAAE,CAAC,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;AACvF,CAAC"}
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@serenity-js/jasmine",
3
- "version": "3.25.0",
4
- "description": "Serenity/JS adapter for the Jasmine test runner",
3
+ "version": "3.25.2",
4
+ "description": "Serenity/JS test runner adapter for Jasmine, enabling the use of the Screenplay Pattern in Jasmine-based test suites and leveraging Serenity/JS reporting capabilities",
5
5
  "author": {
6
6
  "name": "Jan Molak",
7
7
  "email": "jan.molak@smartcodeltd.co.uk",
@@ -69,7 +69,7 @@
69
69
  "node": "^16.13 || ^18.12 || ^20"
70
70
  },
71
71
  "dependencies": {
72
- "@serenity-js/core": "3.25.0"
72
+ "@serenity-js/core": "3.25.2"
73
73
  },
74
74
  "peerDependencies": {
75
75
  "jasmine": "^5.1.0"
@@ -83,5 +83,5 @@
83
83
  "mocha": "10.6.0",
84
84
  "mocha-multi": "1.1.7"
85
85
  },
86
- "gitHead": "22657b685b6002f75b2569db54f4bea31ab91d12"
86
+ "gitHead": "98b68da1e04a8fcbb255dca509b7bc9c322a3b6b"
87
87
  }
@@ -11,10 +11,10 @@ import type { JasmineConfig } from './JasmineConfig.js';
11
11
 
12
12
  /**
13
13
  * Allows for programmatic execution of Jasmine test scenarios,
14
- * using {@apilink SerenityReporterForJasmine} to report progress.
14
+ * using [`SerenityReporterForJasmine`](https://serenity-js.org/api/jasmine/function/default/) to report progress.
15
15
  *
16
16
  * ## Learn more
17
- * - {@apilink TestRunnerAdapter}
17
+ * - [`TestRunnerAdapter`](https://serenity-js.org/api/core-adapter/interface/TestRunnerAdapter/)
18
18
  *
19
19
  * @group Integration
20
20
  */
@@ -1,9 +1,7 @@
1
1
  import type { SpecFilter } from './SpecFilter.js';
2
2
 
3
3
  /**
4
- * @desc
5
- * https://github.com/jasmine/jasmine-npm/blob/641c33d4765efb0486f68980a8b7d184dd797122/lib/filters/console_spec_filter.js
6
- *
4
+ * @see https://github.com/jasmine/jasmine-npm/blob/641c33d4765efb0486f68980a8b7d184dd797122/lib/filters/console_spec_filter.js
7
5
  * @package
8
6
  */
9
7
  export class GrepSpecFilter implements SpecFilter {
package/src/bootstrap.ts CHANGED
@@ -6,7 +6,7 @@ import { SerenityReporterForJasmine } from './SerenityReporterForJasmine.js';
6
6
 
7
7
  /**
8
8
  * Monkey-patches Jasmine's Suite and Spec so that they provide more accurate information,
9
- * and returns a bootstrapped instance of the {@apilink SerenityReporterForJasmine} to be registered with Jasmine.
9
+ * and returns a bootstrapped instance of the [`SerenityReporterForJasmine`](https://serenity-js.org/api/jasmine/function/default/) to be registered with Jasmine.
10
10
  *
11
11
  * ## Registering the reporter from the command line
12
12
  *
@@ -22,13 +22,9 @@ import { SerenityReporterForJasmine } from './SerenityReporterForJasmine.js';
22
22
  * jasmine.getEnv().addReporter(serenityReporterForJasmine);
23
23
  * ```
24
24
  *
25
- * @see {@apilink monkeyPatched}
26
- * @see {@apilink SerenityReporterForJasmine}
27
- *
28
- * @param {SerenityReporterForJasmineConfig} config
29
- * @param {jasmine} jasmine - the global.jasmine instance
30
- *
31
- * @returns {SerenityReporterForJasmine}
25
+ * @param config
26
+ * @param jasmine
27
+ * the global.jasmine instance
32
28
  */
33
29
  export function bootstrap(config: SerenityReporterForJasmineConfig = {}, jasmine = (global as any).jasmine): SerenityReporterForJasmine {
34
30
  const wrappers = {
@@ -2,11 +2,11 @@ import type { Expectation } from './Expectation.js';
2
2
  import type { Order } from './Order.js';
3
3
 
4
4
  /**
5
- * @desc
6
- * Information passed to the Reporter#jasmineDone event.
5
+ * Information passed to the Reporter#jasmineDone event.
7
6
  *
8
- * @package
9
7
  * @see https://jasmine.github.io/api/edge/global.html#JasmineDoneInfo
8
+ *
9
+ * @package
10
10
  */
11
11
  export interface JasmineDoneInfo {
12
12
 
@@ -4,83 +4,56 @@ import type { SpecResult } from './SpecResult.js';
4
4
  import type { SuiteResult } from './SuiteResult.js';
5
5
 
6
6
  /**
7
- * @desc
8
- * An interface representing an instance of a Jasmine Reporter object
7
+ * An interface representing an instance of a Jasmine Reporter object
9
8
  *
10
9
  * @see https://jasmine.github.io/api/edge/Reporter.html
11
- * @interface
12
10
  */
13
11
  export interface JasmineReporter {
14
12
 
15
13
  /**
16
- * @desc
17
- * Called after all of the specs have been loaded, but just before execution starts.
14
+ * Called after all of the specs have been loaded, but just before execution starts.
18
15
  *
19
16
  * @see https://jasmine.github.io/api/edge/Reporter.html#jasmineStarted
20
- *
21
- * @type {function(suiteInfo: JasmineStartedInfo): Promise<void> | void}
22
- * @public
23
17
  */
24
18
  jasmineStarted?: (suiteInfo: JasmineStartedInfo) => Promise<void> | void;
25
19
 
26
20
  /**
27
- * @desc
28
- * Invoked when an `it` starts to run (including associated `beforeEach` functions)
21
+ * Invoked when an `it` starts to run (including associated `beforeEach` functions)
29
22
  *
30
23
  * @see https://jasmine.github.io/api/edge/Reporter.html#specStarted
31
- *
32
- * @type {function(result: SpecResult): Promise<void> | void}
33
- * @public
34
24
  */
35
25
  specStarted?: (result: SpecResult) => Promise<void> | void;
36
26
 
37
27
  /**
38
- * @desc
39
- * Invoked when an `it` and its associated `beforeEach` and `afterEach` functions have been run.
28
+ * Invoked when an `it` and its associated `beforeEach` and `afterEach` functions have been run.
40
29
  *
41
- * While Jasmine doesn't require any specific functions, not defining a `specDone`
42
- * will make it impossible for a reporter to know when a spec has failed.
30
+ * While Jasmine doesn't require any specific functions, not defining a `specDone`
31
+ * will make it impossible for a reporter to know when a spec has failed.
43
32
  *
44
33
  * @see https://jasmine.github.io/api/edge/Reporter.html#specDone
45
- *
46
- * @type {function(result: SpecResult): Promise<void> | void}
47
- * @public
48
34
  */
49
35
  specDone?: (result: SpecResult) => Promise<void> | void;
50
36
 
51
37
  /**
52
- * @desc
53
- * Invoked when a `describe` starts to run.
38
+ * Invoked when a `describe` starts to run.
54
39
  *
55
40
  * @see https://jasmine.github.io/api/edge/Reporter.html#suiteStarted
56
- *
57
- * @type {function(result: SuiteResult): Promise<void> | void}
58
- * @public
59
41
  */
60
42
  suiteStarted?: (result: SuiteResult) => Promise<void> | void;
61
43
 
62
44
  /**
63
- * @desc
64
- * Invoked when all of the child specs and suites for a given suite have been run.
65
- *
66
- * While Jasmine doesn't require any specific functions, not defining a `suiteDone`
67
- * will make it impossible for a reporter to know when a suite has failures in an `afterAll`.
45
+ * Invoked when all the child specs and suites for a given suite have been run.
46
+ * While Jasmine doesn't require any specific functions, not defining a `suiteDone`
47
+ * will make it impossible for a reporter to know when a suite has failures in an `afterAll`.
68
48
  *
69
49
  * @see https://jasmine.github.io/api/edge/Reporter.html#suiteDone
70
- *
71
- * @type {function(result: SuiteResult): Promise<void> | void}
72
- * @public
73
50
  */
74
51
  suiteDone?: (result: SuiteResult) => Promise<void> | void;
75
52
 
76
53
  /**
77
- * @desc
78
- * Called when the entire suite has finished execution.
54
+ * Called when the entire suite has finished execution.
79
55
  *
80
56
  * @see https://jasmine.github.io/api/edge/Reporter.html#jasmineDone
81
- *
82
- * @type {function(suiteInfo: JasmineDoneInfo): Promise<void> | void}
83
- * @public
84
57
  */
85
58
  jasmineDone?: (suiteInfo: JasmineDoneInfo) => Promise<void> | void;
86
59
  }
@@ -1,11 +1,11 @@
1
1
  import type { Order } from './Order.js';
2
2
 
3
3
  /**
4
- * @desc
5
- * Information passed to the Reporter#jasmineStarted event.
4
+ * Information passed to the Reporter#jasmineStarted event.
6
5
  *
7
- * @package
8
6
  * @see https://jasmine.github.io/api/edge/global.html#JasmineStartedInfo
7
+ *
8
+ * @package
9
9
  */
10
10
  export interface JasmineStartedInfo {
11
11
 
@@ -1,6 +1,5 @@
1
1
  /**
2
- * @desc
3
- * A Serenity/JS-specific customisation - the file system location of the caller of a given `it` and `describe` function.
2
+ * A Serenity/JS-specific customisation - the file system location of the caller of a given `it` and `describe` function.
4
3
  *
5
4
  * @package
6
5
  */
@@ -1,6 +1,5 @@
1
1
  /**
2
- * @desc
3
- * Information about the ordering (random or not) of this execution of the suite.
2
+ * Information about the ordering (random or not) of this execution of the suite.
4
3
  *
5
4
  * @package
6
5
  */
@@ -5,11 +5,10 @@ const parser = new ErrorStackParser();
5
5
  /* eslint-disable @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/ban-types */
6
6
 
7
7
  /**
8
- * @desc
9
- * Monkey-patches Jasmine domain model constructors so that they
10
- * record information about the file system location of the caller function.
8
+ * Monkey-patches Jasmine domain model constructors so that they
9
+ * record information about the file system location of the caller function.
11
10
  *
12
- * This helps to make reporting more accurate.
11
+ * This helps to make reporting more accurate.
13
12
  *
14
13
  * @param jasmineConstructor - A Jasmine constructor function to be patched
15
14
  * @param {object} wrappers - Attributes to wrap when the monkey-patched Jasmine constructor is invoked
@@ -41,8 +40,7 @@ export function monkeyPatched(
41
40
  // eslint-enable
42
41
 
43
42
  /**
44
- * @desc
45
- * Retrieves the file system location of the caller function.
43
+ * Retrieves the file system location of the caller function.
46
44
  *
47
45
  * @package
48
46
  */
@@ -63,10 +61,7 @@ function callerLocation() {
63
61
  }
64
62
 
65
63
  /**
66
- * @desc
67
- * Checks if a given property is likely to be a static method or a static field on the constructor function.
68
- *
69
- * @param {string} property - name of the property to be checked
64
+ * Checks if a given property is likely to be a static method or a static field on the constructor function.
70
65
  *
71
66
  * @package
72
67
  */