danepod/express-hypermedia

A library that offers the creation of hypermedia resources that works in tandem with express

express-hypermedia's Issues

Implement API doc generation

Implement actions(/queries/templates)

Move sample project movie-database into this repo

Implement error entities/collections

Extend README, write HOWTOs and manuals

Extend test coverage

Standardize Actions

Siren Actions need to implement one execute() Method because in Siren, the user defines an Action per Resource and HTTP Method.

On the other hand, CJ Actions (called Templates/Queries) are defined per Resource and can contain multiple handlers for HTTP Methods. So CJ Actions need to implement executePOST()/executePUT(), executeDELETE(), etc. methods.

The goal is to find a middle ground to unify creating actions that removes these differences between the output formats. Streamlining these makes it easier for users of the library to understand the usage of these interfaces.

Document every public classes, methods, interfaces using JSDoc

Rename Resource and Representation

Rename Resource and Representation to better reflect the meaning of the terms proposed by Roy Fielding (https://www.ics.uci.edu/~fielding/pubs/dissertation/rest_arch_style.htm, 5.2.11 and 5.2.12).

Make this package available via NPM

When doing this, remove all instructions to the manual installation from README.

Upgrade to the most recent version of TypeScript

Due to a bug that prevents the build from succeeding, 8175e53 set the version of TypeScript to be used for TravisCI builds to 2.6.2. This is the latest known stable version to successfully build express-hypermedia.

I've tested the most recent development version of TypeScript, 2.8.0-dev.20180202, which was able to build the project again after small changes. Because this is an unstable development version, I don't want to use this yet and rather wait for a fix to arrive in the stable build.

What needs to be done: Wait for the next stable version of TypeScript to be released, check if the build succeeds and then revert the aforementioned commit.

Add a way to use HTTP link headers

Express has a way of setting these headers to set navigational affordances (https://expressjs.com/en/4x/api.html#res.links).

Change Content-Type header of outgoing responses to correct MIME type

At the moment, the Content-Type header of every response generated by express-hypermedia reads application/json. While technically correct, the more appropriate value would be the MIME type of the actual used hypermedia format, such as application/vnd.siren+json.

Replace content negotiation logic with builtin Express logic

Using Response.format(), Express provides a solution to content negotiation which could be used with this library as well.

My own implementation, while unit-tested, may not handle every edge-case according to RFC 7231.