@ui5/webcomponents-tools 0.0.0-6ef02a35f → 0.0.0-760fbb471

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 (95) hide show
  1. package/CHANGELOG.md +338 -0
  2. package/README.md +5 -6
  3. package/assets-meta.js +7 -1
  4. package/bin/dev.js +1 -5
  5. package/components-package/eslint.js +34 -0
  6. package/components-package/nps.js +92 -54
  7. package/components-package/postcss.components.js +13 -13
  8. package/components-package/postcss.themes.js +19 -16
  9. package/components-package/vite.config.js +12 -0
  10. package/components-package/wdio.js +78 -29
  11. package/components-package/wdio.sync.js +360 -0
  12. package/icons-collection/nps.js +46 -15
  13. package/lib/copy-and-watch/index.js +24 -1
  14. package/lib/copy-list/index.js +17 -17
  15. package/lib/create-icons/index.js +124 -58
  16. package/lib/create-illustrations/index.js +161 -0
  17. package/lib/create-new-component/index.js +108 -103
  18. package/lib/create-new-component/jsFileContentTemplate.js +77 -0
  19. package/lib/create-new-component/tsFileContentTemplate.js +84 -0
  20. package/lib/dev-server/dev-server.js +66 -0
  21. package/lib/dev-server/virtual-index-html-plugin.js +53 -0
  22. package/lib/esm-abs-to-rel/index.js +13 -9
  23. package/lib/generate-custom-elements-manifest/index.js +327 -0
  24. package/lib/generate-js-imports/illustrations.js +72 -0
  25. package/lib/generate-json-imports/i18n.js +38 -31
  26. package/lib/generate-json-imports/themes.js +31 -24
  27. package/lib/hbs2lit/src/compiler.js +20 -3
  28. package/lib/hbs2lit/src/includesReplacer.js +5 -5
  29. package/lib/hbs2lit/src/litVisitor2.js +59 -13
  30. package/lib/hbs2lit/src/svgProcessor.js +3 -3
  31. package/lib/hbs2ui5/RenderTemplates/LitRenderer.js +4 -10
  32. package/lib/hbs2ui5/index.js +37 -21
  33. package/lib/i18n/defaults.js +65 -57
  34. package/lib/i18n/toJSON.js +12 -11
  35. package/lib/jsdoc/configTypescript.json +29 -0
  36. package/lib/jsdoc/plugin.js +41 -0
  37. package/lib/jsdoc/preprocess.js +146 -0
  38. package/lib/jsdoc/template/publish.js +21 -2
  39. package/lib/postcss-combine-duplicated-selectors/index.js +178 -0
  40. package/lib/postcss-css-to-esm/index.js +53 -8
  41. package/lib/postcss-css-to-json/index.js +18 -2
  42. package/lib/postcss-p/postcss-p.mjs +14 -0
  43. package/lib/replace-global-core/index.js +13 -8
  44. package/lib/scoping/get-all-tags.js +1 -8
  45. package/lib/scoping/lint-src.js +1 -1
  46. package/lib/scoping/missing-dependencies.js +65 -0
  47. package/lib/scoping/report-tags-usage.js +28 -0
  48. package/lib/scoping/scope-test-pages.js +1 -1
  49. package/lib/test-runner/test-runner.js +63 -0
  50. package/package.json +35 -38
  51. package/bin/init-ui5-package.js +0 -3
  52. package/components-package/rollup.js +0 -216
  53. package/lib/documentation/index.js +0 -165
  54. package/lib/documentation/templates/api-component-since.js +0 -3
  55. package/lib/documentation/templates/api-css-variables-section.js +0 -24
  56. package/lib/documentation/templates/api-events-section.js +0 -35
  57. package/lib/documentation/templates/api-methods-section.js +0 -26
  58. package/lib/documentation/templates/api-properties-section.js +0 -40
  59. package/lib/documentation/templates/api-slots-section.js +0 -28
  60. package/lib/documentation/templates/template.js +0 -38
  61. package/lib/hash/config.js +0 -10
  62. package/lib/hash/generate.js +0 -19
  63. package/lib/hash/upToDate.js +0 -31
  64. package/lib/init-package/index.js +0 -136
  65. package/lib/init-package/resources/.eslintignore +0 -3
  66. package/lib/init-package/resources/bundle.es5.js +0 -25
  67. package/lib/init-package/resources/bundle.esm.js +0 -31
  68. package/lib/init-package/resources/config/.eslintrc.js +0 -1
  69. package/lib/init-package/resources/config/postcss.components/postcss.config.js +0 -1
  70. package/lib/init-package/resources/config/postcss.themes/postcss.config.js +0 -1
  71. package/lib/init-package/resources/config/rollup.config.js +0 -1
  72. package/lib/init-package/resources/config/wdio.conf.js +0 -1
  73. package/lib/init-package/resources/package-scripts.js +0 -11
  74. package/lib/init-package/resources/src/Assets.js +0 -5
  75. package/lib/init-package/resources/src/MyFirstComponent.hbs +0 -1
  76. package/lib/init-package/resources/src/MyFirstComponent.js +0 -56
  77. package/lib/init-package/resources/src/i18n/messagebundle.properties +0 -2
  78. package/lib/init-package/resources/src/i18n/messagebundle_de.properties +0 -1
  79. package/lib/init-package/resources/src/i18n/messagebundle_en.properties +0 -1
  80. package/lib/init-package/resources/src/i18n/messagebundle_es.properties +0 -1
  81. package/lib/init-package/resources/src/i18n/messagebundle_fr.properties +0 -1
  82. package/lib/init-package/resources/src/themes/MyFirstComponent.css +0 -11
  83. package/lib/init-package/resources/src/themes/sap_belize/parameters-bundle.css +0 -3
  84. package/lib/init-package/resources/src/themes/sap_belize_hcb/parameters-bundle.css +0 -3
  85. package/lib/init-package/resources/src/themes/sap_belize_hcw/parameters-bundle.css +0 -3
  86. package/lib/init-package/resources/src/themes/sap_fiori_3/parameters-bundle.css +0 -3
  87. package/lib/init-package/resources/src/themes/sap_fiori_3_dark/parameters-bundle.css +0 -3
  88. package/lib/init-package/resources/src/themes/sap_fiori_3_hcb/parameters-bundle.css +0 -3
  89. package/lib/init-package/resources/src/themes/sap_fiori_3_hcw/parameters-bundle.css +0 -3
  90. package/lib/init-package/resources/test/pages/index.html +0 -56
  91. package/lib/init-package/resources/test/specs/Demo.spec.js +0 -12
  92. package/lib/polyfill-placeholder/index.js +0 -5
  93. package/lib/serve/index.js +0 -46
  94. package/lib/serve/serve.json +0 -3
  95. package/package-lock.json +0 -48
@@ -6,16 +6,16 @@ const fs = require("fs");
6
6
  const packageName = JSON.parse(fs.readFileSync("./package.json")).name;
7
7
 
8
8
  module.exports = {
9
- plugins: [
10
- postcssImport(),
11
- cssnano({
12
- preset: [
13
- 'default', {
14
- mergeLonghand: false, // https://github.com/cssnano/cssnano/issues/675
15
- mergeRules: false, // https://github.com/cssnano/cssnano/issues/730
16
- },
17
- ]
18
- }),
19
- postcssCSStoESM({toReplace: 'src', includeDefaultTheme: true, packageName}),
20
- ]
21
- };
9
+ plugins: [
10
+ postcssImport(),
11
+ cssnano({
12
+ preset: [
13
+ 'default', {
14
+ mergeLonghand: false, // https://github.com/cssnano/cssnano/issues/675
15
+ mergeRules: false, // https://github.com/cssnano/cssnano/issues/730
16
+ },
17
+ ]
18
+ }),
19
+ postcssCSStoESM({ toReplace: 'src', includeDefaultTheme: true, packageName }),
20
+ ]
21
+ }
@@ -1,23 +1,26 @@
1
1
  const postcssImport = require('postcss-import');
2
- const combineSelectors = require('postcss-combine-duplicated-selectors');
2
+ const combineSelectors = require('../lib/postcss-combine-duplicated-selectors/index.js');
3
3
  const postcssCSStoJSON = require('../lib/postcss-css-to-json/index.js');
4
4
  const postcssCSStoESM = require('../lib/postcss-css-to-esm/index.js');
5
5
  const cssnano = require('cssnano');
6
+ const fs = require("fs");
7
+
8
+ const packageName = JSON.parse(fs.readFileSync("./package.json")).name;
6
9
 
7
10
  module.exports = {
8
- plugins: [
9
- postcssImport(),
10
- combineSelectors({
11
- removeDuplicatedProperties: true
12
- }),
13
- cssnano({
14
- preset: [
15
- 'default', {
16
- mergeLonghand: false, // https://github.com/cssnano/cssnano/issues/675
17
- },
18
- ]
19
- },),
20
- postcssCSStoJSON({toReplace: 'src'}),
21
- postcssCSStoESM({toReplace: 'src'}),
22
- ]
11
+ plugins: [
12
+ postcssImport(),
13
+ combineSelectors({
14
+ removeDuplicatedProperties: true
15
+ }),
16
+ cssnano({
17
+ preset: [
18
+ 'default', {
19
+ mergeLonghand: false, // https://github.com/cssnano/cssnano/issues/675
20
+ },
21
+ ]
22
+ },),
23
+ postcssCSStoJSON({ toReplace: 'src', packageName }),
24
+ postcssCSStoESM({ toReplace: 'src', packageName }),
25
+ ]
23
26
  };
@@ -0,0 +1,12 @@
1
+ // vite.config.js
2
+ const { defineConfig } = require('vite');
3
+ const virtualIndex = require("../lib/dev-server/virtual-index-html-plugin.js");
4
+
5
+ module.exports = defineConfig(async () => {
6
+ return {
7
+ build: {
8
+ emptyOutDir: false,
9
+ },
10
+ plugins: [await virtualIndex()],
11
+ }
12
+ });
@@ -50,7 +50,7 @@ exports.config = {
50
50
  // maxInstances can get overwritten per capability. So if you have an in-house Selenium
51
51
  // grid with only 5 firefox instances available you can make sure that not more than
52
52
  // 5 instances get started at a time.
53
- maxInstances: process.env.TRAVIS ? 1 : 5,
53
+ maxInstances: 5,
54
54
  //
55
55
  browserName: 'chrome',
56
56
  'goog:chromeOptions': {
@@ -82,7 +82,7 @@ exports.config = {
82
82
  // with `/`, the base url gets prepended, not including the path portion of your baseUrl.
83
83
  // If your `url` parameter starts without a scheme or `/` (like `some/path`), the base url
84
84
  // gets prepended directly.
85
- baseUrl: undefined, // This is important since WDIO 7+ does not accept an empty string for baseUrl
85
+ baseUrl: 'http://localhost:4567', // This is important since WDIO 7+ does not accept an empty string for baseUrl
86
86
  path: '',
87
87
  //
88
88
  // Default timeout for all waitFor* commands.
@@ -99,7 +99,14 @@ exports.config = {
99
99
  // Services take over a specific job you don't want to take care of. They enhance
100
100
  // your test setup with almost no effort. Unlike plugins, they don't add new
101
101
  // commands. Instead, they hook themselves up into the test process.
102
- services: ['chromedriver'],
102
+ services: ['chromedriver', 'devtools',
103
+ ['static-server', {
104
+ folders: [
105
+ { mount: '/', path: './dist' },
106
+ ],
107
+ port: '4567',
108
+ }],
109
+ ],
103
110
  // options
104
111
  chromeDriverArgs: ['--port=9515'], // default
105
112
  // Framework you want to run your specs with.
@@ -152,9 +159,9 @@ exports.config = {
152
159
  * @param {Array.<Object>} capabilities list of capabilities details
153
160
  * @param {Array.<String>} specs List of spec file paths that are to be run
154
161
  */
155
- before: function (capabilities, specs) {
156
- browser.addCommand("isFocusedDeep", function () {
157
- return browser.execute(function (elem) {
162
+ before: async function (capabilities, specs) {
163
+ await browser.addCommand("isFocusedDeep", async function () {
164
+ return browser.executeAsync(function (elem, done) {
158
165
  let activeElement = document.activeElement;
159
166
 
160
167
  while (activeElement.shadowRoot) {
@@ -164,51 +171,80 @@ exports.config = {
164
171
  break;
165
172
  }
166
173
  }
167
- return elem === activeElement;
174
+ done(elem === activeElement);
168
175
  }, this);
169
176
  }, true);
170
177
 
171
- browser.addCommand("setProperty", function(property, value) {
172
- return browser.execute((elem, property, value) => {
173
- return elem[property] = value;
178
+ await browser.addCommand("isFocusedDeepElement", async function (element) {
179
+ return browser.executeAsync(function (elem, element, done) {
180
+ let activeElement = document.activeElement;
181
+
182
+ while (activeElement.shadowRoot) {
183
+ if (activeElement.shadowRoot.activeElement) {
184
+ activeElement = activeElement.shadowRoot.activeElement;
185
+ } else {
186
+ break;
187
+ }
188
+ }
189
+ done(element === activeElement);
190
+ }, this, element);
191
+ }, true);
192
+
193
+ await browser.addCommand("setProperty", async function(property, value) {
194
+ return browser.executeAsync((elem, property, value, done) => {
195
+ elem[property] = value;
196
+ done();
174
197
  }, this, property, value);
175
198
  }, true);
176
199
 
177
- browser.addCommand("setAttribute", function(attribute, value) {
178
- return browser.execute((elem, attribute, value) => {
179
- return elem.setAttribute(attribute, value);
200
+ await browser.addCommand("setAttribute", async function(attribute, value) {
201
+ return browser.executeAsync((elem, attribute, value, done) => {
202
+ elem.setAttribute(attribute, value);
203
+ done();
180
204
  }, this, attribute, value);
181
205
  }, true);
182
206
 
183
- browser.addCommand("removeAttribute", function(attribute) {
184
- return browser.execute((elem, attribute) => {
185
- return elem.removeAttribute(attribute);
207
+ await browser.addCommand("removeAttribute", async function(attribute) {
208
+ return browser.executeAsync((elem, attribute, done) => {
209
+ elem.removeAttribute(attribute);
210
+ done();
186
211
  }, this, attribute);
187
212
  }, true);
188
213
 
189
- browser.addCommand("hasClass", function(className) {
190
- return browser.execute((elem, className) => {
191
- return elem.classList.contains(className);
214
+ await browser.addCommand("hasClass", async function(className) {
215
+ return browser.executeAsync((elem, className, done) => {
216
+ done(elem.classList.contains(className));
192
217
  }, this, className);
193
218
  }, true);
194
219
 
195
- browser.addCommand("getStaticAreaItemClassName", function(selector) {
196
- return browser.execute(async (selector) => {
220
+ await browser.addCommand("hasAttribute", async function(attrName) {
221
+ return browser.executeAsync((elem, attrName, done) => {
222
+ done(elem.hasAttribute(attrName));
223
+ }, this, attrName);
224
+ }, true);
225
+
226
+ await browser.addCommand("getStaticAreaItemClassName", async function(selector) {
227
+ return browser.executeAsync(async (selector, done) => {
197
228
  const staticAreaItem = await document.querySelector(selector).getStaticAreaItemDomRef();
198
- return staticAreaItem.host.classList[0];
229
+ done(staticAreaItem.host.classList[0]);
199
230
  }, selector);
200
231
  }, false);
232
+
233
+ await browser.addLocatorStrategy('activeElement', (selector) => {
234
+ return document.querySelector(selector).shadowRoot.activeElement;
235
+ });
201
236
  },
202
237
  /**
203
238
  * Runs before a WebdriverIO command gets executed.
204
239
  * @param {String} commandName hook command name
205
240
  * @param {Array} args arguments that command would receive
206
241
  */
207
- beforeCommand: function (commandName, args) {
242
+ beforeCommand: async function (commandName, args) {
208
243
  const waitFor = [
209
244
  "$",
210
245
  "$$",
211
246
  "getAttribute",
247
+ "hasAttribute", // custom
212
248
  "getCSSProperty",
213
249
  "getHTML",
214
250
  "getProperty",
@@ -223,11 +259,12 @@ exports.config = {
223
259
  "isExisting",
224
260
  "isFocused",
225
261
  "isFocusedDeep", // custom
262
+ "isFocusedDeepElement", // custom
226
263
  "shadow$",
227
264
  "shadow$$",
228
265
  ];
229
266
  if (waitFor.includes(commandName)) {
230
- browser.executeAsync(function (done) {
267
+ await browser.executeAsync(function (done) {
231
268
  window["sap-ui-webcomponents-bundle"].renderFinished().then(done);
232
269
  });
233
270
  }
@@ -277,12 +314,13 @@ exports.config = {
277
314
  * @param {Number} result 0 - command success, 1 - command error
278
315
  * @param {Object} error error object if any
279
316
  */
280
- afterCommand: function (commandName, args, result, error) {
317
+ afterCommand: async function (commandName, args, result, error) {
281
318
 
282
319
  // url -> set configuration first
283
320
  if (commandName === "url" && !args[0].includes("do-not-change-configuration")) {
284
- browser.execute(function() {
321
+ await browser.executeAsync(function(done) {
285
322
  window["sap-ui-webcomponents-bundle"].configuration.setNoConflict(true);
323
+ done();
286
324
  });
287
325
  }
288
326
 
@@ -292,20 +330,31 @@ exports.config = {
292
330
  "click",
293
331
  "doubleClick",
294
332
  "dragAndDrop",
295
- "keys",
296
333
  "pause",
297
334
  "removeAttribute", // custom
335
+ "scrollIntoView",
298
336
  "setAttribute", // custom
299
337
  "setProperty", // custom
300
338
  "setValue",
301
339
  "setWindowSize",
302
340
  "touchAction",
303
- "url"
341
+ "url",
304
342
  ];
343
+
344
+ const waitForWithDelay = [
345
+ "keys",
346
+ ];
347
+
305
348
  if (waitFor.includes(commandName)) {
306
- browser.executeAsync(function (done) {
349
+ await browser.executeAsync(function (done) {
307
350
  window["sap-ui-webcomponents-bundle"].renderFinished().then(done);
308
351
  });
352
+ } else if (waitForWithDelay.includes(commandName)) {
353
+ await browser.executeAsync(function (done) {
354
+ setTimeout(() => {
355
+ window["sap-ui-webcomponents-bundle"].renderFinished().then(done);
356
+ }, 10);
357
+ });
309
358
  }
310
359
  },
311
360
  /**
@@ -0,0 +1,360 @@
1
+ exports.config = {
2
+ //
3
+ // ====================
4
+ // Runner Configuration
5
+ // ====================
6
+ //
7
+ // WebdriverIO allows it to run your tests in arbitrary locations (e.g. locally or
8
+ // on a remote machine).
9
+ runner: 'local',
10
+
11
+ //
12
+ // ==================
13
+ // Specify Test Files
14
+ // ==================
15
+ // Define which test specs should run. The pattern is relative to the directory
16
+ // from which `wdio` was called. Notice that, if you are calling `wdio` from an
17
+ // NPM script (see https://docs.npmjs.com/cli/run-script) then the current working
18
+ // directory is where your package.json resides, so `wdio` will be called from there.
19
+ //
20
+ specs: [
21
+ './test/specs/**/*.js'
22
+ ],
23
+ // Patterns to exclude.
24
+ exclude: [
25
+ // 'path/to/excluded/files'
26
+ ],
27
+ //
28
+ // ============
29
+ // Capabilities
30
+ // ============
31
+ // Define your capabilities here. WebdriverIO can run multiple capabilities at the same
32
+ // time. Depending on the number of capabilities, WebdriverIO launches several test
33
+ // sessions. Within your capabilities you can overwrite the spec and exclude options in
34
+ // order to group specific specs to a specific capability.
35
+ //
36
+ // First, you can define how many instances should be started at the same time. Let's
37
+ // say you have 3 different capabilities (Chrome, Firefox, and Safari) and you have
38
+ // set maxInstances to 1; wdio will spawn 3 processes. Therefore, if you have 10 spec
39
+ // files and you set maxInstances to 10, all spec files will get tested at the same time
40
+ // and 30 processes will get spawned. The property handles how many capabilities
41
+ // from the same test should run tests.
42
+ //
43
+ maxInstances: 10,
44
+ //
45
+ // If you have trouble getting all important capabilities together, check out the
46
+ // Sauce Labs platform configurator - a great tool to configure your capabilities:
47
+ // https://docs.saucelabs.com/reference/platforms-configurator
48
+ //
49
+ capabilities: [{
50
+ // maxInstances can get overwritten per capability. So if you have an in-house Selenium
51
+ // grid with only 5 firefox instances available you can make sure that not more than
52
+ // 5 instances get started at a time.
53
+ maxInstances: 5,
54
+ //
55
+ browserName: 'chrome',
56
+ 'goog:chromeOptions': {
57
+ // to run chrome headless the following flags are required
58
+ // (see https://developers.google.com/web/updates/2017/04/headless-chrome)
59
+ args: ['--headless', '--disable-gpu'],
60
+ // args: ['--disable-gpu'],
61
+ }
62
+ }],
63
+ //
64
+ // port to find chromedriver
65
+ port: 9515, // default
66
+ // ===================
67
+ // Test Configurations
68
+ // ===================
69
+ // Define all options that are relevant for the WebdriverIO instance here
70
+ //
71
+ // Level of logging verbosity: trace | debug | info | warn | error
72
+ logLevel: 'error',
73
+ //
74
+ // Warns when a deprecated command is used
75
+ deprecationWarnings: true,
76
+ //
77
+ // If you only want to run your tests until a specific amount of tests have failed use
78
+ // bail (default is 0 - don't bail, run all tests).
79
+ bail: 0,
80
+ //
81
+ // Set a base URL in order to shorten url command calls. If your `url` parameter starts
82
+ // with `/`, the base url gets prepended, not including the path portion of your baseUrl.
83
+ // If your `url` parameter starts without a scheme or `/` (like `some/path`), the base url
84
+ // gets prepended directly.
85
+ baseUrl: undefined, // This is important since WDIO 7+ does not accept an empty string for baseUrl
86
+ path: '',
87
+ //
88
+ // Default timeout for all waitFor* commands.
89
+ waitforTimeout: 10000,
90
+ //
91
+ // Default timeout in milliseconds for request
92
+ // if Selenium Grid doesn't send response
93
+ connectionRetryTimeout: 90000,
94
+ //
95
+ // Default request retries count
96
+ connectionRetryCount: 3,
97
+ //
98
+ // Test runner services
99
+ // Services take over a specific job you don't want to take care of. They enhance
100
+ // your test setup with almost no effort. Unlike plugins, they don't add new
101
+ // commands. Instead, they hook themselves up into the test process.
102
+ services: ['chromedriver'],
103
+ // options
104
+ chromeDriverArgs: ['--port=9515'], // default
105
+ // Framework you want to run your specs with.
106
+ // The following are supported: Mocha, Jasmine, and Cucumber
107
+ // see also: https://webdriver.io/docs/frameworks.html
108
+ //
109
+ // Make sure you have the wdio adapter package for the specific framework installed
110
+ // before running any tests.
111
+ framework: 'mocha',
112
+ //
113
+ // Test reporter for stdout.
114
+ // The only one supported by default is 'dot'
115
+ // see also: https://webdriver.io/docs/dot-reporter.html
116
+ reporters: ['dot', 'spec'],
117
+
118
+ //
119
+ // Options to be passed to Mocha.
120
+ // See the full list at http://mochajs.org/
121
+ mochaOpts: {
122
+ ui: 'bdd',
123
+ timeout: 60000
124
+ },
125
+ //
126
+ // =====
127
+ // Hooks
128
+ // =====
129
+ // WebdriverIO provides several hooks you can use to interfere with the test process in order to enhance
130
+ // it and to build services around it. You can either apply a single function or an array of
131
+ // methods to it. If one of them returns with a promise, WebdriverIO will wait until that promise got
132
+ // resolved to continue.
133
+ /**
134
+ * Gets executed once before all workers get launched.
135
+ * @param {Object} config wdio configuration object
136
+ * @param {Array.<Object>} capabilities list of capabilities details
137
+ */
138
+ // onPrepare: function (config, capabilities) {
139
+ // },
140
+ /**
141
+ * Gets executed just before initialising the webdriver session and test framework. It allows you
142
+ * to manipulate configurations depending on the capability or spec.
143
+ * @param {Object} config wdio configuration object
144
+ * @param {Array.<Object>} capabilities list of capabilities details
145
+ * @param {Array.<String>} specs List of spec file paths that are to be run
146
+ */
147
+ // beforeSession: function (config, capabilities, specs) {
148
+ // },
149
+ /**
150
+ * Gets executed before test execution begins. At this point you can access to all global
151
+ * variables like `browser`. It is the perfect place to define custom commands.
152
+ * @param {Array.<Object>} capabilities list of capabilities details
153
+ * @param {Array.<String>} specs List of spec file paths that are to be run
154
+ */
155
+ before: function (capabilities, specs) {
156
+ browser.addCommand("isFocusedDeep", function () {
157
+ return browser.execute(function (elem) {
158
+ let activeElement = document.activeElement;
159
+
160
+ while (activeElement.shadowRoot) {
161
+ if (activeElement.shadowRoot.activeElement) {
162
+ activeElement = activeElement.shadowRoot.activeElement;
163
+ } else {
164
+ break;
165
+ }
166
+ }
167
+ return elem === activeElement;
168
+ }, this);
169
+ }, true);
170
+
171
+ browser.addCommand("isFocusedDeepElement", function (element) {
172
+ return browser.execute(function (elem, element, done) {
173
+ let activeElement = document.activeElement;
174
+
175
+ while (activeElement.shadowRoot) {
176
+ if (activeElement.shadowRoot.activeElement) {
177
+ activeElement = activeElement.shadowRoot.activeElement;
178
+ } else {
179
+ break;
180
+ }
181
+ }
182
+ done(element === activeElement);
183
+ }, this, element);
184
+ }, true);
185
+
186
+ browser.addCommand("setProperty", function(property, value) {
187
+ return browser.execute((elem, property, value) => {
188
+ return elem[property] = value;
189
+ }, this, property, value);
190
+ }, true);
191
+
192
+ browser.addCommand("setAttribute", function(attribute, value) {
193
+ return browser.execute((elem, attribute, value) => {
194
+ return elem.setAttribute(attribute, value);
195
+ }, this, attribute, value);
196
+ }, true);
197
+
198
+ browser.addCommand("removeAttribute", function(attribute) {
199
+ return browser.execute((elem, attribute) => {
200
+ return elem.removeAttribute(attribute);
201
+ }, this, attribute);
202
+ }, true);
203
+
204
+ browser.addCommand("hasClass", function(className) {
205
+ return browser.execute((elem, className) => {
206
+ return elem.classList.contains(className);
207
+ }, this, className);
208
+ }, true);
209
+
210
+ browser.addCommand("getStaticAreaItemClassName", function(selector) {
211
+ return browser.execute(async (selector) => {
212
+ const staticAreaItem = await document.querySelector(selector).getStaticAreaItemDomRef();
213
+ return staticAreaItem.host.classList[0];
214
+ }, selector);
215
+ }, false);
216
+ },
217
+ /**
218
+ * Runs before a WebdriverIO command gets executed.
219
+ * @param {String} commandName hook command name
220
+ * @param {Array} args arguments that command would receive
221
+ */
222
+ beforeCommand: function (commandName, args) {
223
+ const waitFor = [
224
+ "$",
225
+ "$$",
226
+ "getAttribute",
227
+ "getCSSProperty",
228
+ "getHTML",
229
+ "getProperty",
230
+ "getSize",
231
+ "getStaticAreaItemClassName", // custom
232
+ "getText",
233
+ "getValue",
234
+ "hasClass", // custom
235
+ "isDisplayed",
236
+ "isDisplayedInViewport",
237
+ "isEnabled",
238
+ "isExisting",
239
+ "isFocused",
240
+ "isFocusedDeep", // custom
241
+ "isFocusedDeepElement", // custom
242
+ "shadow$",
243
+ "shadow$$",
244
+ ];
245
+ if (waitFor.includes(commandName)) {
246
+ browser.executeAsync(function (done) {
247
+ window["sap-ui-webcomponents-bundle"].renderFinished().then(done);
248
+ });
249
+ }
250
+ },
251
+
252
+ /**
253
+ * Hook that gets executed before the suite starts
254
+ * @param {Object} suite suite details
255
+ */
256
+ // beforeSuite: function (suite) {
257
+ // },
258
+ /**
259
+ * Function to be executed before a test (in Mocha/Jasmine) or a step (in Cucumber) starts.
260
+ * @param {Object} test test details
261
+ */
262
+ // beforeTest: function (test) {
263
+ // },
264
+ /**
265
+ * Hook that gets executed _before_ a hook within the suite starts (e.g. runs before calling
266
+ * beforeEach in Mocha)
267
+ */
268
+ // beforeHook: function () {
269
+ // },
270
+ /**
271
+ * Hook that gets executed _after_ a hook within the suite starts (e.g. runs after calling
272
+ * afterEach in Mocha)
273
+ */
274
+ // afterHook: function () {
275
+ // },
276
+ /**
277
+ * Function to be executed after a test (in Mocha/Jasmine) or a step (in Cucumber) starts.
278
+ * @param {Object} test test details
279
+ */
280
+ // afterTest: function (test) {
281
+ // },
282
+ /**
283
+ * Hook that gets executed after the suite has ended
284
+ * @param {Object} suite suite details
285
+ */
286
+ // afterSuite: function (suite) {
287
+ // },
288
+
289
+ /**
290
+ * Runs after a WebdriverIO command gets executed
291
+ * @param {String} commandName hook command name
292
+ * @param {Array} args arguments that command would receive
293
+ * @param {Number} result 0 - command success, 1 - command error
294
+ * @param {Object} error error object if any
295
+ */
296
+ afterCommand: function (commandName, args, result, error) {
297
+
298
+ // url -> set configuration first
299
+ if (commandName === "url" && !args[0].includes("do-not-change-configuration")) {
300
+ browser.execute(function() {
301
+ window["sap-ui-webcomponents-bundle"].configuration.setNoConflict(true);
302
+ });
303
+ }
304
+
305
+ const waitFor = [
306
+ "addValue",
307
+ "clearValue",
308
+ "click",
309
+ "doubleClick",
310
+ "dragAndDrop",
311
+ "keys",
312
+ "pause",
313
+ "removeAttribute", // custom
314
+ "setAttribute", // custom
315
+ "setProperty", // custom
316
+ "setValue",
317
+ "setWindowSize",
318
+ "touchAction",
319
+ "url"
320
+ ];
321
+ if (waitFor.includes(commandName)) {
322
+ browser.executeAsync(function (done) {
323
+ window["sap-ui-webcomponents-bundle"].renderFinished().then(done);
324
+ });
325
+ }
326
+ },
327
+ /**
328
+ * Gets executed after all tests are done. You still have access to all global variables from
329
+ * the test.
330
+ * @param {Number} result 0 - test pass, 1 - test fail
331
+ * @param {Array.<Object>} capabilities list of capabilities details
332
+ * @param {Array.<String>} specs List of spec file paths that ran
333
+ */
334
+ // after: function (result, capabilities, specs) {
335
+ // },
336
+ /**
337
+ * Gets executed right after terminating the webdriver session.
338
+ * @param {Object} config wdio configuration object
339
+ * @param {Array.<Object>} capabilities list of capabilities details
340
+ * @param {Array.<String>} specs List of spec file paths that ran
341
+ */
342
+ // afterSession: function (config, capabilities, specs) {
343
+ // },
344
+ /**
345
+ * Gets executed after all workers got shut down and the process is about to exit.
346
+ * @param {Object} exitCode 0 - success, 1 - fail
347
+ * @param {Object} config wdio configuration object
348
+ * @param {Array.<Object>} capabilities list of capabilities details
349
+ * @param {<Object>} results object containing test results
350
+ */
351
+ // onComplete: function(exitCode, config, capabilities, results) {
352
+ // },
353
+ /**
354
+ * Gets executed when a refresh happens.
355
+ * @param {String} oldSessionId session ID of the old session
356
+ * @param {String} newSessionId session ID of the new session
357
+ */
358
+ //onReload: function(oldSessionId, newSessionId) {
359
+ //}
360
+ }