merge: release 0.5.1 (#1003)

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 _This changelog follows the [keep a changelog][keep-a-changelog]_ format to maintain a human readable changelog.
 
+### [0.5.1][v0.5.1] [BREAKING CHANGE] - 2021-11-22
+
+#### Changed
+
+- re-added accidentally removed deprecated function names `classToPlain` and `plainToClass`
+
 ### [0.5.0][v0.5.0] [BREAKING CHANGE] - 2021-11-20
 
 > **NOTE:** This version fixes a security vulnerability allowing denial of service attacks with a specially crafted request payload. Please update as soon as possible.
@@ -229,6 +235,7 @@ This version has introduced a breaking-change when this library is used with cla
 - Library has changed its name from `serializer.ts` to `constructor-utils`.
 - Added `constructor-utils` namespace.
 
+[v0.5.1]: https://github.com/typestack/class-transformer/compare/v0.5.0...v0.5.1
 [v0.5.0]: https://github.com/typestack/class-transformer/compare/v0.4.1...v0.5.0
 [v0.4.1]: https://github.com/typestack/class-transformer/compare/v0.4.0...v0.4.1
 [v0.4.0]: https://github.com/typestack/class-transformer/compare/v0.3.2...v0.4.0

package.json

@@ -1,6 +1,6 @@
 {
   "name": "class-transformer",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "description": "Proper decorator-based transformation / serialization / deserialization of plain javascript objects to class constructors",
   "author": "TypeStack contributors",
   "license": "MIT",
@@ -63,11 +63,11 @@
     "eslint-plugin-jest": "^25.2.4",
     "husky": "^4.3.8",
     "jest": "^26.6.3",
-    "lint-staged": "^12.0.3",
+    "lint-staged": "^12.1.2",
     "prettier": "^2.4.1",
     "reflect-metadata": "0.1.13",
     "rimraf": "3.0.2",
-    "rollup": "^2.60.0",
+    "rollup": "^2.60.1",
     "rollup-plugin-terser": "^7.0.2",
     "ts-jest": "^26.5.6",
     "ts-node": "^10.4.0",

src/index.ts

@@ -9,6 +9,20 @@ export * from './enums';
 
 const classTransformer = new ClassTransformer();
 
+/**
+ * Converts class (constructor) object to plain (literal) object. Also works with arrays.
+ *
+ * @deprecated Function name changed, use the `instanceToPlain` method instead.
+ */
+export function classToPlain<T>(object: T, options?: ClassTransformOptions): Record<string, any>;
+export function classToPlain<T>(object: T[], options?: ClassTransformOptions): Record<string, any>[];
+export function classToPlain<T>(
+  object: T | T[],
+  options?: ClassTransformOptions
+): Record<string, any> | Record<string, any>[] {
+  return classTransformer.instanceToPlain(object, options);
+}
+
 /**
  * Converts class (constructor) object to plain (literal) object. Also works with arrays.
  */
@@ -46,6 +60,17 @@ export function classToPlainFromExist<T>(
   return classTransformer.classToPlainFromExist(object, plainObject, options);
 }
 
+/**
+ * Converts plain (literal) object to class (constructor) object. Also works with arrays.
+ *
+ * @deprecated Function name changed, use the `plainToInstance` method instead.
+ */
+export function plainToClass<T, V>(cls: ClassConstructor<T>, plain: V[], options?: ClassTransformOptions): T[];
+export function plainToClass<T, V>(cls: ClassConstructor<T>, plain: V, options?: ClassTransformOptions): T;
+export function plainToClass<T, V>(cls: ClassConstructor<T>, plain: V | V[], options?: ClassTransformOptions): T | T[] {
+  return classTransformer.plainToInstance(cls, plain as any, options);
+}
+
 /**
  * Converts plain (literal) object to class (constructor) object. Also works with arrays.
  */