fix: Do NOT encapsulate by default - breaking change - v0.5 (#147)

Changes default `config.dataEncapsulation` from `true` to `false`.
This is a breaking change that affects almost all pre-existing apps. See the CHANGELOG.MD.

Also fixes README error in issue #146.

Closes #146

Author: wardbell

CHANGELOG.md

@@ -8,6 +8,30 @@ because this is a development tool, not a production product.
 We do try to tell you about such changes in this `CHANGELOG.md`
 and we fix bugs as fast as we can.
 
+<a id="0.5.0"></a>
+## 0.5.0 (2017-10-05)
+**BREAKING CHANGE**: HTTP response data no longer wrapped in object w/ `data` property by default.
+
+In this release, the `dataEncapsulation` configuration default changed from `false` to `true`. The HTTP response body holds the data values directly rather than an object that encapsulates those values, `{data: ...}`. This is a **breaking change that affects almost all existing apps!** 
+
+Changing the default to `false` is a **breaking change**. Pre-existing apps that did not set this property explicitly will be broken because they expect encapsulation and are probably mapping
+the HTTP response results from the `data` property like this:
+```
+  .map(data => data.data as Hero[])
+```
+**To migrate, simply remove that line everywhere.**
+
+If you would rather keep the web api's encapsulation, `{data: ...}`, set `dataEncapsulation` to `true` during configuration as in the following example:
+```
+HttpClientInMemoryWebApiModule.forRoot(HeroInMemDataService, { dataEncapsulation: true })
+```
+
+We made this change because
+* the [security flaw](http://stackoverflow.com/questions/3503102/what-are-top-level-json-arrays-and-why-are-they-a-security-risk)
+that data encapsulation tried to overcome has been fixed in most (if not all) browsers supported by Angular v2+.
+* data encapsulation is uncommon in modern web APIs.
+* removing the `.map` step simplifies usage of `HttpClient` in most scenarios.
+
 <a id="0.4.6"></a>
 ## 0.4.6 (2017-09-13)
 - improves README
@@ -63,6 +87,12 @@ to intercept Angular's attempt to call browser's XHR
 **Theme: Support `HttpClient` and add tests**.
 See PR #130.
 
+The 0.4.0 release was a major overhaul of this library.
+
+You don't have to change your existing application _code_ if your app uses this library without customizations. 
+
+But this release's **breaking changes** affect developers who used the customization features or loaded application files with SystemJS.
+
 **BREAKING CHANGES**: Massive refactoring.
 Many low-level and customization options have changed.
 Apps that stuck with defaults should be (mostly) OK.

README.md

@@ -7,18 +7,24 @@ that emulates CRUD operations over a RESTy API.
 It intercepts Angular `Http` and `HttpClient` requests that would otherwise go to the remote server and redirects them to an in-memory data store that you control.
 
 ---
-## **v0.4 supports `HttpClient`!**
->Release v0.4.0  (8 Sept 2017) was a major overhaul of this library.
->
->You don't have to change your existing application _code_ if your app uses this library without customizations. 
->
->
->The v0.4.0 release introduced **breaking changes** that affect developers who used the customization features or loaded application files with SystemJS.
->
->**Read this README and the [CHANGELOG](https://github.com/angular/in-memory-web-api/blob/master/CHANGELOG.md/#0.4.0)**
-to learn what's new and about **breaking changes**
->
->The new **unit tests** are a good way to see the in-memory web api in action.
+
+## Important recent changes
+
+### HTTP response data no longer wrapped in object w/ `data` property
+
+As of v0.5.0 (5 October 2017), the `dataEncapsulation` configuration default changed from `false` to `true`. The HTTP response body holds the data values directly rather than an object that encapsulates those values, `{data: ...}`. This is a **breaking change that affects almost all existing apps!** 
+
+See the [CHANGELOG](https://github.com/angular/in-memory-web-api/blob/master/CHANGELOG.md/#0.5.0) for the reason behind this change and how to quickly fix your code or revert to encapsulation.
+
+### v0.4 supports `HttpClient`
+Release v0.4.0  (8 Sept 2017) was a major overhaul of this library.
+
+The v0.4.0 release introduced **breaking changes** that affect developers who used the customization features or loaded application files with SystemJS.
+
+**Read this README and the [CHANGELOG](https://github.com/angular/in-memory-web-api/blob/master/CHANGELOG.md/#0.4.0)**
+to learn what's new and about other **breaking changes**.
+
+---
 
 ## Use cases
 
@@ -120,7 +126,7 @@ in your root `AppModule.imports`
 calling the `forRoot` static method with this service class and an optional configuration object:
 ```ts
 import { HttpClientModule } from '@angular/common/http';
-import { HttpClientInMemoryWebApiModule } from 'http-angular-in-memory-web-api';
+import { HttpClientInMemoryWebApiModule } from 'angular-in-memory-web-api';
 
 import { InMemHeroService } from '../app/hero.service';
 
@@ -148,7 +154,7 @@ You can still use the in-memory web api with the older `Http` module.
 
 ```ts
 import { HttpModule } from '@angular/http';
-import { HttpInMemoryWebApiModule } from 'http-angular-in-memory-web-api';
+import { HttpInMemoryWebApiModule } from 'angular-in-memory-web-api';
 
 import { InMemHeroService } from '../app/hero.service';
 
@@ -438,7 +444,7 @@ Follow these steps for updating the library.
 
 - update `CHANGELOG.md` to record the change. Call out _breaking changes_.
 
-- update `READM.md` if usage or interfaces change.
+- update `README.md` if usage or interfaces change.
 
 - consider updating the dependency versions in `package.json`.
 

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

@@ -59,6 +59,8 @@ gulp.task('clean', function() {
       './http-backend.service.*',
       './http-client-backend.service.*',
       './interfaces.*',
+      './http-in-memory-web-api.module.*',
+      './http-client-in-memory-web-api.module.*',
       './in-memory-web-api.module.*',
       './index.*',
       './bundles/in-memory-web-api.umd.js'

gulpfile.js

@@ -47,7 +47,8 @@ export declare abstract class InMemoryBackendConfigArgs {
      */
     caseSensitiveSearch?: boolean;
     /**
-     * true (default) encapsulate content in a `data` property inside the response body. false: put content directly inside the response body
+     * false (default) put content directly inside the response body.
+     * true: encapsulate content in a `data` property inside the response body, `{ data: ... }`.
      */
     dataEncapsulation?: boolean;
     /**

interfaces.d.ts

@@ -1 +1 @@
-[{"__symbolic":"module","version":3,"metadata":{"HeadersCore":{"__symbolic":"interface"},"InMemoryDbService":{"__symbolic":"class","members":{"createDb":[{"__symbolic":"method"}]}},"InMemoryBackendConfigArgs":{"__symbolic":"class"},"InMemoryBackendConfig":{"__symbolic":"class","decorators":[{"__symbolic":"call","expression":{"__symbolic":"reference","module":"@angular/core","name":"Injectable"}}],"members":{"__ctor__":[{"__symbolic":"constructor","parameters":[{"__symbolic":"reference","name":"InMemoryBackendConfigArgs"}]}]}},"parseUri":{"__symbolic":"function"},"ParsedRequestUrl":{"__symbolic":"interface"},"PassThruBackend":{"__symbolic":"interface"},"removeTrailingSlash":{"__symbolic":"function","parameters":["path"],"value":{"__symbolic":"error","message":"Expression form not supported","line":180,"character":22}},"RequestCore":{"__symbolic":"interface"},"RequestInfo":{"__symbolic":"interface"},"RequestInfoUtilities":{"__symbolic":"interface"},"ResponseOptions":{"__symbolic":"interface"},"UriInfo":{"__symbolic":"interface"}}},{"__symbolic":"module","version":1,"metadata":{"HeadersCore":{"__symbolic":"interface"},"InMemoryDbService":{"__symbolic":"class","members":{"createDb":[{"__symbolic":"method"}]}},"InMemoryBackendConfigArgs":{"__symbolic":"class"},"InMemoryBackendConfig":{"__symbolic":"class","decorators":[{"__symbolic":"call","expression":{"__symbolic":"reference","module":"@angular/core","name":"Injectable"}}],"members":{"__ctor__":[{"__symbolic":"constructor","parameters":[{"__symbolic":"reference","name":"InMemoryBackendConfigArgs"}]}]}},"parseUri":{"__symbolic":"function"},"ParsedRequestUrl":{"__symbolic":"interface"},"PassThruBackend":{"__symbolic":"interface"},"removeTrailingSlash":{"__symbolic":"function","parameters":["path"],"value":{"__symbolic":"error","message":"Expression form not supported","line":180,"character":22}},"RequestCore":{"__symbolic":"interface"},"RequestInfo":{"__symbolic":"interface"},"RequestInfoUtilities":{"__symbolic":"interface"},"ResponseOptions":{"__symbolic":"interface"},"UriInfo":{"__symbolic":"interface"}}}]
+[{"__symbolic":"module","version":3,"metadata":{"HeadersCore":{"__symbolic":"interface"},"InMemoryDbService":{"__symbolic":"class","members":{"createDb":[{"__symbolic":"method"}]}},"InMemoryBackendConfigArgs":{"__symbolic":"class"},"InMemoryBackendConfig":{"__symbolic":"class","decorators":[{"__symbolic":"call","expression":{"__symbolic":"reference","module":"@angular/core","name":"Injectable"}}],"members":{"__ctor__":[{"__symbolic":"constructor","parameters":[{"__symbolic":"reference","name":"InMemoryBackendConfigArgs"}]}]}},"parseUri":{"__symbolic":"function"},"ParsedRequestUrl":{"__symbolic":"interface"},"PassThruBackend":{"__symbolic":"interface"},"removeTrailingSlash":{"__symbolic":"function","parameters":["path"],"value":{"__symbolic":"error","message":"Expression form not supported","line":181,"character":22}},"RequestCore":{"__symbolic":"interface"},"RequestInfo":{"__symbolic":"interface"},"RequestInfoUtilities":{"__symbolic":"interface"},"ResponseOptions":{"__symbolic":"interface"},"UriInfo":{"__symbolic":"interface"}}},{"__symbolic":"module","version":1,"metadata":{"HeadersCore":{"__symbolic":"interface"},"InMemoryDbService":{"__symbolic":"class","members":{"createDb":[{"__symbolic":"method"}]}},"InMemoryBackendConfigArgs":{"__symbolic":"class"},"InMemoryBackendConfig":{"__symbolic":"class","decorators":[{"__symbolic":"call","expression":{"__symbolic":"reference","module":"@angular/core","name":"Injectable"}}],"members":{"__ctor__":[{"__symbolic":"constructor","parameters":[{"__symbolic":"reference","name":"InMemoryBackendConfigArgs"}]}]}},"parseUri":{"__symbolic":"function"},"ParsedRequestUrl":{"__symbolic":"interface"},"PassThruBackend":{"__symbolic":"interface"},"removeTrailingSlash":{"__symbolic":"function","parameters":["path"],"value":{"__symbolic":"error","message":"Expression form not supported","line":181,"character":22}},"RequestCore":{"__symbolic":"interface"},"RequestInfo":{"__symbolic":"interface"},"RequestInfoUtilities":{"__symbolic":"interface"},"ResponseOptions":{"__symbolic":"interface"},"UriInfo":{"__symbolic":"interface"}}}]

interfaces.js

@@ -1,6 +1,6 @@
 {
   "name": "angular-in-memory-web-api",
-  "version": "0.4.6",
+  "version": "0.5.0",
   "description": "An in-memory web api for Angular demos and tests",
   "main": "bundles/in-memory-web-api.umd.js",
   "module": "index.js",

interfaces.js.map

@@ -61,14 +61,15 @@ export class HeroInMemDataOverrideService extends HeroInMemDataService {
       console.log('HTTP GET override');
 
       const collection = villains.slice();
+      const dataEncapsulation = reqInfo.utils.getConfig().dataEncapsulation;
       const id = reqInfo.id;
 
       // tslint:disable-next-line:triple-equals
       const data = id == undefined ? collection : reqInfo.utils.findById(collection, id);
 
       const options: ResponseOptions = data ?
         {
-          body: { data },
+          body: dataEncapsulation ? { data } : data,
           status: STATUS.OK
         } :
         {