feature: add responseInterceptor (#61)

Author: wardbell

CHANGELOG.md

@@ -1,5 +1,9 @@
 # "angular-in-memory-web-api" versions
 
+<a name="0.1.14"></a>
+## 0.1.14 (2016-10-29)
+* Add `responseInterceptor` for [issue #61](https://github.com/angular/in-memory-web-api/issues/61)
+
 <a name="0.1.13"></a>
 ## 0.1.13 (2016-10-20)
 * Update README for 0.1.11 breaking change: npm publish as `esm` and a `umd` bundle

README.md

@@ -118,6 +118,15 @@ Request URLs for your api may not match the api imagined by the default `parseUr
 You can override the default by implementing a `parseUrl` method in your `InMemoryDbService`.
 Such a method must take the incoming request URL string and return a `ParsedUrl` object. 
 
+## _responseInterceptor_
+
+You can morph the response returned by the default HTTP methods, called by `collectionHandler`, 
+to suit your needs by adding a `responseInterceptor` method to your `InMemoryDbService` class. 
+The `collectionHandler` calls your interceptor like this:
+```ts
+responseOptions = this.responseInterceptor(responseOptions, requestInfo);
+```
+
 ## HTTP method interceptors
 
 If you make requests this service can't handle but still want an in-memory database to hold values,

bundles/in-memory-web-api.umd.js

@@ -530,6 +530,14 @@ var InMemoryBackendConfig = (function () {
  */
 function isSuccess(status) { return status >= 200 && status < 300; }
 
+/**
+ * The `responseInterceptor` can morph the response from `collectionHandler`
+ * Default just returns the response.
+ * Override with an `responseInterceptor` method in your `inMemDbService`
+ */
+function responseInterceptor(res, ri) {
+    return res;
+}
 /**
  * Set the status text in a response:
  */
@@ -584,6 +592,7 @@ var InMemoryBackendService = (function () {
         this.config.host = loc.host;
         this.config.rootPath = loc.pathname;
         Object.assign(this.config, config || {});
+        this.responseInterceptor = inMemDbService["responseInterceptor"] || responseInterceptor;
         this.setPassThruBackend();
     }
     InMemoryBackendService.prototype.createConnection = function (req) {
@@ -731,6 +740,7 @@ var InMemoryBackendService = (function () {
                 resOptions = createErrorResponse(STATUS.METHOD_NOT_ALLOWED, 'Method not allowed');
                 break;
         }
+        resOptions = this.responseInterceptor(resOptions, reqInfo);
         return this.createDelayedObservableResponse(resOptions);
     };
     /**
@@ -1003,6 +1013,7 @@ exports.createObservableResponse = createObservableResponse;
 exports.InMemoryDbService = InMemoryDbService;
 exports.InMemoryBackendConfig = InMemoryBackendConfig;
 exports.isSuccess = isSuccess;
+exports.responseInterceptor = responseInterceptor;
 exports.setStatusText = setStatusText;
 exports.InMemoryBackendService = InMemoryBackendService;
 exports.inMemoryBackendServiceFactory = inMemoryBackendServiceFactory;

examples/hero-data.service.ts

@@ -6,10 +6,11 @@
  */
 import {
   InMemoryDbService,
-  createErrorResponse, createObservableResponse, HttpMethodInterceptorArgs, ParsedUrl, STATUS
+  createErrorResponse, createObservableResponse, HttpMethodInterceptorArgs,
+  ParsedUrl, RequestInfo, STATUS
 } from 'angular-in-memory-web-api';
 
-import { ResponseOptions, URLSearchParams } from '@angular/http';
+import { RequestMethod, ResponseOptions, URLSearchParams } from '@angular/http';
 
 // For AoT compile
 /* tslint:disable:no-unused-variable */
@@ -61,6 +62,14 @@ export class HeroDataOverrideService extends HeroDataService {
     }
   }
 
+  // intercept response from the default HTTP method handlers
+  responseInterceptor(response: ResponseOptions, reqInfo: RequestInfo) {
+    const method = RequestMethod[reqInfo.req.method].toUpperCase();
+    const body = JSON.stringify(response.body);
+    console.log(`responseInterceptor: ${method} ${reqInfo.req.url}: \n${body}`);
+    return response;
+  }
+
   // HTTP GET interceptor
   protected get(interceptorArgs: HttpMethodInterceptorArgs) {
 

in-memory-backend.service.d.ts

@@ -104,6 +104,12 @@ export interface RequestInfo {
     query: URLSearchParams;
     resourceUrl: string;
 }
+/**
+ * The `responseInterceptor` can morph the response from `collectionHandler`
+ * Default just returns the response.
+ * Override with an `responseInterceptor` method in your `inMemDbService`
+ */
+export declare function responseInterceptor(res: ResponseOptions, ri: RequestInfo): ResponseOptions;
 /**
  * Set the status text in a response:
  */
@@ -158,6 +164,7 @@ export declare class InMemoryBackendService {
     protected passThruBackend: ConnectionBackend;
     protected config: InMemoryBackendConfigArgs;
     protected db: Object;
+    private responseInterceptor;
     constructor(injector: Injector, inMemDbService: InMemoryDbService, config: InMemoryBackendConfigArgs);
     createConnection(req: Request): Connection;
     /**

in-memory-backend.service.js

@@ -1 +1 @@
-{"__symbolic":"module","version":1,"metadata":{"createErrorResponse":{"__symbolic":"function","parameters":["status","message"],"value":{"__symbolic":"error","message":"Expression form not supported","line":20,"character":21}},"isSuccess":{"__symbolic":"function","parameters":["status"],"value":{"__symbolic":"binop","operator":"&&","left":{"__symbolic":"binop","operator":">=","left":{"__symbolic":"reference","name":"status"},"right":200},"right":{"__symbolic":"binop","operator":"<","left":{"__symbolic":"reference","name":"status"},"right":300}}}}}
+{"__symbolic":"module","version":1,"metadata":{"createErrorResponse":{"__symbolic":"function","parameters":["status","message"],"value":{"__symbolic":"error","message":"Expression form not supported","line":20,"character":21}},"isSuccess":{"__symbolic":"function","parameters":["status"],"value":{"__symbolic":"binop","operator":"&&","left":{"__symbolic":"binop","operator":">=","left":{"__symbolic":"reference","name":"status"},"right":200},"right":{"__symbolic":"binop","operator":"<","left":{"__symbolic":"reference","name":"status"},"right":300}}},"responseInterceptor":{"__symbolic":"function","parameters":["res","ri"],"value":{"__symbolic":"reference","name":"res"}}}}

in-memory-backend.service.js.map

@@ -1,6 +1,6 @@
 {
   "name": "angular-in-memory-web-api",
-  "version": "0.1.13",
+  "version": "0.1.14",
   "description": "An in-memory web api for Angular demos and tests",
   "main": "bundles/in-memory-web-api.umd.js",
   "module": "index.js",
@@ -36,7 +36,7 @@
     "@angular/http": "^2.0.0",
     "reflect-metadata": "~0.1.8",
     "rxjs": "5.0.0-beta.12",
-    "zone.js": "^0.6.25"
+    "zone.js": "^0.6.26"
   },
   "devDependencies": {
     "@angular/common": "~2.1.0",
@@ -49,7 +49,7 @@
     "@types/core-js": "^0.9.34",
     "@types/jasmine": "^2.5.36",
     "@types/node": "^6.0.46",
-    "angular-in-memory-web-api": "~0.1.12",
+    "angular-in-memory-web-api": "~0.1.13",
     "canonical-path": "0.0.2",
     "concurrently": "^3.0.0",
     "core-js": "^2.4.1",

in-memory-backend.service.metadata.json

@@ -153,6 +153,15 @@ export interface RequestInfo {
   resourceUrl: string;
 }
 
+/**
+ * The `responseInterceptor` can morph the response from `collectionHandler`
+ * Default just returns the response.
+ * Override with an `responseInterceptor` method in your `inMemDbService`
+ */
+export function responseInterceptor(res: ResponseOptions, ri: RequestInfo): ResponseOptions {
+  return res;
+}
+
 /**
  * Set the status text in a response:
  */
@@ -219,6 +228,7 @@ export class InMemoryBackendService {
   protected passThruBackend: ConnectionBackend;
   protected config: InMemoryBackendConfigArgs = new InMemoryBackendConfig();
   protected db: Object;
+  private responseInterceptor: typeof responseInterceptor;
 
   constructor(
     private injector: Injector,
@@ -232,6 +242,7 @@ export class InMemoryBackendService {
     this.config.rootPath = loc.pathname;
     Object.assign(this.config, config || {});
 
+    this.responseInterceptor = inMemDbService[`responseInterceptor`] || responseInterceptor;
     this.setPassThruBackend();
   }
 
@@ -390,6 +401,8 @@ export class InMemoryBackendService {
         resOptions = createErrorResponse(STATUS.METHOD_NOT_ALLOWED, 'Method not allowed');
         break;
     }
+
+    resOptions = this.responseInterceptor(resOptions, reqInfo);
     return this.createDelayedObservableResponse(resOptions);
   }