@ng-doc/builder 22.0.0-beta.2 → 22.0.0

package/generator/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/generator/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/generator/templates/api/enum-declaration.html.nunj

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

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

@@ -0,0 +1,35 @@
+{% extends "api/base.html.nunj" %}
+
+{% import "helpers/code.html.nunj" as codeMacro %}
+{% import "helpers/type.html.nunj" as typeMacro %}
+{% import "helpers/parameters.html.nunj" as parametersMacro %}
+{% import "helpers/overload.html.nunj" as overloadMacro %}
+
+{% block overview %}
+    {%- set parameters = declaration.getParameters() -%}
+    {%- set overloads = declaration.getOverloads() -%}
+    {%- set returnsTag = docNode | getJsDocTag('returns') -%}
+
+    <h2>Presentation</h2>
+    {{ codeMacro.render(declaration | functionPresentation, "typescript", false) }}
+
+    <h2>Returns</h2>
+    <div class="ng-doc-returns">
+        {{ typeMacro.returnType(declaration) }}
+        {%- if returnsTag.length %}
+            <span> - </span>
+            {{ returnsTag | markdownToHtml }}
+        {%- endif %}
+    </div>
+
+    {% if parameters.length -%}
+        <h2>Parameters</h2>
+        {{ parametersMacro.render(parameters, declaration) }}
+    {%- endif %}
+
+    {% if overloads.length %}
+        <h2>Overloads</h2>
+        {{ overloadMacro.render(overloads) }}
+    {% endif %}
+
+{% endblock %}

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

@@ -0,0 +1,37 @@
+{% extends "api/base.html.nunj" %}
+
+{% import "helpers/type.html.nunj" as typeMacro %}
+{% import "helpers/methods.html.nunj" as methodsMacro %}
+{% import "helpers/call-signature.html.nunj" as callSignatureMacro %}
+{% 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 callSignatures = declaration | getInterfaceCallSignatures | excludeByJsDocTags('internal') -%}
+    {%- 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 %}
+
+  {% if callSignatures.length -%}
+    <h2>Call Signatures</h2>
+
+    {%- for c in callSignatures %}
+      {{ callSignatureMacro.render(c, declaration, "Call Signature #" + loop.index) }}
+    {% endfor -%}
+  {%- endif %}
+{% endblock %}

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

@@ -0,0 +1,16 @@
+{% extends "api/base.html.nunj" %}
+
+{% import "helpers/properties.html.nunj" as propertiesMacro %}
+{% import "helpers/code.html.nunj" as codeMacro %}
+
+{% block overview %}
+    {%- set properties = declaration | getTypeAliasProperties | excludeByJsDocTags('internal') | filterUselessMembers | sortByNodesName -%}
+
+    {% if properties.length -%}
+        <h2>Properties</h2>
+        {{ propertiesMacro.render(properties, declaration, 'definedIn') }}
+    {%- endif %}
+
+    <h2>Presentation</h2>
+    {{ codeMacro.render(declaration | typeAliasPresentation, "typescript", false) }}
+{% endblock %}

package/generator/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/generator/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/generator/templates/api-list.ts.nunj

@@ -0,0 +1,22 @@
+// @ts-nocheck
+import {ChangeDetectionStrategy, Component} from "@angular/core";
+import {Routes} from "@angular/router";
+import {NgDocApiListComponent} from '@ng-doc/app';
+
+@Component({
+  selector: 'ng-doc-api-list-page-{{ id }}',
+  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,
+  },
+]
+
+export default routes;

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

@@ -0,0 +1 @@
+{% include "api/" + templateName + ".html.nunj" %}

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

@@ -0,0 +1,22 @@
+// @ts-nocheck
+import {Routes} from "@angular/router";
+
+const routes: Routes = [
+    {%- if scope.builtChildren.length %}
+    {path: '', redirectTo: '{{ scope.builtChildren[0].route }}', pathMatch: 'full'},
+    {%- endif %}
+    {
+        path: '',
+        title: '{{ scope.title }}',
+        children: [
+            {%- for page in scope.builtChildren %}
+            {
+                path: '{{ page.route }}',
+                loadChildren: () => import('./{{ outFolder | createImportPath(page.moduleImport) }}')
+            },
+            {%- endfor %}
+        ]
+    }
+]
+
+export default routes;

package/generator/templates/category.ts.nunj

@@ -0,0 +1,22 @@
+// @ts-nocheck
+import {Routes} from "@angular/router";
+
+const routes: Routes = [
+    {%- if category.builtChildren.length %}
+    {path: '', redirectTo: '{{ category.builtChildren[0].route }}', pathMatch: 'full'},
+    {%- endif %}
+    {
+        path: '',
+        title: `{{ category.title | toTemplateString }}`,
+        children: [
+            {%- for child in category.builtChildren %}
+            {
+                path: '{{ child.route }}',
+                loadChildren: () => import('./{{ outFolder | createImportPath(child.moduleImport) }}')
+            },
+            {%- endfor %}
+        ]
+    }
+]
+
+export default routes;

package/generator/templates/code.html.nunj

@@ -0,0 +1,3 @@
+{% import "helpers/code.html.nunj" as codeMacro -%}
+
+{{ codeMacro.render(code, lang) }}

package/generator/templates/context.ts.nunj

@@ -0,0 +1,55 @@
+// @ts-nocheck
+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(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 %}
+      ],
+      {%- if apiLists is defined %}
+      apiLists: {{ apiLists | dump }},
+      {%- endif %}
+    },
+  }, {
+    provide: NG_DOC_ROUTE_PREFIX,
+    useValue: '{{ routePrefix }}',
+  }, {
+    provide: NG_DOC_SHIKI_THEME,
+    useValue: {
+      light: '{{ shikiThemeLight }}',
+      dark: '{{ shikiThemeDark }}',
+    },
+  }];
+}

package/generator/templates/demo-assets.ts.nunj

@@ -0,0 +1,25 @@
+// @ts-nocheck
+import {NgDocDemoAssets} from '@ng-doc/app';
+
+export const demoAssets: NgDocDemoAssets = {
+{%- for demoName, assets in demoAssets %}
+{{ demoName }}: [
+    {%- for asset in assets %}
+    {%- if not asset.isEmpty %}
+    {
+        title: '{{ asset.title }}',
+        code: `{{ asset.code | toTemplateString }}`,
+        {%- if asset.icon %}
+        icon: '{{ asset.icon }}',
+        {%- endif %}
+        {%- if asset.opened %}
+        opened: true,
+        {%- endif %}
+    },
+    {%- endif %}
+    {%- endfor %}
+],
+{%- endfor %}
+}
+
+export default demoAssets;

package/generator/templates/helpers/accessor.html.nunj

@@ -0,0 +1,76 @@
+{% 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 %}
+{% 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) %}
+        {% set parameters = accessor.getParameters() %}
+        {% set accessorChain = accessor | getAccessorChain %}
+        {% set inheritedFrom = accessor | getInheritedParent(origin) %}
+        {% set overriddenMember = accessor | getOverriddenMember %}
+        {% set implementedMember = accessor | getImplementedMember %}
+        {% set docNode = accessorChain | firstNodeWithComment %}
+
+        <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>
+
+                    {% set description = docNode | getJsDocDescription %}
+
+                    {{ description if description else noContentMacro.render('No documentation has been provided.') }}
+
+                    {% include "parts/member-remarks.html.nunj" %}
+                </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 %}
+
+
+    {{ renderAccessor(accessor.get, "get", origin) if accessor.get }}
+    {{ renderAccessor(accessor.set, "set", origin) if accessor.set }}
+{% endmacro %}

package/generator/templates/helpers/accessors.html.nunj

@@ -0,0 +1,7 @@
+{% import "helpers/accessor.html.nunj" as accessor %}
+
+{% macro render(accessors, originalParent) %}
+    {%- for a in accessors | groupAccessors %}
+        {{ accessor.render(a, originalParent) }}
+    {% endfor -%}
+{% endmacro %}

package/generator/templates/helpers/badge.html.nunj

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

package/generator/templates/helpers/call-signature.html.nunj

@@ -0,0 +1,70 @@
+{% 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/no-content.html.nunj" as noContentMacro %}
+{% import "helpers/status.html.nunj" as statusMacro %}
+
+{% macro render(callSignature, origin, name) %}
+  {% set parameters = callSignature.getParameters() %}
+  {% set callSignatureChain = callSignature | getCallSignatureChain %}
+  {% set inheritedFrom = callSignature | getInheritedParent(origin) %}
+  {% set docNode = callSignatureChain | firstNodeWithComment %}
+  {% set overloads = callSignature.getOverloads() if callSignature.getOverloads else [] %}
+  {% set returnsTag = docNode | getJsDocTag('returns') %}
+
+  <table class="{{ statusMacro.class(callSignature) }}">
+    <thead>
+    <tr>
+      <th indexable="false">
+        <h3 dataSlugType="member">{{ name }}</h3>
+        <div class="ng-doc-node-details">
+          {%- if inheritedFrom %}
+            inherited from <code>{{ inheritedFrom.getName() }}</code>
+          {%- endif %}
+        </div>
+      </th>
+    </tr>
+    </thead>
+    <tbody>
+    <tr>
+      <td>
+        <div class="ng-doc-api-status">
+          {{ statusMacro.render(callSignature) }}
+        </div>
+
+        {% set description = docNode | getJsDocDescription %}
+
+        {{ description if description else noContentMacro.render('No documentation has been provided.') }}
+
+        {% include "parts/member-remarks.html.nunj" %}
+      </td>
+    </tr>
+    <tr>
+      <td>
+        <h5 class="no-anchor ng-doc-secondary-heading" indexable="false">Presentation</h5>
+        {{ codeMacro.render(callSignature | callSignaturePresentation, "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>
+
+        <div class="ng-doc-returns">
+          {{ typeMacro.returnType(callSignature) }}
+          {%- if returnsTag.length %}
+            <span> - </span>
+            {{ returnsTag | markdownToHtml }}
+          {%- endif %}
+        </div>
+      </td>
+    </tr>
+
+    {% include "parts/member-examples.html.nunj" %}
+    </tbody>
+  </table>
+{% endmacro %}

package/generator/templates/helpers/code.html.nunj

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

package/generator/templates/helpers/constructor.html.nunj

@@ -0,0 +1,32 @@
+{% import "helpers/code.html.nunj" as codeMacro %}
+{% import "helpers/parameters.html.nunj" as parametersMacro %}
+{% import "helpers/no-content.html.nunj" as noContentMacro %}
+
+{% macro render(constructor) %}
+    {% set parameters = constructor.getParameters() %}
+    <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>
+{% endmacro %}

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

@@ -0,0 +1,45 @@
+{% 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() %}
+    {% 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 or isProtected %}
+            <span class="ng-doc-badge-wrapper" ngDocTooltip="{{ tooltip }}" indexable="false">
+				{{ badgeMacro.render("protected") if isProtected }}
+                {{ 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 or isProtected %}
+            <div class="ng-doc-modifiers-wrapper" indexable="false">
+                {{ modifierMacro.render("protected") if isProtected }}
+                {{ 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 or isProtected %}
+            <span class="ng-doc-tags-wrapper" indexable="false">
+				{{ tagMacro.render("protected") if isProtected }}
+                {{ 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/generator/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 }}" indexable="false">
+            {% for decorator in decorators %}
+                <code>{{ '@' + decorator.getName() | escape }}</code>
+            {%- endfor %}
+        </div>
+    {% endif %}
+{% endmacro %}

package/generator/templates/helpers/members.html.nunj

@@ -0,0 +1,29 @@
+{% import "helpers/status.html.nunj" as statusMacro %}
+
+{% macro render(members) %}
+    <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>
+        {% endfor %}
+        </tbody>
+    </table>
+{% endmacro %}