feat(docs): @docs-private support (#1231)

docs/app/@theme/services/index.ts

@@ -10,3 +10,4 @@ export * from './visibility.service';
 export * from './pagination.service';
 export * from './analytics.service';
 export * from './menu.service';
+export * from './metadata.service';

docs/app/@theme/services/metadata.service.ts

@@ -0,0 +1,8 @@
+import { Injectable } from '@angular/core';
+
+@Injectable()
+export class NgdMetadataService {
+ isPublic(prop): boolean {
+ return !prop.isDocsPrivate && !prop.inherited;
+ }
+}

docs/app/@theme/services/tabbed.service.ts

@@ -1,8 +1,11 @@
 import { Injectable } from '@angular/core';
+import { NgdMetadataService } from './metadata.service';
 
 @Injectable()
 export class NgdTabbedService {
 
+ constructor(private metadataService: NgdMetadataService) {}
+
  determineTabs(tabs: any): { [tab: string]: boolean } {
  return {
  'overview': this.hasOverview(tabs),
@@ -36,14 +39,16 @@ export class NgdTabbedService {
  componentHasProps(component): boolean {
  return component &&
  component.props &&
- component.props.length > 0;
+ component.props.filter(m => this.metadataService.isPublic(m)).length > 0;
  }
 
  componentHasMethods(component): boolean {
  return component &&
  component.methods &&
  component.methods.length > 0 &&
- component.methods.some(method => method.shortDescription || method.description);
+ component.methods
+ .filter(m => this.metadataService.isPublic(m))
+ .some(method => method.shortDescription || method.description);
  }
 
  componentHasOverview(component): boolean {

docs/app/@theme/theme.module.ts

@@ -45,6 +45,7 @@ import {
  NgdPaginationService,
  NgdAnalytics,
  NgdMenuService,
+ NgdMetadataService,
 } from './services';
 
 
@@ -111,6 +112,7 @@ export class NgdThemeModule {
  NgdAnalytics,
  NgdMenuService,
  NgdVisibilityService,
+ NgdMetadataService,
  ],
  };
  }

docs/app/blocks/components/methods-block/methods-block.component.ts

@@ -5,6 +5,7 @@
  */
 
 import { ChangeDetectionStrategy, Component, Input } from '@angular/core';
+import { NgdMetadataService } from '../../../@theme/services';
 
 @Component({
  selector: 'ngd-methods-block',
@@ -49,6 +50,8 @@ export class NgdMethodsBlockComponent {
 
  @Input('source')
  set setSource(source: any) {
- this.methods = source.methods;
+ this.methods = source.methods.filter(m => this.metadataService.isPublic(m));
  };
+
+ constructor(private metadataService: NgdMetadataService) {}
 }

docs/app/blocks/components/props-block/props-block.component.ts

@@ -6,6 +6,7 @@
  */
 
 import { ChangeDetectionStrategy, Component, Input } from '@angular/core';
+import { NgdMetadataService } from '../../../@theme/services';
 
 @Component({
  selector: 'ngd-props-block',
@@ -42,10 +43,12 @@ export class NgdPropsBlockComponent {
 
  @Input('source')
  set setSource(source: any) {
- this.inputs = source.props.filter(item => item.kind === 'input');
- this.outputs = source.props.filter(item => item.kind === 'output');
- this.props = source.props.filter(item => item.kind === 'property');
+ this.inputs = source.props.filter(item => item.kind === 'input').filter(m => this.metadataService.isPublic(m));
+ this.outputs = source.props.filter(item => item.kind === 'output').filter(m => this.metadataService.isPublic(m));
+ this.props = source.props.filter(item => item.kind === 'property').filter(m => this.metadataService.isPublic(m));
  this.name = source.name;
  this.slag = source.slag;
  }
+
+ constructor(private metadataService: NgdMetadataService) {}
 }

package.json

@@ -134,7 +134,7 @@
  "codelyzer": "4.5.0",
  "conventional-changelog-cli": "1.3.4",
  "del": "3.0.0",
- "doc-prsr": "2.1.1",
+ "doc-prsr": "2.2.0",
  "firebase-tools": "^3.18.6",
  "gulp": "3.9.1",
  "gulp-autoprefixer": "3.1.1",
@@ -174,4 +174,4 @@
  "uglifyjs-webpack-plugin": "1.1.5"
  },
  "schematics": "./schematics/dist/collection.json"
-}
+}