@ui5/webcomponents-tools 0.0.0-b053ad005 → 0.0.0-b132dd7b9

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 (82) hide show
  1. package/CHANGELOG.md +1899 -0
  2. package/README.md +6 -9
  3. package/assets-meta.js +13 -8
  4. package/bin/dev.js +1 -5
  5. package/components-package/eslint.js +66 -2
  6. package/components-package/nps.js +130 -72
  7. package/components-package/postcss.components.js +1 -21
  8. package/components-package/postcss.themes.js +1 -26
  9. package/components-package/vite.config.js +9 -0
  10. package/components-package/wdio.js +77 -15
  11. package/icons-collection/nps.js +13 -14
  12. package/lib/amd-to-es6/index.js +102 -0
  13. package/lib/amd-to-es6/no-remaining-require.js +33 -0
  14. package/lib/cem/custom-elements-manifest.config.mjs +530 -0
  15. package/lib/cem/event.mjs +168 -0
  16. package/lib/cem/schema-internal.json +1422 -0
  17. package/lib/cem/schema.json +1098 -0
  18. package/lib/cem/types-internal.d.ts +808 -0
  19. package/lib/cem/types.d.ts +736 -0
  20. package/lib/cem/utils.mjs +423 -0
  21. package/lib/cem/validate.js +67 -0
  22. package/lib/copy-and-watch/index.js +24 -1
  23. package/lib/copy-list/index.js +17 -17
  24. package/lib/create-icons/index.js +127 -72
  25. package/lib/create-illustrations/index.js +153 -66
  26. package/lib/create-new-component/Component.js +74 -0
  27. package/lib/create-new-component/ComponentTemplate.js +12 -0
  28. package/lib/create-new-component/index.js +60 -101
  29. package/lib/css-processors/css-processor-components.mjs +78 -0
  30. package/lib/css-processors/css-processor-themes.mjs +74 -0
  31. package/lib/css-processors/scope-variables.mjs +49 -0
  32. package/lib/css-processors/shared.mjs +56 -0
  33. package/lib/dev-server/custom-hot-update-plugin.js +39 -0
  34. package/lib/dev-server/dev-server.mjs +66 -0
  35. package/lib/dev-server/virtual-index-html-plugin.js +56 -0
  36. package/lib/generate-js-imports/illustrations.js +86 -0
  37. package/lib/generate-json-imports/i18n.js +58 -67
  38. package/lib/generate-json-imports/themes.js +36 -46
  39. package/lib/hbs2lit/src/compiler.js +24 -4
  40. package/lib/hbs2lit/src/includesReplacer.js +5 -5
  41. package/lib/hbs2lit/src/litVisitor2.js +85 -22
  42. package/lib/hbs2lit/src/svgProcessor.js +12 -5
  43. package/lib/hbs2ui5/RenderTemplates/LitRenderer.js +39 -6
  44. package/lib/hbs2ui5/index.js +57 -24
  45. package/lib/i18n/defaults.js +66 -57
  46. package/lib/i18n/toJSON.js +12 -11
  47. package/lib/postcss-combine-duplicated-selectors/index.js +185 -0
  48. package/lib/remove-dev-mode/remove-dev-mode.mjs +37 -0
  49. package/lib/scoping/get-all-tags.js +11 -11
  50. package/lib/scoping/lint-src.js +8 -7
  51. package/lib/scoping/missing-dependencies.js +65 -0
  52. package/lib/scoping/report-tags-usage.js +28 -0
  53. package/lib/scoping/scope-test-pages.js +2 -1
  54. package/lib/test-runner/test-runner.js +71 -0
  55. package/package.json +36 -32
  56. package/tsconfig.json +18 -0
  57. package/components-package/rollup-plugins/empty-module.js +0 -15
  58. package/components-package/rollup.js +0 -237
  59. package/components-package/wdio.sync.js +0 -344
  60. package/lib/documentation/index.js +0 -165
  61. package/lib/documentation/templates/api-component-since.js +0 -3
  62. package/lib/documentation/templates/api-css-variables-section.js +0 -24
  63. package/lib/documentation/templates/api-events-section.js +0 -35
  64. package/lib/documentation/templates/api-methods-section.js +0 -26
  65. package/lib/documentation/templates/api-properties-section.js +0 -40
  66. package/lib/documentation/templates/api-slots-section.js +0 -28
  67. package/lib/documentation/templates/template.js +0 -38
  68. package/lib/esm-abs-to-rel/index.js +0 -54
  69. package/lib/hash/config.js +0 -10
  70. package/lib/hash/generate.js +0 -19
  71. package/lib/hash/upToDate.js +0 -31
  72. package/lib/jsdoc/config.json +0 -29
  73. package/lib/jsdoc/plugin.js +0 -2427
  74. package/lib/jsdoc/template/publish.js +0 -4101
  75. package/lib/polyfill-placeholder/index.js +0 -5
  76. package/lib/postcss-css-to-esm/index.js +0 -45
  77. package/lib/postcss-css-to-json/index.js +0 -36
  78. package/lib/postcss-new-files/index.js +0 -36
  79. package/lib/replace-global-core/index.js +0 -20
  80. package/lib/serve/index.js +0 -46
  81. package/lib/serve/serve.json +0 -3
  82. package/package-lock.json +0 -48
@@ -0,0 +1,86 @@
1
+ const fs = require("fs").promises;
2
+ const path = require("path");
3
+
4
+ const generateDynamicImportLines = async (fileNames, location, exclusionPatterns = []) => {
5
+ const packageName = JSON.parse(await fs.readFile("package.json")).name;
6
+ return fileNames
7
+ .filter((fileName) => !exclusionPatterns.some((pattern) => fileName.startsWith(pattern)))
8
+ .map((fileName) => {
9
+ const illustrationName = fileName.replace(".js", "");
10
+ const illustrationPath = `${location}/${illustrationName}`;
11
+ return `\t\tcase "${fileName.replace('.js', '')}": return (await import(/* webpackChunkName: "${packageName.replace("@", "").replace("/", "-")}-${illustrationName.toLowerCase()}" */ "${illustrationPath}.js")).default;`;
12
+ })
13
+ .join("\n");
14
+ };
15
+
16
+ const generateAvailableIllustrationsArray = (fileNames, exclusionPatterns = []) => {
17
+ return JSON.stringify(
18
+ fileNames
19
+ .filter((fileName) => !exclusionPatterns.some((pattern) => fileName.startsWith(pattern)))
20
+ .map((fileName) => fileName.replace(".js", ""))
21
+ );
22
+ };
23
+
24
+ const generateDynamicImportsFileContent = (dynamicImports, availableIllustrations, collection, set, prefix = "") => {
25
+ return `// @ts-nocheck
26
+ import { registerIllustrationLoader } from "@ui5/webcomponents-base/dist/asset-registries/Illustrations.js";
27
+
28
+ export const loadIllustration = async (illustrationName) => {
29
+ const collectionAndPrefix = "${set}/${collection}/${prefix}";
30
+ const cleanIllustrationName = illustrationName.startsWith(collectionAndPrefix) ? illustrationName.replace(collectionAndPrefix, "") : illustrationName;
31
+ switch (cleanIllustrationName) {
32
+ ${dynamicImports}
33
+ default:
34
+ throw new Error("[Illustrations] Illustration not found: " + illustrationName);
35
+ }
36
+ };
37
+
38
+ const loadAndCheck = async (illustrationName) => {
39
+ const data = await loadIllustration(illustrationName);
40
+ return data;
41
+ };
42
+
43
+ ${availableIllustrations}.forEach((illustrationName) =>
44
+ registerIllustrationLoader(\`${set}/${collection}/${prefix}\${illustrationName}\`, loadAndCheck)
45
+ );
46
+ `;
47
+ };
48
+
49
+ const getMatchingFiles = async (folder, pattern) => {
50
+ const dir = await fs.readdir(folder);
51
+ return dir.filter((fileName) => fileName.match(pattern));
52
+ };
53
+
54
+ const generateIllustrations = async (config) => {
55
+ const { inputFolder, outputFile, collection, location, prefix, filterOut, set } = config;
56
+
57
+ const normalizedInputFolder = path.normalize(inputFolder);
58
+ const normalizedOutputFile = path.normalize(outputFile);
59
+
60
+ const illustrations = await getMatchingFiles(normalizedInputFolder, /^.*\.js$/);
61
+
62
+ const dynamicImports = await generateDynamicImportLines(illustrations, location, filterOut);
63
+ const availableIllustrations = generateAvailableIllustrationsArray(illustrations, filterOut);
64
+
65
+ const contentDynamic = generateDynamicImportsFileContent(dynamicImports, availableIllustrations, collection, set, prefix);
66
+
67
+ await fs.mkdir(path.dirname(normalizedOutputFile), { recursive: true });
68
+ await fs.writeFile(normalizedOutputFile, contentDynamic);
69
+
70
+ console.log(`Generated ${normalizedOutputFile}`);
71
+ };
72
+
73
+ // Parse configuration from command-line arguments
74
+ const config = {
75
+ inputFolder: process.argv[2],
76
+ outputFile: process.argv[3],
77
+ set: process.argv[4],
78
+ collection: process.argv[5],
79
+ location: process.argv[6],
80
+ filterOut: process.argv.slice[7],
81
+ };
82
+
83
+ // Run the generation process
84
+ generateIllustrations(config).catch((error) => {
85
+ console.error("Error generating illustrations:", error);
86
+ });
@@ -1,91 +1,82 @@
1
- const fs = require("fs");
1
+ const fs = require("fs").promises;
2
2
  const path = require('path');
3
- const mkdirp = require("mkdirp");
4
3
 
5
- const packageName = JSON.parse(fs.readFileSync("package.json")).name;
4
+ const isTypeScript = process.env.UI5_TS;
5
+ const ext = isTypeScript ? 'ts' : 'js';
6
6
 
7
- const inputFolder = path.normalize(process.argv[2]);
8
- const outputFile = path.normalize(`${process.argv[3]}/i18n-static.js`);
9
- const outputFileDynamic = path.normalize(`${process.argv[3]}/i18n.js`);
10
7
 
11
- // All languages present in the file system
12
- const files = fs.readdirSync(inputFolder);
13
- const languages = files.map(file => {
14
- const matches = file.match(/messagebundle_(.+?).json$/);
15
- return matches ? matches[1] : undefined;
16
- }).filter(key => !!key);
8
+ const getContent = function(caseLines, languagesKeysStringArray, packageName) {
9
+ return `// @ts-nocheck
10
+ import { registerI18nLoader } from "@ui5/webcomponents-base/dist/asset-registries/i18n.js";
17
11
 
18
- let contentStatic, contentDynamic;
19
-
20
- // No i18n - just import dependencies, if any
21
- if (languages.length === 0) {
22
- contentStatic = "";
23
- contentDynamic = "";
24
- // There is i18n - generate the full file
25
- } else {
26
- // Keys for the array
27
- const languagesKeysString = languages.map(key => `"${key}": _${key},`).join("\n\t");
28
- const languagesKeysStringArray = languages.map(key => `"${key}",`).join("\n\t");
29
-
30
- // Actual imports for json assets
31
- const assetsImportsString = languages.map(key => `import _${key} from "../assets/i18n/messagebundle_${key}.json";`).join("\n");
32
-
33
- // static imports
34
- contentStatic = `import { registerI18nLoader } from "@ui5/webcomponents-base/dist/asset-registries/i18n.js";
35
-
36
- ${assetsImportsString}
37
-
38
- const bundleMap = {
39
- ${languagesKeysString}
40
- };
12
+ const importMessageBundle = async (localeId) => {
13
+ switch (localeId) {
14
+ ${caseLines}
15
+ default: throw "unknown locale"
16
+ }
17
+ }
41
18
 
42
- const fetchMessageBundle = async (localeId) => {
43
- if (typeof bundleMap[localeId] === "object") {
44
- // inlined from build
45
- throw new Error("[i18n] Inlined JSON not supported with static imports of assets. Use dynamic imports of assets or configure JSON imports as URLs")
19
+ const importAndCheck = async (localeId) => {
20
+ const data = await importMessageBundle(localeId);
21
+ if (typeof data === "string" && data.endsWith(".json")) {
22
+ throw new Error(\`[i18n] Invalid bundling detected - dynamic JSON imports bundled as URLs. Switch to inlining JSON files from the build. Check the \"Assets\" documentation for more information.\`);
46
23
  }
47
- return (await fetch(bundleMap[localeId])).json()
24
+ return data;
48
25
  }
49
26
 
50
27
  const localeIds = [${languagesKeysStringArray}];
51
28
 
52
29
  localeIds.forEach(localeId => {
53
- registerI18nLoader("${packageName}", localeId, fetchMessageBundle);
30
+ registerI18nLoader("${packageName}", localeId, importAndCheck);
54
31
  });
55
32
  `;
33
+ }
56
34
 
57
- // Actual imports for json assets
58
- const dynamicImportsString = languages.map(key => ` case "${key}": return (await import("../assets/i18n/messagebundle_${key}.json")).default;`).join("\n");
35
+ const generate = async () => {
59
36
 
60
- // Resulting file content
61
- contentDynamic = `import { registerI18nLoader } from "@ui5/webcomponents-base/dist/asset-registries/i18n.js";
37
+ const packageName = JSON.parse(await fs.readFile("package.json")).name;
62
38
 
63
- const importMessageBundle = async (localeId) => {
64
- switch (localeId) {
65
- ${dynamicImportsString}
66
- default: throw "unknown locale"
67
- }
68
- }
39
+ const inputFolder = path.normalize(process.argv[2]);
40
+ const outputFileDynamic = path.normalize(`${process.argv[3]}/i18n.${ext}`);
41
+ const outputFileFetchMetaResolve = path.normalize(`${process.argv[3]}/i18n-fetch.${ext}`);
69
42
 
70
- const importAndCheck = async (localeId) => {
71
- const data = await importMessageBundle(localeId);
72
- if (typeof data === "string" && data.endsWith(".json")) {
73
- throw new Error(\`[i18n] Invalid bundling detected - dynamic JSON imports bundled as URLs. Switch to inlining JSON files from the build or use 'import ".../Assets-static.js"'. Check the \"Assets\" documentation for more information.\`);
74
- }
75
- return data;
76
- }
43
+ // All languages present in the file system
44
+ const files = await fs.readdir(inputFolder);
45
+ const languages = files.map(file => {
46
+ const matches = file.match(/messagebundle_(.+?).json$/);
47
+ return matches ? matches[1] : undefined;
48
+ }).filter(key => !!key);
77
49
 
78
- const localeIds = [${languagesKeysStringArray}];
50
+ let contentDynamic;
51
+ let contentFetchMetaResolve;
79
52
 
80
- localeIds.forEach(localeId => {
81
- registerI18nLoader("${packageName}", localeId, importAndCheck);
82
- });
83
- `;
53
+ // No i18n - just import dependencies, if any
54
+ if (languages.length === 0) {
55
+ contentDynamic = "";
56
+ contentFetchMetaResolve = "";
57
+ // There is i18n - generate the full file
58
+ } else {
59
+ // Keys for the array
60
+ const languagesKeysStringArray = languages.map(key => `"${key}",`).join("\n\t");
84
61
 
62
+ // Actual imports for json assets
63
+ const dynamicImportsString = languages.map(key => ` case "${key}": return (await import(/* webpackChunkName: "${packageName.replace("@", "").replace("/", "-")}-messagebundle-${key}" */ "../assets/i18n/messagebundle_${key}.json")).default;`).join("\n");
64
+ const fetchMetaResolveString = languages.map(key => ` case "${key}": return (await fetch(new URL("../assets/i18n/messagebundle_${key}.json", import.meta.url))).json();`).join("\n");
85
65
 
86
- }
66
+ // Resulting file content
67
+
68
+ contentDynamic = getContent(dynamicImportsString, languagesKeysStringArray, packageName);
69
+ contentFetchMetaResolve = getContent(fetchMetaResolveString, languagesKeysStringArray, packageName);
87
70
 
71
+ }
72
+
73
+ await fs.mkdir(path.dirname(outputFileDynamic), { recursive: true });
74
+ return Promise.all([
75
+ fs.writeFile(outputFileDynamic, contentDynamic),
76
+ fs.writeFile(outputFileFetchMetaResolve, contentFetchMetaResolve),
77
+ ]);
78
+ }
88
79
 
89
- mkdirp.sync(path.dirname(outputFile));
90
- fs.writeFileSync(outputFile, contentStatic);
91
- fs.writeFileSync(outputFileDynamic, contentDynamic);
80
+ generate().then(() => {
81
+ console.log("Generated i18n JSON imports.");
82
+ });
@@ -1,73 +1,63 @@
1
- const fs = require("fs");
1
+ const fs = require("fs").promises;
2
2
  const path = require('path');
3
- const mkdirp = require("mkdirp");
4
3
  const assets = require("../../assets-meta.js");
5
4
 
6
- const inputFolder = path.normalize(process.argv[2]);
7
- const outputFile = path.normalize(`${process.argv[3]}/Themes-static.js`);
8
- const outputFileDynamic = path.normalize(`${process.argv[3]}/Themes.js`);
5
+ const isTypeScript = process.env.UI5_TS;
6
+ const ext = isTypeScript ? 'ts' : 'js';
7
+
8
+ const generate = async () => {
9
+ const inputFolder = path.normalize(process.argv[2]);
10
+ const outputFileDynamic = path.normalize(`${process.argv[3]}/Themes.${ext}`);
11
+ const outputFileFetchMetaResolve = path.normalize(`${process.argv[3]}/Themes-fetch.${ext}`);
9
12
 
10
13
  // All supported optional themes
11
- const allThemes = assets.themes.all;
14
+ const allThemes = assets.themes.all;
12
15
 
13
16
  // All themes present in the file system
14
- const dirs = fs.readdirSync(inputFolder);
15
- const themesOnFileSystem = dirs.map(dir => {
16
- const matches = dir.match(/sap_.*$/);
17
- return matches ? dir : undefined;
18
- }).filter(key => !!key && allThemes.includes(key));
19
-
20
- const packageName = JSON.parse(fs.readFileSync("package.json")).name;
21
-
22
- const importLines = themesOnFileSystem.map(theme => `import ${theme} from "../assets/themes/${theme}/parameters-bundle.css.json";`).join("\n");
23
- const themeUrlsByName = "{\n" + themesOnFileSystem.join(",\n") + "\n}";
24
- const availableThemesArray = `[${themesOnFileSystem.map(theme => `"${theme}"`).join(", ")}]`;
25
- const dynamicImportLines = themesOnFileSystem.map(theme => `\t\tcase "${theme}": return (await import("../assets/themes/${theme}/parameters-bundle.css.json")).default;`).join("\n");
26
-
27
-
28
- // static imports file content
29
- const contentStatic = `import { registerThemePropertiesLoader } from "@ui5/webcomponents-base/dist/asset-registries/Themes.js";
30
-
31
- ${importLines}
32
-
33
- const themeUrlsByName = ${themeUrlsByName};
34
- const isInlined = obj => typeof (obj) === "object";
17
+ const dirs = await fs.readdir(inputFolder);
18
+ const themesOnFileSystem = dirs.map(dir => {
19
+ const matches = dir.match(/sap_.*$/);
20
+ return matches ? dir : undefined;
21
+ }).filter(key => !!key && allThemes.includes(key));
35
22
 
36
- const loadThemeProperties = async (themeName) => {
37
- if (typeof themeUrlsByName[themeName] === "object") {
38
- // inlined from build
39
- throw new Error("[themes] Inlined JSON not supported with static imports of assets. Use dynamic imports of assets or configure JSON imports as URLs");
40
- }
41
- return (await fetch(themeUrlsByName[themeName])).json();
42
- }
43
-
44
- ${availableThemesArray}
45
- .forEach(themeName => registerThemePropertiesLoader("${packageName}", themeName, loadThemeProperties));
46
- `;
23
+ const packageName = JSON.parse(await fs.readFile("package.json")).name;
47
24
 
25
+ const availableThemesArray = `[${themesOnFileSystem.map(theme => `"${theme}"`).join(", ")}]`;
26
+ const dynamicImportLines = themesOnFileSystem.map(theme => `\t\tcase "${theme}": return (await import(/* webpackChunkName: "${packageName.replace("@", "").replace("/", "-")}-${theme.replace("_", "-")}-parameters-bundle" */"../assets/themes/${theme}/parameters-bundle.css.json")).default;`).join("\n");
27
+ const fetchMetaResolveLines = themesOnFileSystem.map(theme => `\t\tcase "${theme}": return (await fetch(new URL("../assets/themes/${theme}/parameters-bundle.css.json", import.meta.url))).json();`).join("\n");
48
28
 
49
29
  // dynamic imports file content
50
- const contentDynamic = `import { registerThemePropertiesLoader } from "@ui5/webcomponents-base/dist/asset-registries/Themes.js";
30
+ const contentDynamic = function (lines) {
31
+ return `// @ts-nocheck
32
+ import { registerThemePropertiesLoader } from "@ui5/webcomponents-base/dist/asset-registries/Themes.js";
51
33
 
52
34
  const loadThemeProperties = async (themeName) => {
53
35
  switch (themeName) {
54
- ${dynamicImportLines}
36
+ ${lines}
55
37
  default: throw "unknown theme"
56
38
  }
57
- }
39
+ };
58
40
 
59
41
  const loadAndCheck = async (themeName) => {
60
42
  const data = await loadThemeProperties(themeName);
61
43
  if (typeof data === "string" && data.endsWith(".json")) {
62
- throw new Error(\`[themes] Invalid bundling detected - dynamic JSON imports bundled as URLs. Switch to inlining JSON files from the build or use 'import ".../Assets-static.js"'. Check the \"Assets\" documentation for more information.\`);
44
+ throw new Error(\`[themes] Invalid bundling detected - dynamic JSON imports bundled as URLs. Switch to inlining JSON files from the build. Check the \"Assets\" documentation for more information.\`);
63
45
  }
64
46
  return data;
65
- }
47
+ };
66
48
 
67
49
  ${availableThemesArray}
68
50
  .forEach(themeName => registerThemePropertiesLoader("${packageName}", themeName, loadAndCheck));
69
51
  `;
52
+ }
53
+
54
+ await fs.mkdir(path.dirname(outputFileDynamic), { recursive: true });
55
+ return Promise.all([
56
+ fs.writeFile(outputFileDynamic, contentDynamic(dynamicImportLines)),
57
+ fs.writeFile(outputFileFetchMetaResolve, contentDynamic(fetchMetaResolveLines)),
58
+ ]);
59
+ };
70
60
 
71
- mkdirp.sync(path.dirname(outputFile));
72
- fs.writeFileSync(outputFile, contentStatic);
73
- fs.writeFileSync(outputFileDynamic, contentDynamic);
61
+ generate().then(() => {
62
+ console.log("Generated themes JSON imports.");
63
+ });
@@ -12,15 +12,25 @@ const removeWhiteSpaces = (source) => {
12
12
  .replace(/}}\s+{{/g, "}}{{"); // Remove whitespace between }} and {{
13
13
  };
14
14
 
15
- const hbs2lit = (file) => {
16
- let sPreprocessed = includesReplacer.replace(file);
15
+ const hbs2lit = async (file, componentName) => {
16
+ let sPreprocessed = await includesReplacer.replace(file);
17
17
 
18
18
  sPreprocessed = removeWhiteSpaces(sPreprocessed);
19
19
 
20
+ const blockSignature = process.env.UI5_TS ? `this: ${componentName}` : ""
21
+
22
+ // icons hack
23
+ if (sPreprocessed.startsWith("<g ") || sPreprocessed.startsWith("<g>")) {
24
+ return `
25
+ function block0 (${blockSignature}) {
26
+ return svg\`${sPreprocessed}\`
27
+ }`;
28
+ }
29
+
20
30
  const ast = Handlebars.parse(sPreprocessed);
21
31
 
22
32
  const pv = new PartialsVisitor();
23
- const lv = new HTMLLitVisitor();
33
+ const lv = new HTMLLitVisitor(componentName);
24
34
 
25
35
  let result = "";
26
36
 
@@ -30,7 +40,17 @@ const hbs2lit = (file) => {
30
40
  lv.accept(ast);
31
41
 
32
42
  for (let key in lv.blocks) {
33
- result += lv.blocks[key] + "\n";
43
+ let block = lv.blocks[key];
44
+
45
+ if (block.match(/scopeTag/)) {
46
+ // const matches = block.match(/^(.*?)( => )(.*?);$/);
47
+ const matches = block.match(/^(function .*? \{ return )(.*?);\}$/);
48
+ const scopedCode = matches[2];
49
+ const normalCode = scopedCode.replace(/\${scopeTag\("/g, "").replace(/", tags, suffix\)}/g, "");
50
+ block = `${matches[1]}suffix ? ${scopedCode} : ${normalCode};}`;
51
+ }
52
+
53
+ result += block + "\n";
34
54
  }
35
55
 
36
56
  result = svgProcessor.process(result);
@@ -1,9 +1,9 @@
1
1
  const path = require("path");
2
- const fs = require("fs");
2
+ const fs = require("fs").promises;
3
3
 
4
- function replaceIncludes(file) {
4
+ const replaceIncludes = async (file) => {
5
5
  const filePath = path.dirname(file);
6
- let fileContent = fs.readFileSync(file, "utf-8");
6
+ let fileContent = await fs.readFile(file, "utf-8");
7
7
 
8
8
  const inclRegex = /{{>\s*include\s*["'](.+?)["']}}/g;
9
9
  let match;
@@ -20,11 +20,11 @@ function replaceIncludes(file) {
20
20
  targetFile = require.resolve(targetFile);
21
21
  }
22
22
 
23
- fileContent = fileContent.replace(match[0], replaceIncludes(targetFile));
23
+ fileContent = fileContent.replace(match[0], await replaceIncludes(targetFile));
24
24
  }
25
25
 
26
26
  return fileContent;
27
- }
27
+ };
28
28
 
29
29
  module.exports = {
30
30
  replace: replaceIncludes
@@ -28,14 +28,18 @@ if (!String.prototype.replaceAll) {
28
28
  };
29
29
  }
30
30
 
31
- function HTMLLitVisitor(debug) {
31
+ function HTMLLitVisitor(componentName, debug) {
32
32
  this.blockCounter = 0;
33
33
  this.keys = [];
34
34
  this.blocks = {};
35
35
  this.result = "";
36
36
  this.mainBlock = "";
37
- this.blockPath = "context";
38
- this.blockParameters = ["context", "tags", "suffix"];
37
+ this.blockLevel = 0;
38
+ this.componentName = componentName
39
+ const blockParametersDefinitionTS = [`this: ${componentName}`, "context: UI5Element", "tags: string[]", "suffix: string | undefined"];
40
+ const blockParametersDefinitionJS = ["context", "tags", "suffix"];
41
+ this.blockParametersDefinition = process.env.UI5_TS ? blockParametersDefinitionTS : blockParametersDefinitionJS;
42
+ this.blockParametersUsage = ["this", "context", "tags", "suffix"];
39
43
  this.paths = []; //contains all normalized relative paths
40
44
  this.debug = debug;
41
45
  if (this.debug) {
@@ -51,18 +55,18 @@ HTMLLitVisitor.prototype.Program = function(program) {
51
55
  this.keys.push(key);
52
56
  this.debug && this.blockByNumber.push(key);
53
57
 
54
- this.blocks[this.currentKey()] = "const " + this.currentKey() + " = (" + this.blockParameters.join(", ") + ") => ";
58
+ // this.blocks[this.currentKey()] = "function " + this.currentKey() + ` (this: any, ` + this.blockParametersDefinition.join(", ") + ") { ";
59
+ this.blocks[this.currentKey()] = `function ${this.currentKey()} (${this.blockParametersDefinition.join(", ")}) { `;
55
60
 
56
61
  if (this.keys.length > 1) { //it's a nested block
57
- this.blocks[this.prevKey()] += this.currentKey() + "(" + this.blockParameters.join(", ") + ")";
62
+ this.blocks[this.prevKey()] += this.currentKey() + ".call(" + this.blockParametersUsage.join(", ") + ")";
58
63
  } else {
59
64
  this.mainBlock = this.currentKey();
60
- this.paths.push(this.blockPath);
61
65
  }
62
66
 
63
- this.blocks[this.currentKey()] += "html`";
67
+ this.blocks[this.currentKey()] += "return html`";
64
68
  Visitor.prototype.Program.call(this, program);
65
- this.blocks[this.currentKey()] += "`;";
69
+ this.blocks[this.currentKey()] += "`;}";
66
70
 
67
71
  this.keys.pop(key);
68
72
  };
@@ -99,14 +103,18 @@ HTMLLitVisitor.prototype.MustacheStatement = function(mustache) {
99
103
  this.blocks[this.currentKey()] += "${index}";
100
104
  } else {
101
105
  const path = normalizePath.call(this, mustache.path.original);
102
- const hasCalculatingClasses = path.includes("context.classes");
106
+ const hasCalculatingClasses = path.includes("this.classes");
103
107
 
104
108
  let parsedCode = "";
105
109
 
106
110
  if (isNodeValue && !mustache.escaped) {
107
111
  parsedCode = `\${unsafeHTML(${path})}`;
108
112
  } else if (hasCalculatingClasses) {
109
- parsedCode = `\${classMap(${path})}`;
113
+ if (process.env.UI5_TS) {
114
+ parsedCode = `\${classMap(${path} as ClassMapValue)}`;
115
+ } else {
116
+ parsedCode = `\${classMap(${path})}`;
117
+ }
110
118
  } else if (isStyleAttribute) {
111
119
  parsedCode = `\${styleMap(${path})}`;
112
120
  } else if (skipIfDefined){
@@ -171,22 +179,37 @@ function visitEachBlock(block) {
171
179
  var bParamAdded = false;
172
180
  visitSubExpression.call(this, block);
173
181
 
174
- this.blocks[this.currentKey()] += "${ repeat(" + normalizePath.call(this, block.params[0].original) + ", (item, index) => item._id || index, (item, index) => ";
182
+ const reapeatDirectiveParamsTS = "(item, index) => (item as typeof item & {_id?: any})._id || index, (item, index: number)";
183
+ const reapeatDirectiveParamsJS = "(item, index) => item._id || index, (item, index)";
184
+ const repleatDirectiveParams = process.env.UI5_TS ? reapeatDirectiveParamsTS : reapeatDirectiveParamsJS;
185
+ this.blocks[this.currentKey()] += "${ repeat(" + normalizePath.call(this, block.params[0].original) + ", " + repleatDirectiveParams + " => ";
175
186
  this.paths.push(normalizePath.call(this, block.params[0].original));
176
- this.blockPath = "item";
187
+ this.blockLevel++;
177
188
 
178
- if (this.blockParameters.indexOf("item") === -1) {
189
+ // block params is [this, context, tags, suffix] for top level blocks
190
+ // blcok params is [this, context, tags, suffix, item, index] for nested blocks
191
+ if (!this.blockParametersUsage.includes("index")) {
192
+ // last item is not index, but an each block is processed, add the paramters for further nested blocks
179
193
  bParamAdded = true;
180
- this.blockParameters.unshift("index");
181
- this.blockParameters.unshift("item");
194
+ if (process.env.UI5_TS) {
195
+ this.blockParametersDefinition.push("item: any");
196
+ this.blockParametersDefinition.push("index: number");
197
+ } else {
198
+ this.blockParametersDefinition.push("item");
199
+ this.blockParametersDefinition.push("index");
200
+ }
201
+ this.blockParametersUsage.push("item");
202
+ this.blockParametersUsage.push("index");
182
203
  }
183
204
  this.acceptKey(block, "program");
184
205
  if (bParamAdded) {
185
- this.blockParameters.shift("item");
186
- this.blockParameters.shift("index");
206
+ // if parameters were added at this step, remove the last two
207
+ this.blockParametersDefinition.pop();
208
+ this.blockParametersDefinition.pop();
209
+ this.blockParametersUsage.pop();
210
+ this.blockParametersUsage.pop();
187
211
  }
188
- this.blockPath = "context";
189
-
212
+ this.blockLevel--;
190
213
  this.blocks[this.currentKey()] += ") }";
191
214
  }
192
215
 
@@ -195,12 +218,52 @@ function normalizePath(sPath) {
195
218
 
196
219
  //read carefully - https://github.com/wycats/handlebars.js/issues/1028
197
220
  //kpdecker commented on May 20, 2015
198
- if (result.indexOf("../") === 0) {
199
- let absolutePath = replaceAll(this.paths[this.paths.length - 1], ".", "/") + "/" + result;
221
+
222
+ if (result.indexOf("@root") === 0) {
223
+ // Trying to access root context via the HBS "@root" variable.
224
+ // Example: {{@root.property}} compiles to "context.property" - called from anywhere within the template.
225
+ result = result.replace("@root", "this");
226
+
227
+ } else if (result.indexOf("../") === 0) {
228
+ let absolutePath;
229
+ const levelsUp = (result.match(/..\//g) || []).length;
230
+
231
+ if (this.blockLevel <= levelsUp) {
232
+ // Trying to access root context from nested loops.
233
+ // Example: {{../../property}} compiles to "context.property" - when currently in a nested level loop.
234
+ // Example: {{../../../property}} compile to "context.property" - when requested levels are not present. fallback to root context.
235
+ absolutePath = `this.${replaceAll(result,"../", "")}`;
236
+ } else {
237
+ // Trying to access upper context (one-level-up) and based on the current lelev, that could be "context" or "item".
238
+ // Example: {{../property}} compiles to "context.property" - when called in a top level loop.
239
+ // Example: {{../property}} compiles to "item.property" - when called in a nested level loop.
240
+ // TODO: the second example, although correctly generated to "item.property", "item" will point to the current object within the nested loop,
241
+ // not the upper level loop as intended. So accessing the upper loop from nested loop is currently not working.
242
+ absolutePath = replaceAll(this.paths[this.paths.length - 1 - levelsUp], ".", "/") + "/" + result;
243
+ }
244
+
200
245
  result = replaceAll(path.normalize(absolutePath), path.sep, ".");
246
+
201
247
  } else {
202
- result = result ? replaceAll(this.blockPath + "/" + result, "/", ".") : this.blockPath;
248
+ // When neither "@root", nor "../" are used, use the following contexts:
249
+ // - use "context" - for the top level of execution, e.g "this.blockLevel = 0".
250
+ // - use "item" - for any nested level, e.g "this.blockLevel > 0".
251
+ // Example:
252
+ //
253
+ // {{text}} -> compiles to "context.text"
254
+ // {{#each items}}
255
+ // Item text: {{text}}</div> -> compiles to "item.text"
256
+ // {{#each words}}
257
+ // Word text: {{text}}</div> -> compiles to "item.text"
258
+ // {{/each}}
259
+ // Item text: {{text}}</div> -> compiles to "item.text"
260
+ // {{/each}}
261
+ // {{text}} -> compiles to "context.text"
262
+
263
+ const blockPath = this.blockLevel > 0 ? "item" : "this";
264
+ result = result ? replaceAll(blockPath + "/" + result, "/", ".") : blockPath;
203
265
  }
266
+
204
267
  return result;
205
268
  }
206
269
 
@@ -2,7 +2,7 @@
2
2
  const svgrx = new RegExp(/<svg[\s\S]*?>([\s\S]*?)<\/svg>/, 'g');
3
3
  const blockrx = /block[0-9]+/g;
4
4
 
5
- function process(input) {
5
+ function processSVG(input) {
6
6
  let matches;
7
7
  let template = input;
8
8
  let blockCounter = 0;
@@ -45,9 +45,16 @@ function getSVGMatches(template) {
45
45
  }
46
46
 
47
47
  function getSVGBlock(input, blockCounter) {
48
+ const definitionTS = `\nfunction blockSVG${blockCounter} (this: any, context: UI5Element, tags: string[], suffix: string | undefined) {
49
+ return svg\`${input}\`;
50
+ };`;
51
+ const definitionJS = `\nfunction blockSVG${blockCounter} (context, tags, suffix) {
52
+ return svg\`${input}\`;
53
+ };`;
54
+
48
55
  return {
49
- usage: `\${blockSVG${blockCounter}(context, tags, suffix)}`,
50
- definition: `\nconst blockSVG${blockCounter} = (context, tags, suffix) => svg\`${input}\`;`,
56
+ usage: `\${blockSVG${blockCounter}.call(this, context, tags, suffix)}`,
57
+ definition: process.env.UI5_TS ? definitionTS : definitionJS,
51
58
  };
52
59
  }
53
60
 
@@ -55,7 +62,7 @@ function replaceInternalBlocks(template, svgContent) {
55
62
  const internalBlocks = svgContent.match(blockrx) || [];
56
63
 
57
64
  internalBlocks.forEach(blockName => {
58
- const rx = new RegExp(`const ${blockName}.*(html\`).*;`);
65
+ const rx = new RegExp(`function ${blockName}.*(html\`).*;`);
59
66
  template = template.replace(rx, (match, p1) => {
60
67
  return match.replace(p1, "svg\`");
61
68
  });
@@ -65,5 +72,5 @@ function replaceInternalBlocks(template, svgContent) {
65
72
  }
66
73
 
67
74
  module.exports = {
68
- process: process
75
+ process: processSVG,
69
76
  };