Feature help library

lib/sky-pages-module-generator.js

@@ -32,7 +32,7 @@ function getSource(skyAppConfig) {
   ];
 
   const routes = routeGenerator.getRoutes(skyAppConfig);
-  const names = `${componentNames.concat(routes.names, runtimeComponents).join(',\n    ')}`;
+  const names = componentNames.concat(routes.names, runtimeComponents);
 
   skyAppConfig.runtime.routes = routes.routesForConfig;
   const skyAppConfigAsString = JSON.stringify(skyAppConfig);
@@ -74,13 +74,36 @@ function getSource(skyAppConfig) {
     }`);
   }
 
+  let nodeModulesImports = [
+    `import {
+      Component,
+      Inject,
+      NgModule,
+      OnInit,
+      OnDestroy,
+      OpaqueToken
+    } from '@angular/core';`,
+    `import { CommonModule } from '@angular/common';`,
+    `import { HttpModule, XHRBackend, RequestOptions } from '@angular/http';`,
+    `import { FormsModule, ReactiveFormsModule } from '@angular/forms';`,
+    `import { ActivatedRoute, RouterModule, Routes } from '@angular/router';`,
+    `import { Subscription } from 'rxjs/Subscription';`,
+    `import { BBHelpModule } from '@blackbaud/skyux-lib-help';`
+  ];
+
+  let runtimeModuleExports = [
+    ...names,
+    'BBHelpModule'
+  ];
+
   let runtimeModuleImports = [
     'CommonModule',
     'HttpModule',
     'FormsModule',
     'ReactiveFormsModule',
     'SkyModule',
-    'AppExtrasModule'
+    'AppExtrasModule',
+    'BBHelpModule'
   ];
 
   if (skyAppConfig.runtime.includeRouteModule) {
@@ -115,22 +138,10 @@ BBAuth.mock = true;
 
   let moduleSource =
 `${useMockAuth}
-import '${skyAppConfig.runtime.skyPagesOutAlias}/src/main';
 
-import {
-  Component,
-  Inject,
-  NgModule,
-  OnInit,
-  OnDestroy,
-  OpaqueToken
-} from '@angular/core';
-
-import { CommonModule } from '@angular/common';
-import { HttpModule, XHRBackend, RequestOptions } from '@angular/http';
-import { FormsModule, ReactiveFormsModule } from '@angular/forms';
-import { ActivatedRoute, RouterModule, Routes } from '@angular/router';
-import { Subscription } from 'rxjs/Subscription';
+${nodeModulesImports.join('\n')}
+
+import '${skyAppConfig.runtime.skyPagesOutAlias}/src/main';
 import { SkyModule } from '${skyAppConfig.runtime.skyuxPathAlias}/core';
 import {
   AppExtrasModule
@@ -175,13 +186,13 @@ ${enableProdMode}
 
 @NgModule({
   declarations: [
-    ${names}
+    ${names.join(',\n' + codegen.indent(2))}
   ],
   imports: [
     ${runtimeModuleImports.join(',\n' + codegen.indent(2))}
   ],
   exports: [
-    ${names}
+    ${runtimeModuleExports.join(',\n' + codegen.indent(2))}
   ],
   providers: [
     ${runtimeProviders.join(',\n' + codegen.indent(2))}

package.json

@@ -42,7 +42,7 @@
     "@angular/platform-browser-dynamic": "4.3.6",
     "@angular/router": "4.3.6",
     "@blackbaud/auth-client": "1.15.0",
-    "@blackbaud/help-client": "1.0.1",
+    "@blackbaud/skyux-lib-help": "1.0.0",
     "@ngtools/webpack": "1.6.2",
     "@types/core-js": "0.9.43",
     "@types/fontfaceobserver": "0.0.5",

runtime/config.ts

@@ -25,6 +25,25 @@ export interface RuntimeConfig {
   useTemplateUrl: boolean;
 }
 
+export interface HelpWidgetConfig {
+  extends?: string;
+  productId?: string;
+  defaultHelpKey?: string;
+  locale?: string;
+  helpBaseUrl?: string;
+  customLocales?: string[];
+  headerColor?: string;
+  headerTextColor?: string;
+  trainingCentralUrl?: string;
+  knowledgeBaseUrl?: string;
+  caseCentralUrl?: string;
+  helpCentralUrl?: string;
+  hideUndock?: boolean;
+  hideWidgetOnMobile?: boolean;
+  hideHelpChat?: boolean;
+  useFlareSearch?: boolean;
+}
+
 export interface SkyuxConfigA11y {
   rules?: any;
 }
@@ -47,7 +66,7 @@ export interface SkyuxConfig {
   cssPath?: string;
   command?: string;
   compileMode?: string;
-  help?: any;
+  help?: HelpWidgetConfig;
   host?: SkyuxConfigHost;
   importPath?: string;
   mode?: string;

src/app/app.component.spec.ts

@@ -8,7 +8,9 @@ import {
   SkyAppStyleLoader,
   SkyAppWindowRef
 } from '@blackbaud/skyux-builder/runtime';
-import { BBHelp } from '@blackbaud/help-client';
+
+import { HelpInitializationService } from '@blackbaud/skyux-lib-help';
+
 import { BBOmnibar, BBOmnibarSearchArgs } from '@blackbaud/auth-client';
 
 import { AppComponent } from './app.component';
@@ -42,6 +44,12 @@ describe('AppComponent', () => {
     }
   };
 
+  class MockHelpInitService {
+    public load() { }
+  }
+
+  const mockHelpInitService = new MockHelpInitService();
+
   function setup(
     config: any,
     includeSearchProvider?: boolean,
@@ -80,6 +88,10 @@ describe('AppComponent', () => {
         useValue: {
           loadStyles: () => Promise.resolve(styleLoadError)
         }
+      },
+      {
+        provide: HelpInitializationService,
+        useValue: mockHelpInitService
       }
     ];
 
@@ -364,23 +376,40 @@ describe('AppComponent', () => {
     });
   }));
 
-  it('should not call BBHelp.load if config.skyux.help does not exist', async(() => {
-    let spyHelp = spyOn(BBHelp, 'load');
+  it('should not call HelpInitializationService.load if help config does not exist', async(() => {
+    let spyHelp = spyOn(mockHelpInitService, 'load');
     setup(skyAppConfig).then(() => {
       fixture.detectChanges();
       expect(spyHelp).not.toHaveBeenCalled();
     });
   }));
 
-  it('should pass help config to BBHelp.load', async(() => {
-    let spyHelp = spyOn(BBHelp, 'load');
-    skyAppConfig.skyux.help = 'help-config';
+  it('should pass help config to HelpInitializationService.load', async(() => {
+    let spyHelp = spyOn(mockHelpInitService, 'load');
+    skyAppConfig.skyux.help = { productId: 'test-config' };
+    skyAppConfig.runtime.params.has = (key: any) => false;
     setup(skyAppConfig).then(() => {
       fixture.detectChanges();
       expect(spyHelp).toHaveBeenCalledWith(skyAppConfig.skyux.help);
     });
   }));
 
+  it('should assign help config extends key to the svcid if one exists', async(() => {
+    let spyHelp = spyOn(mockHelpInitService, 'load');
+    const expectedCall = { productId: 'test-config', extends: 'help-extend' };
+    skyAppConfig.skyux.help = { productId: 'test-config' };
+
+    skyAppConfig.skyux.params = ['svcid'];
+    skyAppConfig.runtime.params.has = (key: any) => key === 'svcid';
+    skyAppConfig.runtime.params.get = (key: any) => key === 'svcid' ? 'help-extend' : false;
+
+    setup(skyAppConfig).then(() => {
+      fixture.detectChanges();
+      expect(spyHelp).not.toHaveBeenCalledWith(skyAppConfig.skyux.help);
+      expect(spyHelp).toHaveBeenCalledWith(expectedCall);
+    });
+  }));
+
   it('should set isReady after SkyAppStyleLoader.loadStyles is resolved', async(() => {
     setup(skyAppConfig).then(() => {
       expect(comp.isReady).toEqual(true);

src/app/app.component.ts

@@ -16,7 +16,7 @@ import {
   BBOmnibarSearchArgs
 } from '@blackbaud/auth-client';
 
-import { BBHelp } from '@blackbaud/help-client';
+import { HelpInitializationService } from '@blackbaud/skyux-lib-help';
 
 import {
   SkyAppConfig,
@@ -74,6 +74,7 @@ export class AppComponent implements OnInit {
     private windowRef: SkyAppWindowRef,
     private config: SkyAppConfig,
     private styleLoader: SkyAppStyleLoader,
+    private helpInitService: HelpInitializationService,
     @Optional() private searchProvider?: SkyAppSearchResultsProvider
   ) {
     this.styleLoader.loadStyles()
@@ -194,7 +195,12 @@ export class AppComponent implements OnInit {
     }
 
     if (helpConfig) {
-      BBHelp.load(helpConfig);
+
+      if (this.config.runtime.params.has('svcid')) {
+        helpConfig.extends = this.config.runtime.params.get('svcid');
+      }
+
+      this.helpInitService.load(helpConfig);
     }
   }
 }

test/sky-pages-component-generator.spec.js

@@ -150,5 +150,4 @@ describe('SKY UX Builder component generator', () => {
     });
     expect(components.names.length).toEqual(0);
   });
-
 });

test/sky-pages-module-generator.spec.js

@@ -3,6 +3,12 @@
 
 const codegen = require('../utils/codegen-utils');
 
+const getModuleList = (listName, content) => {
+  const listRegExp = new RegExp(`${listName}:\\s\\[([\\s\\S]*?).*?\\]`, 'g');
+  const list = content.match(listRegExp);
+  return list ? list[0] : [];
+}
+
 describe('SKY UX Builder module generator', () => {
 
   const runtimeUtils = require('../utils/runtime-test-utils.js');
@@ -102,15 +108,45 @@ describe('SKY UX Builder module generator', () => {
     expect(source).toContain(expectedProvider);
   });
 
-  it('should not include routing in the module if includeRouteModule is false', () => {
+  it('should import modules from the nodeModuleImports', () => {
+    const expectedImport = `import { BBHelpModule } from '@blackbaud/skyux-lib-help'`;
+
+    let source = generator.getSource({
+      runtime: runtimeUtils.getDefaultRuntime(),
+      skyux: {
+        help: {}
+      }
+    });
+
+    expect(source).toContain(expectedImport);
+  });
+
+  it('should export modules from the runtimeModuleExports', () => {
+    const expectedExport = 'BBHelpModule';
 
-    let expectedRouting = `AppExtrasModule,\n${codegen.indent(2)}routing`;
+    let source = generator.getSource({
+      runtime: runtimeUtils.getDefaultRuntime(),
+      skyux: {
+        help: {}
+      }
+    });
+
+    let moduleExports = getModuleList('exports', source);
+
+    expect(moduleExports).toContain(expectedExport);
+  });
+
+  it('should not include routing in the module imports if includeRouteModule is false', () => {
+
+    const expectedImport = `routing`;
     let sourceWithRouting = generator.getSource({
       runtime: runtimeUtils.getDefaultRuntime(),
       skyux: {}
     });
 
-    expect(sourceWithRouting).toContain(expectedRouting);
+    let moduleImports = getModuleList('imports', sourceWithRouting);
+
+    expect(moduleImports).toContain(expectedImport);
 
     let sourceWithoutRouting = generator.getSource(
       {
@@ -120,7 +156,9 @@ describe('SKY UX Builder module generator', () => {
         skyux: {}
       });
 
-    expect(sourceWithoutRouting).not.toContain(expectedRouting);
+    moduleImports = getModuleList('imports', sourceWithoutRouting);
+
+    expect(moduleImports).not.toContain(expectedImport);
   });
 
   it('should call `enableProdMode` if the command is build', () => {