From 310e61f66a1770f337fb0cc8dba89e6080c2ba12 Mon Sep 17 00:00:00 2001 From: UnumID Admin Date: Tue, 4 May 2021 01:34:06 +0000 Subject: [PATCH] [Release 2.0.1] Readme updated with the new 2.0.0 functionality without a NoPresentation type and the stringified Credential attribute, CredentialSubject. --- docs/classes/custerror.html | 4 +- docs/index.html | 63 +++++++++++----------- docs/interfaces/credentialinfo.html | 4 +- docs/interfaces/credentialstatusinfo.html | 8 +-- docs/interfaces/decryptedpresentation.html | 8 +-- docs/interfaces/registeredissuer.html | 2 +- docs/interfaces/registeredverifier.html | 2 +- docs/interfaces/unumdto.html | 4 +- docs/interfaces/verifiedstatus.html | 4 +- docs/modules.html | 24 ++++----- package.json | 2 +- 11 files changed, 61 insertions(+), 64 deletions(-) diff --git a/docs/classes/custerror.html b/docs/classes/custerror.html index 0a02c268..902148bd 100644 --- a/docs/classes/custerror.html +++ b/docs/classes/custerror.html @@ -128,7 +128,7 @@

constructor

Parameters

@@ -153,7 +153,7 @@

code

code: number
diff --git a/docs/index.html b/docs/index.html index d4fcffcb..3db3607c 100644 --- a/docs/index.html +++ b/docs/index.html @@ -59,6 +59,31 @@

@unumid/server-sdk

This SDK combines the functionality of an Issuer and Verifier entities to work with UnumID's SaaS. For necessary account creation and API keys please email admin@unum.id.

+ +

Distribution

+ +

This project is publicly published on the official npm registry. For example it can be pulled with, npm i @unumid/server-sdk or yarn add @unumid/server-sdk.

+ +

Releases

+ +

Releases and publishing to NPM is automated via Github Actions CI job. In order to trigger a release one should push a git tag with a preceding v with semver notation, ie v1.1.1, to the main branch. This will trigger the CI job to bump the package version, generate typedocs, publish to NPM, make a release commit, and make a Github Release. The message of the git tag will be the release message so please make it meaningful. For example, git tag v1.2.0 -m "Updated the SDK with a new CI job" && push origin v1.1.1.

+ +

Global Dependencies

+ +
    +
  • NodeJS v14.0.0 or higher, preferably v14.15.0 or higher
    • +
  • yarn
    • +
+ +

Logging

+ +

Logs level defaults to Info. One can set to debug for more information via the environment variable LOG_LEVEL, i.e. LOG_LEVEL=debug. We are using standard NPM log levels. More details on the various log levels here.

+

The logs default to stdout so can be aggregated using any log provider you would like from disk.

+ +

Documentation

+ +

High level technical documentation can be found here which is served via Docusaurus. More detailed generated from source documentation can be found here which is served via repo specific Github pages via the /docs folder of the main branch.

+

In order to generate the Typedoc documentation from the source code run the createTypedocs.sh script.

SDK Functionality

 @@ -130,10 +155,10 @@

issueCredential

"id": string, // a url for credential's status "type": "CredentialStatus" }, - "credentialSubject": { + "credentialSubject": stringify({ // a string representation of an object with with an id attribute and any number of arbitrary key values pairs. "id": string, // subject DID - [key: string]: any, // // data about subject - }, + [key: string]: any, // data about subject + }), "issuer": string, // issuer DID "type": string[], // credential type(s), always begins with "VerifiableCredential" "id": string, // identifies credential (version 4 UUID) @@ -271,8 +296,8 @@

verifyPresentation

Response Body: DecryptedPresentation

{
   "isVerified": boolean; // whether the presentation is valid
-  "type": 'VerifiablePresentation' | 'NoPresentation' // type of presentation. NoPresentation means user declined request.
-  "presentation": Presentation | NoPresentation, // decrypted Presentation (or NoPresentation) object
+  "type": 'VerifiablePresentation' | 'DeclinedPresentation' // type of presentation. DeclinedPresentation means user declined request and the submitted presentation's VerifiableCredential attribute was undefined or an empty array.
+  "presentation": Presentation, // decrypted Presentation object
   "message"?: string; // (optional) included if isVerified is false. Explains why verification failed.
 }
@@ -335,34 +360,6 @@

checkCredentialStatus

"status": CredentialStatusOptions; // a string literal type that currently only consists of 'valid' and 'revoked' } - -

Other Information

- - -

Distribution

- -

This project is publicly published on the official npm registry. For example it can be pulled with, npm i @unumid/server-sdk or yarn add @unumid/server-sdk.

- -

Releases

- -

Releases and publishing to NPM is automated via Github Actions CI job. In order to trigger a release one should push a git tag with a preceding v with semver notation, ie v1.1.1, to the main branch. This will trigger the CI job to bump the package version, generate typedocs, publish to NPM, make a release commit, and make a Github Release. The message of the git tag will be the release message so please make it meaningful. For example, git tag v1.2.0 -m "Updated the SDK with a new CI job" && push origin v1.1.1.

- -

Global Dependencies

- -
    -
  • NodeJS v14.0.0 or higher, preferably v14.15.0 or higher
    • -
  • yarn
    • -
- -

Logging

- -

Logs level defaults to Info. One can set to debug for more information via the environment variable LOG_LEVEL, i.e. LOG_LEVEL=debug. We are using standard NPM log levels. More details on the various log levels here.

-

The logs default to stdout so can be aggregated using any log provider you would like from disk.

- -

Documentation

- -

High level technical documentation can be found here which is served via Docusaurus. More detailed generated from source documentation can be found here which is served via repo specific Github pages via the /docs folder of the main branch.

-

In order to generate the Typedoc documentation from the source code run the createTypedocs.sh script.

diff --git a/docs/interfaces/credentialinfo.html b/docs/interfaces/credentialinfo.html index 0df7ef96..fbe711ea 100644 --- a/docs/interfaces/credentialinfo.html +++ b/docs/interfaces/credentialinfo.html @@ -102,7 +102,7 @@

credentialTypes

credentialTypes: string[]
@@ -112,7 +112,7 @@

subjectDid

subjectDid: string
diff --git a/docs/interfaces/credentialstatusinfo.html b/docs/interfaces/credentialstatusinfo.html index 3c03b96f..43bbe9fe 100644 --- a/docs/interfaces/credentialstatusinfo.html +++ b/docs/interfaces/credentialstatusinfo.html @@ -104,7 +104,7 @@

createdAt

createdAt: Date
@@ -114,7 +114,7 @@

credentialId

credentialId: string
@@ -124,7 +124,7 @@

status

status: "valid" | "revoked"
@@ -134,7 +134,7 @@

updatedAt

updatedAt: Date
diff --git a/docs/interfaces/decryptedpresentation.html b/docs/interfaces/decryptedpresentation.html index b9c83f99..b7e1f998 100644 --- a/docs/interfaces/decryptedpresentation.html +++ b/docs/interfaces/decryptedpresentation.html @@ -112,7 +112,7 @@

isVerified

@@ -123,7 +123,7 @@

Optional message

@@ -133,7 +133,7 @@

presentation

presentation: Presentation
@@ -143,7 +143,7 @@

type

type: "VerifiablePresentation" | "DeclinedPresentation"
diff --git a/docs/interfaces/registeredissuer.html b/docs/interfaces/registeredissuer.html index 3f44c9cc..67781635 100644 --- a/docs/interfaces/registeredissuer.html +++ b/docs/interfaces/registeredissuer.html @@ -157,7 +157,7 @@

keys

keys: KeyPairSet
diff --git a/docs/interfaces/registeredverifier.html b/docs/interfaces/registeredverifier.html index 0585909c..d9da96ea 100644 --- a/docs/interfaces/registeredverifier.html +++ b/docs/interfaces/registeredverifier.html @@ -159,7 +159,7 @@

keys

keys: KeyPairSet
diff --git a/docs/interfaces/unumdto.html b/docs/interfaces/unumdto.html index 49fe2d23..0b7ad8c0 100644 --- a/docs/interfaces/unumdto.html +++ b/docs/interfaces/unumdto.html @@ -110,7 +110,7 @@

authToken

authToken: string
@@ -120,7 +120,7 @@

body

body: T
diff --git a/docs/interfaces/verifiedstatus.html b/docs/interfaces/verifiedstatus.html index 22fe4f91..f7b24f7a 100644 --- a/docs/interfaces/verifiedstatus.html +++ b/docs/interfaces/verifiedstatus.html @@ -109,7 +109,7 @@

isVerified

isVerified: boolean
@@ -119,7 +119,7 @@

Optional message

message: string
diff --git a/docs/modules.html b/docs/modules.html index 719d742e..dc234a0d 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -115,7 +115,7 @@

Const checkCredentialSt
  • @@ -148,7 +148,7 @@

    Const convertCredential
  • @@ -176,7 +176,7 @@

    Const createProof

  • @@ -215,7 +215,7 @@

    Const extractCredential
  • @@ -246,7 +246,7 @@

    Const issueCredential

  • @@ -291,7 +291,7 @@

    Const registerIssuer

  • @@ -327,7 +327,7 @@

    Const registerVerifier

  • @@ -369,7 +369,7 @@

    Const sendEmail

  • @@ -406,7 +406,7 @@

    Const sendRequest

  • @@ -454,7 +454,7 @@

    Const sendSms

  • @@ -491,7 +491,7 @@

    Const updateCredentialS
  • @@ -534,7 +534,7 @@

    Const verifyPresentation

    diff --git a/package.json b/package.json index 05bd998a..7d91d159 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@unumid/server-sdk", - "version": "2.0.0", + "version": "2.0.1", "main": "build/index.js", "repository": "git@github.com:UnumID/Server-SDK-TypeScript.git", "homepage": "https://docs.unum.id/server-sdk/",