@conform-ed/contracts 0.0.3

package/test/contracts.test.ts

@@ -0,0 +1,125 @@
+import { expect, test } from "bun:test";
+import { AdapterCapabilitySchema, AdapterErrorSchema, AdapterProfileSchema } from "../src/adapter";
+import { RunnerConfigSchema } from "../src/config";
+
+test("RunnerConfigSchema parses minimal config", () => {
+  const parsed = RunnerConfigSchema.parse({
+    suite: { name: "lrs", target: "all" },
+    sut: { publicUrls: { lrs: "http://127.0.0.1:4001/xapi" } },
+    artifacts: { outputDir: "/artifacts" },
+  });
+
+  expect(parsed.contractVersion).toBe("1.0.0");
+});
+
+test("RunnerConfigSchema requires adapter for cmi5 suite", () => {
+  const parsed = RunnerConfigSchema.safeParse({
+    suite: { name: "cmi5", target: "all" },
+    sut: { publicUrls: { api: "http://127.0.0.1:4301" } },
+    artifacts: { outputDir: "/artifacts" },
+  });
+
+  expect(parsed.success).toBe(false);
+});
+
+test("RunnerConfigSchema enforces bearer adapter token source", () => {
+  const parsed = RunnerConfigSchema.safeParse({
+    suite: { name: "cmi5", target: "all" },
+    sut: { publicUrls: { api: "http://127.0.0.1:4301" } },
+    artifacts: { outputDir: "/artifacts" },
+    adapter: {
+      kind: "http",
+      baseUrl: "http://127.0.0.1:4500",
+      auth: { mode: "bearer" },
+    },
+  });
+
+  expect(parsed.success).toBe(false);
+});
+
+test("AdapterCapabilitySchema validates profile payload", () => {
+  const parsed = AdapterCapabilitySchema.safeParse({
+    profileVersion: "1.0.0",
+    adapterName: "emergent-adapter",
+    adapterVersion: "0.1.0",
+    profiles: ["cmi5-http-v1"],
+    operations: ["package.import", "launch.create", "statements.list"],
+  });
+
+  expect(parsed.success).toBe(true);
+});
+
+test("AdapterProfileSchema validates cmi5 interoperability contract", () => {
+  const parsed = AdapterProfileSchema.safeParse({
+    contractVersion: "1.0.0",
+    profileVersion: "1.0.0",
+    suite: "cmi5",
+    adapter: {
+      name: "cmi5-adapter-reference",
+      version: "0.1.0",
+      transport: "http-json",
+    },
+    interoperability: {
+      statementRetrieval: "adapter-api",
+      packageUpload: "inline-base64",
+    },
+    operations: [
+      {
+        name: "package.upload.inline-base64",
+        path: "/v1/cmi5/packages",
+        method: "POST",
+      },
+      {
+        name: "statements.list",
+        path: "/v1/cmi5/statements",
+        method: "GET",
+      },
+    ],
+    artifacts: {
+      requirementTraceRequired: true,
+    },
+  });
+
+  expect(parsed.success).toBe(true);
+});
+
+test("AdapterProfileSchema requires cmi5 packageUpload", () => {
+  const parsed = AdapterProfileSchema.safeParse({
+    contractVersion: "1.0.0",
+    profileVersion: "1.0.0",
+    suite: "cmi5",
+    adapter: {
+      name: "cmi5-adapter-reference",
+      version: "0.1.0",
+      transport: "http-json",
+    },
+    interoperability: {
+      statementRetrieval: "adapter-api",
+    },
+    operations: [
+      {
+        name: "statements.list",
+        path: "/v1/cmi5/statements",
+        method: "GET",
+      },
+    ],
+    artifacts: {
+      requirementTraceRequired: true,
+    },
+  });
+
+  expect(parsed.success).toBe(false);
+});
+
+test("AdapterErrorSchema validates uniform error envelope", () => {
+  const parsed = AdapterErrorSchema.safeParse({
+    error: {
+      code: "upstream_unavailable",
+      message: "Temporary upstream outage",
+      category: "upstream_unavailable",
+      retriable: true,
+    },
+  });
+
+  expect(parsed.success).toBe(true);
+});

package/test/fixtures/cmi5/extended-cmi5.xml

@@ -0,0 +1,72 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- The following file is a course structure with extension -->
+<courseStructure xmlns="https://w3id.org/xapi/profiles/cmi5/v1/CourseStructure.xsd"
+                 xmlns:kw="http://www.adlnet.gov/cmi5/KeywordExtension.xsd">
+  <course id="http://course-repository.example.edu/identifiers/courses/02baafcf">
+    <title>
+      <langstring lang="en-US">Introduction to Geology</langstring>
+    </title>
+    <description>
+      <langstring lang="en-US">
+        This course will introduce you into the basics of geology. This includes subjects such as
+        plate tectonics, geological materials and the history of the Earth.
+      </langstring>
+    </description>
+  </course>
+  <au id="http://course-repository.example.edu/identifiers/courses/02baafcf/aus/4c07">
+    <title>
+      <langstring lang="en-US">Introduction to Geology</langstring>
+    </title>
+    <description>
+      <langstring lang="en-US">
+        This course will introduce you into the basics of geology. This includes subjects such as
+        plate tectonics, geological materials and the history of the Earth.
+      </langstring>
+    </description>
+    <url>http://course-repository.example.edu/identifiers/courses/02baafcf/aus/4c07/launch.html</url>
+    <kw:keyword idref="http://words.example/earth_science"></kw:keyword>
+    <kw:keyword idref="http://words.example/plate_tectonics"></kw:keyword>
+    <kw:keyword idref="http://words.example/open_course"></kw:keyword>
+    <kw:keyword idref="http://words.example/video_based_learning"></kw:keyword>
+    <kw:keyword idref="http://words.example/secondary_school"></kw:keyword>
+  </au>
+  <kw:keywords>
+    <kw:keyword id="http://words.example/earth_science">
+      <kw:title>
+        <langstring lang="en-US">Earth Science</langstring>
+      </kw:title>
+      <kw:description>
+        <langstring lang="en-US">Earth science or geoscience is an all-embracing term referring to the fields of science dealing with planet Earth.</langstring>
+      </kw:description>
+    </kw:keyword>
+    <kw:keyword id="http://words.example/plate_tectonics">
+      <kw:title>
+        <langstring lang="en-US">Plate Tectonics</langstring>
+      </kw:title>
+      <kw:description>
+        <langstring lang="en-US">Plate tectonics is a scientific theory that describes the motion of Earth's lithosphere.</langstring>
+      </kw:description>
+    </kw:keyword>
+    <kw:keyword id="http://words.example/open_course">
+      <kw:title>
+        <langstring lang="en-US">Open Course</langstring>
+      </kw:title>
+      <kw:description>
+        <langstring lang="en-US">This course is copyrighted with an open license</langstring>
+      </kw:description>
+    </kw:keyword>
+    <kw:keyword id="http://words.example/video_based_learning">
+      <kw:title>
+        <langstring lang="en-US">Video Based Learning</langstring>
+      </kw:title>
+    </kw:keyword>
+    <kw:keyword id="http://words.example/secondary_school">
+      <kw:title>
+        <langstring lang="en-US">Secondary School</langstring>
+      </kw:title>
+      <kw:description>
+        <langstring lang="en-US">The content is prepared for secondary school students</langstring>
+      </kw:description>
+    </kw:keyword>
+  </kw:keywords>
+</courseStructure>

package/test/fixtures/cmi5/simple-cmi5.xml

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="utf-8"?>
+<courseStructure xmlns="https://w3id.org/xapi/profiles/cmi5/v1/CourseStructure.xsd">
+  <course id="http://course-repository.example.edu/identifiers/courses/02baafcf">
+    <title>
+      <langstring lang="en-US">Introduction to Geology</langstring>
+    </title>
+    <description>
+      <langstring lang="en-US">
+        This course will introduce you into the basics of geology. This includes subjects such as
+        plate tectonics, geological materials and the history of the Earth.
+      </langstring>
+    </description>
+  </course>
+  <au id="http://course-repository.example.edu/identifiers/courses/02baafcf/aus/4c07">
+    <title>
+      <langstring lang="en-US">Introduction to Geology</langstring>
+    </title>
+    <description>
+      <langstring lang="en-US">
+        This course will introduce you into the basics of geology. This includes subjects such as
+        plate tectonics, geological materials and the history of the Earth.
+      </langstring>
+    </description>
+    <url>http://course-repository.example.edu/identifiers/courses/02baafcf/aus/4c07/launch.html</url>
+  </au>
+</courseStructure>

package/test/lti.test.ts

@@ -0,0 +1,146 @@
+import { expect, test } from "bun:test";
+import { LtiAgsV2_0, LtiDeepLinkingV2_0, LtiNrpsV2_0, LtiProctoringV1_0, LtiV1_3 } from "@conform-ed/contracts";
+
+test("LTI core launch schema accepts a normalized resource link launch", () => {
+  const parsed = LtiV1_3.CoreLaunchRequestSchema.safeParse({
+    messageType: "LtiResourceLinkRequest",
+    version: "1.3.0",
+    deploymentId: "deployment-123",
+    targetLinkUri: "https://tool.example/launch",
+    resourceLink: { id: "resource-123", title: "Example Resource" },
+    subject: "student-123",
+    context: { id: "course-123", title: "Course 123" },
+    roles: ["http://purl.imsglobal.org/vocab/lis/v2/membership#Learner"],
+    lis: { courseOfferingSourcedId: "course-123" },
+    launchPresentation: { documentTarget: "iframe", locale: "en-US" },
+  });
+
+  expect(parsed.success).toBe(true);
+});
+
+test("LTI deep linking schema accepts request settings and response items", () => {
+  const request = LtiDeepLinkingV2_0.DeepLinkingRequestSchema.safeParse({
+    messageType: "LtiDeepLinkingRequest",
+    version: "1.3.0",
+    deploymentId: "deployment-123",
+    subject: "student-123",
+    deepLinkingSettings: {
+      deepLinkReturnUrl: "https://platform.example/deep-link/return",
+      acceptTypes: ["ltiResourceLink"],
+      acceptPresentationDocumentTargets: ["iframe", "window"],
+      acceptMediaTypes: "image/*,text/html",
+      acceptMultiple: true,
+      autoCreate: true,
+      title: "Select content",
+    },
+  });
+
+  expect(request.success).toBe(true);
+
+  const response = LtiDeepLinkingV2_0.DeepLinkingResponseSchema.safeParse({
+    messageType: "LtiDeepLinkingResponse",
+    version: "1.3.0",
+    contentItems: [
+      {
+        type: "ltiResourceLink",
+        title: "Example Link",
+        url: "https://tool.example/content/alpha",
+      },
+    ],
+  });
+
+  expect(response.success).toBe(true);
+});
+
+test("LTI AGS schema accepts endpoint, line item, score, and result shapes", () => {
+  expect(
+    LtiAgsV2_0.EndpointSchema.safeParse({
+      scope: ["https://purl.imsglobal.org/spec/lti-ags/scope/lineitem"],
+      lineitems: "https://platform.example/lineitems",
+    }).success,
+  ).toBe(true);
+
+  expect(
+    LtiAgsV2_0.LineItemSchema.safeParse({
+      id: "https://platform.example/lineitems/1",
+      label: "Example Grade",
+      scoreMaximum: 100,
+      resourceLinkId: "resource-123",
+    }).success,
+  ).toBe(true);
+
+  expect(
+    LtiAgsV2_0.ScoreSchema.safeParse({
+      userId: "student-123",
+      scoreGiven: 85,
+      scoreMaximum: 100,
+      activityProgress: "InProgress",
+      gradingProgress: "Pending",
+    }).success,
+  ).toBe(true);
+
+  expect(
+    LtiAgsV2_0.ResultSchema.safeParse({
+      userId: "student-123",
+      resultScore: 85,
+      resultMaximum: 100,
+    }).success,
+  ).toBe(true);
+});
+
+test("LTI NRPS schema accepts names/roles service and membership container shapes", () => {
+  expect(
+    LtiNrpsV2_0.NamesRoleServiceSchema.safeParse({
+      contextMembershipsUrl: "https://platform.example/context/2923/memberships",
+      serviceVersions: ["2.0"],
+    }).success,
+  ).toBe(true);
+
+  expect(
+    LtiNrpsV2_0.MembershipContainerSchema.safeParse({
+      id: "https://platform.example/context/2923/memberships",
+      context: {
+        id: "2923-abc",
+        title: "CPS 435 Learning Analytics",
+      },
+      members: [
+        {
+          status: "Active",
+          name: "Jane Q. Public",
+          email: "jane@example.com",
+          userId: "0ae836b9-7fc9-4060-006f-27b2066ac545",
+          roles: ["http://purl.imsglobal.org/vocab/lis/v2/membership#Instructor"],
+        },
+      ],
+    }).success,
+  ).toBe(true);
+});
+
+test("LTI proctoring schema accepts start and end assessment messages", () => {
+  expect(
+    LtiProctoringV1_0.StartProctoringMessageSchema.safeParse({
+      messageType: "StartProctoringMessage",
+      version: "1.3.0",
+      deploymentId: "deployment-123",
+      targetLinkUri: "https://tool.example/proctoring",
+      resourceLink: { id: "resource-123" },
+      subject: "student-123",
+      attemptNumber: 2,
+      startAssessmentUrl: "https://platform.example/assessment/start",
+      sessionData: "session-demo-123",
+      roles: ["http://purl.imsglobal.org/vocab/lis/v2/membership#Learner"],
+    }).success,
+  ).toBe(true);
+
+  expect(
+    LtiProctoringV1_0.EndAssessmentMessageSchema.safeParse({
+      messageType: "EndAssessmentMessage",
+      version: "1.3.0",
+      deploymentId: "deployment-123",
+      targetLinkUri: "https://tool.example/proctoring",
+      subject: "student-123",
+      attemptNumber: 2,
+      roles: ["http://purl.imsglobal.org/vocab/lis/v2/membership#Learner"],
+    }).success,
+  ).toBe(true);
+});

package/test/oneroster-v1_2.test.ts

@@ -0,0 +1,234 @@
+import { expect, test } from "bun:test";
+
+import { OneRosterV1_2 } from "../src";
+
+test("UserSchema parses a minimal OneRoster user", () => {
+  const parsed = OneRosterV1_2.UserSchema.safeParse({
+    sourcedId: "user-1",
+    status: "active",
+    dateLastModified: "2025-01-01T00:00:00Z",
+    enabledUser: "true",
+    givenName: "Ada",
+    familyName: "Lovelace",
+    roles: [
+      {
+        roleType: "primary",
+        role: "teacher",
+        org: {
+          href: "https://example.edu/orgs/1",
+          sourcedId: "org-1",
+          type: "org",
+        },
+      },
+    ],
+  });
+
+  expect(parsed.success).toBe(true);
+});
+
+test("LineItemSchema parses a minimal gradebook line item", () => {
+  const parsed = OneRosterV1_2.LineItemSchema.safeParse({
+    sourcedId: "line-item-1",
+    status: "active",
+    dateLastModified: "2025-01-01T00:00:00Z",
+    title: "Quiz 1",
+    assignDate: "2025-01-10T09:00:00Z",
+    dueDate: "2025-01-17T09:00:00Z",
+    class: {
+      href: "https://example.edu/classes/1",
+      sourcedId: "class-1",
+      type: "class",
+    },
+    school: {
+      href: "https://example.edu/orgs/1",
+      sourcedId: "org-1",
+      type: "org",
+    },
+    category: {
+      href: "https://example.edu/categories/1",
+      sourcedId: "category-1",
+      type: "category",
+    },
+  });
+
+  expect(parsed.success).toBe(true);
+});
+
+test("ResourceSchema parses a minimal resource entry", () => {
+  const parsed = OneRosterV1_2.ResourceSchema.safeParse({
+    sourcedId: "resource-1",
+    status: "active",
+    dateLastModified: "2025-01-01T00:00:00Z",
+    vendorResourceId: "vendor-asset-991",
+    importance: "primary",
+    roles: ["student", "teacher"],
+  });
+
+  expect(parsed.success).toBe(true);
+});
+
+test("ImsxStatusInfoSchema parses a OneRoster status envelope", () => {
+  const parsed = OneRosterV1_2.ImsxStatusInfoSchema.safeParse({
+    imsx_codeMajor: "failure",
+    imsx_severity: "error",
+    imsx_description: "Unknown object",
+    imsx_CodeMinor: {
+      imsx_codeMinorField: [
+        {
+          imsx_codeMinorFieldName: "sourcedId",
+          imsx_codeMinorFieldValue: "unknownobject",
+        },
+      ],
+    },
+  });
+
+  expect(parsed.success).toBe(true);
+});
+
+test("EnrollmentRoleSchema accepts extension values and rejects unknown built-ins", () => {
+  expect(OneRosterV1_2.EnrollmentRoleSchema.safeParse("ext:mentor").success).toBe(true);
+  expect(OneRosterV1_2.EnrollmentRoleSchema.safeParse("mentor").success).toBe(false);
+});
+
+test("ClassSchema requires at least one term reference", () => {
+  const parsed = OneRosterV1_2.ClassSchema.safeParse({
+    sourcedId: "class-1",
+    status: "active",
+    dateLastModified: "2025-01-01T00:00:00Z",
+    title: "Algebra I",
+    course: {
+      href: "https://example.edu/courses/1",
+      sourcedId: "course-1",
+      type: "course",
+    },
+    school: {
+      href: "https://example.edu/orgs/1",
+      sourcedId: "org-1",
+      type: "org",
+    },
+    terms: [],
+  });
+
+  expect(parsed.success).toBe(false);
+});
+
+test("OneRoster12DerivedZodTemplates exposes core published entry points", () => {
+  expect(OneRosterV1_2.OneRoster12DerivedZodTemplates.user).toBe(OneRosterV1_2.UserSchema);
+  expect(OneRosterV1_2.OneRoster12DerivedZodTemplates.lineItem).toBe(OneRosterV1_2.LineItemSchema);
+  expect(OneRosterV1_2.OneRoster12DerivedZodTemplates.resource).toBe(OneRosterV1_2.ResourceSchema);
+  expect(OneRosterV1_2.OneRoster12DerivedZodTemplates.imsxStatusInfo).toBe(OneRosterV1_2.ImsxStatusInfoSchema);
+});
+
+test("OneRoster REST binding operation catalogs expose all endpoint schemas", () => {
+  expect(Object.keys(OneRosterV1_2.RosteringRestBindingOperationSchemas).length).toBe(41);
+  expect(Object.keys(OneRosterV1_2.GradebookRestBindingOperationSchemas).length).toBe(35);
+  expect(Object.keys(OneRosterV1_2.ResourceRestBindingOperationSchemas).length).toBe(5);
+});
+
+test("Gradebook operation bindings expose request/response payload schemas", () => {
+  const binding = OneRosterV1_2.GradebookRestBindingOperationSchemas.postLineItemsForClass;
+
+  expect(binding.method).toBe("POST");
+  expect(binding.path).toBe("/classes/{classSourcedId}/lineItems");
+  expect(binding.requestPayload).toBe(OneRosterV1_2.LineItemSetSchema);
+  expect(binding.successResponsePayload).toBe(OneRosterV1_2.GuidPairSetSchema);
+  expect(binding.errorResponsePayload).toBe(OneRosterV1_2.ImsxStatusInfoSchema);
+});
+
+test("ManifestCsvRowSchema accepts either starred or unstarred optional file keys", () => {
+  const parsed = OneRosterV1_2.ManifestCsvRowSchema.safeParse({
+    "manifest.version": "1.0",
+    "oneroster.version": "1.2",
+    "file.academicSessions": "bulk",
+    "file.categories": "bulk",
+    "file.classes": "bulk",
+    "file.classResources": "bulk",
+    "file.courses": "bulk",
+    "file.courseResources": "bulk",
+    "file.demographics": "bulk",
+    "file.enrollments": "bulk",
+    "file.lineItems": "bulk",
+    "file.orgs": "bulk",
+    "file.resources": "bulk",
+    "file.results": "bulk",
+    "file.users": "bulk",
+    "file.lineItemLearningObjectiveIds*": "bulk",
+    "file.lineItemScoreScales": "bulk",
+    "file.resultLearningObjectiveIds*": "bulk",
+    "file.resultScoreScales": "bulk",
+    "file.roles*": "bulk",
+    "file.scoreScales": "bulk",
+    "file.userProfiles*": "bulk",
+    "file.userResources": "bulk",
+  });
+
+  expect(parsed.success).toBe(true);
+});
+
+test("UsersCsvRowSchema validates required OneRoster 1.2 user CSV columns", () => {
+  const parsed = OneRosterV1_2.UsersCsvRowSchema.safeParse({
+    sourcedId: "user-1",
+    status: "active",
+    dateLastModified: "2025-01-01T00:00:00Z",
+    enabledUser: "true",
+    username: "ada",
+    givenName: "Ada",
+    familyName: "Lovelace",
+  });
+
+  expect(parsed.success).toBe(true);
+});
+
+test("OneRosterCsvBindingPackageSchema validates package-level CSV document sets", () => {
+  const parsed = OneRosterV1_2.OneRosterCsvBindingPackageSchema.safeParse({
+    manifest: [
+      {
+        "manifest.version": "1.0",
+        "oneroster.version": "1.2",
+        "file.academicSessions": "bulk",
+        "file.categories": "bulk",
+        "file.classes": "bulk",
+        "file.classResources": "bulk",
+        "file.courses": "bulk",
+        "file.courseResources": "bulk",
+        "file.demographics": "bulk",
+        "file.enrollments": "bulk",
+        "file.lineItems": "bulk",
+        "file.orgs": "bulk",
+        "file.resources": "bulk",
+        "file.results": "bulk",
+        "file.users": "bulk",
+        "file.lineItemLearningObjectiveIds": "bulk",
+        "file.lineItemScoreScales": "bulk",
+        "file.resultLearningObjectiveIds": "bulk",
+        "file.resultScoreScales": "bulk",
+        "file.roles": "bulk",
+        "file.scoreScales": "bulk",
+        "file.userProfiles": "bulk",
+        "file.userResources": "bulk",
+      },
+    ],
+    users: [
+      {
+        sourcedId: "user-1",
+        status: "active",
+        dateLastModified: "2025-01-01T00:00:00Z",
+        enabledUser: "true",
+        username: "ada",
+        givenName: "Ada",
+        familyName: "Lovelace",
+      },
+    ],
+    orgs: [
+      {
+        sourcedId: "org-1",
+        status: "active",
+        dateLastModified: "2025-01-01T00:00:00Z",
+        name: "Example School",
+        type: "school",
+      },
+    ],
+  });
+
+  expect(parsed.success).toBe(true);
+});