@cooperation/vc-storage 1.0.33 → 1.0.40

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/createWASSpace.js

@@ -0,0 +1,27 @@
+import { StorageClient } from '@wallet.storage/fetch-client';
+import { Ed25519Signer } from '@did.coop/did-key-ed25519';
+import { v4 as uuidv4 } from 'uuid';
+import { WAS_BASE_URL } from '../../app.config.js';
+/**
+ * Create a new WAS space
+ * @returns {Promise<{ signer: InstanceType<typeof Ed25519Signer>; spaceId: `urn:uuid:${string}` }>}
+ */
+export async function createSpace() {
+    const signer = await Ed25519Signer.generate();
+    const controller = signer.id.split('#')[0];
+    const spaceUUID = uuidv4();
+    const spaceId = `urn:uuid:${spaceUUID}`;
+    const client = new StorageClient(new URL(WAS_BASE_URL));
+    const space = client.space({ signer, id: spaceId });
+    const spaceObject = {
+        id: spaceId,
+        controller,
+    };
+    const blob = new Blob([JSON.stringify(spaceObject)], { type: 'application/json' });
+    const res = await space.put(blob, { signer });
+    if (!res.ok) {
+        throw new Error(`Failed to initialize WAS space. Status: ${res.status}`);
+    }
+    console.log('✅ Provisioned and saved new WAS space');
+    return { signer, spaceId };
+}

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,100 @@ 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/dist/utils/getOrCreateAppDID.js

@@ -0,0 +1,22 @@
+import { Ed25519VerificationKey2020 } from '@digitalbazaar/ed25519-verification-key-2020';
+const LOCAL_STORAGE_KEY = 'AppInstanceDID';
+export async function getOrCreateAppInstanceDid() {
+    const stored = localStorage.getItem(LOCAL_STORAGE_KEY);
+    if (stored) {
+        const parsed = JSON.parse(stored);
+        const keyPair = await Ed25519VerificationKey2020.from(parsed);
+        return { did: keyPair.controller, keyPair };
+    }
+    const keyPair = await Ed25519VerificationKey2020.generate();
+    keyPair.controller = `did:key:${keyPair.publicKeyMultibase}`;
+    keyPair.id = `${keyPair.controller}#${keyPair.publicKeyMultibase}`;
+    keyPair.revoked = false;
+    const did = keyPair.controller;
+    localStorage.setItem(LOCAL_STORAGE_KEY, JSON.stringify({
+        controller: keyPair.controller,
+        id: keyPair.id,
+        publicKeyMultibase: keyPair.publicKeyMultibase,
+        privateKeyMultibase: keyPair.privateKeyMultibase,
+    }));
+    return { did, keyPair };
+}

package/dist/utils/google.js

@@ -1,7 +1,7 @@
 export const getVCWithRecommendations = async ({ vcId, storage }) => {
     try {
         const vcFolderId = await storage.getFileParents(vcId);
-        const files = await storage.findFilesUnderFolder(vcFolderId);
+        const files = await storage.findFolderFiles(vcFolderId);
         const relationsFile = files.find((f) => f.name === 'RELATIONS');
         const relationsContent = await storage.retrieve(relationsFile.id);
         const relationsData = relationsContent.data.body ? JSON.parse(relationsContent.data.body) : relationsContent.data;

package/package.json

@@ -1,12 +1,13 @@
 {
 	"name": "@cooperation/vc-storage",
 	"type": "module",
-	"version": "1.0.33",
+	"version": "1.0.40",
 	"description": "Sign and store your verifiable credentials.",
 	"main": "dist/index.js",
 	"types": "dist/types/index.d.ts",
 	"files": [
-		"dist"
+		"dist",
+		"app.config.js"
 	],
 	"scripts": {
 		"build": "tsc",
@@ -16,10 +17,12 @@
 	"author": "cooperation",
 	"license": "ISC",
 	"dependencies": {
+		"@did.coop/did-key-ed25519": "^0.0.13",
 		"@digitalbazaar/did-method-key": "^5.2.0",
 		"@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",
 		"add": "^2.0.6",
 		"bnid": "^3.0.0",
 		"crypto-js": "^4.2.0",
@@ -37,7 +40,7 @@
 		"@types/jest": "^29.5.14",
 		"@types/uuid": "^10.0.0",
 		"babel-jest": "^29.7.0",
-		"typescript": "^5.8.2",
+		"typescript": "^5.8.3",
 		"vitest": "^3.0.5"
 	}
 }

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

@@ -1,10 +0,0 @@
-/**
- * Create and sign a Verifiable Presentation (VP) from a given Verifiable Credential (VC) file and any associated recommendations.
- * @param {string} accessTokens - The access tokens for the user.
- * @param {string} vcFileId - The ID of the Verifiable Credential (VC) file in Google Drive.
- * @returns {Promise<{ signedPresentation: object } | null>} - The signed Verifiable Presentation (VP) or null if an error occurs.
- * @throws Will throw an error if the VC is not found, a matching key pair cannot be located, or any part of the signing process fails.
- */
-export declare const createAndSignVerifiablePresentation: (accessTokens: string, vcFileId: string) => Promise<{
-    signedPresentation: object;
-} | null>;

package/dist/utils/presentation.js

@@ -1,45 +0,0 @@
-/**
- * Create and sign a Verifiable Presentation (VP) from a given Verifiable Credential (VC) file and any associated recommendations.
- * @param {string} accessTokens - The access tokens for the user.
- * @param {string} vcFileId - The ID of the Verifiable Credential (VC) file in Google Drive.
- * @returns {Promise<{ signedPresentation: object } | null>} - The signed Verifiable Presentation (VP) or null if an error occurs.
- * @throws Will throw an error if the VC is not found, a matching key pair cannot be located, or any part of the signing process fails.
- */
-export const createAndSignVerifiablePresentation = async (accessTokens, vcFileId) => {
-    if (!accessTokens || !vcFileId) {
-        console.error('Invalid input: Access tokens and VC file ID are required.');
-        return null;
-    }
-    try {
-        // const storage = new GoogleDriveStorage(accessTokens);
-        // const engine = new CredentialEngine(accessTokens);
-        // // Fetch Verifiable Credential (VC)
-        // const verifiableCredential = await storage.retrieve(vcFileId);
-        // if (!verifiableCredential) {
-        // 	throw new Error('Verifiable Credential not found.');
-        // }
-        // // Fetch VC comments (potential recommendations)
-        // const verifiableCredentialComments = await storage.getFileComments(vcFileId);
-        // let recommendations: object[] = [];
-        // // Extract recommendations from comments if present
-        // if (verifiableCredentialComments.length > 0) {
-        // 	for (const comment of verifiableCredentialComments) {
-        // 		console.log('🚀 ~ createAndSignVerifiablePresentation ~ comment', comment);
-        // 		const recommendationFile = await storage.retrieve(extractGoogleDriveFileId(comment.content));
-        // 		console.log('🚀 ~ createAndSignVerifiablePresentation ~ recommendationFile', recommendationFile);
-        // 		if (recommendationFile) {
-        // 			recommendations.push(recommendationFile);
-        // 		}
-        // 	}
-        // }
-        // // Create Verifiable Presentation (VP) with the retrieved VC
-        // const presentation = await engine.createPresentation([verifiableCredential.data, ...recommendations]); //! do not edit the array order!!
-        // // Use the key pair to sign the presentation
-        // const signedPresentation = await engine.signPresentation(presentation);
-        // return {};
-    }
-    catch (error) {
-        console.error('Error during Verifiable Presentation creation and signing:', error);
-        return null;
-    }
-};