@ng-doc/builder 17.6.16 → 18.0.0-beta.2

package/scripts/restore-theme.js

@@ -0,0 +1,6 @@
+const themeId = localStorage.getItem('ng-doc-theme-id');
+
+if (themeId) {
+  const documentElement = document.documentElement;
+  documentElement.setAttribute('data-theme', themeId);
+}

package/templates/api/base.html.nunj

@@ -1,28 +1,18 @@
 {% import "helpers/declaration-modifiers.html.nunj" as tagsMacro %}
 {% import "helpers/no-content.html.nunj" as noContentMacro %}
 
-{% set description = docNode | extractDocs %}
+{% if not hideDescription %}
+    {% set description = docNode | getJsDocDescription %}
 
-<header>
-    {% include "parts/page-tags.html.nunj" %}
-    {% block modifier %}{% endblock %}
-    <h1>{{ declaration.getName() }}</h1>
-
-    {% if not description %}
-        <!-- This is a hack to make the declaration name available to the search index. -->
-        <div style="display: none">%%API_NAME_ANCHOR%%</div>
-    {% endif %}
-
-    {% block details %}{% endblock %}
-</header>
-
-<section>
     {{ description if description else noContentMacro.render('No documentation has been provided.') }}
-</section>
+{% endif %}
 
-{% include "parts/see-also.html.nunj" %}
+{% if not hideSeeAlso %}
+    {% include "parts/see-also.html.nunj" %}
+{% endif %}
 
 {% block overview %}{% endblock %}
 
-
-{% include "parts/usage-notes.html.nunj" %}
+{% if not hideUsageNotes %}
+    {% include "parts/usage-notes.html.nunj" %}
+{% endif %}

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

@@ -0,0 +1,57 @@
+{% extends "api/base.html.nunj" %}
+
+{% import "helpers/constructor.html.nunj" as constructorMacro %}
+{% import "helpers/methods.html.nunj" as methodsMacro %}
+{% import "helpers/properties.html.nunj" as propertiesMacro %}
+{% import "helpers/accessors.html.nunj" as accessorsMacro %}
+{% import "helpers/modifier.html.nunj" as modifierMacro %}
+
+{% block overview %}
+    {%- set constructors = declaration.getConstructors() | filterByScope("public") | excludeByJsDocTags('internal') -%}
+    {%- set allProperties = declaration | getClassProperties | excludeByJsDocTags('internal') | filterByScope(["public", "protected"]) | filterUselessMembers | sortByNodesName -%}
+    {%- set allMethods = declaration | getClassMethods | excludeByJsDocTags('internal') | filterByScope(["public", "protected"]) | filterUselessMembers | sortByNodesName -%}
+    {%- set allAccessors = declaration | getClassAccessors | excludeByJsDocTags('internal') | filterByScope(["public", "protected"]) | filterUselessMembers | sortByNodesName -%}
+
+    {%- set staticProperties = allProperties | filterByStatic(true) -%}
+    {%- set staticAccessors = allAccessors | filterByStatic(true) -%}
+    {%- set staticMethods = allMethods | filterByStatic(true) -%}
+    {%- set properties = allProperties | filterByStatic(false) -%}
+    {%- set accessors = allAccessors | filterByStatic(false) -%}
+    {%- set getAccessors = declaration.getGetAccessors() | filterByStatic(false) -%}
+    {%- set methods = allMethods | filterByStatic(false) -%}
+
+    {% if constructors.length -%}
+        <h2>Constructor</h2>
+        {{ constructorMacro.render(constructors[0]) }}
+    {%- endif %}
+
+    {% if staticProperties.length -%}
+        <h2>Static Properties</h2>
+        {{ propertiesMacro.render(staticProperties, declaration) }}
+    {%- endif %}
+
+    {% if properties.length -%}
+        <h2>Properties</h2>
+        {{ propertiesMacro.render(properties, declaration) }}
+    {%- endif %}
+
+    {% if staticAccessors.length -%}
+        <h2>Static Accessors</h2>
+        {{ accessorsMacro.render(staticAccessors, declaration) }}
+    {%- endif %}
+
+    {% if accessors.length -%}
+        <h2>Accessors</h2>
+        {{ accessorsMacro.render(accessors, declaration) }}
+    {%- endif %}
+
+    {% if staticMethods.length -%}
+        <h2>Static Methods</h2>
+        {{ methodsMacro.render(staticMethods, declaration) }}
+    {%- endif %}
+
+    {% if methods.length -%}
+        <h2>Methods</h2>
+        {{ methodsMacro.render(methods, declaration) }}
+    {%- endif %}
+{% endblock %}

package/templates/api/details/class-declaration.html.nunj

@@ -0,0 +1,47 @@
+{% import "helpers/type.html.nunj" as typeMacro %}
+
+{% set typeParameters %}
+    {% include "api/details/helpers/type-parameters.html.nunj" %}
+{% endset %}
+{% set hasTypeParameters = typeParameters | trim | length %}
+
+{% set decorators %}
+    {% include "api/details/helpers/decorators.html.nunj" %}
+{% endset %}
+{% set hasDecorators = decorators | trim | length %}
+
+{% set selectors %}
+    {% include "api/details/helpers/selectors.html.nunj" %}
+{% endset %}
+{% set hasSelectors = selectors | trim | length %}
+
+{% set extends = declaration.getExtends() %}
+{% set implements = declaration.getImplements() %}
+
+{% if hasTypeParameters or hasDecorators or hasSelectors or extends or implements.length %}
+    <table class="ng-doc-api-table no-padding no-full-width">
+        <tbody>
+        {{ decorators }}
+        {{ typeParameters }}
+        {{ selectors }}
+
+        {% if extends %}
+            <tr>
+                <td indexable="false">Extends:</td>
+                <td>{{ typeMacro.type(extends) }}</td>
+            </tr>
+        {%- endif %}
+
+        {% if implements.length %}
+            <tr>
+                <td indexable="false">Implements:</td>
+                <td>
+                    {%- for i in implements -%}
+                        {{ typeMacro.type(i) }}
+                    {%- endfor %}
+                </td>
+            </tr>
+        {%- endif %}
+        </tbody>
+    </table>
+{% endif %}

package/templates/api/details/function-declaration.html.nunj

@@ -0,0 +1,14 @@
+{% import "helpers/type.html.nunj" as typeMacro %}
+
+{% set typeParameters %}
+    {% include "api/details/helpers/type-parameters.html.nunj" %}
+{% endset %}
+{% set hasTypeParameters = typeParameters | trim | length %}
+
+{% if hasTypeParameters %}
+    <table class="ng-doc-api-table no-padding no-full-width">
+        <tbody>
+        {{ typeParameters }}
+        </tbody>
+    </table>
+{% endif %}

package/templates/api/details/helpers/decorators.html.nunj

@@ -0,0 +1,14 @@
+{% import "helpers/type.html.nunj" as typeMacro %}
+
+{% set decorators = declaration.getDecorators() %}
+
+{% if decorators.length %}
+    <tr>
+        <td indexable="false">Decorators:</td>
+        <td indexable="false">
+            {% for decorator in decorators %}
+                {{ typeMacro.render( '@' + decorator.getName()) }}
+            {%- endfor %}
+        </td>
+    </tr>
+{% endif %}

package/templates/api/details/helpers/extends.html.nunj

@@ -0,0 +1,6 @@
+{% if extends %}
+    <tr>
+        <td indexable="false">Extends:</td>
+        <td>{{ typeMacro.type(extends) }}</td>
+    </tr>
+{%- endif %}

package/templates/api/details/helpers/selectors.html.nunj

@@ -0,0 +1,12 @@
+{% set selectors = declaration | extractSelectors %}
+
+{% if selectors.length %}
+    <tr>
+        <td indexable="false">Selectors:</td>
+        <td>
+            {% for selector in selectors %}
+                <code>{{ selector }}</code>
+            {%- endfor %}
+        </td>
+    </tr>
+{% endif %}

package/templates/api/details/helpers/type-parameters.html.nunj

@@ -0,0 +1,14 @@
+{% import "helpers/type.html.nunj" as typeMacro %}
+
+{% set typeParameters = declaration.getTypeParameters() %}
+
+{% if typeParameters.length %}
+    <tr>
+        <td indexable="false">Generic types:</td>
+        <td>
+            {% for typeParameter in typeParameters %}
+                {{ typeMacro.type(typeParameter) }}
+            {%- endfor %}
+        </td>
+    </tr>
+{% endif %}

package/templates/api/details/interface-declaration.html.nunj

@@ -0,0 +1,27 @@
+{% import "helpers/type.html.nunj" as typeMacro %}
+
+{% set typeParameters %}
+    {% include "api/details/helpers/type-parameters.html.nunj" %}
+{% endset %}
+{% set hasTypeParameters = typeParameters | trim | length %}
+
+{% set extends = declaration.getExtends() %}
+
+{% if hasTypeParameters or extends.length %}
+    <table class="ng-doc-api-table no-padding no-full-width">
+        <tbody>
+        {{ typeParameters }}
+
+        {% if extends.length %}
+            <tr>
+                <td indexable="false">Extends:</td>
+                <td>
+                    {%- for e in extends -%}
+                        {{ typeMacro.type(e) }}
+                    {%- endfor %}
+                </td>
+            </tr>
+        {% endif %}
+        </tbody>
+    </table>
+{% endif %}

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

@@ -0,0 +1,14 @@
+{% import "helpers/type.html.nunj" as typeMacro %}
+
+{% set typeParameters %}
+    {% include "api/details/helpers/type-parameters.html.nunj" %}
+{% endset %}
+{% set hasTypeParameters = typeParameters | trim | length %}
+
+{% if hasTypeParameters %}
+    <table class="ng-doc-api-table no-padding no-full-width">
+        <tbody>
+        {{ typeParameters }}
+        </tbody>
+    </table>
+{% endif %}

package/templates/api/details.html.nunj

@@ -0,0 +1,9 @@
+{% if Node.isClassDeclaration(declaration) %}
+    {% include "api/details/class-declaration.html.nunj" %}
+{% elseif Node.isInterfaceDeclaration(declaration) %}
+    {% include "api/details/interface-declaration.html.nunj" %}
+{% elseif Node.isFunctionDeclaration(declaration) %}
+    {% include "api/details/function-declaration.html.nunj" %}
+{% elseif Node.isTypeAliasDeclaration(declaration) %}
+    {% include "api/details/type-alias-declaration.html.nunj" %}
+{% endif %}

package/templates/api/{enum.html.nunj → enum-declaration.html.nunj}

@@ -3,12 +3,10 @@
 {% import "helpers/members.html.nunj" as membersMacro %}
 
 {% block overview %}
-    {%- set members = declaration.getMembers() -%}
+    {%- set members = declaration.getMembers() | excludeByJsDocTags('internal') -%}
 
     {% if members.length -%}
-        <section>
-            <h2>Members</h2>
-            {{ membersMacro.render(members) }}
-        </section>
+        <h2>Members</h2>
+        {{ membersMacro.render(members) }}
     {%- endif %}
 {% endblock %}

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

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

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

@@ -0,0 +1,27 @@
+{% 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/accessors.html.nunj" as accessorsMacro %}
+
+{% block overview %}
+    {%- set properties = declaration | getInterfaceProperties | excludeByJsDocTags('internal') | filterUselessMembers | sortByNodesName -%}
+    {%- set methods = declaration | getInterfaceMethods | excludeByJsDocTags('internal') | filterUselessMembers | sortByNodesName -%}
+    {%- set accessors = declaration | getInterfaceAccessors | excludeByJsDocTags('internal') | filterUselessMembers | sortByNodesName -%}
+
+    {% if properties.length -%}
+        <h2>Properties</h2>
+        {{ propertiesMacro.render(properties, declaration) }}
+    {%- endif %}
+
+    {% if accessors.length -%}
+        <h2>Accessors</h2>
+        {{ accessorsMacro.render(accessors, declaration) }}
+    {%- endif %}
+
+    {% if methods.length -%}
+        <h2>Methods</h2>
+        {{ methodsMacro.render(methods, declaration) }}
+    {%- endif %}
+{% endblock %}

package/templates/api/type-alias-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 | typeAliasPresentation, "typescript", false) }}
+{% endblock %}

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 %}