@ui5/webcomponents-base 0.0.0-6ef02a35f → 0.0.0-7e7d9ea6f

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 (183) hide show
  1. package/.eslintignore +3 -2
  2. package/CHANGELOG.md +225 -0
  3. package/README.md +53 -7
  4. package/bundle.esm.js +13 -11
  5. package/dist/Boot.js +34 -18
  6. package/dist/CSP.js +59 -0
  7. package/dist/CustomElementsRegistry.js +60 -4
  8. package/dist/CustomElementsScope.js +20 -98
  9. package/dist/CustomElementsScopeUtils.js +108 -0
  10. package/dist/Device.js +20 -1
  11. package/dist/EventProvider.js +19 -25
  12. package/dist/FeaturesRegistry.js +4 -1
  13. package/dist/FontFace.js +7 -95
  14. package/dist/InitialConfiguration.js +11 -7
  15. package/dist/Keys.js +56 -0
  16. package/dist/ManagedStyles.js +83 -0
  17. package/dist/Render.js +3 -1
  18. package/dist/Runtimes.js +107 -0
  19. package/dist/StaticAreaItem.js +15 -10
  20. package/dist/SystemCSSVars.js +4 -25
  21. package/dist/UI5Element.js +59 -60
  22. package/dist/UI5ElementMetadata.js +47 -6
  23. package/dist/asset-registries/Icons.js +22 -8
  24. package/dist/asset-registries/Illustrations.js +10 -3
  25. package/dist/asset-registries/LocaleData.js +18 -4
  26. package/dist/asset-registries/Themes.js +6 -2
  27. package/dist/asset-registries/i18n.js +3 -1
  28. package/dist/assets/bundle.esm.691f93f5.js +43 -0
  29. package/dist/assets-meta/IconCollectionsAlias.js +18 -0
  30. package/dist/config/Icons.js +52 -0
  31. package/dist/config/Theme.js +25 -0
  32. package/dist/css/BusyIndicator.css +80 -0
  33. package/dist/css/FontFace.css +75 -0
  34. package/dist/css/OverrideFontFace.css +32 -0
  35. package/dist/css/SystemCSSVars.css +17 -0
  36. package/dist/delegate/ItemNavigation.js +75 -4
  37. package/dist/features/F6Navigation.js +110 -0
  38. package/dist/features/OpenUI5Enablement.js +119 -0
  39. package/dist/generated/AssetParameters.js +1 -1
  40. package/dist/generated/VersionInfo.js +10 -0
  41. package/dist/generated/css/BusyIndicator.css.js +5 -0
  42. package/dist/generated/css/FontFace.css.js +5 -0
  43. package/dist/generated/css/OverrideFontFace.css.js +5 -0
  44. package/dist/generated/css/SystemCSSVars.css.js +5 -0
  45. package/dist/i18nBundle.js +33 -2
  46. package/dist/renderer/LitRenderer.js +33 -12
  47. package/dist/renderer/directives/style-map.js +72 -0
  48. package/dist/renderer/executeTemplate.js +19 -2
  49. package/dist/sap/base/Log.js +2 -10
  50. package/dist/sap/base/assert.js +1 -5
  51. package/dist/sap/base/security/encodeCSS.js +14 -0
  52. package/dist/sap/base/security/encodeXML.js +23 -0
  53. package/dist/sap/base/strings/toHex.js +8 -0
  54. package/dist/sap/ui/thirdparty/caja-html-sanitizer.js +1 -1
  55. package/dist/theming/CustomStyle.js +23 -3
  56. package/dist/theming/applyTheme.js +11 -10
  57. package/dist/theming/getEffectiveLinksHrefs.js +27 -0
  58. package/dist/theming/getEffectiveStyle.js +9 -0
  59. package/dist/theming/getStylesString.js +4 -2
  60. package/dist/theming/getThemeDesignerTheme.js +25 -5
  61. package/dist/theming/preloadLinks.js +23 -0
  62. package/dist/types/DataType.js +12 -0
  63. package/dist/types/Float.js +4 -0
  64. package/dist/types/Integer.js +4 -0
  65. package/dist/updateShadowRoot.js +9 -6
  66. package/dist/util/Caret.js +1 -14
  67. package/dist/util/ColorConversion.js +30 -2
  68. package/dist/util/FocusableElements.js +8 -6
  69. package/dist/util/InvisibleMessage.js +20 -9
  70. package/dist/util/TabbableElements.js +4 -0
  71. package/dist/util/createLinkInHead.js +19 -0
  72. package/dist/util/escapeRegex.js +10 -0
  73. package/dist/util/generateHighlightedMarkup.js +42 -0
  74. package/dist/util/getNormalizedTarget.js +16 -0
  75. package/dist/util/isDefaultSlotProvided.js +11 -0
  76. package/dist/util/isNodeHidden.js +1 -1
  77. package/hash.txt +1 -1
  78. package/lib/generate-asset-parameters/index.js +8 -5
  79. package/lib/generate-styles/index.js +26 -0
  80. package/lib/generate-version-info/index.js +32 -0
  81. package/package-scripts.js +25 -31
  82. package/package.json +11 -12
  83. package/src/Boot.js +34 -18
  84. package/src/CSP.js +59 -0
  85. package/src/CustomElementsRegistry.js +60 -4
  86. package/src/CustomElementsScope.js +20 -98
  87. package/src/CustomElementsScopeUtils.js +108 -0
  88. package/src/Device.js +20 -1
  89. package/src/EventProvider.js +19 -25
  90. package/src/FeaturesRegistry.js +4 -1
  91. package/src/FontFace.js +7 -95
  92. package/src/InitialConfiguration.js +11 -7
  93. package/src/Keys.js +56 -0
  94. package/src/ManagedStyles.js +83 -0
  95. package/src/Render.js +3 -1
  96. package/src/Runtimes.js +107 -0
  97. package/src/StaticAreaItem.js +15 -10
  98. package/src/SystemCSSVars.js +4 -25
  99. package/src/UI5Element.js +59 -60
  100. package/src/UI5ElementMetadata.js +47 -6
  101. package/src/asset-registries/Icons.js +22 -8
  102. package/src/asset-registries/Illustrations.js +10 -3
  103. package/src/asset-registries/LocaleData.js +18 -4
  104. package/src/asset-registries/Themes.js +6 -2
  105. package/src/asset-registries/i18n.js +3 -1
  106. package/src/assets-meta/IconCollectionsAlias.js +18 -0
  107. package/src/config/Icons.js +52 -0
  108. package/src/config/Theme.js +25 -0
  109. package/src/css/BusyIndicator.css +80 -0
  110. package/src/css/FontFace.css +75 -0
  111. package/src/css/OverrideFontFace.css +32 -0
  112. package/src/css/SystemCSSVars.css +17 -0
  113. package/src/delegate/ItemNavigation.js +75 -4
  114. package/src/features/F6Navigation.js +110 -0
  115. package/src/features/OpenUI5Enablement.js +119 -0
  116. package/src/i18nBundle.js +33 -2
  117. package/src/renderer/LitRenderer.js +33 -12
  118. package/src/renderer/directives/style-map.js +72 -0
  119. package/src/renderer/executeTemplate.js +19 -2
  120. package/src/theming/CustomStyle.js +23 -3
  121. package/src/theming/applyTheme.js +11 -10
  122. package/src/theming/getEffectiveLinksHrefs.js +27 -0
  123. package/src/theming/getEffectiveStyle.js +9 -0
  124. package/src/theming/getStylesString.js +4 -2
  125. package/src/theming/getThemeDesignerTheme.js +25 -5
  126. package/src/theming/preloadLinks.js +23 -0
  127. package/src/types/DataType.js +12 -0
  128. package/src/types/Float.js +4 -0
  129. package/src/types/Integer.js +4 -0
  130. package/src/updateShadowRoot.js +9 -6
  131. package/src/util/Caret.js +1 -14
  132. package/src/util/ColorConversion.js +30 -2
  133. package/src/util/FocusableElements.js +8 -6
  134. package/src/util/InvisibleMessage.js +20 -9
  135. package/src/util/TabbableElements.js +4 -0
  136. package/src/util/createLinkInHead.js +19 -0
  137. package/src/util/escapeRegex.js +10 -0
  138. package/src/util/generateHighlightedMarkup.js +42 -0
  139. package/src/util/getNormalizedTarget.js +16 -0
  140. package/src/util/isDefaultSlotProvided.js +11 -0
  141. package/src/util/isNodeHidden.js +1 -1
  142. package/used-modules.txt +4 -1
  143. package/config/.eslintrc.js +0 -3
  144. package/config/rollup.config.js +0 -1
  145. package/dist/config/AssetsPath.js +0 -17
  146. package/dist/isLegacyBrowser.js +0 -3
  147. package/dist/resources/bundle.esm.js +0 -26
  148. package/dist/resources/bundle.esm.js.map +0 -1
  149. package/dist/test-resources/assets/Themes.js +0 -17
  150. package/dist/test-resources/elements/Child.js +0 -35
  151. package/dist/test-resources/elements/Generic.js +0 -84
  152. package/dist/test-resources/elements/GenericExt.js +0 -26
  153. package/dist/test-resources/elements/NoShadowDOM.js +0 -13
  154. package/dist/test-resources/elements/Parent.js +0 -41
  155. package/dist/test-resources/elements/WithStaticArea.js +0 -76
  156. package/dist/test-resources/pages/AllTestElements.html +0 -39
  157. package/dist/test-resources/pages/Configuration.html +0 -18
  158. package/dist/test-resources/pages/ConfigurationScript.html +0 -34
  159. package/dist/test-resources/pages/assets/messagebundle_de.properties +0 -1
  160. package/dist/test-resources/pages/assets/messagebundle_en.properties +0 -1
  161. package/dist/test-resources/pages/assets/messagebundle_es.properties +0 -1
  162. package/dist/test-resources/pages/assets/messagebundle_fr.properties +0 -1
  163. package/dist/test-resources/pages/i18n.html +0 -35
  164. package/dist/test-resources/specs/ConfigurationChange.spec.js +0 -27
  165. package/dist/test-resources/specs/ConfigurationScript.spec.js +0 -63
  166. package/dist/test-resources/specs/ConfigurationURL.spec.js +0 -93
  167. package/dist/test-resources/specs/CustomTheme.spec.js +0 -27
  168. package/dist/test-resources/specs/StaticArea.spec.js +0 -36
  169. package/dist/test-resources/specs/Theming.spec.js +0 -33
  170. package/dist/test-resources/specs/UI5ElementInvalidation.js +0 -242
  171. package/dist/test-resources/specs/UI5ElementLifecycle.js +0 -98
  172. package/dist/test-resources/specs/UI5ElementListenForChildPropChanges.spec.js +0 -75
  173. package/dist/test-resources/specs/UI5ElementMetadataExt.js +0 -42
  174. package/dist/test-resources/specs/UI5ElementPropertyValidation.js +0 -14
  175. package/dist/test-resources/specs/UI5ElementPropsAndAttrs.spec.js +0 -67
  176. package/dist/test-resources/specs/UI5ElementShadowDOM.js +0 -24
  177. package/dist/test-resources/specs/UI5ElementSlots.js +0 -36
  178. package/dist/theming/createThemePropertiesStyleTag.js +0 -20
  179. package/dist/util/encodeCSS.js +0 -24
  180. package/src/config/AssetsPath.js +0 -17
  181. package/src/isLegacyBrowser.js +0 -3
  182. package/src/theming/createThemePropertiesStyleTag.js +0 -20
  183. package/src/util/encodeCSS.js +0 -24
@@ -0,0 +1,32 @@
1
+ const fs = require('fs').promises;
2
+
3
+ const generate = async () => {
4
+ const version = JSON.parse(await fs.readFile("package.json")).version;
5
+
6
+ // Parse version
7
+ const matches = version.match(/^([0-9]+)\.([0-9]+)\.([0-9]+)(.*)$/);
8
+ if (!matches) {
9
+ throw new Error("Unsupported version format");
10
+ }
11
+
12
+ const isNext = version.match(/[a-f0-9]{9}$/);
13
+ const buildTime = Math.floor(new Date().getTime() / 1000);
14
+
15
+ const fileContent = `const VersionInfo = {
16
+ version: "${version}",
17
+ major: ${matches[1]},
18
+ minor: ${matches[2]},
19
+ patch: ${matches[3]},
20
+ suffix: "${matches[4]}",
21
+ isNext: ${isNext ? "true" : "false"},
22
+ buildTime: ${buildTime},
23
+ };
24
+ export default VersionInfo;`;
25
+
26
+ await fs.mkdir("dist/generated/", { recursive: true });
27
+ await fs.writeFile("dist/generated/VersionInfo.js", fileContent);
28
+ }
29
+
30
+ generate().then(() => {
31
+ console.log("Version info file generated.");
32
+ });
@@ -1,28 +1,27 @@
1
1
  const resolve = require("resolve");
2
+ const path = require("path");
2
3
 
3
4
  const assetParametersScript = resolve.sync("@ui5/webcomponents-base/lib/generate-asset-parameters/index.js");
4
- const serve = resolve.sync("@ui5/webcomponents-tools/lib/serve/index.js");
5
- const generateHash = resolve.sync("@ui5/webcomponents-tools/lib/hash/generate.js");
6
- const hashIsUpToDate = resolve.sync("@ui5/webcomponents-tools/lib/hash/upToDate.js");
5
+ const stylesScript = resolve.sync("@ui5/webcomponents-base/lib/generate-styles/index.js");
6
+ const versionScript = resolve.sync("@ui5/webcomponents-base/lib/generate-version-info/index.js");
7
7
  const copyUsedModules = resolve.sync("@ui5/webcomponents-tools/lib/copy-list/index.js");
8
- const replaceGlobalCore = resolve.sync("@ui5/webcomponents-tools/lib/replace-global-core/index.js");
9
8
  const esmAbsToRel = resolve.sync("@ui5/webcomponents-tools/lib/esm-abs-to-rel/index.js");
10
- const UP_TO_DATE = `node "${hashIsUpToDate}" dist/ hash.txt && echo "Up to date."`;
9
+
10
+ const LIB = path.join(__dirname, `../tools/lib/`);
11
+
12
+ const viteConfig = `-c "${require.resolve("@ui5/webcomponents-tools/components-package/vite.config.js")}"`;
13
+ const eslintConfig = `--config ${require.resolve("@ui5/webcomponents-tools/components-package/eslint.js")}`;
11
14
 
12
15
  const scripts = {
13
16
  clean: "rimraf dist && rimraf .port",
14
- lint: "eslint . --config config/.eslintrc.js",
15
- prepare: "nps clean integrate copy generateAssetParameters",
17
+ lint: `eslint . ${eslintConfig}`,
18
+ prepare: "nps clean integrate copy generateAssetParameters generateVersionInfo generateStyles",
16
19
  integrate: {
17
- default: "nps integrate.copy-used-modules integrate.copy-overlay integrate.replace-amd integrate.replace-export-true integrate.replace-export-false integrate.amd-to-es6 integrate.replace-global-core-usage integrate.esm-abs-to-rel integrate.third-party",
18
- "copy-used-modules": `node ${copyUsedModules} ./used-modules.txt dist/`,
19
- "copy-overlay": `copy-and-watch "overlay/**/*.js" dist/`,
20
+ default: "nps integrate.copy-used-modules integrate.replace-amd integrate.amd-to-es6 integrate.esm-abs-to-rel integrate.third-party",
21
+ "copy-used-modules": `node "${copyUsedModules}" ./used-modules.txt dist/`,
20
22
  "replace-amd": "replace-in-file sap.ui.define define dist/**/*.js",
21
- "replace-export-true": `replace-in-file ", /* bExport= */ true" "" dist/**/*.js`,
22
- "replace-export-false": `replace-in-file ", /* bExport= */ false" "" dist/**/*.js`,
23
23
  "amd-to-es6": "amdtoes6 --src=dist/ --replace --glob=**/*.js",
24
- "replace-global-core-usage": `node ${replaceGlobalCore} dist/`,
25
- "esm-abs-to-rel": `node ${esmAbsToRel} dist/ dist/`,
24
+ "esm-abs-to-rel": `node "${esmAbsToRel}" dist/ dist/`,
26
25
  "third-party": {
27
26
  default: "nps integrate.third-party.copy integrate.third-party.fix",
28
27
  copy: "mkdirp dist/sap/ui/thirdparty/ && copy-and-watch ../../node_modules/@openui5/sap.ui.core/src/sap/ui/thirdparty/caja-html-sanitizer.js dist/sap/ui/thirdparty/",
@@ -30,30 +29,25 @@ const scripts = {
30
29
  },
31
30
  },
32
31
  build: {
33
- default: `${UP_TO_DATE} || nps lint prepare build.bundle hash`,
34
- bundle: "rollup --config config/rollup.config.js",
32
+ default: `nps lint prepare build.bundle`,
33
+ bundle: `vite build ${viteConfig}`,
35
34
  },
36
35
  copy: {
37
- default: "nps copy.src copy.test",
38
- src: `copy-and-watch "src/**/*.js" dist/`,
39
- test: `copy-and-watch "test/**/*.*" dist/test-resources`,
36
+ default: "nps copy.src",
37
+ src: `copy-and-watch "src/**/*.{js,css}" dist/`,
40
38
  },
41
39
  generateAssetParameters: `node "${assetParametersScript}"`,
40
+ generateVersionInfo: `node "${versionScript}"`,
41
+ generateStyles: `node "${stylesScript}"`,
42
42
  watch: {
43
- default: 'concurrently "nps watch.test" "nps watch.src" "nps watch.bundle"',
43
+ default: 'concurrently "nps watch.src" "nps watch.styles"',
44
+ withBundle: 'concurrently "nps watch.src" "nps watch.bundle" "nps watch.styles"',
44
45
  src: 'nps "copy.src --watch --skip-initial-copy"',
45
- test: 'nps "copy.test --watch --skip-initial-copy"',
46
- bundle: "rollup --config config/rollup.config.js -w --environment DEV",
47
- },
48
- dev: 'concurrently "nps serve" "nps watch"',
49
- start: "nps prepare dev",
50
- serve: `node "${serve}" --dir="dist/" --port=9191 --packageName="@ui5/webcomponents-base"`,
51
- test: {
52
- // --success first - report the exit code of the test run (first command to finish), as serve is always terminated and has a non-0 exit code
53
- default: 'concurrently "nps serve" "nps test.run" --kill-others --success first',
54
- run: "cross-env WDIO_LOG_LEVEL=error FORCE_COLOR=0 wdio config/wdio.conf.js",
46
+ bundle: `node ${LIB}/dev-server/dev-server.js ${viteConfig}`,
47
+ styles: 'chokidar "src/css/*.css" -c "nps generateStyles"'
55
48
  },
56
- hash: `node "${generateHash}" dist/ hash.txt`,
49
+ start: "nps prepare watch.withBundle",
50
+ test: `node "${LIB}/test-runner/test-runner.js"`,
57
51
  };
58
52
 
59
53
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ui5/webcomponents-base",
3
- "version": "0.0.0-6ef02a35f",
3
+ "version": "0.0.0-7e7d9ea6f",
4
4
  "description": "UI5 Web Components: webcomponents.base",
5
5
  "author": "SAP SE (https://www.sap.com)",
6
6
  "license": "Apache-2.0",
@@ -28,23 +28,22 @@
28
28
  "start": "nps start",
29
29
  "build": "nps build",
30
30
  "test": "nps test",
31
- "hash": "nps hash",
32
31
  "prepublishOnly": "npm run clean && npm run build"
33
32
  },
34
33
  "dependencies": {
35
- "lit-html": "2.0.0-rc.3"
34
+ "lit-html": "^2.0.1"
36
35
  },
37
36
  "devDependencies": {
38
- "@ui5/webcomponents-tools": "0.0.0-6ef02a35f",
39
- "@buxlabs/amd-to-es6": "0.16.0",
40
- "@openui5/sap.ui.core": "1.87.3",
41
- "array-uniq": "^2.0.0",
42
- "chromedriver": "92.0.0",
37
+ "@buxlabs/amd-to-es6": "0.16.1",
38
+ "@openui5/sap.ui.core": "1.101.0",
39
+ "@ui5/webcomponents-tools": "0.0.0-7e7d9ea6f",
40
+ "chromedriver": "102.0.0",
41
+ "clean-css": "^5.2.2",
43
42
  "copy-and-watch": "^0.1.5",
43
+ "cross-env": "^7.0.3",
44
44
  "eslint": "^7.22.0",
45
- "eslint-config-airbnb-base": "^14.2.1",
46
- "npm-run-all": "^4.1.5",
47
- "path-exists-cli": "^1.0.0",
48
- "replace-in-file": "^6.2.0"
45
+ "mkdirp": "^1.0.4",
46
+ "replace-in-file": "^6.3.5",
47
+ "resolve": "^1.20.0"
49
48
  }
50
49
  }
package/src/Boot.js CHANGED
@@ -1,40 +1,56 @@
1
- import EventProvider from "./EventProvider.js";
2
1
  import whenDOMReady from "./util/whenDOMReady.js";
3
2
  import insertFontFace from "./FontFace.js";
4
3
  import insertSystemCSSVars from "./SystemCSSVars.js";
5
4
  import { getTheme } from "./config/Theme.js";
6
5
  import applyTheme from "./theming/applyTheme.js";
6
+ import { registerCurrentRuntime } from "./Runtimes.js";
7
7
  import { getFeature } from "./FeaturesRegistry.js";
8
8
 
9
- let booted = false;
10
- const eventProvider = new EventProvider();
9
+ let bootPromise;
11
10
 
12
11
  /**
13
12
  * Attach a callback that will be executed on boot
14
13
  * @public
15
14
  * @param listener
16
15
  */
17
- const attachBoot = listener => {
18
- eventProvider.attachEvent("boot", listener);
16
+ const attachBoot = async listener => {
17
+ await boot();
18
+ listener();
19
19
  };
20
20
 
21
21
  const boot = async () => {
22
- if (booted) {
23
- return;
22
+ if (bootPromise) {
23
+ return bootPromise;
24
24
  }
25
25
 
26
- const OpenUI5Support = getFeature("OpenUI5Support");
27
- if (OpenUI5Support) {
28
- await OpenUI5Support.init();
29
- }
26
+ /* eslint-disable no-alert, no-async-promise-executor */
27
+ /*
28
+ Note(since we disable eslint rule):
29
+ If an async executor function throws an error, the error will be lost and won't cause the newly-constructed Promise to reject.
30
+ This could make it difficult to debug and handle some errors.
31
+ */
32
+ bootPromise = new Promise(async resolve => {
33
+ registerCurrentRuntime();
34
+
35
+ const OpenUI5Support = getFeature("OpenUI5Support");
36
+ const F6Navigation = getFeature("F6Navigation");
37
+ if (OpenUI5Support) {
38
+ await OpenUI5Support.init();
39
+ } else if (F6Navigation) {
40
+ F6Navigation.init();
41
+ }
42
+
43
+ await whenDOMReady();
44
+ await applyTheme(getTheme());
45
+ OpenUI5Support && OpenUI5Support.attachListeners();
46
+ insertFontFace();
47
+ insertSystemCSSVars();
48
+
49
+ resolve();
50
+ });
51
+ /* eslint-enable no-alert, no-async-promise-executor */
30
52
 
31
- await whenDOMReady();
32
- await applyTheme(getTheme());
33
- OpenUI5Support && OpenUI5Support.attachListeners();
34
- insertFontFace();
35
- insertSystemCSSVars();
36
- await eventProvider.fireEventAsync("boot");
37
- booted = true;
53
+ return bootPromise;
38
54
  };
39
55
 
40
56
  export {
package/src/CSP.js ADDED
@@ -0,0 +1,59 @@
1
+ const roots = new Map();
2
+ let useLinks = false;
3
+ let preloadLinks = true;
4
+
5
+ /**
6
+ * Use this function to provide the path to the directory where the css resources for the given package will be served from
7
+ *
8
+ * @public
9
+ * @param packageName name of the package that is being configured
10
+ * @param root path, accessible by the server that will serve the css resources
11
+ */
12
+ const setPackageCSSRoot = (packageName, root) => {
13
+ roots.set(packageName, root);
14
+ };
15
+
16
+ const getUrl = (packageName, path) => {
17
+ return `${roots.get(packageName)}${path}`;
18
+ };
19
+
20
+ /**
21
+ * Call this function to enable or disable the usage of <link> tags instead of <style> tags to achieve CSP compliance
22
+ * Example: "setUseLinks(true)" will unconditionally use <link> tags for all browsers;
23
+ * Example: "setUseLinks(!document.adoptedStyleSheets) will only enable the usage of <link> tags for browsers that do not support constructable stylesheets.
24
+ *
25
+ * @public
26
+ * @param use whether links will be used
27
+ */
28
+ const setUseLinks = use => {
29
+ useLinks = use;
30
+ };
31
+
32
+ /**
33
+ * Call this function to enable or disable the preloading of <link> tags.
34
+ * Note: only taken into account when <link> tags are being used.
35
+ * Note: links are being preloaded by default, so call "setPreloadLinks(false)" to opt out of this.
36
+ *
37
+ * @public
38
+ * @param preload
39
+ */
40
+ const setPreloadLinks = preload => {
41
+ preloadLinks = preload;
42
+ };
43
+
44
+ const shouldUseLinks = () => {
45
+ return useLinks;
46
+ };
47
+
48
+ const shouldPreloadLinks = () => {
49
+ return preloadLinks;
50
+ };
51
+
52
+ export {
53
+ setPackageCSSRoot,
54
+ getUrl,
55
+ setUseLinks,
56
+ setPreloadLinks,
57
+ shouldUseLinks,
58
+ shouldPreloadLinks,
59
+ };
@@ -1,11 +1,18 @@
1
1
  import setToArray from "./util/setToArray.js";
2
+ import getSharedResource from "./getSharedResource.js";
3
+ import { getCurrentRuntimeIndex, compareRuntimes, getAllRuntimes } from "./Runtimes.js";
4
+
5
+ const Tags = getSharedResource("Tags", new Map());
2
6
 
3
7
  const Definitions = new Set();
4
- const Failures = new Set();
8
+ let Failures = {};
5
9
  let failureTimeout;
6
10
 
11
+ const UNKNOWN_RUNTIME = "unknown";
12
+
7
13
  const registerTag = tag => {
8
14
  Definitions.add(tag);
15
+ Tags.set(tag, getCurrentRuntimeIndex());
9
16
  };
10
17
 
11
18
  const isTagRegistered = tag => {
@@ -17,18 +24,67 @@ const getAllRegisteredTags = () => {
17
24
  };
18
25
 
19
26
  const recordTagRegistrationFailure = tag => {
20
- Failures.add(tag);
27
+ let tagRegRuntimeIndex = Tags.get(tag);
28
+ if (tagRegRuntimeIndex === undefined) {
29
+ tagRegRuntimeIndex = UNKNOWN_RUNTIME; // If the tag is taken, but not registered in Tags, then a version before 1.1.0 defined it => use the "unknown" key
30
+ }
31
+ Failures[tagRegRuntimeIndex] = Failures[tagRegRuntimeIndex] || new Set();
32
+ Failures[tagRegRuntimeIndex].add(tag);
33
+
21
34
  if (!failureTimeout) {
22
35
  failureTimeout = setTimeout(() => {
23
36
  displayFailedRegistrations();
37
+ Failures = {};
24
38
  failureTimeout = undefined;
25
39
  }, 1000);
26
40
  }
27
41
  };
28
42
 
29
43
  const displayFailedRegistrations = () => {
30
- console.warn(`The following tags have already been defined by a different UI5 Web Components version: ${setToArray(Failures).join(", ")}`); // eslint-disable-line
31
- Failures.clear();
44
+ const allRuntimes = getAllRuntimes();
45
+ const currentRuntimeIndex = getCurrentRuntimeIndex();
46
+ const currentRuntime = allRuntimes[currentRuntimeIndex];
47
+
48
+ let message = `Multiple UI5 Web Components instances detected.`;
49
+
50
+ if (allRuntimes.length > 1) {
51
+ message = `${message}\nLoading order (versions before 1.1.0 not listed): ${allRuntimes.map(runtime => `\n${runtime.description}`).join("")}`;
52
+ }
53
+
54
+ Object.keys(Failures).forEach(otherRuntimeIndex => {
55
+ let comparison;
56
+ let otherRuntime;
57
+
58
+ if (otherRuntimeIndex === UNKNOWN_RUNTIME) { // version < 1.1.0 defined the tag
59
+ comparison = 1; // the current runtime is considered newer
60
+ otherRuntime = {
61
+ description: `Older unknown runtime`,
62
+ };
63
+ } else {
64
+ comparison = compareRuntimes(currentRuntimeIndex, otherRuntimeIndex);
65
+ otherRuntime = allRuntimes[otherRuntimeIndex];
66
+ }
67
+
68
+ let compareWord;
69
+ if (comparison > 0) {
70
+ compareWord = "an older";
71
+ } else if (comparison < 0) {
72
+ compareWord = "a newer";
73
+ } else {
74
+ compareWord = "the same";
75
+ }
76
+ message = `${message}\n\n"${currentRuntime.description}" failed to define ${Failures[otherRuntimeIndex].size} tag(s) as they were defined by a runtime of ${compareWord} version "${otherRuntime.description}": ${setToArray(Failures[otherRuntimeIndex]).sort().join(", ")}.`;
77
+
78
+ if (comparison > 0) {
79
+ message = `${message}\nWARNING! If your code uses features of the above web components, unavailable in ${otherRuntime.description}, it might not work as expected!`;
80
+ } else {
81
+ message = `${message}\nSince the above web components were defined by the same or newer version runtime, they should be compatible with your code.`;
82
+ }
83
+ });
84
+
85
+ message = `${message}\n\nTo prevent other runtimes from defining tags that you use, consider using scoping or have third-party libraries use scoping: https://github.com/SAP/ui5-webcomponents/blob/main/docs/2-advanced/03-scoping.md.`;
86
+
87
+ console.warn(message); // eslint-disable-line
32
88
  };
33
89
 
34
90
  export {
@@ -1,102 +1,24 @@
1
- let suf;
2
- let rulesObj = {
3
- include: [/^ui5-/],
4
- exclude: [],
5
- };
6
- const tagsCache = new Map(); // true/false means the tag should/should not be cached, undefined means not known yet.
7
-
8
- /**
9
- * Sets the suffix to be used for custom elements scoping, f.e. pass "demo" to get tags such as "ui5-button-demo".
10
- * Note: by default all tags starting with "ui5-" will be scoped, unless you change this by calling "setCustomElementsScopingRules"
11
- *
12
- * @public
13
- * @param suffix The scoping suffix
14
- */
15
- const setCustomElementsScopingSuffix = suffix => {
16
- if (!suffix.match(/^[a-zA-Z0-9_-]+$/)) {
17
- throw new Error("Only alphanumeric characters and dashes allowed for the scoping suffix");
18
- }
19
-
20
- suf = suffix;
21
- };
22
-
23
- /**
24
- * Returns the currently set scoping suffix, or undefined if not set.
25
- *
26
- * @public
27
- * @returns {String|undefined}
28
- */
29
- const getCustomElementsScopingSuffix = () => {
30
- return suf;
31
- };
1
+ import {
2
+ html,
3
+ svg,
4
+ unsafeStatic,
5
+ } from "lit-html/static.js";
32
6
 
33
- /**
34
- * Sets the rules, governing which custom element tags to scope and which not, f.e.
35
- * setCustomElementsScopingRules({include: [/^ui5-/]}, exclude: [/^ui5-mylib-/, /^ui5-carousel$/]);
36
- * will scope all elements starting with "ui5-" but not the ones starting with "ui5-mylib-" and not "ui5-carousel".
37
- *
38
- * @public
39
- * @param rules Object with "include" and "exclude" properties, both arrays of regular expressions. Note that "include"
40
- * rules are applied first and "exclude" rules second.
41
- */
42
- const setCustomElementsScopingRules = rules => {
43
- if (!rules || !rules.include) {
44
- throw new Error(`"rules" must be an object with at least an "include" property`);
45
- }
46
-
47
- if (!Array.isArray(rules.include) || rules.include.some(rule => !(rule instanceof RegExp))) {
48
- throw new Error(`"rules.include" must be an array of regular expressions`);
49
- }
50
-
51
- if (rules.exclude && (!Array.isArray(rules.exclude) || rules.exclude.some(rule => !(rule instanceof RegExp)))) {
52
- throw new Error(`"rules.exclude" must be an array of regular expressions`);
53
- }
54
-
55
- rules.exclude = rules.exclude || [];
56
- rulesObj = rules;
57
- tagsCache.clear(); // reset the cache upon setting new rules
58
- };
59
-
60
- /**
61
- * Returns the rules, governing which custom element tags to scope and which not. By default, all elements
62
- * starting with "ui5-" are scoped. The default rules are: {include: [/^ui5-/]}.
63
- *
64
- * @public
65
- * @returns {Object}
66
- */
67
- const getCustomElementsScopingRules = () => {
68
- return rulesObj;
69
- };
70
-
71
- /**
72
- * Determines whether custom elements with the given tag should be scoped or not.
73
- * The tag is first matched against the "include" rules and then against the "exclude" rules and the
74
- * result is cached until new rules are set.
75
- *
76
- * @public
77
- * @param tag
78
- */
79
- const shouldScopeCustomElement = tag => {
80
- if (!tagsCache.has(tag)) {
81
- const result = rulesObj.include.some(rule => tag.match(rule)) && !rulesObj.exclude.some(rule => tag.match(rule));
82
- tagsCache.set(tag, result);
83
- }
84
-
85
- return tagsCache.get(tag);
86
- };
87
-
88
- /**
89
- * Returns the currently set scoping suffix, if any and if the tag should be scoped, or undefined otherwise.
90
- *
91
- * @public
92
- * @param tag
93
- * @returns {String}
94
- */
95
- const getEffectiveScopingSuffixForTag = tag => {
96
- if (shouldScopeCustomElement(tag)) {
97
- return getCustomElementsScopingSuffix();
98
- }
99
- };
7
+ import {
8
+ setCustomElementsScopingSuffix,
9
+ getCustomElementsScopingSuffix,
10
+ setCustomElementsScopingRules,
11
+ getCustomElementsScopingRules,
12
+ shouldScopeCustomElement,
13
+ getEffectiveScopingSuffixForTag,
14
+ } from "./CustomElementsScopeUtils.js";
15
+ import { registerFeature } from "./FeaturesRegistry.js";
16
+
17
+ registerFeature("LitStatic", {
18
+ html,
19
+ svg,
20
+ unsafeStatic,
21
+ });
100
22
 
101
23
  export {
102
24
  setCustomElementsScopingSuffix,
@@ -0,0 +1,108 @@
1
+ let suf;
2
+ let rulesObj = {
3
+ include: [/^ui5-/],
4
+ exclude: [],
5
+ };
6
+ const tagsCache = new Map(); // true/false means the tag should/should not be cached, undefined means not known yet.
7
+
8
+ /**
9
+ * Sets the suffix to be used for custom elements scoping, f.e. pass "demo" to get tags such as "ui5-button-demo".
10
+ * Note: by default all tags starting with "ui5-" will be scoped, unless you change this by calling "setCustomElementsScopingRules"
11
+ *
12
+ * @public
13
+ * @param suffix The scoping suffix
14
+ */
15
+ const setCustomElementsScopingSuffix = suffix => {
16
+ if (!suffix.match(/^[a-zA-Z0-9_-]+$/)) {
17
+ throw new Error("Only alphanumeric characters and dashes allowed for the scoping suffix");
18
+ }
19
+
20
+ suf = suffix;
21
+ };
22
+
23
+ /**
24
+ * Returns the currently set scoping suffix, or undefined if not set.
25
+ *
26
+ * @public
27
+ * @returns {String|undefined}
28
+ */
29
+ const getCustomElementsScopingSuffix = () => {
30
+ return suf;
31
+ };
32
+
33
+ /**
34
+ * Sets the rules, governing which custom element tags to scope and which not, f.e.
35
+ * setCustomElementsScopingRules({include: [/^ui5-/]}, exclude: [/^ui5-mylib-/, /^ui5-carousel$/]);
36
+ * will scope all elements starting with "ui5-" but not the ones starting with "ui5-mylib-" and not "ui5-carousel".
37
+ *
38
+ * @public
39
+ * @param rules Object with "include" and "exclude" properties, both arrays of regular expressions. Note that "include"
40
+ * rules are applied first and "exclude" rules second.
41
+ */
42
+ const setCustomElementsScopingRules = rules => {
43
+ if (!rules || !rules.include) {
44
+ throw new Error(`"rules" must be an object with at least an "include" property`);
45
+ }
46
+
47
+ if (!Array.isArray(rules.include) || rules.include.some(rule => !(rule instanceof RegExp))) {
48
+ throw new Error(`"rules.include" must be an array of regular expressions`);
49
+ }
50
+
51
+ if (rules.exclude && (!Array.isArray(rules.exclude) || rules.exclude.some(rule => !(rule instanceof RegExp)))) {
52
+ throw new Error(`"rules.exclude" must be an array of regular expressions`);
53
+ }
54
+
55
+ rules.exclude = rules.exclude || [];
56
+ rulesObj = rules;
57
+ tagsCache.clear(); // reset the cache upon setting new rules
58
+ };
59
+
60
+ /**
61
+ * Returns the rules, governing which custom element tags to scope and which not. By default, all elements
62
+ * starting with "ui5-" are scoped. The default rules are: {include: [/^ui5-/]}.
63
+ *
64
+ * @public
65
+ * @returns {Object}
66
+ */
67
+ const getCustomElementsScopingRules = () => {
68
+ return rulesObj;
69
+ };
70
+
71
+ /**
72
+ * Determines whether custom elements with the given tag should be scoped or not.
73
+ * The tag is first matched against the "include" rules and then against the "exclude" rules and the
74
+ * result is cached until new rules are set.
75
+ *
76
+ * @public
77
+ * @param tag
78
+ */
79
+ const shouldScopeCustomElement = tag => {
80
+ if (!tagsCache.has(tag)) {
81
+ const result = rulesObj.include.some(rule => tag.match(rule)) && !rulesObj.exclude.some(rule => tag.match(rule));
82
+ tagsCache.set(tag, result);
83
+ }
84
+
85
+ return tagsCache.get(tag);
86
+ };
87
+
88
+ /**
89
+ * Returns the currently set scoping suffix, if any and if the tag should be scoped, or undefined otherwise.
90
+ *
91
+ * @public
92
+ * @param tag
93
+ * @returns {String}
94
+ */
95
+ const getEffectiveScopingSuffixForTag = tag => {
96
+ if (shouldScopeCustomElement(tag)) {
97
+ return getCustomElementsScopingSuffix();
98
+ }
99
+ };
100
+
101
+ export {
102
+ setCustomElementsScopingSuffix,
103
+ getCustomElementsScopingSuffix,
104
+ setCustomElementsScopingRules,
105
+ getCustomElementsScopingRules,
106
+ shouldScopeCustomElement,
107
+ getEffectiveScopingSuffixForTag,
108
+ };
package/src/Device.js CHANGED
@@ -5,9 +5,13 @@ const chrome = !ie && /(Chrome|CriOS)/.test(ua);
5
5
  const safari = !ie && !chrome && /(Version|PhantomJS)\/(\d+\.\d+).*Safari/.test(ua);
6
6
  const webkit = !ie && /webkit/.test(ua);
7
7
  const windows = navigator.platform.indexOf("Win") !== -1;
8
+ const iOS = navigator.platform.match(/iPhone|iPad|iPod/) || (navigator.userAgent.match(/Mac/) && "ontouchend" in document);
8
9
  const android = !windows && /Android/.test(ua);
9
10
  const androidPhone = android && /(?=android)(?=.*mobile)/i.test(ua);
10
- const ipad = /ipad/i.test(ua);
11
+ const ipad = /ipad/i.test(ua) || (/Macintosh/i.test(ua) && "ontouchend" in document);
12
+ // With iOS 13 the string 'iPad' was removed from the user agent string through a browser setting, which is applied on all sites by default:
13
+ // "Request Desktop Website -> All websites" (for more infos see: https://forums.developer.apple.com/thread/119186).
14
+ // Therefore the OS is detected as MACINTOSH instead of iOS and the device is a tablet if the Device.support.touch is true.
11
15
 
12
16
  let windowsVersion;
13
17
  let webkitVersion;
@@ -91,6 +95,18 @@ const isDesktop = () => {
91
95
  return (!isTablet() && !isPhone()) || isWindows8OrAbove();
92
96
  };
93
97
 
98
+ const isCombi = () => {
99
+ return isTablet() && isDesktop();
100
+ };
101
+
102
+ const isIOS = () => {
103
+ return iOS;
104
+ };
105
+
106
+ const isAndroid = () => {
107
+ return android || androidPhone;
108
+ };
109
+
94
110
  export {
95
111
  supportsTouch,
96
112
  isIE,
@@ -99,4 +115,7 @@ export {
99
115
  isPhone,
100
116
  isTablet,
101
117
  isDesktop,
118
+ isCombi,
119
+ isIOS,
120
+ isAndroid,
102
121
  };