@twin.org/standards-w3c-did 0.0.1-next.14 → 0.0.1-next.16

package/dist/cjs/index.cjs

@@ -33,6 +33,25 @@ const DidContexts = {
     ContextVCDataIntegrity: "https://w3id.org/security/data-integrity/v2"
 };
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The types for DID Proof crypto suites.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const DidCryptoSuites = {
+    /**
+     * The type for EdDSA crypto suite for JSON Canonicalization Scheme [RFC8785].
+     * https://www.w3.org/TR/vc-di-eddsa/#eddsa-jcs-2022
+     */
+    EdDSAJcs2022: "eddsa-jcs-2022",
+    /**
+     * The type for EdDSA crypto suite for RDF Dataset Canonicalization.
+     * https://www.w3.org/TR/vc-di-eddsa/#eddsa-rdfc-2022
+     */
+    EdDSARdfc2022: "eddsa-rdfc-2022"
+};
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -98,5 +117,6 @@ const DidVerificationMethodType = {
 };
 
 exports.DidContexts = DidContexts;
+exports.DidCryptoSuites = DidCryptoSuites;
 exports.DidTypes = DidTypes;
 exports.DidVerificationMethodType = DidVerificationMethodType;

package/dist/esm/index.mjs

@@ -31,6 +31,25 @@ const DidContexts = {
     ContextVCDataIntegrity: "https://w3id.org/security/data-integrity/v2"
 };
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The types for DID Proof crypto suites.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const DidCryptoSuites = {
+    /**
+     * The type for EdDSA crypto suite for JSON Canonicalization Scheme [RFC8785].
+     * https://www.w3.org/TR/vc-di-eddsa/#eddsa-jcs-2022
+     */
+    EdDSAJcs2022: "eddsa-jcs-2022",
+    /**
+     * The type for EdDSA crypto suite for RDF Dataset Canonicalization.
+     * https://www.w3.org/TR/vc-di-eddsa/#eddsa-rdfc-2022
+     */
+    EdDSARdfc2022: "eddsa-rdfc-2022"
+};
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -95,4 +114,4 @@ const DidVerificationMethodType = {
     CapabilityDelegation: "capabilityDelegation"
 };
 
-export { DidContexts, DidTypes, DidVerificationMethodType };
+export { DidContexts, DidCryptoSuites, DidTypes, DidVerificationMethodType };

package/dist/types/index.d.ts

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

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

@@ -1,4 +1,5 @@
 import type { DidContexts } from "./didContexts";
+import type { DidCryptoSuites } from "./didCryptoSuites";
 import type { DidTypes } from "./didTypes";
 /**
  * Interface describing a did proof.
@@ -8,7 +9,7 @@ export interface IDidProof {
     /**
      * JSON-LD Context.
      */
-    "@context"?: typeof DidContexts.ContextVCDataIntegrity | [typeof DidContexts.ContextVCDataIntegrity, ...string[]];
+    "@context": typeof DidContexts.ContextVCDataIntegrity | [typeof DidContexts.ContextVCDataIntegrity, ...string[]];
     /**
      * JSON-LD Type.
      */
@@ -16,7 +17,7 @@ export interface IDidProof {
     /**
      * An identifier for the cryptographic suite that can be used to verify the proof.
      */
-    cryptosuite: string;
+    cryptosuite: DidCryptoSuites | string;
     /**
      * The id of the proof.
      */
@@ -29,7 +30,7 @@ export interface IDidProof {
      * Contains the base-encoded binary data necessary to verify the
      * digital proof using the verificationMethod specified.
      */
-    proofValue?: string;
+    proofValue: string;
     /**
      * The verification method of the proof.
      */

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

@@ -1,14 +1,15 @@
-import type { IJsonLdContextDefinitionRoot, IJsonLdObject } from "@twin.org/data-json-ld";
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { DidContexts } from "./didContexts";
 import type { IDidCredentialStatus } from "./IDidCredentialStatus";
 import type { IDidProof } from "./IDidProof";
 /**
  * Interface describing a verifiable credential.
  */
-export interface IDidVerifiableCredential<T extends IJsonLdObject = IJsonLdObject> {
+export interface IDidVerifiableCredential {
     /**
      * The context for the verifiable credential.
      */
-    "@context": IJsonLdContextDefinitionRoot;
+    "@context": typeof DidContexts.ContextVCv2 | [typeof DidContexts.ContextVCv2, ...string[]];
     /**
      * The identifier for the verifiable credential.
      */
@@ -20,7 +21,7 @@ export interface IDidVerifiableCredential<T extends IJsonLdObject = IJsonLdObjec
     /**
      * The data for the verifiable credential.
      */
-    credentialSubject: T | T[];
+    credentialSubject: IJsonLdNodeObject | IJsonLdNodeObject[];
     /**
      * 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,14 +1,14 @@
-import type { IJsonLdContextDefinitionRoot, IJsonLdObject } from "@twin.org/data-json-ld";
+import type { DidContexts } from "./didContexts";
 import type { IDidProof } from "./IDidProof";
 import type { IDidVerifiableCredential } from "./IDidVerifiableCredential";
 /**
  * Interface describing a verifiable presentation.
  */
-export interface IDidVerifiablePresentation<T extends IJsonLdObject = IJsonLdObject> {
+export interface IDidVerifiablePresentation {
     /**
-     * The context for the verifiable credential.
+     * The context for the verifiable presentation.
      */
-    "@context": IJsonLdContextDefinitionRoot;
+    "@context": typeof DidContexts.ContextVCv2 | [typeof DidContexts.ContextVCv2, ...string[]];
     /**
      * Provide a unique identifier for the presentation.
      */
@@ -20,7 +20,7 @@ export interface IDidVerifiablePresentation<T extends IJsonLdObject = IJsonLdObj
     /**
      * The data for the verifiable credentials.
      */
-    verifiableCredential: (string | IDidVerifiableCredential<T>)[];
+    verifiableCredential: (string | IDidVerifiableCredential)[];
     /**
      * The entity generating the presentation.
      */

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

@@ -0,0 +1,19 @@
+/**
+ * The types for DID Proof crypto suites.
+ */
+export declare const DidCryptoSuites: {
+    /**
+     * The type for EdDSA crypto suite for JSON Canonicalization Scheme [RFC8785].
+     * https://www.w3.org/TR/vc-di-eddsa/#eddsa-jcs-2022
+     */
+    readonly EdDSAJcs2022: "eddsa-jcs-2022";
+    /**
+     * The type for EdDSA crypto suite for RDF Dataset Canonicalization.
+     * https://www.w3.org/TR/vc-di-eddsa/#eddsa-rdfc-2022
+     */
+    readonly EdDSARdfc2022: "eddsa-rdfc-2022";
+};
+/**
+ * The types for DID Proof crypto suites.
+ */
+export type DidCryptoSuites = (typeof DidCryptoSuites)[keyof typeof DidCryptoSuites];

package/docs/changelog.md

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

package/docs/reference/index.md

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

package/docs/reference/interfaces/IDidProof.md

@@ -5,9 +5,9 @@ https://www.w3.org/TR/vc-data-integrity/
 
 ## Properties
 
-### @context?
+### @context
 
-> `optional` **@context**: `"https://w3id.org/security/data-integrity/v2"` \| [`"https://w3id.org/security/data-integrity/v2"`, `...string[]`]
+> **@context**: `"https://w3id.org/security/data-integrity/v2"` \| [`"https://w3id.org/security/data-integrity/v2"`, `...string[]`]
 
 JSON-LD Context.
 
@@ -45,9 +45,9 @@ The reason the proof was created.
 
 ***
 
-### proofValue?
+### proofValue
 
-> `optional` **proofValue**: `string`
+> **proofValue**: `string`
 
 Contains the base-encoded binary data necessary to verify the
 digital proof using the verificationMethod specified.

package/docs/reference/interfaces/IDidVerifiableCredential.md

@@ -1,16 +1,12 @@
-# Interface: IDidVerifiableCredential\<T\>
+# Interface: IDidVerifiableCredential
 
 Interface describing a verifiable credential.
 
-## Type Parameters
-
-• **T** *extends* `IJsonLdObject` = `IJsonLdObject`
-
 ## Properties
 
 ### @context
 
-> **@context**: `IJsonLdContextDefinitionRoot`
+> **@context**: `"https://www.w3.org/ns/credentials/v2"` \| [`"https://www.w3.org/ns/credentials/v2"`, `...string[]`]
 
 The context for the verifiable credential.
 
@@ -34,7 +30,7 @@ The types of the data stored in the verifiable credential.
 
 ### credentialSubject
 
-> **credentialSubject**: `T` \| `T`[]
+> **credentialSubject**: `IJsonLdNodeObject` \| `IJsonLdNodeObject`[]
 
 The data for the verifiable credential.
 

package/docs/reference/interfaces/IDidVerifiablePresentation.md

@@ -1,18 +1,14 @@
-# Interface: IDidVerifiablePresentation\<T\>
+# Interface: IDidVerifiablePresentation
 
 Interface describing a verifiable presentation.
 
-## Type Parameters
-
-• **T** *extends* `IJsonLdObject` = `IJsonLdObject`
-
 ## Properties
 
 ### @context
 
-> **@context**: `IJsonLdContextDefinitionRoot`
+> **@context**: `"https://www.w3.org/ns/credentials/v2"` \| [`"https://www.w3.org/ns/credentials/v2"`, `...string[]`]
 
-The context for the verifiable credential.
+The context for the verifiable presentation.
 
 ***
 
@@ -34,7 +30,7 @@ The types of the data stored in the verifiable credential.
 
 ### verifiableCredential
 
-> **verifiableCredential**: (`string` \| [`IDidVerifiableCredential`](IDidVerifiableCredential.md)\<`T`\>)[]
+> **verifiableCredential**: (`string` \| [`IDidVerifiableCredential`](IDidVerifiableCredential.md))[]
 
 The data for the verifiable credentials.
 

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

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

package/docs/reference/variables/DidCryptoSuites.md

@@ -0,0 +1,21 @@
+# Variable: DidCryptoSuites
+
+> `const` **DidCryptoSuites**: `object`
+
+The types for DID Proof crypto suites.
+
+## Type declaration
+
+### EdDSAJcs2022
+
+> `readonly` **EdDSAJcs2022**: `"eddsa-jcs-2022"` = `"eddsa-jcs-2022"`
+
+The type for EdDSA crypto suite for JSON Canonicalization Scheme [RFC8785].
+https://www.w3.org/TR/vc-di-eddsa/#eddsa-jcs-2022
+
+### EdDSARdfc2022
+
+> `readonly` **EdDSARdfc2022**: `"eddsa-rdfc-2022"` = `"eddsa-rdfc-2022"`
+
+The type for EdDSA crypto suite for RDF Dataset Canonicalization.
+https://www.w3.org/TR/vc-di-eddsa/#eddsa-rdfc-2022

package/package.json

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