2.1.0 • Published 9 months ago

@projectlibertylabs/siwf v2.1.0

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

Sign In With Frequency (SIWF) V2 JavaScript Library

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

Install

  • NPM: npm i @projectlibertylabs/siwf@v2
  • Yarn: yarn add @projectlibertylabs/siwf@v2

Documentation

See Markdown/GitHub Docs or Live Docs.

JS API Functions

FunctionDescription
generateAuthenticationUrlGenerates the signed request for the authentication flow
getLoginResultFetch and extract the Result of the Login
hasChainSubmissionsChecks to see if there are any chain submissions in the given result
validateSiwfResponseTakes a response payload and validates it
generateSignedRequestGenerates the signed payload for the authentication flow using a keypair
buildSignedRequestBuilds the signed request for the authentication flow using the signature and public key
generateEncodedSignedRequestGenerates the encoded signed payload for the authentication flow 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
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.

0.0.0-ce36a6

9 months ago

0.0.0-d2649a

9 months ago

2.1.0

9 months ago

0.0.0-c6cbb7

9 months ago

0.0.0-a8b780

9 months ago

0.0.0-c390f9

9 months ago

0.0.0-2b93f2

9 months ago

0.0.0-df5630

10 months ago

0.0.0-281782

9 months ago

1.1.4

9 months ago

1.1.3

9 months ago

0.0.0-90407f

10 months ago

2.0.0-rc1

10 months ago

2.0.3

9 months ago

2.0.2

9 months ago

2.0.5

9 months ago

2.0.4

9 months ago

0.0.0-9ad33a

9 months ago

2.0.6

9 months ago

0.0.0-1c8c45

9 months ago

2.0.1

10 months ago

2.0.0

10 months ago

0.0.0-cc7328

10 months ago

0.0.0-87b24c

9 months ago

0.0.0-9425ab

10 months ago

0.0.0-df5ed0

10 months ago

0.0.0-cf2bb3

10 months ago

0.0.0-b9d308

10 months ago

0.0.0-93caa4

10 months ago

0.0.0-3b8992

10 months ago

0.0.0-e4f59f

10 months ago

0.0.0-913df5

9 months ago

0.0.0-f3a3df

10 months ago

0.0.0-939e4e

10 months ago

0.0.0-8078ec

10 months ago

0.0.0-6f1780

10 months ago

0.0.0-dc4314

9 months ago

1.1.2

11 months ago

0.0.0-bade15

11 months ago