@ng-doc/builder 15.0.0-beta.10

package/templates/api/class.html.nunj

@@ -0,0 +1,66 @@
+{% extends "api/base.html.nunj" %}
+
+{% import "helpers/type.html.nunj" as typeMacro %}
+{% import "helpers/methods.html.nunj" as methodsMacro %}
+{% import "helpers/properties.html.nunj" as propertiesMacro %}
+{% import "helpers/tag.html.nunj" as tagMacro %}
+{% import "helpers/modifier.html.nunj" as modifierMacro %}
+
+{% block modifier %}
+	{{ modifierMacro.render('Abstract') }}
+{% endblock %}
+
+{% block details %}
+	{% set extends = declaration.getExtends() %}
+	{% set implements = declaration.getImplements() %}
+
+	{% if extends or implements.length %}
+		<div class="ng-doc-header-details">
+			{% if extends %}
+				<span class="ng-doc-header-details-label">Extends</span>
+				{{ tagMacro.render(typeMacro.render(extends.getType()), "class-extends") }}
+			{%- endif %}
+			{% if implements.length %}
+				<span class="ng-doc-header-details-label">Implements</span>
+				{%- for i in implements -%}
+					{{ tagMacro.render(typeMacro.render(i.getType()), "class-implements") }}
+				{%- endfor %}
+			{%- endif %}
+		</div>
+	{% endif %}
+{% endblock %}
+
+{% block overview %}
+	{%- set staticProperties = declaration.getProperties() | filterByStatic(true) | filterByScope("public") -%}
+	{%- set staticMethods = declaration.getMethods() | filterByStatic(true) | filterByScope("public") -%}
+	{%- set properties = declaration.getProperties() | filterByStatic(false) | filterByScope("public") -%}
+	{%- set methods = declaration.getMethods() | filterByStatic(false) | filterByScope("public") -%}
+
+	{% if staticProperties.length -%}
+		<section>
+			<h2>Static Properties</h2>
+			{{ propertiesMacro.render(staticProperties) }}
+		</section>
+	{%- endif %}
+
+	{% if properties.length -%}
+		<section>
+			<h2>Properties</h2>
+			{{ propertiesMacro.render(properties) }}
+		</section>
+	{%- endif %}
+
+	{% if staticMethods.length -%}
+		<section>
+			<h2>Static Methods</h2>
+			{{ methodsMacro.render(staticMethods) }}
+		</section>
+	{%- endif %}
+
+	{% if methods.length -%}
+		<section>
+			<h2>Methods</h2>
+			{{ methodsMacro.render(methods) }}
+		</section>
+	{%- endif %}
+{% endblock %}

package/templates/api/enum.html.nunj

@@ -0,0 +1,14 @@
+{% extends "api/base.html.nunj" %}
+
+{% import "helpers/members.html.nunj" as membersMacro %}
+
+{% block overview %}
+	{%- set members = declaration.getMembers() -%}
+
+	{% if members.length -%}
+		<section>
+			<h2>Members</h2>
+			{{ membersMacro.render(members) }}
+		</section>
+	{%- endif %}
+{% endblock %}

package/templates/api/function.html.nunj

@@ -0,0 +1,20 @@
+{% extends "api/base.html.nunj" %}
+
+{% import "helpers/code.html.nunj" as codeMacro %}
+{% import "helpers/parameters.html.nunj" as parametersMacro %}
+
+{% block overview %}
+	{%- set parameters = declaration.getParameters() -%}
+
+	<section>
+		<h2>Presentation</h2>
+		{{ codeMacro.render(declaration | methodPresentation, "typescript", false) }}
+	</section>
+
+	{% if parameters.length -%}
+		<section>
+			<h2>Parameters</h2>
+			{{ parametersMacro.render(parameters, declaration) }}
+		</section>
+	{%- endif %}
+{% endblock %}

package/templates/api/interface.html.nunj

@@ -0,0 +1,38 @@
+{% extends "api/base.html.nunj" %}
+
+{% import "helpers/type.html.nunj" as typeMacro %}
+{% import "helpers/methods.html.nunj" as methodsMacro %}
+{% import "helpers/properties.html.nunj" as propertiesMacro %}
+{% import "helpers/tag.html.nunj" as tagMacro %}
+
+{% block details %}
+	{%- set extends = declaration.getExtends() -%}
+
+	{% if extends.length %}
+		<div class="ng-doc-header-details">
+			<span class="ng-doc-header-details-label">Extends</span>
+			{%- for i in extends -%}
+				{{ tagMacro.render(typeMacro.render(i.getType()), "interface-extends") }}
+			{%- endfor %}
+		</div>
+	{% endif %}
+{% endblock %}
+
+{% block overview %}
+	{%- set properties = declaration.getProperties() -%}
+	{%- set methods = declaration.getMethods() -%}
+
+	{% if properties.length -%}
+		<section>
+			<h2>Properties</h2>
+			{{ propertiesMacro.render(properties) }}
+		</section>
+	{%- endif %}
+
+	{% if methods.length -%}
+		<section>
+			<h2>Methods</h2>
+			{{ methodsMacro.render(methods) }}
+		</section>
+	{%- endif %}
+{% endblock %}

package/templates/api/type-alias.html.nunj

@@ -0,0 +1,10 @@
+{% extends "api/base.html.nunj" %}
+
+{% import "helpers/code.html.nunj" as codeMacro %}
+
+{% block overview %}
+	<section>
+		<h2>Presentation</h2>
+		{{ codeMacro.render(declaration | typeAliasPresentation, "typescript", false) }}
+	</section>
+{% endblock %}

package/templates/api/variable.html.nunj

@@ -0,0 +1,10 @@
+{% extends "api/base.html.nunj" %}
+
+{% import "helpers/code.html.nunj" as codeMacro %}
+
+{% block overview %}
+	<section>
+		<h2>Presentation</h2>
+		{{ codeMacro.render(declaration | variablePresentation, "typescript", false) }}
+	</section>
+{% endblock %}

package/templates/api-page.html.nunj

@@ -0,0 +1,16 @@
+
+{% set docNode = declaration %}
+{% if Node.isClassDeclaration(declaration) -%}
+	{% include "api/class.html.nunj" %}
+{%- elseif Node.isInterfaceDeclaration(declaration) -%}
+	{% include "api/interface.html.nunj" %}
+{%- elseif Node.isEnumDeclaration(declaration) -%}
+	{% include "api/enum.html.nunj" %}
+{%- elseif Node.isFunctionDeclaration(declaration) -%}
+	{% include "api/function.html.nunj" %}
+{%- elseif Node.isTypeAliasDeclaration(declaration) -%}
+	{% include "api/type-alias.html.nunj" %}
+{%- elseif Node.isVariableDeclaration(declaration) -%}
+	{% set docNode = declaration.getVariableStatement() %}
+	{% include "api/variable.html.nunj" %}
+{%- endif -%}

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

@@ -0,0 +1,36 @@
+// @ts-nocheck
+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 pageContent from '!!raw-loader!{{ page.builtPagePath }}';
+
+@Component({
+	template: `<ng-doc-page></ng-doc-page>`,
+	changeDetection: ChangeDetectionStrategy.OnPush,
+	providers: [{provide: NgDocRootPage, useExisting: {{ page.componentName }}}],
+})
+export class {{ page.componentName }} extends NgDocRootPage {
+	readonly pageContent: string = pageContent;
+	readonly demo: Record<string, Type<unknown>> | undefined = undefined;
+	readonly demoAssets: NgDocDemoAssets | undefined = undefined;
+
+	constructor() {
+		super();
+	}
+}
+
+@NgModule({
+	declarations: [{{ page.componentName }}],
+	imports: [
+		CommonModule,
+		NgDocPageModule,
+		RouterModule.forChild([{
+			path: '',
+			component: {{ page.componentName }},
+		}]),
+	],
+	exports: [RouterModule]
+})
+export class {{ page.moduleName }} {
+}

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

@@ -0,0 +1,27 @@
+// @ts-nocheck
+import {NgModule} from "@angular/core";
+import {RouterModule} from "@angular/router";
+
+@NgModule({
+	imports: [
+		RouterModule.forChild([
+			{%- if scope.children.length %}
+			{path: '', redirectTo: '{{ scope.children[0].route }}', pathMatch: 'full' },
+			{%- endif  %}
+			{
+				path: '',
+				children: [
+					{%- for page in scope.children %}
+					{
+						path: '{{ page.route }}',
+						loadChildren: () => import('{{ page.moduleImport }}').then(m => m.{{ page.moduleName }})
+					},
+					{%- endfor %}
+				]
+			}
+		]),
+	],
+	exports: [RouterModule]
+})
+export class {{ scope.moduleName }} {
+}

package/templates/api.module.ts.nunj

@@ -0,0 +1,40 @@
+// @ts-nocheck
+import {ChangeDetectionStrategy, Component, NgModule} from "@angular/core";
+import {RouterModule} from "@angular/router";
+import {CommonModule} from '@angular/common';
+import {NgDocApiListModule, NG_DOC_API_LIST_TOKEN} from '@ng-doc/app';
+import apiList from './ng-doc.api-list.json';
+
+@Component({
+	template: `<ng-doc-api-list></ng-doc-api-list>`,
+	providers: [{
+		provide: NG_DOC_API_LIST_TOKEN,
+		useValue: apiList
+	}],
+	changeDetection: ChangeDetectionStrategy.OnPush,
+})
+export class {{ api.componentName }} {
+}
+
+@NgModule({
+	declarations: [{{ api.componentName }}],
+	imports: [
+		CommonModule,
+		NgDocApiListModule,
+		RouterModule.forChild([
+			{
+				path: '',
+				component: {{ api.componentName }},
+			},
+			{%- for scope in api.children %}
+			{
+				path: '{{ scope.route }}',
+				loadChildren: () => import('{{ scope.moduleImport }}').then(m => m.{{ scope.moduleName }})
+			},
+			{%- endfor %}
+		]),
+	],
+	exports: [RouterModule]
+})
+export class {{ api.moduleName }} {
+}

package/templates/category.module.ts.nunj

@@ -0,0 +1,26 @@
+// @ts-nocheck
+import {NgModule} from "@angular/core";
+import {RouterModule} from "@angular/router";
+
+@NgModule({
+	imports: [RouterModule.forChild([
+		{%- if category.children.length %}
+		{path: '', redirectTo: '{{ category.children[0].route }}', pathMatch: 'full' },
+		{%- endif  %}
+		{
+			path: '',
+			children: [
+				{%- for child in category.children %}
+				{
+					path: '{{ child.route }}',
+					loadChildren: () => import('{{ child.moduleImport }}').then(m => m.{{ child.moduleName }})
+				},
+				{%- endfor %}
+			]
+		}
+	]),
+	],
+	exports: [RouterModule]
+})
+export class {{ category.moduleName }} {
+}

package/templates/component-assets.ts.nunj

@@ -0,0 +1,19 @@
+// @ts-nocheck
+import {NgDocDemoAssets} from '@ng-doc/app';
+{%- for componentName, assets in componentsAssets %}
+	{%- for asset in assets %}
+import {{ asset.name }} from '!!raw-loader!{{ asset.outputPath }}';
+	{%- endfor %}
+{%- endfor %}
+
+export const demoAssets: NgDocDemoAssets = {
+	{%- for componentName, assets in componentsAssets %}
+	{{ componentName }}: [
+		{%- for asset in assets %}
+		{title: '{{ asset.title }}', codeType: '{{ asset.type }}', code: {{ asset.name }}},
+		{%- endfor %}
+	],
+	{%- endfor %}
+}
+
+export default demoAssets;

package/templates/context.ts.nunj

@@ -0,0 +1,34 @@
+// @ts-nocheck
+import {Provider} from '@angular/core';
+import {NG_DOC_CONTEXT} from '@ng-doc/app/tokens';
+
+export const ngDocContextProvider: Provider = {
+	provide: NG_DOC_CONTEXT,
+	useValue: {
+		navigation: [
+			{%- macro nav(entity) %}
+			{
+				title: '{{ entity.title }}',
+				route: '{{ entity.fullRoute }}',
+				{%- if entity.isCategory %}
+				expandable: {{ entity.expandable }},
+				expanded: {{ entity.expanded }},
+				{%- endif %}
+				{%- if entity.order %}
+				order: {{ entity.order }},
+				{%- endif %}
+				{%- if entity.navigationItems.length %}
+				children: [
+					{%- for child in entity.navigationItems %}
+					{{ nav(child) }},
+					{%- endfor %}
+				]
+				{%- endif %}
+			}
+			{%- endmacro %}
+			{%- for entity in entities %}
+			{{ nav(entity) }},
+			{%- endfor %}
+		],
+	}
+}

package/templates/helpers/badge.html.nunj

@@ -0,0 +1,3 @@
+{%- macro render(content, attributeOverride) -%}
+	<span class="ng-doc-badge" data-content="{{ attributeOverride if attributeOverride else content }}">{{ content[0] }}</span>
+{%- endmacro -%}

package/templates/helpers/code.html.nunj

@@ -0,0 +1,3 @@
+{% macro render(code, language = "typescript", copyButton = true) -%}
+	<pre><code lang="{{ language }}" class="language-{{ language }}">{{ code | escape }}</code></pre>
+{%- endmacro %}

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

@@ -0,0 +1,40 @@
+{% import "helpers/tag.html.nunj" as tagMacro %}
+{% import "helpers/badge.html.nunj" as badgeMacro %}
+{% import "helpers/modifier.html.nunj" as modifierMacro %}
+
+{%- macro render(declaration, type='tag') -%}
+	{% set isAbstract = declaration.isAbstract and declaration.isAbstract() %}
+	{% set isStatic = declaration.isStatic and declaration.isStatic() %}
+	{% set isAsync = declaration.isAsync and declaration.isAsync() %}
+	{% set isReadonly = declaration.isReadonly and declaration.isReadonly() %}
+
+	{%- if type == 'badge' %}
+		{%- if isAbstract or isStatic or isAsync or isReadonly %}
+			<span class="ng-doc-badge-wrapper">
+				{{ badgeMacro.render("Abstract") if isAbstract }}
+				{{ badgeMacro.render("Static") if isStatic }}
+				{{ badgeMacro.render("Async") if isAsync }}
+				{{ badgeMacro.render("Readonly") if isReadonly }}
+			</span>
+		{%- endif %}
+
+	{%- elseif type == 'modifier' %}
+		{%- if isAbstract or isStatic or isAsync or isReadonly %}
+			<div class="ng-doc-modifiers-wrapper">
+				{{ modifierMacro.render("Abstract") if isAbstract }}
+				{{ modifierMacro.render("Static") if isStatic }}
+				{{ modifierMacro.render("Async") if isAsync }}
+				{{ modifierMacro.render("Readonly") if isReadonly }}
+			</div>
+		{%- endif %}
+	{%- else %}
+		{%- if isAbstract or isStatic or isAsync or isReadonly %}
+			<span class="ng-doc-tags-wrapper">
+				{{ tagMacro.render("abstract") if isAbstract }}
+				{{ tagMacro.render("static") if isStatic }}
+				{{ tagMacro.render("async") if isAsync }}
+				{{ tagMacro.render("readonly") if isReadonly }}
+			</span>
+		{%- endif %}
+	{%- endif %}
+{%- endmacro -%}

package/templates/helpers/decorators.html.nunj

@@ -0,0 +1,11 @@
+{% import "helpers/tag.html.nunj" as tagMacro %}
+
+{% macro render(decorators, column) %}
+	{% if decorators.length %}
+		<div class="ng-doc-decorators-group {{ 'column' if column }}">
+			{% for decorator in decorators %}
+				{{ tagMacro.render('@' + decorator.getName(), decorator.getName()) }}
+			{%- endfor %}
+		</div>
+	{% endif %}
+{% endmacro %}

package/templates/helpers/members.html.nunj

@@ -0,0 +1,22 @@
+{% macro render(members) %}
+	<div class="ng-doc-table-wrapper">
+		<table>
+			<thead>
+			<tr>
+				<th>Name</th>
+				<th>Value</th>
+				<th>Description</th>
+			</tr>
+			</thead>
+			<tbody>
+			{% for member in members %}
+				<tr>
+					<td>{{ member.getName() }} </td>
+					<td><code>{{ member.getValue() | dump }}</code></td>
+					<td>{{ member | extractDocs }} </td>
+				</tr>
+			{% endfor %}
+			</tbody>
+		</table>
+	</div>
+{% endmacro %}

package/templates/helpers/method.html.nunj

@@ -0,0 +1,49 @@
+{% import "helpers/code.html.nunj" as codeMacro %}
+{% import "helpers/type.html.nunj" as typeMacro %}
+{% import "helpers/declaration-modifiers.html.nunj" as tagsMacro %}
+{% import "helpers/parameters.html.nunj" as parametersMacro %}
+{% import "helpers/decorators.html.nunj" as decoratorsMacro %}
+
+{% macro render(method) %}
+	{% set parameters = method.getParameters() %}
+	<div class="ng-doc-table-wrapper">
+		<table class="ng-doc-method-table">
+			<thead>
+			<tr>
+				<th>
+					{{ decoratorsMacro.render(method.getDecorators()) if method.getDecorators }}
+					<h3>{{ method.getName() }}</h3>
+					{{ tagsMacro.render(method, 'modifier') }}
+				</th>
+			</tr>
+			</thead>
+			<tbody>
+			<tr>
+				<td>
+					{% set description = method | extractDocs %}
+
+					{{ description if description else 'No documentation has been provided.' }}
+				</td>
+			</tr>
+			<tr>
+				<td>
+					<h5 class="no-anchor">Presentation</h5>
+					{{ codeMacro.render(method | methodPresentation, "typescript", false) }}
+				</td>
+			</tr>
+			<tr>
+				<td>
+					{%- if parameters.length %}
+						<h5 class="no-anchor">Parameters</h5>
+						{{ parametersMacro.render(parameters, method) }}
+					{%- endif %}
+					<h5 class="no-anchor">Returns</h5>
+					<p>
+						{{ typeMacro.render(method.getReturnType()) }}
+					</p>
+				</td>
+			</tr>
+			</tbody>
+		</table>
+	</div>
+{% endmacro %}

package/templates/helpers/methods.html.nunj

@@ -0,0 +1,7 @@
+{% import "helpers/method.html.nunj" as method %}
+
+{% macro render(methods) %}
+{%- for m in methods %}
+{{ method.render(m) }}
+{% endfor -%}
+{% endmacro %}

package/templates/helpers/modifier.html.nunj

@@ -0,0 +1,3 @@
+{%- macro render(content, attributeOverride) -%}
+	<span class="ng-doc-modifier" data-content="{{ attributeOverride if attributeOverride else content }}">{{ content }}</span>
+{%- endmacro -%}

package/templates/helpers/parameters.html.nunj

@@ -0,0 +1,24 @@
+{% import "helpers/type.html.nunj" as typeMacro %}
+
+{% macro render(parameters, origin) %}
+	<div class="ng-doc-table-wrapper">
+		<table class="ng-doc-parameters-table">
+			<thead>
+			<tr>
+				<th class="ng-doc-parameters-table-name">Name</th>
+				<th class="ng-doc-parameters-table-type">Type</th>
+				<th class="ng-doc-parameters-table-description">Description</th>
+			</tr>
+			</thead>
+			<tbody>
+			{%- for param in parameters %}
+				<tr>
+					<td>{{ param.getName() }}</td>
+					<td>{{ typeMacro.render(param.getType()) }}</td>
+					<td>{{ origin | extractParameterDocs(param.getName()) }}</td>
+				</tr>
+			{%- endfor %}
+			</tbody>
+		</table>
+	</div>
+{% endmacro %}

package/templates/helpers/properties.html.nunj

@@ -0,0 +1,29 @@
+{% import "helpers/type.html.nunj" as typeMacro %}
+{% import "helpers/declaration-modifiers.html.nunj" as tagsMacro %}
+{% import "helpers/decorators.html.nunj" as decoratorsMacro %}
+
+{% macro render(properties) %}
+	<div class="ng-doc-table-wrapper">
+		<table class="ng-doc-properties-table">
+			<thead>
+			<tr>
+				<th class="ng-doc-properties-table-name">Name</th>
+				<th class="ng-doc-properties-table-type">Type</th>
+				<th class="ng-doc-properties-table-description">Description</th>
+			</tr>
+			</thead>
+			<tbody>
+			{%- for property in properties %}
+				<tr>
+					<td>
+						{{ decoratorsMacro.render(property.getDecorators(), true) if property.getDecorators }}
+						{{ tagsMacro.render(property, "badge") }}{{ property.getName() }}
+					</td>
+					<td>{{ typeMacro.render(property.getType()) }}</td>
+					<td>{{ property | extractDocs }}</td>
+				</tr>
+			{%- endfor %}
+			</tbody>
+		</table>
+	</div>
+{% endmacro %}

package/templates/helpers/tag.html.nunj

@@ -0,0 +1,3 @@
+{%- macro render(content, attributeOverride) -%}
+<span class="ng-doc-tag" data-content="{{ attributeOverride if attributeOverride else content }}">{{ content }}</span>
+{%- endmacro -%}

package/templates/helpers/type.html.nunj

@@ -0,0 +1,3 @@
+{% macro render(type) -%}
+<code>{{ type | displayType | escape }}</code>
+{%- endmacro %}

package/templates/index.ts.nunj

@@ -0,0 +1,3 @@
+export * from './ng-doc.context';
+export * from './ng-doc.generated.module';
+export * from './ng-doc.routing';

package/templates/ng-doc.generated.module.ts.nunj

@@ -0,0 +1,13 @@
+import {ModuleWithProviders, NgModule} from '@angular/core';
+
+import {ngDocContextProvider} from './ng-doc.context';
+
+@NgModule()
+export class NgDocGeneratedModule {
+	static forRoot(): ModuleWithProviders<NgDocGeneratedModule> {
+		return {
+			ngModule: NgDocGeneratedModule,
+			providers: [ngDocContextProvider],
+		};
+	}
+}

package/templates/page.module.ts.nunj

@@ -0,0 +1,55 @@
+// @ts-nocheck
+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 {NgDocPlayground} from '@ng-doc/builder';
+import pageContent from '!!raw-loader!{{ page.builtPagePath }}';
+{%- if page.pageDependenciesImport %}
+// noinspection ES6UnusedImports
+import pageDependencies from '{{ page.pageDependenciesImport }}';
+{%- endif %}
+{%- if page.componentsAssets %}
+// noinspection ES6UnusedImports
+import demoAssets from '{{ page.componentsAssets }}';
+{%- endif %}
+
+
+@Component({
+	template: `<ng-doc-page></ng-doc-page>`,
+	changeDetection: ChangeDetectionStrategy.OnPush,
+	providers: [{provide: NgDocRootPage, useExisting: {{ page.componentName }}}],
+})
+export class {{ page.componentName }} extends NgDocRootPage {
+	readonly pageContent: string = pageContent;
+	{%- if page.pageDependenciesFile %}
+	readonly demo: Record<string, Type<unknown>> | undefined = pageDependencies.demo;
+	readonly module: Type<unknown> | undefined = pageDependencies.module;
+	{%- endif %}
+	{%- if page.componentsAssets %}
+	readonly demoAssets: NgDocDemoAssets = demoAssets;
+	{%- endif %}
+
+	constructor() {
+		super();
+	}
+}
+
+@NgModule({
+	declarations: [{{ page.componentName }}],
+	imports: [
+		CommonModule,
+		NgDocPageModule,
+		{%- if page.pageDependenciesFile %}
+		pageDependencies.module,
+		{%- endif %}
+		RouterModule.forChild([{
+			path: '',
+			component: {{ page.componentName }},
+		}]),
+	],
+	exports: [RouterModule]
+})
+export class {{ page.moduleName }} {
+}
+