@cooperation/vc-storage 1.0.43 → 1.0.45

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;
@@ -177,541 +207,3 @@ export declare const performanceReviewCredentialContext: {
         evidenceDescription: string;
     };
 };
-declare const localOBContext: {
-    '@context': {
-        '@protected': boolean;
-        id: string;
-        type: string;
-        OpenBadgeCredential: {
-            '@id': string;
-        };
-        Achievement: {
-            '@id': string;
-            '@context': {
-                '@protected': boolean;
-                id: string;
-                type: string;
-                achievementType: {
-                    '@id': string;
-                };
-                alignment: {
-                    '@id': string;
-                    '@container': string;
-                };
-                creator: {
-                    '@id': string;
-                };
-                creditsAvailable: {
-                    '@id': string;
-                    '@type': string;
-                };
-                criteria: {
-                    '@id': string;
-                    '@type': string;
-                };
-                fieldOfStudy: {
-                    '@id': string;
-                };
-                humanCode: {
-                    '@id': string;
-                };
-                image: {
-                    '@id': string;
-                    '@type': string;
-                };
-                otherIdentifier: {
-                    '@id': string;
-                    '@container': string;
-                };
-                related: {
-                    '@id': string;
-                    '@container': string;
-                };
-                resultDescription: {
-                    '@id': string;
-                    '@container': string;
-                };
-                specialization: {
-                    '@id': string;
-                };
-                tag: {
-                    '@id': string;
-                    '@container': string;
-                };
-                version: {
-                    '@id': string;
-                };
-                inLanguage: {
-                    '@id': string;
-                };
-            };
-        };
-        AchievementCredential: {
-            '@id': string;
-        };
-        AchievementSubject: {
-            '@id': string;
-            '@context': {
-                '@protected': boolean;
-                id: string;
-                type: string;
-                achievement: {
-                    '@id': string;
-                };
-                activityEndDate: {
-                    '@id': string;
-                    '@type': string;
-                };
-                activityStartDate: {
-                    '@id': string;
-                    '@type': string;
-                };
-                creditsEarned: {
-                    '@id': string;
-                    '@type': string;
-                };
-                identifier: {
-                    '@id': string;
-                    '@container': string;
-                };
-                image: {
-                    '@id': string;
-                    '@type': string;
-                };
-                licenseNumber: {
-                    '@id': string;
-                };
-                result: {
-                    '@id': string;
-                    '@container': string;
-                };
-                role: {
-                    '@id': string;
-                };
-                source: {
-                    '@id': string;
-                    '@type': string;
-                };
-                term: {
-                    '@id': string;
-                };
-            };
-        };
-        Address: {
-            '@id': string;
-            '@context': {
-                '@protected': boolean;
-                id: string;
-                type: string;
-                addressCountry: {
-                    '@id': string;
-                };
-                addressCountryCode: {
-                    '@id': string;
-                };
-                addressLocality: {
-                    '@id': string;
-                };
-                addressRegion: {
-                    '@id': string;
-                };
-                geo: {
-                    '@id': string;
-                };
-                postOfficeBoxNumber: {
-                    '@id': string;
-                };
-                postalCode: {
-                    '@id': string;
-                };
-                streetAddress: {
-                    '@id': string;
-                };
-            };
-        };
-        Alignment: {
-            '@id': string;
-            '@context': {
-                '@protected': boolean;
-                id: string;
-                type: string;
-                targetCode: {
-                    '@id': string;
-                };
-                targetDescription: {
-                    '@id': string;
-                };
-                targetFramework: {
-                    '@id': string;
-                };
-                targetName: {
-                    '@id': string;
-                };
-                targetType: {
-                    '@id': string;
-                };
-                targetUrl: {
-                    '@id': string;
-                    '@type': string;
-                };
-            };
-        };
-        Criteria: {
-            '@id': string;
-        };
-        EndorsementCredential: {
-            '@id': string;
-        };
-        EndorsementSubject: {
-            '@id': string;
-            '@context': {
-                '@protected': boolean;
-                id: string;
-                type: string;
-                endorsementComment: {
-                    '@id': string;
-                };
-            };
-        };
-        Evidence: {
-            '@id': string;
-            '@context': {
-                '@protected': boolean;
-                id: string;
-                type: string;
-                audience: {
-                    '@id': string;
-                };
-                genre: {
-                    '@id': string;
-                };
-            };
-        };
-        GeoCoordinates: {
-            '@id': string;
-            '@context': {
-                '@protected': boolean;
-                id: string;
-                type: string;
-                latitude: {
-                    '@id': string;
-                };
-                longitude: {
-                    '@id': string;
-                };
-            };
-        };
-        IdentifierEntry: {
-            '@id': string;
-            '@context': {
-                '@protected': boolean;
-                id: string;
-                type: string;
-                identifier: {
-                    '@id': string;
-                };
-                identifierType: {
-                    '@id': string;
-                };
-            };
-        };
-        IdentityObject: {
-            '@id': string;
-            '@context': {
-                '@protected': boolean;
-                id: string;
-                type: string;
-                hashed: {
-                    '@id': string;
-                    '@type': string;
-                };
-                identityHash: {
-                    '@id': string;
-                };
-                identityType: {
-                    '@id': string;
-                };
-                salt: {
-                    '@id': string;
-                };
-            };
-        };
-        Image: {
-            '@id': string;
-            '@context': {
-                '@protected': boolean;
-                id: string;
-                type: string;
-                caption: {
-                    '@id': string;
-                };
-            };
-        };
-        Profile: {
-            '@id': string;
-            '@context': {
-                '@protected': boolean;
-                id: string;
-                type: string;
-                additionalName: {
-                    '@id': string;
-                };
-                address: {
-                    '@id': string;
-                    '@type': string;
-                };
-                dateOfBirth: {
-                    '@id': string;
-                    '@type': string;
-                };
-                email: {
-                    '@id': string;
-                };
-                familyName: {
-                    '@id': string;
-                };
-                familyNamePrefix: {
-                    '@id': string;
-                };
-                givenName: {
-                    '@id': string;
-                };
-                honorificPrefix: {
-                    '@id': string;
-                };
-                honorificSuffix: {
-                    '@id': string;
-                };
-                image: {
-                    '@id': string;
-                    '@type': string;
-                };
-                otherIdentifier: {
-                    '@id': string;
-                    '@container': string;
-                };
-                parentOrg: {
-                    '@id': string;
-                    '@type': string;
-                };
-                patronymicName: {
-                    '@id': string;
-                };
-                phone: {
-                    '@id': string;
-                };
-                official: {
-                    '@id': string;
-                };
-            };
-        };
-        Related: {
-            '@id': string;
-            '@context': {
-                '@protected': boolean;
-                id: string;
-                type: string;
-                version: {
-                    '@id': string;
-                };
-                inLanguage: {
-                    '@id': string;
-                };
-            };
-        };
-        Result: {
-            '@id': string;
-            '@context': {
-                '@protected': boolean;
-                id: string;
-                type: string;
-                achievedLevel: {
-                    '@id': string;
-                    '@type': string;
-                };
-                resultDescription: {
-                    '@id': string;
-                    '@type': string;
-                };
-                status: {
-                    '@id': string;
-                };
-                value: {
-                    '@id': string;
-                };
-            };
-        };
-        ResultDescription: {
-            '@id': string;
-            '@context': {
-                '@protected': boolean;
-                id: string;
-                type: string;
-                allowedValue: {
-                    '@id': string;
-                    '@container': string;
-                };
-                requiredLevel: {
-                    '@id': string;
-                    '@type': string;
-                };
-                requiredValue: {
-                    '@id': string;
-                };
-                resultType: {
-                    '@id': string;
-                };
-                rubricCriterionLevel: {
-                    '@id': string;
-                    '@container': string;
-                };
-                valueMax: {
-                    '@id': string;
-                };
-                valueMin: {
-                    '@id': string;
-                };
-            };
-        };
-        RubricCriterionLevel: {
-            '@id': string;
-            '@context': {
-                '@protected': boolean;
-                id: string;
-                type: string;
-                level: {
-                    '@id': string;
-                };
-                points: {
-                    '@id': string;
-                };
-            };
-        };
-        alignment: {
-            '@id': string;
-            '@container': string;
-        };
-        description: {
-            '@id': string;
-        };
-        endorsement: {
-            '@id': string;
-            '@container': string;
-        };
-        image: {
-            '@id': string;
-            '@type': string;
-        };
-        inLanguage: {
-            '@id': string;
-        };
-        name: {
-            '@id': string;
-        };
-        narrative: {
-            '@id': string;
-        };
-        url: {
-            '@id': string;
-            '@type': string;
-        };
-        awardedDate: {
-            '@id': string;
-            '@type': string;
-        };
-    };
-};
-declare const localED25519Context: {
-    '@context': {
-        id: string;
-        type: string;
-        '@protected': boolean;
-        proof: {
-            '@id': string;
-            '@type': string;
-            '@container': string;
-        };
-        Ed25519VerificationKey2020: {
-            '@id': string;
-            '@context': {
-                '@protected': boolean;
-                id: string;
-                type: string;
-                controller: {
-                    '@id': string;
-                    '@type': string;
-                };
-                revoked: {
-                    '@id': string;
-                    '@type': string;
-                };
-                publicKeyMultibase: {
-                    '@id': string;
-                    '@type': string;
-                };
-            };
-        };
-        Ed25519Signature2020: {
-            '@id': string;
-            '@context': {
-                '@protected': boolean;
-                id: string;
-                type: string;
-                challenge: string;
-                created: {
-                    '@id': string;
-                    '@type': string;
-                };
-                domain: string;
-                expires: {
-                    '@id': string;
-                    '@type': string;
-                };
-                nonce: string;
-                proofPurpose: {
-                    '@id': string;
-                    '@type': string;
-                    '@context': {
-                        '@protected': boolean;
-                        id: string;
-                        type: string;
-                        assertionMethod: {
-                            '@id': string;
-                            '@type': string;
-                            '@container': string;
-                        };
-                        authentication: {
-                            '@id': string;
-                            '@type': string;
-                            '@container': string;
-                        };
-                        capabilityInvocation: {
-                            '@id': string;
-                            '@type': string;
-                            '@container': string;
-                        };
-                        capabilityDelegation: {
-                            '@id': string;
-                            '@type': string;
-                            '@container': string;
-                        };
-                        keyAgreement: {
-                            '@id': string;
-                            '@type': string;
-                            '@container': string;
-                        };
-                    };
-                };
-                proofValue: {
-                    '@id': string;
-                    '@type': string;
-                };
-                verificationMethod: {
-                    '@id': string;
-                    '@type': string;
-                };
-            };
-        };
-    };
-};
-export { localOBContext, localED25519Context };

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

@@ -1,4 +1,5 @@
-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';
 /**
  * Create a DID document using the provided key pair.
@@ -21,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.
@@ -56,6 +52,21 @@ export declare function generateUnsignedPerformanceReview({ formData, issuerDid
     formData: PerformanceReviewFormDataI;
     issuerDid: string;
 }): IVerifiableCredential;
+/**
+ * Generate an unsigned SkillClaimCredential (HR Context / VC Data Model v2).
+ *
+ * Key differences from the legacy OpenBadgeCredential:
+ * - Uses `https://www.w3.org/ns/credentials/v2` and `https://w3id.org/hr/v1` contexts
+ * - VC subtype is `SkillClaimCredential` (not `OpenBadgeCredential`)
+ * - `credentialSubject.type` is `SkillClaim` with a `person` object and `skill` array
+ * - Evidence lives at the credential root (not inside `credentialSubject`)
+ * - No `issuanceDate`/`expirationDate` set by the author
+ * - Issuer is a plain DID string (no `type` wrapper)
+ */
+export declare function generateUnsignedSkillClaim({ formData, issuerDid, }: {
+    formData: ISkillClaimCredential;
+    issuerDid: string;
+}): IVerifiableCredential;
 /**
  * Extracts the keypair from a Verifiable Credential
  * @param {Object} credential - The signed Verifiable Credential

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

@@ -0,0 +1,6 @@
+/** Document loader compatible with @digitalcredentials/vc */
+export declare const customDocumentLoader: (url: string) => Promise<{
+    contextUrl: string;
+    documentUrl: string;
+    document: any;
+}>;

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

@@ -1 +1 @@
-export declare const customDocumentLoader: (url: any) => Promise<any>;
+export declare const customDocumentLoader: (url: string) => Promise<any>;

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

@@ -1,4 +1,4 @@
-import { Ed25519VerificationKey2020 } from '@digitalbazaar/ed25519-verification-key-2020';
+import { Ed25519VerificationKey2020 } from '@digitalcredentials/ed25519-verification-key-2020';
 export interface AppInstanceKeyPair {
     controller: string;
     id: string;