@cooperation/vc-storage 1.0.33 → 1.0.34

package/dist/models/CredentialEngine.js

@@ -2,7 +2,7 @@ import { Ed25519VerificationKey2020 } from '@digitalbazaar/ed25519-verification-
 import { Ed25519Signature2020 } from '@digitalbazaar/ed25519-signature-2020';
 import * as dbVc from '@digitalbazaar/vc';
 import { v4 as uuidv4 } from 'uuid';
-import { extractKeyPairFromCredential, generateDIDSchema, generateUnsignedRecommendation, generateUnsignedVC, } from '../utils/credential.js';
+import { extractKeyPairFromCredential, generateDIDSchema, generateUnsignedEmployment, generateUnsignedPerformanceReview, generateUnsignedRecommendation, generateUnsignedVC, generateUnsignedVolunteering, } from '../utils/credential.js';
 import { customDocumentLoader } from '../utils/digitalbazaar.js';
 import { saveToGoogleDrive } from '../utils/google.js';
 function delay(ms) {
@@ -135,28 +135,39 @@ export class CredentialEngine {
      * @throws Will throw an error if VC signing fails.
      */
     async signVC({ data, type, keyPair, issuerId, vcFileId }) {
-        let credential = generateUnsignedVC({ formData: data, issuerDid: issuerId });
-        if (type == 'RECOMMENDATION' && vcFileId) {
-            console.log('WOW');
-            credential = generateUnsignedRecommendation({
-                vcId: vcFileId,
-                recommendation: data,
-                issuerDid: issuerId,
-            });
-        }
-        try {
-            console.log('🚀 ~ CredentialEngine ~ signVC ~ credential:', credential);
-            if (!credential)
-                throw new Error('Invalid credential type');
-            const suite = new Ed25519Signature2020({ key: keyPair, verificationMethod: keyPair.id });
-            console.log('before');
-            const signedVC = await dbVc.issue({ credential, suite, documentLoader: customDocumentLoader });
-            return signedVC;
-        }
-        catch (error) {
-            console.error('Error signing VC:', error);
-            throw error;
+        let credential;
+        switch (type) {
+            case 'VC':
+                credential = generateUnsignedVC({ formData: data, issuerDid: issuerId });
+                break;
+            case 'RECOMMENDATION':
+                if (!vcFileId)
+                    throw new Error('vcFileId is required for recommendation');
+                credential = generateUnsignedRecommendation({ vcId: vcFileId, recommendation: data, issuerDid: issuerId });
+                break;
+            case 'EMPLOYMENT':
+                credential = generateUnsignedEmployment({ formData: data, issuerDid: issuerId });
+                break;
+            case 'VOLUNTEERING':
+                credential = generateUnsignedVolunteering({ formData: data, issuerDid: issuerId });
+                break;
+            case 'PERFORMANCE_REVIEW':
+                credential = generateUnsignedPerformanceReview({ formData: data, issuerDid: issuerId });
+                break;
+            default:
+                throw new Error(`Unsupported credential type: ${type}`);
         }
+        const suite = new Ed25519Signature2020({ key: keyPair, verificationMethod: keyPair.id });
+        return dbVc.issue({ credential, suite, documentLoader: customDocumentLoader });
+    }
+    async signEmploymentCredential(data, keyPair, issuerId) {
+        return this.signVC({ data, type: 'EMPLOYMENT', keyPair, issuerId });
+    }
+    async signVolunteeringCredential(data, keyPair, issuerId) {
+        return this.signVC({ data, type: 'VOLUNTEERING', keyPair, issuerId });
+    }
+    async signPerformanceReviewCredential(data, keyPair, issuerId) {
+        return this.signVC({ data, type: 'PERFORMANCE_REVIEW', keyPair, issuerId });
     }
     /**
      * Verify a Verifiable Credential (VC)

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

@@ -1,8 +1,8 @@
-import { DidDocument, KeyPair, FormDataI, RecommendationFormDataI, VerifiableCredential } from '../../types/credential.js';
+import { DidDocument, KeyPair, FormDataI, RecommendationFormDataI, VerifiableCredential, EmploymentFormDataI, PerformanceReviewFormDataI, VolunteeringFormDataI } from '../../types/credential.js';
 import { GoogleDriveStorage } from './GoogleDriveStorage.js';
 interface SignPropsI {
-    data: FormDataI | RecommendationFormDataI;
-    type: 'VC' | 'RECOMMENDATION';
+    data: FormDataI | RecommendationFormDataI | EmploymentFormDataI | VolunteeringFormDataI | PerformanceReviewFormDataI;
+    type: 'VC' | 'RECOMMENDATION' | 'EMPLOYMENT' | 'VOLUNTEERING' | 'PERFORMANCE_REVIEW';
     keyPair: KeyPair;
     issuerId: string;
     vcFileId?: string;
@@ -59,6 +59,9 @@ export declare class CredentialEngine {
      * @throws Will throw an error if VC signing fails.
      */
     signVC({ data, type, keyPair, issuerId, vcFileId }: SignPropsI): Promise<any>;
+    signEmploymentCredential(data: EmploymentFormDataI, keyPair: KeyPair, issuerId: string): Promise<any>;
+    signVolunteeringCredential(data: VolunteeringFormDataI, keyPair: KeyPair, issuerId: string): Promise<any>;
+    signPerformanceReviewCredential(data: PerformanceReviewFormDataI, keyPair: KeyPair, issuerId: string): Promise<any>;
     /**
      * Verify a Verifiable Credential (VC)
      * @param {object} credential - The Verifiable Credential to verify.

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

@@ -104,6 +104,79 @@ export declare const inlineResumeContext: {
         Resume: string;
     };
 };
+export declare const employmentCredentialContext: {
+    '@context': {
+        '@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;
+    };
+};
+export declare const volunteeringCredentialContext: {
+    '@context': {
+        '@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;
+    };
+};
+export declare const performanceReviewCredentialContext: {
+    '@context': {
+        '@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;
+    };
+};
 declare const localOBContext: {
     '@context': {
         '@protected': boolean;

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

@@ -1,4 +1,4 @@
-import { KeyPair, DidDocument, FormDataI, RecommendationCredential, Credential, RecommendationFormDataI, VerifiableCredential } from '../../types/credential';
+import { KeyPair, DidDocument, FormDataI, RecommendationCredential, Credential, RecommendationFormDataI, VerifiableCredential, EmploymentFormDataI, VolunteeringFormDataI, PerformanceReviewFormDataI } from '../../types/credential';
 /**
  * Create a DID document using the provided key pair.
  * @param {KeyPair} keyPair - The key pair used to create the DID document.
@@ -34,6 +34,176 @@ export declare function generateUnsignedRecommendation({ vcId, recommendation, i
     recommendation: RecommendationFormDataI;
     issuerDid: string;
 }): RecommendationCredential;
+/**
+ * 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;
+    };
+};
+/**
+ * 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;
+    };
+};
+/**
+ * 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;
+    };
+};
 /**
  * Extracts the keypair from a Verifiable Credential
  * @param {Object} credential - The signed Verifiable Credential

package/dist/utils/context.js

@@ -120,6 +120,82 @@ export const inlineResumeContext = {
         Resume: 'https://schema.hropenstandards.org/4.4#Resume',
     },
 };
+// 1. Employment Credential Context
+export const employmentCredentialContext = {
+    '@context': {
+        '@vocab': 'https://schema.hropenstandards.org/4.4/',
+        fullName: 'https://schema.org/name',
+        persons: 'https://schema.org/name',
+        credentialName: 'https://schema.org/jobTitle',
+        credentialDuration: 'https://schema.org/duration',
+        credentialDescription: 'https://schema.org/description',
+        portfolio: {
+            '@id': 'https://schema.org/hasPart',
+            '@container': '@list'
+        },
+        name: 'https://schema.org/name',
+        url: 'https://schema.org/url',
+        evidenceLink: 'https://schema.org/url',
+        evidenceDescription: 'https://schema.org/description',
+        company: 'https://schema.org/worksFor',
+        role: 'https://schema.org/jobTitle'
+    }
+};
+// 2. Volunteering Credential Context
+export const volunteeringCredentialContext = {
+    '@context': {
+        '@vocab': 'https://schema.hropenstandards.org/4.4/',
+        fullName: 'https://schema.org/name',
+        persons: 'https://schema.org/name',
+        volunteerWork: 'https://schema.org/roleName',
+        volunteerOrg: 'https://schema.org/organization',
+        volunteerDescription: 'https://schema.org/description',
+        skillsGained: {
+            '@id': 'https://schema.org/skills',
+            '@container': '@list'
+        },
+        duration: 'https://schema.org/duration',
+        volunteerDates: 'https://schema.org/temporalCoverage',
+        portfolio: {
+            '@id': 'https://schema.org/hasPart',
+            '@container': '@list'
+        },
+        name: 'https://schema.org/name',
+        url: 'https://schema.org/url',
+        evidenceLink: 'https://schema.org/url',
+        evidenceDescription: 'https://schema.org/description'
+    }
+};
+// 3. Performance Review Credential Context
+export const performanceReviewCredentialContext = {
+    '@context': {
+        '@vocab': 'https://schema.hropenstandards.org/4.4/',
+        fullName: 'https://schema.org/name',
+        persons: 'https://schema.org/name',
+        employeeName: 'https://schema.org/name',
+        employeeJobTitle: 'https://schema.org/jobTitle',
+        company: 'https://schema.org/worksFor',
+        role: 'https://schema.org/jobTitle',
+        reviewStartDate: 'https://schema.org/startDate',
+        reviewEndDate: 'https://schema.org/endDate',
+        reviewDuration: 'https://schema.org/duration',
+        jobKnowledgeRating: 'https://schema.org/assessmentScore',
+        teamworkRating: 'https://schema.org/assessmentScore',
+        initiativeRating: 'https://schema.org/assessmentScore',
+        communicationRating: 'https://schema.org/assessmentScore',
+        overallRating: 'https://schema.org/aggregateRating',
+        reviewComments: 'https://schema.org/comment',
+        goalsNext: 'https://schema.hropenstandards.org/4.4/goalsNext',
+        portfolio: {
+            '@id': 'https://schema.org/hasPart',
+            '@container': '@list'
+        },
+        name: 'https://schema.org/name',
+        url: 'https://schema.org/url',
+        evidenceLink: 'https://schema.org/url',
+        evidenceDescription: 'https://schema.org/description'
+    }
+};
 const localOBContext = {
     '@context': {
         '@protected': true,

package/dist/utils/credential.js

@@ -1,7 +1,9 @@
 import { Ed25519VerificationKey2020 } from '@digitalbazaar/ed25519-verification-key-2020';
 import { v4 as uuidv4 } from 'uuid';
 import CryptoJS from 'crypto-js';
+import { employmentCredentialContext, volunteeringCredentialContext, performanceReviewCredentialContext } from './context.js';
 /**
+ *
  * Utility function to generate a hashed ID for a credential.
  * Excludes the `id` field when hashing.
  * @param {object} credential - The credential object to hash.
@@ -169,6 +171,109 @@ export function generateUnsignedRecommendation({ vcId, recommendation, issuerDid
     };
     return unsignedRecommendation;
 }
+/**
+ * Generate an unsigned Employment Credential.
+ */
+export function generateUnsignedEmployment({ formData, issuerDid }) {
+    const issuanceDate = new Date().toISOString();
+    const unsignedCredential = {
+        '@context': [
+            'https://www.w3.org/2018/credentials/v1',
+            employmentCredentialContext['@context'],
+        ],
+        id: '',
+        type: ['VerifiableCredential', 'EmploymentCredential'],
+        issuer: { id: issuerDid, type: ['Profile'] },
+        issuanceDate,
+        credentialSubject: {
+            type: ['WorkExperience'],
+            fullName: formData.fullName,
+            persons: formData.persons,
+            credentialName: formData.credentialName,
+            credentialDuration: formData.credentialDuration,
+            credentialDescription: formData.credentialDescription,
+            portfolio: formData.portfolio.map(item => ({ name: item.name, url: item.url })),
+            evidenceLink: formData.evidenceLink,
+            evidenceDescription: formData.evidenceDescription,
+            company: formData.company,
+            role: formData.role,
+        },
+    };
+    unsignedCredential.id = 'urn:' + generateHashedId(unsignedCredential);
+    return unsignedCredential;
+}
+/**
+ * Generate an unsigned Volunteering Credential.
+ */
+export function generateUnsignedVolunteering({ formData, issuerDid }) {
+    const issuanceDate = new Date().toISOString();
+    const unsignedCredential = {
+        '@context': [
+            'https://www.w3.org/2018/credentials/v1',
+            volunteeringCredentialContext['@context'],
+        ],
+        id: '',
+        type: ['VerifiableCredential', 'VolunteeringCredential'],
+        issuer: { id: issuerDid, type: ['Profile'] },
+        issuanceDate,
+        credentialSubject: {
+            type: ['VolunteerRole'],
+            fullName: formData.fullName,
+            persons: formData.persons,
+            volunteerWork: formData.volunteerWork,
+            volunteerOrg: formData.volunteerOrg,
+            volunteerDescription: formData.volunteerDescription,
+            skillsGained: formData.skillsGained ? formData.skillsGained.split(',').map(s => s.trim()) : undefined,
+            duration: formData.duration,
+            volunteerDates: formData.volunteerDates,
+            portfolio: formData.portfolio.map(item => ({ name: item.name, url: item.url })),
+            evidenceLink: formData.evidenceLink,
+            evidenceDescription: formData.evidenceDescription,
+        },
+    };
+    unsignedCredential.id = 'urn:' + generateHashedId(unsignedCredential);
+    return unsignedCredential;
+}
+/**
+ * Generate an unsigned Performance Review Credential.
+ */
+export function generateUnsignedPerformanceReview({ formData, issuerDid }) {
+    const issuanceDate = new Date().toISOString();
+    const unsignedCredential = {
+        '@context': [
+            'https://www.w3.org/2018/credentials/v1',
+            performanceReviewCredentialContext['@context'],
+        ],
+        id: '',
+        type: ['VerifiableCredential', 'PerformanceReviewCredential'],
+        issuer: { id: issuerDid, type: ['Profile'] },
+        issuanceDate,
+        credentialSubject: {
+            type: ['EndorsementSubject'],
+            fullName: formData.fullName,
+            persons: formData.persons,
+            employeeName: formData.employeeName,
+            employeeJobTitle: formData.employeeJobTitle,
+            company: formData.company,
+            role: formData.role,
+            reviewStartDate: formData.reviewStartDate,
+            reviewEndDate: formData.reviewEndDate,
+            reviewDuration: formData.reviewDuration,
+            jobKnowledgeRating: formData.jobKnowledgeRating,
+            teamworkRating: formData.teamworkRating,
+            initiativeRating: formData.initiativeRating,
+            communicationRating: formData.communicationRating,
+            overallRating: formData.overallRating,
+            reviewComments: formData.reviewComments,
+            goalsNext: formData.goalsNext,
+            portfolio: formData.portfolio.map(item => ({ name: item.name, url: item.url })),
+            evidenceLink: formData.evidenceLink,
+            evidenceDescription: formData.evidenceDescription,
+        },
+    };
+    unsignedCredential.id = 'urn:' + generateHashedId(unsignedCredential);
+    return unsignedCredential;
+}
 /**
  * Extracts the keypair from a Verifiable Credential
  * @param {Object} credential - The signed Verifiable Credential

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@cooperation/vc-storage",
 	"type": "module",
-	"version": "1.0.33",
+	"version": "1.0.34",
 	"description": "Sign and store your verifiable credentials.",
 	"main": "dist/index.js",
 	"types": "dist/types/index.d.ts",