umberto 4.1.2 → 4.2.1
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 +18 -0
- package/LICENSE.md +1 -1
- package/hexo-shim.js +1 -1
- package/package.json +1 -1
- package/scripts/filter/after-post-render/basepath-replacer.js +1 -1
- package/scripts/filter/after-post-render/fix-code-samples.js +1 -1
- package/scripts/filter/after-post-render/gather-guides.js +1 -1
- package/scripts/filter/after-post-render/img-linker.js +1 -1
- package/scripts/filter/after-post-render/import-guide.js +1 -1
- package/scripts/filter/after-post-render/insert-error-codes.js +1 -1
- package/scripts/filter/after-post-render/linker.js +1 -1
- package/scripts/filter/after-post-render/parseicontag.js +1 -1
- package/scripts/filter/after-post-render/process-variables.js +1 -1
- package/scripts/filter/after-post-render/snippets.js +1 -1
- package/scripts/filter/after-post-render/time-end.js +1 -1
- package/scripts/filter/after-post-render/time-start.js +1 -1
- package/scripts/filter/after-post-render/validate-after-render.js +1 -1
- package/scripts/filter/before-post-render/add-project-info-to-page.js +1 -1
- package/scripts/filter/before-post-render/add-repo-url.js +1 -1
- package/scripts/filter/before-post-render/change-output-path.js +1 -1
- package/scripts/filter/before-post-render/execute-and-insert-function-results.js +1 -1
- package/scripts/filter/before-post-render/infobox.js +1 -1
- package/scripts/filter/before-post-render/insertchangelog.js +1 -1
- package/scripts/filter/before-post-render/replace-macros.js +1 -1
- package/scripts/filter/before-post-render/set-layout.js +1 -1
- package/scripts/filter/before-post-render/validate-page-data.js +1 -1
- package/scripts/helper/find-main-category-page.js +1 -1
- package/scripts/helper/get-pages-for-nav-tree.js +1 -1
- package/scripts/helper/mark-empty-categories.js +1 -1
- package/scripts/helper/normalize-badges.js +1 -1
- package/scripts/helper/u-split-to-title-and-content.js +1 -1
- package/scripts/helper/u-toc.js +1 -1
- package/scripts/utils/execute-and-insert-function-results.js +1 -1
- package/scripts/utils/findmaincategorypage.js +1 -1
- package/scripts/utils/getreportissuewidgeturl.js +1 -1
- package/scripts/utils/insertchangelog.js +1 -1
- package/scripts/utils/normalizebadges.js +1 -1
- package/scripts/utils/parseicontag.js +1 -1
- package/scripts/utils/parselinks.js +1 -1
- package/scripts/utils/shoulddisplaynewindicator.js +1 -1
- package/scripts/utils/transforminfobox.js +1 -1
- package/src/api-builder/api-builder.js +1 -1
- package/src/api-builder/classes/description-parser.js +1 -1
- package/src/api-builder/classes/doc-data-factory.js +2 -1
- package/src/api-builder/classes/file-name-manager.js +1 -1
- package/src/api-builder/classes/html-file.js +1 -1
- package/src/api-builder/classes/navigation-tree.js +1 -1
- package/src/api-builder/classes/tree-node.js +1 -1
- package/src/api-builder/utils/findtargetdoclet.js +1 -1
- package/src/api-builder/utils/utils.js +1 -1
- package/src/data-converter/converters/jsdoc2umberto.js +1 -1
- package/src/data-converter/converters/jsduck2umberto.js +1 -1
- package/src/data-converter/converters/typedoc/abstractparser.js +39 -1
- package/src/data-converter/converters/typedoc/accessorparser.js +1 -1
- package/src/data-converter/converters/typedoc/classparser.js +1 -1
- package/src/data-converter/converters/typedoc/computedpropertyparser.js +1 -1
- package/src/data-converter/converters/typedoc/constantparser.js +1 -1
- package/src/data-converter/converters/typedoc/constructorparser.js +1 -1
- package/src/data-converter/converters/typedoc/errorparser.js +1 -1
- package/src/data-converter/converters/typedoc/eventparser.js +1 -1
- package/src/data-converter/converters/typedoc/functionparser.js +1 -1
- package/src/data-converter/converters/typedoc/interfaceparser.js +1 -1
- package/src/data-converter/converters/typedoc/methodparser.js +1 -1
- package/src/data-converter/converters/typedoc/moduleparser.js +1 -1
- package/src/data-converter/converters/typedoc/propertyparser.js +1 -1
- package/src/data-converter/converters/typedoc/typedoc.ts +1 -1
- package/src/data-converter/converters/typedoc/typedocconverter.js +24 -9
- package/src/data-converter/converters/typedoc/typeparser.js +2 -1
- package/src/data-converter/converters/typedoc2umberto.js +1 -1
- package/src/data-converter/data-collection.js +1 -1
- package/src/data-converter/data-provider.js +1 -1
- package/src/data-converter/doclet-collection.js +1 -1
- package/src/data-converter/middlewares/relation-fixer.js +1 -1
- package/src/helpers/capitalize.js +1 -1
- package/src/helpers/copy-file.js +1 -1
- package/src/helpers/create-filtering-data-attribs.js +1 -1
- package/src/helpers/doc-formats.js +1 -1
- package/src/helpers/escape-longname.js +1 -1
- package/src/helpers/extract-longname.js +1 -1
- package/src/helpers/get-api-infobox-tooltip.js +1 -1
- package/src/helpers/get-docsearch-config.js +1 -1
- package/src/helpers/get-file-patterns-to-process.js +1 -1
- package/src/helpers/get-short-module-path.js +1 -1
- package/src/helpers/github-url.js +1 -1
- package/src/helpers/glob-to-regexp.js +1 -1
- package/src/helpers/html-safe.js +1 -1
- package/src/helpers/is-non-empty-array.js +1 -1
- package/src/helpers/snippets.js +1 -1
- package/src/helpers/split-longname.js +1 -1
- package/src/hexo/filter/extend-config.js +1 -1
- package/src/hexo/filter/project-locals.js +1 -1
- package/src/hexo/get-repo-urls.js +1 -1
- package/src/hexo/helper/get-page-group.js +1 -1
- package/src/hexo/project-globals.js +1 -1
- package/src/hexo-manager.js +1 -1
- package/src/index.js +1 -1
- package/src/sdk-builder/get-sdk-sources.js +1 -1
- package/src/sdk-builder/sdk-builder.js +1 -1
- package/src/tasks/build-api-docs.js +1 -1
- package/src/tasks/build-documentation.js +1 -1
- package/src/tasks/build-sdk.js +1 -1
- package/src/tasks/build-snippets.js +1 -1
- package/src/tasks/cache-files.js +1 -1
- package/src/tasks/compile-sass.js +1 -1
- package/src/tasks/copy-assets.js +1 -1
- package/src/tasks/copy-files.js +1 -1
- package/src/tasks/copy-project-docs.js +1 -1
- package/src/tasks/copy-project-icons.js +1 -1
- package/src/tasks/create-redirect-page.js +1 -1
- package/src/tasks/create-sitemap.js +1 -1
- package/src/tasks/create-sym-links.js +1 -1
- package/src/tasks/execute-hooks.js +1 -1
- package/src/tasks/get-extra-files.js +1 -1
- package/src/tasks/get-hexo-config.js +1 -1
- package/src/tasks/get-main-config.js +1 -1
- package/src/tasks/get-project-config.js +1 -1
- package/src/tasks/macro-replacer.js +1 -1
- package/src/tasks/overwrite-api-guides.js +1 -1
- package/src/tasks/read-doc-sources.js +1 -1
- package/src/tasks/run-webpack.js +1 -1
- package/src/tasks/validate-html-w3c.js +1 -1
- package/src/tasks/validate-links.js +1 -1
- package/src/tasks/watcher.js +1 -1
- package/src/tasks/write-html-files.js +1 -1
- package/src/template/template-collection.js +1 -1
- package/themes/umberto/layout/_api-docs/_mixin/_link-or-text.pug +2 -0
- package/themes/umberto/layout/_api-docs/_mixin/_type.pug +3 -0
- package/themes/umberto/layout/_api-docs/typedef.pug +8 -0
- package/themes/umberto/src/css/_api-content.scss +1 -1
- package/themes/umberto/src/css/_api-info-box.scss +1 -1
- package/themes/umberto/src/css/_api-props-filter.scss +1 -1
- package/themes/umberto/src/css/_api-see-source.scss +1 -1
- package/themes/umberto/src/css/_api-subheader.scss +1 -1
- package/themes/umberto/src/css/_api-tree.scss +1 -1
- package/themes/umberto/src/css/_badge.scss +1 -1
- package/themes/umberto/src/css/_collapsinglist.scss +1 -1
- package/themes/umberto/src/css/_content.scss +1 -1
- package/themes/umberto/src/css/_docsearch.scss +1 -1
- package/themes/umberto/src/css/_dropdown.scss +1 -1
- package/themes/umberto/src/css/_editor-icon.scss +1 -1
- package/themes/umberto/src/css/_feedback-widget.scss +1 -1
- package/themes/umberto/src/css/_footer.scss +1 -1
- package/themes/umberto/src/css/_formatted.scss +2 -3
- package/themes/umberto/src/css/_guide-content.scss +1 -1
- package/themes/umberto/src/css/_guide-sdk-tree.scss +1 -1
- package/themes/umberto/src/css/_loading-spinner.scss +1 -1
- package/themes/umberto/src/css/_main.scss +1 -1
- package/themes/umberto/src/css/_navigation.scss +1 -1
- package/themes/umberto/src/css/_notice.scss +1 -1
- package/themes/umberto/src/css/_print.scss +1 -1
- package/themes/umberto/src/css/_prism.scss +1 -1
- package/themes/umberto/src/css/_rwd-breadcrumbs.scss +1 -1
- package/themes/umberto/src/css/_rwd-menu.scss +1 -1
- package/themes/umberto/src/css/_secondary-navigation.scss +1 -1
- package/themes/umberto/src/css/_theme-dark.scss +1 -1
- package/themes/umberto/src/css/_toggler.scss +1 -1
- package/themes/umberto/src/css/_top.scss +1 -1
- package/themes/umberto/src/css/_tree.scss +1 -1
- package/themes/umberto/src/css/_warning-banner.scss +1 -1
- package/themes/umberto/src/css/components/_lightbox.scss +1 -1
- package/themes/umberto/src/css/helpers/_color.scss +1 -1
- package/themes/umberto/src/css/helpers/_font.scss +1 -1
- package/themes/umberto/src/css/helpers/_globals.scss +1 -1
- package/themes/umberto/src/css/helpers/_reset.scss +1 -1
- package/themes/umberto/src/css/helpers/_spacing.scss +1 -1
- package/themes/umberto/src/css/pages/_sdk.scss +1 -1
- package/themes/umberto/src/css/styles.scss +1 -1
- package/themes/umberto/src/js/_anchors.js +1 -1
- package/themes/umberto/src/js/_apisearch.js +1 -1
- package/themes/umberto/src/js/_apitree.js +1 -1
- package/themes/umberto/src/js/_attachpermalinklistener.js +1 -1
- package/themes/umberto/src/js/_collapsables.js +1 -1
- package/themes/umberto/src/js/_copymobileapinavigation.js +1 -1
- package/themes/umberto/src/js/_devnames.js +1 -1
- package/themes/umberto/src/js/_dropdowns.js +1 -1
- package/themes/umberto/src/js/_filtering.js +1 -1
- package/themes/umberto/src/js/_imageModal.js +1 -1
- package/themes/umberto/src/js/_pagenavigation.js +1 -1
- package/themes/umberto/src/js/_prism.js +1 -1
- package/themes/umberto/src/js/_rwdmenu.js +1 -1
- package/themes/umberto/src/js/_samplecode.js +1 -1
- package/themes/umberto/src/js/_sidenavigation.js +1 -1
- package/themes/umberto/src/js/_toc.js +1 -1
- package/themes/umberto/src/js/_tooltips.js +1 -1
- package/themes/umberto/src/js/_warningbanner.js +1 -1
- package/themes/umberto/src/js/app.js +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,24 @@
|
|
|
1
1
|
Changelog
|
|
2
2
|
=========
|
|
3
3
|
|
|
4
|
+
## [4.2.1](https://github.com/cksource/umberto/compare/v4.2.0...v4.2.1) (2024-04-15)
|
|
5
|
+
|
|
6
|
+
### Bug fixes
|
|
7
|
+
|
|
8
|
+
* Used a regular font in `<kbd>` to improve readability. Closes [#1191](https://github.com/cksource/umberto/issues/1191). ([commit](https://github.com/cksource/umberto/commit/720f1d63ddb8f0c93f32566b5a93d24c3d835030))
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
## [4.2.0](https://github.com/cksource/umberto/compare/v4.1.2...v4.2.0) (2024-02-28)
|
|
12
|
+
|
|
13
|
+
### Features
|
|
14
|
+
|
|
15
|
+
* The event structures (typedef) will now include a list of classes that fire an event with the given type. Closes [#1139](https://github.com/cksource/umberto/issues/1139). ([commit](https://github.com/cksource/umberto/commit/0bb26f63d922f1e6164210db2c25a54f83f1d752))
|
|
16
|
+
|
|
17
|
+
### Bug fixes
|
|
18
|
+
|
|
19
|
+
* Support for converting nested arrays which are a part of a union structure. Closes [#1189](https://github.com/cksource/umberto/issues/1189). ([commit](https://github.com/cksource/umberto/commit/472250c6cabc6146bc7ebe92b1cd6b47a0329dd7))
|
|
20
|
+
|
|
21
|
+
|
|
4
22
|
## [4.1.2](https://github.com/cksource/umberto/compare/v4.1.1...v4.1.2) (2023-11-13)
|
|
5
23
|
|
|
6
24
|
### Bug fixes
|
package/LICENSE.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
Software License Agreement
|
|
2
2
|
==========================
|
|
3
3
|
|
|
4
|
-
Copyright (c) 2017-
|
|
4
|
+
Copyright (c) 2017-2024, [CKSource](http://cksource.com) Holding sp. z o.o. All rights reserved.
|
|
5
5
|
|
|
6
6
|
Licensed under the terms of [MIT License](https://opensource.org/licenses/MIT).
|
|
7
7
|
|
package/hexo-shim.js
CHANGED
package/package.json
CHANGED
package/scripts/helper/u-toc.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* @license Copyright (c) 2017-
|
|
2
|
+
* @license Copyright (c) 2017-2024, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
3
|
* For licensing, see LICENSE.md.
|
|
4
4
|
*/
|
|
5
5
|
|
|
@@ -68,6 +68,7 @@ module.exports = class DocDataFactory {
|
|
|
68
68
|
since: doclet.since,
|
|
69
69
|
file: doclet.file,
|
|
70
70
|
see: doclet.see,
|
|
71
|
+
firedBy: doclet.firedBy,
|
|
71
72
|
badges,
|
|
72
73
|
description,
|
|
73
74
|
// By default we want to show a link to source. However, those URLs can be hide using the `@skipsource` annotation.
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* @license Copyright (c) 2017-
|
|
2
|
+
* @license Copyright (c) 2017-2024, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
3
|
* For licensing, see LICENSE.md.
|
|
4
4
|
*/
|
|
5
5
|
|
|
@@ -201,6 +201,44 @@ module.exports = class AbstractParser {
|
|
|
201
201
|
} );
|
|
202
202
|
}
|
|
203
203
|
|
|
204
|
+
/**
|
|
205
|
+
* @param {TypedocReflectionMeta} signature
|
|
206
|
+
* @param {String} parentName
|
|
207
|
+
* @returns {Array.<Object>|null}
|
|
208
|
+
*/
|
|
209
|
+
getFiredBy( signature, parentName ) {
|
|
210
|
+
if ( !signature.comment ) {
|
|
211
|
+
return null;
|
|
212
|
+
}
|
|
213
|
+
|
|
214
|
+
if ( !signature.comment.blockTags ) {
|
|
215
|
+
return null;
|
|
216
|
+
}
|
|
217
|
+
|
|
218
|
+
const eventTags = signature.comment.blockTags.filter( blockTag => blockTag.tag === '@eventName' );
|
|
219
|
+
|
|
220
|
+
if ( !eventTags.length ) {
|
|
221
|
+
return null;
|
|
222
|
+
}
|
|
223
|
+
|
|
224
|
+
return eventTags
|
|
225
|
+
.map( eventTag => {
|
|
226
|
+
const textContent = eventTag.content.find( item => item.kind === 'text' );
|
|
227
|
+
|
|
228
|
+
if ( !textContent ) {
|
|
229
|
+
return null;
|
|
230
|
+
}
|
|
231
|
+
|
|
232
|
+
const [ , className, eventName ] = textContent.text.match( /~([A-Za-z]+)#([A-Za-z:_{}]+)$/ );
|
|
233
|
+
const pathPrefix = textContent.text.startsWith( 'module:' ) ? textContent.text.split( '~' )[ 0 ] : parentName;
|
|
234
|
+
const url = `${ pathPrefix }~${ className }#event:${ eventName }`;
|
|
235
|
+
const name = `${ className }#${ eventName }`;
|
|
236
|
+
|
|
237
|
+
return { url, name };
|
|
238
|
+
} )
|
|
239
|
+
.filter( Boolean );
|
|
240
|
+
}
|
|
241
|
+
|
|
204
242
|
/**
|
|
205
243
|
* Returns the URL to GitHub with selected line, where the given doclet is defined.
|
|
206
244
|
* The URL includes a commit hash which was used to build the API docs.
|