0.1.1 • Published 10 months ago

@projectlibertylabs/siwa v0.1.1

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
10 months ago

Sign In With Access TypeScript/JavaScript Integration Library

The NPM package @projectlibertylabs/siwa offers both CommonJS and ESM exports.

Install

  • NPM: npm i @projectlibertylabs/siwa
  • Yarn: yarn add @projectlibertylabs/siwa

Documentation

See Markdown/GitHub Docs or Live Docs.

JS API Functions

FunctionDescription
generateAuthenticationUrlGenerates the signed request for the authentication flow with Frequency Access
getLoginResultFetch and extract the Result of the Login from Frequency Access
hasChainSubmissionsChecks to see if there are any chain submissions in the given result
generateSignedRequestGenerates the signed payload for the authentication flow with Frequency Access using a keypair
buildSignedRequestBuilds the signed request for the authentication flow with Frequency Access using the signature and public key
generateEncodedSignedRequestGenerates the encoded signed payload for the authentication flow with Frequency Access using a keypair
encodeSignedRequestEncodes a signed request for the authentication flow as a base64url string
decodeSignedRequestDecodes a base64url encoded signed request for the authentication flow with Frequency Access
generateRequestSigningDataGenerates the hex of the payload for signing

JS API Constants

ConstantsDescription
VerifiedEmailAddressCredentialRequest for a verified email address
VerifiedPhoneNumberCredentialRequest for a verified SMS/Phone Number
VerifiedGraphKeyCredentialRequest for a the private graph encryption key

JS API Types

Types are included with the exports for the package

Development

Library is published on merge to main with a development tag 0.0.0-[SHA:6]. Releases are made via GitHub Releases with tags in the style: vX.Y.Z.