refactor(coreservices): Split location services up into location and locationConfig

refactor(angular1): move isolated angular1 code to its own directory
refactor(runtime): replaced `runtime` ($q and $injector) with `services`
refactor(stateEvents): Do not include the legacy `$stateChange*` in the default build

Author: christopherthielen

Gruntfile.js

@@ -34,11 +34,13 @@ module.exports = function (grunt) {
     },
     uglify: {
       options: {
-        banner: '<%= meta.banner %>\n'
+        banner: '<%= meta.banner %>\n',
+        mangle: true
       },
       build: {
         files: {
-          '<%= builddir %>/<%= pkg.name %>.min.js': ['<banner:meta.banner>', '<%= builddir %>/<%= pkg.name %>.js']
+          '<%= builddir %>/<%= pkg.name %>.min.js': ['<banner:meta.banner>', '<%= builddir %>/<%= pkg.name %>.js'],
+          '<%= builddir %>/ng1/stateEvents.min.js': ['<banner:meta.banner>', '<%= builddir %>/ng1/stateEvents.js']
         }
       }
     },
@@ -144,18 +146,28 @@ module.exports = function (grunt) {
 
   grunt.registerTask('integrate', ['clean', 'build', 'karma:ng12', 'karma:ng13', 'karma:ng14']);
   grunt.registerTask('default', ['build', 'karma:unit', 'docs']);
-  grunt.registerTask('build', 'Perform a normal build', ['clean', 'ts', 'webpack', 'uglify']);
+  grunt.registerTask('build', 'Perform a normal build', ['clean', 'ts', 'webpack', 'bundles', 'uglify']);
   grunt.registerTask('dist-docs', 'Perform a clean build and generate documentation', ['build', 'ngdocs']);
   grunt.registerTask('release', 'Tag and perform a release', ['prepare-release', 'build', 'perform-release']);
   grunt.registerTask('dev', 'Run dev server and watch for changes', ['build', 'connect:server', 'karma:background', 'watch']);
   grunt.registerTask('sample', 'Run connect server with keepalive:true for sample app development', ['connect:sample']);
 
   grunt.registerTask('docs', 'Generate documentation to _doc', function() { 
     promising(this, 
-      system('./node_modules/typedoc/bin/typedoc --readme ./README.md --name "UI-Router" --theme default --mode modules --module commonjs --target es5 --out _doc  src/params src/path src/resolve src/state src/transition src/url src/view')
+      system('./node_modules/typedoc/bin/typedoc --readme ./README.md --name "UI-Router" --theme default --mode modules --module commonjs --target es5 --out _doc  src/params src/path src/resolve src/state src/transition src/url src/view src/ng1')
     );
   });
 
+  grunt.registerTask('bundles', 'Create the bundles and reorganize any additional dist files (addons, etc)', function() {
+    var builddir = grunt.config('builddir');
+    grunt.task.requires([ 'clean', 'ts' ]);
+    grunt.task.run(['webpack']);
+
+    ['stateEvents.js', 'stateEvents.js.map'].forEach(function(file) {
+      grunt.file.copy(builddir + "/es5/ng1/" + file, builddir + "/ng1/" + file);
+    })
+  });
+
   grunt.registerTask('publish-pages', 'Publish a clean build, docs, and sample to github.io', function () {
     promising(this,
       ensureCleanMaster().then(function () {
@@ -207,9 +219,10 @@ module.exports = function (grunt) {
   });
 
   grunt.registerTask('perform-release', function () {
-    grunt.task.requires([ 'prepare-release', 'build' ]);
-
     var version = grunt.config('pkg.version'), releasedir = grunt.config('builddir');
+    grunt.task.requires([ 'prepare-release', 'build' ]);
+    grunt.file.delete(releasedir + "/es5");
+    grunt.file.delete(releasedir + "/es6");
     promising(this,
       system('git add \'' + releasedir + '\'').then(function () {
         return system('git commit -m \'release ' + version + '\'');

files.js

@@ -3,7 +3,10 @@ routerFiles = {
   es6Entrypoint:      ['./build/es6/ui-router.js'],
 
   buildDest:          ['build/angular-ui-router.js'], // The distribution file
-  src:                ['src/ui-router.ts'], // Main UI-Router module (imports everything else)
+  src:                [
+    'src/ui-router.ts', // Main UI-Router module (imports everything else)
+    'src/ng1/stateEvents.ts' // There might be a better approach to compiling this file
+  ],
 
   // Test helpers
   testUtils: [

src/common/coreservices.ts

@@ -1,16 +1,51 @@
-import * as foo from "./common";
-
 /**
- * Services related to the browser location (url)
+ * This module is a stub for core services such as Dependency Injection or Browser Location.
+ * Core services may be implemented by a specific framework, such as ng1 or ng2, or be pure javascript.
+ *
+ * @module common
  */
+
+/** for typedoc */
+import * as foo from "./common";
+import IQService = angular.IQService;
+import IInjectorService = angular.auto.IInjectorService;
+
+let notImplemented = (fnname) => () => {
+  throw new Error(`${fnname}(): No coreservices implementation for UI-Router is loaded. You should include one of: ['angular1.js']`);
+};
+
+let services: CoreServices = {
+  $q: undefined,
+  $injector: undefined,
+  location: <any> {},
+  locationConfig: <any> {}
+};
+
+["replace", "url", "path", "search", "hash"]
+    .forEach(key => services.location[key] = notImplemented(key));
+
+["port", "protocol", "host", "baseHref", "html5Mode", "hashPrefix" ]
+    .forEach(key => services.locationConfig[key] = notImplemented(key));
+
+interface CoreServices {
+  $q: IQService;
+  $injector: IInjectorService;
+  /** Services related to getting or setting the browser location (url) */
+  location: LocationServices;
+  /** Retrieves configuration for how to construct a URL. */
+  locationConfig: LocationConfig;
+}
+
 interface LocationServices {
   replace(): void;
   url(newurl: string): string;
   url(): string;
   path(): string;
   search(): string;
   hash(): string;
+}
 
+interface LocationConfig {
   port(): number;
   protocol(): string;
   host(): string;
@@ -21,30 +56,4 @@ interface LocationServices {
   hashPrefix(newprefix: string): string;
 }
 
-interface Services {
-    location: LocationServices;
-}
-
-let services: Services = {
-  location: <any> {}
-};
-
-let notImplemented = (fnname) => () => {
-  throw new Error(`${fnname}(): No coreservices implementation for UI-Router is loaded. You should include one of: ['angular1.js']`);
-};
-
-[
-  "replace",
-  "url",
-  "path",
-  "search",
-  "hash",
-  "port",
-  "protocol",
-  "host",
-  "baseHref",
-  "html5Mode",
-  "hashPrefix"
-].forEach(key => services.location[key] = notImplemented(key));
-
 export {services};

src/common/module.ts

@@ -1,5 +1,4 @@
 /** @module common */ /** for typedoc */
-export * from "./angular1";
 export * from "./common";
 export * from "./coreservices";
 export * from "./queue";

src/common/angular1.ts renamed to src/ng1/angular1.ts

@@ -1,33 +1,23 @@
-/** @module common */ /** for typedoc */
-
 /**
- * Provides the implementation for services defined in [[coreservices]], and registers some
- * with the angular 1 injector.
+ * Angular 1 plugin:
+ *
+ * - Provides an implementation for the [[CoreServices]] API, based on angular 1 services.
+ * - Also registers some services with the angular 1 injector.
+ * - Creates and bootstraps a new [[Router]] object, usiong the angular 1 lifecycle
+ *
+ * @module ng1
+ * @preferred
  */
 
+/** for typedoc */
 /// <reference path='../../typings/angularjs/angular.d.ts' />
 import {IQService} from "angular";
 import {Router} from "../router";
-import {services} from "./coreservices";
-import {isObject} from "./common";
+import {services} from "../common/coreservices";
+import {isObject} from "../common/common";
 
 let app = angular.module("ui.router.angular1", []);
 
-interface IRuntime {
-  setRuntimeInjector($injector: ng.auto.IInjectorService);
-  $injector: ng.auto.IInjectorService;
-  $q: IQService;
-}
-
-export let runtime: IRuntime = {
-  setRuntimeInjector: function($injector: ng.auto.IInjectorService) {
-    runtime.$injector = $injector;
-    runtime.$q = $injector.get("$q");
-  },
-  $injector: undefined,
-  $q: undefined
-};
-
 /**
  * Annotates a controller expression (may be a controller function(), a "controllername",
  * or "controllername as name")
@@ -42,7 +32,7 @@ export let runtime: IRuntime = {
  */
 
 export function annotateController(controllerExpression): string[] {
-  let $injector = runtime.$injector;
+  let $injector = services.$injector;
   let $controller = $injector.get("$controller");
   let oldInstantiate = $injector.instantiate;
   try {
@@ -61,9 +51,10 @@ export function annotateController(controllerExpression): string[] {
   }
 }
 
-runBlock.$inject = ["$injector"];
-function runBlock($injector) {
-  runtime.setRuntimeInjector($injector);
+runBlock.$inject = ['$injector', '$q'];
+function runBlock($injector, $q) {
+  services.$injector = $injector;
+  services.$q = $q;
 }
 
 app.run(runBlock);
@@ -76,34 +67,34 @@ let router = null;
 ng1UIRouter.$inject = ['$locationProvider'];
 function ng1UIRouter($locationProvider) {
   router = new Router();
-  bindFunctions(['hashPrefix'], $locationProvider, services.location);
+  bindFunctions(['hashPrefix'], $locationProvider, services.locationConfig);
 
   this.$get = $get;
   $get.$inject = ['$location', '$browser', '$sniffer'];
   function $get($location, $browser, $sniffer) {
 
-    services.location.html5Mode = function() {
+    services.locationConfig.html5Mode = function() {
       var html5Mode = $locationProvider.html5Mode();
       html5Mode = isObject(html5Mode) ? html5Mode.enabled : html5Mode;
       return html5Mode && $sniffer.history;
     };
 
-    var $locationFnNames = ['hash', 'path', 'replace', 'search', 'url', 'port', 'protocol', 'host'];
-    bindFunctions($locationFnNames, $location, services.location);
-    bindFunctions(['baseHref'], $browser, services.location);
+    bindFunctions(["replace", "url", "path", "search", "hash"], $location, services.location);
+    bindFunctions([ 'port', 'protocol', 'host'], $location, services.locationConfig);
+    bindFunctions(['baseHref'], $browser, services.locationConfig);
 
     return router;
   }
 }
 
-angular.module('ui.router.init', ['ng']).provider("ng1UIRouter", <any> ng1UIRouter);
+angular.module('ui.router.init', []).provider("ng1UIRouter", <any> ng1UIRouter);
 // Register as a provider so it's available to other providers
 angular.module('ui.router.util').provider('$urlMatcherFactory', ['ng1UIRouterProvider', () => router.urlMatcherFactory]);
 angular.module('ui.router.router').provider('$urlRouter', ['ng1UIRouterProvider', () => router.urlRouterProvider]);
 angular.module('ui.router.state').provider('$state', ['ng1UIRouterProvider', () => router.stateProvider]);
 
 /* This effectively calls $get() to init when we enter runtime */
-angular.module('ui.router.state').run(['ng1UIRouter', function(ng1UIRouter) { }]);
+angular.module('ui.router.init').run(['ng1UIRouter', function(ng1UIRouter) { }]);
 angular.module('ui.router.state').run(['$state', function($state) { }]);
 angular.module('ui.router.util').run(['$urlMatcherFactory', function($urlMatcherFactory) { }]);