@learncard/credential-library 1.0.10 → 1.0.11

package/src/fixtures/index.ts

@@ -0,0 +1,159 @@
+import type { CredentialFixture } from '../types';
+
+// VC v1
+import { vcV1Basic } from './vc-v1/basic';
+import { vcV1WithStatus } from './vc-v1/with-status';
+
+// VC v2
+import { vcV2Basic } from './vc-v2/basic';
+import { vcV2WithEvidence } from './vc-v2/with-evidence';
+import { vcV2MultipleSubjects } from './vc-v2/multiple-subjects';
+import { vcV2RenderMethodExample } from './render-method/render-method-example';
+
+// OBv3
+import { obv3MinimalBadge } from './obv3/minimal-badge';
+import { obv3FullBadge } from './obv3/full-badge';
+import { obv3WithAlignment } from './obv3/with-alignment';
+import { obv3WithEndorsement } from './obv3/with-endorsement';
+import { obv3PlugfestJff2 } from './obv3/plugfest-jff2';
+import { obv3OneedtechFull } from './obv3/1edtech-full';
+import { obv3ProfessionalCert } from './obv3/professional-cert';
+import { obv3MicroCredential } from './obv3/micro-credential';
+import { obv3CourseCompletion } from './obv3/course-completion';
+import { obv3K12Diploma } from './obv3/k12-diploma';
+import { obv3EndorsementCredential } from './obv3/endorsement';
+
+// CLR v2
+import { clrMinimal } from './clr/minimal';
+import { clrMultiAchievement } from './clr/multi-achievement';
+import { clrUniversityTranscript } from './clr/university-transcript';
+
+// LearnCard Boosts
+import { boostBasic } from './boost/basic';
+import { boostId } from './boost/boost-id';
+import { boostWithSkills } from './boost/with-skills';
+import { boostCommunityAward } from './boost/community-award';
+import { boostDelegate } from './boost/delegate';
+
+// Invalid / negative test fixtures
+import { invalidMissingContext } from './invalid/missing-context';
+import { invalidEmptyType } from './invalid/empty-type';
+import { invalidMissingIssuer } from './invalid/missing-issuer';
+
+import { clrNdStudentTranscript } from './clr/nd-student-transcript';
+
+// VC v1 (additional)
+import { vcV1AlumniCredential } from './vc-v1/alumni-credential';
+
+// VC v2 (additional)
+import { vcV2EmploymentCredential } from './vc-v2/employment-credential';
+import { vcV2EducationDegree } from './vc-v2/education-degree';
+import { vcV2DigitalId } from './vc-v2/digital-id';
+import { vcV2MembershipCredential } from './vc-v2/membership-credential';
+import { vcV2LicenseCredential } from './vc-v2/license-credential';
+
+import { clrGreatPlainsFull } from './clr/great-plains-full';
+import { clrWestbridgeFull } from './clr/westbridge-full';
+import { clrCompetencyAligned } from './clr/competency-aligned';
+
+// ---------------------------------------------------------------------------
+// All fixtures — collected for auto-registration
+// ---------------------------------------------------------------------------
+
+export const ALL_FIXTURES: CredentialFixture[] = [
+    // VC v1
+    vcV1Basic,
+    vcV1WithStatus,
+
+    // VC v2
+    vcV2Basic,
+    vcV2WithEvidence,
+    vcV2MultipleSubjects,
+    vcV2RenderMethodExample,
+
+    // OBv3
+    obv3MinimalBadge,
+    obv3FullBadge,
+    obv3WithAlignment,
+    obv3WithEndorsement,
+    obv3PlugfestJff2,
+    obv3OneedtechFull,
+    obv3ProfessionalCert,
+    obv3MicroCredential,
+    obv3CourseCompletion,
+    obv3K12Diploma,
+    obv3EndorsementCredential,
+
+    // CLR v2
+    clrMinimal,
+    clrMultiAchievement,
+    clrUniversityTranscript,
+
+    // Boosts
+    boostBasic,
+    boostId,
+    boostWithSkills,
+    boostCommunityAward,
+    boostDelegate,
+
+    // Invalid
+    invalidMissingContext,
+    invalidEmptyType,
+    invalidMissingIssuer,
+    clrNdStudentTranscript,
+
+    // VC v1 (additional)
+    vcV1AlumniCredential,
+
+    // VC v2 (additional)
+    vcV2EmploymentCredential,
+    vcV2EducationDegree,
+    vcV2DigitalId,
+    vcV2MembershipCredential,
+    vcV2LicenseCredential,
+    clrGreatPlainsFull,
+    clrWestbridgeFull,
+    clrCompetencyAligned,
+];
+
+// Re-export individual fixtures for direct import
+export {
+    vcV1Basic,
+    vcV1WithStatus,
+    vcV2Basic,
+    vcV2WithEvidence,
+    vcV2MultipleSubjects,
+    vcV2RenderMethodExample,
+    obv3MinimalBadge,
+    obv3FullBadge,
+    obv3WithAlignment,
+    obv3WithEndorsement,
+    obv3PlugfestJff2,
+    clrMinimal,
+    clrMultiAchievement,
+    boostBasic,
+    boostId,
+    boostWithSkills,
+    invalidMissingContext,
+    invalidEmptyType,
+    invalidMissingIssuer,
+    clrNdStudentTranscript,
+    obv3OneedtechFull,
+    obv3ProfessionalCert,
+    obv3MicroCredential,
+    obv3CourseCompletion,
+    obv3K12Diploma,
+    obv3EndorsementCredential,
+    clrUniversityTranscript,
+    boostCommunityAward,
+    boostDelegate,
+    vcV1AlumniCredential,
+    vcV2EmploymentCredential,
+    vcV2EducationDegree,
+    vcV2DigitalId,
+    vcV2MembershipCredential,
+    vcV2LicenseCredential,
+    clrGreatPlainsFull,
+    clrWestbridgeFull,
+    clrCompetencyAligned,
+};

package/src/fixtures/invalid/empty-type.ts

@@ -0,0 +1,27 @@
+import { UnsignedVCValidator } from '@learncard/types';
+
+import type { CredentialFixture, InvalidCredential } from '../../types';
+
+export const invalidEmptyType: CredentialFixture = {
+    id: 'invalid/empty-type',
+    name: 'Empty type Array',
+    description:
+        'Credential with an empty type array — should fail validation since type must be a non-empty array containing at least "VerifiableCredential"',
+    spec: 'vc-v2',
+    profile: 'generic',
+    features: [],
+    source: 'synthetic',
+    signed: false,
+    validity: 'invalid',
+    validator: UnsignedVCValidator,
+    tags: ['negative-test'],
+
+    credential: {
+        '@context': ['https://www.w3.org/ns/credentials/v2'],
+        id: 'urn:uuid:invalid-0002',
+        type: [],
+        issuer: 'did:example:issuer123',
+        validFrom: '2024-01-01T00:00:00Z',
+        credentialSubject: { id: 'did:example:subject456' },
+    } as InvalidCredential as any,
+};

package/src/fixtures/invalid/missing-context.ts

@@ -0,0 +1,27 @@
+import { UnsignedVCValidator } from '@learncard/types';
+
+import type { CredentialFixture, InvalidCredential } from '../../types';
+
+export const invalidMissingContext: CredentialFixture = {
+    id: 'invalid/missing-context',
+    name: 'Missing @context',
+    description:
+        'Credential with no @context array — should fail validation since @context is required by the VC Data Model',
+    spec: 'vc-v2',
+    profile: 'generic',
+    features: [],
+    source: 'synthetic',
+    signed: false,
+    validity: 'invalid',
+    validator: UnsignedVCValidator,
+    tags: ['negative-test'],
+
+    credential: {
+        // Intentionally missing '@context'
+        id: 'urn:uuid:invalid-0001',
+        type: ['VerifiableCredential'],
+        issuer: 'did:example:issuer123',
+        validFrom: '2024-01-01T00:00:00Z',
+        credentialSubject: { id: 'did:example:subject456' },
+    } as InvalidCredential as any,
+};

package/src/fixtures/invalid/missing-issuer.ts

@@ -0,0 +1,27 @@
+import { UnsignedVCValidator } from '@learncard/types';
+
+import type { CredentialFixture, InvalidCredential } from '../../types';
+
+export const invalidMissingIssuer: CredentialFixture = {
+    id: 'invalid/missing-issuer',
+    name: 'Missing Issuer',
+    description:
+        'Credential with no issuer field — should fail validation since issuer is required by the VC Data Model',
+    spec: 'vc-v2',
+    profile: 'generic',
+    features: [],
+    source: 'synthetic',
+    signed: false,
+    validity: 'invalid',
+    validator: UnsignedVCValidator,
+    tags: ['negative-test'],
+
+    credential: {
+        '@context': ['https://www.w3.org/ns/credentials/v2'],
+        id: 'urn:uuid:invalid-0003',
+        type: ['VerifiableCredential'],
+        // Intentionally missing 'issuer'
+        validFrom: '2024-01-01T00:00:00Z',
+        credentialSubject: { id: 'did:example:subject456' },
+    } as InvalidCredential as any,
+};

package/src/fixtures/obv3/1edtech-full.ts

@@ -0,0 +1,237 @@
+import type { CredentialFixture } from '../../types';
+
+export const obv3OneedtechFull: CredentialFixture = {
+    id: 'obv3/1edtech-full',
+    name: '1EdTech Complete OpenBadgeCredential',
+    description:
+        'The comprehensive OBv3 example from the 1EdTech specification, exercising nearly every optional field including endorsements, alignment, evidence, results, credential schema, status, and refresh service.',
+    spec: 'obv3',
+    profile: 'badge',
+    features: [
+        'alignment',
+        'endorsement',
+        'expiration',
+        'status',
+        'image',
+        'results',
+        'source',
+        'credential-schema',
+        'refresh-service',
+    ],
+    source: 'spec-example',
+    signed: false,
+    validity: 'valid',
+    tags: ['1edtech', 'obv3', 'spec-example', 'comprehensive'],
+
+    credential: {
+        '@context': [
+            'https://www.w3.org/ns/credentials/v2',
+            'https://purl.imsglobal.org/spec/ob/v3p0/context-3.0.3.json',
+            'https://purl.imsglobal.org/spec/ob/v3p0/extensions.json',
+        ],
+        id: 'http://1edtech.edu/credentials/3732',
+        type: ['VerifiableCredential', 'OpenBadgeCredential'],
+        name: '1EdTech University Degree for Example Student',
+        description: '1EdTech University Degree Description',
+        image: {
+            id: 'https://1edtech.edu/credentials/3732/image',
+            type: 'Image',
+            caption: '1EdTech University Degree for Example Student',
+        },
+        credentialSubject: {
+            id: 'did:example:ebfeb1f712ebc6f1c276e12ec21',
+            type: ['AchievementSubject'],
+            activityEndDate: '2010-01-02T00:00:00Z',
+            activityStartDate: '2010-01-01T00:00:00Z',
+            creditsEarned: 42.0,
+            licenseNumber: 'A-9320041',
+            role: 'Major Domo',
+            source: {
+                id: 'https://school.edu/issuers/201234',
+                type: ['Profile'],
+                name: '1EdTech College of Arts',
+            },
+            term: 'Fall',
+            identifier: [
+                {
+                    type: 'IdentityObject',
+                    identityHash: 'student@1edtech.edu',
+                    identityType: 'emailAddress',
+                    hashed: false,
+                    salt: 'not-used',
+                },
+            ],
+            achievement: {
+                id: 'https://1edtech.edu/achievements/degree',
+                type: ['Achievement'],
+                alignment: [
+                    {
+                        type: ['Alignment'],
+                        targetCode: 'degree',
+                        targetDescription: '1EdTech University Degree programs.',
+                        targetName: '1EdTech University Degree',
+                        targetFramework: '1EdTech University Program and Course Catalog',
+                        targetType: 'CFItem',
+                        targetUrl: 'https://1edtech.edu/catalog/degree',
+                    },
+                    {
+                        type: ['Alignment'],
+                        targetCode: 'degree',
+                        targetDescription: '1EdTech University Degree programs.',
+                        targetName: '1EdTech University Degree',
+                        targetFramework: '1EdTech University Program and Course Catalog',
+                        targetType: 'CTDL',
+                        targetUrl: 'https://credentialengineregistry.org/resources/ce-98cb027b-95ef-4494-908d-6f7790ec6b6b',
+                    },
+                ],
+                achievementType: 'Degree',
+                creator: {
+                    id: 'https://1edtech.edu/issuers/565049',
+                    type: ['Profile'],
+                    name: '1EdTech University',
+                    url: 'https://1edtech.edu',
+                    phone: '1-222-333-4444',
+                    description: '1EdTech University provides online degree programs.',
+                    image: {
+                        id: 'https://1edtech.edu/logo.png',
+                        type: 'Image',
+                        caption: '1EdTech University logo',
+                    },
+                    email: 'registrar@1edtech.edu',
+                    address: {
+                        type: ['Address'],
+                        addressCountry: 'USA',
+                        addressCountryCode: 'US',
+                        addressRegion: 'TX',
+                        addressLocality: 'Austin',
+                        streetAddress: '123 First St',
+                        postOfficeBoxNumber: '1',
+                        postalCode: '12345',
+                    },
+                },
+                criteria: {
+                    id: 'https://1edtech.edu/achievements/degree',
+                    narrative: 'Complete all required degree courses with a minimum GPA of 3.0.',
+                },
+                description: 'A four-year undergraduate degree from 1EdTech University.',
+                fieldOfStudy: 'Research',
+                humanCode: '1EdTech-DEGREE-001',
+                image: {
+                    id: 'https://1edtech.edu/achievements/degree/image',
+                    type: 'Image',
+                    caption: '1EdTech University Degree',
+                },
+                name: '1EdTech University Degree',
+                otherIdentifier: [
+                    {
+                        type: 'IdentifierEntry',
+                        identifier: '1EdTech-degree-001',
+                        identifierType: 'identifier',
+                    },
+                ],
+                resultDescription: [
+                    {
+                        id: 'urn:uuid:f6ab2b98-0001-4000-8000-000000000001',
+                        type: ['ResultDescription'],
+                        alignment: [
+                            {
+                                type: ['Alignment'],
+                                targetCode: 'project',
+                                targetDescription: 'Project description',
+                                targetName: 'Final Project Grade',
+                                targetFramework: '1EdTech University Grading Policy',
+                                targetType: 'CFItem',
+                                targetUrl: 'https://1edtech.edu/catalog/degree/project-grade',
+                            },
+                        ],
+                        allowedValue: ['A', 'B', 'C', 'D', 'F'],
+                        name: 'Final Project Grade',
+                        requiredValue: 'C',
+                        resultType: 'LetterGrade',
+                    },
+                    {
+                        id: 'urn:uuid:f6ab2b98-0001-4000-8000-000000000002',
+                        type: ['ResultDescription'],
+                        alignment: [
+                            {
+                                type: ['Alignment'],
+                                targetCode: 'gpa',
+                                targetDescription: 'Overall GPA',
+                                targetName: 'GPA',
+                                targetFramework: '1EdTech University Grading Policy',
+                                targetType: 'CFItem',
+                                targetUrl: 'https://1edtech.edu/catalog/degree/gpa',
+                            },
+                        ],
+                        allowedValue: ['3.0', '4.0'],
+                        name: 'GPA',
+                        requiredLevel: 'https://1edtech.edu/policy/gpa-minimum',
+                        resultType: 'GPA',
+                    },
+                    {
+                        id: 'urn:uuid:f6ab2b98-0001-4000-8000-000000000003',
+                        type: ['ResultDescription'],
+                        name: 'Status',
+                        resultType: 'Status',
+                    },
+                ],
+                specialization: 'Computer Science',
+                tag: ['research', 'computer-science'],
+            },
+            result: [
+                {
+                    type: ['Result'],
+                    resultDescription: 'urn:uuid:f6ab2b98-0001-4000-8000-000000000001',
+                    value: 'A',
+                },
+                {
+                    type: ['Result'],
+                    resultDescription: 'urn:uuid:f6ab2b98-0001-4000-8000-000000000002',
+                    value: '3.8',
+                },
+                {
+                    type: ['Result'],
+                    resultDescription: 'urn:uuid:f6ab2b98-0001-4000-8000-000000000003',
+                    status: 'Completed',
+                },
+            ],
+        },
+        issuer: {
+            id: 'https://1edtech.edu/issuers/565049',
+            type: ['Profile'],
+            name: '1EdTech University',
+            url: 'https://1edtech.edu',
+            phone: '1-222-333-4444',
+            description: '1EdTech University provides online degree programs.',
+            image: {
+                id: 'https://1edtech.edu/logo.png',
+                type: 'Image',
+                caption: '1EdTech University logo',
+            },
+            email: 'registrar@1edtech.edu',
+        },
+        validFrom: '2010-01-01T00:00:00Z',
+        validUntil: '2030-01-01T00:00:00Z',
+        credentialSchema: [
+            {
+                id: 'https://purl.imsglobal.org/spec/ob/v3p0/schema/json/ob_v3p0_achievementcredential_schema.json',
+                type: '1EdTechJsonSchemaValidator2019',
+            },
+        ],
+        credentialStatus: {
+            id: 'https://1edtech.edu/credentials/3732/revocations',
+            type: '1EdTechRevocationList',
+        },
+        refreshService: {
+            id: 'http://1edtech.edu/credentials/3732',
+            type: '1EdTechCredentialRefresh',
+        },
+        evidence: [
+            {
+                id: 'https://1edtech.edu/credentials/3732/evidence/1',
+                type: ['Evidence'],
+                narrative: 'Student demonstrated mastery through coursework, exams, and a capstone project.',
+            },
+        ],
+    },
+};

package/src/fixtures/obv3/course-completion.ts

@@ -0,0 +1,82 @@
+import type { CredentialFixture } from '../../types';
+
+export const obv3CourseCompletion: CredentialFixture = {
+    id: 'obv3/course-completion',
+    name: 'Introduction to Machine Learning Course Completion',
+    description:
+        'An online course completion badge from a MOOC platform, representing a common real-world use case for OBv3 credentials in online education.',
+    spec: 'obv3',
+    profile: 'course',
+    features: ['image', 'evidence'],
+    source: 'synthetic',
+    signed: false,
+    validity: 'valid',
+    tags: ['course', 'mooc', 'machine-learning', 'online-education'],
+
+    credential: {
+        '@context': [
+            'https://www.w3.org/ns/credentials/v2',
+            'https://purl.imsglobal.org/spec/ob/v3p0/context-3.0.3.json',
+        ],
+        id: 'urn:uuid:a5f3e2c1-8d4b-47f0-b293-1e4a6f8c9d02',
+        type: ['VerifiableCredential', 'OpenBadgeCredential'],
+        name: 'Introduction to Machine Learning',
+        description:
+            'Successfully completed the Introduction to Machine Learning course, covering supervised learning, unsupervised learning, neural networks, and model evaluation.',
+        image: {
+            id: 'https://learn-platform-example.com/badges/intro-ml.png',
+            type: 'Image',
+            caption: 'Introduction to Machine Learning completion badge',
+        },
+        credentialSubject: {
+            id: 'did:example:learner-ml-042',
+            type: ['AchievementSubject'],
+            achievement: {
+                id: 'https://learn-platform-example.com/courses/intro-ml',
+                type: ['Achievement'],
+                achievementType: 'Course',
+                name: 'Introduction to Machine Learning',
+                description:
+                    'A 10-week course covering the fundamentals of machine learning, including linear regression, classification, clustering, dimensionality reduction, and neural networks. Includes hands-on coding assignments in Python using scikit-learn and TensorFlow.',
+                criteria: {
+                    id: 'https://learn-platform-example.com/courses/intro-ml/criteria',
+                    narrative:
+                        'Complete all 10 weekly modules, pass each quiz with 80% or higher, and submit 3 coding assignments with a passing grade.',
+                },
+                image: {
+                    id: 'https://learn-platform-example.com/badges/intro-ml.png',
+                    type: 'Image',
+                    caption: 'Intro to ML badge',
+                },
+                creator: {
+                    id: 'https://learn-platform-example.com/issuers/platform',
+                    type: ['Profile'],
+                    name: 'LearnPlatform Online Education',
+                    url: 'https://learn-platform-example.com',
+                    description: 'An online learning platform offering courses in technology, data science, and business.',
+                },
+                tag: ['machine-learning', 'python', 'data-science', 'artificial-intelligence'],
+            },
+        },
+        issuer: {
+            id: 'did:web:learn-platform-example.com',
+            type: ['Profile'],
+            name: 'LearnPlatform Online Education',
+            url: 'https://learn-platform-example.com',
+            image: {
+                id: 'https://learn-platform-example.com/logo.png',
+                type: 'Image',
+                caption: 'LearnPlatform logo',
+            },
+        },
+        validFrom: '2025-01-20T00:00:00Z',
+        evidence: [
+            {
+                id: 'https://learn-platform-example.com/evidence/learner-ml-042/intro-ml',
+                type: ['Evidence'],
+                narrative:
+                    'Learner completed all 10 modules, achieved an average quiz score of 94%, and submitted all 3 coding assignments with passing grades. Final project: built a sentiment analysis classifier using scikit-learn achieving 91% accuracy on test data.',
+            },
+        ],
+    },
+};

package/src/fixtures/obv3/endorsement.ts

@@ -0,0 +1,58 @@
+import type { CredentialFixture } from '../../types';
+
+export const obv3EndorsementCredential: CredentialFixture = {
+    id: 'obv3/endorsement-credential',
+    name: 'Program Accreditation Endorsement',
+    description:
+        'An OBv3 EndorsementCredential where an accrediting body endorses a university program. Represents the real-world accreditation pattern in higher education.',
+    spec: 'obv3',
+    profile: 'endorsement',
+    features: ['endorsement', 'expiration', 'credential-schema', 'status'],
+    source: 'synthetic',
+    signed: false,
+    validity: 'valid',
+    tags: ['endorsement', 'accreditation', 'higher-education', 'quality-assurance'],
+
+    credential: {
+        '@context': [
+            'https://www.w3.org/ns/credentials/v2',
+            'https://purl.imsglobal.org/spec/ob/v3p0/context-3.0.3.json',
+        ],
+        id: 'urn:uuid:a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d',
+        type: ['VerifiableCredential', 'EndorsementCredential'],
+        name: 'ABET Accreditation – Computer Science Program',
+        description:
+            'Endorsement certifying that the Computer Science program at Pacific Coast University meets the quality standards set by the Accreditation Board for Engineering and Technology (ABET).',
+        credentialSubject: {
+            id: 'https://pcu-example.edu/programs/bs-cs',
+            type: ['EndorsementSubject'],
+            endorsementComment:
+                'The Computer Science program at Pacific Coast University has been evaluated and found to meet or exceed all criteria for accreditation. The program demonstrates strong student outcomes, qualified faculty, continuous improvement processes, and adequate institutional support.',
+        },
+        issuer: {
+            id: 'did:web:abet-example.org',
+            type: ['Profile'],
+            name: 'Accreditation Board for Engineering and Technology (ABET)',
+            url: 'https://abet-example.org',
+            description:
+                'ABET accredits college and university programs in the disciplines of applied and natural science, computing, engineering, and engineering technology.',
+            image: {
+                id: 'https://abet-example.org/logo.png',
+                type: 'Image',
+                caption: 'ABET logo',
+            },
+        },
+        validFrom: '2023-10-01T00:00:00Z',
+        validUntil: '2029-10-01T00:00:00Z',
+        credentialSchema: [
+            {
+                id: 'https://purl.imsglobal.org/spec/ob/v3p0/schema/json/ob_v3p0_endorsementcredential_schema.json',
+                type: '1EdTechJsonSchemaValidator2019',
+            },
+        ],
+        credentialStatus: {
+            id: 'https://abet-example.org/credentials/status/2023/1',
+            type: '1EdTechRevocationList',
+        },
+    },
+};