mchlbrnd/normalizr-decorators

Experimental TypeScript normalizr decorators for normalization of class and property definitions

normalizr-decorators's Issues

Update documentation in README.md

See https://github.com/paularmstrong/normalizr/blob/master/README.md

Move decorators to separate file

Move decorators out of index.ts into directory src/schema/.

So for the Entity schema type:

• src/schema/EntityClassDecorator.ts
• src/schema/EntityPropertyDecorator.ts

Feedback welcome!

Add Union schema type decorators

• Add class and property decorations (Union & UnionProperty resp.)
• Add test (ie https://github.com/paularmstrong/normalizr/blob/master/src/__tests__/typescript/union.ts)
• Add documentation in README.md

Add Values schema type decorators

• Add class and property decorations (Values & ValuesProperty resp.)
• Add test (ie https://github.com/paularmstrong/normalizr/blob/master/src/__tests__/typescript/values.ts)
• Add documentation in README.md

Add denormlize API as static and prototype method to decorated class

See #6.

TODO: write code up.

Add normlize API as static and prototype method to decorated class

Extend the decorated class with the normalize API.

@Entity({key: 'users'})
class User {
  public readonly id: number;
  public age: number;
}

// instantiate a User object (ignore id for now)
const user = new User();
// set age property of instantiated user
user.age = 42;

// normalize through prototype method
const normalizedProtoUser1 = user.normalize();  // internally calls normalizr.normalize(this, typeOfThis);
// ... and with optional arg
const normalizedProtoUser2 = user.normalize({age: 43});

// normalize through static method with required data arg
const normalizedStaticUser = User.normalize({id: 1, age: 42});  

Questions:

1. • For static method: how to let the API know normaliza input is an array? As seen in #1 the Array type was determined based on input.
2. • Would it be nice to have a dedicated method for Array normalization?

// 1) internally determine based on input arg
User.normalize([]);

// 2) specialized method for Array type
User.normalizeArray([]);

Feedback welcome!

Add Object schema type decorators

• Add class and property decorations (Object & ObjectProperty resp.)
• Add test (ie https://github.com/paularmstrong/normalizr/blob/master/src/__tests__/typescript/object.ts)
• Add documentation in README.md

bug: Unable to (de)normalize an array of values

Hi there,

Love the project, always a fan of using decorators to avoid extra schema definitions everywhere!

Ran into an issue though, I can't work out how to (de)normalize to and from an array of values. In normalizr you just wrap the schema in [], however I've dug through your source and cannot find a way to do it.

Are you able to please advise? Thanks!