@cooperation/vc-storage 1.0.41 → 1.0.43

package/dist/models/CredentialEngine.js

@@ -73,6 +73,33 @@ export class CredentialEngine {
         }));
         return true;
     }
+    /**
+     * For recommendations we need the *target VC DID/URI* (VC `id`) in the payload.
+     * Callers may still pass a Google Drive file id; if so we resolve and extract the VC `id`.
+     */
+    async resolveTargetVcId(vcIdOrFileId) {
+        if (!vcIdOrFileId)
+            throw new Error('Missing target VC reference');
+        // Already a DID/URI
+        if (vcIdOrFileId.startsWith('urn:') || vcIdOrFileId.startsWith('did:')) {
+            return vcIdOrFileId;
+        }
+        // Otherwise assume it's a Google Drive file id and resolve
+        const retrieved = await this.storage.retrieve(vcIdOrFileId);
+        if (!retrieved?.data)
+            throw new Error(`Unable to resolve VC from file id: ${vcIdOrFileId}`);
+        const maybeEnvelope = retrieved.data;
+        const payload = typeof maybeEnvelope?.body === 'string'
+            ? JSON.parse(maybeEnvelope.body)
+            : maybeEnvelope?.body
+                ? maybeEnvelope.body
+                : maybeEnvelope;
+        const resolvedId = payload?.id;
+        if (!resolvedId || typeof resolvedId !== 'string') {
+            throw new Error(`Resolved VC is missing an 'id' (from file id: ${vcIdOrFileId})`);
+        }
+        return resolvedId;
+    }
     /**
      * Create a new DID with Digital Bazaar's Ed25519VerificationKey2020 key pair.
      * @returns {Promise<{didDocument: object, keyPair: object}>} The created DID document and key pair.
@@ -143,8 +170,10 @@ export class CredentialEngine {
             case 'RECOMMENDATION':
                 if (!vcFileId)
                     throw new Error('vcFileId is required for recommendation');
+                // Ensure the Recommendation VC references the target VC DID/URI (not a Drive file id)
+                const targetVcId = await this.resolveTargetVcId(vcFileId);
                 credential = generateUnsignedRecommendation({
-                    vcId: vcFileId,
+                    vcId: targetVcId,
                     recommendation: data,
                     issuerDid: issuerId,
                 });

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

@@ -1,4 +1,5 @@
-import { DidDocument, KeyPair, FormDataI, RecommendationFormDataI, VerifiableCredential, EmploymentFormDataI, PerformanceReviewFormDataI, VolunteeringFormDataI } from '../../types/credential.js';
+import type { IVerifiableCredential } from '@digitalcredentials/ssi';
+import { DidDocument, KeyPair, FormDataI, RecommendationFormDataI, EmploymentFormDataI, PerformanceReviewFormDataI, VolunteeringFormDataI } from '../../types';
 import { GoogleDriveStorage } from './GoogleDriveStorage.js';
 interface SignPropsI {
     data: FormDataI | RecommendationFormDataI | EmploymentFormDataI | VolunteeringFormDataI | PerformanceReviewFormDataI;
@@ -25,6 +26,11 @@ export declare class CredentialEngine {
     private getKeyPair;
     private generateKeyPair;
     private verifyCreds;
+    /**
+     * For recommendations we need the *target VC DID/URI* (VC `id`) in the payload.
+     * Callers may still pass a Google Drive file id; if so we resolve and extract the VC `id`.
+     */
+    private resolveTargetVcId;
     /**
      * Create a new DID with Digital Bazaar's Ed25519VerificationKey2020 key pair.
      * @returns {Promise<{didDocument: object, keyPair: object}>} The created DID document and key pair.
@@ -68,13 +74,13 @@ export declare class CredentialEngine {
      * @returns {Promise<boolean>} The verification result.
      * @throws Will throw an error if VC verification fails.
      */
-    verifyCredential(credential: VerifiableCredential): Promise<boolean>;
+    verifyCredential(credential: IVerifiableCredential): Promise<boolean>;
     /**
      * Create a Verifiable Presentation (VP)
      * @param verifiableCredential
      * @returns
      */
-    createPresentation(verifiableCredential: VerifiableCredential[]): Promise<any>;
+    createPresentation(verifiableCredential: IVerifiableCredential[]): Promise<any>;
     /**
      * Sign a Verifiable Presentation (VP)
      * @param presentation

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

@@ -28,5 +28,5 @@ export declare class ResumeVC {
      */
     createDID({ keyPair }: {
         keyPair: any;
-    }): Promise<import("../../types/credential.js").DidDocument>;
+    }): Promise<import("../../types/Credential.js").DidDocument>;
 }

package/dist/types/utils/credential.d.ts

@@ -1,4 +1,5 @@
-import { KeyPair, DidDocument, FormDataI, RecommendationCredential, Credential, RecommendationFormDataI, VerifiableCredential, EmploymentFormDataI, VolunteeringFormDataI, PerformanceReviewFormDataI } from '../../types';
+import { KeyPair, DidDocument, FormDataI, RecommendationFormDataI, EmploymentFormDataI, VolunteeringFormDataI, PerformanceReviewFormDataI } from '../../types';
+import { IVerifiableCredential } from '@digitalcredentials/ssi';
 /**
  * Create a DID document using the provided key pair.
  * @param {KeyPair} keyPair - The key pair used to create the DID document.
@@ -12,201 +13,52 @@ export declare const generateDIDSchema: (keyPair: KeyPair) => Promise<DidDocumen
  * @param {FormDataI} params
  * @param {string} params.FormData - The form dta to include in the VC.
  * @param {string} params.issuerDid - The DID of the issuer.
- * @returns {Credential} The created unsigned VC.
+ * @returns {IVerifiableCredential} The created unsigned VC.
  * @throws Will throw an error if the VC creation fails or if issuance date exceeds expiration date.
  */
 export declare function generateUnsignedVC({ formData, issuerDid }: {
     formData: FormDataI;
     issuerDid: string;
-}): Credential;
+}): IVerifiableCredential;
 /**
  * Generate an unsigned Recommendation Credential.
  * Uses the hash of the VC to set the `id` for consistency.
  * @param {object} params
- * @param {VerifiableCredential} params.vc - The Verifiable Credential to base the recommendation on.
+ * @param {IVerifiableCredential} params.vc - The Verifiable Credential to base the recommendation on.
  * @param {RecommendationFormDataI} params.recommendation - The recommendation form data.
  * @param {string} params.issuerDid - The DID of the issuer.
- * @returns {RecommendationCredential} The created unsigned Recommendation Credential.
+ * @returns {IVerifiableCredential} The created unsigned Recommendation Credential.
  * @throws Will throw an error if the recommendation creation fails or if issuance date exceeds expiration date.
  */
 export declare function generateUnsignedRecommendation({ vcId, recommendation, issuerDid, }: {
     vcId: string;
     recommendation: RecommendationFormDataI;
     issuerDid: string;
-}): RecommendationCredential;
+}): IVerifiableCredential;
 /**
  * Generate an unsigned Employment Credential.
  */
 export declare function generateUnsignedEmployment({ formData, issuerDid }: {
     formData: EmploymentFormDataI;
     issuerDid: string;
-}): {
-    '@context': (string | {
-        '@vocab': string;
-        fullName: string;
-        persons: string;
-        credentialName: string;
-        credentialDuration: string;
-        credentialDescription: string;
-        portfolio: {
-            '@id': string;
-            '@container': string;
-        };
-        name: string;
-        url: string;
-        evidenceLink: string;
-        evidenceDescription: string;
-        company: string;
-        role: string;
-    })[];
-    id: string;
-    type: string[];
-    issuer: {
-        id: string;
-        type: string[];
-    };
-    issuanceDate: string;
-    credentialSubject: {
-        type: string[];
-        fullName: string;
-        persons: string;
-        credentialName: string;
-        credentialDuration: string;
-        credentialDescription: string;
-        portfolio: {
-            name: string;
-            url: string;
-        }[];
-        evidenceLink: string;
-        evidenceDescription: string;
-        company: string;
-        role: string;
-    };
-};
+}): IVerifiableCredential;
 /**
  * Generate an unsigned Volunteering Credential.
  */
 export declare function generateUnsignedVolunteering({ formData, issuerDid }: {
     formData: VolunteeringFormDataI;
     issuerDid: string;
-}): {
-    '@context': (string | {
-        '@vocab': string;
-        fullName: string;
-        persons: string;
-        volunteerWork: string;
-        volunteerOrg: string;
-        volunteerDescription: string;
-        skillsGained: {
-            '@id': string;
-            '@container': string;
-        };
-        duration: string;
-        volunteerDates: string;
-        portfolio: {
-            '@id': string;
-            '@container': string;
-        };
-        name: string;
-        url: string;
-        evidenceLink: string;
-        evidenceDescription: string;
-    })[];
-    id: string;
-    type: string[];
-    issuer: {
-        id: string;
-        type: string[];
-    };
-    issuanceDate: string;
-    credentialSubject: {
-        type: string[];
-        fullName: string;
-        persons: string;
-        volunteerWork: string;
-        volunteerOrg: string;
-        volunteerDescription: string;
-        skillsGained: string[];
-        duration: string;
-        volunteerDates: string;
-        portfolio: {
-            name: string;
-            url: string;
-        }[];
-        evidenceLink: string;
-        evidenceDescription: string;
-    };
-};
+}): IVerifiableCredential;
 /**
  * Generate an unsigned Performance Review Credential.
  */
 export declare function generateUnsignedPerformanceReview({ formData, issuerDid }: {
     formData: PerformanceReviewFormDataI;
     issuerDid: string;
-}): {
-    '@context': (string | {
-        '@vocab': string;
-        fullName: string;
-        persons: string;
-        employeeName: string;
-        employeeJobTitle: string;
-        company: string;
-        role: string;
-        reviewStartDate: string;
-        reviewEndDate: string;
-        reviewDuration: string;
-        jobKnowledgeRating: string;
-        teamworkRating: string;
-        initiativeRating: string;
-        communicationRating: string;
-        overallRating: string;
-        reviewComments: string;
-        goalsNext: string;
-        portfolio: {
-            '@id': string;
-            '@container': string;
-        };
-        name: string;
-        url: string;
-        evidenceLink: string;
-        evidenceDescription: string;
-    })[];
-    id: string;
-    type: string[];
-    issuer: {
-        id: string;
-        type: string[];
-    };
-    issuanceDate: string;
-    credentialSubject: {
-        type: string[];
-        fullName: string;
-        persons: string;
-        employeeName: string;
-        employeeJobTitle: string;
-        company: string;
-        role: string;
-        reviewStartDate: string;
-        reviewEndDate: string;
-        reviewDuration: string;
-        jobKnowledgeRating: string;
-        teamworkRating: string;
-        initiativeRating: string;
-        communicationRating: string;
-        overallRating: string;
-        reviewComments: string;
-        goalsNext: string;
-        portfolio: {
-            name: string;
-            url: string;
-        }[];
-        evidenceLink: string;
-        evidenceDescription: string;
-    };
-};
+}): IVerifiableCredential;
 /**
  * Extracts the keypair from a Verifiable Credential
  * @param {Object} credential - The signed Verifiable Credential
  * @returns {Ed25519VerificationKey2020} keyPair - The generated keypair object
  */
-export declare function extractKeyPairFromCredential(credential: VerifiableCredential): Promise<KeyPair>;
+export declare function extractKeyPairFromCredential(credential: IVerifiableCredential): Promise<KeyPair>;

package/dist/types/utils/google.d.ts

@@ -22,10 +22,10 @@ export declare const getVCWithRecommendations: ({ vcId, storage }: {
  * @param {object} data - The data to save.
  * @param {FileType} data.type - The type of data being saved.
  * @returns {Promise<object>} - The file object saved to Google Drive.
- * @param {string} data.vcId - Optional unique identifier for the VC to link the recommendations.
+ * @param {string} data.vcId - When `type` is RECOMMENDATION, this is the Google Drive file id of the parent VC (named "VC") to link against.
  * @throws Will throw an error if the save operation fails.
  */
-export declare function saveToGoogleDrive({ storage, data, type }: SaveToGooglePropsI): Promise<any>;
+export declare function saveToGoogleDrive({ storage, data, type, vcId }: SaveToGooglePropsI): Promise<any>;
 /**
  * Upload any type of file to Google Drive in the Credentials/MEDIAs folder.
  * @param {GoogleDriveStorage} storage - The GoogleDriveStorage instance.

package/dist/utils/credential.js

@@ -60,7 +60,7 @@ export const generateDIDSchema = async (keyPair) => {
  * @param {FormDataI} params
  * @param {string} params.FormData - The form dta to include in the VC.
  * @param {string} params.issuerDid - The DID of the issuer.
- * @returns {Credential} The created unsigned VC.
+ * @returns {IVerifiableCredential} The created unsigned VC.
  * @throws Will throw an error if the VC creation fails or if issuance date exceeds expiration date.
  */
 export function generateUnsignedVC({ formData, issuerDid }) {
@@ -127,10 +127,10 @@ export function generateUnsignedVC({ formData, issuerDid }) {
  * Generate an unsigned Recommendation Credential.
  * Uses the hash of the VC to set the `id` for consistency.
  * @param {object} params
- * @param {VerifiableCredential} params.vc - The Verifiable Credential to base the recommendation on.
+ * @param {IVerifiableCredential} params.vc - The Verifiable Credential to base the recommendation on.
  * @param {RecommendationFormDataI} params.recommendation - The recommendation form data.
  * @param {string} params.issuerDid - The DID of the issuer.
- * @returns {RecommendationCredential} The created unsigned Recommendation Credential.
+ * @returns {IVerifiableCredential} The created unsigned Recommendation Credential.
  * @throws Will throw an error if the recommendation creation fails or if issuance date exceeds expiration date.
  */
 export function generateUnsignedRecommendation({ vcId, recommendation, issuerDid, }) {
@@ -149,7 +149,7 @@ export function generateUnsignedRecommendation({ vcId, recommendation, issuerDid
                 portfolio: 'https://schema.org/portfolio',
             },
         ],
-        id: `urn:${generateHashedId({ id: vcId })}`,
+        id: ``,
         type: ['VerifiableCredential', 'https://schema.org/RecommendationCredential'],
         issuer: {
             id: issuerDid,
@@ -158,6 +158,7 @@ export function generateUnsignedRecommendation({ vcId, recommendation, issuerDid
         issuanceDate,
         expirationDate: recommendation.expirationDate,
         credentialSubject: {
+            id: vcId,
             name: recommendation.fullName,
             howKnow: recommendation.howKnow,
             recommendationText: recommendation.recommendationText,
@@ -169,6 +170,8 @@ export function generateUnsignedRecommendation({ vcId, recommendation, issuerDid
             })),
         },
     };
+    // Generate the hashed ID
+    unsignedRecommendation.id = 'urn:' + generateHashedId(unsignedRecommendation);
     return unsignedRecommendation;
 }
 /**
@@ -272,7 +275,7 @@ export function generateUnsignedPerformanceReview({ formData, issuerDid }) {
  */
 export async function extractKeyPairFromCredential(credential) {
     const verificationMethod = credential.proof.verificationMethod;
-    const issuer = credential.issuer.id;
+    const issuer = typeof credential.issuer === 'string' ? credential.issuer : credential.issuer.id;
     // Example of extracting the public key from the DID fragment (verification method)
     const publicKeyMultibase = verificationMethod.split('#')[1];
     // Generate the keypair using Ed25519VerificationKey2020

package/dist/utils/google.js

@@ -19,10 +19,10 @@ export const getVCWithRecommendations = async ({ vcId, storage }) => {
  * @param {object} data - The data to save.
  * @param {FileType} data.type - The type of data being saved.
  * @returns {Promise<object>} - The file object saved to Google Drive.
- * @param {string} data.vcId - Optional unique identifier for the VC to link the recommendations.
+ * @param {string} data.vcId - When `type` is RECOMMENDATION, this is the Google Drive file id of the parent VC (named "VC") to link against.
  * @throws Will throw an error if the save operation fails.
  */
-export async function saveToGoogleDrive({ storage, data, type }) {
+export async function saveToGoogleDrive({ storage, data, type, vcId }) {
     try {
         const fileData = {
             fileName: type === 'VC' ? 'VC' : `${type}-${Date.now()}`,
@@ -55,6 +55,22 @@ export async function saveToGoogleDrive({ storage, data, type }) {
         }
         // Save the file in the specific subfolder
         const file = await storage.saveFile({ data: fileData, folderId: typeFolderId });
+        // If this is a recommendation, optionally link it to a parent VC folder via RELATIONS
+        if (type === 'RECOMMENDATION' && vcId) {
+            const parents = await storage.getFileParents(vcId);
+            const vcFolderId = Array.isArray(parents) ? parents[0] : parents;
+            if (!vcFolderId)
+                throw new Error('Unable to resolve parent folder for vcId');
+            const vcFolderFiles = await storage.findFolderFiles(vcFolderId);
+            let relationsFile = vcFolderFiles.find((f) => f.name === 'RELATIONS');
+            if (!relationsFile) {
+                relationsFile = await storage.createRelationsFile({ vcFolderId });
+            }
+            await storage.updateRelationsFile({
+                relationsFileId: relationsFile.id,
+                recommendationFileId: file.id,
+            });
+        }
         return file;
     }
     catch (error) {

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@cooperation/vc-storage",
 	"type": "module",
-	"version": "1.0.41",
+	"version": "1.0.43",
 	"description": "Sign and store your verifiable credentials.",
 	"main": "dist/index.js",
 	"types": "dist/types/index.d.ts",
@@ -22,10 +22,11 @@
 		"@digitalbazaar/ed25519-signature-2020": "^5.4.0",
 		"@digitalbazaar/ed25519-verification-key-2020": "^4.1.0",
 		"@digitalbazaar/vc": "^6.3.0",
-		"@wallet.storage/fetch-client": "^1.2.0",
-		"@digitalcredentials/ezcap": "^7.1.0",
-		"@digitalcredentials/ed25519-verification-key-2020": "^5.0.0-beta.2",
 		"@digitalcredentials/ed25519-signature-2020": "^5.0.0",
+		"@digitalcredentials/ed25519-verification-key-2020": "^5.0.0-beta.2",
+		"@digitalcredentials/ezcap": "^5.1.0",
+		"@digitalcredentials/ssi": "^5.1.0",
+		"@wallet.storage/fetch-client": "^1.2.0",
 		"add": "^2.0.6",
 		"bnid": "^3.0.0",
 		"crypto-js": "^4.2.0",