@conform-ed/contracts 0.0.3

package/.turbo/turbo-build.log

@@ -0,0 +1,2 @@
+
+$ tsgo --noEmit

package/.turbo/turbo-format.log

@@ -0,0 +1,6 @@
+
+$ oxfmt --config ../../.oxfmtrc.jsonc --check .
+Checking formatting...
+
+All matched files use the correct format.
+Finished in 665ms on 180 files using 8 threads.

package/.turbo/turbo-lint.log

@@ -0,0 +1,4 @@
+
+$ oxlint --config ../../.oxlintrc.jsonc .
+Found 0 warnings and 0 errors.
+Finished in 938ms on 162 files with 102 rules using 8 threads.

package/.turbo/turbo-test.log

@@ -0,0 +1,196 @@
+
+$ bun test
+bun test v1.3.14 (0d9b296a)
+
+test/xapi.test.ts:
+✓ xAPI 1.0.3 statement schema accepts the core data model [9.81ms]
+✓ xAPI 2.0 statement schema accepts the same core data model [1.62ms]
+✓ xAPI 2.0 statement schema accepts IEEE 2.0 contextAgent/contextGroup objects [5.43ms]
+✓ xAPI statement submission schema accepts batches [0.28ms]
+✓ xAPI document, listing, and about schemas validate LRS metadata [1.72ms]
+✓ xAPI validation rejects statements missing required fields [0.36ms]
+✓ xAPI statement result, person object, and resource queries validate missing spec objects [2.13ms]
+✓ xAPI HTTP method enum validates LRS operations [0.10ms]
+✓ xAPI error response schema validates LRS error payloads [0.38ms]
+✓ xAPI error codes validate standard HTTP status responses [0.12ms]
+✓ xAPI concurrency schema validates ETags and conditional headers [0.31ms]
+✓ xAPI multipart attachment part schema validates attachment data structure [0.16ms]
+✓ xAPI multipart request schema validates statement with attachments [0.41ms]
+✓ xAPI resource schema models LRS endpoint definitions [0.44ms]
+✓ xAPI request and response headers are properly enumerated [0.17ms]
+
+test/cmi5-v1_0.test.ts:
+✓ cmi5 course structure schema parses the simple XML example [6.15ms]
+✓ cmi5 keyword extension schema parses the extended XML example [3.01ms]
+✓ cmi5 recursive course structure schema accepts nested blocks and AUs [0.86ms]
+
+test/oneroster-v1_2.test.ts:
+✓ UserSchema parses a minimal OneRoster user [2.35ms]
+✓ LineItemSchema parses a minimal gradebook line item [1.11ms]
+✓ ResourceSchema parses a minimal resource entry [0.65ms]
+✓ ImsxStatusInfoSchema parses a OneRoster status envelope [0.63ms]
+✓ EnrollmentRoleSchema accepts extension values and rejects unknown built-ins [0.20ms]
+✓ ClassSchema requires at least one term reference [1.05ms]
+✓ OneRoster12DerivedZodTemplates exposes core published entry points [0.05ms]
+✓ OneRoster REST binding operation catalogs expose all endpoint schemas [0.05ms]
+✓ Gradebook operation bindings expose request/response payload schemas [0.04ms]
+✓ ManifestCsvRowSchema accepts either starred or unstarred optional file keys [1.70ms]
+✓ UsersCsvRowSchema validates required OneRoster 1.2 user CSV columns [1.09ms]
+✓ OneRosterCsvBindingPackageSchema validates package-level CSV document sets [1.73ms]
+
+test/qti-v2_1.test.ts:
+✓ QtiV2_1 metadata document parses a minimal metadata payload [0.83ms]
+✓ QtiV2_1 assessment item document parses a minimal choice item [10.72ms]
+✓ QtiV2_1 result document rejects record responses without field identifiers [1.75ms]
+✓ QtiV2_1 manifest document parses a minimal package [1.37ms]
+✓ QtiV2_1 APIP accessibility document parses a minimal payload [1.45ms]
+
+test/qti-v3_0_1.test.ts:
+✓ QtiMetadataDocumentSchema parses a minimal metadata document [0.89ms]
+✓ QtiAccessForAllPnpDocumentSchema parses a minimal preferences document [2.57ms]
+✓ QtiAssessmentResultDocumentSchema parses a minimal result report [2.67ms]
+✓ QtiAssessmentResultDocumentSchema rejects record response values without field identifiers [0.30ms]
+✓ QtiAssessmentResultDocumentSchema rejects record outcomes with baseType [0.72ms]
+✓ QtiUsageDataDocumentSchema parses ordinary and categorized statistics [2.83ms]
+✓ QtiUsageDataDocumentSchema rejects invalid objectType and mapping bounds [0.58ms]
+✓ QtiResponseProcessingDocumentSchema parses typed processing operators [11.39ms]
+✓ QtiOutcomeProcessingDocumentSchema parses typed aggregate operators [7.39ms]
+✓ QtiResponseProcessingDocumentSchema rejects invalid operator parameters [2.33ms]
+✓ QtiOutcomeProcessingDocumentSchema rejects invalid operator arity and ranges [2.26ms]
+✓ QtiAssessmentSectionDocumentSchema parses a minimal standalone section [3.71ms]
+✓ QtiAssessmentStimulusDocumentSchema parses a minimal stimulus [2.73ms]
+✓ QtiOutcomeDeclarationDocumentSchema parses a minimal outcome declaration [1.55ms]
+✓ QtiAsiProfileDocumentSchema accepts resource-specific QTI documents [1.40ms]
+✓ QtiAssessmentItemDocumentSchema parses a minimal choice item [20.41ms]
+✓ QtiAssessmentItemDocumentSchema rejects incompatible response declarations [0.71ms]
+✓ QtiAssessmentTestDocumentSchema parses a minimal test document [2.00ms]
+✓ Qti301DerivedZodTemplates exposes expected document templates [0.03ms]
+✓ QTI barrel exports prefixed XML extension node helpers [0.41ms]
+
+test/contracts.test.ts:
+✓ RunnerConfigSchema parses minimal config [3.44ms]
+✓ RunnerConfigSchema requires adapter for cmi5 suite [0.15ms]
+✓ RunnerConfigSchema enforces bearer adapter token source [0.79ms]
+✓ AdapterCapabilitySchema validates profile payload [0.65ms]
+✓ AdapterProfileSchema validates cmi5 interoperability contract [1.38ms]
+✓ AdapterProfileSchema requires cmi5 packageUpload [0.10ms]
+✓ AdapterErrorSchema validates uniform error envelope [0.51ms]
+
+test/qti-v2_2.test.ts:
+✓ QtiV2_2 metadata document parses a minimal metadata payload with scoring modes [0.81ms]
+✓ QtiV2_2 assessment stimulus and assessment item documents parse together [3.49ms]
+✓ QtiV2_2 processing rejects invalid numeric operator parameters [6.84ms]
+✓ QtiV2_2 curriculum standards metadata and manifest documents parse [1.70ms]
+✓ QtiV2_2 APIP accessibility document parses external supplemental accessibility [1.77ms]
+
+test/cat-v1_0.test.ts:
+✓ CAT v1.0 Zod Schemas > Shared validators > UuidSchema validates RFC4122 compliant UUIDs [1.78ms]
+✓ CAT v1.0 Zod Schemas > Shared validators > DateTimeSchema validates ISO8601 datetimes [0.35ms]
+✓ CAT v1.0 Zod Schemas > Shared validators > ExtensionEnum supports standard values and ext:* vendor extensions [0.23ms]
+✓ CAT v1.0 Zod Schemas > Shared validators > OutcomeVariableType supports outcome types and vendor extensions [0.06ms]
+✓ CAT v1.0 Zod Schemas > Core data types > OutcomeVariable validates outcome variable structure [0.50ms]
+✓ CAT v1.0 Zod Schemas > Core data types > OutcomeVariable rejects additional properties [0.12ms]
+✓ CAT v1.0 Zod Schemas > Core data types > ResponseVariable validates candidate responses [0.16ms]
+✓ CAT v1.0 Zod Schemas > Core data types > ItemRef validates item references [0.24ms]
+✓ CAT v1.0 Zod Schemas > Core data types > ItemPool validates item pool with multiple items [0.26ms]
+✓ CAT v1.0 Zod Schemas > Core data types > SectionData validates complete section configuration [0.59ms]
+✓ CAT v1.0 Zod Schemas > Core data types > ItemStage validates items to present to candidate [0.49ms]
+✓ CAT v1.0 Zod Schemas > Core data types > AssessmentResult validates candidate responses and outcomes [0.66ms]
+✓ CAT v1.0 Zod Schemas > Core data types > CatEngineResultReport validates CAT engine response [0.56ms]
+✓ CAT v1.0 Zod Schemas > Core data types > SessionInfo validates session state [0.49ms]
+✓ CAT v1.0 Zod Schemas > REST operation payloads > CreateSectionRequest validates section creation [0.18ms]
+✓ CAT v1.0 Zod Schemas > REST operation payloads > CreateSectionResponse validates section creation response [0.23ms]
+✓ CAT v1.0 Zod Schemas > REST operation payloads > CreateSessionRequest validates session creation [0.24ms]
+✓ CAT v1.0 Zod Schemas > REST operation payloads > CreateSessionResponse validates session creation response [0.20ms]
+✓ CAT v1.0 Zod Schemas > REST operation payloads > SubmitResultsRequest validates result submission [0.26ms]
+✓ CAT v1.0 Zod Schemas > REST operation payloads > SubmitResultsResponse validates CAT engine result report [0.05ms]
+✓ CAT v1.0 Zod Schemas > REST operation payloads > EndSessionRequest validates session termination [0.19ms]
+✓ CAT v1.0 Zod Schemas > REST operation payloads > EndSessionResponse validates session termination response [0.22ms]
+✓ CAT v1.0 Zod Schemas > REST operation payloads > EndSectionRequest validates section closure [0.14ms]
+✓ CAT v1.0 Zod Schemas > REST operation payloads > EndSectionResponse validates section closure response [0.09ms]
+✓ CAT v1.0 Zod Schemas > REST operation bindings > REST operation catalog exposes all 6 CAT operations [0.04ms]
+✓ CAT v1.0 Zod Schemas > REST operation bindings > CreateSection operation has correct structure [0.03ms]
+✓ CAT v1.0 Zod Schemas > REST operation bindings > SubmitResults operation has correct path template [0.03ms]
+✓ CAT v1.0 Zod Schemas > Derived templates > Cat10DerivedZodTemplates exposes specification metadata [0.27ms]
+✓ CAT v1.0 Zod Schemas > Derived templates > Specification links point to official CAT v1.0 resources [0.06ms]
+✓ CAT v1.0 Zod Schemas > Error handling > ErrorResponse validates error payloads [0.36ms]
+
+test/schema-examples.test.ts:
+✓ example configs parse with RunnerConfigSchema [0.51ms]
+✓ summary sample shape validates [2.03ms]
+✓ requirement trace sample shape validates [0.80ms]
+✓ run metadata sample shape validates [1.75ms]
+✓ adapter profile sample shape validates [0.19ms]
+
+test/clr-v2_0.test.ts:
+✓ ClrCredentialSchema parses a realistic CLR 2.0 credential [6.57ms]
+✓ AchievementCredentialSchema parses a minimal achievement credential [1.95ms]
+✓ ProfileSchema parses a minimal issuer profile [0.09ms]
+✓ GetClrCredentialsResponseSchema parses credential and JWS collections [0.43ms]
+✓ ImsxStatusInfoSchema enforces known status vocabularies [0.44ms]
+✓ ClrCredentialSchema rejects credentials without the CLR context set [0.38ms]
+✓ Clr20DerivedZodTemplates exposes the published entry points [0.05ms]
+
+test/cc-v1_4.test.ts:
+✓ CommonCartridgeV1_4 parses a minimal core manifest [3.74ms]
+✓ CommonCartridgeV1_4 rejects question-bank references from organization items [0.95ms]
+✓ CommonCartridgeV1_4 parses a minimal thin manifest with embedded webLink XML [2.29ms]
+✓ CommonCartridgeV1_4 thin profile rejects mismatched embedded resource XML [1.30ms]
+✓ CommonCartridgeV1_4 K-12 LOM resource profile enforces required educational metadata [2.15ms]
+✓ CommonCartridgeV1_4 parses assignment, line item, accessibility, and open video documents [3.62ms]
+✓ CommonCartridgeV1_4 exposes expected derived templates [0.05ms]
+
+test/open-badges-v3_0.test.ts:
+✓ AchievementCredentialSchema parses a realistic Open Badge credential [0.48ms]
+✓ EndorsementCredentialSchema parses a valid endorsement credential [1.50ms]
+✓ GetOpenBadgeCredentialsResponseSchema parses credential and JWS collections [0.34ms]
+✓ AchievementCredentialSchema rejects missing OB context [0.41ms]
+✓ OpenBadges30DerivedZodTemplates exposes expected entry points [0.05ms]
+
+test/vc-data-model-v2_0.test.ts:
+✓ VerifiableCredentialSchema parses a minimal VC Data Model 2.0 credential [1.11ms]
+✓ VerifiablePresentationSchema parses a presentation carrying VC and JWS credentials [0.53ms]
+✓ VerifiableCredentialSchema rejects wrong core context [0.17ms]
+✓ VcDataModel20DerivedZodTemplates exposes expected entry points [0.04ms]
+
+test/lti.test.ts:
+✓ LTI core launch schema accepts a normalized resource link launch [2.00ms]
+✓ LTI deep linking schema accepts request settings and response items [2.03ms]
+✓ LTI AGS schema accepts endpoint, line item, score, and result shapes [1.68ms]
+✓ LTI NRPS schema accepts names/roles service and membership container shapes [1.39ms]
+✓ LTI proctoring schema accepts start and end assessment messages [1.57ms]
+
+test/case-v1_1.test.ts:
+✓ CASE v1.1 Schemas > Core entity schemas > should validate a valid CFAssociation [1.11ms]
+✓ CASE v1.1 Schemas > Core entity schemas > should reject CFAssociation with invalid UUID [0.20ms]
+✓ CASE v1.1 Schemas > REST binding operations > should expose getCFAssociation operation [0.04ms]
+✓ CASE v1.1 Schemas > REST binding operations > should expose listCFAssociations operation [0.02ms]
+✓ CASE v1.1 Schemas > REST binding operations > should expose getCFPackage operation [0.05ms]
+✓ CASE v1.1 Schemas > REST binding operations > should expose listCFItems operation [0.02ms]
+✓ CASE v1.1 Schemas > REST binding operations > should expose getCFRubric operation [0.02ms]
+✓ CASE v1.1 Schemas > Shared validators > should validate RFC4122 UUID [0.03ms]
+✓ CASE v1.1 Schemas > Shared validators > should reject invalid UUID format [0.06ms]
+✓ CASE v1.1 Schemas > Shared validators > should validate ISO8601 datetime [0.04ms]
+✓ CASE v1.1 Schemas > Shared validators > should validate link URI [0.29ms]
+✓ CASE v1.1 Schemas > Extensible vocabularies > should allow standard association types [0.14ms]
+✓ CASE v1.1 Schemas > Extensible vocabularies > should allow ext:* custom extensions [0.08ms]
+✓ CASE v1.1 Schemas > Extensible vocabularies > should reject invalid ext: format [0.10ms]
+✓ CASE v1.1 Schemas > Derived templates > should expose spec links [0.04ms]
+✓ CASE v1.1 Schemas > Derived templates > should document scope coverage [0.03ms]
+
+test/caliper-v1_2.test.ts:
+✓ ActionSchema validates Caliper action vocabulary [0.20ms]
+✓ PersonSchema requires top-level @context for described entity documents [0.78ms]
+✓ EventSchema enforces URN UUID ids and UTC-millisecond eventTime [1.14ms]
+✓ AnnotationEventSchema enforces textual actor/action/object constraints [0.96ms]
+✓ MessageEventSchema accepts MarkedAsUnRead textual alias [0.37ms]
+✓ ViewEventSchema restricts target entity type to Frame [0.47ms]
+✓ EnvelopeSchema enforces required fields and disallows custom top-level properties [5.80ms]
+✓ TextPositionSelectorSchema requires type/start/end [0.50ms]
+✓ SystemIdentifierSchema validates required identifier fields [0.47ms]
+✓ Caliper12DerivedZodTemplates exposes key Caliper entry points and conformance metadata [0.08ms]
+
+ 156 pass
+ 0 fail
+ 279 expect() calls
+Ran 156 tests across 16 files. [456.00ms]

package/.turbo/turbo-typecheck.log

@@ -0,0 +1,2 @@
+
+$ tsgo --noEmit

package/README.md

@@ -0,0 +1,52 @@
+# @conform-ed/contracts
+
+Shared runtime contracts and zod schemas for runner config and output.
+
+Implementation notes for the XSD-to-Zod ports live alongside this package:
+
+- `packages/contracts/caliper-v1_2-zod-templates.md`
+- `packages/contracts/cmi5-v1_0-zod-templates.md`
+- `packages/contracts/xapi-zod-templates.md`
+- `packages/contracts/case-v1_1-zod-templates.md`
+- `packages/contracts/cat-v1_0-zod-templates.md`
+- `packages/contracts/cc-v1_3-zod-templates.md`
+- `packages/contracts/cc-v1_4-zod-templates.md`
+- `packages/contracts/clr-v2_0-zod-templates.md`
+- `packages/contracts/lti-zod-templates.md`
+- `packages/contracts/open-badges-v3_0-zod-templates.md`
+- `packages/contracts/oneroster-v1_2-zod-templates.md`
+- `packages/contracts/qti-v2_1-zod-templates.md`
+- `packages/contracts/qti-v2_2-zod-templates.md`
+- `packages/contracts/qti-v3_0_1-zod-templates.md`
+- `packages/contracts/vc-data-model-v2_0-zod-templates.md`
+
+Versioned schema bundles are exported from the package root as namespaces:
+
+- `CaliperV1_2`
+- `Cmi5`
+- `Cmi5V1_0`
+- `Xapi`
+- `XapiV1_0_3`
+- `XapiV2_0`
+- `CaseV1_1`
+- `CatV1_0`
+- `CommonCartridgeV1_3`
+- `CommonCartridgeV1_4`
+- `ClrV2_0`
+- `Lti`
+- `LtiV1_3`
+- `LtiDeepLinkingV2_0`
+- `LtiAgsV2_0`
+- `LtiNrpsV2_0`
+- `LtiProctoringV1_0`
+- `OpenBadgesV3_0`
+- `OneRosterV1_2`
+- `QtiV2_1`
+- `QtiV2_2`
+- `QtiV3_0_1`
+- `VcDataModelV2_0`
+
+XML intake, example inventory, and file/folder validation helpers now live alongside this package in:
+
+- `packages/qti-xml`
+- `packages/cli`

package/caliper-v1_2-zod-templates.md

@@ -0,0 +1,123 @@
+# Caliper Analytics v1.2 JSON schema bundle -> Zod template notes
+
+## Published specification
+
+- Main specification: `https://www.imsglobal.org/spec/caliper/v1p2/impl/`
+- Canonical source repository: `https://github.com/1EdTech/caliper-spec`
+- Practical JSON schema corpus used for this implementation: `https://github.com/1EdTech/CaliperBootcamp/tree/main/schemas/v1_2`
+
+This note accompanies `packages/contracts/src/caliper/v1_2/`.
+
+---
+
+## 1. Source precedence used for this implementation
+
+To align with textual spec intent while remaining interoperable with published artifacts, this implementation follows an explicit precedence order:
+
+1. `https://www.imsglobal.org/spec/caliper/v1p2` (normative textual specification)
+2. `https://www.imsglobal.org/spec/caliper/v1p2/impl/` (implementation guide clarifications)
+3. `tmp/CaliperBootcamp/schemas/v1_2/*` (machine-readable compatibility corpus)
+
+This precedence is exported in code via `CALIPER_REQUIREMENT_SOURCE_PRECEDENCE` and related metadata.
+
+---
+
+## 2. What was implemented
+
+This port adds a versioned Caliper v1.2 bundle with:
+
+- Caliper envelope schema
+- full published Action/Profile/Metric/Status vocabularies
+- base event contracts and all Bootcamp v1.2 event entry points
+- base entity contracts and all Bootcamp v1.2 entity entry points
+- SystemIdentifier, CaliperData, Selector/TextPositionSelector helper schemas
+- an explicit published-entry-point map (`CaliperV1P2JsonSchemaEntryPoints`)
+
+Public package surface:
+
+- root namespace: `CaliperV1_2`
+- subpath export: `@conform-ed/contracts/caliper/v1_2`
+
+---
+
+## 3. Structural choices
+
+The implementation is split into:
+
+- `shared.ts` for shared context, datetime, IRI/UUID, reference, and entity/event schema builders
+- `caliper_v1p2_bootcamp_schema.ts` for vocabulary and published entry-point schemas
+- `textual_requirements.ts` for extracted event-level textual constraints and source metadata
+- `index.ts` for barrel exports and `Caliper12DerivedZodTemplates`
+
+This keeps Caliper-specific concerns isolated and aligned with existing versioned standards packages.
+
+---
+
+## 4. Validation choices
+
+Implemented strict alignment upgrades:
+
+- **Event id** requires UUID URN form (`urn:uuid:...`) via `CaliperEventIdSchema`
+- **Datetime** requires ISO8601 UTC with millisecond precision (`YYYY-MM-DDTHH:mm:ss.SSSZ`)
+- **Envelope** enforces required `sensor`, `sendTime`, `dataVersion`, and non-empty `data`
+- **Envelope** is strict at top-level (no unknown custom envelope properties)
+- **Event subtype constraints** are enforced for textual-spec-covered events:
+  - supported actor type(s)
+  - supported action terms (including documented deprecated terms where applicable)
+  - supported object type(s)
+  - supported generated/target entity type(s) where defined
+- **Entity entry points** require `id`, `type`, and top-level `@context`
+- **No-id entity alignment**: `TextPositionSelector` requires `type`, `start`, `end`; `SystemIdentifier` requires `type`, `identifier`, `identifierType`
+
+`CaliperV1P2ConformanceMetadata` exposes the extracted textual rule set and identifies Bootcamp-only event types.
+
+---
+
+## 5. Coverage and known deviations
+
+### Textual-spec covered event constraints
+
+Event-level textual constraints are explicitly enforced for:
+
+- `AnnotationEvent`
+- `AssessmentEvent`
+- `AssessmentItemEvent`
+- `AssignableEvent`
+- `ForumEvent`
+- `GradeEvent`
+- `MediaEvent`
+- `MessageEvent`
+- `NavigationEvent`
+- `SessionEvent`
+- `ThreadEvent`
+- `ToolUseEvent`
+- `ViewEvent`
+
+### Bootcamp-only compatibility events
+
+The following event types exist in Bootcamp v1.2 artifacts but are not fully constrained by the extracted textual rule set used in this implementation:
+
+- `Event`
+- `FeedbackEvent`
+- `OutcomeEvent`
+- `QuestionnaireEvent`
+- `QuestionnaireItemEvent`
+- `ReadingEvent`
+- `ResourceManagementEvent`
+- `SearchEvent`
+- `SurveyEvent`
+- `SurveyInvitationEvent`
+- `ToolLaunchEvent`
+
+These remain structurally validated but without the same actor/action/object subset enforcement as the textual-spec-covered list above.
+
+### Additional explicit deviation notes
+
+- Caliper context handling in public artifacts can vary between `v1p1` and `v1p2` context URIs; this implementation accepts both.
+- Full per-entity property-table enforcement across all Appendix entity definitions is not yet exhaustive; current implementation focuses on base required semantics (`id`, `type`, context) plus key no-id entities and event/profile-level constraints.
+
+---
+
+## 6. Scope note
+
+The 1EdTech Caliper implementation page does not currently publish an official machine-readable schema bundle comparable to some other standards in this repository. This implementation therefore uses the Bootcamp v1.2 schema corpus as the concrete source for operational Zod contracts, while keeping all spec links and versioning explicit.