@cooperation/vc-storage 1.0.44 → 1.0.45

package/dist/index.js

@@ -8,3 +8,4 @@ export * from './models/WASZcapStorage.js';
 export * from './models/StorageContext.js';
 export * from './utils/createWASSpace.js';
 export * from './utils/getOrCreateAppDID.js';
+export * from './utils/context.js';

package/dist/types/index.d.ts

@@ -8,3 +8,4 @@ export * from './models/WASZcapStorage.js';
 export * from './models/StorageContext.js';
 export * from './utils/createWASSpace.js';
 export * from './utils/getOrCreateAppDID.js';
+export * from './utils/context.js';

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

@@ -14,7 +14,7 @@ export declare class LCWStorage {
         ok: boolean;
         headers: [string, string][];
         status: number;
-        blob(): Promise<import("buffer").Blob>;
+        blob(): Promise<import("node:buffer").Blob>;
         json(): Promise<unknown>;
     }>;
     read(key: string): Promise<unknown>;
@@ -22,7 +22,7 @@ export declare class LCWStorage {
         ok: boolean;
         headers: [string, string][];
         status: number;
-        blob(): Promise<import("buffer").Blob>;
+        blob(): Promise<import("node:buffer").Blob>;
         json(): Promise<unknown>;
     }>;
     delete(key: string): Promise<boolean>;

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

@@ -148,6 +148,36 @@ export declare const volunteeringCredentialContext: {
         evidenceDescription: string;
     };
 };
+export declare const VC_V2_CONTEXT = "https://www.w3.org/ns/credentials/v2";
+export declare const OB_V3_CONTEXT = "https://purl.imsglobal.org/spec/ob/v3p0/context-3.0.3.json";
+export declare const HR_V1_CONTEXT = "https://w3id.org/hr/v1";
+export declare const ED25519_2020_CONTEXT = "https://w3id.org/security/suites/ed25519-2020/v1";
+/** @context array for SkillClaimCredential signing (single source of truth). */
+export declare const skillClaimCredentialContexts: string[];
+/** JSON-LD terms for RecommendationCredential (schema.org + VC v2). */
+export declare const recommendationCredentialContext: {
+    '@context': {
+        recipientName: string;
+        howKnow: string;
+        recommendationText: string;
+        qualifications: string;
+        explainAnswer: string;
+        portfolio: string;
+        skillsEndorsed: string;
+    };
+};
+/** @context array for RecommendationCredential signing (single source of truth). */
+export declare const recommendationCredentialContexts: (string | {
+    '@context': {
+        recipientName: string;
+        howKnow: string;
+        recommendationText: string;
+        qualifications: string;
+        explainAnswer: string;
+        portfolio: string;
+        skillsEndorsed: string;
+    };
+})[];
 export declare const performanceReviewCredentialContext: {
     '@context': {
         '@vocab': string;

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

@@ -1,4 +1,4 @@
-import { KeyPair, DidDocument, FormDataI, RecommendationFormDataI, EmploymentFormDataI, VolunteeringFormDataI, PerformanceReviewFormDataI } from '../../types';
+import { KeyPair, DidDocument, FormDataI, RecommendationFormDataI, EvidenceItem, EmploymentFormDataI, VolunteeringFormDataI, PerformanceReviewFormDataI } from '../../types';
 import type { ISkillClaimCredential } from 'hr-context';
 import { IVerifiableCredential } from '@digitalcredentials/ssi';
 /**
@@ -22,19 +22,14 @@ export declare function generateUnsignedVC({ formData, issuerDid }: {
     issuerDid: string;
 }): IVerifiableCredential;
 /**
- * Generate an unsigned Recommendation Credential.
- * Uses the hash of the VC to set the `id` for consistency.
- * @param {object} params
- * @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 {IVerifiableCredential} The created unsigned Recommendation Credential.
- * @throws Will throw an error if the recommendation creation fails or if issuance date exceeds expiration date.
+ * Generate an unsigned Recommendation Credential (VC Data Model v2).
+ * Uses the target skill-claim VC id on credentialSubject.id.
  */
-export declare function generateUnsignedRecommendation({ vcId, recommendation, issuerDid, }: {
+export declare function generateUnsignedRecommendation({ vcId, recommendation, issuerDid, evidence, }: {
     vcId: string;
     recommendation: RecommendationFormDataI;
     issuerDid: string;
+    evidence?: EvidenceItem[];
 }): IVerifiableCredential;
 /**
  * Generate an unsigned Employment Credential.

package/dist/utils/context.js

@@ -166,6 +166,37 @@ export const volunteeringCredentialContext = {
         evidenceDescription: 'https://schema.org/description'
     }
 };
+export const VC_V2_CONTEXT = 'https://www.w3.org/ns/credentials/v2';
+export const OB_V3_CONTEXT = 'https://purl.imsglobal.org/spec/ob/v3p0/context-3.0.3.json';
+export const HR_V1_CONTEXT = 'https://w3id.org/hr/v1';
+export const ED25519_2020_CONTEXT = 'https://w3id.org/security/suites/ed25519-2020/v1';
+/** @context array for SkillClaimCredential signing (single source of truth). */
+export const skillClaimCredentialContexts = [
+    VC_V2_CONTEXT,
+    OB_V3_CONTEXT,
+    HR_V1_CONTEXT,
+    ED25519_2020_CONTEXT,
+];
+/** JSON-LD terms for RecommendationCredential (schema.org + VC v2). */
+export const recommendationCredentialContext = {
+    '@context': {
+        recipientName: 'https://schema.org/name',
+        howKnow: 'https://schema.org/howKnow',
+        recommendationText: 'https://schema.org/recommendationText',
+        qualifications: 'https://schema.org/qualifications',
+        explainAnswer: 'https://schema.org/explainAnswer',
+        portfolio: 'https://schema.org/portfolio',
+        skillsEndorsed: 'https://schema.org/skillsEndorsed',
+    },
+};
+/** @context array for RecommendationCredential signing (single source of truth). */
+export const recommendationCredentialContexts = [
+    VC_V2_CONTEXT,
+    OB_V3_CONTEXT,
+    HR_V1_CONTEXT,
+    recommendationCredentialContext,
+    ED25519_2020_CONTEXT,
+];
 // 3. Performance Review Credential Context
 export const performanceReviewCredentialContext = {
     '@context': {

package/dist/utils/credential.js

@@ -1,7 +1,7 @@
 import { Ed25519VerificationKey2020 } from '@digitalcredentials/ed25519-verification-key-2020';
 import { v4 as uuidv4 } from 'uuid';
 import CryptoJS from 'crypto-js';
-import { employmentCredentialContext, volunteeringCredentialContext, performanceReviewCredentialContext } from './context.js';
+import { employmentCredentialContext, volunteeringCredentialContext, performanceReviewCredentialContext, recommendationCredentialContexts, skillClaimCredentialContexts, } from './context.js';
 /**
  * Utility function to generate a hashed ID for a credential.
  * Excludes the `id` field when hashing.
@@ -123,54 +123,38 @@ export function generateUnsignedVC({ formData, issuerDid }) {
     return unsignedCredential;
 }
 /**
- * Generate an unsigned Recommendation Credential.
- * Uses the hash of the VC to set the `id` for consistency.
- * @param {object} params
- * @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 {IVerifiableCredential} The created unsigned Recommendation Credential.
- * @throws Will throw an error if the recommendation creation fails or if issuance date exceeds expiration date.
+ * Generate an unsigned Recommendation Credential (VC Data Model v2).
+ * Uses the target skill-claim VC id on credentialSubject.id.
  */
-export function generateUnsignedRecommendation({ vcId, recommendation, issuerDid, }) {
-    const issuanceDate = new Date().toISOString();
-    if (issuanceDate > recommendation.expirationDate)
-        throw new Error('issuanceDate cannot be after expirationDate');
+export function generateUnsignedRecommendation({ vcId, recommendation, issuerDid, evidence = [], }) {
     const unsignedRecommendation = {
-        '@context': [
-            'https://www.w3.org/2018/credentials/v1',
-            'https://purl.imsglobal.org/spec/ob/v3p0/context-3.0.3.json',
-            {
-                howKnow: 'https://schema.org/howKnow',
-                recommendationText: 'https://schema.org/recommendationText',
-                qualifications: 'https://schema.org/qualifications',
-                explainAnswer: 'https://schema.org/explainAnswer',
-                portfolio: 'https://schema.org/portfolio',
-            },
-        ],
-        id: ``,
+        '@context': recommendationCredentialContexts,
+        id: `urn:uuid:${uuidv4()}`,
         type: ['VerifiableCredential', 'https://schema.org/RecommendationCredential'],
-        issuer: {
-            id: issuerDid,
-            type: ['Profile'],
-        },
-        issuanceDate,
-        expirationDate: recommendation.expirationDate,
+        issuer: { id: issuerDid, type: ['Profile'] },
+        validFrom: new Date().toISOString(),
         credentialSubject: {
             id: vcId,
             name: recommendation.fullName,
+            ...(recommendation.recipientName ? { recipientName: recommendation.recipientName } : {}),
             howKnow: recommendation.howKnow,
             recommendationText: recommendation.recommendationText,
-            qualifications: recommendation.qualifications,
-            explainAnswer: recommendation.explainAnswer,
-            portfolio: recommendation.portfolio.map((item) => ({
-                name: item.name,
-                url: item.url,
-            })),
+            ...(recommendation.qualifications ? { qualifications: recommendation.qualifications } : {}),
+            ...(recommendation.explainAnswer ? { explainAnswer: recommendation.explainAnswer } : {}),
+            ...(recommendation.portfolio?.length ? { portfolio: recommendation.portfolio } : {}),
+            ...(recommendation.skillsEndorsed?.length ? { skillsEndorsed: recommendation.skillsEndorsed } : {}),
         },
+        ...(evidence.length
+            ? {
+                evidence: evidence.map((e) => ({
+                    id: e.id,
+                    type: Array.isArray(e.type) ? e.type[0] : e.type || 'Evidence',
+                    name: e.name,
+                    description: e.description || '',
+                })),
+            }
+            : {}),
     };
-    // Generate the hashed ID
-    unsignedRecommendation.id = 'urn:' + generateHashedId(unsignedRecommendation);
     return unsignedRecommendation;
 }
 /**
@@ -280,12 +264,7 @@ export function generateUnsignedPerformanceReview({ formData, issuerDid }) {
  */
 export function generateUnsignedSkillClaim({ formData, issuerDid, }) {
     const unsignedCredential = {
-        '@context': [
-            'https://www.w3.org/ns/credentials/v2',
-            'https://purl.imsglobal.org/spec/ob/v3p0/context-3.0.3.json',
-            'https://w3id.org/hr/v1',
-            'https://w3id.org/security/suites/ed25519-2020/v1',
-        ],
+        '@context': skillClaimCredentialContexts,
         id: `urn:uuid:${uuidv4()}`,
         type: ['VerifiableCredential', 'SkillClaimCredential'],
         issuer: issuerDid,

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@cooperation/vc-storage",
 	"type": "module",
-	"version": "1.0.44",
+	"version": "1.0.45",
 	"description": "Sign and store your verifiable credentials.",
 	"main": "dist/index.js",
 	"types": "dist/types/index.d.ts",
@@ -43,6 +43,7 @@
 	"devDependencies": {
 		"@types/fs-extra": "^11.0.4",
 		"@types/jest": "^29.5.14",
+		"@types/node": "^25.9.0",
 		"@types/uuid": "^10.0.0",
 		"babel-jest": "^29.7.0",
 		"typescript": "^5.8.3",