@dipscope/type-manager 4.0.0 → 4.0.3

package/CHANGELOG.md

@@ -5,6 +5,35 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [4.0.3] - 2022-05-07
+
+### Added
+
+- Getters of serialized and deserialized property names for property metadata.
+
+### Removed
+
+- Definition logic of serialized and deserialized property names from type serializer.
+
+### Fixed
+
+- Serialized property name was displayed in log messages.
+
+## [4.0.2] - 2022-05-01
+
+### Changed
+
+- Used symbol instead of string based key to store type metadata.
+- Avoid complete reset of custom data by providing `null` as argument.
+- Code style improvements.
+
+## [4.0.1] - 2021-08-01
+
+### Changed
+
+- Custom data options are now behave like built in configure options.
+- Path reference handler is now using path traversal instead of direct evaluation for resolving references.
+
 ## [4.0.0] - 2021-03-24
 
 ### Added

package/README.md

@@ -4,6 +4,12 @@
 
 Type manager is a parsing package for `TypeScript` which will help you to transform JSON strings or plain objects into `JavaScript` object instances. It supports [decorators](https://www.typescriptlang.org/docs/handbook/decorators.html) or declarative configuration and allows you to configure parsing of your or 3rd party classes easily.
 
+We recommend to use our [official website](https://dipscope.com/type-manager/what-issues-it-solves) to navigate through available features. You can also use the latest documentation described below.
+
+## Give a star :star:
+
+If you like or are using this project please give it a star. Thanks!
+
 ## Table of contents
 
 * [What issues it solves?](#what-issues-it-solves)
@@ -94,7 +100,7 @@ export class User
 
     public constructor(id: number, name: string)
     {
-        this.id   = id;
+        this.id = id;
         this.name = name;
 
         return;
@@ -197,7 +203,7 @@ export class User
 
 TypeManager.configureTypeOptions(User, {
     propertyOptionsMap: new Map<PropertyName, PropertyOptions<any>>([
-        ['name',  { typeArgument: String }],
+        ['name', { typeArgument: String }],
         ['email', { typeArgument: String }],
     ])
 });
@@ -211,7 +217,7 @@ No matter what style of configuration you have chosen the next step is to call s
 import { TypeManager } from '@dipscope/type-manager';
 
 const userObject = TypeManager.serialize(User, new User());
-const user       = TypeManager.deserialize(User, userObject);
+const user = TypeManager.deserialize(User, userObject);
 
 user instanceof User; // True.
 ```
@@ -222,7 +228,7 @@ Calling serialize creates a plain object and deserialize creates an instance of
 import { TypeManager } from '@dipscope/type-manager';
 
 const userJson = TypeManager.stringify(User, new User());
-const user     = TypeManager.parse(User, userJson);
+const user = TypeManager.parse(User, userJson);
 
 user instanceof User; // True.
 ```
@@ -235,8 +241,8 @@ Static functions are not the only way to work with a `TypeManager`. You can also
 import { TypeManager } from '@dipscope/type-manager';
 
 const userManager = new TypeManager(User);
-const userObject  = userManager.serialize(new User());
-const user        = userManager.deserialize(userObject);
+const userObject = userManager.serialize(new User());
+const user = userManager.deserialize(userObject);
 
 user instanceof User; // True.
 ```
@@ -515,9 +521,9 @@ export enum UserPriorityNumeric
 
 export enum UserPriorityTextual
 {
-    Low    = 'Low',
+    Low = 'Low',
     Medium = 'Medium',
-    High   = 'High'
+    High = 'High'
 }
 
 @Type()
@@ -542,9 +548,9 @@ export enum UserPriorityNumeric
 
 export enum UserPriorityTextual
 {
-    Low    = 'Low',
+    Low = 'Low',
     Medium = 'Medium',
-    High   = 'High'
+    High = 'High'
 }
 
 @Type()
@@ -1317,7 +1323,7 @@ It uses 2 special configurable type options:
 
 This options have default values if you have not configured them explicitly.
 
-* Default value of discriminator is a `__type__`. During deserialization `TypeManager` expects such property to be present inside a polymorphic object.
+* Default value of discriminator is a `$type`. During deserialization `TypeManager` expects such property to be present inside a polymorphic object.
 * Default value of discriminant is a `ClassName` which determined based on the type function.
 
 For proper deserialization of polymorphic types you have to provide such information inside your JSON.
@@ -1326,18 +1332,18 @@ For proper deserialization of polymorphic types you have to provide such informa
 {
     "shapes": [
         {
-            "__type__": "Rectangle",
+            "$type": "Rectangle",
             "title": "Cool rectangle",
             "width": 10,
             "height": 10
         }, 
         {
-            "__type__": "Square",
+            "$type": "Square",
             "title": "Perfect square",
             "width": 10
         },
         {
-            "__type__": "Circle",
+            "$type": "Circle",
             "title": "Simple circle",
             "radius": 6
         }
@@ -1347,7 +1353,7 @@ For proper deserialization of polymorphic types you have to provide such informa
 
 Now your JSON will be handled properly and you will get `Rectangle`, `Square` and `Circle` class instances in return.
 
-In most cases your `Discriminator` and `Discriminant` values will not match to our default ones. For example library like [Json.NET](https://www.newtonsoft.com/json) can be used on the backend side to send a response from your API. It uses `$type` property as `Discriminator` and full name of class as `Discriminant`. In such scenario our JSON may look like this.
+In some cases your `Discriminator` or `Discriminant` values will not match to our default ones. For example library like [Json.NET](https://www.newtonsoft.com/json) can be used on the backend side to send a response from your API. It uses `$type` property as `Discriminator` and full name of class as `Discriminant`. In such scenario our JSON may look like this.
 
 ```json
 {
@@ -1379,7 +1385,7 @@ import { TypeManagerOptions } from '@dipscope/type-manager';
 import { TypeOptionsBase } from '@dipscope/type-manager/core';
 
 const typeOptionsBase: TypeOptionsBase<any> = {
-    discriminator: '$type'
+    discriminator: '$customType'
 };
 
 const typeManagerOptions: TypeManagerOptions = {
@@ -1608,7 +1614,7 @@ Somewhere in code you have such a logic:
 ```typescript
 import { TypeManager } from '@dipscope/type-manager';
 
-const user    = new User();
+const user = new User();
 const company = new Company();
 
 user.company = company;
@@ -1675,7 +1681,7 @@ This allows you to get it later in serializers, factories, injectors or your cod
 import { TypeManager } from '@dipscope/type-manager';
 
 const userMetadata = TypeManager.extractTypeMetadata(User);
-const customData   = userMetadata.customData;
+const customData = userMetadata.customData;
 
 // Do something with type custom data...
 
@@ -1836,7 +1842,7 @@ export class CustomTypeFactory extends TypeFactory
         
         // Resolve custom data.
         const typeMetadata = typeContext.typeMetadata;
-        const customData   = typeMetadata.customData;
+        const customData = typeMetadata.customData;
 
         // Process custom data.
         for (const propertyName in customData)
@@ -1988,11 +1994,11 @@ Polymorphic types are supported. In most cases additional configuration is requi
 
 See information about breaking changes, release notes and migration steps between versions [here](https://github.com/dipscope/TypeManager.TS/blob/master/CHANGELOG.md).
 
-Thanks for checking this package. If you like it please give repo a star.
+Thanks for checking this package.
 
-Have any improvements in mind? Feel free to create an issue.
+Feel free to create an issue if you find any mistakes in documentation or have any improvements in mind.
 
-I wish you good luck and happy coding! ;)
+We wish you good luck and happy coding!
 
 ## License
 

package/core/fn.d.ts

@@ -51,7 +51,7 @@ export declare class Fn {
      *
      * @returns {boolean} True when value is function. False otherwise.
      */
-    static isFunction(x: any): x is (...args: any[]) => any;
+    static isFunction(x: any): x is (...args: Array<any>) => any;
     /**
      * Checks if value is an arrow function.
      *
@@ -59,7 +59,7 @@ export declare class Fn {
      *
      * @returns {boolean} True when value is an arrow function. False otherwise.
      */
-    static isArrowFunction(x: any): x is (...args: any[]) => any;
+    static isArrowFunction(x: any): x is (...args: Array<any>) => any;
     /**
      * Checks if value is a constructor.
      *
@@ -67,7 +67,7 @@ export declare class Fn {
      *
      * @returns {boolean} True when value is a constructor. False otherwise.
      */
-    static isCtor(x: any): x is new (...args: any[]) => any;
+    static isCtor(x: any): x is new (...args: Array<any>) => any;
     /**
      * Checks if value is string.
      *
@@ -107,7 +107,7 @@ export declare class Fn {
      *
      * @returns {boolean} True when value is array. False otherwise.
      */
-    static isArray(x: any): x is any[];
+    static isArray(x: any): x is Array<any>;
     /**
      * Checks if value is date.
      *
@@ -248,7 +248,7 @@ export declare class Fn {
      * Performs deep assignment and returns target object.
      *
      * @param {Record<string, any>} target Target object.
-     * @param {Record<string, any>[]} sources Source objects.
+     * @param {Array<Record<string, any>>} sources Source objects.
      *
      * @returns {Record<string, any>} Target object.
      */
@@ -268,25 +268,25 @@ export declare class Fn {
      *
      * @param {string} x String.
      *
-     * @returns {string[]} Array with the words of provided string.
+     * @returns {Array<string>} Array with the words of provided string.
      */
-    static unicodeWords(x: string): string[];
+    static unicodeWords(x: string): Array<string>;
     /**
      * Splits a ASCII string into an array of its words.
      *
      * @param {string} x String.
      *
-     * @returns {string[]} Array with the words of provided string.
+     * @returns {Array<string>} Array with the words of provided string.
      */
-    static asciiWords(x: string): string[];
+    static asciiWords(x: string): Array<string>;
     /**
      * Splits string into an array of its words.
      *
      * @param {string} x String.
      *
-     * @returns {string[]} Array with the words of provided string.
+     * @returns {Array<string>} Array with the words of provided string.
      */
-    static words(x: string): string[];
+    static words(x: string): Array<string>;
     /**
      * Checks if reflect metadata is supported.
      *

package/core/generic-argument.d.ts

@@ -4,4 +4,4 @@ import { TypeArgument } from './type-argument';
  *
  * @type {GenericArgument<TType>}
  */
-export declare type GenericArgument<TType> = TypeArgument<TType> | [TypeArgument<TType>, GenericArgument<any>[]];
+export declare type GenericArgument<TType> = TypeArgument<TType> | [TypeArgument<TType>, Array<GenericArgument<any>>];

package/core/generic-metadata.d.ts

@@ -4,4 +4,4 @@ import { TypeMetadata } from './type-metadata';
  *
  * @type {GenericMetadata<TType>}
  */
-export declare type GenericMetadata<TType> = [TypeMetadata<TType>, GenericMetadata<any>[]];
+export declare type GenericMetadata<TType> = [TypeMetadata<TType>, Array<GenericMetadata<any>>];

package/core/index.d.ts

@@ -34,6 +34,7 @@ export * from './type-ctor';
 export * from './type-fn';
 export * from './type-like';
 export * from './type-metadata-resolver';
+export * from './type-metadata-symbol';
 export * from './type-metadata';
 export * from './type-name';
 export * from './type-options-base';