diff --git a/docs/classes/custerror.html b/docs/classes/custerror.html index 27339e83..ac7db8ea 100644 --- a/docs/classes/custerror.html +++ b/docs/classes/custerror.html @@ -128,7 +128,7 @@
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.
+ +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.
+ +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.
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
.
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.1.1 -m "Updated the SDK with a new CI job" && push origin v1.1.1
.
The NODE_ENV
environment variable defaults to sandbox
. However while debugging one can use the debug
environment setting. This enables logging of decrypted presentations at the debug
level. Due to presentations containing sensitive information it is not advised to use in a production environment.
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.
Information regarding the suggested versioning strategy can be found here.
+ Breaking versions of this SDK will be denoted as such with an incremented major version. However all versions of the SDK will be fully backwards compatible with the other Unum ID SDKs. If there is a need to referencing an older version of the SDK within your applications for other applications specific backwards compatibility we recommend this syntax for simplicity:
+ @unumid/server-sdk-v2": "npm:@unumid/server-sdk@2.1.4
.
Register an issuer corresponding to your customer UUID and issuer API key provided by UnumID. As a customer, you can register as many issuers as you like (or none at all), depending on your use case. Note, however, that you'll need a unique issuer API key for each one.
You should store the DID (did
) and encryption and signing key pairs (keys
) that this returns. You'll need these to issue credentials to users.
Parameters:
-"name": string, // human readable name for issuer. Displayed to users in mobile apps when verifiers request credentials.
-"customerUuid": string, // your customer UUID
+ "customerUuid": string, // your customer UUID
"apiKey": string // your issuer API key
Response Body: RegisteredIssuer
@@ -120,7 +128,7 @@ registerIssuer
"uuid": string, // identifies issuer in Unum ID database
"customerUuid": string, // identifies customer in Unum ID database
"did": string, // identifies issuer in Unum ID ecosystem
- "name": string, // human-readable name for issuer
+ "name": string, // human-readable name for issuer. Displayed to users in mobile apps when verifiers request credentials. Comes from the name of the ApiKey used to register the Issuer.
"createdAt": string, // when issuer was registered
"updatedAt": string, // when issuer was last updated
"keys": {
@@ -197,8 +205,7 @@ registerVerifier
Register a verifier corresponding to your customer UUID and verifier API key that UnumID provides. As a customer, you can register as many verifiers as you like (or none at all), depending on your use case. Note, however, that you'll need a unique verifier API key for each one.
You should store the DID (did
) and signing key pair (keys
) that this returns. You'll need these to create requests for (presentations of) credentials from users.
Parameters
- "name": string, // human readable name for verifier. Displayed to users in mobile apps when you make requests.
-"customerUuid": string, // your customer UUID
+ "customerUuid": string, // your customer UUID
"url": string, // the url of which UnumID's SaaS will interface with
"apiKey": string // your verifier API key
@@ -207,7 +214,7 @@ registerVerifier
"uuid": string, // identifies verifier in Unum ID database
"customerUuid": string, // identifies customer in Unum ID database
"did": string, // identifiers verifier in Unum ID ecosystem
- "name": string, // human-readable name for verifier
+ "name": string, // human-readable name for verifier. Displayed to users in mobile apps when you make requests. Comes from the name of the ApiKey used to register the Verifier.
"createdAt": string, // when verifier was registered (ISO 8601 date/time)
"updatedAt": string, // when verifier was last updated (ISO 8601 date/time)
"keys": {
diff --git a/docs/interfaces/credential.html b/docs/interfaces/credential.html
index 584e60b2..ed38d774 100644
--- a/docs/interfaces/credential.html
+++ b/docs/interfaces/credential.html
@@ -126,7 +126,7 @@ credentialStatus
@@ -148,9 +148,14 @@ credentialSubject
+
@@ -159,7 +164,7 @@ Optional expirationDate
@@ -170,7 +175,7 @@ id
@@ -181,7 +186,7 @@ issuanceDate
@@ -192,7 +197,7 @@ issuer
@@ -202,7 +207,7 @@ proof
@@ -213,9 +218,14 @@ type
+
+
+ As dictated by the W3 spec. ref: https://www.w3.org/TR/vc-data-model/#example-1-a-simple-example-of-a-verifiable-credential.
+
+
diff --git a/docs/interfaces/credentialinfo.html b/docs/interfaces/credentialinfo.html
index 857aa995..c5c33b66 100644
--- a/docs/interfaces/credentialinfo.html
+++ b/docs/interfaces/credentialinfo.html
@@ -102,7 +102,7 @@ credentialTypes
@@ -112,7 +112,7 @@ subjectDid
diff --git a/docs/interfaces/credentialstatusinfo.html b/docs/interfaces/credentialstatusinfo.html
index ac315e77..f2356ddb 100644
--- a/docs/interfaces/credentialstatusinfo.html
+++ b/docs/interfaces/credentialstatusinfo.html
@@ -104,7 +104,7 @@ createdAt
@@ -114,7 +114,7 @@ credentialId
@@ -124,7 +124,7 @@ status
@@ -134,7 +134,7 @@ updatedAt
diff --git a/docs/interfaces/decryptedpresentation.html b/docs/interfaces/decryptedpresentation.html
index 05cfa59d..f2a19f1e 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
@@ -143,7 +143,7 @@ type
diff --git a/docs/interfaces/presentation.html b/docs/interfaces/presentation.html
index 2d2c75db..5a1825cd 100644
--- a/docs/interfaces/presentation.html
+++ b/docs/interfaces/presentation.html
@@ -113,7 +113,7 @@ @context
@@ -124,7 +124,7 @@ presentationRequestId
@@ -134,7 +134,7 @@ proof
@@ -145,7 +145,7 @@ type
@@ -156,9 +156,14 @@ Optional uuid
+
+
+ Optional wether the presentation has been persisted yet or not.
+
+
@@ -167,9 +172,14 @@ Optional verifiableCreden
+
+
+ Optional. If undefined or empty it means the presentation request was declined
+
+
@@ -178,7 +188,7 @@ verifierDid
diff --git a/docs/interfaces/registeredissuer.html b/docs/interfaces/registeredissuer.html
index cdbd5377..bb460cb4 100644
--- a/docs/interfaces/registeredissuer.html
+++ b/docs/interfaces/registeredissuer.html
@@ -114,7 +114,7 @@ createdAt
@@ -125,7 +125,7 @@ customerUuid
@@ -136,7 +136,7 @@ did
@@ -147,7 +147,7 @@ isAuthorized
@@ -157,7 +157,7 @@ keys
@@ -168,7 +168,7 @@ name
@@ -179,7 +179,7 @@ updatedAt
@@ -190,7 +190,7 @@ uuid
diff --git a/docs/interfaces/registeredverifier.html b/docs/interfaces/registeredverifier.html
index 443b4848..af389262 100644
--- a/docs/interfaces/registeredverifier.html
+++ b/docs/interfaces/registeredverifier.html
@@ -116,7 +116,7 @@ createdAt
@@ -127,7 +127,7 @@ customerUuid
@@ -138,7 +138,7 @@ did
@@ -149,7 +149,7 @@ isAuthorized
@@ -159,7 +159,7 @@ keys
@@ -170,7 +170,7 @@ name
@@ -181,7 +181,7 @@ updatedAt
@@ -192,7 +192,7 @@ url
@@ -203,7 +203,7 @@ uuid
@@ -214,7 +214,7 @@ versionInfo
diff --git a/docs/interfaces/unumdto.html b/docs/interfaces/unumdto.html
index e344aef3..6fe3a680 100644
--- a/docs/interfaces/unumdto.html
+++ b/docs/interfaces/unumdto.html
@@ -110,7 +110,7 @@ authToken
@@ -120,7 +120,7 @@ body
diff --git a/docs/interfaces/verifiedstatus.html b/docs/interfaces/verifiedstatus.html
index 7baf2c41..c613e05f 100644
--- a/docs/interfaces/verifiedstatus.html
+++ b/docs/interfaces/verifiedstatus.html
@@ -109,7 +109,7 @@ isVerified
@@ -119,7 +119,7 @@ Optional message
diff --git a/docs/modules.html b/docs/modules.html
index e3473ce2..a2c066e3 100644
--- a/docs/modules.html
+++ b/docs/modules.html
@@ -118,7 +118,7 @@ Const checkCredentialSt
@@ -151,7 +151,7 @@ Const convertCredential
@@ -179,7 +179,7 @@ Const createProof
@@ -218,7 +218,7 @@ Const createProofPb
@@ -257,7 +257,7 @@ Const extractCredential
@@ -288,7 +288,7 @@ Const getRequest
@@ -320,7 +320,7 @@ Const getVersionedReque
Parameters
@@ -346,7 +346,7 @@ Const issueCredential
@@ -385,13 +385,13 @@ Returns Promise
Const registerIssuer
-
+
-
@@ -401,9 +401,6 @@
Const registerIssuer
Parameters
- -
-
name: string
-
-
customerUuid: string
@@ -421,13 +418,13 @@ Returns Promise
Const registerVerifier
-
+
-
@@ -437,9 +434,6 @@
Const registerVerifier
Parameters
- -
-
name: string
-
-
customerUuid: string
@@ -469,7 +463,7 @@ Const sendEmail
-
@@ -506,7 +500,7 @@
Const sendRequest
-
@@ -555,7 +549,7 @@
Const sendSms
-
@@ -592,7 +586,7 @@
Const updateCredentialS
-
@@ -635,7 +629,7 @@
Const verifyPresentation
diff --git a/package.json b/package.json
index 10c7c84e..88ad2357 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "@unumid/server-sdk",
- "version": "3.0.4",
+ "version": "3.1.0",
"main": "build/index.js",
"repository": "git@github.com:UnumID/Server-SDK-TypeScript.git",
"homepage": "https://docs.unum.id/server-sdk/",
Due to its ambiguous format going to handle as JSON string when passing around.
+