Shape testing of the bee endpoint responses

[vojtechsimetka]

This has been discussed on our roundtable on March 31st. We will start implementing it gradually to different endpoints. The idea is to type the expected shape array with the return type of a given function.

Here is a dump of the proposal:

rationale:

• it has happened to us several times already that the responses from bee version we officially supported did not match the bee-js type
• as far as I recall, in 2 cases it was missing properties, in one case it was wrong type of properties and in one it was removed property

proposal:

• use https://www.npmjs.com/package/jest-to-match-shape-of on all API call responses in bee-js
• this is very intuitive to use

interface TestInterface {
  foo: string
  bar?: number
}

const validShapes: TestInterface[] = [{foo: 'hi'}, {foo: 'yo!', bar: 1}]

expect(res).toMatchOneOf(validShapes)

[AuHau]

I think this was already once or twice brought up before but we have never really decided to do this.

From my POW I am done doing it, especially as we are promising some returned types/interfaces from the API calls that we are not really sure if it is correct or not.