@conform-ed/contracts 0.0.3

package/test/open-badges-v3_0.test.ts

@@ -0,0 +1,144 @@
+import { expect, test } from "bun:test";
+
+import { OpenBadgesV3_0 } from "../src";
+
+test("AchievementCredentialSchema parses a realistic Open Badge credential", () => {
+  const parsed = OpenBadgesV3_0.AchievementCredentialSchema.safeParse({
+    "@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://example.edu/credentials/3732",
+    type: ["VerifiableCredential", "OpenBadgeCredential"],
+    issuer: {
+      id: "https://example.edu/issuers/565049",
+      type: ["Profile"],
+      name: "Example University",
+    },
+    validFrom: "2010-01-01T00:00:00Z",
+    name: "Example University Degree",
+    credentialSubject: {
+      id: "did:example:ebfeb1f712ebc6f1c276e12ec21",
+      type: ["AchievementSubject"],
+      achievement: {
+        id: "https://example.com/achievements/21st-century-skills/teamwork",
+        type: ["Achievement"],
+        criteria: {
+          narrative: "Team members are nominated for this badge by peers and recognized upon management review.",
+        },
+        description: "This badge recognizes collaboration capacity in group environments.",
+        name: "Teamwork",
+      },
+    },
+    credentialSchema: [
+      {
+        id: "https://purl.imsglobal.org/spec/ob/v3p0/schema/json/ob_v3p0_achievementcredential_schema.json",
+        type: "1EdTechJsonSchemaValidator2019",
+      },
+    ],
+    proof: {
+      type: "DataIntegrityProof",
+      created: "2010-01-01T19:23:24Z",
+      verificationMethod: "https://example.edu/issuers/565049#z6MkjZRsdasZv3aez3r18pB1RBFJR1kwUVJ5jHt92JmQwXbd5hwi",
+      cryptosuite: "eddsa-rdfc-2022",
+      proofPurpose: "assertionMethod",
+      proofValue: "z4HwAsa7GvwL7so7CoQ8v3ShzykRPCq8pfkAFKuAPrJx28S69pXphpqL8ApjoxEcMaqbgkaCUyKuEohhGXBR4Fh3L",
+    },
+  });
+
+  expect(parsed.success).toBe(true);
+});
+
+test("EndorsementCredentialSchema parses a valid endorsement credential", () => {
+  const parsed = OpenBadgesV3_0.EndorsementCredentialSchema.safeParse({
+    "@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://example.edu/endorsementcredential/3732",
+    type: ["VerifiableCredential", "EndorsementCredential"],
+    issuer: {
+      id: "https://state.gov/issuers/565049",
+      type: ["Profile"],
+      name: "State Department of Education",
+    },
+    validFrom: "2010-01-01T00:00:00Z",
+    validUntil: "2030-01-01T00:00:00Z",
+    name: "Example endorsement",
+    credentialSubject: {
+      id: "https://example.edu/issuers/565049",
+      type: ["EndorsementSubject"],
+      endorsementComment: "Example University is in good standing",
+    },
+    credentialSchema: [
+      {
+        id: "https://purl.imsglobal.org/spec/ob/v3p0/schema/json/ob_v3p0_endorsementcredential_schema.json",
+        type: "1EdTechJsonSchemaValidator2019",
+      },
+    ],
+  });
+
+  expect(parsed.success).toBe(true);
+});
+
+test("GetOpenBadgeCredentialsResponseSchema parses credential and JWS collections", () => {
+  const parsed = OpenBadgesV3_0.GetOpenBadgeCredentialsResponseSchema.safeParse({
+    credential: {
+      "@context": [
+        "https://www.w3.org/ns/credentials/v2",
+        "https://purl.imsglobal.org/spec/ob/v3p0/context-3.0.3.json",
+      ],
+      id: "https://example.test/credentials/1",
+      type: ["VerifiableCredential", "OpenBadgeCredential"],
+      issuer: "https://example.test/issuers/1",
+      validFrom: "2025-01-01T00:00:00Z",
+      credentialSubject: {
+        type: ["AchievementSubject"],
+        achievement: {
+          id: "https://example.test/achievements/1",
+          type: ["Achievement"],
+          name: "Example Achievement",
+          description: "Awarded for completing the example pathway.",
+          criteria: { narrative: "Complete every required task." },
+        },
+      },
+    },
+    compactJwsString: "header.payload.signature",
+  });
+
+  expect(parsed.success).toBe(true);
+});
+
+test("AchievementCredentialSchema rejects missing OB context", () => {
+  const parsed = OpenBadgesV3_0.AchievementCredentialSchema.safeParse({
+    "@context": ["https://www.w3.org/ns/credentials/v2"],
+    id: "https://example.test/credentials/1",
+    type: ["VerifiableCredential", "OpenBadgeCredential"],
+    issuer: "https://example.test/issuers/1",
+    validFrom: "2025-01-01T00:00:00Z",
+    credentialSubject: {
+      type: ["AchievementSubject"],
+      achievement: {
+        id: "https://example.test/achievements/1",
+        type: ["Achievement"],
+        name: "Example Achievement",
+        description: "Awarded for completing the example pathway.",
+        criteria: { narrative: "Complete every required task." },
+      },
+    },
+  });
+
+  expect(parsed.success).toBe(false);
+});
+
+test("OpenBadges30DerivedZodTemplates exposes expected entry points", () => {
+  expect(OpenBadgesV3_0.OpenBadges30DerivedZodTemplates.achievementCredential).toBe(
+    OpenBadgesV3_0.AchievementCredentialSchema,
+  );
+  expect(OpenBadgesV3_0.OpenBadges30DerivedZodTemplates.openBadgeCredential).toBe(
+    OpenBadgesV3_0.OpenBadgeCredentialSchema,
+  );
+  expect(OpenBadgesV3_0.OpenBadges30DerivedZodTemplates.imsxStatusInfo).toBe(OpenBadgesV3_0.ImsxStatusInfoSchema);
+});

package/test/qti-v2_1.test.ts

@@ -0,0 +1,146 @@
+import { expect, test } from "bun:test";
+
+import { QtiV2_1 } from "../src";
+
+test("QtiV2_1 metadata document parses a minimal metadata payload", () => {
+  const parsed = QtiV2_1.QtiMetadataDocumentSchema.safeParse({
+    qtiMetadata: {
+      itemTemplate: false,
+      interactionType: ["choiceInteraction"],
+      feedbackType: "nonadaptive",
+      solutionAvailable: true,
+    },
+  });
+
+  expect(parsed.success).toBe(true);
+});
+
+test("QtiV2_1 assessment item document parses a minimal choice item", () => {
+  const parsed = QtiV2_1.QtiAssessmentItemDocumentSchema.safeParse({
+    assessmentItem: {
+      identifier: "ITEM1",
+      responseDeclarations: [
+        {
+          identifier: "RESPONSE",
+          cardinality: "single",
+          baseType: "identifier",
+          correctResponse: {
+            values: [{ value: "A" }],
+          },
+        },
+      ],
+      outcomeDeclarations: [
+        {
+          identifier: "SCORE",
+          cardinality: "single",
+          baseType: "float",
+          defaultValue: {
+            values: [{ value: "0" }],
+          },
+        },
+      ],
+      itemBody: {
+        children: [
+          {
+            kind: "choiceInteraction",
+            responseIdentifier: "RESPONSE",
+            simpleChoices: [
+              {
+                kind: "simpleChoice",
+                identifier: "A",
+                children: [{ kind: "text", value: "Option A" }],
+              },
+              {
+                kind: "simpleChoice",
+                identifier: "B",
+                children: [{ kind: "text", value: "Option B" }],
+              },
+            ],
+          },
+        ],
+      },
+      responseProcessing: {
+        rules: [
+          {
+            kind: "setOutcomeValue",
+            identifier: "SCORE",
+            expression: {
+              kind: "baseValue",
+              baseType: "float",
+              value: "1.0",
+            },
+          },
+        ],
+      },
+    },
+  });
+
+  expect(parsed.success).toBe(true);
+});
+
+test("QtiV2_1 result document rejects record responses without field identifiers", () => {
+  const parsed = QtiV2_1.QtiAssessmentResultDocumentSchema.safeParse({
+    assessmentResult: {
+      context: {},
+      itemResults: [
+        {
+          identifier: "ITEM1",
+          datestamp: "2026-05-27T12:00:00Z",
+          sessionStatus: "final",
+          responseVariables: [
+            {
+              identifier: "RESPONSE",
+              cardinality: "record",
+              candidateResponse: {
+                values: [{ value: "A" }],
+              },
+            },
+          ],
+        },
+      ],
+    },
+  });
+
+  expect(parsed.success).toBe(false);
+});
+
+test("QtiV2_1 manifest document parses a minimal package", () => {
+  const parsed = QtiV2_1.QtiManifestDocumentSchema.safeParse({
+    manifest: {
+      identifier: "manifest-1",
+      metadata: {
+        schema: "QTIv2.1 Package",
+        schemaVersion: "1.0.0",
+      },
+      organizations: {},
+      resources: [
+        {
+          identifier: "item-resource",
+          type: "imsqti_item_xmlv2p1",
+          href: "items/item1.xml",
+          files: [{ href: "items/item1.xml" }],
+        },
+      ],
+    },
+  });
+
+  expect(parsed.success).toBe(true);
+});
+
+test("QtiV2_1 APIP accessibility document parses a minimal payload", () => {
+  const parsed = QtiV2_1.QtiApipAccessibilityDocumentSchema.safeParse({
+    apipAccessibility: {
+      accessibilityInfo: {
+        accessElements: [
+          {
+            identifier: "ae1",
+            contentLinkInfos: [{ qtiLinkIdentifier: "choice-A" }],
+            relatedElementInfo: {},
+          },
+        ],
+      },
+    },
+  });
+
+  expect(parsed.success).toBe(true);
+});

package/test/qti-v2_2.test.ts

@@ -0,0 +1,154 @@
+import { expect, test } from "bun:test";
+
+import { QtiV2_2 } from "../src";
+
+test("QtiV2_2 metadata document parses a minimal metadata payload with scoring modes", () => {
+  const parsed = QtiV2_2.QtiMetadataDocumentSchema.safeParse({
+    qtiMetadata: {
+      itemTemplate: false,
+      interactionType: ["choiceInteraction", "mediaInteraction"],
+      scoringMode: ["responseprocessing"],
+      toolName: "conform-ed",
+    },
+  });
+
+  expect(parsed.success).toBe(true);
+});
+
+test("QtiV2_2 assessment stimulus and assessment item documents parse together", () => {
+  const stimulusParsed = QtiV2_2.QtiAssessmentStimulusDocumentSchema.safeParse({
+    assessmentStimulus: {
+      identifier: "STIM1",
+      stimulusBody: {
+        children: [
+          {
+            kind: "article",
+            children: [{ kind: "text", value: "Shared stimulus" }],
+          },
+        ],
+      },
+    },
+  });
+
+  const itemParsed = QtiV2_2.QtiAssessmentItemDocumentSchema.safeParse({
+    assessmentItem: {
+      identifier: "ITEM1",
+      assessmentStimulusRefs: [{ href: "stimulus.xml", identifier: "STIM1" }],
+      responseDeclarations: [
+        {
+          identifier: "RESPONSE",
+          cardinality: "single",
+          baseType: "identifier",
+        },
+      ],
+      itemBody: {
+        children: [
+          {
+            kind: "choiceInteraction",
+            responseIdentifier: "RESPONSE",
+            simpleChoices: [
+              { kind: "simpleChoice", identifier: "A", children: [{ kind: "text", value: "A" }] },
+              { kind: "simpleChoice", identifier: "B", children: [{ kind: "text", value: "B" }] },
+            ],
+          },
+        ],
+      },
+    },
+  });
+
+  expect(stimulusParsed.success).toBe(true);
+  expect(itemParsed.success).toBe(true);
+});
+
+test("QtiV2_2 processing rejects invalid numeric operator parameters", () => {
+  const parsed = QtiV2_2.QtiResponseProcessingDocumentSchema.safeParse({
+    responseProcessing: {
+      rules: [
+        {
+          kind: "setOutcomeValue",
+          identifier: "RANDOM",
+          expression: {
+            kind: "randomInteger",
+            min: 10,
+            max: 1,
+          },
+        },
+      ],
+    },
+  });
+
+  expect(parsed.success).toBe(false);
+});
+
+test("QtiV2_2 curriculum standards metadata and manifest documents parse", () => {
+  const csmParsed = QtiV2_2.QtiCurriculumStandardsMetadataSetDocumentSchema.safeParse({
+    curriculumStandardsMetadataSet: {
+      resourceLabel: "Item",
+      curriculumStandardsMetadata: [
+        {
+          providerId: "provider-1",
+          setOfGuids: [
+            {
+              region: "AU",
+              labelledGuids: [{ guid: "GUID-1", label: "Outcome 1" }],
+            },
+          ],
+        },
+      ],
+    },
+  });
+
+  const manifestParsed = QtiV2_2.QtiManifestDocumentSchema.safeParse({
+    manifest: {
+      identifier: "manifest-2",
+      metadata: {
+        schema: "QTIv2.2 Package",
+        schemaVersion: "1.0.0",
+        curriculumStandardsMetadataSet: {
+          curriculumStandardsMetadata: [
+            {
+              setOfGuids: [
+                {
+                  labelledGuids: [{ guid: "GUID-1" }],
+                },
+              ],
+            },
+          ],
+        },
+      },
+      organizations: {},
+      resources: [
+        {
+          identifier: "stimulus-resource",
+          type: "imsqti_stimulus_xmlv2p2",
+          href: "stimulus.xml",
+          files: [{ href: "stimulus.xml" }],
+        },
+      ],
+    },
+  });
+
+  expect(csmParsed.success).toBe(true);
+  expect(manifestParsed.success).toBe(true);
+});
+
+test("QtiV2_2 APIP accessibility document parses external supplemental accessibility", () => {
+  const parsed = QtiV2_2.QtiApipAccessibilityDocumentSchema.safeParse({
+    apipAccessibility: {
+      externalSupplementalAccessibility: {
+        fileHrefs: [{ href: "supplement.xml" }],
+      },
+      accessibilityInfo: {
+        accessElements: [
+          {
+            identifier: "ae1",
+            contentLinkInfos: [{ qtiLinkIdentifier: "choice-A" }],
+            relatedElementInfo: {},
+          },
+        ],
+      },
+    },
+  });
+
+  expect(parsed.success).toBe(true);
+});