@conform-ed/contracts 0.0.3

package/src/lti/proctoring/v1_0/index.ts

@@ -0,0 +1,131 @@
+export * from "../../shared";
+
+import { z } from "zod";
+
+import {
+  ContextSchema,
+  CustomParametersSchema,
+  LaunchPresentationSchema,
+  LisSchema,
+  NonEmptyStringSchema,
+  ResourceLinkSchema,
+  RolesSchema,
+  UrlSchema,
+  LtiVersionSchema,
+  strictObject,
+} from "../../shared";
+
+export const AssessmentControlSeveritySchema = z.enum(["low", "medium", "high"]);
+
+export const AssessmentProctoringSettingsSchema = strictObject({
+  proctoringUrl: UrlSchema.optional(),
+  startAssessmentUrl: UrlSchema.optional(),
+  endAssessmentReturnUrl: UrlSchema.optional(),
+  assessmentControlUrl: UrlSchema.optional(),
+  sessionData: NonEmptyStringSchema.optional(),
+  extraTime: z.number().int().nonnegative().optional(),
+});
+
+export const StartProctoringMessageSchema = strictObject({
+  messageType: z.literal("StartProctoringMessage"),
+  version: LtiVersionSchema,
+  deploymentId: NonEmptyStringSchema,
+  targetLinkUri: UrlSchema,
+  resourceLink: ResourceLinkSchema,
+  subject: NonEmptyStringSchema,
+  attemptNumber: z.number().int().positive(),
+  startAssessmentUrl: UrlSchema,
+  sessionData: NonEmptyStringSchema,
+  roles: RolesSchema,
+  context: ContextSchema.optional(),
+  launchPresentation: LaunchPresentationSchema.optional(),
+  lis: LisSchema.optional(),
+  custom: CustomParametersSchema.optional(),
+  assessmentProctoringSettings: AssessmentProctoringSettingsSchema.optional(),
+});
+
+export const StartAssessmentMessageSchema = strictObject({
+  messageType: z.literal("StartAssessmentMessage"),
+  version: LtiVersionSchema,
+  deploymentId: NonEmptyStringSchema,
+  resourceLink: ResourceLinkSchema,
+  subject: NonEmptyStringSchema,
+  attemptNumber: z.number().int().positive(),
+  sessionData: NonEmptyStringSchema,
+  endAssessmentReturnUrl: UrlSchema,
+  verifiedUser: z.union([z.boolean(), NonEmptyStringSchema]).optional(),
+  context: ContextSchema.optional(),
+  launchPresentation: LaunchPresentationSchema.optional(),
+  lis: LisSchema.optional(),
+  custom: CustomParametersSchema.optional(),
+  assessmentProctoringSettings: AssessmentProctoringSettingsSchema.optional(),
+});
+
+export const EndAssessmentMessageSchema = strictObject({
+  messageType: z.literal("EndAssessmentMessage"),
+  version: LtiVersionSchema,
+  deploymentId: NonEmptyStringSchema,
+  targetLinkUri: UrlSchema,
+  subject: NonEmptyStringSchema,
+  attemptNumber: z.number().int().positive(),
+  roles: RolesSchema,
+  context: ContextSchema.optional(),
+  launchPresentation: LaunchPresentationSchema.optional(),
+  lis: LisSchema.optional(),
+  custom: CustomParametersSchema.optional(),
+  assessmentProctoringSettings: AssessmentProctoringSettingsSchema.optional(),
+  errorMessage: z.string().optional(),
+  errorLog: z.string().optional(),
+});
+
+export const AssessmentControlRequestSchema = strictObject({
+  user: NonEmptyStringSchema,
+  resourceLink: NonEmptyStringSchema,
+  attemptNumber: z.number().int().positive(),
+  action: NonEmptyStringSchema,
+  incidentTime: z.iso.datetime(),
+  extraTime: z.number().int().nonnegative().optional(),
+  incidentSeverity: AssessmentControlSeveritySchema.optional(),
+  reasonCode: NonEmptyStringSchema.optional(),
+  reasonMsg: z.string().optional(),
+});
+
+export const AssessmentControlResponseSchema = strictObject({
+  status: NonEmptyStringSchema,
+  extraTime: z.number().int().nonnegative().optional(),
+});
+
+export namespace LtiProctoringV1_0 {
+  export namespace Schemas {
+    export const AssessmentProctoringSettings = AssessmentProctoringSettingsSchema;
+    export const StartProctoringMessage = StartProctoringMessageSchema;
+    export const StartAssessmentMessage = StartAssessmentMessageSchema;
+    export const EndAssessmentMessage = EndAssessmentMessageSchema;
+    export const AssessmentControlRequest = AssessmentControlRequestSchema;
+    export const AssessmentControlResponse = AssessmentControlResponseSchema;
+    export const AssessmentControlSeverity = AssessmentControlSeveritySchema;
+  }
+}
+
+export type LtiProctoringV1_0Schemas = typeof LtiProctoringV1_0.Schemas;
+
+export const LtiProctoringV1_0DerivedZodTemplates = {
+  description: "LTI Proctoring v1.0 Zod schemas for normalized start/end assessment message payloads",
+  specLinks: {
+    main: "https://www.imsglobal.org/spec/proctoring/v1p0/",
+  },
+  scope: "Proctoring launch messages and assessment-control service payloads",
+  claims: ["assessment_proctoring_settings", "attempt_number"],
+  notes: [
+    "The specification is still in candidate-final/public form, so the schema favors normalized compatibility over an exact JSON Schema mirror.",
+    "Control-service parameters are modeled separately from launch message payloads to keep request/response contracts explicit.",
+  ],
+} as const;
+// Inferred types from exported Zod validators.
+export type AssessmentControlSeverity = z.infer<typeof AssessmentControlSeveritySchema>;
+export type AssessmentProctoringSettings = z.infer<typeof AssessmentProctoringSettingsSchema>;
+export type StartProctoringMessage = z.infer<typeof StartProctoringMessageSchema>;
+export type StartAssessmentMessage = z.infer<typeof StartAssessmentMessageSchema>;
+export type EndAssessmentMessage = z.infer<typeof EndAssessmentMessageSchema>;
+export type AssessmentControlRequest = z.infer<typeof AssessmentControlRequestSchema>;
+export type AssessmentControlResponse = z.infer<typeof AssessmentControlResponseSchema>;

package/src/lti/shared.ts

@@ -0,0 +1,66 @@
+import { z } from "zod";
+
+export function strictObject<T extends z.ZodRawShape>(shape: T) {
+  return z.object(shape).strict();
+}
+
+const UriSchema = z.string().regex(/^[a-zA-Z][a-zA-Z0-9+.-]*:.+$/u);
+
+export const NonEmptyStringSchema = z.string().min(1);
+export const UrlSchema = z.url();
+export const UriReferenceSchema = UriSchema;
+export const LtiVersionSchema = z.literal("1.3.0");
+export const DocumentTargetSchema = z.enum(["embed", "frame", "iframe", "popup", "tab", "window"]);
+export const RoleUriSchema = UriSchema;
+
+export const ResourceLinkSchema = strictObject({
+  id: NonEmptyStringSchema,
+  title: NonEmptyStringSchema.optional(),
+  description: z.string().optional(),
+});
+
+export const ContextSchema = strictObject({
+  id: NonEmptyStringSchema,
+  label: NonEmptyStringSchema.optional(),
+  title: NonEmptyStringSchema.optional(),
+  type: z.array(NonEmptyStringSchema).min(1).optional(),
+});
+
+export const LaunchPresentationSchema = strictObject({
+  documentTarget: DocumentTargetSchema.optional(),
+  locale: NonEmptyStringSchema.optional(),
+  height: z.number().int().positive().optional(),
+  width: z.number().int().positive().optional(),
+  returnUrl: UrlSchema.optional(),
+});
+
+export const LisSchema = strictObject({
+  personSourcedId: NonEmptyStringSchema.optional(),
+  courseOfferingSourcedId: NonEmptyStringSchema.optional(),
+  courseSectionSourcedId: NonEmptyStringSchema.optional(),
+  membershipSourcedId: NonEmptyStringSchema.optional(),
+});
+
+export const RolesSchema = z.array(RoleUriSchema).min(1);
+export const CustomParametersSchema = z.record(z.string().min(1), z.union([z.string(), z.number(), z.boolean()]));
+
+export const ImageResourceSchema = strictObject({
+  url: UrlSchema,
+  width: z.number().int().positive().optional(),
+  height: z.number().int().positive().optional(),
+  alt: z.string().optional(),
+});
+// Inferred types from exported Zod validators.
+export type NonEmptyString = z.infer<typeof NonEmptyStringSchema>;
+export type Url = z.infer<typeof UrlSchema>;
+export type UriReference = z.infer<typeof UriReferenceSchema>;
+export type LtiVersion = z.infer<typeof LtiVersionSchema>;
+export type DocumentTarget = z.infer<typeof DocumentTargetSchema>;
+export type RoleUri = z.infer<typeof RoleUriSchema>;
+export type ResourceLink = z.infer<typeof ResourceLinkSchema>;
+export type Context = z.infer<typeof ContextSchema>;
+export type LaunchPresentation = z.infer<typeof LaunchPresentationSchema>;
+export type Lis = z.infer<typeof LisSchema>;
+export type Roles = z.infer<typeof RolesSchema>;
+export type CustomParameters = z.infer<typeof CustomParametersSchema>;
+export type ImageResource = z.infer<typeof ImageResourceSchema>;

package/src/lti/v1_3/index.ts

@@ -0,0 +1,84 @@
+export * from "../shared";
+
+import { z } from "zod";
+
+import {
+  ContextSchema,
+  CustomParametersSchema,
+  LaunchPresentationSchema,
+  LisSchema,
+  NonEmptyStringSchema,
+  ResourceLinkSchema,
+  RolesSchema,
+  UrlSchema,
+  LtiVersionSchema,
+  strictObject,
+} from "../shared";
+
+export const CoreLaunchRequestSchema = strictObject({
+  messageType: z.literal("LtiResourceLinkRequest"),
+  version: LtiVersionSchema,
+  deploymentId: NonEmptyStringSchema,
+  targetLinkUri: UrlSchema,
+  resourceLink: ResourceLinkSchema,
+  subject: NonEmptyStringSchema,
+  context: ContextSchema.optional(),
+  roles: RolesSchema,
+  lis: LisSchema.optional(),
+  launchPresentation: LaunchPresentationSchema.optional(),
+  custom: CustomParametersSchema.optional(),
+  name: NonEmptyStringSchema.optional(),
+  givenName: NonEmptyStringSchema.optional(),
+  familyName: NonEmptyStringSchema.optional(),
+  email: z.string().email().optional(),
+  locale: NonEmptyStringSchema.optional(),
+});
+
+export const CoreLaunchClaimsSchema = CoreLaunchRequestSchema;
+
+export namespace LtiV1_3 {
+  export namespace Schemas {
+    export const ResourceLink = ResourceLinkSchema;
+    export const Context = ContextSchema;
+    export const LaunchPresentation = LaunchPresentationSchema;
+    export const Lis = LisSchema;
+    export const CoreLaunchRequest = CoreLaunchRequestSchema;
+    export const CoreLaunchClaims = CoreLaunchClaimsSchema;
+  }
+
+  export namespace Shared {
+    export const Version = LtiVersionSchema;
+    export const Url = UrlSchema;
+    export const NonEmptyString = NonEmptyStringSchema;
+    export const Roles = RolesSchema;
+  }
+}
+
+export type LtiV1_3Schemas = typeof LtiV1_3.Schemas;
+
+export const Lti13DerivedZodTemplates = {
+  description: "LTI 1.3 Core Zod schemas for normalized launch claims and launch-shaped objects",
+  specLinks: {
+    main: "https://www.imsglobal.org/spec/lti/v1p3/",
+    claims: "https://www.imsglobal.org/spec/lti/v1p3/#message-claims",
+  },
+  scope: "LTI 1.3 resource-link launch claims",
+  claims: [
+    "messageType",
+    "version",
+    "deploymentId",
+    "targetLinkUri",
+    "resourceLink",
+    "context",
+    "roles",
+    "lis",
+    "launchPresentation",
+  ],
+  notes: [
+    "Normalized camelCase field names are used instead of raw JWT claim URIs.",
+    "Identity fields remain optional beyond the subject claim to keep the schema useful for adapter stubs and launch fixtures.",
+  ],
+} as const;
+// Inferred types from exported Zod validators.
+export type CoreLaunchRequest = z.infer<typeof CoreLaunchRequestSchema>;
+export type CoreLaunchClaims = z.infer<typeof CoreLaunchClaimsSchema>;

package/src/oneroster/v1_2/index.ts

@@ -0,0 +1,156 @@
+export * from "./shared";
+export * from "./or_v1p2_rostering_service_schema";
+export * from "./or_v1p2_gradebook_service_schema";
+export * from "./or_v1p2_resource_service_schema";
+export * from "./or_v1p2_rostering_restbinding_schema";
+export * from "./or_v1p2_gradebook_restbinding_schema";
+export * from "./or_v1p2_resource_restbinding_schema";
+export * from "./or_v1p2_csv_binding_schema";
+
+import {
+  AcademicSessionSchema,
+  AcademicSessionSetSchema,
+  ClassSchema,
+  ClassSetSchema,
+  CourseSchema,
+  CourseSetSchema,
+  DemographicsSchema,
+  DemographicsSetSchema,
+  EnrollmentSchema,
+  EnrollmentSetSchema,
+  OrgSchema,
+  OrgSetSchema,
+  SingleAcademicSessionSchema,
+  SingleClassSchema,
+  SingleCourseSchema,
+  SingleDemographicsSchema,
+  SingleEnrollmentSchema,
+  SingleOrgSchema,
+  SingleUserSchema,
+  UserSchema,
+  UserSetSchema,
+} from "./or_v1p2_rostering_service_schema";
+import {
+  AssessmentLineItemSchema,
+  AssessmentLineItemSetSchema,
+  AssessmentResultSchema,
+  AssessmentResultSetSchema,
+  CategorySchema,
+  CategorySetSchema,
+  GuidPairSetSchema,
+  LineItemSchema,
+  LineItemSetSchema,
+  ResultSchema,
+  ResultSetSchema,
+  ScoreScaleSchema,
+  ScoreScaleSetSchema,
+  SingleAssessmentLineItemSchema,
+  SingleAssessmentResultSchema,
+  SingleCategorySchema,
+  SingleLineItemSchema,
+  SingleResultSchema,
+  SingleScoreScaleSchema,
+} from "./or_v1p2_gradebook_service_schema";
+import { ResourceSchema, ResourceSetSchema, SingleResourceSchema } from "./or_v1p2_resource_service_schema";
+import {
+  AcademicSessionsCsvDocumentSchema,
+  CategoriesCsvDocumentSchema,
+  ClassResourcesCsvDocumentSchema,
+  ClassesCsvDocumentSchema,
+  CourseResourcesCsvDocumentSchema,
+  CoursesCsvDocumentSchema,
+  DemographicsCsvDocumentSchema,
+  EnrollmentsCsvDocumentSchema,
+  LineItemLearningObjectiveIdsCsvDocumentSchema,
+  LineItemsCsvDocumentSchema,
+  LineItemScoreScalesCsvDocumentSchema,
+  ManifestCsvDocumentSchema,
+  OneRosterCsvBindingPackageSchema,
+  OrgsCsvDocumentSchema,
+  ResourcesCsvDocumentSchema,
+  ResultLearningObjectiveIdsCsvDocumentSchema,
+  ResultsCsvDocumentSchema,
+  ResultScoreScalesCsvDocumentSchema,
+  RolesCsvDocumentSchema,
+  ScoreScalesCsvDocumentSchema,
+  UserProfilesCsvDocumentSchema,
+  UserResourcesCsvDocumentSchema,
+  UsersCsvDocumentSchema,
+} from "./or_v1p2_csv_binding_schema";
+import { GradebookRestBindingOperationSchemas } from "./or_v1p2_gradebook_restbinding_schema";
+import { ResourceRestBindingOperationSchemas } from "./or_v1p2_resource_restbinding_schema";
+import { RosteringRestBindingOperationSchemas } from "./or_v1p2_rostering_restbinding_schema";
+import { ImsxStatusInfoSchema } from "./shared";
+
+export const OneRoster12DerivedZodTemplates = {
+  academicSession: AcademicSessionSchema,
+  academicSessionSet: AcademicSessionSetSchema,
+  class: ClassSchema,
+  classSet: ClassSetSchema,
+  course: CourseSchema,
+  courseSet: CourseSetSchema,
+  demographics: DemographicsSchema,
+  demographicsSet: DemographicsSetSchema,
+  enrollment: EnrollmentSchema,
+  enrollmentSet: EnrollmentSetSchema,
+  org: OrgSchema,
+  orgSet: OrgSetSchema,
+  user: UserSchema,
+  userSet: UserSetSchema,
+  singleAcademicSession: SingleAcademicSessionSchema,
+  singleClass: SingleClassSchema,
+  singleCourse: SingleCourseSchema,
+  singleDemographics: SingleDemographicsSchema,
+  singleEnrollment: SingleEnrollmentSchema,
+  singleOrg: SingleOrgSchema,
+  singleUser: SingleUserSchema,
+  lineItem: LineItemSchema,
+  lineItemSet: LineItemSetSchema,
+  result: ResultSchema,
+  resultSet: ResultSetSchema,
+  category: CategorySchema,
+  categorySet: CategorySetSchema,
+  scoreScale: ScoreScaleSchema,
+  scoreScaleSet: ScoreScaleSetSchema,
+  assessmentLineItem: AssessmentLineItemSchema,
+  assessmentLineItemSet: AssessmentLineItemSetSchema,
+  assessmentResult: AssessmentResultSchema,
+  assessmentResultSet: AssessmentResultSetSchema,
+  guidPairSet: GuidPairSetSchema,
+  singleLineItem: SingleLineItemSchema,
+  singleResult: SingleResultSchema,
+  singleCategory: SingleCategorySchema,
+  singleScoreScale: SingleScoreScaleSchema,
+  singleAssessmentLineItem: SingleAssessmentLineItemSchema,
+  singleAssessmentResult: SingleAssessmentResultSchema,
+  resource: ResourceSchema,
+  resourceSet: ResourceSetSchema,
+  singleResource: SingleResourceSchema,
+  rosteringRestBindingOperations: RosteringRestBindingOperationSchemas,
+  gradebookRestBindingOperations: GradebookRestBindingOperationSchemas,
+  resourceRestBindingOperations: ResourceRestBindingOperationSchemas,
+  manifestCsvDocument: ManifestCsvDocumentSchema,
+  academicSessionsCsvDocument: AcademicSessionsCsvDocumentSchema,
+  categoriesCsvDocument: CategoriesCsvDocumentSchema,
+  classesCsvDocument: ClassesCsvDocumentSchema,
+  classResourcesCsvDocument: ClassResourcesCsvDocumentSchema,
+  courseResourcesCsvDocument: CourseResourcesCsvDocumentSchema,
+  coursesCsvDocument: CoursesCsvDocumentSchema,
+  demographicsCsvDocument: DemographicsCsvDocumentSchema,
+  enrollmentsCsvDocument: EnrollmentsCsvDocumentSchema,
+  lineItemLearningObjectiveIdsCsvDocument: LineItemLearningObjectiveIdsCsvDocumentSchema,
+  lineItemsCsvDocument: LineItemsCsvDocumentSchema,
+  lineItemScoreScalesCsvDocument: LineItemScoreScalesCsvDocumentSchema,
+  orgsCsvDocument: OrgsCsvDocumentSchema,
+  resourcesCsvDocument: ResourcesCsvDocumentSchema,
+  resultLearningObjectiveIdsCsvDocument: ResultLearningObjectiveIdsCsvDocumentSchema,
+  resultsCsvDocument: ResultsCsvDocumentSchema,
+  resultScoreScalesCsvDocument: ResultScoreScalesCsvDocumentSchema,
+  rolesCsvDocument: RolesCsvDocumentSchema,
+  scoreScalesCsvDocument: ScoreScalesCsvDocumentSchema,
+  userProfilesCsvDocument: UserProfilesCsvDocumentSchema,
+  userResourcesCsvDocument: UserResourcesCsvDocumentSchema,
+  usersCsvDocument: UsersCsvDocumentSchema,
+  csvBindingPackage: OneRosterCsvBindingPackageSchema,
+  imsxStatusInfo: ImsxStatusInfoSchema,
+} as const;