RC > Merged master

CHANGELOG.md

@@ -1,3 +1,12 @@
+# 1.19.2 (2018-08-02)
+
+- Reverted stricter type information for `SkyPactService`. [#446](https://github.com/blackbaud/skyux-builder/pull/446)
+- Bugfix for `skyux build-public-library` command to successfully run on Windows. [#445](https://github.com/blackbaud/skyux-builder/pull/445)
+
+# 1.19.1 (2018-07-23)
+
+- Bugfix to allow component libraries to properly consume external components. [#439](https://github.com/blackbaud/skyux-builder/pull/439)
+
 # 1.19.0 (2018-07-18)
 
 - Updated the `skyux build-public-library` command to use same compiler as `skyux build`. [#417](https://github.com/blackbaud/skyux-builder/pull/417)
@@ -241,7 +250,7 @@ To opt into this new behavior, simply add the following to your `skyuxconfig.jso
 
 - Bugfix to allow `redirects` property in `skyuxconfig.json`. [#224](https://github.com/blackbaud/skyux-builder/pull/224)
 - Bugfix that caused plugins to process files twice during AOT compilation.  [#225](https://github.com/blackbaud/skyux-builder/pull/225)
-- Implemented a better caching strategy and fallback to non-region-specific languages.  [#226](https://github.com/blackbaud/skyux-builder/pull/226) 
+- Implemented a better caching strategy and fallback to non-region-specific languages.  [#226](https://github.com/blackbaud/skyux-builder/pull/226)
 - Upgraded `@blackbaud/auth-client` to 1.9.1. [#227](https://github.com/blackbaud/skyux-builder/pull/227)
 
 # 1.0.0-rc.7 (2017-07-13)
@@ -255,7 +264,7 @@ To opt into this new behavior, simply add the following to your `skyuxconfig.jso
 # 1.0.0-rc.6 (2017-07-05)
 
   - Updated the auth client library to pick up logic for showing the search button based on whether search has been implemented by the SPA author. [#214](https://github.com/blackbaud/skyux-builder/pull/214)
-  
+
 # 1.0.0-rc.5 (2017-07-03)
 
   - Added web-animations polyfill to support Angular animations in more browsers. [#204](https://github.com/blackbaud/skyux-builder/pull/204)
@@ -285,7 +294,7 @@ To opt into this new behavior, simply add the following to your `skyuxconfig.jso
 
 # 1.0.0-rc.0 (2017-06-16)
 
-- Added support for Angular v4.1.3 and SKY UX 2.0.0-rc.0. 
+- Added support for Angular v4.1.3 and SKY UX 2.0.0-rc.0.
 
 # 1.0.0-beta.33 (2017-06-15)
 

cli/build-public-library.js

@@ -1,13 +1,13 @@
 /*jshint node: true*/
 'use strict';
 
+const spawn = require('cross-spawn');
 const fs = require('fs-extra');
 const rimraf = require('rimraf');
 const logger = require('@blackbaud/skyux-logger');
 
 const stageTypeScriptFiles = require('./utils/stage-library-ts');
 const preparePackage = require('./utils/prepare-library-package');
-const webpackConfig = require('../config/webpack/build-public-library.webpack.config.js');
 const skyPagesConfigUtil = require('../config/sky-pages/sky-pages.config');
 const runCompiler = require('./utils/run-compiler');
 const tsLinter = require('./utils/ts-linter');
@@ -83,9 +83,14 @@ function writeTSConfig() {
   fs.writeJSONSync(skyPagesConfigUtil.spaPathTemp('tsconfig.json'), config);
 }
 
+/**
+ * Create a "placeholder" module for Angular AoT compiler.
+ * This is needed to avoid breaking changes; in the future,
+ * we should require a module name be provided by the consumer.
+ */
 function writePlaceholderModule() {
   const content = `import { NgModule } from '@angular/core';
-import './index';
+export * from './index';
 @NgModule({})
 export class SkyLibPlaceholderModule {}
 `;
@@ -95,11 +100,48 @@ export class SkyLibPlaceholderModule {}
   });
 }
 
-function transpile(skyPagesConfig, webpack) {
+/**
+ * Creates a UMD JavaScript bundle.
+ * @param {*} skyPagesConfig
+ * @param {*} webpack
+ */
+function createBundle(skyPagesConfig, webpack) {
+  const webpackConfig = require('../config/webpack/build-public-library.webpack.config');
   const config = webpackConfig.getWebpackConfig(skyPagesConfig);
   return runCompiler(webpack, config);
 }
 
+/**
+ * Transpiles TypeScript files into JavaScript files
+ * to be included with the NPM package.
+ */
+function transpile() {
+  return new Promise((resolve, reject) => {
+    const result = spawn.sync(
+      skyPagesConfigUtil.spaPath('node_modules', '.bin', 'ngc'),
+      [
+        '--project',
+        skyPagesConfigUtil.spaPathTemp('tsconfig.json')
+      ],
+      { stdio: 'inherit' }
+    );
+
+    // Catch ngc errors.
+    if (result.err) {
+      reject(result.err);
+      return;
+    }
+
+    // Catch non-zero status codes.
+    if (result.status !== 0) {
+      reject(new Error(`Angular compiler (ngc) exited with status code ${result.status}.`));
+      return;
+    }
+
+    resolve();
+  });
+}
+
 module.exports = (skyPagesConfig, webpack) => {
   runLinter();
   cleanAll();
@@ -108,7 +150,8 @@ module.exports = (skyPagesConfig, webpack) => {
   writePlaceholderModule();
   copyRuntime();
 
-  return transpile(skyPagesConfig, webpack)
+  return createBundle(skyPagesConfig, webpack)
+    .then(() => transpile())
     .then(() => {
       cleanRuntime();
       preparePackage();

config/webpack/build-public-library.webpack.config.js

@@ -4,7 +4,6 @@
 const ngtools = require('@ngtools/webpack');
 const fs = require('fs-extra');
 const webpack = require('webpack');
-const ngcWebpack = require('ngc-webpack');
 const skyPagesConfigUtil = require('../sky-pages/sky-pages.config');
 
 function parseRegExp(name) {
@@ -26,19 +25,27 @@ function getWebpackConfig(skyPagesConfig) {
     skyPagesConfigUtil.spaPath('package.json')
   );
 
-  let builderDependencies = [];
+  let dependencies = [];
   if (builderPackageJson.dependencies) {
-    builderDependencies = Object.keys(builderPackageJson.dependencies)
-      .map(key => parseRegExp(key));
+    dependencies = Object.keys(builderPackageJson.dependencies);
+  }
+
+  if (builderPackageJson.peerDependencies) {
+    dependencies = dependencies.concat(Object.keys(builderPackageJson.peerDependencies));
   }
 
-  let spaDependencies = [];
   if (spaPackageJson.dependencies) {
-    spaDependencies = Object.keys(spaPackageJson.dependencies)
-      .map(key => parseRegExp(key));
+    dependencies = dependencies.concat(Object.keys(spaPackageJson.dependencies));
+  }
+
+  if (spaPackageJson.peerDependencies) {
+    dependencies = dependencies.concat(Object.keys(spaPackageJson.peerDependencies));
   }
 
-  const externals = builderDependencies.concat(spaDependencies);
+  // Remove duplicates from array.
+  // https://stackoverflow.com/questions/1960473/get-all-unique-values-in-a-javascript-array-remove-duplicates
+  const externals = [...new Set(dependencies)]
+    .map(key => parseRegExp(key));
 
   return {
     entry: skyPagesConfigUtil.spaPathTemp('index.ts'),
@@ -74,12 +81,9 @@ function getWebpackConfig(skyPagesConfig) {
       ]
     },
     plugins: [
-      // Generate transpiled source files.
-      new ngcWebpack.NgcWebpackPlugin({
-        tsConfig: skyPagesConfigUtil.spaPathTemp('tsconfig.json')
-      }),
-
-      // Generates an aot JavaScript bundle.
+      // Generates an AoT JavaScript bundle.
+      // TODO: Remove this in favor of Angular's native library bundler,
+      // once we've upgraded to Angular version 6.
       new ngtools.AotPlugin({
         tsConfigPath: skyPagesConfigUtil.spaPathTemp('tsconfig.json'),
         entryModule: skyPagesConfigUtil.spaPathTemp('main.ts') + '#SkyLibPlaceholderModule',

lib/locale-assets-processor.js

@@ -90,7 +90,7 @@ function getNonDefaultLocaleFiles(dirname) {
 function mergeDefaultLocaleFiles() {
   const libFiles = getDefaultLocaleFiles(libPath);
   const libInternalFiles = getDefaultLocaleFiles(libInternalPath);
-  const contents = extendJson(defaultFile, ...libFiles, ...libInternalFiles);
+  const contents = extendJson(...libFiles, ...libInternalFiles, defaultFile);
   fs.writeJsonSync(defaultFile, contents);
 }
 
@@ -146,6 +146,7 @@ process.on('SIGINT', () => {
 });
 
 module.exports = {
+  getDefaultLocaleFiles,
   isLocaleFile,
   parseLocaleFileBasename,
   prepareLocaleFiles,

lib/sky-pages-assets-generator.js

@@ -16,10 +16,19 @@ function getSource() {
   const srcPath = skyPagesConfigUtil.spaPath('src');
   const assetsPath = skyPagesConfigUtil.spaPath('src', 'assets');
 
-  const filePaths = glob.sync(
+  let filePaths = glob.sync(
     skyPagesConfigUtil.spaPath('src', 'assets', '**', '*.*')
   );
 
+  // Use auto-generated en-US file even if site has no file.
+  // This will let sites use consumed library files without having to create their own en_US file.
+  const hasLocaleFile = filePaths.some(filePath => localeAssetsProcessor.isLocaleFile(filePath));
+  if (!hasLocaleFile) {
+    filePaths = filePaths.concat(
+      localeAssetsProcessor.getDefaultLocaleFiles('.skypageslocales')
+    );
+  }
+
   const pathMap = filePaths.map(filePath => {
     let key;
     let location;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blackbaud/skyux-builder",
-  "version": "1.19.0",
+  "version": "1.19.2",
   "description": "Builds the output of a SKY UX application.",
   "main": "index.js",
   "scripts": {
@@ -83,7 +83,6 @@
     "loader-utils": "1.1.0",
     "lodash.get": "4.4.2",
     "lodash.mergewith": "4.6.0",
-    "ngc-webpack": "3.0.0",
     "node-sass": "4.5.3",
     "node-sass-tilde-importer": "1.0.2",
     "open": "0.0.5",

runtime/pact.service.ts

@@ -6,10 +6,6 @@ import {
   PactWeb
 } from '@pact-foundation/pact-web';
 
-import {
-  InteractionObject
-} from '@pact-foundation/pact-web/dsl/interaction';
-
 declare var Pact: any;
 
 /**
@@ -42,7 +38,7 @@ export class SkyPactService {
    * @param provider The name of the provider service.
    * @param interaction The provider interaction.
    */
-  public addInteraction(provider: string, interaction: InteractionObject): Promise<string> {
+  public addInteraction(provider: string, interaction: any): Promise<string> {
     return this.pactProviders[provider].addInteraction(interaction);
   }
 

test/cli-build-public-library.spec.js

@@ -11,6 +11,7 @@ describe('cli build-public-library', () => {
   let webpackConfig;
   let mockWebpack;
   let mockFs;
+  let mockSpawn;
 
   beforeEach(() => {
     mockFs = {
@@ -19,6 +20,14 @@ describe('cli build-public-library', () => {
       copySync() {}
     };
 
+    mockSpawn = {
+      sync() {
+        return {
+          status: 0
+        };
+      }
+    };
+
     mockWebpack = () => {
       return {
         run: (cb) => {
@@ -50,6 +59,7 @@ describe('cli build-public-library', () => {
     });
 
     mock('fs-extra', mockFs);
+    mock('cross-spawn', mockSpawn);
 
     spyOn(process, 'exit').and.callFake(() => {});
     spyOn(skyPagesConfigUtil, 'spaPath').and.returnValue('');
@@ -108,7 +118,7 @@ describe('cli build-public-library', () => {
       const args = spy.calls.argsFor(0);
       expect(args[0]).toEqual('main.ts');
       expect(args[1]).toEqual(`import { NgModule } from '@angular/core';
-import './index';
+export * from './index';
 @NgModule({})
 export class SkyLibPlaceholderModule {}
 `);
@@ -155,4 +165,31 @@ export class SkyLibPlaceholderModule {}
       done();
     });
   });
+
+  it('should handle transpilation errors', (done) => {
+    const cliCommand = mock.reRequire(requirePath);
+    const spy = spyOn(logger, 'error').and.callThrough();
+    spyOn(mockSpawn, 'sync').and.returnValue({
+      err: 'something bad happened'
+    });
+    cliCommand({}, mockWebpack).then(() => {
+      expect(spy).toHaveBeenCalledWith('something bad happened');
+      done();
+    });
+  });
+
+  it('should catch non-zero status codes during transpilation', (done) => {
+    const cliCommand = mock.reRequire(requirePath);
+    const spy = spyOn(logger, 'error').and.returnValue();
+    spyOn(mockSpawn, 'sync').and.returnValue({
+      err: null,
+      status: 1
+    });
+    cliCommand({}, mockWebpack).then(() => {
+      expect(spy).toHaveBeenCalledWith(
+        new Error(`Angular compiler (ngc) exited with status code 1.`)
+      );
+      done();
+    });
+  });
 });

test/cli-utils-run-build.spec.js

@@ -4,20 +4,17 @@
 const mock = require('mock-require');
 const logger = require('@blackbaud/skyux-logger');
 const runtimeUtils = require('../utils/runtime-test-utils');
+const localeAssetsProcessor = require('../lib/locale-assets-processor');
 
 describe('cli utils run build', () => {
   let mockAssetsProcessor;
   let mockLocaleProcessor;
 
   beforeEach(() => {
     mockLocaleProcessor = {
-      isLocaleFile() {
-        return true;
-      },
-      parseLocaleFileBasename() {
-        return '';
-      },
-      prepareLocaleFiles() {}
+      getDefaultLocaleFiles: localeAssetsProcessor.getDefaultLocaleFiles,
+      prepareLocaleFiles() {},
+      isLocaleFile() {},
     };
 
     mockAssetsProcessor = {

test/config-webpack-build-public-library.spec.js

@@ -82,6 +82,9 @@ describe('config webpack build public library', () => {
             '@angular/common': '4.3.6',
             '@pact-foundation/pact-web': '5.3.0',
             'zone.js': '0.8.10'
+          },
+          peerDependencies: {
+            '@angular/core': '4.3.6'
           }
         };
       }
@@ -90,6 +93,9 @@ describe('config webpack build public library', () => {
         dependencies: {
           '@blackbaud/skyux': '2.13.0',
           '@blackbaud-internal/skyux-lib-testing': 'latest'
+        },
+        peerDependencies: {
+          '@angular/core': '4.3.6'
         }
       };
     });
@@ -99,6 +105,7 @@ describe('config webpack build public library', () => {
       /^@angular\/common/,
       /^@pact\-foundation\/pact\-web/,
       /^zone\.js/,
+      /^@angular\/core/,
       /^@blackbaud\/skyux/,
       /^@blackbaud\-internal\/skyux\-lib\-testing/
     ]);