@ui5/webcomponents-tools 0.0.0-fc993d8cd → 0.0.0-fca1107e7

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 (51) hide show
  1. package/CHANGELOG.md +623 -0
  2. package/README.md +2 -1
  3. package/assets-meta.js +15 -7
  4. package/components-package/eslint.js +2 -0
  5. package/components-package/nps.js +41 -32
  6. package/components-package/postcss.components.js +1 -21
  7. package/components-package/postcss.themes.js +1 -26
  8. package/components-package/wdio.js +15 -3
  9. package/components-package/wdio.sync.js +9 -1
  10. package/icons-collection/nps.js +8 -6
  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 +501 -0
  14. package/lib/cem/event.mjs +131 -0
  15. package/lib/cem/schema-internal.json +1357 -0
  16. package/lib/cem/schema.json +1098 -0
  17. package/lib/cem/types-internal.d.ts +796 -0
  18. package/lib/cem/types.d.ts +736 -0
  19. package/lib/cem/utils.mjs +384 -0
  20. package/lib/cem/validate.js +70 -0
  21. package/lib/create-illustrations/index.js +51 -30
  22. package/lib/create-new-component/index.js +28 -58
  23. package/lib/create-new-component/jsFileContentTemplate.js +1 -5
  24. package/lib/create-new-component/tsFileContentTemplate.js +3 -16
  25. package/lib/css-processors/css-processor-component-styles.mjs +47 -0
  26. package/lib/css-processors/css-processor-components.mjs +77 -0
  27. package/lib/css-processors/css-processor-themes.mjs +79 -0
  28. package/lib/css-processors/scope-variables.mjs +49 -0
  29. package/lib/{postcss-css-to-esm/index.js → css-processors/shared.mjs} +36 -50
  30. package/lib/dev-server/custom-hot-update-plugin.js +39 -0
  31. package/lib/generate-custom-elements-manifest/index.js +51 -107
  32. package/lib/generate-js-imports/illustrations.js +78 -64
  33. package/lib/generate-json-imports/i18n.js +10 -5
  34. package/lib/generate-json-imports/themes.js +10 -5
  35. package/lib/hbs2lit/src/compiler.js +9 -6
  36. package/lib/hbs2lit/src/litVisitor2.js +42 -17
  37. package/lib/hbs2lit/src/svgProcessor.js +12 -5
  38. package/lib/hbs2ui5/RenderTemplates/LitRenderer.js +32 -4
  39. package/lib/hbs2ui5/index.js +21 -4
  40. package/lib/i18n/toJSON.js +1 -1
  41. package/lib/jsdoc/preprocess.js +3 -3
  42. package/lib/postcss-combine-duplicated-selectors/index.js +12 -5
  43. package/lib/scoping/get-all-tags.js +1 -1
  44. package/lib/scoping/scope-test-pages.js +2 -1
  45. package/lib/test-runner/test-runner.js +2 -2
  46. package/package.json +13 -10
  47. package/lib/esm-abs-to-rel/index.js +0 -58
  48. package/lib/postcss-css-to-json/index.js +0 -47
  49. package/lib/postcss-new-files/index.js +0 -36
  50. package/lib/postcss-p/postcss-p.mjs +0 -14
  51. package/lib/replace-global-core/index.js +0 -25
@@ -0,0 +1,501 @@
1
+ import { parse } from "comment-parser";
2
+ import processEvent from "./event.mjs";
3
+ import path from "path";
4
+ import fs from 'fs';
5
+ import {
6
+ getDeprecatedStatus,
7
+ getSinceStatus,
8
+ getPrivacyStatus,
9
+ getReference,
10
+ validateJSDocComment,
11
+ findDecorator,
12
+ findAllDecorators,
13
+ hasTag,
14
+ findTag,
15
+ findAllTags,
16
+ getTypeRefs,
17
+ normalizeDescription,
18
+ formatArrays,
19
+ isClass,
20
+ normalizeTagType,
21
+ logDocumentationError,
22
+ displayDocumentationErrors,
23
+ toKebabCase
24
+ } from "./utils.mjs";
25
+ import { generateCustomData } from "cem-plugin-vs-code-custom-data-generator";
26
+ import { customElementJetBrainsPlugin } from "custom-element-jet-brains-integration";
27
+
28
+ const packageJSON = JSON.parse(fs.readFileSync("./package.json"));
29
+
30
+ const extractClassNodeJSDoc = node => {
31
+ const fileContent = node.getFullText();
32
+ const allJSDocsRegExp = new RegExp(`\\/\\*\\*(.|\\n)+?\\s+\\*\\/`, "gm");
33
+ let allJSDocs = [...fileContent.matchAll(allJSDocsRegExp)];
34
+ allJSDocs = allJSDocs.map(match => match[0]); // all /** ..... */ comments
35
+
36
+ // Find where the class is defined in the original file
37
+ const tsClassDefinitionRegExp = new RegExp(`^\\s*(abstract\\s*)?class [\\w\\d_]+`, "gm");
38
+ let tsClassDefinitionMatch = fileContent.match(tsClassDefinitionRegExp);
39
+ if (!tsClassDefinitionMatch) {
40
+ return; // no class defined in this .ts file
41
+ }
42
+ const tsClassDefinition = tsClassDefinitionMatch[0];
43
+ const tsClassDefinitionIndex = fileContent.indexOf(tsClassDefinition);
44
+
45
+ return allJSDocs.find(JSDoc => {
46
+ return isClass(JSDoc) && (fileContent.indexOf(JSDoc) < tsClassDefinitionIndex)
47
+ });
48
+ }
49
+
50
+ function processClass(ts, classNode, moduleDoc) {
51
+ const className = classNode?.name?.text;
52
+ const currClass = moduleDoc?.declarations?.find(declaration => declaration?.name === className);
53
+ const currClassJSdoc = extractClassNodeJSDoc(classNode);
54
+
55
+ if (!currClassJSdoc) return;
56
+
57
+ const customElementDecorator = findDecorator(classNode, "customElement");
58
+ const classParsedJsDoc = parse(currClassJSdoc, { spacing: 'preserve' })[0];
59
+
60
+ validateJSDocComment("class", classParsedJsDoc, classNode.name?.text, moduleDoc);
61
+
62
+ const decoratorArg = customElementDecorator?.expression?.arguments[0];
63
+ currClass.tagName = decoratorArg?.text || (decoratorArg?.properties.find(property => property.name.text === "tag")?.initializer?.text);
64
+ currClass.customElement = !!customElementDecorator || className === "UI5Element" || undefined;
65
+ currClass.kind = "class";
66
+ currClass.deprecated = getDeprecatedStatus(classParsedJsDoc);
67
+ currClass._ui5since = getSinceStatus(classParsedJsDoc);
68
+ currClass._ui5privacy = getPrivacyStatus(classParsedJsDoc);
69
+ currClass._ui5abstract = hasTag(classParsedJsDoc, "abstract") ? true : undefined;
70
+ currClass.description = normalizeDescription(classParsedJsDoc.description || findTag(classParsedJsDoc, "class")?.description);
71
+ currClass._ui5implements = findAllTags(classParsedJsDoc, "implements")
72
+ .map(tag => getReference(ts, normalizeTagType(tag.type), classNode, moduleDoc.path))
73
+ .filter(Boolean);
74
+
75
+
76
+ if (hasTag(classParsedJsDoc, "extends")) {
77
+ const superclassTag = findTag(classParsedJsDoc, "extends");
78
+ currClass.superclass = getReference(ts, superclassTag.name, classNode, moduleDoc.path);
79
+
80
+ if (currClass.superclass?.name === "UI5Element") {
81
+ currClass.customElement = true;
82
+ }
83
+ }
84
+
85
+ if (!currClass._ui5implements.length) delete currClass._ui5implements;
86
+
87
+ // Slots
88
+
89
+ // Slots without accessort (defined in class comment)
90
+ if (hasTag(classParsedJsDoc, "slot") && currClass.slots) {
91
+ const slotTags = findAllTags(classParsedJsDoc, "slot");
92
+
93
+ currClass.slots.forEach(slot => {
94
+ const tag = slotTags.find(tag => tag.name === slot.name);
95
+
96
+ const typeRefs = (normalizeTagType(tag.type)
97
+ ?.replaceAll(/Array<|>|\[\]/g, "")
98
+ ?.split("|")
99
+ ?.map(e => getReference(ts, e.trim(), classNode, moduleDoc.path)).filter(Boolean));
100
+
101
+ slot._ui5privacy = "public";
102
+ slot._ui5type = { text: formatArrays(normalizeTagType(tag.type)) };
103
+ slot.description = normalizeDescription(tag.description)
104
+
105
+ if (typeRefs && typeRefs.length) {
106
+ slot._ui5type.references = typeRefs;
107
+ }
108
+
109
+ delete slot.type
110
+ })
111
+ }
112
+
113
+ // Events
114
+ currClass.events = findAllDecorators(classNode, "event")
115
+ ?.map(event => processEvent(ts, event, classNode, moduleDoc));
116
+
117
+ // Slots (with accessor), methods and fields
118
+ for (let i = 0; i < (currClass.members?.length || 0); i++) {
119
+ const member = currClass.members[i];
120
+ const classNodeMember = classNode.members?.find(nodeMember => nodeMember.name?.text === member?.name && nodeMember.jsDoc?.[0]);
121
+ const classNodeMemberJSdoc = classNodeMember?.jsDoc?.[0];
122
+
123
+ if (!classNodeMember || !classNodeMemberJSdoc) continue;
124
+
125
+ const memberParsedJsDoc = parse(classNodeMemberJSdoc?.getText())[0];
126
+
127
+ member._ui5since = getSinceStatus(memberParsedJsDoc);
128
+ member.deprecated === "true" && (member.deprecated = true)
129
+
130
+ // Slots with accessors are treated like fields by the tool, so we have to convert them into slots.
131
+ if (member.kind === "field") {
132
+ const slotDecorator = findDecorator(classNodeMember, "slot");
133
+ validateJSDocComment(slotDecorator ? "slot" : (member.readonly ? "getter" : "field"), memberParsedJsDoc, classNodeMember.name?.text, moduleDoc);
134
+
135
+ const typeRefs = (getTypeRefs(ts, classNodeMember, member)
136
+ ?.map(e => getReference(ts, e, classNodeMember, moduleDoc.path)).filter(Boolean)) || [];
137
+
138
+ if (member.type?.text) {
139
+ member.type.text = formatArrays(member.type.text);
140
+ }
141
+
142
+ if (member.type && typeRefs.length) {
143
+ member.type.references = typeRefs;
144
+ }
145
+
146
+ if (slotDecorator) {
147
+ if (!currClass.slots) currClass.slots = [];
148
+
149
+ const slot = currClass.members.splice(i, 1)[0];
150
+ const defaultProperty = slotDecorator.expression?.arguments?.[0]?.properties?.find(property => property.name.text === "default");
151
+
152
+ // name of the default slot declared with decorator will be overriden so we to provide it's accessor name
153
+ if (defaultProperty && defaultProperty.initializer?.kind === ts.SyntaxKind.TrueKeyword) {
154
+ slot._ui5propertyName = slot.name;
155
+ slot.name = "default";
156
+ }
157
+
158
+ // Slots don't have type, privacy and kind, so we have do convert them and to clean unused props
159
+ member._ui5type = member.type;
160
+ member._ui5privacy = member.privacy;
161
+ delete member.type;
162
+ delete member.privacy;
163
+ delete slot.kind;
164
+
165
+ currClass.slots.push(slot);
166
+ i--;
167
+ } else {
168
+ const propertyDecorator = findDecorator(classNodeMember, "property");
169
+
170
+ if (propertyDecorator) {
171
+ member._ui5validator = propertyDecorator?.expression?.arguments[0]?.properties?.find(property => ["validator", "type"].includes(property.name.text))?.initializer?.text || "String";
172
+ member._ui5noAttribute = propertyDecorator?.expression?.arguments[0]?.properties?.find(property => property.name.text === "noAttribute")?.initializer?.kind === ts.SyntaxKind.TrueKeyword || undefined;
173
+ }
174
+
175
+ if (currClass.customElement && member.privacy === "public" && !propertyDecorator?.expression?.arguments[0]?.properties?.find(property => property.name.text === "multiple") && !["object"].includes(member._ui5validator?.toLowerCase())) {
176
+ const filename = classNode.getSourceFile().fileName;
177
+ const sourceFile = typeProgram.getSourceFile(filename);
178
+ const tsProgramClassNode = sourceFile.statements.find(statement => ts.isClassDeclaration(statement) && statement.name?.text === classNode.name?.text);
179
+ const tsProgramMember = tsProgramClassNode.members.find(m => ts.isPropertyDeclaration(m) && m.name?.text === member.name);
180
+ const attributeValue = typeChecker.typeToString(typeChecker.getTypeAtLocation(tsProgramMember), tsProgramMember);
181
+
182
+ currClass.attributes.push({
183
+ description: member.description,
184
+ name: toKebabCase(member.name),
185
+ default: member.default,
186
+ fieldName: member.name,
187
+ type: { text: attributeValue },
188
+ deprecated: member.deprecated
189
+ })
190
+ }
191
+
192
+ if (hasTag(memberParsedJsDoc, "formProperty")) {
193
+ member._ui5formProperty = true;
194
+ }
195
+
196
+ const formEventsTag = findTag(memberParsedJsDoc, "formEvents");
197
+ if (formEventsTag) {
198
+ const tagValue = formEventsTag.description ? `${formEventsTag.name} ${formEventsTag.description}` : formEventsTag.name;
199
+ member._ui5formEvents = tagValue.trim().replaceAll(/\s+/g, ",");
200
+ }
201
+
202
+ const defaultTag = findTag(memberParsedJsDoc, "default");
203
+ if (defaultTag) {
204
+ const tagValue = defaultTag.source?.[0]?.tokens?.name || defaultTag.source?.[0]?.tokens?.description || defaultTag.source?.[0]?.tokens?.type || "";
205
+ member.default = tagValue;
206
+ }
207
+
208
+ if (member.privacy === "public" && !member.default) {
209
+ logDocumentationError(moduleDoc.path, `Missing default value for '${member.name}'.`)
210
+ }
211
+
212
+ // Getters are treated as fields so they should not have return, instead of return they should have default value defined with @default
213
+ if (member.readonly) {
214
+ if (member.privacy === "public" && !member.type) {
215
+ logDocumentationError(moduleDoc.path, `Missing return type for read-only field '${member.name}'.`)
216
+ }
217
+
218
+ delete member.return;
219
+ }
220
+ }
221
+ } else if (member.kind === "method") {
222
+ validateJSDocComment("method", memberParsedJsDoc, classNodeMember.name?.text, moduleDoc);
223
+
224
+ member.parameters?.forEach(param => {
225
+ // Treat every parameter that has respective @param tag as public
226
+ param._ui5privacy = findAllTags(memberParsedJsDoc, "param").some(tag => tag.name === param.name) ? "public" : "private";
227
+ if (param._ui5privacy === "public") {
228
+ const paramNode = classNodeMember.parameters?.find(parameter => parameter.name?.text === param.name);
229
+ let type;
230
+
231
+ if (param.optional) {
232
+ const filename = classNode.getSourceFile().fileName;
233
+
234
+ const sourceFile = typeProgram.getSourceFile(filename);
235
+ const tsProgramClassNode = sourceFile.statements.find(statement => ts.isClassDeclaration(statement) && statement.name?.text === classNode.name?.text);
236
+ const tsProgramMember = tsProgramClassNode.members.find(m => ts.isMethodDeclaration(m) && m.name?.text === member.name);
237
+ const tsProgramParameter = tsProgramMember.parameters.find(p => ts.isParameter(p) && p.name?.text === param.name);
238
+
239
+ if (tsProgramParameter) {
240
+ const typeName = typeChecker.typeToString(typeChecker.getTypeAtLocation(tsProgramParameter), tsProgramParameter);
241
+
242
+ if (!param.type) {
243
+ param.type = {};
244
+ param.type.text = typeName;
245
+ }
246
+
247
+ type = typeName.replaceAll(/Array<|>|\[\]/g, "")
248
+ ?.split("|");
249
+ }
250
+ }
251
+
252
+ const typeRefs = ((type || getTypeRefs(ts, (type || paramNode), param))
253
+ ?.map(typeRef => getReference(ts, typeRef, classNodeMember, moduleDoc.path)).filter(Boolean)) || [];
254
+
255
+ if (typeRefs.length) {
256
+ param.type.references = typeRefs;
257
+ }
258
+ }
259
+ });
260
+
261
+ if (member.return) {
262
+ const returnTag = findTag(memberParsedJsDoc, "returns");
263
+ member.return.description = returnTag?.description ? `${returnTag.name} ${returnTag.description}` : returnTag?.name;
264
+ member.return.type.text = formatArrays(classNodeMember?.type?.getFullText?.()?.trim());
265
+ const typeRefs = (getTypeRefs(ts, classNodeMember, member.return)
266
+ ?.map(typeRef => getReference(ts, typeRef, classNodeMember, moduleDoc.path)).filter(Boolean)) || [];
267
+
268
+ if (typeRefs.length) {
269
+ member.return.type.references = typeRefs;
270
+ }
271
+
272
+ if (member.privacy === "public" && !member.return.type.text) {
273
+ logDocumentationError(moduleDoc.path, `Missing return type for function '${member.name}'.`)
274
+ }
275
+ } else if (member.privacy === "public") {
276
+ logDocumentationError(moduleDoc.path, `Missing return type for function '${member.name}'.`)
277
+ }
278
+ }
279
+ }
280
+ }
281
+
282
+ function processInterface(ts, interfaceNode, moduleDoc) {
283
+ const interfaceJSdoc = interfaceNode?.jsDoc?.[0];
284
+ const interfaceName = interfaceNode?.name?.text;
285
+
286
+ if (!interfaceJSdoc) return;
287
+
288
+ const interfaceParsedJsDoc = parse(interfaceJSdoc?.getText(), { spacing: 'preserve' })[0];
289
+
290
+ validateJSDocComment("interface", interfaceParsedJsDoc, interfaceNode.name?.text, moduleDoc);
291
+
292
+ moduleDoc.declarations.push({
293
+ kind: "interface",
294
+ name: interfaceName,
295
+ description: normalizeDescription(interfaceParsedJsDoc?.description),
296
+ _ui5privacy: getPrivacyStatus(interfaceParsedJsDoc),
297
+ _ui5since: getSinceStatus(interfaceParsedJsDoc),
298
+ deprecated: getDeprecatedStatus(interfaceParsedJsDoc),
299
+ });
300
+ }
301
+
302
+ function processEnum(ts, enumNode, moduleDoc) {
303
+ const enumJSdoc = enumNode?.jsDoc?.[0];
304
+ const enumName = enumNode?.name?.text;
305
+
306
+ if (!enumJSdoc) return;
307
+
308
+ const enumParsedJsDoc = parse(enumJSdoc?.getText(), { spacing: 'preserve' })[0];
309
+
310
+ validateJSDocComment("enum", enumParsedJsDoc, enumNode.name?.text, moduleDoc);
311
+
312
+ const result = {
313
+ kind: "enum",
314
+ name: enumName,
315
+ description: normalizeDescription(enumJSdoc?.comment),
316
+ _ui5privacy: getPrivacyStatus(enumParsedJsDoc),
317
+ _ui5since: getSinceStatus(enumParsedJsDoc),
318
+ deprecated: getDeprecatedStatus(enumParsedJsDoc) || undefined,
319
+ members: (enumNode?.members || []).map(member => {
320
+ const memberJSdoc = member?.jsDoc?.[0];
321
+
322
+ if (!memberJSdoc) return;
323
+
324
+ const memberParsedJsDoc = parse(memberJSdoc?.getText())[0];
325
+
326
+ validateJSDocComment("enum", memberParsedJsDoc, member.name?.text, moduleDoc);
327
+
328
+ return {
329
+ kind: "field",
330
+ static: true,
331
+ privacy: getPrivacyStatus(memberParsedJsDoc),
332
+ _ui5since: getSinceStatus(memberParsedJsDoc),
333
+ description: memberJSdoc?.comment,
334
+ default: member.initializer?.text,
335
+ deprecated: getDeprecatedStatus(memberParsedJsDoc),
336
+ name: member.name?.text,
337
+ readonly: true,
338
+ };
339
+ }).filter(Boolean),
340
+ };
341
+
342
+ moduleDoc.declarations.push(result);
343
+ }
344
+
345
+ const processPublicAPI = object => {
346
+ if (!object) {
347
+ return true;
348
+ }
349
+ const keys = Object.keys(object);
350
+ if (!keys.includes("privacy") && !keys.includes("_ui5privacy")) {
351
+ return true;
352
+ }
353
+ for (const key of keys) {
354
+ if ((key === "privacy" && object[key] !== "public") || (key === "_ui5privacy" && object[key] !== "public")) {
355
+ return true;
356
+ } else if (typeof object[key] === "object") {
357
+ if (key === "cssParts" || key === "attributes" || key === "_ui5implements") {
358
+ continue;
359
+ }
360
+
361
+ if (Array.isArray(object[key])) {
362
+ for (let i = 0; i < object[key].length; i++) {
363
+ const shouldRemove = processPublicAPI(object[key][i]);
364
+ if (shouldRemove) {
365
+ object[key].splice(i, 1);
366
+ i--;
367
+ }
368
+ }
369
+ if (object[key].length === 0) {
370
+ delete object[key];
371
+ }
372
+ }
373
+ }
374
+ }
375
+ return false;
376
+ };
377
+
378
+ let typeChecker;
379
+ let typeProgram;
380
+
381
+ export default {
382
+ globs: ["src/!(*generated)/*.ts", "src/!(*bundle)*.ts"],
383
+ outdir: 'dist',
384
+ overrideModuleCreation: ({ ts, globs }) => {
385
+ typeProgram = ts.createProgram(globs, {
386
+ noEmitOnError: false,
387
+ allowJs: true,
388
+ experimentalDecorators: true,
389
+ target: 99,
390
+ downlevelIteration: true,
391
+ module: 99,
392
+ strictNullChecks: true,
393
+ moduleResolution: 2,
394
+ esModuleInterop: true,
395
+ noEmit: true,
396
+ pretty: true,
397
+ allowSyntheticDefaultImports: true,
398
+ allowUnreachableCode: true,
399
+ allowUnusedLabels: true,
400
+ skipLibCheck: true,
401
+ });
402
+ typeChecker = typeProgram.getTypeChecker();
403
+
404
+ return globs.map((glob) => {
405
+ const fullPath = path.resolve(process.cwd(), glob);
406
+ const source = fs.readFileSync(fullPath).toString();
407
+
408
+ return ts.createSourceFile(glob, source, ts.ScriptTarget.ES2015, true);
409
+ });
410
+ },
411
+ plugins: [
412
+ {
413
+ name: 'my-plugin',
414
+ analyzePhase({ ts, node, moduleDoc }) {
415
+ switch (true) {
416
+ case ts.isClassDeclaration(node):
417
+ processClass(ts, node, moduleDoc);
418
+ break;
419
+ case ts.isEnumDeclaration(node):
420
+ processEnum(ts, node, moduleDoc);
421
+ break;
422
+ case ts.isInterfaceDeclaration(node):
423
+ processInterface(ts, node, moduleDoc);
424
+ break;
425
+ }
426
+ },
427
+ moduleLinkPhase({ moduleDoc }) {
428
+ for (let i = 0; i < moduleDoc.declarations.length; i++) {
429
+ const shouldRemove = processPublicAPI(moduleDoc.declarations[i]) || ["function", "variable"].includes(moduleDoc.declarations[i].kind)
430
+ if (shouldRemove) {
431
+ moduleDoc.declarations.splice(i, 1);
432
+ i--;
433
+ }
434
+ }
435
+
436
+ moduleDoc.path = moduleDoc.path?.replace(/^src/, "dist").replace(/\.ts$/, ".js");
437
+
438
+ moduleDoc.exports = moduleDoc.exports.
439
+ filter(e => !(e.kind === "custom-element-definition" && !moduleDoc.declarations?.find(d => d.name === e.name)?.tagName))
440
+
441
+ moduleDoc.exports.forEach(e => {
442
+ const classNode = moduleDoc.declarations.find(c => c.name === e.declaration.name);
443
+
444
+ if (e.declaration && e.declaration.module) {
445
+ e.declaration.module = e.declaration.module.replace(/^src/, "dist").replace(/\.ts$/, ".js");
446
+ }
447
+
448
+ if (classNode?.customElement && classNode.tagName && e.kind !== "custom-element-definition") {
449
+ moduleDoc.exports.push({
450
+ kind: "custom-element-definition",
451
+ name: classNode.tagName,
452
+ declaration: {
453
+ name: e.declaration.name,
454
+ module: e.declaration.module
455
+ }
456
+ })
457
+ }
458
+ })
459
+
460
+ const typeReferences = new Set();
461
+ const registerTypeReference = reference => typeReferences.add(JSON.stringify(reference))
462
+
463
+ moduleDoc.declarations.forEach(declaration => {
464
+ ["events", "slots", "members"].forEach(memberType => {
465
+ declaration[memberType]?.forEach(member => {
466
+ if (member.type?.references) {
467
+ member.type.references.forEach(registerTypeReference)
468
+ } else if (member._ui5type?.references) {
469
+ member._ui5type.references.forEach(registerTypeReference)
470
+ } else if (member.kind === "method") {
471
+ member.return?.type?.references?.forEach(registerTypeReference)
472
+
473
+ member.parameters?.forEach(parameter => {
474
+ parameter.type?.references?.forEach(registerTypeReference)
475
+ })
476
+ }
477
+ })
478
+ })
479
+ });
480
+
481
+ typeReferences.forEach(reference => {
482
+ reference = JSON.parse(reference);
483
+ if (reference.package === packageJSON?.name && reference.module === moduleDoc.path) {
484
+ const hasExport = moduleDoc.exports.some(e => e.declaration?.name === reference.name && e.declaration?.module === reference.module)
485
+
486
+ if (!hasExport) {
487
+ logDocumentationError(moduleDoc.path?.replace(/^dist/, "src").replace(/\.js$/, ".ts"), `Type '${reference.name}' is used to describe a public API but is not exported.`,)
488
+ }
489
+ }
490
+ })
491
+ },
492
+ packageLinkPhase({ context }) {
493
+ if (context.dev) {
494
+ displayDocumentationErrors();
495
+ }
496
+ }
497
+ },
498
+ generateCustomData({ outdir: "dist", cssFileName: null, cssPropertiesDocs: false }),
499
+ customElementJetBrainsPlugin({ outdir: "dist", cssFileName: null, cssPropertiesDocs: false })
500
+ ],
501
+ };
@@ -0,0 +1,131 @@
1
+ import { parse } from "comment-parser";
2
+ import {
3
+ getPrivacyStatus,
4
+ getDeprecatedStatus,
5
+ getSinceStatus,
6
+ getType,
7
+ getTypeRefs,
8
+ validateJSDocComment,
9
+ hasTag,
10
+ findTag,
11
+ findAllTags,
12
+ getReference,
13
+ normalizeDescription,
14
+ normalizeTagType,
15
+ logDocumentationError
16
+ } from "./utils.mjs";
17
+
18
+ const jsDocRegExp = /\/\*\*(.|\n)+?\s+\*\//;
19
+
20
+ const getParams = (ts, eventDetails, commentParams, classNode, moduleDoc) => {
21
+ return commentParams?.map(commentParam => {
22
+ const decoratorParam = eventDetails?.find(prop => prop?.name?.text === commentParam?.name);
23
+
24
+ if (!decoratorParam || !decoratorParam?.jsDoc?.[0]) {
25
+ return;
26
+ }
27
+
28
+ const decoratorParamParsedComment = parse(decoratorParam?.jsDoc?.[0]?.getText?.(), { spacing: 'preserve' })[0];
29
+
30
+ validateJSDocComment("eventParam", decoratorParamParsedComment, decoratorParam.name?.text, moduleDoc);
31
+
32
+ const { typeName, name } = getType(normalizeTagType(commentParam?.type));
33
+ let type;
34
+
35
+ if (typeName) {
36
+ type = { text: typeName };
37
+
38
+ let typeRefs = name?.split("|")
39
+ ?.map(e => getReference(ts, e.trim(), classNode, moduleDoc.path))
40
+ .filter(Boolean);
41
+
42
+ if (typeRefs?.length) {
43
+ type.references = typeRefs;
44
+ }
45
+ }
46
+
47
+ return {
48
+ type,
49
+ name: commentParam?.name,
50
+ _ui5privacy: getPrivacyStatus(decoratorParamParsedComment),
51
+ description: normalizeDescription(commentParam?.description),
52
+ _ui5since: getSinceStatus(decoratorParamParsedComment),
53
+ deprecated: getDeprecatedStatus(decoratorParamParsedComment),
54
+ };
55
+ }).filter(pair => !!pair);
56
+ };
57
+
58
+ function processEvent(ts, event, classNode, moduleDoc) {
59
+ const name = event?.expression?.arguments?.[0]?.text;
60
+ const result = {
61
+ name,
62
+ _ui5privacy: "private",
63
+ type: { text: "CustomEvent" }
64
+ };
65
+
66
+ const comment = event.getFullText?.().match(jsDocRegExp)?.[0];
67
+
68
+ if (!comment) {
69
+ return result;
70
+ }
71
+
72
+ const eventParsedComment = parse(comment, { spacing: 'preserve' })[0];
73
+
74
+ validateJSDocComment("event", eventParsedComment, name, moduleDoc);
75
+
76
+ const deprecatedTag = findTag(eventParsedComment, "deprecated");
77
+ const privacy = findTag(eventParsedComment, ["public", "private", "protected"])?.tag || "private";
78
+ const sinceTag = findTag(eventParsedComment, "since");
79
+ const commentParams = findAllTags(eventParsedComment, "param");
80
+ const allowPreventDefault = hasTag(eventParsedComment, "allowPreventDefault") || undefined;
81
+ const description = normalizeDescription(eventParsedComment?.description);
82
+ const native = hasTag(eventParsedComment, "native");
83
+ const eventDetails = event?.expression?.arguments?.[1]?.properties?.find(prop => prop?.name?.text === "detail")?.initializer?.properties;
84
+
85
+ if (event?.expression?.arguments?.[1] && !event?.expression?.typeArguments) {
86
+ logDocumentationError(moduleDoc.path, `Event details for event '${name}' must be described using generics. Add type via generics to the decorator: @event<TypeForDetails>("${name}", {details}).`)
87
+ }
88
+
89
+ result.description = description;
90
+ result._ui5allowPreventDefault = allowPreventDefault;
91
+
92
+ if (native) {
93
+ result.type = { text: "Event" };
94
+ } else if (event?.expression?.typeArguments) {
95
+ const typesText = event?.expression?.typeArguments.map(type => type.typeName?.text).filter(Boolean).join(" | ");
96
+ const typeRefs = (getTypeRefs(ts, event.expression)
97
+ ?.map(e => getReference(ts, e, event, moduleDoc.path)).filter(Boolean)) || [];
98
+
99
+ result.type = { text: `CustomEvent<${typesText}>` };
100
+
101
+ if (typeRefs.length) {
102
+ result.type.references = typeRefs;
103
+ }
104
+ }
105
+
106
+ if (privacy) {
107
+ result._ui5privacy = privacy;
108
+ }
109
+
110
+ if (deprecatedTag?.name) {
111
+ result.deprecated = deprecatedTag.description
112
+ ? `${deprecatedTag.name} ${deprecatedTag.description}`
113
+ : deprecatedTag.name;
114
+ } else if (deprecatedTag) {
115
+ result.deprecated = true;
116
+ }
117
+
118
+ if (sinceTag?.name) {
119
+ result._ui5since = sinceTag?.description
120
+ ? `${sinceTag.name} ${sinceTag.description}`
121
+ : sinceTag.name;
122
+ }
123
+
124
+ if (commentParams && eventDetails) {
125
+ result._ui5parameters = getParams(ts, eventDetails, commentParams, classNode, moduleDoc);
126
+ }
127
+
128
+ return result;
129
+ }
130
+
131
+ export default processEvent;