[SignedDidDocument] types and proto added. (#81)

* [SignedDidDocument] type added.

* [DidDocService] from protos leveraged.

* cleanup

* [SignedDidDocument] proto added.

build/index.d.ts

@@ -3,7 +3,7 @@ import { Literal, Static, Union } from "runtypes";
 import { SemVer } from 'semver';
 import { UnsignedPresentation as UnsignedPresentationPb, Presentation as PresentationPb } from "./protos/presentation";
 import { UnsignedPresentationRequest as UnsignedPresentationRequestPb, PresentationRequest as PresentationRequestPb } from "./protos/presentationRequest";
-import { DidDocument as DidDocumentPb, DidDocumentService } from "./protos/didDocument";
+import { DidDocument as DidDocumentPb, SignedDidDocument as SignedDidDocumentPb, DidDocumentService } from "./protos/didDocument";
 import { Proof as ProofPb } from "./protos/proof";
 import { UnsignedCredential as UnsignedCredentialPb, Credential as CredentialPb, CredentialRequest as CredentialRequestPb, CredentialStatusInfo, IssueCredentialOptions, IssueCredentialsOptions, EncryptedCredential as EncryptedCredentialPb, EncryptedCredentialOptions as EncryptedCredentialOptionsPb, EncryptedCredentialEnriched, SubjectCredentialRequest } from "./protos/credential";
 import { EncryptedData as EncryptedDataPb, EncryptedKey, RSAPadding, PublicKeyInfo as PublicKeyInfoPb } from "./protos/crypto";
@@ -15,7 +15,7 @@ import { VerifierInfo as VerifierInfoPb } from "./protos/verifier";
  * The "Pb" serves to differentiate until we can ditch the legacy ts defined types.
  */
 export { UnsignedPresentationPb, PresentationPb, };
-export { DidDocumentPb, DidDocumentService };
+export { DidDocumentPb, DidDocumentService, SignedDidDocumentPb };
 export { UnsignedPresentationRequestPb, PresentationRequestPb, };
 export { IssueCredentialOptions, IssueCredentialsOptions, CredentialStatusInfo, CredentialRequestPb, UnsignedCredentialPb, CredentialPb, EncryptedCredentialPb, EncryptedCredentialOptionsPb, EncryptedCredentialEnriched, RSAPadding, SubjectCredentialRequest };
 export { PresentationRequestEnriched };
@@ -658,11 +658,20 @@ export interface DidDocument {
     created: Date;
     updated: Date;
     publicKey: PublicKeyInfo[];
-    service: {
-        id: string;
-        serviceEndpoint: string;
-        type: string;
-    }[];
+    service: DidDocumentService[];
+}
+/**
+ * Interface to encapsulate a signed Subject Did Document.
+ * Note: it breaks the name convention of the singed type counterpart being the simpler name of the two, however because the unsigned DidDocument definition was claimed first, this is an exception to the rule.
+ */
+export interface SignedDidDocument {
+    '@context': ['https://www.w3.org/ns/did/v1', ...string[]];
+    id: string;
+    created: Date;
+    updated: Date;
+    publicKey: PublicKeyInfo[];
+    service: DidDocumentService[];
+    proof: Proof;
 }
 /**
  * Type to encapsulate supported key types in did documents.

build/protos/credential.d.ts

@@ -36,7 +36,10 @@ export interface Credential {
     /** optional in the ts types */
     expirationDate: Date | undefined;
 }
-/** Object that encapsulates Credential information requested. */
+/**
+ * Object that encapsulates Credential information requested.
+ * Note this is used moslty used within Presentations and PresentationRequests. However it can also be used as an UnsignedCredentialRequest when dealing with a signed SubjectCredentialRequest.
+ */
 export interface CredentialRequest {
     /** the string matching the desire credential type */
     type: string;
@@ -48,13 +51,14 @@ export interface CredentialRequest {
 /**
  * Object that encapsulates a Subject's request for a Credential.
  * Note: this is different than the original CredentialRequest which lives in a Presentation(Request) object.
+ * Also, it breaks the name convention of the singed type counterpart being the simpler name of the two, however because the unsigned CredentialRequest definition was claimed first, this is an exception to the rule.
  */
 export interface SubjectCredentialRequest {
     /** the string matching the desire credential type */
     type: string;
     /** list of acceptable issuer DIDs that have issued the credential */
     issuers: string[];
-    /** to denote wether this particular credential is required in response to the PresentationRequest. Defaults behavior resolves this to true. */
+    /** to denote wether this particular credential is required. Defaults behavior resolves this to true. */
     required: boolean;
     /** proof signed by the subject */
     proof: Proof | undefined;