@sprucelabs/heartwood-polish 5.0.233 → 5.0.235

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 (24) hide show
  1. package/CHANGELOG.md +4 -0
  2. package/build/__tests__/behavioral/ImportingFromScript.test.js +1 -1
  3. package/build/__tests__/behavioral/Loading.test.js +1 -1
  4. package/build/__tests__/behavioral/Polishing.test.js +1 -1
  5. package/build/__tests__/behavioral/Targeting.test.js +1 -1
  6. package/build/__tests__/behavioral/assertions/AssertingDoesNotInclude.test.js +1 -1
  7. package/build/__tests__/behavioral/assertions/AssertingInputValue.test.js +1 -1
  8. package/build/__tests__/behavioral/assertions/AssertingPresentSlide.test.js +1 -1
  9. package/build/__tests__/behavioral/performingActions/AssertionAction.test.js +1 -1
  10. package/build/__tests__/behavioral/performingActions/ClearTextAction.test.js +1 -1
  11. package/build/__tests__/behavioral/performingActions/ClickAction.test.js +1 -1
  12. package/build/__tests__/behavioral/performingActions/ConfigureAction.test.js +1 -1
  13. package/build/__tests__/behavioral/performingActions/DragAndDropAction.test.js +1 -1
  14. package/build/__tests__/behavioral/performingActions/FileAction.test.js +1 -1
  15. package/build/__tests__/behavioral/performingActions/RedirectAction.test.js +1 -1
  16. package/build/__tests__/behavioral/performingActions/SelectAction.test.js +1 -1
  17. package/build/__tests__/behavioral/performingActions/TypeTextAction.test.js +1 -1
  18. package/build/__tests__/behavioral/performingActions/WaitAction.test.js +1 -1
  19. package/build/__tests__/implementation/ActionFactory.test.js +1 -1
  20. package/build/__tests__/support/SpyPage.d.ts +2 -2
  21. package/build/loading/StepLoader.js +1 -1
  22. package/build/performingActions/AssertAction.js +1 -1
  23. package/package.json +14 -14
  24. package/src/__tests__/support/SpyPage.ts +5 -1
package/CHANGELOG.md CHANGED
@@ -1,3 +1,7 @@
1
+ ## [5.0.235](https://github.com/sprucelabsai/heartwood-polish/compare/v5.0.234...v5.0.235) (2023-06-02)
2
+
3
+ ## [5.0.234](https://github.com/sprucelabsai/heartwood-polish/compare/v5.0.233...v5.0.234) (2023-05-31)
4
+
1
5
  ## [5.0.233](https://github.com/sprucelabsai/heartwood-polish/compare/v5.0.232...v5.0.233) (2023-05-31)
2
6
 
3
7
  ## [5.0.232](https://github.com/sprucelabsai/heartwood-polish/compare/v5.0.231...v5.0.232) (2023-05-30)
@@ -97,6 +97,7 @@ class ImportingFromScriptTest extends AbstractPolishTest_1.default {
97
97
  return this.generator.generate(script);
98
98
  }
99
99
  }
100
+ exports.default = ImportingFromScriptTest;
100
101
  __decorate([
101
102
  (0, test_utils_1.test)()
102
103
  ], ImportingFromScriptTest, "generatesSingleStepWithRedirect", null);
@@ -115,4 +116,3 @@ __decorate([
115
116
  __decorate([
116
117
  (0, test_utils_1.test)()
117
118
  ], ImportingFromScriptTest, "canGenerateMultipleActions", null);
118
- exports.default = ImportingFromScriptTest;
@@ -136,6 +136,7 @@ class LoadingTest extends test_utils_1.default {
136
136
  return spruce_skill_utils_1.diskUtil.resolvePath(this.loaderCwd, 'package.json');
137
137
  }
138
138
  }
139
+ exports.default = LoadingTest;
139
140
  __decorate([
140
141
  (0, test_utils_1.test)()
141
142
  ], LoadingTest, "throwsWhenMissingRequired", null);
@@ -187,7 +188,6 @@ __decorate([
187
188
  },
188
189
  ])
189
190
  ], LoadingTest, "canLoadStepsFromAlternativeFile", null);
190
- exports.default = LoadingTest;
191
191
  class SpyStepLoader extends StepLoader_1.StepLoader {
192
192
  getPolishFile() {
193
193
  return this.polishFile;
@@ -150,6 +150,7 @@ class PolishingTest extends AbstractPolishTest_1.default {
150
150
  }) }, options));
151
151
  }
152
152
  }
153
+ exports.default = PolishingTest;
153
154
  __decorate([
154
155
  (0, test_utils_1.test)()
155
156
  ], PolishingTest, "throwsWhenMissingRequired", null);
@@ -201,7 +202,6 @@ __decorate([
201
202
  __decorate([
202
203
  (0, test_utils_1.test)()
203
204
  ], PolishingTest, "targetingToolWaitsForVisibleBelt", null);
204
- exports.default = PolishingTest;
205
205
  class SpyPolisherStep {
206
206
  constructor() {
207
207
  this.wasGoInvoked = false;
@@ -112,6 +112,7 @@ TargetingTest.expectedComponentToSelectorMap = {
112
112
  CalendarEventNDrag: '.resize-n',
113
113
  CalendarDay: '.days li',
114
114
  };
115
+ exports.default = TargetingTest;
115
116
  __decorate([
116
117
  (0, test_utils_1.test)()
117
118
  ], TargetingTest, "throwsWithBadTarget", null);
@@ -150,4 +151,3 @@ __decorate([
150
151
  __decorate([
151
152
  (0, test_utils_1.test)()
152
153
  ], TargetingTest, "canGenerateForMultipleTargetItems", null);
153
- exports.default = TargetingTest;
@@ -47,6 +47,7 @@ class AssertingDoesNotIncludeTest extends AbstractAssertTest_1.default {
47
47
  return this.action.go();
48
48
  }
49
49
  }
50
+ exports.default = AssertingDoesNotIncludeTest;
50
51
  __decorate([
51
52
  (0, test_utils_1.test)()
52
53
  ], AssertingDoesNotIncludeTest, "canCreateAssertingDoesNotInclude", null);
@@ -61,4 +62,3 @@ __decorate([
61
62
  (0, test_utils_1.test)('selectorEqualsExpected 2', ['Tool'], '.tool'),
62
63
  (0, test_utils_1.test)('selectorEqualsExpected 3', ['Dialog', ['Field', 'title']], '.dialog [name="title"]')
63
64
  ], AssertingDoesNotIncludeTest, "selectorEqualsExpected", null);
64
- exports.default = AssertingDoesNotIncludeTest;
@@ -82,6 +82,7 @@ class AssertingInputValueTest extends AbstractAssertTest_1.default {
82
82
  return this.action.go();
83
83
  }
84
84
  }
85
+ exports.default = AssertingInputValueTest;
85
86
  __decorate([
86
87
  (0, test_utils_1.test)()
87
88
  ], AssertingInputValueTest, "canCreateAssertingInputValue", null);
@@ -111,4 +112,3 @@ __decorate([
111
112
  __decorate([
112
113
  (0, test_utils_1.test)()
113
114
  ], AssertingInputValueTest, "canForceGetPropertyResponse", null);
114
- exports.default = AssertingInputValueTest;
@@ -82,6 +82,7 @@ class AssertingPresentSlideTest extends AbstractAssertTest_1.default {
82
82
  return this.action.go();
83
83
  }
84
84
  }
85
+ exports.default = AssertingPresentSlideTest;
85
86
  __decorate([
86
87
  (0, test_utils_1.test)()
87
88
  ], AssertingPresentSlideTest, "canCreateAssertPresentSlide", null);
@@ -112,4 +113,3 @@ __decorate([
112
113
  __decorate([
113
114
  (0, test_utils_1.test)()
114
115
  ], AssertingPresentSlideTest, "throwsWhenNeitherAssertionIsSet", null);
115
- exports.default = AssertingPresentSlideTest;
@@ -66,6 +66,7 @@ class AssertionActionTest extends AbstractActionTest_1.default {
66
66
  test_utils_1.assert.isEqualDeep(passedOptions, Object.assign(Object.assign({}, options), { targetSelector: selector, originalTarget: target, page: this.spyPage, getProperty: passedOptions.getProperty, getInnerHtml: passedOptions.getInnerHtml }));
67
67
  }
68
68
  }
69
+ exports.default = AssertionActionTest;
69
70
  __decorate([
70
71
  (0, test_utils_1.test)('throws with bad key 1', 'waka'),
71
72
  (0, test_utils_1.test)('throws with bad key 2', 'taco')
@@ -78,4 +79,3 @@ __decorate([
78
79
  (0, test_utils_1.test)('can do assertion 2', 'another'),
79
80
  (0, test_utils_1.test)('can do assertion 3', 'test', ['Button'])
80
81
  ], AssertionActionTest, "canFeedInAssertions", null);
81
- exports.default = AssertionActionTest;
@@ -38,6 +38,7 @@ class ClearTextActionTest extends AbstractActionTest_1.default {
38
38
  this.action.process({ target });
39
39
  }
40
40
  }
41
+ exports.default = ClearTextActionTest;
41
42
  __decorate([
42
43
  (0, test_utils_1.test)('processingSetupsUpAction 1', ['Card']),
43
44
  (0, test_utils_1.test)('processingSetupsUpAction 2', ['ToolBelt'])
@@ -45,7 +46,6 @@ __decorate([
45
46
  __decorate([
46
47
  (0, test_utils_1.test)('can clear text 1', [['Field', 'name']])
47
48
  ], ClearTextActionTest, "canClearText", null);
48
- exports.default = ClearTextActionTest;
49
49
  class SpyClearTextAction extends ClearTextAction_1.ClearTextAction {
50
50
  getSelector() {
51
51
  return this.target;
@@ -59,6 +59,7 @@ class ClickActionTest extends AbstractActionTest_1.default {
59
59
  this.action.process({ target });
60
60
  }
61
61
  }
62
+ exports.default = ClickActionTest;
62
63
  __decorate([
63
64
  (0, test_utils_1.test)('processingSetsUpAction 1', ['Button']),
64
65
  (0, test_utils_1.test)('processingSetsUpAction 2', ['Card'])
@@ -76,7 +77,6 @@ __decorate([
76
77
  __decorate([
77
78
  (0, test_utils_1.test)()
78
79
  ], ClickActionTest, "doesNotWaitForToolBeltIfNotTargettingToolBelt", null);
79
- exports.default = ClickActionTest;
80
80
  class SpyClickAction extends ClickAction_1.default {
81
81
  getSelector() {
82
82
  return this.targetSelector;
@@ -37,6 +37,7 @@ class ConfigureActionTest extends AbstractActionTest_1.default {
37
37
  test_utils_1.assert.isEqual(polisher.getStepWaitMs(), waitMs);
38
38
  }
39
39
  }
40
+ exports.default = ConfigureActionTest;
40
41
  __decorate([
41
42
  (0, test_utils_1.test)()
42
43
  ], ConfigureActionTest, "canCreateConfigureAction", null);
@@ -47,4 +48,3 @@ __decorate([
47
48
  (0, test_utils_1.test)('can set wait on polisher to 100', 100),
48
49
  (0, test_utils_1.test)('can set wait on polisher to 200', 200)
49
50
  ], ConfigureActionTest, "setsStepWaitOnPolisher", null);
50
- exports.default = ConfigureActionTest;
@@ -89,6 +89,7 @@ class DragAndDropActionTest extends AbstractActionTest_1.default {
89
89
  return this.sourceAndDestination[1].box;
90
90
  }
91
91
  }
92
+ exports.default = DragAndDropActionTest;
92
93
  __decorate([
93
94
  (0, test_utils_1.test)()
94
95
  ], DragAndDropActionTest, "canCreateDragAndDropAction", null);
@@ -109,7 +110,6 @@ __decorate([
109
110
  __decorate([
110
111
  (0, test_utils_1.test)()
111
112
  ], DragAndDropActionTest, "callsMoveClickMoveInOrder", null);
112
- exports.default = DragAndDropActionTest;
113
113
  class BoundingBoxElementHandle extends SpyElementHandle_1.default {
114
114
  constructor() {
115
115
  super(...arguments);
@@ -43,6 +43,7 @@ class FileActionTest extends AbstractActionTest_1.default {
43
43
  });
44
44
  }
45
45
  }
46
+ exports.default = FileActionTest;
46
47
  __decorate([
47
48
  (0, test_utils_1.test)()
48
49
  ], FileActionTest, "canCreateFileAction", null);
@@ -56,4 +57,3 @@ __decorate([
56
57
  __decorate([
57
58
  (0, test_utils_1.test)()
58
59
  ], FileActionTest, "usesTheElementReturnedFrom$ToUploadFile", null);
59
- exports.default = FileActionTest;
@@ -59,6 +59,7 @@ class RedirectActionsTest extends AbstractActionTest_1.default {
59
59
  return this.Action('redirect');
60
60
  }
61
61
  }
62
+ exports.default = RedirectActionsTest;
62
63
  __decorate([
63
64
  (0, test_utils_1.test)()
64
65
  ], RedirectActionsTest, "abstractThrowsWhenMissingPage", null);
@@ -68,4 +69,3 @@ __decorate([
68
69
  __decorate([
69
70
  (0, test_utils_1.test)()
70
71
  ], RedirectActionsTest, "redirectControlsPage", null);
71
- exports.default = RedirectActionsTest;
@@ -41,6 +41,7 @@ class SelectActionTest extends AbstractActionTest_1.default {
41
41
  test_utils_1.assert.isEqual(options.value, value);
42
42
  }
43
43
  }
44
+ exports.default = SelectActionTest;
44
45
  __decorate([
45
46
  (0, test_utils_1.test)()
46
47
  ], SelectActionTest, "canCreateConfigureAction", null);
@@ -54,4 +55,3 @@ __decorate([
54
55
  ['Field', 'name'],
55
56
  ])
56
57
  ], SelectActionTest, "selectsOnPageWithSimpleSelector", null);
57
- exports.default = SelectActionTest;
@@ -79,6 +79,7 @@ class TypeTextActionTest extends AbstractActionTest_1.default {
79
79
  await this.action.go();
80
80
  }
81
81
  }
82
+ exports.default = TypeTextActionTest;
82
83
  __decorate([
83
84
  (0, test_utils_1.test)('processingSetupsUpAction 1', ['Card']),
84
85
  (0, test_utils_1.test)('processingSetupsUpAction 2', ['ToolBelt'])
@@ -96,7 +97,6 @@ __decorate([
96
97
  __decorate([
97
98
  (0, test_utils_1.test)()
98
99
  ], TypeTextActionTest, "evaluateClearedCalledBeforeType", null);
99
- exports.default = TypeTextActionTest;
100
100
  class SpyTypeTextAction extends TypeTextAction_1.TypeTextAction {
101
101
  getSelector() {
102
102
  return this.selector;
@@ -28,6 +28,7 @@ class WaitActionTest extends AbstractActionTest_1.default {
28
28
  test_utils_1.assert.isEqual(this.spyPage.lastWaitForTimeout, wait);
29
29
  }
30
30
  }
31
+ exports.default = WaitActionTest;
31
32
  __decorate([
32
33
  (0, test_utils_1.test)()
33
34
  ], WaitActionTest, "isInstanceOfWait", null);
@@ -35,4 +36,3 @@ __decorate([
35
36
  (0, test_utils_1.test)('can wait 100 ms', 100),
36
37
  (0, test_utils_1.test)('can wait 250 ms', 250)
37
38
  ], WaitActionTest, "waitsForTimePassed", null);
38
- exports.default = WaitActionTest;
@@ -55,6 +55,7 @@ class ActionFactoryTest extends AbstractPolishTest_1.default {
55
55
  return this.actions.Action(name);
56
56
  }
57
57
  }
58
+ exports.default = ActionFactoryTest;
58
59
  __decorate([
59
60
  (0, test_utils_1.test)()
60
61
  ], ActionFactoryTest, "canCreateActionFactory", null);
@@ -70,4 +71,3 @@ __decorate([
70
71
  __decorate([
71
72
  (0, test_utils_1.test)()
72
73
  ], ActionFactoryTest, "actionsReceiveStartingUrl", null);
73
- exports.default = ActionFactoryTest;
@@ -3,7 +3,7 @@
3
3
  /// <reference types="node" />
4
4
  import { EventEmitter, Readable } from 'stream';
5
5
  import { Protocol } from 'devtools-protocol';
6
- import { Accessibility, Browser, BrowserContext, CDPSession, Coverage, Credentials, ElementHandle, EvaluateFunc, EventType, FileChooser, Frame, FrameWaitForFunctionOptions, GeolocationOptions, HandleFor, Handler, HTTPRequest, HTTPResponse, JSHandle, Keyboard, MediaFeature, Metrics, MouseButton, NetworkConditions, NodeFor, Page, PageEventObject, PDFOptions, ScreenshotOptions, Target, Touchscreen, Tracing, Viewport, WaitForOptions, WaitForSelectorOptions, WaitTimeoutOptions, WebWorker } from 'puppeteer';
6
+ import { Accessibility, Browser, BrowserContext, CDPSession, Coverage, Credentials, ElementHandle, EvaluateFunc, EventType, FileChooser, Frame, FrameWaitForFunctionOptions, GeolocationOptions, HandleFor, Handler, HTTPRequest, HTTPResponse, JSHandle, Keyboard, MediaFeature, Metrics, MouseButton, NetworkConditions, NewDocumentScriptEvaluation, NodeFor, Page, PageEventObject, PDFOptions, ScreenshotOptions, Target, Touchscreen, Tracing, Viewport, WaitForOptions, WaitForSelectorOptions, WaitTimeoutOptions, WebWorker } from 'puppeteer';
7
7
  import SpyElementHandle from './SpyElementHandle';
8
8
  import SpyMouse from './SpyMouse';
9
9
  export default class SpyPageImpl implements SpyPage {
@@ -131,7 +131,7 @@ export default class SpyPageImpl implements SpyPage {
131
131
  setViewport(_viewport: Viewport): Promise<void>;
132
132
  viewport(): Viewport | null;
133
133
  evaluate<Params extends unknown[], Func extends EvaluateFunc<Params> = EvaluateFunc<Params>>(cb: string | Func, ...args: Params): Promise<Awaited<ReturnType<Func>>>;
134
- evaluateOnNewDocument<Params extends unknown[], Func extends (...args: Params) => unknown = (...args: Params) => unknown>(_pageFunction: string | Func, ..._args: Params): Promise<void>;
134
+ evaluateOnNewDocument<Params extends unknown[], Func extends (...args: Params) => unknown = (...args: Params) => unknown>(_pageFunction: string | Func, ..._args: Params): Promise<NewDocumentScriptEvaluation>;
135
135
  setCacheEnabled(_enabled?: boolean | undefined): Promise<void>;
136
136
  screenshot(_options?: ScreenshotOptions | undefined): Promise<string>;
137
137
  createPDFStream(_options?: PDFOptions | undefined): Promise<Readable>;
@@ -120,6 +120,6 @@ class StepLoader {
120
120
  });
121
121
  }
122
122
  }
123
+ exports.StepLoader = StepLoader;
123
124
  StepLoader.divider = '## HEARTWOOD-POLISH DIVIDER ##';
124
125
  StepLoader.errorDivider = '## HEARTWOOD-POLISH ERROR DIVIDER ##';
125
- exports.StepLoader = StepLoader;
@@ -60,6 +60,6 @@ class AssertAction extends AbstractAction_1.default {
60
60
  return await this.page.$eval(selector, (element) => element.innerHTML);
61
61
  }
62
62
  }
63
- AssertAction.assertions = {};
64
63
  exports.AssertAction = AssertAction;
64
+ AssertAction.assertions = {};
65
65
  ActionFactory_1.default.setAction('assert', AssertAction);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sprucelabs/heartwood-polish",
3
- "version": "5.0.233",
3
+ "version": "5.0.235",
4
4
  "main": "build/index.js",
5
5
  "license": "MIT",
6
6
  "access": "public",
@@ -39,26 +39,26 @@
39
39
  "watch.tsc": "tsc -w"
40
40
  },
41
41
  "dependencies": {
42
- "@sprucelabs/error": "^5.1.4",
42
+ "@sprucelabs/error": "^5.1.7",
43
43
  "@sprucelabs/globby": "^1.0.1",
44
- "@sprucelabs/schema": "^28.6.34",
45
- "@sprucelabs/spruce-core-schemas": "^38.1.28",
46
- "@sprucelabs/spruce-skill-utils": "^29.0.19",
47
- "puppeteer": "^20.4.0",
44
+ "@sprucelabs/schema": "^28.6.37",
45
+ "@sprucelabs/spruce-core-schemas": "^38.1.34",
46
+ "@sprucelabs/spruce-skill-utils": "^29.0.23",
47
+ "puppeteer": "^20.5.0",
48
48
  "yargs": "^17.7.2"
49
49
  },
50
50
  "devDependencies": {
51
- "@sprucelabs/jest-json-reporter": "^7.0.49",
51
+ "@sprucelabs/jest-json-reporter": "^7.0.52",
52
52
  "@sprucelabs/jest-sheets-reporter": "^3.0.24",
53
- "@sprucelabs/resolve-path-aliases": "^1.1.221",
53
+ "@sprucelabs/resolve-path-aliases": "^1.1.224",
54
54
  "@sprucelabs/semantic-release": "^4.0.8",
55
- "@sprucelabs/spruce-test-fixtures": "^59.0.34",
56
- "@sprucelabs/test": "^7.7.449",
57
- "@sprucelabs/test-utils": "^3.4.63",
55
+ "@sprucelabs/spruce-test-fixtures": "^59.0.42",
56
+ "@sprucelabs/test": "^7.7.451",
57
+ "@sprucelabs/test-utils": "^3.4.66",
58
58
  "@types/node": "^20.2.5",
59
59
  "chokidar-cli": "^3.0.0",
60
- "concurrently": "^8.0.1",
61
- "devtools-protocol": "^0.0.1149535",
60
+ "concurrently": "^8.1.0",
61
+ "devtools-protocol": "^0.0.1152352",
62
62
  "eslint": "^8.41.0",
63
63
  "eslint-config-spruce": "^10.12.0",
64
64
  "jest": "^29.5.0",
@@ -67,7 +67,7 @@
67
67
  "ts-node": "^10.9.1",
68
68
  "tsc-watch": "^6.0.4",
69
69
  "tsconfig-paths": "^4.2.0",
70
- "typescript": "^5.0.4"
70
+ "typescript": "^5.1.3"
71
71
  },
72
72
  "jest": {
73
73
  "testRunner": "jest-circus/runner",
@@ -25,6 +25,7 @@ import {
25
25
  Metrics,
26
26
  MouseButton,
27
27
  NetworkConditions,
28
+ NewDocumentScriptEvaluation,
28
29
  NodeFor,
29
30
  Page,
30
31
  PageEventObject,
@@ -406,7 +407,10 @@ export default class SpyPageImpl implements SpyPage {
406
407
  public async evaluateOnNewDocument<
407
408
  Params extends unknown[],
408
409
  Func extends (...args: Params) => unknown = (...args: Params) => unknown
409
- >(_pageFunction: string | Func, ..._args: Params): Promise<void> {
410
+ >(
411
+ _pageFunction: string | Func,
412
+ ..._args: Params
413
+ ): Promise<NewDocumentScriptEvaluation> {
410
414
  return {} as any
411
415
  }
412
416