Deploy preview for PR 326 🛫

Author: cwolf10

pr-preview/pr-326/35.c7d20d6b8b8df622.js

@@ -0,0 +1,90 @@
+import { Component, OnInit } from '@angular/core';
+import { BaseExampleComponent } from './baseexample.component';
+import { HttpClient } from '@angular/common/http';
+import { MarkdownService } from 'app/services/markdown/markdown.service';
+import { DocumentationService } from 'app/services/documentation.service';
+import { ActivatedRoute } from '@angular/router';
+import { environment } from 'environment';
+
+@Component({
+  selector: 'doc-base-page',
+  template: `
+<doc-template-next
+    [markdown]="markdown"
+    [codeExample]="codeExample"
+    [example]="example"
+    [design]="design"
+    [guidance]="guidance"
+    [implementation]="implementation"
+    [typedoc]="typedoc_content">
+  <router-outlet></router-outlet>
+</doc-template-next>`,
+})
+export class BaseDocPageComponent extends BaseExampleComponent implements OnInit {
+    implementation;
+    ngOnInit() {
+        const ctx = this;
+        // console.log(this.route.snapshot.data.sections);
+        this.typedoc_target = this.route.snapshot.data.componentName;
+        if (this.typedoc_target) {
+            this.service.getComponentProperties(this.typedoc_target)
+            .subscribe(
+                (data) => { this.setupTypedocContent(data); },
+                (error) => { throw new Error(error); }
+            );
+        }
+
+        // todo: see if we can find out if we should make the call or not
+        if (this.route.snapshot.data.sections.indexOf('component-example.html') !== -1) {
+            this._http.get(this.getAssetURI('/component-example.html'), { responseType: 'text' as 'json'})
+                .subscribe((res: any) => {
+                    // console.log(res.text());
+                    ctx.example = res;
+                });
+        }
+        if (this.route.snapshot.data.sections.indexOf('component-example.ts') !== -1) {
+            this._http.get(this.getAssetURI('component-example.ts'), { responseType: 'text' as 'json'}).subscribe((res: any) => {
+                // console.log(res.text());
+                ctx.codeExample = res;
+            });
+        }
+        if (this.route.snapshot.data.sections.indexOf('documentation.md') !== -1) {
+            this._http.get(this.getAssetURI('documentation.md'), { responseType: 'text' as 'json'}).subscribe((res: any) => {
+                // console.log(res.text());
+                ctx.markdown = res;
+            });
+        }
+        if (this.route.snapshot.data.sections.indexOf('design.md') !== -1) {
+            this._http.get(this.getAssetURI('design.md'), { responseType: 'text' as 'json'}).subscribe((res: any) => {
+                // console.log(res.text());
+                ctx.design = res;
+            });
+        }
+        if (this.route.snapshot.data.sections.indexOf('guidance.md') !== -1) {
+            this._http.get(this.getAssetURI('guidance.md'), { responseType: 'text' as 'json'}).subscribe((res: any) => {
+                // console.log(res.text());
+                ctx.guidance = res;
+            });
+        }
+        if (this.route.snapshot.data.sections.indexOf('implementation.md') !== -1) {
+            this._http.get(this.getAssetURI('implementation.md'), { responseType: 'text' as 'json'}).subscribe((res: any) => {
+                // console.log(res.text());
+                ctx.implementation = res;
+            });
+        }
+    }
+
+    constructor(
+        public _http: HttpClient,
+        public service: DocumentationService,
+        public mdService: MarkdownService,
+        public route: ActivatedRoute) {
+
+        super(_http, service, mdService);
+    }
+
+    public getAssetURI (file: string): string {
+      return `./${this.route.snapshot.data.path}/${file}`;
+    }
+
+}

pr-preview/pr-326/3rdpartylicenses.txt

@@ -0,0 +1,103 @@
+import {
+  Component,
+  OnInit,
+} from '@angular/core';
+import { HttpClient } from '@angular/common/http';
+
+import { DocumentationService } from '../app/services/documentation.service';
+import { MarkdownService } from '../app/services/markdown/markdown.service';
+
+@Component({
+  selector: 'doc-base-example',
+  template: `<h1>overwrite me</h1>`
+})
+export class BaseExampleComponent implements OnInit {
+  public typedoc_target: string = '';
+  public typedoc_content: string = '';
+  public markdown: string = '';
+  public guidance: string = '';
+  public example: string = '';
+  public codeExample: string = '';
+  public design: string = '';
+
+  public sections = [
+    'markdown',
+    'design',
+    'guidance',
+    'implementation'
+  ];
+
+  public base;
+
+  constructor(
+    public http: HttpClient,
+    public service: DocumentationService,
+    public mdService: MarkdownService) {}
+
+  public ngOnInit(): void {
+    this.service.getComponentProperties(this.typedoc_target)
+    .subscribe(
+      (data) => { this.setupTypedocContent(data); },
+      (error) => { throw new Error(error); }
+    );
+  }
+
+  public setupTypedocContent(obj: any): void {
+    if (!obj || obj.length === 0) {
+      return;
+    }
+    this.typedoc_content += `
+      <h2 class="sam heading">API Reference</h2>
+      <table class="sam-ui definition celled table">
+      <thead>
+        <tr>
+          <th>Name</th>
+          <th>Type</th>
+          <th>Comment</th>
+        </tr>
+      </thead>`;
+    obj.forEach((item) => {
+      const comment = item['comment'] && item['comment']['shortText'] ? item.comment.shortText : '';
+      const type = item['type'] && item['type']['name'] ? item.type.name : '';
+      let deprecated;
+      if (item.comment && item.comment.tags) {
+        const depItems = item.comment.tags.filter(
+          tag => tag.tag === 'deprecated'
+        );
+        deprecated = depItems.length > 0 ? true : false;
+      }
+      this.typedoc_content += `
+        <tr>
+          <td>
+          ${deprecated
+            ? '<em><i class="fa fa-thumbs-down"></i>&nbsp;Deprecated</em><br>'
+            : ''}
+          @${item.decorators[0].name}( ) ${item.name}
+        </td>
+          <td>${type}</td>
+          <td>${comment}</td>
+        </tr>
+      `;
+    });
+    this.typedoc_content += '</tbody></table>';
+  }
+
+  public fetchSection (section: string) {
+
+    const fileName = section === 'markdown'
+      ? 'documentation'
+      : section;
+
+    return this.mdService
+      .get(`${this.base}${fileName}.md`)
+      .subscribe(
+        (data: any) => {
+          this[section] = data.text();
+        },
+        (err) => {
+          this[section] = '';
+        }
+      );
+  }
+
+}

pr-preview/pr-326/581.debff4a02681a413.js

@@ -0,0 +1,64 @@
+import { NO_ERRORS_SCHEMA } from '@angular/core';
+import {
+  inject,
+  async,
+  TestBed,
+  ComponentFixture
+} from '@angular/core/testing';
+import {RouterTestingModule} from '@angular/router/testing';
+import { HttpClientModule } from '@angular/common/http';
+// Load the implementations that should be tested
+import { BaseExampleComponent } from './baseexample.component';
+import { MarkdownService } from '../app/services/markdown/markdown.service';
+import { DocumentationService } from '../app/services/documentation.service';
+import { Router, ActivatedRoute, NavigationEnd } from '@angular/router';
+import { Observable } from 'rxjs';
+
+describe(`BaseExampleComponent tests`, () => {
+  let comp: BaseExampleComponent;
+  let fixture: ComponentFixture<BaseExampleComponent>;
+
+  beforeEach(() => {
+    TestBed.configureTestingModule({
+      imports: [RouterTestingModule, HttpClientModule],
+      declarations: [ BaseExampleComponent ],
+      providers: [
+        { 
+          provide: MarkdownService,
+          useValue: {
+            get: function(filename){
+              return Observable.of({});
+            }
+          }
+        },
+        { 
+          provide: DocumentationService,
+          useValue: {
+            loadData: function(){
+              return Observable.of({});
+            },
+            getComponentProperties: function(name){
+              return Observable.of([]); 
+            }
+          }
+        },
+        {
+            provide: ActivatedRoute, useValue: {
+            data: Observable.create({ markdownfile: 'test' })
+            }
+        }
+      ],
+      schemas: [NO_ERRORS_SCHEMA]
+    });
+    fixture = TestBed.createComponent(BaseExampleComponent);
+    comp    = fixture.componentInstance;
+    fixture.detectChanges(); // trigger initial data binding
+  });
+
+  it(`should be initialized`, () => {
+    expect(fixture).toBeDefined();
+    expect(comp).toBeDefined();
+  });
+
+
+});