umberto 4.1.2 → 4.2.0
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 +11 -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 +1 -1
- 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
|
@@ -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
|
|
|
@@ -415,18 +415,26 @@ class TypeConverter {
|
|
|
415
415
|
const convertedType = this._convertSingleType( typeReflection );
|
|
416
416
|
|
|
417
417
|
if ( type.type === 'array' ) {
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
}
|
|
418
|
+
return this.convertArray( convertedType );
|
|
419
|
+
}
|
|
421
420
|
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
421
|
+
return convertedType;
|
|
422
|
+
}
|
|
423
|
+
|
|
424
|
+
/**
|
|
425
|
+
* @param {TypedocTypeDetails|null} type
|
|
426
|
+
* @returns {string|Array}
|
|
427
|
+
*/
|
|
428
|
+
convertArray( type ) {
|
|
429
|
+
if ( !type ) {
|
|
430
|
+
return 'Array';
|
|
431
|
+
}
|
|
425
432
|
|
|
426
|
-
|
|
433
|
+
if ( type instanceof Set ) {
|
|
434
|
+
return [ ...type ];
|
|
427
435
|
}
|
|
428
436
|
|
|
429
|
-
return
|
|
437
|
+
return [ type ];
|
|
430
438
|
}
|
|
431
439
|
|
|
432
440
|
/**
|
|
@@ -653,6 +661,13 @@ class TypeConverter {
|
|
|
653
661
|
return this.convertIntrinsicType( typeReflection );
|
|
654
662
|
}
|
|
655
663
|
|
|
664
|
+
// An array can be a part of a union type. Example: `string | Array<string> | Array<Array<string>>`.
|
|
665
|
+
// Hence, it needs to be parsed twice (`#convert()` and `#_convertSingleType()).
|
|
666
|
+
// See: #1189.
|
|
667
|
+
if ( typeReflection.type === 'array' ) {
|
|
668
|
+
return this.convertArray( typeReflection );
|
|
669
|
+
}
|
|
670
|
+
|
|
656
671
|
// Inline type: an object or a function.
|
|
657
672
|
if ( typeReflection.type === 'reflection' ) {
|
|
658
673
|
if ( Array.isArray( typeReflection.declaration.signatures ) ) {
|
|
@@ -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
|
|
|
@@ -34,6 +34,7 @@ module.exports = class TypeParser extends AbstractParser {
|
|
|
34
34
|
skipSource: this.shouldSkipSource( item ),
|
|
35
35
|
description: this.getComment( item ),
|
|
36
36
|
deprecated: this.isDeprecated( item ),
|
|
37
|
+
firedBy: this.getFiredBy( item, parentName ),
|
|
37
38
|
|
|
38
39
|
// This property will be filled in the post-processing phase.
|
|
39
40
|
typeParameters: null
|
package/src/helpers/copy-file.js
CHANGED
package/src/helpers/html-safe.js
CHANGED
package/src/helpers/snippets.js
CHANGED
package/src/hexo-manager.js
CHANGED
package/src/index.js
CHANGED
package/src/tasks/build-sdk.js
CHANGED
package/src/tasks/cache-files.js
CHANGED
package/src/tasks/copy-assets.js
CHANGED
package/src/tasks/copy-files.js
CHANGED
package/src/tasks/run-webpack.js
CHANGED
package/src/tasks/watcher.js
CHANGED
|
@@ -27,6 +27,8 @@ mixin linkOrText( name, options = {} )
|
|
|
27
27
|
- nameText += ( parts.isStatic ? '.' : '#' ) + parts.name
|
|
28
28
|
else
|
|
29
29
|
- nameText = parts.name || parts.longnameBase
|
|
30
|
+
if ( parts.name === 'event' && parts.label )
|
|
31
|
+
- nameText += `:${ parts.label }`
|
|
30
32
|
|
|
31
33
|
- nameText = htmlsafe( nameText );
|
|
32
34
|
|
|
@@ -76,6 +76,9 @@ mixin renderType( type )
|
|
|
76
76
|
//- Backward compatibility, when passing a `module:...` string.
|
|
77
77
|
if ( typeof type === 'string' )
|
|
78
78
|
+renderStringValue( type )
|
|
79
|
+
//- `intrinsic` type.
|
|
80
|
+
else if ( type.elementType )
|
|
81
|
+
| #{ type.elementType.name }
|
|
79
82
|
else
|
|
80
83
|
//- Complex structures introduced when generating API pages from TypeScript.
|
|
81
84
|
if ( type instanceof Set )
|
|
@@ -3,6 +3,7 @@ include ./_mixin/_api-title
|
|
|
3
3
|
include ./_mixin/_params
|
|
4
4
|
include ./_mixin/_return
|
|
5
5
|
include ./_mixin/_related
|
|
6
|
+
include ./_mixin/_link-or-text
|
|
6
7
|
|
|
7
8
|
block prepend content
|
|
8
9
|
+apiTitle( { iconPath: 'assets/' + umbertoVersion + '/img/data.svg', kind: 'Typedef' } )
|
|
@@ -23,6 +24,13 @@ block append content
|
|
|
23
24
|
if isNonEmptyArray( data.see )
|
|
24
25
|
+related( data.see )
|
|
25
26
|
|
|
27
|
+
if data.firedBy
|
|
28
|
+
h2 Fired by
|
|
29
|
+
ul
|
|
30
|
+
each firedByItem in data.firedBy
|
|
31
|
+
li
|
|
32
|
+
+linkOrText( firedByItem.url, { linkText: firedByItem.name } )
|
|
33
|
+
|
|
26
34
|
//- Make sure to add the report issue widget at the end of the page.
|
|
27
35
|
block append content
|
|
28
36
|
if page.reportIssueWidget
|