refactor(common): simplify references to angular.* functions

christopherthielen · christopherthielen · commit 002e8d1531a7 · 2016-02-18T18:50:19.000-06:00
refactor(*): for typescript 1.8: export all interfaces/classes/enums exposed externally
refactor(*): for typescript 1.8: switch up /// &lt;reference paths
refactor(Router): rename to UIRouter to avoid same name as component Router
refactor(*): Switch types from angular IPromise to ES6 Promise
diff --git a/src/common/common.ts b/src/common/common.ts
@@ -3,17 +3,17 @@
 import {isFunction, isString, isArray, isRegExp, isDate} from "./predicates";
 import { all, pattern, any, not, prop, curry, val } from "./hof";
 
-let angular = (<any> window).angular;
-export const fromJson = angular && angular.fromJson || _fromJson;
-export const toJson = angular && angular.toJson || _toJson;
-export const copy = angular && angular.copy || _copy;
-export const forEach = angular && angular.forEach || _forEach;
-export const extend = angular && angular.extend || _extend;
-export const equals = angular && angular.equals || _equals;
+let angular = (<any> window).angular || {};
+export const fromJson = angular.fromJson || _fromJson;
+export const toJson = angular.toJson || _toJson;
+export const copy = angular.copy || _copy;
+export const forEach = angular.forEach || _forEach;
+export const extend = angular.extend || _extend;
+export const equals = angular.equals || _equals;
 export const identity = (x) => x;
 export const noop = () => undefined;
 
-type Mapper<X, T> = (x: X, key?: (string|number)) => T;
+export type Mapper<X, T> = (x: X, key?: (string|number)) => T;
 export interface TypedMap<T> { [key: string]: T; }
 export type Predicate<X> = (X) => boolean;
 export type IInjectable = (Function|any[]);
@@ -570,3 +570,9 @@ function _arraysEq(a1, a2) {
   if (a1.length !== a2.length) return false;
   return arrayTuples(a1, a2).reduce((b, t) => b && _equals(t[0], t[1]), true);
 }
+//
+//const _addToGroup = (result, keyFn) => (item) =>
+//  (result[keyFn(item)] = result[keyFn(item)] || []).push(item) && result;
+//const groupBy = (array, keyFn) => array.reduce((memo, item) => _addToGroup(memo, keyFn), {});
+//
+//
diff --git a/src/common/coreservices.ts b/src/common/coreservices.ts
@@ -27,7 +27,7 @@ let services: CoreServices = {
 ["port", "protocol", "host", "baseHref", "html5Mode", "hashPrefix" ]
     .forEach(key => services.locationConfig[key] = notImplemented(key));
 
-interface CoreServices {
+export interface CoreServices {
   $q; // : IQService;
   $injector; // : IInjectorService;
   /** Services related to getting or setting the browser location (url) */
@@ -37,7 +37,7 @@ interface CoreServices {
   template: TemplateServices;
 }
 
-interface LocationServices {
+export interface LocationServices {
   replace(): void;
   url(newurl: string): string;
   url(): string;
@@ -47,7 +47,7 @@ interface LocationServices {
   onChange(callback: Function): Function;
 }
 
-interface LocationConfig {
+export interface LocationConfig {
   port(): number;
   protocol(): string;
   host(): string;
@@ -58,7 +58,7 @@ interface LocationConfig {
   hashPrefix(newprefix: string): string;
 }
 
-interface TemplateServices {
+export interface TemplateServices {
   get(url: string): string;
 }
 
diff --git a/src/common/trace.ts b/src/common/trace.ts
@@ -43,11 +43,11 @@ function stringify(o) {
   return JSON.stringify(o, (key, val) => format(val)).replace(/\\"/g, '"');
 }
 
-enum Category {
+export enum Category {
   RESOLVE, TRANSITION, HOOK, INVOKE, UIVIEW, VIEWCONFIG
 }
 
-class Trace {
+export class Trace {
   approximateDigests: number;
 
   constructor() {
diff --git a/src/ng1.ts b/src/ng1.ts
@@ -1,3 +1,5 @@
+/// <reference path='../typings/angularjs/angular.d.ts' />
+/// <reference path='../typings/es6-shim/es6-shim.d.ts' />
 /**
  * Main entry point for angular 1.x build
  */
diff --git a/src/ng1/services.ts b/src/ng1/services.ts
@@ -9,9 +9,11 @@
  * @preferred
  */
 
-/** for typedoc */
 /// <reference path='../../typings/angularjs/angular.d.ts' />
-import {Router} from "../router";
+/// <reference path='../../typings/es6-shim/es6-shim.d.ts' />
+
+/** for typedoc */
+import {UIRouter} from "../router";
 import {services} from "../common/coreservices";
 import {map, bindFunctions, removeFrom, find, noop} from "../common/common";
 import {prop, propEq} from "../common/hof";
@@ -148,14 +150,14 @@ function runBlock($injector, $q) {
 
 app.run(runBlock);
 
-let router: Router = null;
+let router: UIRouter = null;
 
 ng1UIRouter.$inject = ['$locationProvider'];
 /** This angular 1 provider instantiates a Router and exposes its services via the angular injector */
 function ng1UIRouter($locationProvider) {
 
   // Create a new instance of the Router when the ng1UIRouterProvider is initialized
-  router = new Router();
+  router = new UIRouter();
 
   // Bind LocationConfig.hashPrefix to $locationProvider.hashPrefix
   bindFunctions($locationProvider, services.locationConfig, $locationProvider, ['hashPrefix']);
diff --git a/src/ng1/stateEvents.ts b/src/ng1/stateEvents.ts
@@ -18,8 +18,6 @@
  */
 
 /** for typedoc */
-/// <reference path='../../typings/angularjs/angular.d.ts' />
-
 import {IServiceProviderFactory} from "angular";
 import {StateService, StateProvider} from "../state/interface";
 import {TargetState} from "../state/module";
diff --git a/src/ng1/stateFilters.ts b/src/ng1/stateFilters.ts
@@ -1,5 +1,4 @@
 /** @module state */ /** for typedoc */
-/// <reference path='../../typings/angularjs/angular.d.ts' />
 
 /**
  * @ngdoc filter
diff --git a/src/ng1/viewDirective.ts b/src/ng1/viewDirective.ts
@@ -1,8 +1,6 @@
 var ngMajorVer = angular.version.major;
 var ngMinorVer = angular.version.minor;
 /** @module view */ /** for typedoc */
-/// <reference path='../../typings/angularjs/angular.d.ts' />
-
 import {extend} from "../common/common";
 import {isDefined} from "../common/predicates";
 import {trace} from "../common/trace";
diff --git a/src/ng1/viewScroll.ts b/src/ng1/viewScroll.ts
@@ -1,5 +1,4 @@
 /** @module view */ /** for typedoc */
-/// <reference path='../../typings/angularjs/angular.d.ts' />
 import {IServiceProviderFactory} from "angular";
 
 /**
diff --git a/src/params/interface.ts b/src/params/interface.ts
@@ -214,7 +214,7 @@ export interface ParamDeclaration {
   dynamic: boolean;
 }
 
-interface Replace {
+export interface Replace {
   from: string;
   to: string;
 }
diff --git a/src/params/paramTypes.ts b/src/params/paramTypes.ts
@@ -12,7 +12,7 @@ import {Type} from "./type";
 function valToString(val) { return val != null ? val.toString().replace(/~/g, "~~").replace(/\//g, "~2F") : val; }
 function valFromString(val) { return val != null ? val.toString().replace(/~2F/g, "/").replace(/~~/g, "~") : val; }
 
-class ParamTypes {
+export class ParamTypes {
   types: any;
   enqueue: boolean = true;
   typeQueue: any[] = [];
diff --git a/src/resolve/resolvable.ts b/src/resolve/resolvable.ts
@@ -1,12 +1,10 @@
 /** @module path */ /** for typedoc */
-/// <reference path='../../typings/angularjs/angular.d.ts' />
 import {extend, pick, map, filter} from "../common/common";
 import {not} from "../common/hof";
 import {isInjectable} from "../common/predicates";
 
 import {services} from "../common/coreservices";
 import {trace} from "../common/trace";
-import {IPromise} from "angular";
 import {Resolvables, IOptions1} from "./interface";
 
 import {ResolveContext} from "./resolveContext";
@@ -32,7 +30,7 @@ export class Resolvable {
   resolveFn: Function;
   deps: string[];
 
-  promise: IPromise<any> = undefined;
+  promise: Promise<any> = undefined;
   data: any;
 
   // synchronous part:
@@ -80,7 +78,7 @@ export class Resolvable {
     });
   }
 
-  get(resolveContext: ResolveContext, options?: IOptions1): IPromise<any> {
+  get(resolveContext: ResolveContext, options?: IOptions1): Promise<any> {
     return this.promise || this.resolveResolvable(resolveContext, options);
   }
 
diff --git a/src/resolve/resolveContext.ts b/src/resolve/resolveContext.ts
@@ -1,11 +1,9 @@
 /** @module path */ /** for typedoc */
-/// <reference path='../../typings/angularjs/angular.d.ts' />
 import {IInjectable, find, filter, map, tail, defaults, extend, pick, omit} from "../common/common";
 import {prop, propEq} from "../common/hof";
 import {isString, isObject} from "../common/predicates";
 import {trace} from "../common/trace";
 import {services} from "../common/coreservices";
-import {IPromise} from "angular";
 import {Resolvables, ResolvePolicy, IOptions1} from "./interface";
 
 import {Node} from "../path/module";
@@ -17,7 +15,7 @@ import {mergeR} from "../common/common";
 let defaultResolvePolicy = ResolvePolicy[ResolvePolicy.LAZY];
 
 interface IPolicies { [key: string]: string; }
-interface IPromises { [key: string]: IPromise<any>; }
+interface Promises { [key: string]: Promise<any>; }
 
 export class ResolveContext {
 
@@ -93,7 +91,7 @@ export class ResolveContext {
   }
    
   // Returns a promise for an array of resolved path Element promises
-  resolvePath(options: IOptions1 = {}): IPromise<any> {
+  resolvePath(options: IOptions1 = {}): Promise<any> {
     trace.traceResolvePath(this._path, options);
     const promiseForNode = (node: Node) => this.resolvePathElement(node.state, options);
     return services.$q.all(<any> map(this._path, promiseForNode)).then(all => all.reduce(mergeR, {}));
@@ -103,7 +101,7 @@ export class ResolveContext {
   // options.resolvePolicy: only return promises for those Resolvables which are at 
   // the specified policy, or above.  i.e., options.resolvePolicy === 'lazy' will
   // resolve both 'lazy' and 'eager' resolves.
-  resolvePathElement(state: State, options: IOptions1 = {}): IPromise<any> {
+  resolvePathElement(state: State, options: IOptions1 = {}): Promise<any> {
     // The caller can request the path be resolved for a given policy and "below" 
     let policy: string = options && options.resolvePolicy;
     let policyOrdinal: number = ResolvePolicy[policy || defaultResolvePolicy];
@@ -114,7 +112,7 @@ export class ResolveContext {
     let matchingResolves = filter(resolvables, matchesRequestedPolicy);
 
     const getResolvePromise = (resolvable: Resolvable) => resolvable.get(this.isolateRootTo(state), options);
-    let resolvablePromises: IPromises = <any> map(matchingResolves, getResolvePromise);
+    let resolvablePromises: Promises = <any> map(matchingResolves, getResolvePromise);
 
     trace.traceResolvePathElement(this, matchingResolves, options);
 
@@ -135,11 +133,11 @@ export class ResolveContext {
    * @param locals: are the angular $injector-style locals to inject
    * @param options: options (TODO: document)
    */
-  invokeLater(fn: IInjectable, locals: any = {}, options: IOptions1 = {}): IPromise<any> {
+  invokeLater(fn: IInjectable, locals: any = {}, options: IOptions1 = {}): Promise<any> {
     let resolvables = this.getResolvablesForFn(fn);
     trace.tracePathElementInvoke(tail(this._path), fn, Object.keys(resolvables), extend({when: "Later"}, options));
     const getPromise = (resolvable: Resolvable) => resolvable.get(this, options);
-    let promises: IPromises = <any> map(resolvables, getPromise);
+    let promises: Promises = <any> map(resolvables, getPromise);
     
     return services.$q.all(promises).then(() => {
       try {
diff --git a/src/resolve/resolveInjector.ts b/src/resolve/resolveInjector.ts
@@ -4,6 +4,7 @@ import {map} from "../common/common";
 import {Resolvable} from "./resolvable";
 import {ResolveContext} from "./resolveContext";
 import {State} from "../state/module";
+import {TypedMap} from "../common/common";
 
 export class ResolveInjector {
   constructor(private _resolveContext: ResolveContext, private _state: State) { }
diff --git a/src/router.ts b/src/router.ts
@@ -2,6 +2,7 @@ import {UrlMatcherFactory} from "./url/urlMatcherFactory";
 import {UrlRouterProvider} from "./url/urlRouter";
 import {StateProvider} from "./state/state";
 import {stateParamsFactory} from "./params/stateParams";
+import {StateParams} from "./params/stateParams";
 import {UrlRouter} from "./url/urlRouter";
 import {TransitionService} from "./transition/transitionService";
 import {TemplateFactory} from "./view/templateFactory";
@@ -18,7 +19,7 @@ import {StateService} from "./state/stateService";
  * your app states with the [[stateRegistry]] (and set url options using ...).  Then, tell UI-Router to monitor
  * the URL by calling `urlRouter.listen()` ([[URLRouter.listen]])
  */
-class Router {
+class UIRouter {
 
   stateParams = stateParamsFactory();
 
@@ -46,4 +47,4 @@ class Router {
   }
 }
 
-export { Router };
+export { UIRouter };
diff --git a/src/state/hooks/resolveHooks.ts b/src/state/hooks/resolveHooks.ts
@@ -24,13 +24,13 @@ export class ResolveHooks {
     let treeChanges = this.transition.treeChanges();
 
     /** a function which resolves any EAGER Resolvables for a Path */
-    $eagerResolvePath.$inject = ['$transition$'];
+    (<any> $eagerResolvePath).$inject = ['$transition$'];
     function $eagerResolvePath($transition$) {
       return tail(<any[]> treeChanges.to).resolveContext.resolvePath(extend({ transition: $transition$ }, { resolvePolicy: EAGER }));
     }
 
     /** Returns a function which pre-resolves any LAZY Resolvables for a Node in a Path */
-    $lazyResolveEnteringState.$inject = ['$state$', '$transition$'];
+    (<any> $lazyResolveEnteringState).$inject = ['$state$', '$transition$'];
     function $lazyResolveEnteringState($state$, $transition$) {
       let node = find(<any[]> treeChanges.entering, propEq('state', $state$));
       return node.resolveContext.resolvePathElement(node.state, extend({transition: $transition$}, { resolvePolicy: LAZY }));
diff --git a/src/state/hooks/transitionManager.ts b/src/state/hooks/transitionManager.ts
@@ -1,5 +1,4 @@
 /** @module state */ /** for typedoc */
-import {IPromise, IQService} from "angular";
 import {copy} from "../../common/common";
 import {prop} from "../../common/hof";
 import {Queue} from "../../common/queue";
@@ -45,7 +44,7 @@ export class TransitionManager {
       private $view, // service
       private $state: StateService,
       private $stateParams, // service/obj
-      private $q: IQService, // TODO: get from runtime.$q
+      private $q, // TODO: get from runtime.$q
       private activeTransQ: Queue<Transition>,
       private changeHistory: Queue<TreeChanges>
   ) {
@@ -61,7 +60,7 @@ export class TransitionManager {
     this.resolveHooks.registerHooks();
   }
 
-  runTransition(): IPromise<any> {
+  runTransition(): Promise<any> {
     this.activeTransQ.clear();  // TODO: nuke this
     this.activeTransQ.enqueue(this.transition);
     this.$state.transition = this.transition;
@@ -92,7 +91,7 @@ export class TransitionManager {
     this.updateStateParams();
   }
 
-  transRejected(error): (StateDeclaration|IPromise<any>) {
+  transRejected(error): (StateDeclaration|Promise<any>) {
     let {transition, $state, $stateParams, $q} = this;
     // Handle redirect and abort
     if (error instanceof TransitionRejection) {
diff --git a/src/state/hooks/viewHooks.ts b/src/state/hooks/viewHooks.ts
@@ -1,5 +1,4 @@
 /** @module state */ /** for typedoc */
-import {IPromise} from "angular";
 import {find, noop} from "../../common/common";
 import {propEq} from "../../common/hof";
 import {services} from "../../common/coreservices";
@@ -15,7 +14,7 @@ export class ViewHooks {
   private enteringViews: ViewConfig[];
   private exitingViews: ViewConfig[];
   private transition: Transition;
-  private $view; // service
+  private $view: ViewService; // service
 
   constructor(transition: Transition, $view: ViewService) {
     this.transition = transition;
@@ -29,7 +28,7 @@ export class ViewHooks {
   loadAllEnteringViews() {
     const loadView = (vc: ViewConfig) => {
       let resolveInjector = find(this.treeChanges.to, propEq('state', vc.context)).resolveInjector;
-      return <IPromise<ViewConfig>> this.$view.load(vc, resolveInjector);
+      return <Promise<ViewConfig>> this.$view.load(vc, resolveInjector);
     };
     return services.$q.all(this.enteringViews.map(loadView)).then(noop);
   }
diff --git a/src/state/interface.ts b/src/state/interface.ts
@@ -1,6 +1,4 @@
 /** @module state */ /** for typedoc */
-import {IPromise} from "angular";
-
 import {TransitionOptions} from "../transition/interface";
 import {ParamDeclaration, RawParams, ParamsOrArray} from "../params/interface";
 
@@ -417,10 +415,10 @@ export interface StateService {
   current:      StateDeclaration;
   $current:     State;
   transition:   Transition;
-  reload        (stateOrName: StateOrName): IPromise<State>;
+  reload        (stateOrName: StateOrName): Promise<State>;
   target        (identifier: StateOrName, params: ParamsOrArray, options: TransitionOptions): TargetState;
-  go            (to: StateOrName, params: RawParams, options: TransitionOptions): IPromise<State>;
-  transitionTo  (to: StateOrName, toParams: ParamsOrArray, options: TransitionOptions): IPromise<State>;
+  go            (to: StateOrName, params: RawParams, options: TransitionOptions): Promise<State>;
+  transitionTo  (to: StateOrName, toParams: ParamsOrArray, options: TransitionOptions): Promise<State>;
   is            (stateOrName: StateOrName, params?: RawParams, options?: TransitionOptions): boolean;
   includes      (stateOrName: StateOrName, params?: RawParams, options?: TransitionOptions): boolean;
   href          (stateOrName: StateOrName, params?: RawParams, options?: HrefOptions): string;
diff --git a/src/state/state.ts b/src/state/state.ts
@@ -3,6 +3,7 @@ import {isObject} from "../common/predicates";
 import {bindFunctions} from "../common/common";
 import {BuilderFunction} from "./module";
 import {StateRegistry} from "./stateRegistry";
+import {State} from "./stateObject";
 
 /**
  * @ngdoc object
diff --git a/src/state/stateService.ts b/src/state/stateService.ts
diff --git a/src/transition/transition.ts b/src/transition/transition.ts
diff --git a/src/transition/transitionHook.ts b/src/transition/transitionHook.ts
diff --git a/src/transition/transitionService.ts b/src/transition/transitionService.ts
diff --git a/src/ui-router.ts b/src/ui-router.ts
diff --git a/src/url/urlMatcherConfig.ts b/src/url/urlMatcherConfig.ts
diff --git a/src/url/urlMatcherFactory.ts b/src/url/urlMatcherFactory.ts
diff --git a/src/url/urlRouter.ts b/src/url/urlRouter.ts
diff --git a/src/view/templateFactory.ts b/src/view/templateFactory.ts
diff --git a/test/hookBuilderSpec.ts b/test/hookBuilderSpec.ts

Original file line number	Diff line number	Diff line change
`@@ -43,11 +43,11 @@ function stringify(o) {`
`43`	`43`	`return JSON.stringify(o, (key, val) => format(val)).replace(/\\"/g, '"');`
`44`	`44`	`}`
`45`	`45`
`46`		`-enum Category {`
	`46`	`+export enum Category {`
`47`	`47`	`RESOLVE, TRANSITION, HOOK, INVOKE, UIVIEW, VIEWCONFIG`
`48`	`48`	`}`
`49`	`49`
`50`		`-class Trace {`
	`50`	`+export class Trace {`
`51`	`51`	`approximateDigests: number;`
`52`	`52`
`53`	`53`	`constructor() {`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+/// <reference path='../typings/angularjs/angular.d.ts' />`
	`2`	`+/// <reference path='../typings/es6-shim/es6-shim.d.ts' />`
`1`	`3`	`/**`
`2`	`4`	`* Main entry point for angular 1.x build`
`3`	`5`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`/** @module state / /* for typedoc */`
`2`		`-/// <reference path='../../typings/angularjs/angular.d.ts' />`
`3`	`2`
`4`	`3`	`/**`
`5`	`4`	`* @ngdoc filter`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`/** @module view / /* for typedoc */`
`2`		`-/// <reference path='../../typings/angularjs/angular.d.ts' />`
`3`	`2`	`import {IServiceProviderFactory} from "angular";`
`4`	`3`
`5`	`4`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -214,7 +214,7 @@ export interface ParamDeclaration {`
`214`	`214`	`dynamic: boolean;`
`215`	`215`	`}`
`216`	`216`
`217`		`-interface Replace {`
	`217`	`+export interface Replace {`
`218`	`218`	`from: string;`
`219`	`219`	`to: string;`
`220`	`220`	`}`