@ng-doc/builder 15.4.1 → 15.5.1

package/engine/actions/demo.action.js

@@ -12,8 +12,8 @@ const core_1 = require("@ng-doc/core");
 function demoAction(componentName, options) {
     return () => {
         return {
-            output: `<ng-doc-demo componentName="${componentName}">
-						<div id="options">${(0, core_1.escapeHtml)(JSON.stringify(options !== null && options !== void 0 ? options : {}))}</div>
+            output: `<ng-doc-demo componentName="${componentName}">
+						<div id="options">${(0, core_1.escapeHtml)(JSON.stringify(options !== null && options !== void 0 ? options : {}))}</div>
 					</ng-doc-demo>`,
         };
     };

package/engine/template-filters.d.ts

@@ -1,2 +1,2 @@
-export { accessorPresentation, constructorPresentation, displayType, extractDocs, extractParameterDocs, extractSeeDocs, extractSelectors, filterByScope, filterByStatic, filterUselessMembers, firstNodeWithComment, functionPresentation, getAccessorChain, getClassAccessors, getClassMethods, getClassProperties, getContentForPlayground, getDeclarationType, getImplementedMember, getInheritedParent, getInterfaceAccessors, getInterfaceMethods, getInterfaceProperties, getMemberParent, getMethodChain, getOverriddenMember, getPlaygroundClassProperties, getPropertyChain, getTargetForPlayground, getTemplateForPlayground, groupAccessors, marked, methodPresentation, noEmpty, noLineBreaks, notEmptyAssets, sortByNodesName, typeAliasPresentation, variablePresentation } from '../helpers';
+export { accessorPresentation, constructorPresentation, displayType, extractDocs, extractParameterDocs, extractSeeDocs, extractSelectors, filterByScope, filterByStatic, filterUselessMembers, firstNodeWithComment, functionPresentation, getAccessorChain, getClassAccessors, getClassMethods, getClassProperties, getContentForPlayground, getDeclarationType, getImplementedMember, getInheritedParent, getInterfaceAccessors, getInterfaceMethods, getInterfaceProperties, getMemberParent, getMethodChain, getOverriddenMember, getPlaygroundClassProperties, getPropertyChain, getTargetForPlayground, getTemplateForPlayground, groupAccessors, marked, methodPresentation, noEmpty, noLineBreaks, notEmptyAssets, sortByNodesName, sortNavigationEntities, typeAliasPresentation, variablePresentation, } from '../helpers';
 export { buildPlaygroundDemoTemplate, objectKeys } from '@ng-doc/core';

package/engine/template-filters.js

@@ -1,7 +1,7 @@
 "use strict";
 /* Just export filters from this file, they will be included to the template renderer automatically */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.objectKeys = exports.buildPlaygroundDemoTemplate = exports.variablePresentation = exports.typeAliasPresentation = exports.sortByNodesName = exports.notEmptyAssets = exports.noLineBreaks = exports.noEmpty = exports.methodPresentation = exports.marked = exports.groupAccessors = exports.getTemplateForPlayground = exports.getTargetForPlayground = exports.getPropertyChain = exports.getPlaygroundClassProperties = exports.getOverriddenMember = exports.getMethodChain = exports.getMemberParent = exports.getInterfaceProperties = exports.getInterfaceMethods = exports.getInterfaceAccessors = exports.getInheritedParent = exports.getImplementedMember = exports.getDeclarationType = exports.getContentForPlayground = exports.getClassProperties = exports.getClassMethods = exports.getClassAccessors = exports.getAccessorChain = exports.functionPresentation = exports.firstNodeWithComment = exports.filterUselessMembers = exports.filterByStatic = exports.filterByScope = exports.extractSelectors = exports.extractSeeDocs = exports.extractParameterDocs = exports.extractDocs = exports.displayType = exports.constructorPresentation = exports.accessorPresentation = void 0;
+exports.objectKeys = exports.buildPlaygroundDemoTemplate = exports.variablePresentation = exports.typeAliasPresentation = exports.sortNavigationEntities = exports.sortByNodesName = exports.notEmptyAssets = exports.noLineBreaks = exports.noEmpty = exports.methodPresentation = exports.marked = exports.groupAccessors = exports.getTemplateForPlayground = exports.getTargetForPlayground = exports.getPropertyChain = exports.getPlaygroundClassProperties = exports.getOverriddenMember = exports.getMethodChain = exports.getMemberParent = exports.getInterfaceProperties = exports.getInterfaceMethods = exports.getInterfaceAccessors = exports.getInheritedParent = exports.getImplementedMember = exports.getDeclarationType = exports.getContentForPlayground = exports.getClassProperties = exports.getClassMethods = exports.getClassAccessors = exports.getAccessorChain = exports.functionPresentation = exports.firstNodeWithComment = exports.filterUselessMembers = exports.filterByStatic = exports.filterByScope = exports.extractSelectors = exports.extractSeeDocs = exports.extractParameterDocs = exports.extractDocs = exports.displayType = exports.constructorPresentation = exports.accessorPresentation = void 0;
 var helpers_1 = require("../helpers");
 Object.defineProperty(exports, "accessorPresentation", { enumerable: true, get: function () { return helpers_1.accessorPresentation; } });
 Object.defineProperty(exports, "constructorPresentation", { enumerable: true, get: function () { return helpers_1.constructorPresentation; } });
@@ -40,6 +40,7 @@ Object.defineProperty(exports, "noEmpty", { enumerable: true, get: function () {
 Object.defineProperty(exports, "noLineBreaks", { enumerable: true, get: function () { return helpers_1.noLineBreaks; } });
 Object.defineProperty(exports, "notEmptyAssets", { enumerable: true, get: function () { return helpers_1.notEmptyAssets; } });
 Object.defineProperty(exports, "sortByNodesName", { enumerable: true, get: function () { return helpers_1.sortByNodesName; } });
+Object.defineProperty(exports, "sortNavigationEntities", { enumerable: true, get: function () { return helpers_1.sortNavigationEntities; } });
 Object.defineProperty(exports, "typeAliasPresentation", { enumerable: true, get: function () { return helpers_1.typeAliasPresentation; } });
 Object.defineProperty(exports, "variablePresentation", { enumerable: true, get: function () { return helpers_1.variablePresentation; } });
 var core_1 = require("@ng-doc/core");

package/engine/template-filters.js.map

@@ -1 +1 @@
-{"version":3,"file":"template-filters.js","sourceRoot":"","sources":["../../../../libs/builder/engine/template-filters.ts"],"names":[],"mappings":";AAAA,sGAAsG;;;AAEtG,sCAuCyC;AAtCxC,+GAAA,oBAAoB,OAAA;AACpB,kHAAA,uBAAuB,OAAA;AACvB,sGAAA,WAAW,OAAA;AACX,sGAAA,WAAW,OAAA;AACX,+GAAA,oBAAoB,OAAA;AACpB,yGAAA,cAAc,OAAA;AACd,2GAAA,gBAAgB,OAAA;AAChB,wGAAA,aAAa,OAAA;AACb,yGAAA,cAAc,OAAA;AACd,+GAAA,oBAAoB,OAAA;AACpB,+GAAA,oBAAoB,OAAA;AACpB,+GAAA,oBAAoB,OAAA;AACpB,2GAAA,gBAAgB,OAAA;AAChB,4GAAA,iBAAiB,OAAA;AACjB,0GAAA,eAAe,OAAA;AACf,6GAAA,kBAAkB,OAAA;AAClB,kHAAA,uBAAuB,OAAA;AACvB,6GAAA,kBAAkB,OAAA;AAClB,+GAAA,oBAAoB,OAAA;AACpB,6GAAA,kBAAkB,OAAA;AAClB,gHAAA,qBAAqB,OAAA;AACrB,8GAAA,mBAAmB,OAAA;AACnB,iHAAA,sBAAsB,OAAA;AACtB,0GAAA,eAAe,OAAA;AACf,yGAAA,cAAc,OAAA;AACd,8GAAA,mBAAmB,OAAA;AACnB,uHAAA,4BAA4B,OAAA;AAC5B,2GAAA,gBAAgB,OAAA;AAChB,iHAAA,sBAAsB,OAAA;AACtB,mHAAA,wBAAwB,OAAA;AACxB,yGAAA,cAAc,OAAA;AACd,iGAAA,MAAM,OAAA;AACN,6GAAA,kBAAkB,OAAA;AAClB,kGAAA,OAAO,OAAA;AACP,uGAAA,YAAY,OAAA;AACZ,yGAAA,cAAc,OAAA;AACd,0GAAA,eAAe,OAAA;AACf,gHAAA,qBAAqB,OAAA;AACrB,+GAAA,oBAAoB,OAAA;AACrB,qCAAmE;AAA3D,mHAAA,2BAA2B,OAAA;AAAC,kGAAA,UAAU,OAAA"}
+{"version":3,"file":"template-filters.js","sourceRoot":"","sources":["../../../../libs/builder/engine/template-filters.ts"],"names":[],"mappings":";AAAA,sGAAsG;;;AAEtG,sCAyCoB;AAxCnB,+GAAA,oBAAoB,OAAA;AACpB,kHAAA,uBAAuB,OAAA;AACvB,sGAAA,WAAW,OAAA;AACX,sGAAA,WAAW,OAAA;AACX,+GAAA,oBAAoB,OAAA;AACpB,yGAAA,cAAc,OAAA;AACd,2GAAA,gBAAgB,OAAA;AAChB,wGAAA,aAAa,OAAA;AACb,yGAAA,cAAc,OAAA;AACd,+GAAA,oBAAoB,OAAA;AACpB,+GAAA,oBAAoB,OAAA;AACpB,+GAAA,oBAAoB,OAAA;AACpB,2GAAA,gBAAgB,OAAA;AAChB,4GAAA,iBAAiB,OAAA;AACjB,0GAAA,eAAe,OAAA;AACf,6GAAA,kBAAkB,OAAA;AAClB,kHAAA,uBAAuB,OAAA;AACvB,6GAAA,kBAAkB,OAAA;AAClB,+GAAA,oBAAoB,OAAA;AACpB,6GAAA,kBAAkB,OAAA;AAClB,gHAAA,qBAAqB,OAAA;AACrB,8GAAA,mBAAmB,OAAA;AACnB,iHAAA,sBAAsB,OAAA;AACtB,0GAAA,eAAe,OAAA;AACf,yGAAA,cAAc,OAAA;AACd,8GAAA,mBAAmB,OAAA;AACnB,uHAAA,4BAA4B,OAAA;AAC5B,2GAAA,gBAAgB,OAAA;AAChB,iHAAA,sBAAsB,OAAA;AACtB,mHAAA,wBAAwB,OAAA;AACxB,yGAAA,cAAc,OAAA;AACd,iGAAA,MAAM,OAAA;AACN,6GAAA,kBAAkB,OAAA;AAClB,kGAAA,OAAO,OAAA;AACP,uGAAA,YAAY,OAAA;AACZ,yGAAA,cAAc,OAAA;AACd,0GAAA,eAAe,OAAA;AACf,iHAAA,sBAAsB,OAAA;AACtB,gHAAA,qBAAqB,OAAA;AACrB,+GAAA,oBAAoB,OAAA;AAErB,qCAAqE;AAA7D,mHAAA,2BAA2B,OAAA;AAAE,kGAAA,UAAU,OAAA"}

package/helpers/index.d.ts

@@ -30,5 +30,6 @@ export * from './print-console';
 export * from './process-snippets';
 export * from './repo-link';
 export * from './slash';
+export * from './sort-navigation-entities';
 export * from './typescript';
 export * from './unique-name';

package/helpers/index.js

@@ -33,6 +33,7 @@ tslib_1.__exportStar(require("./print-console"), exports);
 tslib_1.__exportStar(require("./process-snippets"), exports);
 tslib_1.__exportStar(require("./repo-link"), exports);
 tslib_1.__exportStar(require("./slash"), exports);
+tslib_1.__exportStar(require("./sort-navigation-entities"), exports);
 tslib_1.__exportStar(require("./typescript"), exports);
 tslib_1.__exportStar(require("./unique-name"), exports);
 //# sourceMappingURL=index.js.map

package/helpers/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../libs/builder/helpers/index.ts"],"names":[],"mappings":";;;AAAA,yDAA+B;AAC/B,+DAAqC;AACrC,mEAAyC;AACzC,oEAA0C;AAC1C,8DAAoC;AACpC,wDAA8B;AAC9B,yDAA+B;AAC/B,gEAAsC;AACtC,8DAAoC;AACpC,mEAAyC;AACzC,8DAAoC;AACpC,wDAA8B;AAC9B,kEAAwC;AACxC,gEAAsC;AACtC,iEAAuC;AACvC,wEAA8C;AAC9C,mEAAyC;AACzC,yEAA+C;AAC/C,0DAAgC;AAChC,iEAAuC;AACvC,sEAA4C;AAC5C,iEAAuC;AACvC,qEAA2C;AAC3C,mDAAyB;AACzB,qDAA2B;AAC3B,2DAAiC;AACjC,6DAAmC;AACnC,yDAA+B;AAC/B,0DAAgC;AAChC,6DAAmC;AACnC,sDAA4B;AAC5B,kDAAwB;AACxB,uDAA6B;AAC7B,wDAA8B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../libs/builder/helpers/index.ts"],"names":[],"mappings":";;;AAAA,yDAA+B;AAC/B,+DAAqC;AACrC,mEAAyC;AACzC,oEAA0C;AAC1C,8DAAoC;AACpC,wDAA8B;AAC9B,yDAA+B;AAC/B,gEAAsC;AACtC,8DAAoC;AACpC,mEAAyC;AACzC,8DAAoC;AACpC,wDAA8B;AAC9B,kEAAwC;AACxC,gEAAsC;AACtC,iEAAuC;AACvC,wEAA8C;AAC9C,mEAAyC;AACzC,yEAA+C;AAC/C,0DAAgC;AAChC,iEAAuC;AACvC,sEAA4C;AAC5C,iEAAuC;AACvC,qEAA2C;AAC3C,mDAAyB;AACzB,qDAA2B;AAC3B,2DAAiC;AACjC,6DAAmC;AACnC,yDAA+B;AAC/B,0DAAgC;AAChC,6DAAmC;AACnC,sDAA4B;AAC5B,kDAAwB;AACxB,qEAA2C;AAC3C,uDAA6B;AAC7B,wDAA8B"}

package/helpers/sort-navigation-entities.d.ts

@@ -0,0 +1,6 @@
+import { NgDocNavigationEntity } from '../engine/entities/abstractions/navigation.entity';
+/**
+ *
+ * @param entities
+ */
+export declare function sortNavigationEntities<T>(entities: Array<NgDocNavigationEntity<T>>): Array<NgDocNavigationEntity<T>>;

package/helpers/sort-navigation-entities.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sortNavigationEntities = void 0;
+const is_present_1 = require("@ng-doc/core/helpers/is-present");
+/**
+ *
+ * @param entities
+ */
+function sortNavigationEntities(entities) {
+    return entities.sort((a, b) => {
+        if ((0, is_present_1.isPresent)(a.order) && (0, is_present_1.isPresent)(b.order)) {
+            return a.order - b.order;
+        }
+        if ((0, is_present_1.isPresent)(a.order)) {
+            return -1;
+        }
+        if ((0, is_present_1.isPresent)(b.order)) {
+            return 1;
+        }
+        return a.title.localeCompare(b.title);
+    });
+}
+exports.sortNavigationEntities = sortNavigationEntities;
+//# sourceMappingURL=sort-navigation-entities.js.map

package/helpers/sort-navigation-entities.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sort-navigation-entities.js","sourceRoot":"","sources":["../../../../libs/builder/helpers/sort-navigation-entities.ts"],"names":[],"mappings":";;;AAAA,gEAA0D;AAI1D;;;GAGG;AACH,SAAgB,sBAAsB,CAAI,QAAyC;IAClF,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAC,CAA2B,EAAE,CAA2B,EAAE,EAAE;QACjF,IAAI,IAAA,sBAAS,EAAC,CAAC,CAAC,KAAK,CAAC,IAAI,IAAA,sBAAS,EAAC,CAAC,CAAC,KAAK,CAAC,EAAE;YAC7C,OAAO,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC;SACzB;QACD,IAAI,IAAA,sBAAS,EAAC,CAAC,CAAC,KAAK,CAAC,EAAE;YACvB,OAAO,CAAC,CAAC,CAAC;SACV;QACD,IAAI,IAAA,sBAAS,EAAC,CAAC,CAAC,KAAK,CAAC,EAAE;YACvB,OAAO,CAAC,CAAC;SACT;QACD,OAAO,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;AACJ,CAAC;AAbD,wDAaC"}

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@ng-doc/builder",
-  "version": "15.4.1",
+  "version": "15.5.1",
   "type": "commonjs",
   "builders": "./builders.json",
   "schematics": "./schematics/collection.json",
   "dependencies": {
-    "@ng-doc/core": "15.4.1",
+    "@ng-doc/core": "15.5.1",
     "@angular-devkit/architect": ">=0.1500.0",
     "chokidar": "^3.5.3",
     "minimatch": "^5.1.0",

package/templates/api-page.module.ts.nunj

@@ -3,6 +3,7 @@ import {ChangeDetectionStrategy, Component, NgModule, Type} from "@angular/core"
 import {RouterModule} from "@angular/router";
 import {CommonModule} from '@angular/common';
 import {NgDocDemoAssets, NgDocPageModule, NgDocRootPage} from '@ng-doc/app';
+import {NgDocPageType} from '@ng-doc/core';
 import pageContent from '!!raw-loader!{{ page.builtPagePath }}';
 
 @Component({
@@ -11,6 +12,7 @@ import pageContent from '!!raw-loader!{{ page.builtPagePath }}';
 	providers: [{provide: NgDocRootPage, useExisting: DynamicComponent}],
 })
 export class DynamicComponent extends NgDocRootPage {
+	readonly pageType: NgDocPageType = 'api';
 	{%- if page.editSourceFileUrl %}
 	readonly editSourceFileUrl: string = '{{ page.editSourceFileUrl }}';
 	{%- endif %}

package/templates/context.ts.nunj

@@ -19,14 +19,14 @@ export const ngDocContextProvider: Provider = {
 				{%- endif %}
 				{%- if entity.navigationItems.length %}
 				children: [
-					{%- for child in entity.navigationItems %}
+					{%- for child in entity.navigationItems | sortNavigationEntities %}
 					{{ nav(child) }},
 					{%- endfor %}
 				]
 				{%- endif %}
 			}
 			{%- endmacro %}
-			{%- for entity in entities %}
+			{%- for entity in entities | sortNavigationEntities %}
 			{{ nav(entity) }},
 			{%- endfor %}
 		],

package/templates/helpers/declaration-modifiers.html.nunj

@@ -7,11 +7,13 @@
 	{% set isStatic = declaration.isStatic and declaration.isStatic() %}
 	{% set isAsync = declaration.isAsync and declaration.isAsync() %}
 	{% set isReadonly = declaration.isReadonly and declaration.isReadonly() %}
-	{% set tooltip = ["Abstract" if isAbstract, 'Static' if isStatic, 'Async' if isAsync, 'Readonly' if isReadonly] | noEmpty | join(', ') %}
+	{% set isProtected = declaration.getScope and declaration.getScope() == 'protected'  %}
+	{% set tooltip = ["Protected" if isProtected, "Abstract" if isAbstract, 'Static' if isStatic, 'Async' if isAsync, 'Readonly' if isReadonly] | noEmpty | join(', ') %}
 
 	{%- if type == 'badge' %}
-		{%- if isAbstract or isStatic or isAsync or isReadonly %}
+		{%- if isAbstract or isStatic or isAsync or isReadonly or isProtected %}
 			<span class="ng-doc-badge-wrapper" ngDocTooltip="{{ tooltip }}">
+				{{ badgeMacro.render("protected") if isProtected }}
 				{{ badgeMacro.render("abstract") if isAbstract }}
 				{{ badgeMacro.render("static") if isStatic }}
 				{{ badgeMacro.render("async") if isAsync }}
@@ -20,8 +22,9 @@
 		{%- endif %}
 
 	{%- elseif type == 'modifier' %}
-		{%- if isAbstract or isStatic or isAsync or isReadonly %}
+		{%- if isAbstract or isStatic or isAsync or isReadonly or isProtected %}
 			<div class="ng-doc-modifiers-wrapper">
+				{{ modifierMacro.render("protected") if isProtected }}
 				{{ modifierMacro.render("abstract") if isAbstract }}
 				{{ modifierMacro.render("static") if isStatic }}
 				{{ modifierMacro.render("async") if isAsync }}
@@ -29,8 +32,9 @@
 			</div>
 		{%- endif %}
 	{%- else %}
-		{%- if isAbstract or isStatic or isAsync or isReadonly %}
+		{%- if isAbstract or isStatic or isAsync or isReadonly or isProtected %}
 			<span class="ng-doc-tags-wrapper">
+				{{ tagMacro.render("protected") if isProtected }}
 				{{ tagMacro.render("abstract") if isAbstract }}
 				{{ tagMacro.render("static") if isStatic }}
 				{{ tagMacro.render("async") if isAsync }}

package/templates/page.module.ts.nunj

@@ -3,7 +3,7 @@ import {Component, NgModule, Type, ChangeDetectionStrategy} from '@angular/core'
 import {RouterModule} from '@angular/router';
 import {CommonModule} from '@angular/common';
 import {NgDocPageModule, NgDocRootPage, NgDocDemoAssets} from '@ng-doc/app';
-import {NgDocDependencies} from '@ng-doc/core';
+import {NgDocDependencies, NgDocPageType} from '@ng-doc/core';
 import pageContent from '!!raw-loader!{{ page.builtPagePath }}';
 {%- if page.pageDependencies %}
 // noinspection ES6UnusedImports
@@ -22,6 +22,7 @@ import demoAssets from '{{ page.componentsAssets }}';
 	providers: [{provide: NgDocRootPage, useExisting: DynamicComponent}],
 })
 export class DynamicComponent extends NgDocRootPage {
+	readonly pageType: NgDocPageType = 'guide';
 	readonly pageContent: string = pageContent;
 
 	{%- if page.editSourceFileUrl %}