@unumid/types - npm Package Compare versions

Comparing version 3.27.1 to 3.28.0

docs/interfaces/subjectcredentialrequestsenricheddto.html

build/index.d.ts

		@@ -828,2 +828,12 @@ /// <reference types="node" />
		/**
		* Interface to encapsulate the combined functionality of user DID association with subject credential requests.
		*
		* Note: userDidAssociation is optional because will not be necessary aside for the initial credential requests in order for the customer's user to get an associated DID.
		* Opted to include as part of the credential requests to eliminate the possibility for a user did / credential request race condition.
		*/
		export interface SubjectCredentialRequestsEnrichedDto {
		credentialRequestsInfo: SubjectCredentialRequestsDto;
		userDidAssociation?: UserDidAssociation;
		}
		/**
		* Interface to encapsulate the response that the UnumID SaaS is expecting after forwarding the encrypted presentation to the verifier app for verification.
		@@ -830,0 +840,0 @@ * Notably it is not the DecryptedPresentation type from the Server SDK returns because the SaaS to never deals with the plaintext presentations.

package.json

		{
		"name": "@unumid/types",
		"version": "3.27.1",
		"version": "3.28.0",
		"description": "shared Unum ID TypeScript types",
		@@ -5,0 +5,0 @@ "main": "build/index.js",

README.md

		@@ -21,3 +21,3 @@ # UnumID Types

		c) For generic types that represent an object consisting options for creating a persisted entity they should have succeeding `Options` naming convention. For example, `IssueCredentialOptions` or `EncryptedCredentialOptions`.
		c) For generic types that represent an object consisting of options for creating a persisted entity they should have succeeding `Options` naming convention. For example, `IssueCredentialOptions` or `EncryptedCredentialOptions`.

		@@ -24,0 +24,0 @@ d) Types explicitly for HTTP interfaces ought have a trailing `Dto`, i.e. `PresentationRequestDto`. This is often used to better represent for the JSON serialized attributes `createdAt` and `updatedAt` from `Date` to `string`. Furthermore, if the Data Transfer Object is different between the HTTP request verbs, i.e. GET and POST, then include in the type as such, `PresentationRequestPostDto`.

src/index.ts

		@@ -1005,12 +1005,23 @@ import { Literal, Static, Union } from "runtypes";
		*/
		export interface UserDidAssociation {
		/**
		* Any application user's identifier will do as long as it is unique.
		* However, it is recommend to use the user's objectId.
		*/
		userIdentifier: string;
		subjectDidDocument: SignedDidDocument;
		}
		export interface UserDidAssociation {
		/**
		* Any application user's identifier will do as long as it is unique.
		* However, it is recommend to use the user's objectId.
		*/
		userIdentifier: string;
		subjectDidDocument: SignedDidDocument;
		}

		/**
		* Interface to encapsulate the combined functionality of user DID association with subject credential requests.
		*
		* Note: userDidAssociation is optional because will not be necessary aside for the initial credential requests in order for the customer's user to get an associated DID.
		* Opted to include as part of the credential requests to eliminate the possibility for a user did / credential request race condition.
		*/
		export interface SubjectCredentialRequestsEnrichedDto {
		credentialRequestsInfo: SubjectCredentialRequestsDto;
		userDidAssociation?: UserDidAssociation; // note: optional
		}

		/**
		* Interface to encapsulate the response that the UnumID SaaS is expecting after forwarding the encrypted presentation to the verifier app for verification.
		@@ -1017,0 +1028,0 @@ * Notably it is not the DecryptedPresentation type from the Server SDK returns because the SaaS to never deals with the plaintext presentations.

build/index.d.ts.map