@applitools/eyes 1.33.3 → 1.33.4

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 (141) hide show
  1. package/dist/BatchClose.js +84 -0
  2. package/dist/Eyes.js +750 -0
  3. package/dist/Logger.js +122 -0
  4. package/dist/Runners.js +130 -0
  5. package/dist/SDK.js +45 -0
  6. package/dist/SessionEventHandlers.js +193 -0
  7. package/dist/cli/cli.js +56 -0
  8. package/dist/cli/load-config.js +73 -0
  9. package/dist/enums/AccessibilityGuidelinesVersion.js +9 -0
  10. package/dist/enums/AccessibilityLevel.js +9 -0
  11. package/dist/enums/AccessibilityRegionType.js +12 -0
  12. package/dist/enums/AccessibilityStatus.js +9 -0
  13. package/dist/enums/BrowserType.js +23 -0
  14. package/dist/enums/CorsIframeHandle.js +10 -0
  15. package/dist/enums/DeviceName.js +105 -0
  16. package/dist/enums/DynamicTextType.js +13 -0
  17. package/dist/enums/FailureReport.js +8 -0
  18. package/dist/enums/IosDeviceName.js +47 -0
  19. package/dist/enums/IosMultiDeviceTarget.js +30 -0
  20. package/dist/enums/IosVersion.js +10 -0
  21. package/dist/enums/MatchLevel.js +15 -0
  22. package/dist/enums/ScreenOrientation.js +8 -0
  23. package/dist/enums/SessionType.js +8 -0
  24. package/dist/enums/StitchMode.js +11 -0
  25. package/dist/enums/TestResultsStatus.js +9 -0
  26. package/dist/errors/DiffsFoundError.js +38 -0
  27. package/dist/errors/EyesError.js +6 -0
  28. package/dist/errors/NewTestError.js +38 -0
  29. package/dist/errors/TestFailedError.js +47 -0
  30. package/dist/index.js +128 -0
  31. package/dist/input/AUTProxySettings.js +2 -0
  32. package/dist/input/AccessibilityMatchSettings.js +109 -0
  33. package/dist/input/AccessibilitySettings.js +2 -0
  34. package/dist/input/BatchInfo.js +153 -0
  35. package/dist/input/CheckSettings.js +663 -0
  36. package/dist/input/Configuration.js +1179 -0
  37. package/dist/input/CutProvider.js +132 -0
  38. package/dist/input/DebugScreenshotProvider.js +2 -0
  39. package/dist/input/DensityMetrics.js +2 -0
  40. package/dist/input/ExactMatchSettings.js +102 -0
  41. package/dist/input/EyesSelector.js +2 -0
  42. package/dist/input/FloatingMatchSettings.js +152 -0
  43. package/dist/input/Image.js +2 -0
  44. package/dist/input/ImageMatchSettings.js +271 -0
  45. package/dist/input/ImageRotation.js +59 -0
  46. package/dist/input/LatestCommitInfo.js +2 -0
  47. package/dist/input/LazyLoadOptions.js +2 -0
  48. package/dist/input/Location.js +74 -0
  49. package/dist/input/LogHandler.js +90 -0
  50. package/dist/input/OCRRegion.js +2 -0
  51. package/dist/input/OCRSettings.js +2 -0
  52. package/dist/input/PropertyData.js +76 -0
  53. package/dist/input/ProxySettings.js +77 -0
  54. package/dist/input/RectangleSize.js +74 -0
  55. package/dist/input/Region.js +135 -0
  56. package/dist/input/RenderInfo.js +2 -0
  57. package/dist/input/RunnerOptions.js +56 -0
  58. package/dist/input/VisualLocatorSettings.js +2 -0
  59. package/dist/output/ApiUrls.js +102 -0
  60. package/dist/output/AppUrls.js +66 -0
  61. package/dist/output/MatchResult.js +66 -0
  62. package/dist/output/SessionUrls.js +66 -0
  63. package/dist/output/StepInfo.js +118 -0
  64. package/dist/output/TestAccessibilityStatus.js +2 -0
  65. package/dist/output/TestResultContainer.js +49 -0
  66. package/dist/output/TestResults.js +378 -0
  67. package/dist/output/TestResultsSummary.js +49 -0
  68. package/dist/output/TextRegion.js +2 -0
  69. package/dist/output/ValidationInfo.js +60 -0
  70. package/dist/output/ValidationResult.js +53 -0
  71. package/package.json +1 -1
  72. package/types/BatchClose.d.ts +23 -0
  73. package/types/Eyes.d.ts +255 -0
  74. package/types/Logger.d.ts +30 -0
  75. package/types/Runners.d.ts +41 -0
  76. package/types/SDK.d.ts +20 -0
  77. package/types/SessionEventHandlers.d.ts +78 -0
  78. package/types/cli/cli.d.ts +2 -0
  79. package/types/cli/load-config.d.ts +1 -0
  80. package/types/enums/AccessibilityGuidelinesVersion.d.ts +5 -0
  81. package/types/enums/AccessibilityLevel.d.ts +5 -0
  82. package/types/enums/AccessibilityRegionType.d.ts +8 -0
  83. package/types/enums/AccessibilityStatus.d.ts +5 -0
  84. package/types/enums/BrowserType.d.ts +20 -0
  85. package/types/enums/CorsIframeHandle.d.ts +7 -0
  86. package/types/enums/DeviceName.d.ts +101 -0
  87. package/types/enums/DynamicTextType.d.ts +9 -0
  88. package/types/enums/FailureReport.d.ts +5 -0
  89. package/types/enums/IosDeviceName.d.ts +43 -0
  90. package/types/enums/IosMultiDeviceTarget.d.ts +26 -0
  91. package/types/enums/IosVersion.d.ts +7 -0
  92. package/types/enums/MatchLevel.d.ts +12 -0
  93. package/types/enums/ScreenOrientation.d.ts +5 -0
  94. package/types/enums/SessionType.d.ts +5 -0
  95. package/types/enums/StitchMode.d.ts +8 -0
  96. package/types/enums/TestResultsStatus.d.ts +6 -0
  97. package/types/errors/DiffsFoundError.d.ts +6 -0
  98. package/types/errors/EyesError.d.ts +2 -0
  99. package/types/errors/NewTestError.d.ts +6 -0
  100. package/types/errors/TestFailedError.d.ts +9 -0
  101. package/types/index.d.ts +60 -0
  102. package/types/input/AUTProxySettings.d.ts +5 -0
  103. package/types/input/AccessibilityMatchSettings.d.ts +34 -0
  104. package/types/input/AccessibilitySettings.d.ts +6 -0
  105. package/types/input/BatchInfo.d.ts +47 -0
  106. package/types/input/CheckSettings.d.ts +266 -0
  107. package/types/input/Configuration.d.ts +437 -0
  108. package/types/input/CutProvider.d.ts +44 -0
  109. package/types/input/DebugScreenshotProvider.d.ts +5 -0
  110. package/types/input/DensityMetrics.d.ts +5 -0
  111. package/types/input/ExactMatchSettings.d.ts +34 -0
  112. package/types/input/EyesSelector.d.ts +6 -0
  113. package/types/input/FloatingMatchSettings.d.ts +50 -0
  114. package/types/input/Image.d.ts +11 -0
  115. package/types/input/ImageMatchSettings.d.ts +95 -0
  116. package/types/input/ImageRotation.d.ts +15 -0
  117. package/types/input/LatestCommitInfo.d.ts +4 -0
  118. package/types/input/LazyLoadOptions.d.ts +5 -0
  119. package/types/input/Location.d.ts +23 -0
  120. package/types/input/LogHandler.d.ts +45 -0
  121. package/types/input/OCRRegion.d.ts +9 -0
  122. package/types/input/OCRSettings.d.ts +6 -0
  123. package/types/input/PropertyData.d.ts +23 -0
  124. package/types/input/ProxySettings.d.ts +25 -0
  125. package/types/input/RectangleSize.d.ts +23 -0
  126. package/types/input/Region.d.ts +46 -0
  127. package/types/input/RenderInfo.d.ts +47 -0
  128. package/types/input/RunnerOptions.d.ts +21 -0
  129. package/types/input/VisualLocatorSettings.d.ts +4 -0
  130. package/types/output/ApiUrls.d.ts +41 -0
  131. package/types/output/AppUrls.d.ts +23 -0
  132. package/types/output/MatchResult.d.ts +23 -0
  133. package/types/output/SessionUrls.d.ts +23 -0
  134. package/types/output/StepInfo.d.ts +50 -0
  135. package/types/output/TestAccessibilityStatus.d.ts +8 -0
  136. package/types/output/TestResultContainer.d.ts +31 -0
  137. package/types/output/TestResults.d.ts +186 -0
  138. package/types/output/TestResultsSummary.d.ts +18 -0
  139. package/types/output/TextRegion.d.ts +7 -0
  140. package/types/output/ValidationInfo.d.ts +21 -0
  141. package/types/output/ValidationResult.d.ts +18 -0
@@ -0,0 +1,109 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
14
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
15
+ }) : function(o, v) {
16
+ o["default"] = v;
17
+ });
18
+ var __importStar = (this && this.__importStar) || function (mod) {
19
+ if (mod && mod.__esModule) return mod;
20
+ var result = {};
21
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
22
+ __setModuleDefault(result, mod);
23
+ return result;
24
+ };
25
+ Object.defineProperty(exports, "__esModule", { value: true });
26
+ exports.AccessibilityMatchSettingsData = void 0;
27
+ const utils = __importStar(require("@applitools/utils"));
28
+ const AccessibilityRegionType_1 = require("../enums/AccessibilityRegionType");
29
+ const Region_1 = require("./Region");
30
+ class AccessibilityMatchSettingsData {
31
+ constructor(settingsOrRegionOrX, y, width, height, type) {
32
+ let settings;
33
+ if (utils.types.isNumber(settingsOrRegionOrX)) {
34
+ settings = { region: { x: settingsOrRegionOrX, y: y, width: width, height: height }, type };
35
+ }
36
+ else if (!utils.types.has(settingsOrRegionOrX, 'region')) {
37
+ settings = { region: settingsOrRegionOrX };
38
+ }
39
+ else {
40
+ settings = settingsOrRegionOrX;
41
+ }
42
+ utils.guard.isEnumValue(settings.type, AccessibilityRegionType_1.AccessibilityRegionTypeEnum, { name: 'type', strict: false });
43
+ utils.guard.isObject(settings.region, { name: 'region' });
44
+ this._settings = settings;
45
+ }
46
+ get region() {
47
+ return this._settings.region;
48
+ }
49
+ set region(region) {
50
+ utils.guard.isObject(region, { name: 'region' });
51
+ this._settings.region = region;
52
+ }
53
+ getRegion() {
54
+ return new Region_1.RegionData(this._settings.region);
55
+ }
56
+ setRegion(region) {
57
+ this.region = region;
58
+ }
59
+ getLeft() {
60
+ return this.region.x;
61
+ }
62
+ setLeft(left) {
63
+ this.region.x = left;
64
+ }
65
+ getTop() {
66
+ return this.region.y;
67
+ }
68
+ setTop(top) {
69
+ this.region.y = top;
70
+ }
71
+ getWidth() {
72
+ return this.region.width;
73
+ }
74
+ setWidth(width) {
75
+ this.region.width = width;
76
+ }
77
+ getHeight() {
78
+ return this.region.height;
79
+ }
80
+ setHeight(height) {
81
+ this.region.height = height;
82
+ }
83
+ get type() {
84
+ return this._settings.type;
85
+ }
86
+ set type(type) {
87
+ utils.guard.isEnumValue(type, AccessibilityRegionType_1.AccessibilityRegionTypeEnum, { name: 'type', strict: false });
88
+ this._settings.type = type;
89
+ }
90
+ getType() {
91
+ return this.type;
92
+ }
93
+ setType(type) {
94
+ this.type = type;
95
+ }
96
+ /** @internal */
97
+ toObject() {
98
+ return this._settings;
99
+ }
100
+ /** @internal */
101
+ toJSON() {
102
+ return utils.general.toJSON(this._settings);
103
+ }
104
+ /** @internal */
105
+ toString() {
106
+ return utils.general.toString(this);
107
+ }
108
+ }
109
+ exports.AccessibilityMatchSettingsData = AccessibilityMatchSettingsData;
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,153 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
14
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
15
+ }) : function(o, v) {
16
+ o["default"] = v;
17
+ });
18
+ var __importStar = (this && this.__importStar) || function (mod) {
19
+ if (mod && mod.__esModule) return mod;
20
+ var result = {};
21
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
22
+ __setModuleDefault(result, mod);
23
+ return result;
24
+ };
25
+ Object.defineProperty(exports, "__esModule", { value: true });
26
+ exports.BatchInfoData = void 0;
27
+ const utils = __importStar(require("@applitools/utils"));
28
+ const PropertyData_1 = require("./PropertyData");
29
+ class BatchInfoData {
30
+ constructor(batchOrName, startedAt, id) {
31
+ var _a, _b, _c, _d, _e, _f, _g;
32
+ const batch = utils.types.isNull(batchOrName) || utils.types.isString(batchOrName)
33
+ ? { name: batchOrName, id, startedAt }
34
+ : batchOrName;
35
+ utils.guard.isString(batch.id, { name: 'id', strict: false });
36
+ utils.guard.isString(batch.name, { name: 'name', strict: false });
37
+ utils.guard.isString(batch.sequenceName, { name: 'sequenceName', strict: false });
38
+ utils.guard.isBoolean(batch.notifyOnCompletion, { name: 'notifyOnCompletion', strict: false });
39
+ utils.guard.isArray(batch.properties, { name: 'properties', strict: false });
40
+ this._batch = {
41
+ id: (_b = (_a = batch.id) !== null && _a !== void 0 ? _a : utils.general.getEnvValue('BATCH_ID')) !== null && _b !== void 0 ? _b : `generated-${utils.general.guid()}`,
42
+ name: (_c = batch.name) !== null && _c !== void 0 ? _c : utils.general.getEnvValue('BATCH_NAME'),
43
+ sequenceName: (_d = batch.sequenceName) !== null && _d !== void 0 ? _d : utils.general.getEnvValue('BATCH_SEQUENCE'),
44
+ startedAt: (_e = batch.startedAt) !== null && _e !== void 0 ? _e : new Date(),
45
+ notifyOnCompletion: (_g = (_f = batch.notifyOnCompletion) !== null && _f !== void 0 ? _f : utils.general.getEnvValue('BATCH_NOTIFY', 'boolean')) !== null && _g !== void 0 ? _g : false,
46
+ properties: batch.properties,
47
+ };
48
+ }
49
+ get id() {
50
+ return this._batch.id;
51
+ }
52
+ set id(id) {
53
+ utils.guard.isString(id, { name: 'id', strict: false });
54
+ this._batch.id = id;
55
+ }
56
+ getId() {
57
+ return this.id;
58
+ }
59
+ setId(id) {
60
+ this.id = id;
61
+ return this;
62
+ }
63
+ get name() {
64
+ return this._batch.name;
65
+ }
66
+ set name(name) {
67
+ utils.guard.isString(name, { name: 'name', strict: false });
68
+ this._batch.name = name;
69
+ }
70
+ getName() {
71
+ return this.name;
72
+ }
73
+ setName(name) {
74
+ this.name = name;
75
+ return this;
76
+ }
77
+ get sequenceName() {
78
+ return this._batch.sequenceName;
79
+ }
80
+ set sequenceName(sequenceName) {
81
+ utils.guard.isString(sequenceName, { name: 'sequenceName', strict: false });
82
+ this._batch.sequenceName = sequenceName;
83
+ }
84
+ getSequenceName() {
85
+ return this.sequenceName;
86
+ }
87
+ setSequenceName(sequenceName) {
88
+ this.sequenceName = sequenceName;
89
+ return this;
90
+ }
91
+ get startedAt() {
92
+ return this._batch.startedAt;
93
+ }
94
+ set startedAt(startedAt) {
95
+ this._batch.startedAt = new Date(startedAt);
96
+ }
97
+ getStartedAt() {
98
+ return this.startedAt;
99
+ }
100
+ setStartedAt(startedAt) {
101
+ this.startedAt = startedAt;
102
+ return this;
103
+ }
104
+ get notifyOnCompletion() {
105
+ return this._batch.notifyOnCompletion;
106
+ }
107
+ set notifyOnCompletion(notifyOnCompletion) {
108
+ utils.guard.isBoolean(notifyOnCompletion, { name: 'notifyOnCompletion', strict: false });
109
+ this._batch.notifyOnCompletion = notifyOnCompletion;
110
+ }
111
+ getNotifyOnCompletion() {
112
+ return this.notifyOnCompletion;
113
+ }
114
+ setNotifyOnCompletion(notifyOnCompletion) {
115
+ this.notifyOnCompletion = notifyOnCompletion;
116
+ return this;
117
+ }
118
+ get properties() {
119
+ return this._batch.properties;
120
+ }
121
+ set properties(properties) {
122
+ utils.guard.isArray(properties, { name: 'properties', strict: false });
123
+ this._batch.properties = properties;
124
+ }
125
+ getProperties() {
126
+ var _a, _b;
127
+ return (_b = (_a = this.properties) === null || _a === void 0 ? void 0 : _a.map(property => new PropertyData_1.PropertyDataData(property))) !== null && _b !== void 0 ? _b : [];
128
+ }
129
+ setProperties(properties) {
130
+ this.properties = properties;
131
+ return this;
132
+ }
133
+ addProperty(propOrName, value) {
134
+ const property = utils.types.isString(propOrName) ? { name: propOrName, value: value } : propOrName;
135
+ if (!this.properties)
136
+ this.properties = [];
137
+ this.properties.push(property);
138
+ return this;
139
+ }
140
+ /** @internal */
141
+ toObject() {
142
+ return this._batch;
143
+ }
144
+ /** @internal */
145
+ toJSON() {
146
+ return utils.general.toJSON(this._batch);
147
+ }
148
+ /** @internal */
149
+ toString() {
150
+ return utils.general.toString(this);
151
+ }
152
+ }
153
+ exports.BatchInfoData = BatchInfoData;