Packages

stytch_ui_model

1.0.0-rc1
1.0.0-rc1

Collection of model types, update functions, and events for interacting with the server-side stytch client. It is opinionated about URLs and model structure.

HexDocs

Current section

Files

Jump to
Readme
1 Version
8 Dependencies
Dependants
Files
Activity
stytch_ui_model README.md
Raw

README.md 

# stytch_ui_model



Lustre model and update function for authenticating part of your state using

Stytch magic links, one time passcodes, and passkeys.



This package targets JavaScript only.



Assumes your backend has a specific url structure (this may be configurable in a future major version):



- You provide a prefix such as `https://mydomain.com/api/authenticate`

- You implement routes on your server for (depending which methods you want to support):

  - /send_sign_in_link (magic link auth)

  - /send_passcode and /verify_passcode (passcode auth)

  - /start_register_passkey and /finish_register_passkey (adding passkeys)

  - /start_passkey_login and /passkey_login (passkey auth)

  - /me

  - /sign_out

  - /authenticate (called by Stytch, not this package)



You'll also need to hook up some view components to call the update methods in

this package.



See [example clients](../example/) to get started.