Merge branch 'develop' into feat/transform-plain-to-class

Author: cojack

.travis.yml

@@ -1,11 +1,8 @@
 language: node_js
 node_js:
   - stable
+  - 8
   - 6
-  - 5
-  - 4
-  - 0.12
-  - 0.11
 
 after_success:
-  - bash <(curl -s https://codecov.io/bash)
+  - bash <(curl -s https://codecov.io/bash)

CHANGELOG.md

@@ -0,0 +1,82 @@
+# Changelog and release notes
+
+### 0.1.10
+
+#### Fixed
+
+- improve MetadataStorage perf by changing from Arrays to ES6 Maps by @sheiidan
+- fixed getAncestor issue with unknown nested properties by @247GradLabs
+
+### 0.1.9
+
+#### Fixed
+
+- objects with `null` prototype are converted properly now
+- objects with unknown non primitive properties are converted properly now
+- corrected a typo in the README.md
+- fixed the deserialize example in the README.md
+
+### 0.1.4
+
+#### Added
+
+- added `TransformClassToPlain` and `TransformClassToClass` decorators
+
+### 0.1.0
+
+#### Added
+
+- renamed library from `constructor-utils` to `class-transformer`
+- completely renamed most of names
+- renamed all main methods: `plainToConstructor` now is `plainToClass` and `constructorToPlain` is `classToPlain`, etc.
+- `plainToConstructorArray` method removed - now `plainToClass` handles it
+- `@Skip()` decorator renamed to `@Exclude()`
+- added `@Expose` decorator
+- added lot of new options: groups, versioning, custom names, etc.
+- methods and getters that should be exposed must be decorated with `@Expose` decorator
+- added `excludedPrefix` to class transform options that allows exclude properties that start with one of the given prefix
+
+### 0.0.22
+
+#### Fixed
+
+- fixed array with primitive types being converted
+
+### 0.0.18-0.0.21
+
+#### Fixed
+
+- fixed bugs when getters are not converted with es6 target
+
+### 0.0.17
+
+#### Fixed
+
+- fixed issue #4
+- added type guessing during transformation from constructor to plain object
+- added sample with generics
+
+### 0.0.16
+
+#### Changed
+
+- renamed `constructor-utils/constructor-utils` to `constructor-utils` package namespace
+
+### 0.0.15
+
+#### Removed
+
+- removed code mappings from package
+
+### 0.0.14
+
+#### Removed
+
+- removed `import "reflect-metadata"` from source code. Now reflect metadata should be included like any other shims.
+
+### 0.0.13
+
+#### Changed
+
+- Library has changed its name from `serializer.ts` to `constructor-utils`.
+- Added `constructor-utils` namespace.

LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2015-2016 Umed Khudoiberdiev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -1,11 +1,10 @@
 # class-transformer
 
-[![Build Status](https://travis-ci.org/pleerock/class-transformer.svg?branch=master)](https://travis-ci.org/pleerock/class-transformer)
-[![codecov](https://codecov.io/gh/pleerock/class-transformer/branch/master/graph/badge.svg)](https://codecov.io/gh/pleerock/class-transformer)
+[![Build Status](https://travis-ci.org/typestack/class-transformer.svg?branch=master)](https://travis-ci.org/typestack/class-transformer)
+[![codecov](https://codecov.io/gh/typestack/class-transformer/branch/master/graph/badge.svg)](https://codecov.io/gh/typestack/class-transformer)
 [![npm version](https://badge.fury.io/js/class-transformer.svg)](https://badge.fury.io/js/class-transformer)
-[![Dependency Status](https://david-dm.org/pleerock/class-transformer.svg)](https://david-dm.org/pleerock/class-transformer)
-[![devDependency Status](https://david-dm.org/pleerock/class-transformer/dev-status.svg)](https://david-dm.org/pleerock/class-transformer#info=devDependencies)
-[![Join the chat at https://gitter.im/pleerock/class-transformer](https://badges.gitter.im/pleerock/class-transformer.svg)](https://gitter.im/pleerock/class-transformer?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![Dependency Status](https://david-dm.org/typestack/class-transformer.svg)](https://david-dm.org/typestack/class-transformer)
+[![Join the chat at https://gitter.im/typestack/class-transformer](https://badges.gitter.im/typestack/class-transformer.svg)](https://gitter.im/typestack/class-transformer?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 Its ES6 and Typescript era. Nowadays you are working with classes and constructor objects more then ever.
 Class-transformer allows you to transform plain object to some instance of class and versa.
@@ -225,14 +224,14 @@ You can deserialize your model to from a json using `deserialize` method:
 
 ```typescript
 import {deserialize} from "class-transformer";
-let photo = deserialize(photo);
+let photo = deserialize(Photo, photo);
 ```
 
 To make deserialization to work with arrays use `deserializeArray` method:
 
 ```typescript
 import {deserializeArray} from "class-transformer";
-let photos = deserializeArray(photos);
+let photos = deserializeArray(Photo, photos);
 ```
 
 ## Working with nested objects
@@ -566,8 +565,33 @@ export class Photo {
 
 Library will handle proper transformation automatically.
 
+ES6 collections `Set` and `Map` also require the `@Type` decorator:
+
+```typescript
+export class Skill {
+    name: string;
+}
+
+export class Weapon {
+    name: string;
+    range: number;
+}
+
+export class Player {
+    name: string;
+
+    @Type(() => Skill)
+    skills: Set<Skill>;
+
+    @Type(() => Weapon)
+    weapons: Map<string, Weapon>;
+}
+```
+
 ## Additional data transformation
 
+### Basic usage
+
 You can perform additional data transformation using `@Transform` decorator.
 For example, you want to make your `Date` object to be a `moment` object when you are
 transforming object from plain to class:
@@ -591,6 +615,20 @@ Now when you call `plainToClass` and send a plain representation of the Photo ob
 it will convert a date value in your photo object to moment date. 
 `@Transform` decorator also supports groups and versioning.
 
+### Advanced usage
+
+The `@Transform` decorator is given more arguments to let you configure how you want the transformation to be done.
+
+```
+@Transform((value, obj, type) => value)
+```
+
+| Argument          | Description
+|--------------------|---------------------------------------------------------------------------------|
+| `value` | The property value before the transformation.
+| `obj` | The transformation source object. 
+| `type` | The transformation type.
+
 ## Other decorators
 | Signature          | Example                                  | Description
 |--------------------|------------------------------------------|---------------------------------------------|
@@ -644,7 +682,7 @@ the exposed variables. email property is also exposed becuase we metioned the gr
 ## Working with generics
 
 Generics are not supported because TypeScript does not have good reflection abilities yet.
-Once TypeScript team provide us better runtime type reelection tools, generics will be implemented.
+Once TypeScript team provide us better runtime type reflection tools, generics will be implemented.
 There are some tweaks however you can use, that maybe can solve your problem.
 [Checkout this example.](https://github.com/pleerock/class-transformer/tree/master/sample/sample4-generics)
 
@@ -667,7 +705,7 @@ this.http
     .map(res => res.json())
     .map(res => plainToClass(User, res as Object[]))
     .subscribe(users => {
-        // now "users" is type of User[] and each user have getName() and isAdult() methods available
+        // now "users" is type of User[] and each user has getName() and isAdult() methods available
         console.log(users);
     });
 ```