@twin.org/standards-w3c-did 0.0.1-next.7 → 0.0.1-next.9

package/dist/cjs/index.cjs

@@ -17,6 +17,23 @@ const DidContexts = {
     ContextV2: "https://www.w3.org/ns/credentials/v2"
 };
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The types for DIDs.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const DidTypes = {
+    /**
+     * The type for Verifiable Credential.
+     */
+    VerifiableCredential: "VerifiableCredential",
+    /**
+     * The type for Verifiable Presentation.
+     */
+    VerifiablePresentation: "VerifiablePresentation"
+};
+
 /**
  * The types of verification method.
  */
@@ -49,4 +66,5 @@ const DidVerificationMethodType = {
 };
 
 exports.DidContexts = DidContexts;
+exports.DidTypes = DidTypes;
 exports.DidVerificationMethodType = DidVerificationMethodType;

package/dist/esm/index.mjs

@@ -15,6 +15,23 @@ const DidContexts = {
     ContextV2: "https://www.w3.org/ns/credentials/v2"
 };
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The types for DIDs.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const DidTypes = {
+    /**
+     * The type for Verifiable Credential.
+     */
+    VerifiableCredential: "VerifiableCredential",
+    /**
+     * The type for Verifiable Presentation.
+     */
+    VerifiablePresentation: "VerifiablePresentation"
+};
+
 /**
  * The types of verification method.
  */
@@ -46,4 +63,4 @@ const DidVerificationMethodType = {
     CapabilityDelegation: "capabilityDelegation"
 };
 
-export { DidContexts, DidVerificationMethodType };
+export { DidContexts, DidTypes, DidVerificationMethodType };

package/dist/types/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./models/didContexts";
+export * from "./models/didTypes";
 export * from "./models/didVerificationMethodType";
 export * from "./models/IDidCredentialStatus";
 export * from "./models/IDidDocument";

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

@@ -4,7 +4,7 @@ import type { IDidProof } from "./IDidProof";
 /**
  * Interface describing a verifiable credential.
  */
-export interface IDidVerifiableCredential {
+export interface IDidVerifiableCredential<T extends IJsonLdNodeObject = IJsonLdNodeObject> {
     /**
      * The context for the verifiable credential.
      */
@@ -20,7 +20,7 @@ export interface IDidVerifiableCredential {
     /**
      * The data for the verifiable credential.
      */
-    credentialSubject: IJsonLdNodeObject | IJsonLdNodeObject[];
+    credentialSubject: T | T[];
     /**
      * Used to discover information about the current status of the
      * verifiable credential, such as whether it is suspended or revoked.

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

@@ -1,10 +1,10 @@
-import type { IJsonLdContextDefinitionRoot } from "@twin.org/data-json-ld";
+import type { IJsonLdContextDefinitionRoot, IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import type { IDidProof } from "./IDidProof";
 import type { IDidVerifiableCredential } from "./IDidVerifiableCredential";
 /**
  * Interface describing a verifiable presentation.
  */
-export interface IDidVerifiablePresentation {
+export interface IDidVerifiablePresentation<T extends IJsonLdNodeObject = IJsonLdNodeObject> {
     /**
      * The context for the verifiable credential.
      */
@@ -20,7 +20,7 @@ export interface IDidVerifiablePresentation {
     /**
      * The data for the verifiable credentials.
      */
-    verifiableCredential: (string | IDidVerifiableCredential)[];
+    verifiableCredential: (string | IDidVerifiableCredential<T>)[];
     /**
      * The entity generating the presentation.
      */

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

@@ -0,0 +1,17 @@
+/**
+ * The types for DIDs.
+ */
+export declare const DidTypes: {
+    /**
+     * The type for Verifiable Credential.
+     */
+    readonly VerifiableCredential: "VerifiableCredential";
+    /**
+     * The type for Verifiable Presentation.
+     */
+    readonly VerifiablePresentation: "VerifiablePresentation";
+};
+/**
+ * The types for DIDs.
+ */
+export type DidTypes = (typeof DidTypes)[keyof typeof DidTypes];

package/docs/changelog.md

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

package/docs/reference/index.md

@@ -14,9 +14,11 @@
 ## Type Aliases
 
 - [DidContexts](type-aliases/DidContexts.md)
+- [DidTypes](type-aliases/DidTypes.md)
 - [DidVerificationMethodType](type-aliases/DidVerificationMethodType.md)
 
 ## Variables
 
 - [DidContexts](variables/DidContexts.md)
+- [DidTypes](variables/DidTypes.md)
 - [DidVerificationMethodType](variables/DidVerificationMethodType.md)

package/docs/reference/interfaces/IDidVerifiableCredential.md

@@ -1,7 +1,11 @@
-# Interface: IDidVerifiableCredential
+# Interface: IDidVerifiableCredential\<T\>
 
 Interface describing a verifiable credential.
 
+## Type Parameters
+
+• **T** *extends* `IJsonLdNodeObject` = `IJsonLdNodeObject`
+
 ## Properties
 
 ### @context
@@ -30,7 +34,7 @@ The types of the data stored in the verifiable credential.
 
 ### credentialSubject
 
-> **credentialSubject**: `IJsonLdNodeObject` \| `IJsonLdNodeObject`[]
+> **credentialSubject**: `T` \| `T`[]
 
 The data for the verifiable credential.
 

package/docs/reference/interfaces/IDidVerifiablePresentation.md

@@ -1,7 +1,11 @@
-# Interface: IDidVerifiablePresentation
+# Interface: IDidVerifiablePresentation\<T\>
 
 Interface describing a verifiable presentation.
 
+## Type Parameters
+
+• **T** *extends* `IJsonLdNodeObject` = `IJsonLdNodeObject`
+
 ## Properties
 
 ### @context
@@ -30,7 +34,7 @@ The types of the data stored in the verifiable credential.
 
 ### verifiableCredential
 
-> **verifiableCredential**: (`string` \| [`IDidVerifiableCredential`](IDidVerifiableCredential.md))[]
+> **verifiableCredential**: (`string` \| [`IDidVerifiableCredential`](IDidVerifiableCredential.md)\<`T`\>)[]
 
 The data for the verifiable credentials.
 

package/docs/reference/type-aliases/DidTypes.md

@@ -0,0 +1,5 @@
+# Type Alias: DidTypes
+
+> **DidTypes**: *typeof* [`DidTypes`](../variables/DidTypes.md)\[keyof *typeof* [`DidTypes`](../variables/DidTypes.md)\]
+
+The types for DIDs.

package/docs/reference/variables/DidTypes.md

@@ -0,0 +1,19 @@
+# Variable: DidTypes
+
+> `const` **DidTypes**: `object`
+
+The types for DIDs.
+
+## Type declaration
+
+### VerifiableCredential
+
+> `readonly` **VerifiableCredential**: `"VerifiableCredential"` = `"VerifiableCredential"`
+
+The type for Verifiable Credential.
+
+### VerifiablePresentation
+
+> `readonly` **VerifiablePresentation**: `"VerifiablePresentation"` = `"VerifiablePresentation"`
+
+The type for Verifiable Presentation.

package/package.json

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