@trustvc/trustvc 2.12.3 → 2.12.5

package/README.md

@@ -14,7 +14,7 @@ TrustVC is a comprehensive wrapper library designed to simplify the signing and
       - [a) wrapOADocument](#a-wrapoadocument)
       - [b) wrapOADocuments](#b-wrapoadocuments)
     - [2. **Signing**](#2-signing)
-      - [a) OpenAttestation Signing (signOA) v2 v3](#a-openattestation-signing-signoa-v2-v3)
+      - [a) OpenAttestation Signing (signOA) v2](#a-openattestation-signing-signoa-v2)
       - [b) TrustVC W3C Signing (signW3C)](#b-trustvc-w3c-signing-signw3c)
     - [3. **Deriving (Selective Disclosure)**](#3-deriving-selective-disclosure)
     - [4. **Verifying**](#4-verifying)
@@ -44,13 +44,13 @@ npm run test
 
 ### 1. **Wrapping**
 
-> This module provides utility functions for wrapping OpenAttestation documents of version 2 (v2) and version 3 (v3). These functions validate the document version and apply the appropriate wrapping logic using the OpenAttestation library. Note that wrapping is not required for W3C-compliant documents, as they follow a different format and standard.
+> This module provides utility functions for wrapping OpenAttestation documents of version 2 (v2). These functions validate the document version and apply the appropriate wrapping logic using the OpenAttestation library. Note that wrapping is not required for W3C-compliant documents, as they follow a different format and standard.
 
 #### a) wrapOADocument
 
 #### Description
 
-> Wraps a single OpenAttestation document asynchronously, supporting both v2 and v3 documents.
+> Wraps a single OpenAttestation v2 document asynchronously.
 
 #### Parameters
 
@@ -71,7 +71,7 @@ npm run test
 import { wrapOADocument } from '@trustvc/trustvc';
 
 const document = {
-  /* OpenAttestation document (v2 or v3) */
+  /* OpenAttestation v2 document */
 };
 const wrappedDocument = await wrapOADocument(document);
 console.log(wrappedDocument);
@@ -81,7 +81,7 @@ console.log(wrappedDocument);
 
 #### Description
 
-> Wraps multiple OpenAttestation documents asynchronously, supporting both v2 and v3 documents.
+> Wraps multiple OpenAttestation v2 documents asynchronously.
 
 #### Parameters
 
@@ -126,7 +126,7 @@ The signing functionality is split into two methods:
 1. signOA: Designed specifically for signing OpenAttestation documents.
 2. signW3C: Tailored for signing W3C-compliant verifiable credentials.
 
-#### a) OpenAttestation Signing (signOA) [v2](https://github.com/Open-Attestation/open-attestation/tree/master/src/2.0) [v3](https://github.com/Open-Attestation/open-attestation/tree/master/src/3.0)
+#### a) OpenAttestation Signing (signOA) [v2](https://github.com/Open-Attestation/open-attestation/tree/master/src/2.0)
 
 ```ts
 import { wrapOA, signOA } from '@trustvc/trustvc';

package/dist/cjs/open-attestation/wrap.js

@@ -14,7 +14,9 @@ async function wrapOADocument(document) {
   if (tradetrust.utils.isRawV2Document(document)) {
     return wrapOADocumentV2(document);
   } else if (tradetrust.utils.isRawV3Document(document)) {
-    return tradetrust.__unsafe__use__it__at__your__own__risks__wrapDocument(document);
+    throw new Error(
+      "OA v3 is deprecated in TrustVC as of 1 October 2025. Please switch over to W3C VC."
+    );
   } else {
     throw new Error("Unsupported document version");
   }
@@ -23,22 +25,16 @@ __name(wrapOADocument, "wrapOADocument");
 async function wrapOADocuments(documents) {
   if (documents.every((s) => tradetrust.utils.isRawV2Document(s))) {
     return wrapOADocumentsV2(documents);
-  } else if (documents.every((s) => tradetrust.utils.isRawV3Document(s))) {
-    return tradetrust.__unsafe__use__it__at__your__own__risks__wrapDocuments(documents);
+  } else if (documents.some((s) => tradetrust.utils.isRawV3Document(s))) {
+    throw new Error(
+      "OA v3 is deprecated in TrustVC as of 1 October 2025. Please switch over to W3C VC."
+    );
   } else {
     throw new Error("Unsupported documents version");
   }
 }
 __name(wrapOADocuments, "wrapOADocuments");
 
-Object.defineProperty(exports, "wrapOADocumentV3", {
-  enumerable: true,
-  get: function () { return tradetrust.__unsafe__use__it__at__your__own__risks__wrapDocument; }
-});
-Object.defineProperty(exports, "wrapOADocumentsV3", {
-  enumerable: true,
-  get: function () { return tradetrust.__unsafe__use__it__at__your__own__risks__wrapDocuments; }
-});
 exports.wrapOADocument = wrapOADocument;
 exports.wrapOADocumentV2 = wrapOADocumentV2;
 exports.wrapOADocuments = wrapOADocuments;

package/dist/cjs/verify/fragments/issuer-identity/w3cIssuerIdentity.js

@@ -37,7 +37,8 @@ const w3cIssuerIdentity = {
   }, "test"),
   verify: /* @__PURE__ */ __name(async (document, verifierOptions) => {
     const doc = document;
-    if (doc.proof?.verificationMethod?.split("#")[0] !== doc.issuer) {
+    const issuerId = typeof doc.issuer === "string" ? doc.issuer : doc.issuer?.id;
+    if (doc.proof?.verificationMethod?.split("#")[0] !== issuerId) {
       return {
         type: "ISSUER_IDENTITY",
         name: "W3CIssuerIdentity",
@@ -48,7 +49,7 @@ const w3cIssuerIdentity = {
         status: "INVALID"
       };
     }
-    const resolutionResult = await checkDidWebResolve(doc.issuer, verifierOptions?.documentLoader);
+    const resolutionResult = await checkDidWebResolve(issuerId, verifierOptions?.documentLoader);
     if (resolutionResult) {
       return {
         type: "ISSUER_IDENTITY",

package/dist/esm/open-attestation/wrap.js

@@ -1,5 +1,4 @@
-import { wrapDocument, wrapDocuments, utils, __unsafe__use__it__at__your__own__risks__wrapDocument, __unsafe__use__it__at__your__own__risks__wrapDocuments } from '@tradetrust-tt/tradetrust';
-export { __unsafe__use__it__at__your__own__risks__wrapDocument as wrapOADocumentV3, __unsafe__use__it__at__your__own__risks__wrapDocuments as wrapOADocumentsV3 } from '@tradetrust-tt/tradetrust';
+import { wrapDocument, wrapDocuments, utils } from '@tradetrust-tt/tradetrust';
 
 var __defProp = Object.defineProperty;
 var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
@@ -13,7 +12,9 @@ async function wrapOADocument(document) {
   if (utils.isRawV2Document(document)) {
     return wrapOADocumentV2(document);
   } else if (utils.isRawV3Document(document)) {
-    return __unsafe__use__it__at__your__own__risks__wrapDocument(document);
+    throw new Error(
+      "OA v3 is deprecated in TrustVC as of 1 October 2025. Please switch over to W3C VC."
+    );
   } else {
     throw new Error("Unsupported document version");
   }
@@ -22,8 +23,10 @@ __name(wrapOADocument, "wrapOADocument");
 async function wrapOADocuments(documents) {
   if (documents.every((s) => utils.isRawV2Document(s))) {
     return wrapOADocumentsV2(documents);
-  } else if (documents.every((s) => utils.isRawV3Document(s))) {
-    return __unsafe__use__it__at__your__own__risks__wrapDocuments(documents);
+  } else if (documents.some((s) => utils.isRawV3Document(s))) {
+    throw new Error(
+      "OA v3 is deprecated in TrustVC as of 1 October 2025. Please switch over to W3C VC."
+    );
   } else {
     throw new Error("Unsupported documents version");
   }

package/dist/esm/verify/fragments/issuer-identity/w3cIssuerIdentity.js

@@ -35,7 +35,8 @@ const w3cIssuerIdentity = {
   }, "test"),
   verify: /* @__PURE__ */ __name(async (document, verifierOptions) => {
     const doc = document;
-    if (doc.proof?.verificationMethod?.split("#")[0] !== doc.issuer) {
+    const issuerId = typeof doc.issuer === "string" ? doc.issuer : doc.issuer?.id;
+    if (doc.proof?.verificationMethod?.split("#")[0] !== issuerId) {
       return {
         type: "ISSUER_IDENTITY",
         name: "W3CIssuerIdentity",
@@ -46,7 +47,7 @@ const w3cIssuerIdentity = {
         status: "INVALID"
       };
     }
-    const resolutionResult = await checkDidWebResolve(doc.issuer, verifierOptions?.documentLoader);
+    const resolutionResult = await checkDidWebResolve(issuerId, verifierOptions?.documentLoader);
     if (resolutionResult) {
       return {
         type: "ISSUER_IDENTITY",

package/dist/types/index.d.ts

@@ -65,7 +65,7 @@ export { GasStationFeeData, GasStationFunction, calculateMaxFee, gasStation, sca
 export { AwsKmsSigner, AwsKmsSignerCredentials } from '@tradetrust-tt/ethers-aws-kms-signer';
 export { gaEvent, gaPageView, validateGaEvent, validateGtag, validatePageViewEvent } from './utils/analytics/analytics.js';
 export { CustomDnsResolver, IDNSQueryResponse, IDNSRecord, OpenAttestationDNSTextRecord, OpenAttestationDnsDidRecord, defaultDnsResolvers, getDnsDidRecords, getDocumentStoreRecords, parseDnsDidResults, parseDocumentStoreResults, parseOpenAttestationRecord, queryDns } from '@tradetrust-tt/dnsprove';
-export { OpenAttestationDocument, SUPPORTED_SIGNING_ALGORITHM, SchemaId, SignedWrappedDocument, WrappedDocument, getData as getDataV2, isSchemaValidationError, obfuscateDocument, v2, v3, validateSchema, __unsafe__use__it__at__your__own__risks__wrapDocument as wrapOADocumentV3, __unsafe__use__it__at__your__own__risks__wrapDocuments as wrapOADocumentsV3 } from '@tradetrust-tt/tradetrust';
+export { OpenAttestationDocument, SUPPORTED_SIGNING_ALGORITHM, SchemaId, SignedWrappedDocument, WrappedDocument, getData as getDataV2, isSchemaValidationError, obfuscateDocument, v2, v3, validateSchema } from '@tradetrust-tt/tradetrust';
 export { DiagnoseError } from '@tradetrust-tt/tradetrust/dist/types/shared/utils';
 export { createResolver, getIdentifier, isValid, utils, verificationBuilder, verify } from '@tradetrust-tt/tt-verify';
 export { DocumentsToVerify, ErrorVerificationFragment, InvalidVerificationFragment, ProviderDetails, providerType as ProviderType, SkippedVerificationFragment, ValidVerificationFragment, VerificationBuilderOptions, VerificationFragment, VerificationFragmentStatus, VerificationFragmentType, VerificationFragmentWithData, Verifier, VerifierOptions } from '@tradetrust-tt/tt-verify/dist/types/src/types/core';

package/dist/types/open-attestation/index.d.ts

@@ -5,7 +5,7 @@ export { verifyOASignature } from './verify.js';
 export { wrapOADocument, wrapOADocumentV2, wrapOADocuments, wrapOADocumentsV2 } from './wrap.js';
 export { encryptString } from './encrypt.js';
 export { decryptString } from './decrypt.js';
-export { OpenAttestationDocument, SUPPORTED_SIGNING_ALGORITHM, SchemaId, SignedWrappedDocument, WrappedDocument, getData as getDataV2, isSchemaValidationError, obfuscateDocument, v2, v3, validateSchema, __unsafe__use__it__at__your__own__risks__wrapDocument as wrapOADocumentV3, __unsafe__use__it__at__your__own__risks__wrapDocuments as wrapOADocumentsV3 } from '@tradetrust-tt/tradetrust';
+export { OpenAttestationDocument, SUPPORTED_SIGNING_ALGORITHM, SchemaId, SignedWrappedDocument, WrappedDocument, getData as getDataV2, isSchemaValidationError, obfuscateDocument, v2, v3, validateSchema } from '@tradetrust-tt/tradetrust';
 export { DiagnoseError } from '@tradetrust-tt/tradetrust/dist/types/shared/utils';
 import '@ethersproject/abstract-signer';
 import '@tradetrust-tt/tradetrust/dist/types/3.0/types';

package/dist/types/open-attestation/wrap.d.ts

@@ -1,5 +1,4 @@
 import { OpenAttestationDocument, WrappedDocument, v2 } from '@tradetrust-tt/tradetrust';
-export { __unsafe__use__it__at__your__own__risks__wrapDocument as wrapOADocumentV3, __unsafe__use__it__at__your__own__risks__wrapDocuments as wrapOADocumentsV3 } from '@tradetrust-tt/tradetrust';
 
 /**
  * Asynchronously wraps a V2 OpenAttestation document.
@@ -25,25 +24,23 @@ declare const wrapOADocumentV2: <T extends v2.OpenAttestationDocument>(document:
  */
 declare const wrapOADocumentsV2: <T extends v2.OpenAttestationDocument>(documents: T[]) => Promise<v2.WrappedDocument<T>[]>;
 /**
- * Asynchronously wraps a v2 / v3 OpenAttestation document.
+ * Asynchronously wraps a V2 OpenAttestation document.
  *
  * This function takes an OpenAttestation document and validates its version before wrapping it
- * using the OpenAttestation library's `wrapOADocument` function. The function will throw any errors
- * encountered during the wrapping process, as handled by the OpenAttestation library.
+ * using the OpenAttestation library's `wrapOADocument` function. Only V2 documents are supported.
  * @param {OpenAttestationDocument} document - The OpenAttestation document to be wrapped.
  * @returns {Promise<WrappedDocument>} - A promise that resolves to the wrapped document.
- * @throws {Error} - Any errors thrown by the `wrapOADocument` function will propagate naturally.
+ * @throws {Error} - Throws if the document is not a V2 document.
  */
 declare function wrapOADocument<T extends OpenAttestationDocument>(document: T): Promise<WrappedDocument<T>>;
 /**
- * Asynchronously wraps multiple v2 / v3 OpenAttestation documents.
+ * Asynchronously wraps multiple V2 OpenAttestation documents.
  *
  * This function takes an array of OpenAttestation documents and validates their versions before wrapping them
- * using the OpenAttestation library's `wrapOADocuments` function. The function will throw any errors
- * encountered during the wrapping process, as handled by the OpenAttestation library.
+ * using the OpenAttestation library's `wrapOADocuments` function. Only V2 documents are supported.
  * @param {OpenAttestationDocument[]} documents - The OpenAttestation documents to be wrapped.
  * @returns {Promise<WrappedDocument[]>} - A promise that resolves to the wrapped documents.
- * @throws {Error} - Any errors thrown by the `wrapOADocuments` function will propagate naturally.
+ * @throws {Error} - Throws if any document is not a V2 document.
  */
 declare function wrapOADocuments<T extends OpenAttestationDocument>(documents: T[]): Promise<WrappedDocument<T>[]>;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trustvc/trustvc",
-  "version": "2.12.3",
+  "version": "2.12.5",
   "description": "TrustVC library",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",