refactor(all): adjust interfaces/impl, add router events export

.vscode/settings.json

@@ -1,3 +1,4 @@
 {
-  "typescript.tsdk": "aurelia-router/node_modules/typescript/lib"
+  "typescript.tsdk": "aurelia-router/node_modules/typescript/lib",
+  "tslint.autoFixOnSave": true
 }

build/scripts/build.js

@@ -33,7 +33,7 @@ function generateDts() {
   console.log('\n==============\nGenerating dts bundle...\n==============');
   return new Promise(resolve => {
     const ChildProcess = require('child_process');
-    ChildProcess.exec('npm run bundle-dts', (err, stdout, stderr) => {
+    ChildProcess.exec('npm run build:dts', (err, stdout, stderr) => {
       if (err || stderr) {
         console.log('Generating dts error:');
         console.log(stderr);

package.json

@@ -14,7 +14,7 @@
   "author": "Rob Eisenberg <rob@bluespire.com> (http://robeisenberg.com/)",
   "main": "dist/commonjs/aurelia-router.js",
   "module": "dist/es2015/aurelia-router.js",
-  "typings": "dist/index.d.ts",
+  "typings": "dist/aurelia-router.d.ts",
   "repository": {
     "type": "git",
     "url": "http://github.com/aurelia/router"
@@ -23,8 +23,10 @@
     "start": "npm run dev -- --format es2015",
     "dev": "node build/scripts/dev",
     "build": "node build/scripts/build",
-    "bundle-dts": "dts-bundle-generator -o dist/index.d.ts src/index.ts",
-    "test": "karma start",
+    "build:dts": "dts-bundle-generator -o dist/aurelia-router.d.ts src/aurelia-router.ts",
+    "test": "karma start --single-run",
+    "test:watch": "karma start",
+    "test:debugger": "karma ",
     "lint": "tslint -c tslint.json '{src,test}/**/*.ts' --force"
   },
   "jspm": {
@@ -58,7 +60,7 @@
     "aurelia-history": "^1.1.0",
     "aurelia-logging": "^1.0.0",
     "aurelia-path": "^1.0.0",
-    "aurelia-route-recognizer": "^1.2.0"
+    "aurelia-route-recognizer": "^1.3.2"
   },
   "devDependencies": {
     "@types/jasmine": "^2.8.8",

src/activation.ts

@@ -1,9 +1,8 @@
-import { activationStrategy } from './navigation-plan';
+import { Next, ViewPortComponent, ViewPortPlan } from './interfaces';
 import { isNavigationCommand } from './navigation-commands';
 import { NavigationInstruction } from './navigation-instruction';
-import { Next } from './pipeline';
+import { activationStrategy } from './navigation-plan';
 import { Router } from './router';
-import { ViewPortComponent, ViewPortPlan } from './interfaces';
 
 export class CanDeactivatePreviousStep {
   run(navigationInstruction: NavigationInstruction, next: Next) {

src/index.ts → src/aurelia-router.ts

@@ -8,6 +8,7 @@ export {
   ConfiguresRouter,
   RouteConfig,
   NavigationResult,
+  Next,
   PipelineResult,
   PipelineStep,
   ViewPort,
@@ -32,8 +33,17 @@ export {
   NavigationInstruction,
   NavigationInstructionInit
 } from './navigation-instruction';
+
+// export {
+//   PipelineStatus
+// } from './pipeline-status';
+
+export {
+  RouterEvent
+} from './router-events';
+
 export { PipelineProvider } from './pipeline-provider';
-export { Pipeline, Next, pipelineStatus } from './pipeline';
+export { Pipeline } from './pipeline';
 export { RouteLoader, LoadRouteStep } from './route-loading';
 export { RouterConfiguration } from './router-configuration';
 export { Router } from './router';

src/interfaces.ts

@@ -4,7 +4,6 @@ import { Router } from './router';
 import { NavModel } from './nav-model';
 import { RouterConfiguration } from './router-configuration';
 import { NavigationCommand } from './navigation-commands';
-import { Next } from './pipeline';
 import { IObservable } from './activation';
 
 /**@internal */
@@ -297,3 +296,30 @@ export interface ViewPortInstruction {
 export type NavigationResult = boolean | Promise<PipelineResult | boolean>;
 
 export type LifecycleArguments = [Record<string, string>, RouteConfig, NavigationInstruction];
+
+/**
+* A callback to indicate when pipeline processing should advance to the next step
+* or be aborted.
+*/
+export interface Next {
+  /**
+  * Indicates the successful completion of the pipeline step.
+  */
+  (): Promise<any>;
+  /**
+  * Indicates the successful completion of the entire pipeline.
+  */
+  complete: (result?: any) => Promise<any>;
+
+  /**
+  * Indicates that the pipeline should cancel processing.
+  */
+  cancel: (result?: any) => Promise<any>;
+
+  /**
+  * Indicates that pipeline processing has failed and should be stopped.
+  */
+  reject: (result?: any) => Promise<any>;
+}
+
+export type StepRunnerFunction = <TThis = any>(this: TThis, instruction: NavigationInstruction, next: Next) => any;

src/navigation-plan.ts

@@ -1,7 +1,6 @@
+import { ActivationStrategy, Next, ViewPortPlan } from './interfaces';
 import { Redirect } from './navigation-commands';
 import { NavigationInstruction } from './navigation-instruction';
-import { ActivationStrategy, ViewPortPlan } from './interfaces';
-import { Next } from './pipeline';
 
 /**
 * The strategy to use when activating modules during navigation.

src/next.ts

@@ -0,0 +1,40 @@
+import { PipelineStatus } from './pipeline-status';
+import { NavigationInstruction } from './navigation-instruction';
+import { Next, StepRunnerFunction } from './interfaces';
+
+/**@internal exported for unit testing */
+export function createNextFn(instruction: NavigationInstruction, steps: StepRunnerFunction[]): Next {
+  let index = -1;
+  const next: Next = function() {
+    index++;
+
+    if (index < steps.length) {
+      let currentStep = steps[index];
+
+      try {
+        return currentStep(instruction, next);
+      } catch (e) {
+        return next.reject(e);
+      }
+    } else {
+      return next.complete();
+    }
+  } as Next;
+
+  next.complete = createCompletionHandler(next, PipelineStatus.completed);
+  next.cancel = createCompletionHandler(next, PipelineStatus.canceled);
+  next.reject = createCompletionHandler(next, PipelineStatus.rejected);
+
+  return next;
+}
+
+
+/**@internal exported for unit testing */
+export function createCompletionHandler(next: Next, status: PipelineStatus) {
+  return (output: any) => Promise
+    .resolve({
+      status,
+      output,
+      completed: status === PipelineStatus.completed
+    });
+}

src/pipeline-status.ts

@@ -0,0 +1,9 @@
+/**
+* The status of a Pipeline.
+*/
+export enum PipelineStatus {
+  completed = 'completed',
+  canceled = 'canceled',
+  rejected = 'rejected',
+  running = 'running'
+}

src/pipeline.ts

@@ -1,58 +1,16 @@
-import { PipelineStep, PipelineResult } from './interfaces';
+import { PipelineStep, PipelineResult, Next, StepRunnerFunction } from './interfaces';
 import { NavigationInstruction } from './navigation-instruction';
-
-export interface PipeLineStatus {
-  completed: 'completed';
-  canceled: 'canceled';
-  rejected: 'rejected';
-  running: 'running';
-}
-
-export type PipeLineStatusType = PipeLineStatus[keyof PipeLineStatus];
-
-/**
-* The status of a Pipeline.
-*/
-export const pipelineStatus: PipeLineStatus = {
-  completed: 'completed',
-  canceled: 'canceled',
-  rejected: 'rejected',
-  running: 'running'
-};
-
-/**
-* A callback to indicate when pipeline processing should advance to the next step
-* or be aborted.
-*/
-export interface Next {
-  /**
-  * Indicates the successful completion of the pipeline step.
-  */
-  (): Promise<any>;
-  /**
-  * Indicates the successful completion of the entire pipeline.
-  */
-  complete: (result?: any) => Promise<any>;
-
-  /**
-  * Indicates that the pipeline should cancel processing.
-  */
-  cancel: (result?: any) => Promise<any>;
-
-  /**
-  * Indicates that pipeline processing has failed and should be stopped.
-  */
-  reject: (result?: any) => Promise<any>;
-}
+import { createNextFn } from './next';
 
 /**
 * The class responsible for managing and processing the navigation pipeline.
 */
 export class Pipeline {
   /**
-  * The pipeline steps.
+  * The pipeline steps. And steps added via addStep will be converted to a function
+  * The actualy running functions with correct step contexts of this pipeline
   */
-  steps: Array<Function | PipelineStep> = [];
+  steps: StepRunnerFunction[] = [];
 
   /**
   * Adds a step to the pipeline.
@@ -86,35 +44,7 @@ export class Pipeline {
   * @param instruction The navigation instruction to process.
   */
   run(instruction: NavigationInstruction): Promise<PipelineResult> {
-    let index = -1;
-    const steps = this.steps;
-
-    const next: Next = function() {
-      index++;
-
-      if (index < steps.length) {
-        let currentStep = steps[index];
-
-        try {
-          return (currentStep as Function)(instruction, next);
-        } catch (e) {
-          return next.reject(e);
-        }
-      } else {
-        return next.complete();
-      }
-    } as Next;
-
-    next.complete = createCompletionHandler(next, pipelineStatus.completed);
-    next.cancel = createCompletionHandler(next, pipelineStatus.canceled);
-    next.reject = createCompletionHandler(next, pipelineStatus.rejected);
-
-    return next();
+    const nextFn = createNextFn(instruction, this.steps);
+    return nextFn();
   }
 }
-
-function createCompletionHandler(next: Next, status: PipeLineStatusType) {
-  return (output: any) => {
-    return Promise.resolve({ status, output, completed: status === pipelineStatus.completed });
-  };
-}

src/route-loading.ts

@@ -1,9 +1,8 @@
-import { activationStrategy, _buildNavigationPlan } from './navigation-plan';
-import { NavigationInstruction } from './navigation-instruction';
-import { ViewPortInstruction, RouteConfig, ViewPortComponent, ViewPortPlan } from './interfaces';
+import { Next, RouteConfig, ViewPortComponent, ViewPortPlan } from './interfaces';
 import { Redirect } from './navigation-commands';
+import { NavigationInstruction } from './navigation-instruction';
+import { activationStrategy, _buildNavigationPlan } from './navigation-plan';
 import { Router } from './router';
-import { Next } from './pipeline';
 
 export class RouteLoader {
   loadRoute(router: Router, config: RouteConfig, navigationInstruction: NavigationInstruction): Promise<ViewPortComponent> {

src/router-configuration.ts

@@ -177,7 +177,7 @@ export class RouterConfiguration {
     }
 
     if (this.unknownRouteConfig) {
-      router.handleUnknownRoutes(this.unknownRouteConfig);
+      router.handleUnknownRoutes(this.unknownRouteConfig as any);
     }
 
     if (this._fallbackRoute) {

src/router-events.ts

@@ -0,0 +1,8 @@
+export enum RouterEvent {
+  processing = 'router:navigation:processing',
+  error = 'router:navigation:error',
+  canceled = 'router:navigation:canceled',
+  complete = 'router:navigation:complete',
+  success = 'router:navigation:success',
+  childComplete = 'router:navigation:child:complete'
+}

src/router.ts

@@ -336,14 +336,14 @@ export class Router {
     // to the childRoute property of params for the childRouter to recognize. When generating routes, we
     // use the childRecognizer when childRoute params are available to generate a child router enabled route.
     let recognizer = 'childRoute' in params ? this._childRecognizer : this._recognizer;
-    let hasRoute = recognizer.hasRoute(nameOrRoute);
+    let hasRoute = recognizer.hasRoute(nameOrRoute as string | RouteHandler);
     if (!hasRoute) {
       if (this.parent) {
         return this.parent.generate(nameOrRoute, params, options);
       }
       throw new Error(`A route with name '${nameOrRoute}' could not be found. Check that \`name: '${nameOrRoute}'\` was specified in the route's config.`);
     }
-    let path = recognizer.generate(nameOrRoute, params);
+    let path = recognizer.generate(nameOrRoute as string | RouteHandler, params);
     let rootedPath = _createRootedPath(path, this.baseUrl, this.history._hasPushState, options.absolute);
     return options.absolute ? `${this.history.getAbsoluteRoot()}${rootedPath}` : rootedPath;
   }
@@ -643,7 +643,7 @@ export class Router {
     instruction: NavigationInstruction
   ) {
     return Promise.resolve(config)
-      .then(c => {
+      .then((c: any) => {
         if (typeof c === 'string') {
           return { moduleId: c } as RouteConfig;
         } else if (typeof c === 'function') {
@@ -652,8 +652,8 @@ export class Router {
 
         return c;
       })
-      .then(c => typeof c === 'string' ? { moduleId: c } as RouteConfig : c)
-      .then(c => {
+      .then((c: string | RouteConfig) => typeof c === 'string' ? { moduleId: c } as RouteConfig : c)
+      .then((c: RouteConfig) => {
         c.route = instruction.params.path;
         validateRouteConfig(c, this.routes);
 

test/activation.spec.ts

@@ -10,7 +10,7 @@ import {
   ActivateNextStep,
   NavigationInstructionInit,
   ViewPortPlan
-} from '../src';
+} from '../src/aurelia-router';
 import { ValueOf, createPipelineState, MockPipelineState, MockInstruction } from './shared';
 
 describe('activation', () => {

test/app-router.spec.ts

@@ -14,7 +14,7 @@ import {
   ViewPortInstruction,
   ViewPort,
   PipelineStep
-} from '../src';
+} from '../src/aurelia-router';
 import { MockHistory, MockInstruction } from './shared';
 import { EventAggregator } from 'aurelia-event-aggregator';
 import { History } from 'aurelia-history';