@serenity-js/core 3.0.0-rc.9 → 3.0.1

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 (1041) hide show
  1. package/CHANGELOG.md +208 -2139
  2. package/README.md +8 -10
  3. package/lib/Serenity.d.ts +145 -80
  4. package/lib/Serenity.d.ts.map +1 -0
  5. package/lib/Serenity.js +159 -86
  6. package/lib/Serenity.js.map +1 -1
  7. package/lib/adapter/OutputStream.d.ts +14 -0
  8. package/lib/adapter/OutputStream.d.ts.map +1 -0
  9. package/lib/{io → adapter}/OutputStream.js.map +1 -1
  10. package/lib/adapter/TestRunnerAdapter.d.ts +33 -0
  11. package/lib/adapter/TestRunnerAdapter.d.ts.map +1 -0
  12. package/lib/adapter/TestRunnerAdapter.js.map +1 -0
  13. package/lib/adapter/index.d.ts +3 -0
  14. package/lib/adapter/index.d.ts.map +1 -0
  15. package/lib/adapter/index.js +19 -0
  16. package/lib/adapter/index.js.map +1 -0
  17. package/lib/config/ClassDescription.d.ts +60 -0
  18. package/lib/config/ClassDescription.d.ts.map +1 -0
  19. package/lib/config/ClassDescription.js +3 -0
  20. package/lib/config/ClassDescription.js.map +1 -0
  21. package/lib/config/SerenityConfig.d.ts +73 -0
  22. package/lib/config/SerenityConfig.d.ts.map +1 -0
  23. package/lib/config/SerenityConfig.js +20 -0
  24. package/lib/config/SerenityConfig.js.map +1 -0
  25. package/lib/config/index.d.ts +3 -0
  26. package/lib/config/index.d.ts.map +1 -0
  27. package/lib/config/index.js +19 -0
  28. package/lib/config/index.js.map +1 -0
  29. package/lib/errors/ErrorFactory.d.ts +16 -0
  30. package/lib/errors/ErrorFactory.d.ts.map +1 -0
  31. package/lib/errors/ErrorFactory.js +241 -0
  32. package/lib/errors/ErrorFactory.js.map +1 -0
  33. package/lib/errors/ErrorOptions.d.ts +16 -0
  34. package/lib/errors/ErrorOptions.d.ts.map +1 -0
  35. package/lib/errors/ErrorOptions.js +3 -0
  36. package/lib/errors/ErrorOptions.js.map +1 -0
  37. package/lib/errors/ErrorSerialiser.d.ts +14 -0
  38. package/lib/errors/ErrorSerialiser.d.ts.map +1 -0
  39. package/lib/{io → errors}/ErrorSerialiser.js +33 -7
  40. package/lib/errors/ErrorSerialiser.js.map +1 -0
  41. package/lib/errors/ErrorStackParser.d.ts +13 -0
  42. package/lib/errors/ErrorStackParser.d.ts.map +1 -0
  43. package/lib/errors/ErrorStackParser.js +42 -0
  44. package/lib/errors/ErrorStackParser.js.map +1 -0
  45. package/lib/errors/RaiseErrors.d.ts +57 -0
  46. package/lib/errors/RaiseErrors.d.ts.map +1 -0
  47. package/lib/errors/RaiseErrors.js +62 -0
  48. package/lib/errors/RaiseErrors.js.map +1 -0
  49. package/lib/errors/diff/AnsiDiffFormatter.d.ts +28 -0
  50. package/lib/errors/diff/AnsiDiffFormatter.d.ts.map +1 -0
  51. package/lib/errors/diff/AnsiDiffFormatter.js +38 -0
  52. package/lib/errors/diff/AnsiDiffFormatter.js.map +1 -0
  53. package/lib/errors/diff/DiffFormatter.d.ts +13 -0
  54. package/lib/errors/diff/DiffFormatter.d.ts.map +1 -0
  55. package/lib/errors/diff/DiffFormatter.js +3 -0
  56. package/lib/errors/diff/DiffFormatter.js.map +1 -0
  57. package/lib/errors/diff/NoOpDiffFormatter.d.ts +12 -0
  58. package/lib/errors/diff/NoOpDiffFormatter.d.ts.map +1 -0
  59. package/lib/errors/diff/NoOpDiffFormatter.js +21 -0
  60. package/lib/errors/diff/NoOpDiffFormatter.js.map +1 -0
  61. package/lib/errors/diff/index.d.ts +4 -0
  62. package/lib/errors/diff/index.d.ts.map +1 -0
  63. package/lib/errors/diff/index.js +20 -0
  64. package/lib/errors/diff/index.js.map +1 -0
  65. package/lib/errors/index.d.ts +8 -7
  66. package/lib/errors/index.d.ts.map +1 -0
  67. package/lib/errors/index.js +23 -8
  68. package/lib/errors/index.js.map +1 -1
  69. package/lib/errors/model/AssertionError.d.ts +16 -0
  70. package/lib/errors/model/AssertionError.d.ts.map +1 -0
  71. package/lib/errors/model/AssertionError.js +26 -0
  72. package/lib/errors/model/AssertionError.js.map +1 -0
  73. package/lib/errors/model/ConfigurationError.d.ts +16 -0
  74. package/lib/errors/model/ConfigurationError.d.ts.map +1 -0
  75. package/lib/errors/model/ConfigurationError.js +26 -0
  76. package/lib/errors/model/ConfigurationError.js.map +1 -0
  77. package/lib/errors/model/ImplementationPendingError.d.ts +37 -0
  78. package/lib/errors/model/ImplementationPendingError.d.ts.map +1 -0
  79. package/lib/errors/model/ImplementationPendingError.js +47 -0
  80. package/lib/errors/model/ImplementationPendingError.js.map +1 -0
  81. package/lib/errors/model/ListItemNotFoundError.d.ts +20 -0
  82. package/lib/errors/model/ListItemNotFoundError.d.ts.map +1 -0
  83. package/lib/errors/model/ListItemNotFoundError.js +30 -0
  84. package/lib/errors/model/ListItemNotFoundError.js.map +1 -0
  85. package/lib/errors/model/LogicError.d.ts +20 -0
  86. package/lib/errors/model/LogicError.d.ts.map +1 -0
  87. package/lib/errors/model/LogicError.js +30 -0
  88. package/lib/errors/model/LogicError.js.map +1 -0
  89. package/lib/errors/model/OperationInterruptedError.d.ts +20 -0
  90. package/lib/errors/model/OperationInterruptedError.d.ts.map +1 -0
  91. package/lib/errors/model/OperationInterruptedError.js +30 -0
  92. package/lib/errors/model/OperationInterruptedError.js.map +1 -0
  93. package/lib/errors/model/RuntimeError.d.ts +80 -0
  94. package/lib/errors/model/RuntimeError.d.ts.map +1 -0
  95. package/lib/errors/model/RuntimeError.js +97 -0
  96. package/lib/errors/model/RuntimeError.js.map +1 -0
  97. package/lib/errors/model/TestCompromisedError.d.ts +31 -0
  98. package/lib/errors/model/TestCompromisedError.d.ts.map +1 -0
  99. package/lib/errors/model/TestCompromisedError.js +41 -0
  100. package/lib/errors/model/TestCompromisedError.js.map +1 -0
  101. package/lib/errors/model/TimeoutExpiredError.d.ts +20 -0
  102. package/lib/errors/model/TimeoutExpiredError.d.ts.map +1 -0
  103. package/lib/errors/model/TimeoutExpiredError.js +30 -0
  104. package/lib/errors/model/TimeoutExpiredError.js.map +1 -0
  105. package/lib/errors/model/UnknownError.d.ts +16 -0
  106. package/lib/errors/model/UnknownError.d.ts.map +1 -0
  107. package/lib/errors/model/UnknownError.js +26 -0
  108. package/lib/errors/model/UnknownError.js.map +1 -0
  109. package/lib/errors/model/index.d.ts +11 -0
  110. package/lib/errors/model/index.d.ts.map +1 -0
  111. package/lib/errors/model/index.js +27 -0
  112. package/lib/errors/model/index.js.map +1 -0
  113. package/lib/events/ActivityFinished.d.ts +5 -5
  114. package/lib/events/ActivityFinished.d.ts.map +1 -0
  115. package/lib/events/ActivityFinished.js +2 -4
  116. package/lib/events/ActivityFinished.js.map +1 -1
  117. package/lib/events/ActivityRelatedArtifactArchived.d.ts +6 -1
  118. package/lib/events/ActivityRelatedArtifactArchived.d.ts.map +1 -0
  119. package/lib/events/ActivityRelatedArtifactArchived.js +7 -3
  120. package/lib/events/ActivityRelatedArtifactArchived.js.map +1 -1
  121. package/lib/events/ActivityRelatedArtifactGenerated.d.ts +6 -1
  122. package/lib/events/ActivityRelatedArtifactGenerated.d.ts.map +1 -0
  123. package/lib/events/ActivityRelatedArtifactGenerated.js +7 -3
  124. package/lib/events/ActivityRelatedArtifactGenerated.js.map +1 -1
  125. package/lib/events/ActivityStarts.d.ts +5 -5
  126. package/lib/events/ActivityStarts.d.ts.map +1 -0
  127. package/lib/events/ActivityStarts.js +2 -4
  128. package/lib/events/ActivityStarts.js.map +1 -1
  129. package/lib/events/ArtifactArchived.d.ts +6 -1
  130. package/lib/events/ArtifactArchived.d.ts.map +1 -0
  131. package/lib/events/ArtifactArchived.js +7 -3
  132. package/lib/events/ArtifactArchived.js.map +1 -1
  133. package/lib/events/ArtifactGenerated.d.ts +6 -1
  134. package/lib/events/ArtifactGenerated.d.ts.map +1 -0
  135. package/lib/events/ArtifactGenerated.js +7 -3
  136. package/lib/events/ArtifactGenerated.js.map +1 -1
  137. package/lib/events/AsyncOperationAborted.d.ts +14 -0
  138. package/lib/events/AsyncOperationAborted.d.ts.map +1 -0
  139. package/lib/events/AsyncOperationAborted.js +24 -0
  140. package/lib/events/AsyncOperationAborted.js.map +1 -0
  141. package/lib/events/AsyncOperationAttempted.d.ts +9 -3
  142. package/lib/events/AsyncOperationAttempted.d.ts.map +1 -0
  143. package/lib/events/AsyncOperationAttempted.js +12 -6
  144. package/lib/events/AsyncOperationAttempted.js.map +1 -1
  145. package/lib/events/AsyncOperationCompleted.d.ts +7 -3
  146. package/lib/events/AsyncOperationCompleted.d.ts.map +1 -0
  147. package/lib/events/AsyncOperationCompleted.js +8 -6
  148. package/lib/events/AsyncOperationCompleted.js.map +1 -1
  149. package/lib/events/AsyncOperationFailed.d.ts +6 -1
  150. package/lib/events/AsyncOperationFailed.d.ts.map +1 -0
  151. package/lib/events/AsyncOperationFailed.js +9 -5
  152. package/lib/events/AsyncOperationFailed.js.map +1 -1
  153. package/lib/events/BusinessRuleDetected.d.ts +6 -5
  154. package/lib/events/BusinessRuleDetected.d.ts.map +1 -0
  155. package/lib/events/BusinessRuleDetected.js +7 -7
  156. package/lib/events/BusinessRuleDetected.js.map +1 -1
  157. package/lib/events/DomainEvent.d.ts +5 -7
  158. package/lib/events/DomainEvent.d.ts.map +1 -0
  159. package/lib/events/DomainEvent.js +5 -8
  160. package/lib/events/DomainEvent.js.map +1 -1
  161. package/lib/events/FeatureNarrativeDetected.d.ts +6 -1
  162. package/lib/events/FeatureNarrativeDetected.d.ts.map +1 -0
  163. package/lib/events/FeatureNarrativeDetected.js +7 -3
  164. package/lib/events/FeatureNarrativeDetected.js.map +1 -1
  165. package/lib/events/InteractionFinished.d.ts +4 -0
  166. package/lib/events/InteractionFinished.d.ts.map +1 -0
  167. package/lib/events/InteractionFinished.js +5 -1
  168. package/lib/events/InteractionFinished.js.map +1 -1
  169. package/lib/events/InteractionStarts.d.ts +4 -0
  170. package/lib/events/InteractionStarts.d.ts.map +1 -0
  171. package/lib/events/InteractionStarts.js +5 -1
  172. package/lib/events/InteractionStarts.js.map +1 -1
  173. package/lib/events/RetryableSceneDetected.d.ts +9 -10
  174. package/lib/events/RetryableSceneDetected.d.ts.map +1 -0
  175. package/lib/events/RetryableSceneDetected.js +13 -15
  176. package/lib/events/RetryableSceneDetected.js.map +1 -1
  177. package/lib/events/SceneBackgroundDetected.d.ts +6 -1
  178. package/lib/events/SceneBackgroundDetected.d.ts.map +1 -0
  179. package/lib/events/SceneBackgroundDetected.js +8 -5
  180. package/lib/events/SceneBackgroundDetected.js.map +1 -1
  181. package/lib/events/SceneDescriptionDetected.d.ts +6 -1
  182. package/lib/events/SceneDescriptionDetected.d.ts.map +1 -0
  183. package/lib/events/SceneDescriptionDetected.js +7 -3
  184. package/lib/events/SceneDescriptionDetected.js.map +1 -1
  185. package/lib/events/SceneFinished.d.ts +6 -1
  186. package/lib/events/SceneFinished.d.ts.map +1 -0
  187. package/lib/events/SceneFinished.js +7 -3
  188. package/lib/events/SceneFinished.js.map +1 -1
  189. package/lib/events/SceneFinishes.d.ts +10 -4
  190. package/lib/events/SceneFinishes.d.ts.map +1 -0
  191. package/lib/events/SceneFinishes.js +11 -8
  192. package/lib/events/SceneFinishes.js.map +1 -1
  193. package/lib/events/SceneParametersDetected.d.ts +6 -1
  194. package/lib/events/SceneParametersDetected.d.ts.map +1 -0
  195. package/lib/events/SceneParametersDetected.js +7 -3
  196. package/lib/events/SceneParametersDetected.js.map +1 -1
  197. package/lib/events/SceneSequenceDetected.d.ts +6 -1
  198. package/lib/events/SceneSequenceDetected.d.ts.map +1 -0
  199. package/lib/events/SceneSequenceDetected.js +7 -3
  200. package/lib/events/SceneSequenceDetected.js.map +1 -1
  201. package/lib/events/SceneStarts.d.ts +6 -1
  202. package/lib/events/SceneStarts.d.ts.map +1 -0
  203. package/lib/events/SceneStarts.js +7 -3
  204. package/lib/events/SceneStarts.js.map +1 -1
  205. package/lib/events/SceneTagged.d.ts +6 -1
  206. package/lib/events/SceneTagged.d.ts.map +1 -0
  207. package/lib/events/SceneTagged.js +7 -3
  208. package/lib/events/SceneTagged.js.map +1 -1
  209. package/lib/events/SceneTemplateDetected.d.ts +6 -1
  210. package/lib/events/SceneTemplateDetected.d.ts.map +1 -0
  211. package/lib/events/SceneTemplateDetected.js +7 -3
  212. package/lib/events/SceneTemplateDetected.js.map +1 -1
  213. package/lib/events/TaskFinished.d.ts +4 -0
  214. package/lib/events/TaskFinished.d.ts.map +1 -0
  215. package/lib/events/TaskFinished.js +5 -1
  216. package/lib/events/TaskFinished.js.map +1 -1
  217. package/lib/events/TaskStarts.d.ts +4 -0
  218. package/lib/events/TaskStarts.d.ts.map +1 -0
  219. package/lib/events/TaskStarts.js +5 -1
  220. package/lib/events/TaskStarts.js.map +1 -1
  221. package/lib/events/TestRunFinished.d.ts +10 -5
  222. package/lib/events/TestRunFinished.d.ts.map +1 -0
  223. package/lib/events/TestRunFinished.js +8 -5
  224. package/lib/events/TestRunFinished.js.map +1 -1
  225. package/lib/events/TestRunFinishes.d.ts +6 -4
  226. package/lib/events/TestRunFinishes.d.ts.map +1 -0
  227. package/lib/events/TestRunFinishes.js +6 -5
  228. package/lib/events/TestRunFinishes.js.map +1 -1
  229. package/lib/events/TestRunStarts.d.ts +4 -4
  230. package/lib/events/TestRunStarts.d.ts.map +1 -0
  231. package/lib/events/TestRunStarts.js +4 -5
  232. package/lib/events/TestRunStarts.js.map +1 -1
  233. package/lib/events/TestRunnerDetected.d.ts +6 -2
  234. package/lib/events/TestRunnerDetected.d.ts.map +1 -0
  235. package/lib/events/TestRunnerDetected.js +9 -7
  236. package/lib/events/TestRunnerDetected.js.map +1 -1
  237. package/lib/events/TestSuiteFinished.d.ts +6 -1
  238. package/lib/events/TestSuiteFinished.d.ts.map +1 -0
  239. package/lib/events/TestSuiteFinished.js +7 -3
  240. package/lib/events/TestSuiteFinished.js.map +1 -1
  241. package/lib/events/TestSuiteStarts.d.ts +6 -1
  242. package/lib/events/TestSuiteStarts.d.ts.map +1 -0
  243. package/lib/events/TestSuiteStarts.js +7 -3
  244. package/lib/events/TestSuiteStarts.js.map +1 -1
  245. package/lib/events/index.d.ts +2 -0
  246. package/lib/events/index.d.ts.map +1 -0
  247. package/lib/events/index.js +6 -1
  248. package/lib/events/index.js.map +1 -1
  249. package/lib/index.d.ts +2 -2
  250. package/lib/index.d.ts.map +1 -0
  251. package/lib/index.js +7 -7
  252. package/lib/index.js.map +1 -1
  253. package/lib/instance.d.ts +180 -90
  254. package/lib/instance.d.ts.map +1 -0
  255. package/lib/instance.js +179 -90
  256. package/lib/instance.js.map +1 -1
  257. package/lib/io/Config.d.ts +2 -1
  258. package/lib/io/Config.d.ts.map +1 -0
  259. package/lib/io/FileFinder.d.ts +1 -0
  260. package/lib/io/FileFinder.d.ts.map +1 -0
  261. package/lib/io/FileFinder.js +5 -2
  262. package/lib/io/FileFinder.js.map +1 -1
  263. package/lib/io/FileSystem.d.ts +3 -0
  264. package/lib/io/FileSystem.d.ts.map +1 -0
  265. package/lib/io/FileSystem.js +30 -4
  266. package/lib/io/FileSystem.js.map +1 -1
  267. package/lib/io/FileSystemLocation.d.ts +1 -0
  268. package/lib/io/FileSystemLocation.d.ts.map +1 -0
  269. package/lib/io/FileSystemLocation.js +3 -3
  270. package/lib/io/FileSystemLocation.js.map +1 -1
  271. package/lib/io/Path.d.ts +2 -0
  272. package/lib/io/Path.d.ts.map +1 -0
  273. package/lib/io/Path.js +22 -16
  274. package/lib/io/Path.js.map +1 -1
  275. package/lib/io/asyncMap.d.ts +4 -4
  276. package/lib/io/asyncMap.d.ts.map +1 -0
  277. package/lib/io/asyncMap.js +5 -5
  278. package/lib/io/asyncMap.js.map +1 -1
  279. package/lib/io/commaSeparated.d.ts +6 -6
  280. package/lib/io/commaSeparated.d.ts.map +1 -0
  281. package/lib/io/commaSeparated.js +8 -9
  282. package/lib/io/commaSeparated.js.map +1 -1
  283. package/lib/io/format.d.ts +46 -19
  284. package/lib/io/format.d.ts.map +1 -0
  285. package/lib/io/format.js +48 -22
  286. package/lib/io/format.js.map +1 -1
  287. package/lib/io/index.d.ts +4 -9
  288. package/lib/io/index.d.ts.map +1 -0
  289. package/lib/io/index.js +8 -10
  290. package/lib/io/index.js.map +1 -1
  291. package/lib/io/inspected.d.ts +4 -19
  292. package/lib/io/inspected.d.ts.map +1 -0
  293. package/lib/io/inspected.js +11 -222
  294. package/lib/io/inspected.js.map +1 -1
  295. package/lib/io/inspectedObject.d.ts +4 -0
  296. package/lib/io/inspectedObject.d.ts.map +1 -0
  297. package/lib/io/inspectedObject.js +55 -0
  298. package/lib/io/inspectedObject.js.map +1 -0
  299. package/lib/io/loader/ClassDescriptionParser.d.ts +8 -0
  300. package/lib/io/loader/ClassDescriptionParser.d.ts.map +1 -0
  301. package/lib/io/loader/ClassDescriptionParser.js +52 -0
  302. package/lib/io/loader/ClassDescriptionParser.js.map +1 -0
  303. package/lib/io/loader/ClassDescriptor.d.ts +7 -0
  304. package/lib/io/loader/ClassDescriptor.d.ts.map +1 -0
  305. package/lib/io/loader/ClassDescriptor.js +3 -0
  306. package/lib/io/loader/ClassDescriptor.js.map +1 -0
  307. package/lib/io/loader/ClassLoader.d.ts +11 -0
  308. package/lib/io/loader/ClassLoader.d.ts.map +1 -0
  309. package/lib/io/loader/ClassLoader.js +34 -0
  310. package/lib/io/loader/ClassLoader.js.map +1 -0
  311. package/lib/io/{ModuleLoader.d.ts → loader/ModuleLoader.d.ts} +11 -18
  312. package/lib/io/loader/ModuleLoader.d.ts.map +1 -0
  313. package/lib/io/loader/ModuleLoader.js +96 -0
  314. package/lib/io/loader/ModuleLoader.js.map +1 -0
  315. package/lib/io/{Version.d.ts → loader/Version.d.ts} +2 -4
  316. package/lib/io/loader/Version.d.ts.map +1 -0
  317. package/lib/io/{Version.js → loader/Version.js} +14 -14
  318. package/lib/io/loader/Version.js.map +1 -0
  319. package/lib/io/loader/index.d.ts +6 -0
  320. package/lib/io/loader/index.d.ts.map +1 -0
  321. package/lib/io/loader/index.js +22 -0
  322. package/lib/io/loader/index.js.map +1 -0
  323. package/lib/io/proxies.d.ts +1 -0
  324. package/lib/io/proxies.d.ts.map +1 -0
  325. package/lib/io/reflection/has.d.ts +4 -5
  326. package/lib/io/reflection/has.d.ts.map +1 -0
  327. package/lib/io/reflection/has.js +3 -5
  328. package/lib/io/reflection/has.js.map +1 -1
  329. package/lib/io/reflection/index.d.ts +3 -0
  330. package/lib/io/reflection/index.d.ts.map +1 -0
  331. package/lib/io/reflection/index.js +7 -1
  332. package/lib/io/reflection/index.js.map +1 -1
  333. package/lib/io/reflection/isPrimitive.d.ts +8 -0
  334. package/lib/io/reflection/isPrimitive.d.ts.map +1 -0
  335. package/lib/io/reflection/isPrimitive.js +24 -0
  336. package/lib/io/reflection/isPrimitive.js.map +1 -0
  337. package/lib/io/reflection/typeOf.d.ts +7 -0
  338. package/lib/io/reflection/typeOf.d.ts.map +1 -0
  339. package/lib/io/reflection/typeOf.js +35 -0
  340. package/lib/io/reflection/typeOf.js.map +1 -0
  341. package/lib/io/stringified.d.ts +24 -0
  342. package/lib/io/stringified.d.ts.map +1 -0
  343. package/lib/io/stringified.js +220 -0
  344. package/lib/io/stringified.js.map +1 -0
  345. package/lib/io/trimmed.d.ts +6 -7
  346. package/lib/io/trimmed.d.ts.map +1 -0
  347. package/lib/io/trimmed.js +6 -8
  348. package/lib/io/trimmed.js.map +1 -1
  349. package/lib/model/ActivityDetails.d.ts +9 -1
  350. package/lib/model/ActivityDetails.d.ts.map +1 -0
  351. package/lib/model/ActivityDetails.js +9 -4
  352. package/lib/model/ActivityDetails.js.map +1 -1
  353. package/lib/model/Artifact.d.ts +2 -1
  354. package/lib/model/Artifact.d.ts.map +1 -0
  355. package/lib/model/Artifact.js +29 -6
  356. package/lib/model/Artifact.js.map +1 -1
  357. package/lib/model/BusinessRule.d.ts +1 -0
  358. package/lib/model/BusinessRule.d.ts.map +1 -0
  359. package/lib/model/BusinessRule.js +3 -3
  360. package/lib/model/BusinessRule.js.map +1 -1
  361. package/lib/model/Category.d.ts +1 -0
  362. package/lib/model/Category.d.ts.map +1 -0
  363. package/lib/model/Category.js +3 -3
  364. package/lib/model/Category.js.map +1 -1
  365. package/lib/model/CorrelationId.d.ts +1 -0
  366. package/lib/model/CorrelationId.d.ts.map +1 -0
  367. package/lib/model/CorrelationId.js +5 -2
  368. package/lib/model/CorrelationId.js.map +1 -1
  369. package/lib/model/Description.d.ts +1 -0
  370. package/lib/model/Description.d.ts.map +1 -0
  371. package/lib/model/Description.js +3 -3
  372. package/lib/model/Description.js.map +1 -1
  373. package/lib/model/Name.d.ts +1 -0
  374. package/lib/model/Name.d.ts.map +1 -0
  375. package/lib/model/Name.js +3 -3
  376. package/lib/model/Name.js.map +1 -1
  377. package/lib/model/ScenarioDetails.d.ts +1 -0
  378. package/lib/model/ScenarioDetails.d.ts.map +1 -0
  379. package/lib/model/ScenarioDetails.js +6 -3
  380. package/lib/model/ScenarioDetails.js.map +1 -1
  381. package/lib/model/ScenarioParameters.d.ts +1 -0
  382. package/lib/model/ScenarioParameters.d.ts.map +1 -0
  383. package/lib/model/ScenarioParameters.js +3 -3
  384. package/lib/model/ScenarioParameters.js.map +1 -1
  385. package/lib/model/TestSuiteDetails.d.ts +1 -0
  386. package/lib/model/TestSuiteDetails.d.ts.map +1 -0
  387. package/lib/model/TestSuiteDetails.js +3 -3
  388. package/lib/model/TestSuiteDetails.js.map +1 -1
  389. package/lib/model/artifacts/HTTPRequestResponse.d.ts +6 -13
  390. package/lib/model/artifacts/HTTPRequestResponse.d.ts.map +1 -0
  391. package/lib/model/artifacts/HTTPRequestResponse.js +1 -4
  392. package/lib/model/artifacts/HTTPRequestResponse.js.map +1 -1
  393. package/lib/model/artifacts/JSONData.d.ts +1 -0
  394. package/lib/model/artifacts/JSONData.d.ts.map +1 -0
  395. package/lib/model/artifacts/LogEntry.d.ts +1 -0
  396. package/lib/model/artifacts/LogEntry.d.ts.map +1 -0
  397. package/lib/model/artifacts/Photo.d.ts +1 -8
  398. package/lib/model/artifacts/Photo.d.ts.map +1 -0
  399. package/lib/model/artifacts/Photo.js +0 -8
  400. package/lib/model/artifacts/Photo.js.map +1 -1
  401. package/lib/model/artifacts/TestReport.d.ts +1 -0
  402. package/lib/model/artifacts/TestReport.d.ts.map +1 -0
  403. package/lib/model/artifacts/TextData.d.ts +1 -0
  404. package/lib/model/artifacts/TextData.d.ts.map +1 -0
  405. package/lib/model/artifacts/index.d.ts +1 -1
  406. package/lib/model/artifacts/index.d.ts.map +1 -0
  407. package/lib/model/artifacts/index.js +5 -2
  408. package/lib/model/artifacts/index.js.map +1 -1
  409. package/lib/model/index.d.ts +1 -2
  410. package/lib/model/index.d.ts.map +1 -0
  411. package/lib/model/index.js +5 -3
  412. package/lib/model/index.js.map +1 -1
  413. package/lib/model/outcomes.d.ts +1 -0
  414. package/lib/model/outcomes.d.ts.map +1 -0
  415. package/lib/model/outcomes.js +7 -7
  416. package/lib/model/outcomes.js.map +1 -1
  417. package/lib/model/tags/ArbitraryTag.d.ts +3 -5
  418. package/lib/model/tags/ArbitraryTag.d.ts.map +1 -0
  419. package/lib/model/tags/ArbitraryTag.js +2 -5
  420. package/lib/model/tags/ArbitraryTag.js.map +1 -1
  421. package/lib/model/tags/BrowserTag.d.ts +1 -0
  422. package/lib/model/tags/BrowserTag.d.ts.map +1 -0
  423. package/lib/model/tags/BrowserTag.js +3 -3
  424. package/lib/model/tags/BrowserTag.js.map +1 -1
  425. package/lib/model/tags/CapabilityTag.d.ts +1 -0
  426. package/lib/model/tags/CapabilityTag.d.ts.map +1 -0
  427. package/lib/model/tags/ExecutionRetriedTag.d.ts +3 -5
  428. package/lib/model/tags/ExecutionRetriedTag.d.ts.map +1 -0
  429. package/lib/model/tags/ExecutionRetriedTag.js +5 -8
  430. package/lib/model/tags/ExecutionRetriedTag.js.map +1 -1
  431. package/lib/model/tags/FeatureTag.d.ts +1 -0
  432. package/lib/model/tags/FeatureTag.d.ts.map +1 -0
  433. package/lib/model/tags/IssueTag.d.ts +1 -0
  434. package/lib/model/tags/IssueTag.d.ts.map +1 -0
  435. package/lib/model/tags/ManualTag.d.ts +1 -0
  436. package/lib/model/tags/ManualTag.d.ts.map +1 -0
  437. package/lib/model/tags/PlatformTag.d.ts +1 -0
  438. package/lib/model/tags/PlatformTag.d.ts.map +1 -0
  439. package/lib/model/tags/PlatformTag.js +3 -3
  440. package/lib/model/tags/PlatformTag.js.map +1 -1
  441. package/lib/model/tags/Tag.d.ts +1 -0
  442. package/lib/model/tags/Tag.d.ts.map +1 -0
  443. package/lib/model/tags/Tag.js +31 -8
  444. package/lib/model/tags/Tag.js.map +1 -1
  445. package/lib/model/tags/Tags.d.ts +1 -0
  446. package/lib/model/tags/Tags.d.ts.map +1 -0
  447. package/lib/model/tags/ThemeTag.d.ts +1 -0
  448. package/lib/model/tags/ThemeTag.d.ts.map +1 -0
  449. package/lib/model/tags/index.d.ts +1 -1
  450. package/lib/model/tags/index.d.ts.map +1 -0
  451. package/lib/model/tags/index.js +5 -2
  452. package/lib/model/tags/index.js.map +1 -1
  453. package/lib/screenplay/Activity.d.ts +35 -19
  454. package/lib/screenplay/Activity.d.ts.map +1 -0
  455. package/lib/screenplay/Activity.js +74 -0
  456. package/lib/screenplay/Activity.js.map +1 -1
  457. package/lib/screenplay/Actor.d.ts +146 -0
  458. package/lib/screenplay/Actor.d.ts.map +1 -0
  459. package/lib/screenplay/Actor.js +283 -0
  460. package/lib/screenplay/Actor.js.map +1 -0
  461. package/lib/screenplay/Answerable.d.ts +5 -7
  462. package/lib/screenplay/Answerable.d.ts.map +1 -0
  463. package/lib/screenplay/Answered.d.ts +13 -0
  464. package/lib/screenplay/Answered.d.ts.map +1 -0
  465. package/lib/screenplay/{Ability.js → Answered.js} +1 -1
  466. package/lib/screenplay/Answered.js.map +1 -0
  467. package/lib/screenplay/Interaction.d.ts +81 -18
  468. package/lib/screenplay/Interaction.d.ts.map +1 -0
  469. package/lib/screenplay/Interaction.js +70 -28
  470. package/lib/screenplay/Interaction.js.map +1 -1
  471. package/lib/screenplay/Optional.d.ts +15 -18
  472. package/lib/screenplay/Optional.d.ts.map +1 -0
  473. package/lib/screenplay/Question.d.ts +201 -70
  474. package/lib/screenplay/Question.d.ts.map +1 -0
  475. package/lib/screenplay/Question.js +295 -75
  476. package/lib/screenplay/Question.js.map +1 -1
  477. package/lib/screenplay/RecursivelyAnswered.d.ts +40 -0
  478. package/lib/screenplay/RecursivelyAnswered.d.ts.map +1 -0
  479. package/lib/screenplay/RecursivelyAnswered.js +3 -0
  480. package/lib/screenplay/RecursivelyAnswered.js.map +1 -0
  481. package/lib/screenplay/Task.d.ts +180 -40
  482. package/lib/screenplay/Task.d.ts.map +1 -0
  483. package/lib/screenplay/Task.js +175 -76
  484. package/lib/screenplay/Task.js.map +1 -1
  485. package/lib/screenplay/WithAnswerableProperties.d.ts +33 -0
  486. package/lib/screenplay/WithAnswerableProperties.d.ts.map +1 -0
  487. package/lib/screenplay/WithAnswerableProperties.js +3 -0
  488. package/lib/screenplay/WithAnswerableProperties.js.map +1 -0
  489. package/lib/screenplay/abilities/Ability.d.ts +397 -0
  490. package/lib/screenplay/abilities/Ability.d.ts.map +1 -0
  491. package/lib/screenplay/abilities/Ability.js +401 -0
  492. package/lib/screenplay/abilities/Ability.js.map +1 -0
  493. package/lib/screenplay/abilities/AbilityType.d.ts +45 -0
  494. package/lib/screenplay/abilities/AbilityType.d.ts.map +1 -0
  495. package/lib/screenplay/abilities/AbilityType.js.map +1 -0
  496. package/lib/screenplay/abilities/CanHaveAbilities.d.ts +19 -0
  497. package/lib/screenplay/abilities/CanHaveAbilities.d.ts.map +1 -0
  498. package/lib/screenplay/abilities/CanHaveAbilities.js.map +1 -0
  499. package/lib/screenplay/abilities/Discardable.d.ts +19 -7
  500. package/lib/screenplay/abilities/Discardable.d.ts.map +1 -0
  501. package/lib/screenplay/abilities/Initialisable.d.ts +18 -16
  502. package/lib/screenplay/abilities/Initialisable.d.ts.map +1 -0
  503. package/lib/screenplay/abilities/UsesAbilities.d.ts +23 -0
  504. package/lib/screenplay/abilities/UsesAbilities.d.ts.map +1 -0
  505. package/lib/screenplay/abilities/UsesAbilities.js.map +1 -0
  506. package/lib/screenplay/abilities/index.d.ts +5 -1
  507. package/lib/screenplay/abilities/index.d.ts.map +1 -0
  508. package/lib/screenplay/abilities/index.js +9 -2
  509. package/lib/screenplay/abilities/index.js.map +1 -1
  510. package/lib/screenplay/activities/PerformsActivities.d.ts +20 -0
  511. package/lib/screenplay/activities/PerformsActivities.d.ts.map +1 -0
  512. package/lib/screenplay/activities/PerformsActivities.js.map +1 -0
  513. package/lib/screenplay/activities/index.d.ts +2 -1
  514. package/lib/screenplay/activities/index.d.ts.map +1 -0
  515. package/lib/screenplay/activities/index.js +6 -2
  516. package/lib/screenplay/activities/index.js.map +1 -1
  517. package/lib/screenplay/artifacts/CollectsArtifacts.d.ts +24 -0
  518. package/lib/screenplay/artifacts/CollectsArtifacts.d.ts.map +1 -0
  519. package/lib/screenplay/artifacts/CollectsArtifacts.js.map +1 -0
  520. package/lib/screenplay/artifacts/index.d.ts +2 -0
  521. package/lib/screenplay/artifacts/index.d.ts.map +1 -0
  522. package/lib/screenplay/{actor → artifacts}/index.js +5 -6
  523. package/lib/screenplay/artifacts/index.js.map +1 -0
  524. package/lib/screenplay/debugging/Debug.d.ts +107 -0
  525. package/lib/screenplay/debugging/Debug.d.ts.map +1 -0
  526. package/lib/screenplay/debugging/Debug.js +131 -0
  527. package/lib/screenplay/debugging/Debug.js.map +1 -0
  528. package/lib/screenplay/debugging/DebuggingResult.d.ts +11 -0
  529. package/lib/screenplay/debugging/DebuggingResult.d.ts.map +1 -0
  530. package/lib/screenplay/debugging/DebuggingResult.js +3 -0
  531. package/lib/screenplay/debugging/DebuggingResult.js.map +1 -0
  532. package/lib/screenplay/debugging/Log.d.ts +47 -0
  533. package/lib/screenplay/debugging/Log.d.ts.map +1 -0
  534. package/lib/screenplay/debugging/Log.js +59 -0
  535. package/lib/screenplay/debugging/Log.js.map +1 -0
  536. package/lib/screenplay/debugging/index.d.ts +4 -0
  537. package/lib/screenplay/debugging/index.d.ts.map +1 -0
  538. package/lib/screenplay/debugging/index.js +20 -0
  539. package/lib/screenplay/debugging/index.js.map +1 -0
  540. package/lib/screenplay/index.d.ts +10 -4
  541. package/lib/screenplay/index.d.ts.map +1 -0
  542. package/lib/screenplay/index.js +14 -5
  543. package/lib/screenplay/index.js.map +1 -1
  544. package/lib/screenplay/notes/ChainableSetter.d.ts +9 -0
  545. package/lib/screenplay/notes/ChainableSetter.d.ts.map +1 -0
  546. package/lib/screenplay/notes/ChainableSetter.js +3 -0
  547. package/lib/screenplay/notes/ChainableSetter.js.map +1 -0
  548. package/lib/screenplay/notes/Notepad.d.ts +164 -0
  549. package/lib/screenplay/notes/Notepad.d.ts.map +1 -0
  550. package/lib/screenplay/notes/Notepad.js +200 -0
  551. package/lib/screenplay/notes/Notepad.js.map +1 -0
  552. package/lib/screenplay/notes/NotepadAdapter.d.ts +245 -0
  553. package/lib/screenplay/notes/NotepadAdapter.d.ts.map +1 -0
  554. package/lib/screenplay/notes/NotepadAdapter.js +298 -0
  555. package/lib/screenplay/notes/NotepadAdapter.js.map +1 -0
  556. package/lib/screenplay/notes/TakeNotes.d.ts +249 -0
  557. package/lib/screenplay/notes/TakeNotes.d.ts.map +1 -0
  558. package/lib/screenplay/notes/TakeNotes.js +259 -0
  559. package/lib/screenplay/notes/TakeNotes.js.map +1 -0
  560. package/lib/screenplay/notes/index.d.ts +6 -0
  561. package/lib/screenplay/notes/index.d.ts.map +1 -0
  562. package/lib/screenplay/notes/index.js +22 -0
  563. package/lib/screenplay/notes/index.js.map +1 -0
  564. package/lib/screenplay/notes/notes.d.ts +117 -0
  565. package/lib/screenplay/notes/notes.d.ts.map +1 -0
  566. package/lib/screenplay/notes/notes.js +123 -0
  567. package/lib/screenplay/notes/notes.js.map +1 -0
  568. package/lib/screenplay/questions/AnswersQuestions.d.ts +19 -0
  569. package/lib/screenplay/questions/AnswersQuestions.d.ts.map +1 -0
  570. package/lib/screenplay/questions/AnswersQuestions.js.map +1 -0
  571. package/lib/screenplay/questions/Check.d.ts +39 -57
  572. package/lib/screenplay/questions/Check.d.ts.map +1 -0
  573. package/lib/screenplay/questions/Check.js +41 -63
  574. package/lib/screenplay/questions/Check.js.map +1 -1
  575. package/lib/screenplay/questions/Expectation.d.ts +155 -44
  576. package/lib/screenplay/questions/Expectation.d.ts.map +1 -0
  577. package/lib/screenplay/questions/Expectation.js +172 -46
  578. package/lib/screenplay/questions/Expectation.js.map +1 -1
  579. package/lib/screenplay/questions/List.d.ts +14 -2
  580. package/lib/screenplay/questions/List.d.ts.map +1 -0
  581. package/lib/screenplay/questions/List.js +14 -11
  582. package/lib/screenplay/questions/List.js.map +1 -1
  583. package/lib/screenplay/questions/MetaQuestion.d.ts +18 -22
  584. package/lib/screenplay/questions/MetaQuestion.d.ts.map +1 -0
  585. package/lib/screenplay/questions/Unanswered.d.ts +20 -0
  586. package/lib/screenplay/questions/Unanswered.d.ts.map +1 -0
  587. package/lib/screenplay/questions/Unanswered.js +52 -0
  588. package/lib/screenplay/questions/Unanswered.js.map +1 -0
  589. package/lib/screenplay/questions/expectations/ExpectationDetails.d.ts +24 -0
  590. package/lib/screenplay/questions/expectations/ExpectationDetails.d.ts.map +1 -0
  591. package/lib/screenplay/questions/expectations/ExpectationDetails.js +55 -0
  592. package/lib/screenplay/questions/expectations/ExpectationDetails.js.map +1 -0
  593. package/lib/screenplay/questions/expectations/ExpectationMet.d.ts +7 -1
  594. package/lib/screenplay/questions/expectations/ExpectationMet.d.ts.map +1 -0
  595. package/lib/screenplay/questions/expectations/ExpectationMet.js +5 -0
  596. package/lib/screenplay/questions/expectations/ExpectationMet.js.map +1 -1
  597. package/lib/screenplay/questions/expectations/ExpectationNotMet.d.ts +7 -1
  598. package/lib/screenplay/questions/expectations/ExpectationNotMet.d.ts.map +1 -0
  599. package/lib/screenplay/questions/expectations/ExpectationNotMet.js +5 -0
  600. package/lib/screenplay/questions/expectations/ExpectationNotMet.js.map +1 -1
  601. package/lib/screenplay/questions/expectations/ExpectationOutcome.d.ts +13 -4
  602. package/lib/screenplay/questions/expectations/ExpectationOutcome.d.ts.map +1 -0
  603. package/lib/screenplay/questions/expectations/ExpectationOutcome.js +8 -1
  604. package/lib/screenplay/questions/expectations/ExpectationOutcome.js.map +1 -1
  605. package/lib/screenplay/questions/expectations/index.d.ts +2 -0
  606. package/lib/screenplay/questions/expectations/index.d.ts.map +1 -0
  607. package/lib/screenplay/questions/expectations/index.js +6 -1
  608. package/lib/screenplay/questions/expectations/index.js.map +1 -1
  609. package/lib/screenplay/questions/index.d.ts +3 -1
  610. package/lib/screenplay/questions/index.d.ts.map +1 -0
  611. package/lib/screenplay/questions/index.js +7 -2
  612. package/lib/screenplay/questions/index.js.map +1 -1
  613. package/lib/screenplay/questions/q.d.ts +56 -25
  614. package/lib/screenplay/questions/q.d.ts.map +1 -0
  615. package/lib/screenplay/questions/q.js +53 -23
  616. package/lib/screenplay/questions/q.js.map +1 -1
  617. package/lib/screenplay/time/abilities/ScheduleWork.d.ts +26 -0
  618. package/lib/screenplay/time/abilities/ScheduleWork.d.ts.map +1 -0
  619. package/lib/screenplay/time/abilities/ScheduleWork.js +45 -0
  620. package/lib/screenplay/time/abilities/ScheduleWork.js.map +1 -0
  621. package/lib/screenplay/time/abilities/index.d.ts +2 -0
  622. package/lib/screenplay/time/abilities/index.d.ts.map +1 -0
  623. package/lib/{io/json → screenplay/time/abilities}/index.js +6 -2
  624. package/lib/screenplay/time/abilities/index.js.map +1 -0
  625. package/lib/screenplay/time/activities/Wait.d.ts +212 -0
  626. package/lib/screenplay/time/activities/Wait.d.ts.map +1 -0
  627. package/lib/screenplay/time/activities/Wait.js +270 -0
  628. package/lib/screenplay/time/activities/Wait.js.map +1 -0
  629. package/lib/screenplay/time/activities/index.d.ts +2 -0
  630. package/lib/screenplay/time/activities/index.d.ts.map +1 -0
  631. package/lib/screenplay/{interactions → time/activities}/index.js +6 -3
  632. package/lib/screenplay/time/activities/index.js.map +1 -0
  633. package/lib/screenplay/time/index.d.ts +4 -0
  634. package/lib/screenplay/time/index.d.ts.map +1 -0
  635. package/lib/screenplay/time/index.js +20 -0
  636. package/lib/screenplay/time/index.js.map +1 -0
  637. package/lib/screenplay/time/models/Clock.d.ts +24 -0
  638. package/lib/screenplay/time/models/Clock.d.ts.map +1 -0
  639. package/lib/screenplay/time/models/Clock.js +31 -0
  640. package/lib/screenplay/time/models/Clock.js.map +1 -0
  641. package/lib/screenplay/time/models/DelayedCallback.d.ts +11 -0
  642. package/lib/screenplay/time/models/DelayedCallback.d.ts.map +1 -0
  643. package/lib/screenplay/time/models/DelayedCallback.js +3 -0
  644. package/lib/screenplay/time/models/DelayedCallback.js.map +1 -0
  645. package/lib/{model → screenplay/time/models}/Duration.d.ts +11 -1
  646. package/lib/screenplay/time/models/Duration.d.ts.map +1 -0
  647. package/lib/{model → screenplay/time/models}/Duration.js +14 -0
  648. package/lib/screenplay/time/models/Duration.js.map +1 -0
  649. package/lib/screenplay/time/models/RepeatUntilLimits.d.ts +12 -0
  650. package/lib/screenplay/time/models/RepeatUntilLimits.d.ts.map +1 -0
  651. package/lib/screenplay/time/models/RepeatUntilLimits.js +3 -0
  652. package/lib/screenplay/time/models/RepeatUntilLimits.js.map +1 -0
  653. package/lib/screenplay/time/models/Scheduler.d.ts +43 -0
  654. package/lib/screenplay/time/models/Scheduler.d.ts.map +1 -0
  655. package/lib/screenplay/time/models/Scheduler.js +166 -0
  656. package/lib/screenplay/time/models/Scheduler.js.map +1 -0
  657. package/lib/{model → screenplay/time/models}/Timestamp.d.ts +16 -0
  658. package/lib/screenplay/time/models/Timestamp.d.ts.map +1 -0
  659. package/lib/screenplay/time/models/Timestamp.js +81 -0
  660. package/lib/screenplay/time/models/Timestamp.js.map +1 -0
  661. package/lib/screenplay/time/models/index.d.ts +7 -0
  662. package/lib/screenplay/time/models/index.d.ts.map +1 -0
  663. package/lib/screenplay/time/models/index.js +23 -0
  664. package/lib/screenplay/time/models/index.js.map +1 -0
  665. package/lib/stage/Cast.d.ts +142 -49
  666. package/lib/stage/Cast.d.ts.map +1 -0
  667. package/lib/stage/Cast.js +141 -55
  668. package/lib/stage/Cast.js.map +1 -1
  669. package/lib/stage/Extras.d.ts +2 -4
  670. package/lib/stage/Extras.d.ts.map +1 -0
  671. package/lib/stage/Extras.js +1 -4
  672. package/lib/stage/Extras.js.map +1 -1
  673. package/lib/stage/ListensToDomainEvents.d.ts +14 -11
  674. package/lib/stage/ListensToDomainEvents.d.ts.map +1 -0
  675. package/lib/stage/Stage.d.ts +81 -100
  676. package/lib/stage/Stage.d.ts.map +1 -0
  677. package/lib/stage/Stage.js +122 -119
  678. package/lib/stage/Stage.js.map +1 -1
  679. package/lib/stage/StageCrewMember.d.ts +67 -15
  680. package/lib/stage/StageCrewMember.d.ts.map +1 -0
  681. package/lib/stage/StageCrewMemberBuilder.d.ts +14 -12
  682. package/lib/stage/StageCrewMemberBuilder.d.ts.map +1 -0
  683. package/lib/stage/StageCrewMemberBuilderDependencies.d.ts +6 -13
  684. package/lib/stage/StageCrewMemberBuilderDependencies.d.ts.map +1 -0
  685. package/lib/stage/StageManager.d.ts +6 -2
  686. package/lib/stage/StageManager.d.ts.map +1 -0
  687. package/lib/stage/StageManager.js +22 -20
  688. package/lib/stage/StageManager.js.map +1 -1
  689. package/lib/stage/crew/artifact-archiver/ArtifactArchiver.d.ts +70 -47
  690. package/lib/stage/crew/artifact-archiver/ArtifactArchiver.d.ts.map +1 -0
  691. package/lib/stage/crew/artifact-archiver/ArtifactArchiver.js +80 -56
  692. package/lib/stage/crew/artifact-archiver/ArtifactArchiver.js.map +1 -1
  693. package/lib/stage/crew/artifact-archiver/Hash.d.ts +1 -0
  694. package/lib/stage/crew/artifact-archiver/Hash.d.ts.map +1 -0
  695. package/lib/stage/crew/artifact-archiver/Hash.js +3 -3
  696. package/lib/stage/crew/artifact-archiver/Hash.js.map +1 -1
  697. package/lib/stage/crew/artifact-archiver/index.d.ts +1 -0
  698. package/lib/stage/crew/artifact-archiver/index.d.ts.map +1 -0
  699. package/lib/stage/crew/artifact-archiver/index.js +5 -1
  700. package/lib/stage/crew/artifact-archiver/index.js.map +1 -1
  701. package/lib/stage/crew/index.d.ts +1 -0
  702. package/lib/stage/crew/index.d.ts.map +1 -0
  703. package/lib/stage/crew/index.js +5 -1
  704. package/lib/stage/crew/index.js.map +1 -1
  705. package/lib/stage/crew/stream-reporter/StreamReporter.d.ts +82 -54
  706. package/lib/stage/crew/stream-reporter/StreamReporter.d.ts.map +1 -0
  707. package/lib/stage/crew/stream-reporter/StreamReporter.js +81 -54
  708. package/lib/stage/crew/stream-reporter/StreamReporter.js.map +1 -1
  709. package/lib/stage/crew/stream-reporter/index.d.ts +1 -0
  710. package/lib/stage/crew/stream-reporter/index.d.ts.map +1 -0
  711. package/lib/stage/crew/stream-reporter/index.js +5 -1
  712. package/lib/stage/crew/stream-reporter/index.js.map +1 -1
  713. package/lib/stage/index.d.ts +2 -1
  714. package/lib/stage/index.d.ts.map +1 -0
  715. package/lib/stage/index.js +6 -2
  716. package/lib/stage/index.js.map +1 -1
  717. package/lib/stage/queues/DomainEventQueue.d.ts +25 -0
  718. package/lib/stage/queues/DomainEventQueue.d.ts.map +1 -0
  719. package/lib/stage/queues/DomainEventQueue.js +33 -0
  720. package/lib/stage/queues/DomainEventQueue.js.map +1 -0
  721. package/lib/stage/queues/DomainEventQueues.d.ts +22 -0
  722. package/lib/stage/queues/DomainEventQueues.d.ts.map +1 -0
  723. package/lib/stage/queues/DomainEventQueues.js +76 -0
  724. package/lib/stage/queues/DomainEventQueues.js.map +1 -0
  725. package/lib/stage/queues/index.d.ts +3 -0
  726. package/lib/stage/queues/index.d.ts.map +1 -0
  727. package/lib/stage/queues/index.js +19 -0
  728. package/lib/stage/queues/index.js.map +1 -0
  729. package/package.json +31 -51
  730. package/src/Serenity.ts +183 -88
  731. package/src/adapter/OutputStream.ts +13 -0
  732. package/src/adapter/TestRunnerAdapter.ts +35 -0
  733. package/src/adapter/index.ts +2 -0
  734. package/src/config/ClassDescription.ts +55 -0
  735. package/src/config/SerenityConfig.ts +79 -0
  736. package/src/config/index.ts +2 -0
  737. package/src/errors/ErrorFactory.ts +329 -0
  738. package/src/errors/ErrorOptions.ts +16 -0
  739. package/src/errors/ErrorSerialiser.ts +106 -0
  740. package/src/{io → errors}/ErrorStackParser.ts +4 -4
  741. package/src/errors/RaiseErrors.ts +61 -0
  742. package/src/errors/diff/AnsiDiffFormatter.ts +41 -0
  743. package/src/errors/diff/DiffFormatter.ts +12 -0
  744. package/src/errors/diff/NoOpDiffFormatter.ts +20 -0
  745. package/src/errors/diff/index.ts +3 -0
  746. package/src/errors/index.ts +28 -7
  747. package/src/errors/model/AssertionError.ts +31 -0
  748. package/src/errors/model/ConfigurationError.ts +31 -0
  749. package/src/errors/model/ImplementationPendingError.ts +52 -0
  750. package/src/errors/model/ListItemNotFoundError.ts +35 -0
  751. package/src/errors/model/LogicError.ts +35 -0
  752. package/src/errors/model/OperationInterruptedError.ts +38 -0
  753. package/src/errors/model/RuntimeError.ts +101 -0
  754. package/src/errors/model/TestCompromisedError.ts +46 -0
  755. package/src/errors/model/TimeoutExpiredError.ts +38 -0
  756. package/src/errors/model/UnknownError.ts +31 -0
  757. package/src/errors/model/index.ts +10 -0
  758. package/src/events/ActivityFinished.ts +4 -5
  759. package/src/events/ActivityRelatedArtifactArchived.ts +6 -1
  760. package/src/events/ActivityRelatedArtifactGenerated.ts +5 -1
  761. package/src/events/ActivityStarts.ts +4 -5
  762. package/src/events/ArtifactArchived.ts +5 -1
  763. package/src/events/ArtifactGenerated.ts +5 -1
  764. package/src/events/AsyncOperationAborted.ts +28 -0
  765. package/src/events/AsyncOperationAttempted.ts +11 -4
  766. package/src/events/AsyncOperationCompleted.ts +5 -4
  767. package/src/events/AsyncOperationFailed.ts +6 -2
  768. package/src/events/BusinessRuleDetected.ts +5 -5
  769. package/src/events/DomainEvent.ts +4 -7
  770. package/src/events/FeatureNarrativeDetected.ts +5 -1
  771. package/src/events/InteractionFinished.ts +5 -1
  772. package/src/events/InteractionStarts.ts +5 -1
  773. package/src/events/RetryableSceneDetected.ts +8 -10
  774. package/src/events/SceneBackgroundDetected.ts +6 -1
  775. package/src/events/SceneDescriptionDetected.ts +5 -1
  776. package/src/events/SceneFinished.ts +5 -1
  777. package/src/events/SceneFinishes.ts +8 -7
  778. package/src/events/SceneParametersDetected.ts +5 -1
  779. package/src/events/SceneSequenceDetected.ts +5 -1
  780. package/src/events/SceneStarts.ts +5 -1
  781. package/src/events/SceneTagged.ts +5 -1
  782. package/src/events/SceneTemplateDetected.ts +5 -1
  783. package/src/events/TaskFinished.ts +5 -1
  784. package/src/events/TaskStarts.ts +5 -1
  785. package/src/events/TestRunFinished.ts +14 -6
  786. package/src/events/TestRunFinishes.ts +5 -4
  787. package/src/events/TestRunStarts.ts +3 -4
  788. package/src/events/TestRunnerDetected.ts +7 -4
  789. package/src/events/TestSuiteFinished.ts +5 -1
  790. package/src/events/TestSuiteStarts.ts +5 -1
  791. package/src/events/index.ts +1 -0
  792. package/src/index.ts +1 -2
  793. package/src/instance.ts +180 -91
  794. package/src/io/FileFinder.ts +2 -1
  795. package/src/io/FileSystem.ts +1 -1
  796. package/src/io/Path.ts +6 -3
  797. package/src/io/asyncMap.ts +6 -5
  798. package/src/io/commaSeparated.ts +8 -9
  799. package/src/io/format.ts +49 -22
  800. package/src/io/index.ts +3 -9
  801. package/src/io/inspected.ts +13 -271
  802. package/src/io/inspectedObject.ts +38 -0
  803. package/src/io/loader/ClassDescriptionParser.ts +67 -0
  804. package/src/io/loader/ClassDescriptor.ts +7 -0
  805. package/src/io/loader/ClassLoader.ts +42 -0
  806. package/src/io/{ModuleLoader.ts → loader/ModuleLoader.ts} +11 -19
  807. package/src/io/{Version.ts → loader/Version.ts} +2 -5
  808. package/src/io/loader/index.ts +5 -0
  809. package/src/io/reflection/has.ts +3 -5
  810. package/src/io/reflection/index.ts +2 -0
  811. package/src/io/reflection/isPrimitive.ts +20 -0
  812. package/src/io/reflection/typeOf.ts +31 -0
  813. package/src/io/stringified.ts +266 -0
  814. package/src/io/trimmed.ts +7 -9
  815. package/src/model/ActivityDetails.ts +8 -2
  816. package/src/model/CorrelationId.ts +1 -1
  817. package/src/model/ScenarioDetails.ts +4 -1
  818. package/src/model/artifacts/HTTPRequestResponse.ts +6 -10
  819. package/src/model/artifacts/Photo.ts +0 -8
  820. package/src/model/artifacts/index.ts +0 -1
  821. package/src/model/index.ts +0 -2
  822. package/src/model/outcomes.ts +5 -4
  823. package/src/model/tags/ArbitraryTag.ts +2 -5
  824. package/src/model/tags/ExecutionRetriedTag.ts +2 -5
  825. package/src/model/tags/index.ts +0 -1
  826. package/src/screenplay/Activity.ts +78 -20
  827. package/src/screenplay/Actor.ts +370 -0
  828. package/src/screenplay/Answerable.ts +3 -6
  829. package/src/screenplay/Answered.ts +16 -0
  830. package/src/screenplay/Interaction.ts +85 -42
  831. package/src/screenplay/Optional.ts +14 -18
  832. package/src/screenplay/Question.ts +369 -114
  833. package/src/screenplay/RecursivelyAnswered.ts +43 -0
  834. package/src/screenplay/Task.ts +185 -88
  835. package/src/screenplay/WithAnswerableProperties.ts +36 -0
  836. package/src/screenplay/abilities/Ability.ts +403 -0
  837. package/src/screenplay/abilities/AbilityType.ts +46 -0
  838. package/src/screenplay/abilities/CanHaveAbilities.ts +20 -0
  839. package/src/screenplay/abilities/Discardable.ts +19 -7
  840. package/src/screenplay/abilities/Initialisable.ts +17 -16
  841. package/src/screenplay/abilities/UsesAbilities.ts +24 -0
  842. package/src/screenplay/abilities/index.ts +4 -1
  843. package/src/screenplay/activities/PerformsActivities.ts +21 -0
  844. package/src/screenplay/activities/index.ts +1 -1
  845. package/src/screenplay/artifacts/CollectsArtifacts.ts +25 -0
  846. package/src/screenplay/artifacts/index.ts +1 -0
  847. package/src/screenplay/debugging/Debug.ts +161 -0
  848. package/src/screenplay/debugging/DebuggingResult.ts +10 -0
  849. package/src/screenplay/debugging/Log.ts +68 -0
  850. package/src/screenplay/debugging/index.ts +3 -0
  851. package/src/screenplay/index.ts +9 -4
  852. package/src/screenplay/notes/ChainableSetter.ts +9 -0
  853. package/src/screenplay/notes/Notepad.ts +208 -0
  854. package/src/screenplay/notes/NotepadAdapter.ts +317 -0
  855. package/src/screenplay/notes/TakeNotes.ts +257 -0
  856. package/src/screenplay/notes/index.ts +5 -0
  857. package/src/screenplay/notes/notes.ts +120 -0
  858. package/src/screenplay/questions/AnswersQuestions.ts +20 -0
  859. package/src/screenplay/questions/Check.ts +41 -62
  860. package/src/screenplay/questions/Expectation.ts +211 -65
  861. package/src/screenplay/questions/List.ts +18 -11
  862. package/src/screenplay/questions/MetaQuestion.ts +18 -22
  863. package/src/screenplay/questions/Unanswered.ts +27 -0
  864. package/src/screenplay/questions/expectations/ExpectationDetails.ts +64 -0
  865. package/src/screenplay/questions/expectations/ExpectationMet.ts +6 -1
  866. package/src/screenplay/questions/expectations/ExpectationNotMet.ts +6 -1
  867. package/src/screenplay/questions/expectations/ExpectationOutcome.ts +12 -3
  868. package/src/screenplay/questions/expectations/index.ts +1 -0
  869. package/src/screenplay/questions/index.ts +2 -1
  870. package/src/screenplay/questions/q.ts +55 -25
  871. package/src/screenplay/time/abilities/ScheduleWork.ts +52 -0
  872. package/src/screenplay/time/abilities/index.ts +1 -0
  873. package/src/screenplay/time/activities/Wait.ts +294 -0
  874. package/src/screenplay/time/activities/index.ts +1 -0
  875. package/src/screenplay/time/index.ts +3 -0
  876. package/src/screenplay/time/models/Clock.ts +28 -0
  877. package/src/screenplay/time/models/DelayedCallback.ts +8 -0
  878. package/src/{model → screenplay/time/models}/Duration.ts +17 -1
  879. package/src/screenplay/time/models/RepeatUntilLimits.ts +12 -0
  880. package/src/screenplay/time/models/Scheduler.ts +226 -0
  881. package/src/{model → screenplay/time/models}/Timestamp.ts +36 -2
  882. package/src/screenplay/time/models/index.ts +6 -0
  883. package/src/stage/Cast.ts +147 -62
  884. package/src/stage/Extras.ts +1 -4
  885. package/src/stage/ListensToDomainEvents.ts +13 -11
  886. package/src/stage/Stage.ts +140 -130
  887. package/src/stage/StageCrewMember.ts +66 -15
  888. package/src/stage/StageCrewMemberBuilder.ts +13 -12
  889. package/src/stage/StageCrewMemberBuilderDependencies.ts +5 -15
  890. package/src/stage/StageManager.ts +44 -44
  891. package/src/stage/crew/artifact-archiver/ArtifactArchiver.ts +81 -53
  892. package/src/stage/crew/stream-reporter/StreamReporter.ts +81 -54
  893. package/src/stage/index.ts +1 -1
  894. package/src/stage/queues/DomainEventQueue.ts +41 -0
  895. package/src/stage/queues/DomainEventQueues.ts +88 -0
  896. package/src/stage/queues/index.ts +2 -0
  897. package/tsconfig.build.json +10 -0
  898. package/lib/SerenityConfig.d.ts +0 -45
  899. package/lib/SerenityConfig.js +0 -12
  900. package/lib/SerenityConfig.js.map +0 -1
  901. package/lib/errors/AssertionError.d.ts +0 -18
  902. package/lib/errors/AssertionError.js +0 -25
  903. package/lib/errors/AssertionError.js.map +0 -1
  904. package/lib/errors/ConfigurationError.d.ts +0 -14
  905. package/lib/errors/ConfigurationError.js +0 -21
  906. package/lib/errors/ConfigurationError.js.map +0 -1
  907. package/lib/errors/ImplementationPendingError.d.ts +0 -29
  908. package/lib/errors/ImplementationPendingError.js +0 -36
  909. package/lib/errors/ImplementationPendingError.js.map +0 -1
  910. package/lib/errors/LogicError.d.ts +0 -17
  911. package/lib/errors/LogicError.js +0 -24
  912. package/lib/errors/LogicError.js.map +0 -1
  913. package/lib/errors/RuntimeError.d.ts +0 -43
  914. package/lib/errors/RuntimeError.js +0 -58
  915. package/lib/errors/RuntimeError.js.map +0 -1
  916. package/lib/errors/TestCompromisedError.d.ts +0 -26
  917. package/lib/errors/TestCompromisedError.js +0 -33
  918. package/lib/errors/TestCompromisedError.js.map +0 -1
  919. package/lib/errors/UnknownError.d.ts +0 -14
  920. package/lib/errors/UnknownError.js +0 -21
  921. package/lib/errors/UnknownError.js.map +0 -1
  922. package/lib/io/AssertionReportDiffer.d.ts +0 -12
  923. package/lib/io/AssertionReportDiffer.js +0 -34
  924. package/lib/io/AssertionReportDiffer.js.map +0 -1
  925. package/lib/io/ErrorSerialiser.d.ts +0 -27
  926. package/lib/io/ErrorSerialiser.js.map +0 -1
  927. package/lib/io/ErrorStackParser.d.ts +0 -12
  928. package/lib/io/ErrorStackParser.js +0 -19
  929. package/lib/io/ErrorStackParser.js.map +0 -1
  930. package/lib/io/ModuleLoader.js +0 -81
  931. package/lib/io/ModuleLoader.js.map +0 -1
  932. package/lib/io/OutputStream.d.ts +0 -16
  933. package/lib/io/TestRunnerAdapter.d.ts +0 -47
  934. package/lib/io/TestRunnerAdapter.js.map +0 -1
  935. package/lib/io/Version.js.map +0 -1
  936. package/lib/io/formatted.d.ts +0 -16
  937. package/lib/io/formatted.js +0 -23
  938. package/lib/io/formatted.js.map +0 -1
  939. package/lib/io/json/cycle.d.ts +0 -11
  940. package/lib/io/json/cycle.js +0 -165
  941. package/lib/io/json/cycle.js.map +0 -1
  942. package/lib/io/json/index.d.ts +0 -1
  943. package/lib/io/json/index.js.map +0 -1
  944. package/lib/model/Duration.js.map +0 -1
  945. package/lib/model/Timestamp.js +0 -48
  946. package/lib/model/Timestamp.js.map +0 -1
  947. package/lib/model/artifacts/AssertionReport.d.ts +0 -7
  948. package/lib/model/artifacts/AssertionReport.js +0 -11
  949. package/lib/model/artifacts/AssertionReport.js.map +0 -1
  950. package/lib/model/tags/ContextTag.d.ts +0 -17
  951. package/lib/model/tags/ContextTag.js +0 -24
  952. package/lib/model/tags/ContextTag.js.map +0 -1
  953. package/lib/screenplay/Ability.d.ts +0 -100
  954. package/lib/screenplay/Ability.js.map +0 -1
  955. package/lib/screenplay/AbilityType.d.ts +0 -42
  956. package/lib/screenplay/AbilityType.js.map +0 -1
  957. package/lib/screenplay/abilities/TakeNotes.d.ts +0 -151
  958. package/lib/screenplay/abilities/TakeNotes.js +0 -205
  959. package/lib/screenplay/abilities/TakeNotes.js.map +0 -1
  960. package/lib/screenplay/activities/ActivityDescriber.d.ts +0 -9
  961. package/lib/screenplay/activities/ActivityDescriber.js +0 -18
  962. package/lib/screenplay/activities/ActivityDescriber.js.map +0 -1
  963. package/lib/screenplay/activities/OutcomeMatcher.d.ts +0 -5
  964. package/lib/screenplay/activities/OutcomeMatcher.js +0 -21
  965. package/lib/screenplay/activities/OutcomeMatcher.js.map +0 -1
  966. package/lib/screenplay/activities/TrackedActivity.d.ts +0 -17
  967. package/lib/screenplay/activities/TrackedActivity.js +0 -40
  968. package/lib/screenplay/activities/TrackedActivity.js.map +0 -1
  969. package/lib/screenplay/actor/Actor.d.ts +0 -106
  970. package/lib/screenplay/actor/Actor.js +0 -189
  971. package/lib/screenplay/actor/Actor.js.map +0 -1
  972. package/lib/screenplay/actor/AnswersQuestions.d.ts +0 -10
  973. package/lib/screenplay/actor/AnswersQuestions.js.map +0 -1
  974. package/lib/screenplay/actor/CanHaveAbilities.d.ts +0 -15
  975. package/lib/screenplay/actor/CanHaveAbilities.js.map +0 -1
  976. package/lib/screenplay/actor/CollectsArtifacts.d.ts +0 -17
  977. package/lib/screenplay/actor/CollectsArtifacts.js.map +0 -1
  978. package/lib/screenplay/actor/PerformsActivities.d.ts +0 -10
  979. package/lib/screenplay/actor/PerformsActivities.js.map +0 -1
  980. package/lib/screenplay/actor/UsesAbilities.d.ts +0 -18
  981. package/lib/screenplay/actor/UsesAbilities.js.map +0 -1
  982. package/lib/screenplay/actor/index.d.ts +0 -6
  983. package/lib/screenplay/actor/index.js.map +0 -1
  984. package/lib/screenplay/interactions/Log.d.ts +0 -57
  985. package/lib/screenplay/interactions/Log.js +0 -74
  986. package/lib/screenplay/interactions/Log.js.map +0 -1
  987. package/lib/screenplay/interactions/TakeNote.d.ts +0 -87
  988. package/lib/screenplay/interactions/TakeNote.js +0 -103
  989. package/lib/screenplay/interactions/TakeNote.js.map +0 -1
  990. package/lib/screenplay/interactions/index.d.ts +0 -2
  991. package/lib/screenplay/interactions/index.js.map +0 -1
  992. package/lib/screenplay/questions/Note.d.ts +0 -79
  993. package/lib/screenplay/questions/Note.js +0 -96
  994. package/lib/screenplay/questions/Note.js.map +0 -1
  995. package/lib/stage/Clock.d.ts +0 -15
  996. package/lib/stage/Clock.js +0 -23
  997. package/lib/stage/Clock.js.map +0 -1
  998. package/src/SerenityConfig.ts +0 -49
  999. package/src/errors/AssertionError.ts +0 -20
  1000. package/src/errors/ConfigurationError.ts +0 -18
  1001. package/src/errors/ImplementationPendingError.ts +0 -33
  1002. package/src/errors/LogicError.ts +0 -21
  1003. package/src/errors/RuntimeError.ts +0 -60
  1004. package/src/errors/TestCompromisedError.ts +0 -30
  1005. package/src/errors/UnknownError.ts +0 -18
  1006. package/src/io/AssertionReportDiffer.ts +0 -43
  1007. package/src/io/ErrorSerialiser.ts +0 -78
  1008. package/src/io/OutputStream.ts +0 -16
  1009. package/src/io/TestRunnerAdapter.ts +0 -50
  1010. package/src/io/formatted.ts +0 -20
  1011. package/src/io/json/cycle.ts +0 -177
  1012. package/src/io/json/index.ts +0 -1
  1013. package/src/model/artifacts/AssertionReport.ts +0 -7
  1014. package/src/model/tags/ContextTag.ts +0 -21
  1015. package/src/screenplay/Ability.ts +0 -100
  1016. package/src/screenplay/AbilityType.ts +0 -44
  1017. package/src/screenplay/abilities/TakeNotes.ts +0 -216
  1018. package/src/screenplay/activities/ActivityDescriber.ts +0 -20
  1019. package/src/screenplay/activities/OutcomeMatcher.ts +0 -25
  1020. package/src/screenplay/activities/TrackedActivity.ts +0 -50
  1021. package/src/screenplay/actor/Actor.ts +0 -243
  1022. package/src/screenplay/actor/AnswersQuestions.ts +0 -11
  1023. package/src/screenplay/actor/CanHaveAbilities.ts +0 -16
  1024. package/src/screenplay/actor/CollectsArtifacts.ts +0 -18
  1025. package/src/screenplay/actor/PerformsActivities.ts +0 -11
  1026. package/src/screenplay/actor/UsesAbilities.ts +0 -20
  1027. package/src/screenplay/actor/index.ts +0 -6
  1028. package/src/screenplay/interactions/Log.ts +0 -81
  1029. package/src/screenplay/interactions/TakeNote.ts +0 -107
  1030. package/src/screenplay/interactions/index.ts +0 -2
  1031. package/src/screenplay/questions/Note.ts +0 -99
  1032. package/src/stage/Clock.ts +0 -19
  1033. package/tsconfig.eslint.json +0 -10
  1034. /package/lib/{io → adapter}/OutputStream.js +0 -0
  1035. /package/lib/{io → adapter}/TestRunnerAdapter.js +0 -0
  1036. /package/lib/screenplay/{AbilityType.js → abilities/AbilityType.js} +0 -0
  1037. /package/lib/screenplay/{actor → abilities}/CanHaveAbilities.js +0 -0
  1038. /package/lib/screenplay/{actor → abilities}/UsesAbilities.js +0 -0
  1039. /package/lib/screenplay/{actor → activities}/PerformsActivities.js +0 -0
  1040. /package/lib/screenplay/{actor → artifacts}/CollectsArtifacts.js +0 -0
  1041. /package/lib/screenplay/{actor → questions}/AnswersQuestions.js +0 -0
@@ -0,0 +1,317 @@
1
+ import { JSONObject } from 'tiny-types';
2
+
3
+ import { commaSeparated } from '../../io';
4
+ import { UsesAbilities } from '../abilities';
5
+ import { Answerable } from '../Answerable';
6
+ import { Interaction } from '../Interaction';
7
+ import { Question, QuestionAdapter } from '../Question';
8
+ import { AnswersQuestions } from '../questions';
9
+ import { ChainableSetter } from './ChainableSetter';
10
+ import { TakeNotes } from './TakeNotes';
11
+
12
+ /**
13
+ * Serenity/JS Screenplay Pattern-style adapter for the {@apilink Notepad},
14
+ * that makes it easier for the {@apilink Actor|actors} to access its APIs.
15
+ *
16
+ * See {@apilink TakeNotes}, {@apilink Notepad} and {@apilink notes} for more examples.
17
+ *
18
+ * @group Notes
19
+ */
20
+ export class NotepadAdapter<Notes extends Record<any, any>> implements ChainableSetter<Notes> {
21
+
22
+ /**
23
+ * Checks if a note identified by `subject` exists in the notepad.
24
+ *
25
+ * #### Learn more
26
+ * - {@apilink Notepad.has}
27
+ *
28
+ * @param subject
29
+ * A subject (name) that uniquely identifies a given note
30
+ *
31
+ * @returns
32
+ * Question that resolves to `true` if the note exists, `false` otherwise
33
+ */
34
+ has<Subject extends keyof Notes>(subject: Subject): QuestionAdapter<boolean> {
35
+ return Question.about(`a note of ${ String(subject) } exists`, actor => {
36
+ return TakeNotes.as(actor).notepad.has(subject);
37
+ });
38
+ }
39
+
40
+ /**
41
+ * Retrieves a note, identified by `subject`, from the notepad.
42
+ *
43
+ * #### Learn more
44
+ * - {@apilink Notepad.get}
45
+ *
46
+ * @param subject
47
+ * A subject (name) that uniquely identifies a given note
48
+ *
49
+ * @returns
50
+ * The value of the previously recorded note.
51
+ *
52
+ * @throws {LogicError}
53
+ * Throws a {@apilink LogicError} if the note with a given `subject`
54
+ * has never been recorded.
55
+ */
56
+ get<Subject extends keyof Notes>(subject: Subject): QuestionAdapter<Notes[Subject]> {
57
+ return Question.about(`a note of ${ String(subject) }`, actor => {
58
+ return TakeNotes.as(actor).notepad.get(subject);
59
+ });
60
+ }
61
+
62
+ /**
63
+ * Resolves a given `Answerable<value>` and stores it in the notepad,
64
+ * uniquely identified by its `subject`.
65
+ *
66
+ * **Pro tip:** calls to `set` can be chained and result in an accumulation
67
+ * of values to be recorded in the {@apilink Notepad}.
68
+ * Those values are resolved and recorded when the {@apilink Interaction}
69
+ * returned by this method is performed by an {@apilink Actor}.
70
+ *
71
+ * If a note identified by a given `subject` is set multiple times,
72
+ * the last call wins.
73
+ *
74
+ * ```ts
75
+ * import { actorCalled, notes, TakeNotes } from '@serenity-js/core'
76
+ * import { Ensure, equals } from '@serenity-js/assertions'
77
+ *
78
+ * interface MyNotes {
79
+ * stringNote: string;
80
+ * numberNote: number;
81
+ * }
82
+ *
83
+ * await actorCalled('Alice')
84
+ * .whoCan(TakeNotes.usingAnEmptyNotepad<MyNotes>());
85
+ * .attemptsTo(
86
+ *
87
+ * notes<MyNotes>()
88
+ * .set('stringNote', 'example')
89
+ * .set('numberNote', Promise.resolve(42))
90
+ * .set('stringNote', 'another example'),
91
+ *
92
+ * Ensure.equal(notes().toJSON(), {
93
+ * firstNote: 'another example',
94
+ * secondNote: 42,
95
+ * })
96
+ * )
97
+ * ```
98
+ *
99
+ * #### Learn more
100
+ * - {@apilink Notepad.set}
101
+ *
102
+ * @param subject
103
+ * A subject (name) that uniquely identifies a given note
104
+ *
105
+ * @param value
106
+ * The value to record
107
+ */
108
+ set<Subject extends keyof Notes>(subject: Subject, value: Answerable<Notes[Subject]>): ChainableSetter<Notes> & Interaction {
109
+ return new ChainableNoteSetter<Notes>({ [subject]: value } as NotesToSet<Notes>);
110
+ }
111
+
112
+ /**
113
+ * Removes the note identified by `subject` from the notepad.
114
+ *
115
+ * #### Using as an `Interaction`
116
+ *
117
+ * ```ts
118
+ * import { actorCalled, Check, Log, notes } from '@serenity-js/core'
119
+ * import { isPresent } from '@serenity-js/assertions'
120
+ *
121
+ * interface MyNotes {
122
+ * myNote: string;
123
+ * }
124
+ *
125
+ * await actorCalled('Alice')
126
+ * .whoCan(TakeNotes.using(Notepad.empty<MyNotes>()))
127
+ * .attemptsTo(
128
+ * notes<MyNotes>().set('myNote', 'example value'),
129
+ *
130
+ * notes<MyNotes>().delete('myNote'),
131
+ *
132
+ * Check.whether(notes<MyNotes>().get('myNote'), isPresent())
133
+ * .andIfSo(
134
+ * Log.the('myNote is present'),
135
+ * )
136
+ * .otherwise(
137
+ * Log.the('myNote was deleted'),
138
+ * )
139
+ * )
140
+ * // logs: myNote was deleted
141
+ * ```
142
+ *
143
+ * #### Using as a `Question`
144
+ *
145
+ * ```ts
146
+ * import { actorCalled, Check, Log, notes } from '@serenity-js/core'
147
+ * import { isTrue } from '@serenity-js/assertions'
148
+ *
149
+ * interface MyNotes {
150
+ * myNote: string;
151
+ * }
152
+ *
153
+ * await actorCalled('Alice')
154
+ * .whoCan(TakeNotes.using(Notepad.empty<MyNotes>()))
155
+ * .attemptsTo(
156
+ * notes<MyNotes>().set('myNote', 'example value'),
157
+ *
158
+ * Check.whether(notes<MyNotes>().delete('myNote'), isTrue())
159
+ * .andIfSo(
160
+ * Log.the('myNote was deleted'),
161
+ * )
162
+ * .otherwise(
163
+ * Log.the('myNote could not be deleted because it was not set'),
164
+ * )
165
+ * )
166
+ * // logs: myNote was deleted
167
+ * ```
168
+ *
169
+ * #### Learn more
170
+ * - {@apilink Notepad.delete}
171
+ *
172
+ * @param subject
173
+ *
174
+ * @returns
175
+ * When used as a `Question`, resolves to `true` if the item in the Notepad object existed and has been removed,
176
+ * `false` otherwise.
177
+ */
178
+ delete<Subject extends keyof Notes>(subject: Subject): QuestionAdapter<boolean> {
179
+ return Question.about(`#actor deletes a note of ${ String(subject) }`, actor => {
180
+ return TakeNotes.as(actor).notepad.delete(subject);
181
+ });
182
+ }
183
+
184
+ /**
185
+ * Deletes all the notes stored in this notepad.
186
+ *
187
+ * ```ts
188
+ * import { actorCalled, notes } from '@serenity-js/core'
189
+ * import { isTrue } from '@serenity-js/assertions'
190
+ *
191
+ * interface MyNotes {
192
+ * myNote: string;
193
+ * }
194
+ *
195
+ * await actorCalled('Alice')
196
+ * .whoCan(TakeNotes.using(Notepad.empty<MyNotes>()))
197
+ * .attemptsTo(
198
+ * notes<MyNotes>().set('myNote', 'example value'),
199
+ * Log.the(notes<MyNotes>().size()), // emits 1
200
+ * notes<MyNotes>().clear(),
201
+ * Log.the(notes<MyNotes>().size()), // emits 0
202
+ * )
203
+ * ```
204
+ *
205
+ * #### Learn more
206
+ * - {@apilink Notepad.clear}
207
+ */
208
+ clear(): Interaction {
209
+ return Interaction.where('#actor clears their notepad', actor => {
210
+ return TakeNotes.as(actor).notepad.clear();
211
+ });
212
+ }
213
+
214
+ /**
215
+ * Returns the number of notes stored in the notepad.
216
+ *
217
+ * ```ts
218
+ * import { actorCalled, notes } from '@serenity-js/core'
219
+ * import { isTrue } from '@serenity-js/assertions'
220
+ *
221
+ * interface MyNotes {
222
+ * myNote: string;
223
+ * }
224
+ *
225
+ * await actorCalled('Alice')
226
+ * .whoCan(TakeNotes.using(Notepad.empty<MyNotes>()))
227
+ * .attemptsTo(
228
+ * Log.the(notes<MyNotes>().size()), // emits 0
229
+ * notes<MyNotes>().set('myNote', 'example value'),
230
+ * Log.the(notes<MyNotes>().size()), // emits 1
231
+ * )
232
+ * ```
233
+ *
234
+ * #### Learn more
235
+ * - {@apilink Notepad.size}
236
+ */
237
+ size(): QuestionAdapter<number> {
238
+ return Question.about('number of notes', async actor => {
239
+ return TakeNotes.as(actor).notepad.size();
240
+ });
241
+ }
242
+
243
+ /**
244
+ * Produces a {@apilink QuestionAdapter} that resolves to a `JSONObject`
245
+ * representing the resolved notes stored in the notepad.
246
+ *
247
+ * Note that serialisation to JSON will simplify some data types that might not be serialisable by default,
248
+ * but are commonly used in data structures representing actor's notes.
249
+ * For example a {@apilink Map} will be serialised as a regular JSON object, a {@apilink Set} will be serialised as {@apilink Array}.
250
+ *
251
+ * Additionally, notepad assumes that the data structure you use it with does not contain cyclic references.
252
+ *
253
+ * To learn more about the serialisation mechanism used by the notepad, please refer to [TinyTypes documentation](https://jan-molak.github.io/tiny-types/).
254
+ *
255
+ * ```ts
256
+ * import { actorCalled, notes } from '@serenity-js/core'
257
+ *
258
+ * await actorCalled('Alice')
259
+ * .whoCan(TakeNotes.using(Notepad.with({
260
+ * aSet: new Set(['apples', 'bananas', 'cucumbers']),
261
+ * aPromisedValue: Promise.resolve(42),
262
+ * aString: 'example'
263
+ * })))
264
+ * .attemptsTo(
265
+ * Log.the(notes().toJSON()),
266
+ * )
267
+ * // emits: {
268
+ * // aSet: ['apples', 'bananas', 'cucumbers']
269
+ * // aPromisedValue: 42,
270
+ * // aString: 'example',
271
+ * // }
272
+ * ```
273
+ */
274
+ toJSON(): QuestionAdapter<JSONObject> {
275
+ return Question.about('notepad serialised to JSON', async actor => {
276
+ return TakeNotes.as(actor).notepad.toJSON() as JSONObject;
277
+ });
278
+ }
279
+
280
+ /**
281
+ * @inheritDoc
282
+ */
283
+ toString(): string {
284
+ return 'notes';
285
+ }
286
+ }
287
+
288
+ type NotesToSet<Notes extends Record<any, any>> = {
289
+ [Subject in keyof Notes]?: Answerable<Notes[Subject]>
290
+ }
291
+
292
+ /**
293
+ * @package
294
+ */
295
+ class ChainableNoteSetter<Notes extends Record<any, any>> extends Interaction implements ChainableSetter<Notes> {
296
+
297
+ constructor(private readonly notes: NotesToSet<Notes>) {
298
+ super(`#actor takes note of ${ commaSeparated(Object.keys(notes)) }`);
299
+ }
300
+
301
+ set<K extends keyof Notes>(subject: K, value: Answerable<Notes[K]>): ChainableSetter<Notes> & Interaction {
302
+ return new ChainableNoteSetter({
303
+ ...this.notes,
304
+ [subject]: value,
305
+ } as NotesToSet<Notes>)
306
+ }
307
+
308
+ async performAs(actor: AnswersQuestions & UsesAbilities): Promise<void> {
309
+
310
+ const notepad = TakeNotes.as(actor).notepad;
311
+
312
+ for (const [ subject, value ] of Object.entries(this.notes)) {
313
+ const answer = await actor.answer(value);
314
+ notepad.set(subject, answer);
315
+ }
316
+ }
317
+ }
@@ -0,0 +1,257 @@
1
+ import { Ability } from '../abilities';
2
+ import { Notepad } from './Notepad';
3
+
4
+ /**
5
+ * An {@apilink Ability} that enables an {@apilink Actor} to remember information
6
+ * to be recalled during a test scenario.
7
+ *
8
+ * Under the hood, {@apilink TakeNotes} uses a {@apilink Notepad}, which state
9
+ * can be populated both during initialisation or while the test scenario is executed.
10
+ * Populating the notepad when it's initialised can be useful to associate authentication credentials
11
+ * or personal details with a given actor, while dynamic recording of notes during a test scenario
12
+ * can be useful when the data to be recorded is not known upfront - for example when we want
13
+ * the actor to remember a JWT stored in the browser and then use it when sending API requests.
14
+ *
15
+ * **Pro tip:** {@apilink TakeNotes}, {@apilink Notepad} and {@apilink notes} can be typed
16
+ * using [TypeScript generics](https://www.typescriptlang.org/docs/handbook/2/generics.html)
17
+ * to help you avoid typos when specifying note names.
18
+ *
19
+ * See [notes](/api/core/function/notes) and {@apilink Notepad} for more usage examples.
20
+ *
21
+ * ## Remembering and retrieving a value
22
+ *
23
+ * ```ts
24
+ * import { actorCalled, Log, notes, TakeNotes } from '@serenity-js/core'
25
+ *
26
+ * await actorCalled('Leonard')
27
+ * .whoCan(TakeNotes.usingAnEmptyNotepad())
28
+ * .attemptsTo(
29
+ * notes().set('my_note', 'some value'),
30
+ * Log.the(notes().get('my_note')),
31
+ * // emits 'some value'
32
+ * )
33
+ * ```
34
+ *
35
+ * ## Using generics
36
+ *
37
+ * ```ts
38
+ * import { actorCalled, Log, notes, TakeNotes } from '@serenity-js/core'
39
+ *
40
+ * interface MyNotes {
41
+ * personalDetails: {
42
+ * firstName: string;
43
+ * lastName: string;
44
+ * }
45
+ * }
46
+ *
47
+ * await actorCalled('Leonard')
48
+ * .whoCan(TakeNotes.usingAnEmptyNotepad<MyNotes>())
49
+ * .attemptsTo(
50
+ * Log.the(notes<MyNotes>().has('personalDetails')),
51
+ * // emits false
52
+ *
53
+ * Log.the(notes<MyNotes>().get('personalDetails').isPresent()),
54
+ * // emits false
55
+ *
56
+ * notes<MyNotes>().set('personalDetails', { firstName: 'Leonard', lastName: 'McLaud' }),
57
+ *
58
+ * Log.the(notes<MyNotes>().has('personalDetails')),
59
+ * // emits true
60
+ *
61
+ * Log.the(notes<MyNotes>().get('personalDetails').isPresent()),
62
+ * // emits true
63
+ *
64
+ * Log.the(notes().get('personalDetails').firstName),
65
+ * // emits 'Leonard'
66
+ *
67
+ * Log.the(notes().get('personalDetails').firstName.toLocaleUpperCase()),
68
+ * // emits 'LEONARD'
69
+ * )
70
+ * ```
71
+ *
72
+ * ## Populating the notepad with initial state
73
+ *
74
+ * ```ts
75
+ * import { actorCalled, Log, Note, Notepad, TakeNotes } from '@serenity-js/core'
76
+ *
77
+ * interface MyNotes {
78
+ * firstName: string;
79
+ * lastName: string;
80
+ * }
81
+ *
82
+ * await actorCalled('Leonard')
83
+ * .whoCan(
84
+ * TakeNotes.using(Notepad.with<MyNotes>({
85
+ * firstName: 'Leonard',
86
+ * lastName: 'McLaud',
87
+ * }))
88
+ * )
89
+ * .attemptsTo(
90
+ * notes<MyNotes>().set('lastName', 'Shelby'),
91
+ * Log.the(notes().get('firstName')),
92
+ * // emits 'Leonard'
93
+ *
94
+ * Log.the(notes().get('lastName')),
95
+ * // emits 'Shelby'
96
+ * )
97
+ * ```
98
+ *
99
+ * ## Recording a dynamic note
100
+ *
101
+ * ```ts
102
+ * import { actorCalled, Log, Notepad, notes, TakeNotes } from '@serenity-js/core'
103
+ * import { By, Text, PageElement } from '@serenity-js/web'
104
+ * import { BrowseTheWebWithWebdriverIO } from '@serenity-js/webdriverio'
105
+ *
106
+ * interface OnlineShoppingNotes {
107
+ * promoCode: string;
108
+ * }
109
+ *
110
+ * const promoCodeBanner = () =>
111
+ * PageElement.located(By.css('[data-testid="promo-code"]'))
112
+ * .describedAs('promo code');
113
+ *
114
+ * const promoCodeInput = () =>
115
+ * PageElement.located(By.css('[data-testid="promo-code-input"]'))
116
+ * .describedAs('promo code field');
117
+ *
118
+ * await actorCalled('Leonard')
119
+ * .whoCan(
120
+ * BrowseTheWebWithWebdriverIO.using(browser),
121
+ * TakeNotes.using(Notepad.empty<OnlineShoppingNotes>())
122
+ * )
123
+ * .attemptsTo(
124
+ * notes<OnlineShoppingNotes>().set('promoCode', Text.of(promoCode()),
125
+ * // ...
126
+ * Enter.theValue(notes<OnlineShoppingNotes>().get('promoCode'))
127
+ * .into(promoCodeInput())
128
+ * )
129
+ * ```
130
+ *
131
+ * ## Clearing a notepad before each test scenario (Mocha)
132
+ *
133
+ * ```ts
134
+ * import 'mocha';
135
+ *
136
+ * beforeEach(() =>
137
+ * actorCalled('Leonard')
138
+ * .attemptsTo(
139
+ * notes().clear(),
140
+ * ))
141
+ * ```
142
+ *
143
+ * ## Clearing a notepad before each test scenario (Cucumber)
144
+ *
145
+ * ```ts
146
+ * import { Before } from '@cucumber/cucumber'
147
+ *
148
+ * Before(() =>
149
+ * actorCalled('Leonard')
150
+ * .attemptsTo(
151
+ * notes().clear(),
152
+ * ));
153
+ * ```
154
+ *
155
+ * ## Importing notes from an API response
156
+ *
157
+ * ```ts
158
+ * // given an example API:
159
+ * // GET /generate-test-user
160
+ * // which returns:
161
+ * // { "first_name": "Leonard", "last_name": "Shelby" }
162
+ *
163
+ * import { actorCalled, Log, Notepad, notes, TakeNotes } from '@serenity-js/core'
164
+ * import { CallAnApi, GetRequest, Send } from '@serenity-js/rest'
165
+ *
166
+ * interface PersonalDetails {
167
+ * first_name: string;
168
+ * last_name: string;
169
+ * }
170
+ *
171
+ * interface MyNotes {
172
+ * personalDetails?: PersonalDetails;
173
+ * }
174
+ *
175
+ * await actorCalled('Leonard')
176
+ * .whoCan(
177
+ * CallAnApi.at('https://api.example.org/'),
178
+ * TakeNotes.using(Notepad.empty<MyNotes>())
179
+ * )
180
+ * .attemptsTo(
181
+ * Send.a(GetRequest.to('/generate-test-user')),
182
+ * notes<MyNotes>().set('personalDetails', LastResponse.body<PersonalDetails>()),
183
+ *
184
+ * Log.the(notes<MyNotes>().get('personalDetails').first_name), // emits 'Leonard'
185
+ * Log.the(notes<MyNotes>().get('personalDetails').last_name), // emits 'Shelby'
186
+ * )
187
+ * ```
188
+ *
189
+ * ## Using the QuestionAdapter
190
+ *
191
+ * ```ts
192
+ * import { actorCalled, Log, Notepad, notes, TakeNotes } from '@serenity-js/core'
193
+ *
194
+ * interface AuthCredentials {
195
+ * username?: string;
196
+ * password?: string;
197
+ * }
198
+ *
199
+ * interface MyNotes {
200
+ * auth: AuthCredentials;
201
+ * }
202
+ *
203
+ * await actorCalled('Leonard')
204
+ * .whoCan(
205
+ * TakeNotes.using(
206
+ * Notepad.with<MyNotes>({ // typed initial state
207
+ * auth: {
208
+ * username: 'leonard@example.org',
209
+ * password: 'SuperSecretP@ssword!',
210
+ * }
211
+ * })
212
+ * )
213
+ * )
214
+ * .attemptsTo(
215
+ * Log.the(
216
+ * notes<MyNotes>() // typed notes
217
+ * .get('auth') // returns QuestionAdapter<AuthCredentials>
218
+ * .password // returns QuestionAdapter<string>
219
+ * .charAt(0)
220
+ * .toLocaleLowerCase(), // emits "s"
221
+ * ),
222
+ * )
223
+ * ```
224
+ *
225
+ * ## Learn more
226
+ *
227
+ * - [notes](/api/core/function/notes)
228
+ * - {@apilink Notepad}
229
+ *
230
+ * @group Notes
231
+ */
232
+ export class TakeNotes<Notes_Type extends Record<any, any>> extends Ability {
233
+
234
+ /**
235
+ * Initialises an {@apilink Ability} to {@apilink TakeNotes} with {@apilink Notepad.empty}.
236
+ */
237
+ static usingAnEmptyNotepad<N extends Record<any, any>>(): TakeNotes<N> {
238
+ return TakeNotes.using<N>(Notepad.empty<N>());
239
+ }
240
+
241
+ /**
242
+ * Initialises an {@apilink Ability} to {@apilink TakeNotes} using
243
+ * a {@apilink Notepad.with} some initial state.
244
+ *
245
+ * @param notepad
246
+ */
247
+ static using<N extends Record<any, any>>(notepad: Notepad<N>): TakeNotes<N> {
248
+ return new TakeNotes<N>(notepad);
249
+ }
250
+
251
+ /**
252
+ * @param notepad
253
+ */
254
+ constructor(public readonly notepad: Notepad<Notes_Type>) {
255
+ super();
256
+ }
257
+ }
@@ -0,0 +1,5 @@
1
+ export * from './ChainableSetter';
2
+ export * from './Notepad';
3
+ export * from './NotepadAdapter';
4
+ export * from './notes';
5
+ export * from './TakeNotes';
@@ -0,0 +1,120 @@
1
+ import { Notepad } from './Notepad';
2
+ import { NotepadAdapter } from './NotepadAdapter';
3
+
4
+ /**
5
+ * Alias for {@apilink Notepad.notes}.
6
+ *
7
+ * **Pro tip:** `notes<T>().get(subject)` returns a {@apilink NotepadAdapter} to make accessing the APIs
8
+ * of the underlying type easier. Check {@apilink NotepadAdapter} for more examples.
9
+ *
10
+ * ## Working with untyped notes
11
+ *
12
+ * You can use `notes<T>()` without parameterising it with an [interface](https://www.typescriptlang.org/docs/handbook/interfaces.html)
13
+ * describing the structure of your notes.
14
+ *
15
+ * **Note:** this approach _is not type-safe_ and the type-safe alternative presented below should be used in most cases.
16
+ *
17
+ * ```ts
18
+ * import { actorCalled, Log, notes, TakeNotes } from '@serenity-js/core';
19
+ *
20
+ * await actorCalled('Leonard')
21
+ * .whoCan(TakeNotes.usingAnEmptyNotepad())
22
+ * .attemptsTo(
23
+ * notes().set('my_note', 'some value'),
24
+ *
25
+ * Log.the(notes().get('my_note')),
26
+ * // emits "some value"
27
+ *
28
+ * Log.the(notes().get('my_note').toLocaleUpperCase()),
29
+ * // emits "SOME VALUE"
30
+ * );
31
+ * ```
32
+ *
33
+ * ## Working with typed notes
34
+ *
35
+ * The **recommended** way to use `notes<T>()` is to parameterise it
36
+ * with an [interface](https://www.typescriptlang.org/docs/handbook/interfaces.html)
37
+ * describing the structure of your notes.
38
+ *
39
+ * **Note:** this approach _is type-safe_.
40
+ *
41
+ * ```ts
42
+ * import { actorCalled, Log, notes, TakeNotes } from '@serenity-js/core';
43
+ *
44
+ * interface MyNotes {
45
+ * username: string;
46
+ * token?: string; // optional value
47
+ * }
48
+ *
49
+ * await actorCalled('Leonard')
50
+ * .whoCan(TakeNotes.using(Notepad.with<MyNotes>({
51
+ * username: 'Leonard.McLaud@example.org',
52
+ * }))
53
+ * .attemptsTo(
54
+ * notes<MyNotes>().set('token', 'my-auth-token')
55
+ *
56
+ * Log.the(notes<MyNotes>().get('token').length),
57
+ * // emits 13
58
+ *
59
+ * Log.the(notes<MyNotes>().get('username').toLocaleLowerCase()),
60
+ * // emits 'leonard.mclaud@example.org'
61
+ * )
62
+ * ```
63
+ *
64
+ * ## Checking if a note is present
65
+ *
66
+ * ```ts
67
+ * import { actorCalled, Check, notes, TakeNotes } from '@serenity-js/core'
68
+ * import { isPresent } from '@serenity-js/assertions'
69
+ *
70
+ * await actorCalled('Leonard')
71
+ * .whoCan(TakeNotes.using(Notepad.empty()))
72
+ * .attemptsTo(
73
+ * Check.whether(notes().get('token'), isPresent())
74
+ * .andIfSo(
75
+ * Authenticate.using(notes().get('token')),
76
+ * )
77
+ * .otherwise(
78
+ * SignIn.using('username', 'password'),
79
+ * )
80
+ * )
81
+ * ```
82
+ *
83
+ * ## Working with complex data structures
84
+ *
85
+ * ```ts
86
+ * import { actorCalled, Log, notes, TakeNotes } from '@serenity-js/core'
87
+ *
88
+ * interface MyNotes {
89
+ * recordedItems: string[];
90
+ * }
91
+ *
92
+ * await actorCalled('Leonard')
93
+ * .whoCan(TakeNotes.using(Notepad.with<MyNotes>({
94
+ * recordedItems: [],
95
+ * }))
96
+ * .attemptsTo(
97
+ * // push 3 items
98
+ * notes().get('recordedItems').push('apples'),
99
+ * notes().get('recordedItems').push('cucumbers'),
100
+ * notes().get('recordedItems').push('bananas'),
101
+ *
102
+ * // use QuestionAdapter to access Array.sort()
103
+ * notes().get('recordedItems').sort(),
104
+ *
105
+ * Log.the(notes().get('recordedItems')),
106
+ * // emits 'apples', 'bananas', 'cucumbers'
107
+ * )
108
+ * ```
109
+ *
110
+ * ## Learn more
111
+ *
112
+ * - {@apilink NotepadAdapter}
113
+ * - {@apilink Notepad.notes}
114
+ * - {@apilink QuestionAdapter}
115
+ *
116
+ * @group Notes
117
+ */
118
+ export function notes<N extends Record<any, any>>(): NotepadAdapter<N> {
119
+ return Notepad.notes<N>();
120
+ }