@cooperation/vc-storage 1.0.43 → 1.0.45

package/dist/utils/Ed25519Signer.js

@@ -0,0 +1,71 @@
+/**
+ * Ed25519 signer compatible with @wallet.storage/fetch-client.
+ * Uses @digitalcredentials packages instead of @digitalbazaar.
+ */
+import { Ed25519VerificationKey2020 } from '@digitalcredentials/ed25519-verification-key-2020';
+export class Ed25519Signer {
+    keyPair;
+    verificationMethod;
+    algorithm = 'Ed25519';
+    constructor(keyPair, verificationMethod) {
+        this.keyPair = keyPair;
+        this.verificationMethod = verificationMethod;
+    }
+    static async generate() {
+        const keyPair = await Ed25519VerificationKey2020.generate();
+        const fingerprint = keyPair.fingerprint();
+        const controller = `did:key:${fingerprint}`;
+        keyPair.controller = controller;
+        keyPair.id = `${controller}#${fingerprint}`;
+        const verificationMethod = {
+            id: keyPair.id,
+            type: 'Ed25519VerificationKey2020',
+            controller,
+            publicKeyMultibase: keyPair.publicKeyMultibase,
+        };
+        return new Ed25519Signer(keyPair, verificationMethod);
+    }
+    static async fromJSON(json) {
+        const object = JSON.parse(json);
+        const { publicKeyMultibase, privateKeyMultibase, controller } = object;
+        if (typeof controller !== 'string') {
+            throw new Error('json object must have controller string', { cause: { parsedJson: object } });
+        }
+        if (typeof publicKeyMultibase !== 'string') {
+            throw new Error('json object must have publicKeyMultibase string', { cause: object });
+        }
+        if (typeof privateKeyMultibase !== 'string') {
+            throw new Error('json object must have privateKeyMultibase string', { cause: object });
+        }
+        const keyPair = await Ed25519VerificationKey2020.from({
+            type: 'Ed25519VerificationKey2020',
+            controller,
+            publicKeyMultibase,
+            privateKeyMultibase,
+        });
+        const fingerprint = keyPair.fingerprint();
+        const verificationMethod = {
+            id: `${controller}#${fingerprint}`,
+            type: 'Ed25519VerificationKey2020',
+            controller,
+            publicKeyMultibase: keyPair.publicKeyMultibase,
+        };
+        return new Ed25519Signer(keyPair, verificationMethod);
+    }
+    get controller() {
+        return this.keyPair.controller;
+    }
+    get id() {
+        return this.verificationMethod.id;
+    }
+    get publicKeyMultibase() {
+        return this.keyPair.publicKeyMultibase;
+    }
+    async sign({ data }) {
+        const signature = await this.keyPair.signer().sign({ data });
+        return signature;
+    }
+    toJSON() {
+        return this.keyPair.export({ publicKey: true, privateKey: true });
+    }
+}

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': {
@@ -196,541 +227,3 @@ export const performanceReviewCredentialContext = {
         evidenceDescription: 'https://schema.org/description'
     }
 };
-const localOBContext = {
-    '@context': {
-        '@protected': true,
-        id: '@id',
-        type: '@type',
-        OpenBadgeCredential: {
-            '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#OpenBadgeCredential',
-        },
-        Achievement: {
-            '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#Achievement',
-            '@context': {
-                '@protected': true,
-                id: '@id',
-                type: '@type',
-                achievementType: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#achievementType',
-                },
-                alignment: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#alignment',
-                    '@container': '@set',
-                },
-                creator: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#creator',
-                },
-                creditsAvailable: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#creditsAvailable',
-                    '@type': 'https://www.w3.org/2001/XMLSchema#float',
-                },
-                criteria: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#Criteria',
-                    '@type': '@id',
-                },
-                fieldOfStudy: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#fieldOfStudy',
-                },
-                humanCode: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#humanCode',
-                },
-                image: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#image',
-                    '@type': '@id',
-                },
-                otherIdentifier: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#otherIdentifier',
-                    '@container': '@set',
-                },
-                related: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#related',
-                    '@container': '@set',
-                },
-                resultDescription: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#resultDescription',
-                    '@container': '@set',
-                },
-                specialization: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#specialization',
-                },
-                tag: {
-                    '@id': 'https://schema.org/keywords',
-                    '@container': '@set',
-                },
-                version: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#version',
-                },
-                inLanguage: {
-                    '@id': 'https://schema.org/inLanguage',
-                },
-            },
-        },
-        AchievementCredential: {
-            '@id': 'OpenBadgeCredential',
-        },
-        AchievementSubject: {
-            '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#AchievementSubject',
-            '@context': {
-                '@protected': true,
-                id: '@id',
-                type: '@type',
-                achievement: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#achievement',
-                },
-                activityEndDate: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#activityEndDate',
-                    '@type': 'https://www.w3.org/2001/XMLSchema#date',
-                },
-                activityStartDate: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#activityStartDate',
-                    '@type': 'https://www.w3.org/2001/XMLSchema#date',
-                },
-                creditsEarned: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#creditsEarned',
-                    '@type': 'https://www.w3.org/2001/XMLSchema#float',
-                },
-                identifier: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#identifier',
-                    '@container': '@set',
-                },
-                image: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#image',
-                    '@type': '@id',
-                },
-                licenseNumber: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#licenseNumber',
-                },
-                result: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#result',
-                    '@container': '@set',
-                },
-                role: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#role',
-                },
-                source: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#source',
-                    '@type': '@id',
-                },
-                term: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#term',
-                },
-            },
-        },
-        Address: {
-            '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#Address',
-            '@context': {
-                '@protected': true,
-                id: '@id',
-                type: '@type',
-                addressCountry: {
-                    '@id': 'https://schema.org/addressCountry',
-                },
-                addressCountryCode: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#CountryCode',
-                },
-                addressLocality: {
-                    '@id': 'https://schema.org/addressLocality',
-                },
-                addressRegion: {
-                    '@id': 'https://schema.org/addressRegion',
-                },
-                geo: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#GeoCoordinates',
-                },
-                postOfficeBoxNumber: {
-                    '@id': 'https://schema.org/postOfficeBoxNumber',
-                },
-                postalCode: {
-                    '@id': 'https://schema.org/postalCode',
-                },
-                streetAddress: {
-                    '@id': 'https://schema.org/streetAddress',
-                },
-            },
-        },
-        Alignment: {
-            '@id': 'https://schema.org/AlignmentObject',
-            '@context': {
-                '@protected': true,
-                id: '@id',
-                type: '@type',
-                targetCode: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#targetCode',
-                },
-                targetDescription: {
-                    '@id': 'https://schema.org/targetDescription',
-                },
-                targetFramework: {
-                    '@id': 'https://schema.org/targetFramework',
-                },
-                targetName: {
-                    '@id': 'https://schema.org/targetName',
-                },
-                targetType: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#targetType',
-                },
-                targetUrl: {
-                    '@id': 'https://schema.org/targetUrl',
-                    '@type': 'https://www.w3.org/2001/XMLSchema#anyURI',
-                },
-            },
-        },
-        Criteria: {
-            '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#Criteria',
-        },
-        EndorsementCredential: {
-            '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#EndorsementCredential',
-        },
-        EndorsementSubject: {
-            '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#EndorsementSubject',
-            '@context': {
-                '@protected': true,
-                id: '@id',
-                type: '@type',
-                endorsementComment: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#endorsementComment',
-                },
-            },
-        },
-        Evidence: {
-            '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#Evidence',
-            '@context': {
-                '@protected': true,
-                id: '@id',
-                type: '@type',
-                audience: {
-                    '@id': 'https://schema.org/audience',
-                },
-                genre: {
-                    '@id': 'https://schema.org/genre',
-                },
-            },
-        },
-        GeoCoordinates: {
-            '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#GeoCoordinates',
-            '@context': {
-                '@protected': true,
-                id: '@id',
-                type: '@type',
-                latitude: {
-                    '@id': 'https://schema.org/latitude',
-                },
-                longitude: {
-                    '@id': 'https://schema.org/longitude',
-                },
-            },
-        },
-        IdentifierEntry: {
-            '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#IdentifierEntry',
-            '@context': {
-                '@protected': true,
-                id: '@id',
-                type: '@type',
-                identifier: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#identifier',
-                },
-                identifierType: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#identifierType',
-                },
-            },
-        },
-        IdentityObject: {
-            '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#IdentityObject',
-            '@context': {
-                '@protected': true,
-                id: '@id',
-                type: '@type',
-                hashed: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#hashed',
-                    '@type': 'https://www.w3.org/2001/XMLSchema#boolean',
-                },
-                identityHash: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#identityHash',
-                },
-                identityType: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#identityType',
-                },
-                salt: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#salt',
-                },
-            },
-        },
-        Image: {
-            '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#Image',
-            '@context': {
-                '@protected': true,
-                id: '@id',
-                type: '@type',
-                caption: {
-                    '@id': 'https://schema.org/caption',
-                },
-            },
-        },
-        Profile: {
-            '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#Profile',
-            '@context': {
-                '@protected': true,
-                id: '@id',
-                type: '@type',
-                additionalName: {
-                    '@id': 'https://schema.org/additionalName',
-                },
-                address: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#address',
-                    '@type': '@id',
-                },
-                dateOfBirth: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#dateOfBirth',
-                    '@type': 'https://www.w3.org/2001/XMLSchema#date',
-                },
-                email: {
-                    '@id': 'https://schema.org/email',
-                },
-                familyName: {
-                    '@id': 'https://schema.org/familyName',
-                },
-                familyNamePrefix: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#familyNamePrefix',
-                },
-                givenName: {
-                    '@id': 'https://schema.org/givenName',
-                },
-                honorificPrefix: {
-                    '@id': 'https://schema.org/honorificPrefix',
-                },
-                honorificSuffix: {
-                    '@id': 'https://schema.org/honorificSuffix',
-                },
-                image: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#image',
-                    '@type': '@id',
-                },
-                otherIdentifier: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#otherIdentifier',
-                    '@container': '@set',
-                },
-                parentOrg: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#parentOrg',
-                    '@type': '@id',
-                },
-                patronymicName: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#patronymicName',
-                },
-                phone: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#phone',
-                },
-                official: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#official',
-                },
-            },
-        },
-        Related: {
-            '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#Related',
-            '@context': {
-                '@protected': true,
-                id: '@id',
-                type: '@type',
-                version: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#version',
-                },
-                inLanguage: {
-                    '@id': 'https://schema.org/inLanguage',
-                },
-            },
-        },
-        Result: {
-            '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#Result',
-            '@context': {
-                '@protected': true,
-                id: '@id',
-                type: '@type',
-                achievedLevel: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#achievedLevel',
-                    '@type': 'https://www.w3.org/2001/XMLSchema#anyURI',
-                },
-                resultDescription: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#resultDescription',
-                    '@type': 'https://www.w3.org/2001/XMLSchema#anyURI',
-                },
-                status: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#status',
-                },
-                value: {
-                    '@id': 'https://schema.org/value',
-                },
-            },
-        },
-        ResultDescription: {
-            '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#ResultDescription',
-            '@context': {
-                '@protected': true,
-                id: '@id',
-                type: '@type',
-                allowedValue: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#allowedValue',
-                    '@container': '@list',
-                },
-                requiredLevel: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#requiredLevel',
-                    '@type': 'https://www.w3.org/2001/XMLSchema#anyURI',
-                },
-                requiredValue: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#requiredValue',
-                },
-                resultType: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#resultType',
-                },
-                rubricCriterionLevel: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#rubricCriterionLevel',
-                    '@container': '@set',
-                },
-                valueMax: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#valueMax',
-                },
-                valueMin: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#valueMin',
-                },
-            },
-        },
-        RubricCriterionLevel: {
-            '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#RubricCriterionLevel',
-            '@context': {
-                '@protected': true,
-                id: '@id',
-                type: '@type',
-                level: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#level',
-                },
-                points: {
-                    '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#points',
-                },
-            },
-        },
-        alignment: {
-            '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#alignment',
-            '@container': '@set',
-        },
-        description: {
-            '@id': 'https://schema.org/description',
-        },
-        endorsement: {
-            '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#endorsement',
-            '@container': '@set',
-        },
-        image: {
-            '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#image',
-            '@type': '@id',
-        },
-        inLanguage: {
-            '@id': 'https://schema.org/inLanguage',
-        },
-        name: {
-            '@id': 'https://schema.org/name',
-        },
-        narrative: {
-            '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#narrative',
-        },
-        url: {
-            '@id': 'https://schema.org/url',
-            '@type': 'https://www.w3.org/2001/XMLSchema#anyURI',
-        },
-        awardedDate: {
-            '@id': 'https://purl.imsglobal.org/spec/vc/ob/vocab.html#awardedDate',
-            '@type': 'xsd:dateTime',
-        },
-    },
-};
-const localED25519Context = {
-    '@context': {
-        id: '@id',
-        type: '@type',
-        '@protected': true,
-        proof: {
-            '@id': 'https://w3id.org/security#proof',
-            '@type': '@id',
-            '@container': '@graph',
-        },
-        Ed25519VerificationKey2020: {
-            '@id': 'https://w3id.org/security#Ed25519VerificationKey2020',
-            '@context': {
-                '@protected': true,
-                id: '@id',
-                type: '@type',
-                controller: {
-                    '@id': 'https://w3id.org/security#controller',
-                    '@type': '@id',
-                },
-                revoked: {
-                    '@id': 'https://w3id.org/security#revoked',
-                    '@type': 'http://www.w3.org/2001/XMLSchema#dateTime',
-                },
-                publicKeyMultibase: {
-                    '@id': 'https://w3id.org/security#publicKeyMultibase',
-                    '@type': 'https://w3id.org/security#multibase',
-                },
-            },
-        },
-        Ed25519Signature2020: {
-            '@id': 'https://w3id.org/security#Ed25519Signature2020',
-            '@context': {
-                '@protected': true,
-                id: '@id',
-                type: '@type',
-                challenge: 'https://w3id.org/security#challenge',
-                created: {
-                    '@id': 'http://purl.org/dc/terms/created',
-                    '@type': 'http://www.w3.org/2001/XMLSchema#dateTime',
-                },
-                domain: 'https://w3id.org/security#domain',
-                expires: {
-                    '@id': 'https://w3id.org/security#expiration',
-                    '@type': 'http://www.w3.org/2001/XMLSchema#dateTime',
-                },
-                nonce: 'https://w3id.org/security#nonce',
-                proofPurpose: {
-                    '@id': 'https://w3id.org/security#proofPurpose',
-                    '@type': '@vocab',
-                    '@context': {
-                        '@protected': true,
-                        id: '@id',
-                        type: '@type',
-                        assertionMethod: {
-                            '@id': 'https://w3id.org/security#assertionMethod',
-                            '@type': '@id',
-                            '@container': '@set',
-                        },
-                        authentication: {
-                            '@id': 'https://w3id.org/security#authenticationMethod',
-                            '@type': '@id',
-                            '@container': '@set',
-                        },
-                        capabilityInvocation: {
-                            '@id': 'https://w3id.org/security#capabilityInvocationMethod',
-                            '@type': '@id',
-                            '@container': '@set',
-                        },
-                        capabilityDelegation: {
-                            '@id': 'https://w3id.org/security#capabilityDelegationMethod',
-                            '@type': '@id',
-                            '@container': '@set',
-                        },
-                        keyAgreement: {
-                            '@id': 'https://w3id.org/security#keyAgreementMethod',
-                            '@type': '@id',
-                            '@container': '@set',
-                        },
-                    },
-                },
-                proofValue: {
-                    '@id': 'https://w3id.org/security#proofValue',
-                    '@type': 'https://w3id.org/security#multibase',
-                },
-                verificationMethod: {
-                    '@id': 'https://w3id.org/security#verificationMethod',
-                    '@type': '@id',
-                },
-            },
-        },
-    },
-};
-export { localOBContext, localED25519Context };