umberto 5.0.1 → 5.0.2

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.
package/CHANGELOG.md CHANGED
@@ -1,6 +1,13 @@
1
1
  Changelog
2
2
  =========
3
3
 
4
+ ## [5.0.2](https://github.com/cksource/umberto/compare/v5.0.1...v5.0.2) (2025-03-24)
5
+
6
+ ### Bug fixes
7
+
8
+ * Improve handling CKEditor 5 icons on the API pages. ([commit](https://github.com/cksource/umberto/commit/89f1856de2fcbd99dbdf24d17cdd05b89a08a147))
9
+
10
+
4
11
  ## [5.0.1](https://github.com/cksource/umberto/compare/v5.0.0...v5.0.1) (2025-03-13)
5
12
 
6
13
  Internal changes only (updated dependencies, documentation, etc.).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "umberto",
3
- "version": "5.0.1",
3
+ "version": "5.0.2",
4
4
  "description": "CKSource Documentation builder",
5
5
  "main": "src/index.js",
6
6
  "files": [
@@ -172,6 +172,25 @@ class TypedocConverter {
172
172
  * @param {String|null} [parentName=null]
173
173
  */
174
174
  _convertChild( reflection, parentName = null ) {
175
+ // For unknown reasons, TypeScript or TypeDoc treats all CKEditor 5 icons (except for the first one)
176
+ // as a reference to the first exported member by a module.
177
+ // We map them manually to display a proper list of the available doclets.
178
+ // See: https://github.com/cksource/ckeditor5-internal/issues/3993.
179
+ if ( parentName === 'module:icons/index' && reflection.kindString === 'Reference' ) {
180
+ reflection = {
181
+ ...reflection,
182
+ kind: 32,
183
+ kindString: 'Variable',
184
+ flags: {
185
+ isConst: true
186
+ },
187
+ type: {
188
+ type: 'intrinsic',
189
+ name: 'string'
190
+ }
191
+ };
192
+ }
193
+
175
194
  const parser = this._parsers.find( parser => parser.canParse( reflection ) );
176
195
 
177
196
  let doclets;
@@ -28,7 +28,6 @@ import showWarningBanner from './_warningbanner';
28
28
  import { enableBadgeTooltips, createTooltip } from './_tooltips';
29
29
  import attachPermalinkListener from './_attachpermalinklistener';
30
30
  import { createCodeSwitcherButtons } from './_codeswitcherbuttons';
31
- import { sendUserDate } from './_sendUserDate';
32
31
 
33
32
  // Changing documentation theme. To enable, type in the console: `localStorage.setItem( 'theme', 'theme-dark' )`.
34
33
  if ( localStorage.getItem( 'theme' ) === 'theme-dark' ) {
@@ -68,5 +67,4 @@ $( document ).ready( () => {
68
67
  sampleCode(); // control accordion of sample code and buttons(copy/download)
69
68
  enableBadgeTooltips(); // attaches tippy.js tooltip for all elements with data-badge-tooltip
70
69
  createCodeSwitcherButtons();
71
- sendUserDate();
72
70
  } );
@@ -1,54 +0,0 @@
1
- /**
2
- * @license Copyright (c) 2017-2025, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md.
4
- */
5
-
6
- const IS_USER_DATE_SENT_KEY = 'is_local_user_os_date_sent';
7
- const STATS_EVENT_URL_DEV = 'https://builder-api.internal.cke-cs-dev.com/events';
8
- const STATS_EVENT_URL_PROD = 'https://builder-api.ckeditor.com/events';
9
-
10
- export function sendUserDate() {
11
- const isUserDateSent = localStorage.getItem( IS_USER_DATE_SENT_KEY );
12
- const environment = getEnvironment();
13
- const isProdOrNightly = environment === 'production' || environment === 'nightly';
14
- const userDateUrl = isProdOrNightly ? STATS_EVENT_URL_PROD : STATS_EVENT_URL_DEV;
15
-
16
- if ( isUserDateSent ) {
17
- // User date info is already collected. Aborting.
18
- return;
19
- }
20
-
21
- fetch( userDateUrl, {
22
- method: 'POST',
23
- headers: {
24
- 'Content-Type': 'application/json'
25
- },
26
- body: JSON.stringify( {
27
- environment,
28
- event_type: 'cksource_docs_date',
29
- event_data: {
30
- date: new Date().toISOString(),
31
- user_agent: window.navigator.userAgent,
32
- language: window.navigator.language
33
- }
34
- } )
35
- } ).then( () => {
36
- localStorage.setItem( IS_USER_DATE_SENT_KEY, 'true' );
37
- } ).catch( () => {
38
- // There is no need to report if sending user date fails.
39
- } );
40
- }
41
-
42
- function getEnvironment() {
43
- const hostname = window.location.hostname;
44
-
45
- if ( hostname.startsWith( 'ckeditor5.github.io' ) ) {
46
- return 'nightly';
47
- }
48
-
49
- if ( hostname.startsWith( 'ckeditor.com' ) ) {
50
- return 'production';
51
- }
52
-
53
- return 'local';
54
- }