@twin.org/standards-w3c-did 0.0.1-next.22 → 0.0.1-next.24

package/dist/types/index.d.ts

@@ -2,6 +2,7 @@ export * from "./models/didContexts";
 export * from "./models/didCryptoSuites";
 export * from "./models/didTypes";
 export * from "./models/didVerificationMethodType";
+export * from "./models/IDidCredentialSchema";
 export * from "./models/IDidCredentialStatus";
 export * from "./models/IDidDocument";
 export * from "./models/IDidDocumentVerificationMethod";

package/dist/types/models/IDidCredentialSchema.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Interface describing a DID credential schema.
+ */
+export interface IDidCredentialSchema {
+    /**
+     * The URI id.
+     */
+    id: string;
+    /**
+     * The credential schema type.
+     */
+    type: string;
+}

package/dist/types/models/IDidDocument.d.ts

@@ -10,7 +10,7 @@ export interface IDidDocument {
     /**
      * The context for the document.
      */
-    "@context"?: typeof DidContexts.Context | [typeof DidContexts.Context, IJsonLdContextDefinitionElement];
+    "@context": typeof DidContexts.Context | [typeof DidContexts.Context, ...IJsonLdContextDefinitionElement[]];
     /**
      * The id for the document.
      */

package/dist/types/models/IDidProof.d.ts

@@ -10,11 +10,11 @@ export interface IDidProof {
     /**
      * JSON-LD Context.
      */
-    "@context": typeof DidContexts.ContextVCDataIntegrity | [typeof DidContexts.ContextVCDataIntegrity, IJsonLdContextDefinitionElement];
+    "@context"?: typeof DidContexts.ContextVCDataIntegrity | [typeof DidContexts.ContextVCDataIntegrity, ...IJsonLdContextDefinitionElement[]];
     /**
      * JSON-LD Type.
      */
-    type: typeof DidTypes.DataIntegrityProof;
+    type: typeof DidTypes.DataIntegrityProof | string;
     /**
      * An identifier for the cryptographic suite that can be used to verify the proof.
      */

package/dist/types/models/IDidVerifiableCredential.d.ts

@@ -1,5 +1,6 @@
 import type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import type { DidContexts } from "./didContexts";
+import type { IDidCredentialSchema } from "./IDidCredentialSchema";
 import type { IDidCredentialStatus } from "./IDidCredentialStatus";
 import type { IDidProof } from "./IDidProof";
 /**
@@ -10,7 +11,7 @@ export interface IDidVerifiableCredential {
     /**
      * The context for the verifiable credential.
      */
-    "@context": typeof DidContexts.ContextVCv2 | [typeof DidContexts.ContextVCv2, IJsonLdContextDefinitionElement];
+    "@context": typeof DidContexts.ContextVCv2 | [typeof DidContexts.ContextVCv2, ...IJsonLdContextDefinitionElement[]];
     /**
      * The identifier for the verifiable credential.
      */
@@ -22,20 +23,43 @@ export interface IDidVerifiableCredential {
     /**
      * The data for the verifiable credential.
      */
-    credentialSubject: IJsonLdNodeObject | IJsonLdNodeObject[];
+    credentialSubject?: IJsonLdNodeObject | IJsonLdNodeObject[];
     /**
      * Used to discover information about the current status of the
      * verifiable credential, such as whether it is suspended or revoked.
      */
-    credentialStatus?: IDidCredentialStatus;
+    credentialStatus?: IDidCredentialStatus | IDidCredentialStatus[];
+    /**
+     * Annotate type definitions or lock them to specific versions of the vocabulary.
+     */
+    credentialSchema?: IDidCredentialSchema | IDidCredentialSchema[];
     /**
      * The issuing identity.
      */
-    issuer?: string;
+    issuer?: string | {
+        [key: string]: unknown;
+        id: string;
+    };
     /**
      * The date the verifiable credential was issued.
      */
     issuanceDate?: string;
+    /**
+     * The name of the credential.
+     */
+    name?: string | {
+        "@value": string;
+        "@language": string;
+        "@direction"?: string;
+    }[];
+    /**
+     * The description of the credential.
+     */
+    description?: string | {
+        "@value": string;
+        "@language": string;
+        "@direction"?: string;
+    }[];
     /**
      * The date the verifiable credential is valid from.
      */

package/dist/types/models/IDidVerifiablePresentation.d.ts

@@ -9,7 +9,7 @@ export interface IDidVerifiablePresentation {
     /**
      * The context for the verifiable presentation.
      */
-    "@context": typeof DidContexts.ContextVCv2 | [typeof DidContexts.ContextVCv2, IJsonLdContextDefinitionElement];
+    "@context": typeof DidContexts.ContextVCv2 | [typeof DidContexts.ContextVCv2, ...IJsonLdContextDefinitionElement[]];
     /**
      * Provide a unique identifier for the presentation.
      */
@@ -17,11 +17,11 @@ export interface IDidVerifiablePresentation {
     /**
      * The types of the data stored in the verifiable credential.
      */
-    type: string[];
+    type: string | string[];
     /**
      * The data for the verifiable credentials.
      */
-    verifiableCredential: (string | IDidVerifiableCredential)[];
+    verifiableCredential?: (string | IDidVerifiableCredential)[];
     /**
      * The entity generating the presentation.
      */

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/standards-w3c-did - Changelog
 
-## v0.0.1-next.22
+## v0.0.1-next.24
 
 - Initial Release

package/docs/reference/index.md

@@ -2,6 +2,7 @@
 
 ## Interfaces
 
+- [IDidCredentialSchema](interfaces/IDidCredentialSchema.md)
 - [IDidCredentialStatus](interfaces/IDidCredentialStatus.md)
 - [IDidDocument](interfaces/IDidDocument.md)
 - [IDidDocumentVerificationMethod](interfaces/IDidDocumentVerificationMethod.md)

package/docs/reference/interfaces/IDidCredentialSchema.md

@@ -0,0 +1,19 @@
+# Interface: IDidCredentialSchema
+
+Interface describing a DID credential schema.
+
+## Properties
+
+### id
+
+> **id**: `string`
+
+The URI id.
+
+***
+
+### type
+
+> **type**: `string`
+
+The credential schema type.

package/docs/reference/interfaces/IDidDocument.md

@@ -5,9 +5,9 @@ Spec https://www.w3.org/TR/did-core/#did-document-properties.
 
 ## Properties
 
-### @context?
+### @context
 
-> `optional` **@context**: `"https://www.w3.org/ns/did/v1"` \| \[`"https://www.w3.org/ns/did/v1"`, `IJsonLdContextDefinitionElement`\]
+> **@context**: `"https://www.w3.org/ns/did/v1"` \| \[`"https://www.w3.org/ns/did/v1"`, `...IJsonLdContextDefinitionElement[]`\]
 
 The context for the document.
 

package/docs/reference/interfaces/IDidProof.md

@@ -5,9 +5,9 @@ https://www.w3.org/TR/vc-data-integrity/
 
 ## Properties
 
-### @context
+### @context?
 
-> **@context**: `"https://w3id.org/security/data-integrity/v2"` \| \[`"https://w3id.org/security/data-integrity/v2"`, `IJsonLdContextDefinitionElement`\]
+> `optional` **@context**: `"https://w3id.org/security/data-integrity/v2"` \| \[`"https://w3id.org/security/data-integrity/v2"`, `...IJsonLdContextDefinitionElement[]`\]
 
 JSON-LD Context.
 
@@ -15,7 +15,7 @@ JSON-LD Context.
 
 ### type
 
-> **type**: `"DataIntegrityProof"`
+> **type**: `string`
 
 JSON-LD Type.
 

package/docs/reference/interfaces/IDidVerifiableCredential.md

@@ -7,7 +7,7 @@ https://www.w3.org/TR/vc-data-model-2.0
 
 ### @context
 
-> **@context**: `"https://www.w3.org/ns/credentials/v2"` \| \[`"https://www.w3.org/ns/credentials/v2"`, `IJsonLdContextDefinitionElement`\]
+> **@context**: `"https://www.w3.org/ns/credentials/v2"` \| \[`"https://www.w3.org/ns/credentials/v2"`, `...IJsonLdContextDefinitionElement[]`\]
 
 The context for the verifiable credential.
 
@@ -29,9 +29,9 @@ The types of the data stored in the verifiable credential.
 
 ***
 
-### credentialSubject
+### credentialSubject?
 
-> **credentialSubject**: `IJsonLdNodeObject` \| `IJsonLdNodeObject`[]
+> `optional` **credentialSubject**: `IJsonLdNodeObject` \| `IJsonLdNodeObject`[]
 
 The data for the verifiable credential.
 
@@ -39,16 +39,24 @@ The data for the verifiable credential.
 
 ### credentialStatus?
 
-> `optional` **credentialStatus**: [`IDidCredentialStatus`](IDidCredentialStatus.md)
+> `optional` **credentialStatus**: [`IDidCredentialStatus`](IDidCredentialStatus.md) \| [`IDidCredentialStatus`](IDidCredentialStatus.md)[]
 
 Used to discover information about the current status of the
 verifiable credential, such as whether it is suspended or revoked.
 
 ***
 
+### credentialSchema?
+
+> `optional` **credentialSchema**: [`IDidCredentialSchema`](IDidCredentialSchema.md) \| [`IDidCredentialSchema`](IDidCredentialSchema.md)[]
+
+Annotate type definitions or lock them to specific versions of the vocabulary.
+
+***
+
 ### issuer?
 
-> `optional` **issuer**: `string`
+> `optional` **issuer**: `string` \| \{ `[key: string]`: `unknown`;  `id`: `string`; \}
 
 The issuing identity.
 
@@ -62,6 +70,22 @@ The date the verifiable credential was issued.
 
 ***
 
+### name?
+
+> `optional` **name**: `string` \| `object`[]
+
+The name of the credential.
+
+***
+
+### description?
+
+> `optional` **description**: `string` \| `object`[]
+
+The description of the credential.
+
+***
+
 ### validFrom?
 
 > `optional` **validFrom**: `string`

package/docs/reference/interfaces/IDidVerifiablePresentation.md

@@ -6,7 +6,7 @@ Interface describing a verifiable presentation.
 
 ### @context
 
-> **@context**: `"https://www.w3.org/ns/credentials/v2"` \| \[`"https://www.w3.org/ns/credentials/v2"`, `IJsonLdContextDefinitionElement`\]
+> **@context**: `"https://www.w3.org/ns/credentials/v2"` \| \[`"https://www.w3.org/ns/credentials/v2"`, `...IJsonLdContextDefinitionElement[]`\]
 
 The context for the verifiable presentation.
 
@@ -22,15 +22,15 @@ Provide a unique identifier for the presentation.
 
 ### type
 
-> **type**: `string`[]
+> **type**: `string` \| `string`[]
 
 The types of the data stored in the verifiable credential.
 
 ***
 
-### verifiableCredential
+### verifiableCredential?
 
-> **verifiableCredential**: (`string` \| [`IDidVerifiableCredential`](IDidVerifiableCredential.md))[]
+> `optional` **verifiableCredential**: (`string` \| [`IDidVerifiableCredential`](IDidVerifiableCredential.md))[]
 
 The data for the verifiable credentials.
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/standards-w3c-did",
-	"version": "0.0.1-next.22",
+	"version": "0.0.1-next.24",
 	"description": "Models which define the structure of W3C DID Standard",
 	"repository": {
 		"type": "git",