RFC: 005 - Create AuthN port for hyper63

[twilson63]

AuthN Port

Summary

AuthN port will provide the ability for hyper63 to support AuthN services for apis

Motivation

AuthN is a common requirement with application development, giving api developers a common api to implement AuthN and leveraging hyper63's adapter pattern to support multiple AuthN services will provide a clean experience for api developers.

Detailed design

A port is the specification each adapter of this type must follow in order to take advantage of the swap ability in hyper63.

As an api developer I want a clear way forward to implement AuthN, https://en.wikipedia.org/wiki/Authentication

The port should define the methods and arguments of those methods that are required by the adapter to implement, some methods may also be optional. Here is a potential set of methods and arguments for a port.

const authn = z.object({
  settings: z.function().args(z.void()).returns(z.object().passthrough()),
  signup: z.function().args(z.object({ 
    username: z.string().optional(), 
    email: z.string().email(), 
    password: z.string()})
    ).returns(z.object({
    id: z.string(),
    username: z.string().optional(),
    email: z.string(),
    ...
 
 }

Other methods to consider:

• invite
• verify
• recover
• token
• getUser
• updateUser
• logout

How we teach this

Create an adapter implementation example, write a blog post on how to create an adapter for the port, maybe record a screencast.

Yes this would be accepted and formal documents would have to created to show that hyper63 now supports an AuthN port with ... adapters.

See above.

Drawbacks

It may be a big project to get right on the first go, I recommend we focus on a simple implementation that can easily be connected to an adapter, like pouchdb-users or gotrue

Alternatives

What other designs have been considered? What is the impact of not doing this?

This section could also include prior art, that is, how other frameworks in the same domain have solved this problem.

Unresolved questions

Optional, but suggested for first drafts. What parts of the design are still
TBD?

[twilson63]

@cawilson1

FYI ☝️