Improve typescript typing

[VincentLanglet]

Problem

With typescript, the normalize object lose his type

Solution

Generic function

TODO

• Add & update tests
• Ensure CI is passing (lint, tests, flow)
• Update relevant documentation

[ntucker]

You probably want entities to be something like { [key:string]: { [key:string]: E } } since it's guaranteed to be nested with string

[VincentLanglet]

See this example, the entities are not the same

{
  result: "123",
  entities: {
    "articles": {
      "123": {
        id: "123",
        author: "1",
        title: "My awesome blog post",
        comments: [ "324" ]
      }
    },
    "users": {
      "1": { "id": "1", "name": "Paul" },
      "2": { "id": "2", "name": "Nicole" }
    },
    "comments": {
      "324": { id: "324", "commenter": "2" }
    }
  }
}

You prefer to type this, like this

type List<E> = {
  [key: string]: E
}

type Entities = {
  articles: List<Article>
  users: List<User>
  comments: List<Comment>
}

And then NormalizedSchema<Entities>

[ntucker]

I can see how that would be more specific if you put the work in. For my cases I was happy with 'any' for the final result and really wanted to have the typings of the nesting level.

For me there's no way to know all the entity types statically, so this is unfeasible for me.

[VincentLanglet]

I let the default any value so you can use it like you do.

But this can't be use with the no-unsafe-any rule from tslint.

It's not about typescript checking the type of the entity. It about typescript checking the use of the entity after you normalized them.

cont normalized = normalize<Entities>(...);

const foo = normalized.articles // known as Article.
foo.author // no error
foo.name // error
const bar = normalized.user // error

With the less precise typing you ask, we will have

const foo = normalized.articles // known as Entity = Article | User | Comment
foo.author // error !!!
foo.name // error
const bar = normalized.user // no error !!!

[shakibbzillow]

this makes sense, the typing should be on the entity. also @ntucker you can opt out by using any.

[paularmstrong]

Thanks! The addition of generics really helps avoid default any all over.

[lock]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.