The official NodeJS SDK for SnapAuth 🫰
This is for server code.
If you're looking for the client integration, check out @snapauth/sdk.
npm i --save @snapauth/node-sdk
# yarn add @snapauth/sdk
# etcimport SnapAuth from '@snapauth/node-sdk'
const snapAuth = new SnapAuth(process.env.SNAPAUTH_SECRET_KEY)[!TIP] The SDK will auto-detect a
SNAPAUTH_SECRET_KEYenvironment variable. If that's where you've set up your Secret Key, you can simplify this toconst snapAuth = new SnapAuth().
All examples are in TypeScript, based roughly on an ExpressJS app.
General usage is as follows:
const response = await snapAuth.someApiCall(param1, ...)
if (response.ok) {
// Got back a 2xx
// console.assert(response.result !== null)
useDataFrom(response.result)
} else {
// Any other response, or network error
// console.assert(response.result === null)
// console.assert(response.errors.length > 0)
console.error(response.errors)
}This is similar to fetch() which you're probably already familiar with.
If the API call succeeded, the response will be in response.result.
[!NOTE] Even on successful responses,
response.errorsmay contain information, such as deprecation or usage warnings. We suggest always examining this value.
app.post('/register', async (request, response) => {
// You should have POSTed something like this:
// {
// token: string
// username: string
// }
const token = request.body.token
const username = request.body.username
// Do whatever you normally do to create a new User record
const user = createUserWithUsername(username)
// Then save the new passkey
const credentialInfo = await snapAuth.attachRegistration(token, {
id: user.id, // You may need to cast this to a string first, e.g. `String(user.id)`
handle: user.username, // Probably the value from above
})
// That's it. Proceed as normal.
})[!NOTE] The
idis what you should use during authentication; it can not be changed. Thehandleis to make client code more straightforward, and is typically the value the user would type in to a username field.You MAY hash or obfuscate the
handle, or omit it entirely. If you do, you'll need to either a) repeat the procedure in client code during authentication or b) rely on the user's id instead.
app.post('/signin', async (request, response) => {
// { token: string }
const token = request.body.token
const auth = await snapAuth.signIn(token)
if (auth.ok) {
signInUserWithId(auth.result.user.id)
} else {
// Look at auth.errors and decide what, if anything, to display to the user.
}
})Run npm run watch to keep the build running continually on file change.
To make the local version available for linking, run npm link in this directory.
In the project that should use the local version, run npm link '@snapauth/node-sdk' which will set up the symlinking.