@ng-doc/builder 17.6.15 → 18.0.0-beta.1

package/templates/api/variable-declaration.html.nunj

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

package/templates/api-header.html.nunj

@@ -0,0 +1,11 @@
+{% import "helpers/status.html.nunj" as statusMacro %}
+
+{% include "parts/page-tags.html.nunj" %}
+
+<h1 class="{{ statusMacro.class(docNode) }}">
+    {{ declaration.getName() }}
+</h1>
+
+{{ statusMacro.render(docNode) }}
+
+{% include "api/details.html.nunj" %}

package/templates/api-list.ts.nunj

@@ -1,34 +1,23 @@
 // @ts-nocheck
 import {ChangeDetectionStrategy, Component} from "@angular/core";
 import {Routes} from "@angular/router";
-import {NG_DOC_API_LIST_TOKEN, NgDocApiListComponent} from '@ng-doc/app';
-import apiList from './ng-doc.api-list.json';
+import {NgDocApiListComponent} from '@ng-doc/app';
 
 @Component({
-    selector: 'ng-doc-api-list-page-{{ api.route | kebabCase }}',
-    standalone: true,
-    template: `<ng-doc-api-list title="{{ api.title }}"></ng-doc-api-list>`,
-    imports: [NgDocApiListComponent],
-    providers: [{
-        provide: NG_DOC_API_LIST_TOKEN,
-        useValue: apiList
-    }],
-    changeDetection: ChangeDetectionStrategy.OnPush,
+  selector: 'ng-doc-api-list-page-{{ id }}',
+  standalone: true,
+  template: `<ng-doc-api-list title="{{ title }}" segment="{{ segment }}"></ng-doc-api-list>`,
+  imports: [NgDocApiListComponent],
+  changeDetection: ChangeDetectionStrategy.OnPush,
 })
 export class DynamicComponent {
 }
 
 const routes: Routes = [
-    {
-        path: '',
-        component: DynamicComponent,
-    },
-    {%- for scope in api.builtChildren %}
-    {
-        path: '{{ scope.route }}',
-        loadChildren: () => import('./{{ outFolder | createImportPath(scope.moduleImport) }}')
-    },
-    {%- endfor %}
+  {
+    path: '',
+    component: DynamicComponent,
+  },
 ]
 
 export default routes;

package/templates/api-page-content.html.nunj

@@ -1,15 +1 @@
-{% 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 -%}
+{% include "api/" + templateName + ".html.nunj" %}

package/templates/context.ts.nunj

@@ -1,37 +1,52 @@
 // @ts-nocheck
-import {Provider} from '@angular/core';
-import {NG_DOC_CONTEXT} from '@ng-doc/app/tokens';
+import { Provider } from '@angular/core';
+import { NG_DOC_CONTEXT, NG_DOC_ROUTE_PREFIX, NG_DOC_SHIKI_THEME } from '@ng-doc/app/tokens';
 
-export function provideNgDocContext(): Provider {
-    return {
-        provide: NG_DOC_CONTEXT,
-        useValue: {
-            navigation: [
-                {%- macro nav(entity) %}
-                {
-                    title: `{{ entity.title | toTemplateString }}`,
-                    route: '{{ entity.fullRoute }}',
-                    {%- if entity.isCategory %}
-                    expandable: {{ entity.expandable }},
-                    expanded: {{ entity.expanded }},
-                    {%- endif %}
-                    {%- if entity.order %}
-                    order: {{ entity.order }},
-										{%- endif %}
-                    hidden: {{ "true" if entity.target.hidden else "false" }},
-                    {%- if entity.isCategory %}
-                    children: [
-                        {%- for child in entity.navigationItems | sortNavigationEntities %}
-                        {{ nav(child) }},
-                        {%- endfor %}
-                    ]
-                    {%- endif %}
-                }
-                {%- endmacro %}
-                {%- for entity in entities | sortNavigationEntities %}
-                {{ nav(entity) }},
-                {%- endfor %}
-            ],
+export function provideNgDocContext(): Provider[] {
+  return [{
+    provide: NG_DOC_CONTEXT,
+    useValue: {
+      navigation: [
+          {%- macro nav(entry) %}
+        {
+          title: `{{ entry.item.entry.title | toTemplateString }}`,
+          route: '/{{ entry.item.absoluteRoute() }}',
+            {%- if entry.children.length %}
+          expandable: {{ entry.item.entry.expandable | default("true") }},
+          expanded: {{ entry.item.entry.expanded | default("false") }},
+            {%- endif %}
+            {%- if entry.item.order %}
+          order: {{ entry.item.order }},
+            {%- endif %}
+          hidden: {{ entry.item.entry.hidden | default("false") }},
+          metadata: {{ entry.item.jsDocMetadata() | dump }},
+            {%- if entry.children.length %}
+          children: [
+              {%- for child in entry.children | sortNavigationEntries %}
+              {%- if not child.item.hidden %}
+              {{ nav(child) }},
+              {%- endif %}
+              {%- endfor %}
+          ]
+            {%- endif %}
         }
-    };
+          {%- endmacro %}
+
+          {%- for entry in entries | sortNavigationEntries %}
+          {%- if not entry.item.hidden %}
+          {{ nav(entry) }},
+          {%- endif %}
+          {%- endfor %}
+      ],
+    },
+  }, {
+    provide: NG_DOC_ROUTE_PREFIX,
+    useValue: '{{ routePrefix }}',
+  }, {
+    provide: NG_DOC_SHIKI_THEME,
+    useValue: {
+      light: '{{ shikiThemeLight }}',
+      dark: '{{ shikiThemeDark }}',
+    },
+  }];
 }

package/templates/helpers/accessor.html.nunj

@@ -5,6 +5,7 @@
 {% import "helpers/decorators.html.nunj" as decoratorsMacro %}
 {% import "helpers/no-content.html.nunj" as noContentMacro %}
 {% import "helpers/modifier.html.nunj" as modifierMacro %}
+{% import "helpers/status.html.nunj" as statusMacro %}
 
 {% macro render(accessor, origin) %}
     {% macro renderAccessor(accessor, type, origin) %}
@@ -15,54 +16,56 @@
         {% set implementedMember = accessor | getImplementedMember %}
         {% set docNode = accessorChain | firstNodeWithComment %}
 
-        <div class="ng-doc-table-wrapper">
-            <table class="ng-doc-accessor-table">
-                <thead>
-                <tr>
-                    <th indexable="false">
-                        {{ decoratorsMacro.render(accessor.getDecorators()) if accessor.getDecorators }}
-                        {{ tagsMacro.render(accessor, 'modifier') }}
-                        <h3 dataSlug="{{ type + '-' + accessor.getName() }}" dataSlugType="member"
-                            dataSlugTitle="{{ accessor.getName() }}">
-                            {{ modifierMacro.render(type) }} {{ accessor.getName() }}
-                        </h3>
-                        <div class="ng-doc-node-details">
-                            {%- if inheritedFrom %}
-                                inherited from <code>{{ inheritedFrom.getName() }}</code>
-                            {%- elseif overriddenMember %}
-                                overrides <code>{{ overriddenMember.getParent().getName() }}</code>
-                            {%- elseif implementedMember %}
-                                implements <code>{{ implementedMember.getParent().getName() }}</code>
-                            {%- endif %}
-                        </div>
-                    </th>
-                </tr>
-                </thead>
-                <tbody>
-                <tr>
-                    <td>
-                        {% set description = docNode | extractDocs %}
+        <table class="{{ statusMacro.class(accessor) }}">
+            <thead>
+            <tr>
+                <th indexable="false">
+                    {{ decoratorsMacro.render(accessor.getDecorators()) if accessor.getDecorators }}
+                    {{ tagsMacro.render(accessor, 'modifier') }}
+                    <h3 dataSlug="{{ type + '-' + accessor.getName() }}" dataSlugType="member"
+                        dataSlugTitle="{{ accessor.getName() }}">
+                        {{ modifierMacro.render(type) }} {{ accessor.getName() }}
+                    </h3>
+                    <div class="ng-doc-node-details">
+                        {%- if inheritedFrom %}
+                            inherited from <code>{{ inheritedFrom.getName() }}</code>
+                        {%- elseif overriddenMember %}
+                            overrides <code>{{ overriddenMember.getParent().getName() }}</code>
+                        {%- elseif implementedMember %}
+                            implements <code>{{ implementedMember.getParent().getName() }}</code>
+                        {%- endif %}
+                    </div>
+                </th>
+            </tr>
+            </thead>
+            <tbody>
+            <tr>
+                <td>
+                    <div class="ng-doc-api-status">
+                        {{ statusMacro.render(accessor) }}
+                    </div>
 
-                        {{ description if description else noContentMacro.render('No documentation has been provided.') }}
-                    </td>
-                </tr>
-                <tr>
-                    <td indexable="false">
-                        <h5 class="no-anchor">Presentation</h5>
-                        {{ codeMacro.render(accessor | accessorPresentation, "typescript", false) }}
-                    </td>
-                </tr>
-                <tr>
-                    <td indexable="false">
-                        <h5 class="no-anchor">Type</h5>
-                        <p>
-                            {{ typeMacro.type(accessor) }}
-                        </p>
-                    </td>
-                </tr>
-                </tbody>
-            </table>
-        </div>
+                    {% set description = docNode | getJsDocDescription %}
+
+                    {{ description if description else noContentMacro.render('No documentation has been provided.') }}
+                </td>
+            </tr>
+            <tr>
+                <td indexable="false">
+                    <h5 class="no-anchor ng-doc-secondary-heading">Presentation</h5>
+                    {{ codeMacro.render(accessor | accessorPresentation, "typescript", false) }}
+                </td>
+            </tr>
+            <tr>
+                <td indexable="false">
+                    <h5 class="no-anchor ng-doc-secondary-heading">Type</h5>
+                    <p>
+                        {{ typeMacro.type(accessor) }}
+                    </p>
+                </td>
+            </tr>
+            </tbody>
+        </table>
     {% endmacro %}
 
 

package/templates/helpers/code.html.nunj

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

package/templates/helpers/constructor.html.nunj

@@ -4,31 +4,29 @@
 
 {% macro render(constructor) %}
     {% set parameters = constructor.getParameters() %}
-    <div class="ng-doc-table-wrapper">
-        <table class="ng-doc-method-table">
-            <tbody>
-            <tr>
-                <td>
-                    {% set description = constructor | extractDocs %}
+    <table>
+        <tbody>
+        <tr>
+            <td>
+                {% set description = constructor | getJsDocDescription %}
 
-                    {{ description if description else noContentMacro.render('No documentation has been provided.') }}
-                </td>
-            </tr>
-            <tr>
-                <td>
-                    <h5 class="no-anchor" indexable="false">Presentation</h5>
-                    {{ codeMacro.render(constructor | constructorPresentation, "typescript", false) }}
-                </td>
-            </tr>
-            <tr>
-                <td>
-                    {%- if parameters.length %}
-                        <h5 class="no-anchor" indexable="false">Parameters</h5>
-                        {{ parametersMacro.render(parameters, constructor, true) }}
-                    {%- endif %}
-                </td>
-            </tr>
-            </tbody>
-        </table>
-    </div>
+                {{ description if description else noContentMacro.render('No documentation has been provided.') }}
+            </td>
+        </tr>
+        <tr>
+            <td>
+                <h5 class="no-anchor" indexable="false">Presentation</h5>
+                {{ codeMacro.render(constructor | constructorPresentation, "typescript", false) }}
+            </td>
+        </tr>
+        <tr>
+            <td>
+                {%- if parameters.length %}
+                    <h5 class="no-anchor" indexable="false">Parameters</h5>
+                    {{ parametersMacro.render(parameters, constructor, true) }}
+                {%- endif %}
+            </td>
+        </tr>
+        </tbody>
+    </table>
 {% endmacro %}

package/templates/helpers/members.html.nunj

@@ -1,23 +1,29 @@
+{% import "helpers/status.html.nunj" as statusMacro %}
+
 {% macro render(members) %}
-    <div class="ng-doc-table-wrapper">
-        <table>
-            <thead>
-            <tr indexable="false">
-                <th>Name</th>
-                <th>Value</th>
-                <th>Description</th>
+    <table class="ng-doc-api-table sticky first-colum-highlighted">
+        <thead>
+        <tr indexable="false">
+            <th>Name</th>
+            <th>Value</th>
+            <th style="min-width: 300px;">Description</th>
+        </tr>
+        </thead>
+        <tbody>
+        {% for member in members %}
+            <tr class="{{ statusMacro.class(member) }}">
+                <td indexable="false" dataSlug="{{ member.getName() }}"
+                    dataSlugType="member">{{ member.getName() }} </td>
+                <td indexable="false"><code>{{ member.getValue() | dump }}</code></td>
+                <td>
+                    <div class="ng-doc-api-status">
+                        {{ statusMacro.render(member) }}
+                    </div>
+
+                    {{ member | getJsDocDescription }}
+                </td>
             </tr>
-            </thead>
-            <tbody>
-            {% for member in members %}
-                <tr>
-                    <td indexable="false" dataSlug="{{ member.getName() }}"
-                        dataSlugType="member">{{ member.getName() }} </td>
-                    <td indexable="false"><code>{{ member.getValue() | dump }}</code></td>
-                    <td>{{ member | extractDocs }} </td>
-                </tr>
-            {% endfor %}
-            </tbody>
-        </table>
-    </div>
+        {% endfor %}
+        </tbody>
+    </table>
 {% endmacro %}

package/templates/helpers/method.html.nunj

@@ -4,6 +4,8 @@
 {% import "helpers/parameters.html.nunj" as parametersMacro %}
 {% import "helpers/decorators.html.nunj" as decoratorsMacro %}
 {% import "helpers/no-content.html.nunj" as noContentMacro %}
+{% import "helpers/overload.html.nunj" as overloadMacro %}
+{% import "helpers/status.html.nunj" as statusMacro %}
 
 {% macro render(method, origin) %}
     {% set parameters = method.getParameters() %}
@@ -12,54 +14,66 @@
     {% set overriddenMember = method | getOverriddenMember %}
     {% set implementedMember = method | getImplementedMember %}
     {% set docNode = methodChain | firstNodeWithComment %}
+    {% set overloads = method.getOverloads() if method.getOverloads else [] %}
 
-    <div class="ng-doc-table-wrapper">
-        <table class="ng-doc-method-table">
-            <thead>
-            <tr>
-                <th indexable="false">
-                    {{ decoratorsMacro.render(method.getDecorators()) if method.getDecorators }}
-                    {{ tagsMacro.render(method, 'modifier') }}
-                    <h3 dataSlugType="member">{{ method.getName() }}()</h3>
-                    <div class="ng-doc-node-details">
-                        {%- if inheritedFrom %}
-                            inherited from <code>{{ inheritedFrom.getName() }}</code>
-                        {%- elseif overriddenMember %}
-                            overrides <code>{{ (overriddenMember | getMemberParent).getName() }}</code>
-                        {%- elseif implementedMember %}
-                            implements <code>{{ (implementedMember | getMemberParent).getName() }}</code>
-                        {%- endif %}
-                    </div>
-                </th>
-            </tr>
-            </thead>
-            <tbody>
-            <tr>
-                <td>
-                    {% set description = docNode | extractDocs %}
+    <table class="{{ statusMacro.class(method) }}">
+        <thead>
+        <tr>
+            <th indexable="false">
+                {{ decoratorsMacro.render(method.getDecorators()) if method.getDecorators }}
+                {{ tagsMacro.render(method, 'modifier') }}
+                <h3 dataSlugType="member">{{ method.getName() }}()</h3>
+                <div class="ng-doc-node-details">
+                    {%- if inheritedFrom %}
+                        inherited from <code>{{ inheritedFrom.getName() }}</code>
+                    {%- elseif overriddenMember %}
+                        overrides <code>{{ (overriddenMember | getMemberParent).getName() }}</code>
+                    {%- elseif implementedMember %}
+                        implements
+                        <code>{{ (implementedMember | getMemberParent).getName() }}</code>
+                    {%- endif %}
+                </div>
+            </th>
+        </tr>
+        </thead>
+        <tbody>
+        <tr>
+            <td>
+                <div class="ng-doc-api-status">
+                    {{ statusMacro.render(method) }}
+                </div>
 
-                    {{ description if description else noContentMacro.render('No documentation has been provided.') }}
-                </td>
-            </tr>
-            <tr>
-                <td>
-                    <h5 class="no-anchor" indexable="false">Presentation</h5>
-                    {{ codeMacro.render(method | methodPresentation, "typescript", false) }}
-                </td>
-            </tr>
+                {% set description = docNode | getJsDocDescription %}
+
+                {{ description if description else noContentMacro.render('No documentation has been provided.') }}
+            </td>
+        </tr>
+        <tr>
+            <td>
+                <h5 class="no-anchor ng-doc-secondary-heading" indexable="false">Presentation</h5>
+                {{ codeMacro.render(method | methodPresentation, "typescript", false) }}
+            </td>
+        </tr>
+        <tr>
+            <td>
+                {%- if parameters.length %}
+                    <h5 class="no-anchor ng-doc-secondary-heading" indexable="false">Parameters</h5>
+                    {{ parametersMacro.render(parameters, docNode) }}
+                {%- endif %}
+                <h5 class="no-anchor ng-doc-secondary-heading" indexable="false">Returns</h5>
+                <p>
+                    {{ typeMacro.returnType(method) }}
+                </p>
+            </td>
+        </tr>
+
+        {% if overloads.length %}
             <tr>
                 <td>
-                    {%- if parameters.length %}
-                        <h5 class="no-anchor" indexable="false">Parameters</h5>
-                        {{ parametersMacro.render(parameters, docNode) }}
-                    {%- endif %}
-                    <h5 class="no-anchor" indexable="false">Returns</h5>
-                    <p>
-                        {{ typeMacro.returnType(method) }}
-                    </p>
+                    {{ overloadMacro.render(overloads) }}
                 </td>
             </tr>
-            </tbody>
-        </table>
-    </div>
+        {% endif %}
+        </tbody>
+    </table>
 {% endmacro %}

package/templates/helpers/no-content.html.nunj

@@ -1,3 +1,3 @@
 {%- macro render(content) -%}
-    <span class="ng-doc-no-content" indexable="false">{{ content }}</span>
+    <p class="ng-doc-no-content" indexable="false">{{ content }}</p>
 {%- endmacro -%}

package/templates/helpers/overload.html.nunj

@@ -0,0 +1,47 @@
+{% import "helpers/no-content.html.nunj" as noContentMacro %}
+{% import "helpers/parameters.html.nunj" as parametersMacro %}
+{% import "helpers/type.html.nunj" as typeMacro %}
+{% import "helpers/code.html.nunj" as codeMacro %}
+
+{% macro render(overloads) %}
+    {% for overload in overloads %}
+        {% set docNode = overload %}
+        {% set parameters = overload.getParameters() %}
+
+        <table class="ng-doc-overload-table">
+            <thead indexable="false">
+            <tr>
+                <th>Overload #{{ loop.index }}</th>
+            </tr>
+            </thead>
+            <tbody>
+            <tr>
+                <td>
+                    {% set description = docNode | getJsDocDescription %}
+
+                    {{ description if description else noContentMacro.render('No documentation has been provided.') }}
+                </td>
+            </tr>
+            <tr>
+                <td>
+                    <h5 class="no-anchor" indexable="false">Presentation</h5>
+                    {{ codeMacro.render(overload | methodPresentation, "typescript", false) }}
+                </td>
+            </tr>
+            <tr>
+                <td>
+                    {%- if parameters.length %}
+                        <h5 class="no-anchor" indexable="false">Parameters</h5>
+                        {{ parametersMacro.render(parameters, docNode) }}
+                    {%- endif %}
+                    <h5 class="no-anchor" indexable="false">Returns</h5>
+                    <p>
+                        {{ typeMacro.returnType(overload) }}
+                    </p>
+                </td>
+            </tr>
+            </tbody>
+        </table>
+    {% endfor %}
+{% endmacro %}
+