@ui5/webcomponents-tools 0.0.0-b0b835975 → 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 (60) hide show
  1. package/CHANGELOG.md +1290 -0
  2. package/README.md +3 -5
  3. package/assets-meta.js +7 -9
  4. package/components-package/eslint.js +59 -29
  5. package/components-package/nps.js +75 -46
  6. package/components-package/postcss.components.js +1 -24
  7. package/components-package/postcss.themes.js +1 -30
  8. package/components-package/vite.config.js +7 -11
  9. package/components-package/wdio.js +415 -400
  10. package/icons-collection/nps.js +7 -5
  11. package/lib/amd-to-es6/index.js +102 -0
  12. package/lib/amd-to-es6/no-remaining-require.js +33 -0
  13. package/lib/cem/custom-elements-manifest.config.mjs +530 -0
  14. package/lib/cem/event.mjs +168 -0
  15. package/lib/cem/schema-internal.json +1422 -0
  16. package/lib/cem/schema.json +1098 -0
  17. package/lib/cem/types-internal.d.ts +808 -0
  18. package/lib/cem/types.d.ts +736 -0
  19. package/lib/cem/utils.mjs +423 -0
  20. package/lib/cem/validate.js +67 -0
  21. package/lib/create-icons/index.js +13 -10
  22. package/lib/create-illustrations/index.js +40 -33
  23. package/lib/create-new-component/{tsFileContentTemplate.js → Component.js} +15 -21
  24. package/lib/create-new-component/ComponentTemplate.js +12 -0
  25. package/lib/create-new-component/index.js +14 -22
  26. package/lib/css-processors/css-processor-components.mjs +78 -0
  27. package/lib/css-processors/css-processor-themes.mjs +74 -0
  28. package/lib/css-processors/scope-variables.mjs +49 -0
  29. package/lib/css-processors/shared.mjs +56 -0
  30. package/lib/dev-server/custom-hot-update-plugin.js +4 -4
  31. package/lib/dev-server/{dev-server.js → dev-server.mjs} +4 -4
  32. package/lib/dev-server/virtual-index-html-plugin.js +24 -20
  33. package/lib/generate-js-imports/illustrations.js +17 -14
  34. package/lib/generate-json-imports/i18n.js +45 -61
  35. package/lib/generate-json-imports/themes.js +16 -33
  36. package/lib/hbs2ui5/RenderTemplates/LitRenderer.js +12 -7
  37. package/lib/hbs2ui5/index.js +3 -3
  38. package/lib/i18n/defaults.js +3 -2
  39. package/lib/postcss-combine-duplicated-selectors/index.js +12 -5
  40. package/lib/remove-dev-mode/remove-dev-mode.mjs +37 -0
  41. package/lib/scoping/get-all-tags.js +10 -3
  42. package/lib/scoping/lint-src.js +8 -7
  43. package/lib/scoping/scope-test-pages.js +2 -1
  44. package/package.json +16 -12
  45. package/tsconfig.json +18 -0
  46. package/components-package/wdio.sync.js +0 -368
  47. package/lib/create-new-component/jsFileContentTemplate.js +0 -73
  48. package/lib/esm-abs-to-rel/index.js +0 -58
  49. package/lib/generate-custom-elements-manifest/index.js +0 -327
  50. package/lib/jsdoc/config.json +0 -29
  51. package/lib/jsdoc/configTypescript.json +0 -29
  52. package/lib/jsdoc/plugin.js +0 -2468
  53. package/lib/jsdoc/preprocess.js +0 -146
  54. package/lib/jsdoc/template/publish.js +0 -4120
  55. package/lib/postcss-css-to-esm/index.js +0 -90
  56. package/lib/postcss-css-to-json/index.js +0 -47
  57. package/lib/postcss-new-files/index.js +0 -36
  58. package/lib/postcss-p/postcss-p.mjs +0 -14
  59. package/lib/postcss-scope-vars/index.js +0 -24
  60. package/lib/replace-global-core/index.js +0 -25
@@ -0,0 +1,423 @@
1
+ import fs from "fs";
2
+ import path from "path";
3
+
4
+ let documentationErrors = new Map();
5
+
6
+ const packageRegex = /^((@([a-z0-9._-]+)\/)?([a-z0-9._-]+))/;
7
+
8
+ const getDeprecatedStatus = (jsdocComment) => {
9
+ const deprecatedTag = findTag(jsdocComment, "deprecated");
10
+ return deprecatedTag?.name
11
+ ? deprecatedTag.description
12
+ ? `${deprecatedTag.name} ${deprecatedTag.description}`
13
+ : deprecatedTag.name
14
+ : deprecatedTag
15
+ ? true
16
+ : undefined;
17
+ };
18
+
19
+ const getExperimentalStatus = (jsdocComment) => {
20
+ const experimentalTag = findTag(jsdocComment, "experimental");
21
+ return experimentalTag?.name
22
+ ? experimentalTag.description
23
+ ? `${experimentalTag.name} ${experimentalTag.description}`
24
+ : experimentalTag.name
25
+ : experimentalTag
26
+ ? true
27
+ : undefined;
28
+ };
29
+
30
+ const toKebabCase = str => {
31
+ return str.replaceAll(/[A-Z]+(?![a-z])|[A-Z]/g, ($, ofs) => (ofs ? "-" : "") + $.toLowerCase())
32
+ }
33
+
34
+ const normalizeDescription = (description) => {
35
+ return typeof description === 'string' ? description.replaceAll(/^-\s+|^(\n)+|(\n)+$/g, "") : description;
36
+ }
37
+
38
+ const getTypeRefs = (ts, node, member) => {
39
+ const extractTypeRefs = (type) => {
40
+ if (type?.kind === ts.SyntaxKind.TypeReference) {
41
+ return type.typeArguments?.length
42
+ ? type.typeArguments.map((typeRef) => typeRef.typeName?.text)
43
+ : [type.typeName?.text];
44
+ } else if (type?.kind === ts.SyntaxKind.ArrayType) {
45
+ return [type.elementType?.typeName?.text];
46
+ } else if (type?.kind === ts.SyntaxKind.UnionType) {
47
+ return type.types
48
+ .map((type) => extractTypeRefs(type))
49
+ .flat(1);
50
+ } else if (type?.kind === ts.SyntaxKind.TemplateLiteralType) {
51
+ if (member?.type) {
52
+ member.type.text = member.type.text.replaceAll?.(/`|\${|}/g, "");
53
+ }
54
+
55
+ return type.templateSpans?.length
56
+ ? type.templateSpans.map((typeRef) => typeRef.type?.typeName?.text)
57
+ : [type.typeName?.text];
58
+ }
59
+ };
60
+
61
+ let typeRefs = extractTypeRefs(node.type) || node?.typeArguments?.map(n => extractTypeRefs(n)).flat(2);
62
+
63
+ if (typeRefs) {
64
+ typeRefs = typeRefs.filter((e) => !!e);
65
+ }
66
+
67
+ return typeRefs?.length ? typeRefs : undefined;
68
+ };
69
+
70
+ const getSinceStatus = (jsdocComment) => {
71
+ const sinceTag = findTag(jsdocComment, "since");
72
+ return sinceTag
73
+ ? sinceTag.description
74
+ ? `${sinceTag.name} ${sinceTag.description}`
75
+ : sinceTag.name
76
+ : undefined;
77
+ };
78
+
79
+ const getPrivacyStatus = (jsdocComment) => {
80
+ const privacyTag = findTag(jsdocComment, ["public", "private", "protected"]);
81
+ return privacyTag?.tag || "private";
82
+ };
83
+
84
+ const findPackageName = (ts, sourceFile, typeName) => {
85
+ const localStatements = [
86
+ ts.SyntaxKind.EnumDeclaration,
87
+ ts.SyntaxKind.InterfaceDeclaration,
88
+ ts.SyntaxKind.ClassDeclaration,
89
+ ts.SyntaxKind.TypeAliasDeclaration,
90
+ ];
91
+
92
+ const isLocalDeclared = sourceFile.statements.some(
93
+ (statement) =>
94
+ localStatements.includes(statement.kind) && statement?.name?.text === typeName
95
+ );
96
+
97
+ if (isLocalDeclared) {
98
+ return packageJSON?.name;
99
+ } else {
100
+ const importStatements = sourceFile.statements?.filter(
101
+ (statement) => statement.kind === ts.SyntaxKind.ImportDeclaration
102
+ );
103
+ const currentModuleSpecifier = importStatements.find((statement) => {
104
+ if (statement.importClause?.name?.text === typeName) {
105
+ return true;
106
+ }
107
+
108
+ return statement.importClause?.namedBindings?.elements?.some(
109
+ (element) => element.name?.text === typeName
110
+ );
111
+ })?.moduleSpecifier;
112
+
113
+ if (currentModuleSpecifier?.text?.startsWith(".")) {
114
+ return packageJSON?.name;
115
+ } else {
116
+ // my-package/test
117
+ // my-package
118
+ // @scope/my-package
119
+ // my.package
120
+ // _mypackage
121
+ // mypackage-
122
+ // scope/my-package/test
123
+ // @scope/my-package/test
124
+ const match = currentModuleSpecifier?.text.match(packageRegex);
125
+ let packageName;
126
+
127
+ if (match) {
128
+ packageName = match[1];
129
+ }
130
+
131
+ return packageName || undefined;
132
+ }
133
+ }
134
+ };
135
+
136
+ const findImportPath = (ts, sourceFile, typeName, modulePath) => {
137
+ const localStatements = [
138
+ ts.SyntaxKind.EnumDeclaration,
139
+ ts.SyntaxKind.InterfaceDeclaration,
140
+ ts.SyntaxKind.ClassDeclaration,
141
+ ts.SyntaxKind.TypeAliasDeclaration,
142
+ ];
143
+
144
+ const isLocalDeclared = sourceFile.statements.some(
145
+ (statement) =>
146
+ localStatements.includes(statement.kind) && statement?.name?.text === typeName
147
+ );
148
+
149
+ if (isLocalDeclared) {
150
+ return (
151
+ modulePath?.replace("src", "dist")?.replace(".ts", ".js") || undefined
152
+ );
153
+ } else {
154
+ const importStatements = sourceFile.statements?.filter(
155
+ (statement) => statement.kind === ts.SyntaxKind.ImportDeclaration
156
+ );
157
+ const currentModuleSpecifier = importStatements.find((statement) => {
158
+ if (statement.importClause?.name?.text === typeName) {
159
+ return true;
160
+ }
161
+
162
+ return statement.importClause?.namedBindings?.elements?.some(
163
+ (element) => element.name?.text === typeName
164
+ );
165
+ })?.moduleSpecifier;
166
+
167
+ if (currentModuleSpecifier?.text?.startsWith(".")) {
168
+ return (
169
+ path.join(path.dirname(modulePath), currentModuleSpecifier.text)
170
+ ?.replace("src", "dist")?.replace(".ts", ".js") || undefined
171
+ );
172
+ } else {
173
+ let packageName = currentModuleSpecifier?.text?.replace(packageRegex, "") || undefined;
174
+
175
+ if (packageName?.startsWith("/")) {
176
+ packageName = packageName.replace("/", "");
177
+ }
178
+
179
+ return packageName;
180
+ }
181
+ }
182
+ };
183
+
184
+
185
+ const isClass = text => {
186
+ return text.includes("@abstract") || text.includes("@class") || text.includes("@constructor");
187
+ };
188
+
189
+ const normalizeTagType = (type) => {
190
+ return type?.trim();
191
+ }
192
+
193
+ const packageJSON = JSON.parse(fs.readFileSync("./package.json"));
194
+
195
+ const getReference = (ts, type, classNode, modulePath) => {
196
+ let sourceFile = classNode.parent;
197
+
198
+ while (sourceFile && sourceFile.kind !== ts.SyntaxKind.SourceFile) {
199
+ sourceFile = sourceFile.parent;
200
+ }
201
+
202
+ const typeName =
203
+ typeof type === "string"
204
+ ? normalizeTagType(type)
205
+ : type.class?.expression?.text ||
206
+ type.typeExpression?.type?.getText() ||
207
+ type.typeExpression?.type?.elementType?.typeName?.text;
208
+ const packageName = findPackageName(ts, sourceFile, typeName);
209
+ const importPath = findImportPath(
210
+ ts,
211
+ sourceFile,
212
+ typeName,
213
+ modulePath
214
+ )?.replace(`${packageName}/`, "");
215
+
216
+ return packageName && {
217
+ name: typeName,
218
+ package: packageName,
219
+ module: importPath,
220
+ };
221
+ };
222
+
223
+ const getType = (type) => {
224
+ const typeName = typeof type === "string" ? normalizeTagType(type) : type?.type;
225
+
226
+ const multiple =
227
+ typeName?.endsWith("[]") || typeName?.startsWith("Array<");
228
+ const name = multiple
229
+ ? typeName?.replace("[]", "")?.replace("Array<", "")?.replace(">", "")
230
+ : typeName;
231
+
232
+ return typeName ? { typeName: multiple ? `Array<${name}>` : typeName, name, multiple } : undefined;
233
+ };
234
+
235
+ const commonTags = ["public", "protected", "private", "since", "deprecated"];
236
+
237
+ const allowedTags = {
238
+ field: [...commonTags, "formEvents", "formProperty", "default"],
239
+ slot: [...commonTags, "default"],
240
+ event: [...commonTags, "param", "native", "allowPreventDefault"],
241
+ eventParam: [...commonTags],
242
+ method: [...commonTags, "param", "returns", "override"],
243
+ class: [...commonTags, "constructor", "class", "abstract", "experimental", "implements", "extends", "slot", "csspart"],
244
+ enum: [...commonTags, "experimental",],
245
+ enumMember: [...commonTags, "experimental",],
246
+ interface: [...commonTags, "experimental",],
247
+ };
248
+ allowedTags.getter = [...allowedTags.field, "override"]
249
+
250
+ const tagMatchCallback = (tag, tagName) => {
251
+ const currentTagName = tag.tag;
252
+
253
+ return typeof tagName === "string"
254
+ ? currentTagName === tagName
255
+ : tagName.includes(currentTagName);
256
+ };
257
+
258
+ const findDecorator = (node, decoratorName) => {
259
+ return (node?.modifiers || node?.decorators)?.find(
260
+ (decorator) =>
261
+ decorator?.expression?.expression?.text === decoratorName
262
+ );
263
+ };
264
+
265
+ const findAllDecorators = (node, decoratorName) => {
266
+ if (typeof decoratorName === "string") {
267
+ return (node?.modifiers || node?.decorators)?.filter(decorator => decorator?.expression?.expression?.text === decoratorName) || [];
268
+ }
269
+
270
+ if (Array.isArray(decoratorName)) {
271
+ return (node?.modifiers || node?.decorators)?.filter(decorator => {
272
+ if (decorator?.expression?.expression?.text) {
273
+ return decoratorName.includes(decorator.expression.expression.text);
274
+ }
275
+
276
+ return false;
277
+ }
278
+ ) || [];
279
+ }
280
+
281
+ return [];
282
+ };
283
+
284
+ const hasTag = (jsDoc, tagName) => {
285
+ if (!jsDoc) {
286
+ return;
287
+ }
288
+
289
+ return jsDoc?.tags?.some((tag) => tagMatchCallback(tag, tagName));
290
+ };
291
+
292
+ const findTag = (jsDoc, tagName) => {
293
+ if (!jsDoc) {
294
+ return;
295
+ }
296
+
297
+ return jsDoc?.tags?.find((tag) => tagMatchCallback(tag, tagName));
298
+ };
299
+
300
+ const findAllTags = (jsDoc, tagName) => {
301
+ if (!jsDoc) {
302
+ return [];
303
+ }
304
+
305
+ const foundTags = jsDoc?.tags?.filter((tag) => tagMatchCallback(tag, tagName));
306
+
307
+ return foundTags || [];
308
+ };
309
+
310
+ const validateJSDocTag = (tag) => {
311
+ const booleanTags = ["private", "protected", "public", "abstract", "native", "allowPreventDefault", "formProperty", "constructor", "override"];
312
+ let tagName = tag.tag;
313
+
314
+ if (booleanTags.includes(tag.tag)) {
315
+ tagName = "boolean";
316
+ }
317
+
318
+ switch (tagName) {
319
+ case "boolean":
320
+ return !tag.name && !tag.type && !tag.description;
321
+ case "deprecated":
322
+ return !tag.type;
323
+ case "experimental":
324
+ return !tag.type;
325
+ case "extends":
326
+ return !tag.type && tag.name && !tag.description;
327
+ case "implements":
328
+ return tag.type && !tag.name && !tag.description;
329
+ case "slot":
330
+ return tag.type && tag.name && tag.description;
331
+ case "csspart":
332
+ return !tag.type && tag.name && tag.description;
333
+ case "since":
334
+ return !tag.type && tag.name;
335
+ case "returns":
336
+ return !tag.type && tag.name;
337
+ case "default":
338
+ return !tag.type && !tag.description;
339
+ case "class":
340
+ return !tag.type;
341
+ case "param":
342
+ return !tag.type && tag.name;
343
+ case "eventparam":
344
+ return tag.type && tag.name;
345
+ case "formEvents":
346
+ return !tag.type && tag.name;
347
+ default:
348
+ return false;
349
+ }
350
+ };
351
+
352
+ const validateJSDocComment = (fieldType, jsdocComment, node, moduleDoc) => {
353
+ return !!jsdocComment?.tags?.every((tag) => {
354
+ let isValid = false
355
+
356
+ if (fieldType === "event" && tag?.tag === "param") {
357
+ isValid = allowedTags[fieldType]?.includes(tag.tag) && validateJSDocTag({ ...tag, tag: "eventparam" });
358
+ } else {
359
+ isValid = allowedTags[fieldType]?.includes(tag.tag) && validateJSDocTag(tag);
360
+ }
361
+
362
+ if (!isValid) {
363
+ logDocumentationError(moduleDoc.path, `Incorrect use of @${tag.tag}. Ensure it is part of ${fieldType} JSDoc tags.`)
364
+ }
365
+
366
+ return !!isValid;
367
+ });
368
+ };
369
+
370
+ const logDocumentationError = (modulePath, message) => {
371
+ let moduleErrors = documentationErrors.get(modulePath);
372
+
373
+ if (!moduleErrors) {
374
+ documentationErrors.set(modulePath, []);
375
+ moduleErrors = documentationErrors.get(modulePath);
376
+ }
377
+
378
+ moduleErrors.push(message);
379
+ }
380
+
381
+ const displayDocumentationErrors = () => {
382
+ let errorsCount = 0;
383
+ [...documentationErrors.keys()].forEach(modulePath => {
384
+ const moduleErrors = documentationErrors.get(modulePath);
385
+
386
+ console.log(`=== ERROR: ${moduleErrors.length > 1 ? `${moduleErrors.length} problems` : "Problem"} found in file: ${modulePath}:`)
387
+ moduleErrors.forEach(moduleError => {
388
+ errorsCount++;
389
+ console.log(`\t- ${moduleError}`)
390
+ })
391
+ })
392
+
393
+ if (errorsCount) {
394
+ throw new Error(`Found ${errorsCount} errors in the description of the public API.`);
395
+ }
396
+ }
397
+
398
+ const formatArrays = (typeText) => {
399
+ return typeText?.replaceAll(/(\S+)\[\]/g, "Array<$1>")
400
+ }
401
+
402
+ export {
403
+ getPrivacyStatus,
404
+ getSinceStatus,
405
+ getDeprecatedStatus,
406
+ getExperimentalStatus,
407
+ getType,
408
+ getReference,
409
+ validateJSDocComment,
410
+ findDecorator,
411
+ findAllDecorators,
412
+ hasTag,
413
+ findTag,
414
+ findAllTags,
415
+ getTypeRefs,
416
+ normalizeDescription,
417
+ formatArrays,
418
+ isClass,
419
+ normalizeTagType,
420
+ displayDocumentationErrors,
421
+ logDocumentationError,
422
+ toKebabCase
423
+ };
@@ -0,0 +1,67 @@
1
+ const fs = require('fs');
2
+ const Ajv = require('ajv');
3
+ const path = require('path');
4
+ // Load your JSON schema
5
+ const extenalSchema = require('./schema.json');
6
+ const internalSchema = require('./schema-internal.json');
7
+
8
+ // Load your JSON data from the input file
9
+ const inputFilePath = path.join(process.cwd(), "dist/custom-elements.json"); // Update with your file path
10
+ const customManifest = fs.readFileSync(inputFilePath, 'utf8');
11
+ const inputDataInternal = JSON.parse(customManifest);
12
+ const devMode = process.env.UI5_CEM_MODE === "dev";
13
+
14
+ inputDataInternal.modules.forEach(moduleDoc => {
15
+ moduleDoc.exports = moduleDoc.exports.
16
+ filter(e => moduleDoc.declarations.find(d => d.name === e.declaration.name && ["class", "function", "variable", "enum"].includes(d.kind)) || e.name === "default");
17
+ })
18
+
19
+ const clearProps = (data) => {
20
+ if (Array.isArray(data)) {
21
+ for (let i = 0; i < data.length; i++) {
22
+ if (typeof data[i] === "object") {
23
+ if (["enum", "interface"].includes(data[i].kind)) {
24
+ data.splice(i, 1);
25
+ i--;
26
+ } else {
27
+ clearProps(data[i]);
28
+ }
29
+ }
30
+ }
31
+ } else if (typeof data === "object") {
32
+ Object.keys(data).forEach(prop => {
33
+ if (prop.startsWith("_ui5")) {
34
+ delete data[prop];
35
+ } else if (typeof data[prop] === "object") {
36
+ clearProps(data[prop]);
37
+ }
38
+ });
39
+ }
40
+
41
+ return data;
42
+ }
43
+
44
+ const ajv = new Ajv({ allowUnionTypes: true, allError: true })
45
+ let validate = ajv.compile(internalSchema)
46
+
47
+ // Validate the JSON data against the schema
48
+ if (devMode) {
49
+ if (validate(inputDataInternal)) {
50
+ console.log('Internal custom element manifest is validated successfully');
51
+ } else {
52
+ console.log(validate.errors)
53
+ throw new Error(`Validation of internal custom elements manifest failed: ${validate.errors}`);
54
+ }
55
+ }
56
+
57
+ const inputDataExternal = clearProps(JSON.parse(JSON.stringify(inputDataInternal)));
58
+ validate = ajv.compile(extenalSchema)
59
+
60
+ // Validate the JSON data against the schema
61
+ if (validate(inputDataExternal)) {
62
+ console.log('Custom element manifest is validated successfully');
63
+ fs.writeFileSync(inputFilePath, JSON.stringify(inputDataExternal, null, 2), 'utf8');
64
+ fs.writeFileSync(inputFilePath.replace("custom-elements", "custom-elements-internal"), JSON.stringify(inputDataInternal, null, 2), 'utf8');
65
+ } else if (devMode) {
66
+ throw new Error(`Validation of public custom elements manifest failed: ${validate.errors}`);
67
+ }
@@ -21,8 +21,8 @@ export default "${collection}/${name}";
21
21
  export { pathData, ltr, accData };`;
22
22
 
23
23
 
24
- const iconAccTemplate = (name, pathData, ltr, accData, collection, packageName) => `import { registerIcon } from "@ui5/webcomponents-base/dist/asset-registries/Icons.js";
25
- import { ${accData.key} } from "../generated/i18n/i18n-defaults.js";
24
+ const iconAccTemplate = (name, pathData, ltr, accData, collection, packageName, versioned) => `import { registerIcon } from "@ui5/webcomponents-base/dist/asset-registries/Icons.js";
25
+ import { ${accData.key} } from "${versioned ? "../" : "./"}generated/i18n/i18n-defaults.js";
26
26
 
27
27
  const name = "${name}";
28
28
  const pathData = "${pathData}";
@@ -38,14 +38,16 @@ export { pathData, ltr, accData };`;
38
38
 
39
39
 
40
40
 
41
- const collectionTemplate = (name, versions, fullName) => `import { isLegacyThemeFamily } from "@ui5/webcomponents-base/dist/config/Theme.js";
41
+ const collectionTemplate = (name, versions, fullName) => `import { isLegacyThemeFamilyAsync } from "@ui5/webcomponents-base/dist/config/Theme.js";
42
42
  import { pathData as pathData${versions[0]}, ltr, accData } from "./${versions[0]}/${name}.js";
43
43
  import { pathData as pathData${versions[1]} } from "./${versions[1]}/${name}.js";
44
44
 
45
- const pathData = isLegacyThemeFamily() ? pathData${versions[0]} : pathData${versions[1]};
45
+ const getPathData = async() => {
46
+ return await isLegacyThemeFamilyAsync() ? pathDatav4 : pathDatav5;
47
+ };
46
48
 
47
49
  export default "${fullName}";
48
- export { pathData, ltr, accData };`;
50
+ export { getPathData, ltr, accData };`;
49
51
 
50
52
 
51
53
  const typeDefinitionTemplate = (name, accData, collection) => `declare const pathData: string;
@@ -56,13 +58,13 @@ declare const _default: "${collection}/${name}";
56
58
  export default _default;
57
59
  export { pathData, ltr, accData };`
58
60
 
59
- const collectionTypeDefinitionTemplate = (name, accData) => `declare const pathData: string;
61
+ const collectionTypeDefinitionTemplate = (name, accData) => `declare const getPathData: () => Promise<string>;
60
62
  declare const ltr: boolean;
61
63
  declare const accData: ${accData ? '{ key: string; defaultText: string; }' : null}
62
64
  declare const _default: "${name}";
63
65
 
64
66
  export default _default;
65
- export { pathData, ltr, accData };`
67
+ export { getPathData, ltr, accData };`
66
68
 
67
69
 
68
70
  const svgTemplate = (pathData) => `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512">
@@ -82,8 +84,9 @@ const createIcons = async (file) => {
82
84
  const acc = iconData.acc;
83
85
  const packageName = json.packageName;
84
86
  const collection = json.collection;
87
+ const versioned = json.version;
85
88
 
86
- const content = acc ? iconAccTemplate(name, pathData, ltr, acc, collection, packageName) : iconTemplate(name, pathData, ltr, collection, packageName);
89
+ const content = acc ? iconAccTemplate(name, pathData, ltr, acc, collection, packageName, versioned) : iconTemplate(name, pathData, ltr, collection, packageName);
87
90
 
88
91
  promises.push(fs.writeFile(path.join(destDir, `${name}.js`), content));
89
92
  promises.push(fs.writeFile(path.join(destDir, `${name}.svg`), svgTemplate(pathData)));
@@ -91,10 +94,10 @@ const createIcons = async (file) => {
91
94
 
92
95
  // For versioned icons collections, the script creates top level (unversioned) module that internally imports the versioned ones.
93
96
  // For example, the top level "@ui5/ui5-webcomponents-icons/dist/accept.js" imports:
94
- // - "@ui5/ui5-webcomponents-icons/dist/v5/accept.js"
97
+ // - "@ui5/ui5-webcomponents-icons/dist/v5/accept.js"
95
98
  // - "@ui5/ui5-webcomponents-icons/dist/v4/accept.js"
96
99
 
97
- if (json.version) {
100
+ if (versioned) {
98
101
  // The exported value from the top level (unversioned) icon module depends on whether the collection is the default,
99
102
  // to add or not the collection name to the exported value:
100
103
  // For the default collection (SAPIcons) we export just the icon name - "export default { 'accept' }"
@@ -59,9 +59,11 @@ const generate = async () => {
59
59
  const destPath = process.argv[6];
60
60
  const collection = process.argv[7];
61
61
  const fileNamePattern = new RegExp(`${illustrationsPrefix}-.+-(.+).svg`);
62
- // collect each illustration name because each one should have Sample.js file
62
+ // collect each illustration name because each one should have Sample.js file
63
63
  const fileNames = new Set();
64
64
 
65
+ let dotIllustrationNames = [];
66
+
65
67
  try {
66
68
  await fs.access(srcPath);
67
69
  } catch (error) {
@@ -75,10 +77,16 @@ const generate = async () => {
75
77
  return `export default \`${svgContent}\`;`
76
78
  };
77
79
  const svgToJs = async fileName => {
78
- const svg = await fs.readFile(path.join(srcPath, fileName), {encoding: "utf-8"});
80
+ const svg = await fs.readFile(path.join(srcPath, fileName), { encoding: "utf-8" });
79
81
  const fileContent = svgImportTemplate(svg);
82
+ const fileNameSplitArr = fileName.split('-');
80
83
  fileName = fileName.replace(/\.svg$/, ".js");
81
84
 
85
+ if (fileNameSplitArr[1] === 'Dot') {
86
+ // we keep the Dot illustration names to import them later. If no Dot is present, Spot will be used
87
+ dotIllustrationNames.push(fileNameSplitArr[2].split('.')[0]);
88
+ }
89
+
82
90
  return fs.writeFile(path.join(destPath, fileName), fileContent);
83
91
  };
84
92
  const illustrationImportTemplate = illustrationName => {
@@ -93,59 +101,54 @@ const generate = async () => {
93
101
  }
94
102
 
95
103
  const illustrationNameUpperCase = illustrationNameForTranslation.toUpperCase();
104
+ // If no Dot is present, Spot will be imported as Dot
105
+ const hasDot = dotIllustrationNames.indexOf(illustrationName) !== -1 ? 'Dot' : 'Spot';
96
106
 
97
- return defaultText ? `import { registerIllustration } from "@ui5/webcomponents-base/dist/asset-registries/Illustrations.js";
107
+ return `import { registerIllustration } from "@ui5/webcomponents-base/dist/asset-registries/Illustrations.js";
98
108
  import dialogSvg from "./${illustrationsPrefix}-Dialog-${illustrationName}.js";
99
109
  import sceneSvg from "./${illustrationsPrefix}-Scene-${illustrationName}.js";
100
110
  import spotSvg from "./${illustrationsPrefix}-Spot-${illustrationName}.js";
101
- import {
111
+ import dotSvg from "./${illustrationsPrefix}-${hasDot}-${illustrationName}.js";${
112
+ defaultText ? `import {
102
113
  IM_TITLE_${illustrationNameUpperCase},
103
114
  IM_SUBTITLE_${illustrationNameUpperCase},
104
- } from "../generated/i18n/i18n-defaults.js";
115
+ } from "../generated/i18n/i18n-defaults.js";` : ``}
105
116
 
106
117
  const name = "${illustrationName}";
107
118
  const set = "${illustrationSet}";
108
- const collection = "${collection}";
119
+ const collection = "${collection}";${defaultText ? `
109
120
  const title = IM_TITLE_${illustrationNameUpperCase};
110
- const subtitle = IM_SUBTITLE_${illustrationNameUpperCase};
121
+ const subtitle = IM_SUBTITLE_${illustrationNameUpperCase};` : ``}
111
122
 
112
123
  registerIllustration(name, {
113
124
  dialogSvg,
114
125
  sceneSvg,
115
126
  spotSvg,
127
+ dotSvg,${defaultText ? `
116
128
  title,
117
- subtitle,
129
+ subtitle,` : ``}
118
130
  set,
119
131
  collection,
120
132
  });
121
133
 
134
+ export default "${illustrationSet === "fiori" ? "" : `${illustrationSet}/`}${illustrationName}";
122
135
  export {
123
136
  dialogSvg,
124
137
  sceneSvg,
125
138
  spotSvg,
126
- };` :
127
- `import { registerIllustration } from "@ui5/webcomponents-base/dist/asset-registries/Illustrations.js";
128
- import dialogSvg from "./${illustrationsPrefix}-Dialog-${illustrationName}.js";
129
- import sceneSvg from "./${illustrationsPrefix}-Scene-${illustrationName}.js";
130
- import spotSvg from "./${illustrationsPrefix}-Spot-${illustrationName}.js";
131
-
132
- const name = "${illustrationName}";
133
- const set = "${illustrationSet}";
134
- const collection = "${collection}";
139
+ dotSvg,
140
+ };`
141
+ };
135
142
 
136
- registerIllustration(name, {
137
- dialogSvg,
138
- sceneSvg,
139
- spotSvg,
140
- set,
141
- collection,
142
- });
143
+ const illustrationTypeDefinition = illustrationName => {
144
+ return `declare const dialogSvg: string;
145
+ declare const sceneSvg: string;
146
+ declare const spotSvg: string;
147
+ declare const dotSvg: string;
148
+ declare const _default: "${illustrationSet === "fiori" ? "" : `${illustrationSet}/`}${illustrationName}";
143
149
 
144
- export {
145
- dialogSvg,
146
- sceneSvg,
147
- spotSvg,
148
- };`
150
+ export default _default;
151
+ export { dialogSvg, sceneSvg, spotSvg, dotSvg };`
149
152
  };
150
153
 
151
154
  await fs.mkdir(destPath, { recursive: true });
@@ -163,11 +166,15 @@ export {
163
166
  }
164
167
  });
165
168
 
166
- for (let illustrationName of fileNames) {
167
- promises.push(fs.writeFile(path.join(destPath, `${illustrationName}.js`), illustrationImportTemplate(illustrationName)));
168
- }
169
+ return Promise.all(promises).then(() => {
170
+ const nestedPromises = [];
171
+ for (let illustrationName of fileNames) {
172
+ nestedPromises.push(fs.writeFile(path.join(destPath, `${illustrationName}.js`), illustrationImportTemplate(illustrationName)));
173
+ nestedPromises.push(fs.writeFile(path.join(destPath, `${illustrationName}.d.ts`), illustrationTypeDefinition(illustrationName)));
174
+ }
169
175
 
170
- return Promise.all(promises);
176
+ return Promise.all(nestedPromises);
177
+ });
171
178
  };
172
179
 
173
180
  generate().then(() => {