@timeback/oneroster 0.2.1-beta.20260320221119 → 0.2.1-beta.20260330020222

package/dist/index.d.ts

@@ -165,15 +165,13 @@ interface LearningObjectiveResult {
 }
 
 /**
- * A set of learning objectives with optional results.
+ * A set of learning objective IDs.
  */
 interface LearningObjectiveSetItem {
 	/** Source system for these learning objectives */
 	source: string
-	/** Learning objective IDs (for line items) */
-	learningObjectiveIds?: string[]
-	/** Learning objective results (for results) */
-	learningObjectiveResults?: LearningObjectiveResult[]
+	/** Learning objective IDs (for line items and resource metadata) */
+	learningObjectiveIds: string[]
 }
 
 /**
@@ -181,6 +179,21 @@ interface LearningObjectiveSetItem {
  */
 type LearningObjectiveSet = LearningObjectiveSetItem[] | null
 
+/**
+ * A set of learning objective scores.
+ */
+interface LearningObjectiveScoreSetItem {
+	/** Source system for these learning objectives */
+	source: string
+	/** Learning objective results (for results and assessment results) */
+	learningObjectiveResults: LearningObjectiveResult[]
+}
+
+/**
+ * Array of learning objective score sets, or null if not applicable.
+ */
+type LearningObjectiveScoreSet = LearningObjectiveScoreSetItem[] | null
+
 /**
  * A reference to another OneRoster entity by sourcedId.
  */
@@ -509,10 +522,6 @@ interface ScoreScale extends Base {
 	course?: Ref | null
 	/** Values defining the scale */
 	scoreScaleValue?: ScoreScaleValue[]
-	/** Minimum possible score */
-	minScore?: number
-	/** Maximum possible score */
-	maxScore?: number
 }
 
 /**
@@ -584,7 +593,7 @@ interface Result extends Base {
 	/** Teacher comment */
 	comment?: string | null
 	/** Learning objective scores */
-	learningObjectiveSet?: LearningObjectiveSet
+	learningObjectiveSet?: LearningObjectiveScoreSet
 	/** Whether work is in progress */
 	inProgress?: string
 	/** Whether work is incomplete */
@@ -649,7 +658,7 @@ interface AssessmentResult extends Base {
 	/** Teacher/grader comment */
 	comment?: string | null
 	/** Learning objective scores */
-	learningObjectiveSet?: LearningObjectiveSet
+	learningObjectiveSet?: LearningObjectiveScoreSet
 	/** Whether assessment is in progress */
 	inProgress?: string | null
 	/** Whether assessment is incomplete */
@@ -1326,18 +1335,25 @@ type input$1<T> = T extends {
 /**
  * Input for creating a OneRoster user.
  *
- * Enforces required fields while allowing additional fields via passthrough.
+ * Unknown keys are rejected intentionally; add supported fields here rather than relying on passthrough.
  */
 declare const OneRosterUserCreateInput = z
 	.object({
 		sourcedId: NonEmptyString.describe('sourcedId must be a non-empty string'),
 		status: Status.optional(),
-		enabledUser: z.boolean(),
+		enabledUser: z.union([
+			z.boolean(),
+			z.enum(['true', 'false']).transform(value => value === 'true'),
+		]),
 		givenName: NonEmptyString.describe('givenName must be a non-empty string'),
 		familyName: NonEmptyString.describe('familyName must be a non-empty string'),
-		middleName: NonEmptyString.optional(),
-		username: NonEmptyString.optional(),
+		middleName: NonEmptyString.nullable().optional(),
+		preferredFirstName: NonEmptyString.nullable().optional(),
+		preferredMiddleName: NonEmptyString.nullable().optional(),
+		preferredLastName: NonEmptyString.nullable().optional(),
+		username: NonEmptyString.nullable().optional(),
 		email: z.email(),
+		userMasterIdentifier: z.string().nullable().optional(),
 		roles: z.array(OneRosterUserRoleInput).min(1, 'roles must include at least one role'),
 		userIds: z
 			.array(
@@ -1350,12 +1366,12 @@ declare const OneRosterUserCreateInput = z
 			)
 			.optional(),
 		agents: z.array(Ref).optional(),
+		primaryOrg: Ref.optional(),
 		grades: z.array(TimebackGrade).optional(),
-		identifier: NonEmptyString.optional(),
-		sms: NonEmptyString.optional(),
-		phone: NonEmptyString.optional(),
-		pronouns: NonEmptyString.optional(),
-		password: NonEmptyString.optional(),
+		sms: NonEmptyString.nullable().optional(),
+		phone: NonEmptyString.nullable().optional(),
+		pronouns: NonEmptyString.nullable().optional(),
+		password: NonEmptyString.nullable().optional(),
 		metadata: Metadata,
 	})
 	.strict()
@@ -1367,19 +1383,31 @@ declare const OneRosterUserCreateInput = z
 /**
  * Input for creating a OneRoster course.
  *
- * Enforces required fields while allowing additional fields.
+ * Unknown keys are rejected intentionally; add supported fields here rather than relying on passthrough.
  */
 declare const OneRosterCourseCreateInput = z
 	.object({
 		sourcedId: NonEmptyString.describe('sourcedId must be a non-empty string').optional(),
-		status: Status.optional(),
+		status: Status,
 		title: NonEmptyString.describe('title must be a non-empty string'),
 		org: Ref,
-		courseCode: NonEmptyString.optional(),
-		subjects: z.array(TimebackSubject).optional(),
-		grades: z.array(TimebackGrade).optional(),
-		level: NonEmptyString.optional(),
+		courseCode: NonEmptyString.nullable().optional(),
+		subjects: z.array(TimebackSubject).nullable().optional(),
+		subjectCodes: z.array(z.string()).nullable().optional(),
+		grades: z.array(TimebackGrade).nullable().optional(),
+		level: NonEmptyString.nullable().optional(),
+		academicSession: Ref.nullable().optional(),
+		schoolYear: GuidRef.nullable().optional(),
+		gradingScheme: NonEmptyString.nullable().optional(),
 		metadata: Metadata,
+
+		/**
+		 * NOTE: `resources` is accepted by the upstream CourseSchema but the current
+		 * implementation of serializeCourse() drops it before writing to the database,
+		 * so the API silently ignores this field on create/update until the service is
+		 * extended to persist it.
+		 */
+		// resources: z.array(GuidRef).nullable().optional(),
 	})
 	.strict()
 
@@ -1390,7 +1418,7 @@ declare const OneRosterCourseCreateInput = z
 /**
  * Input for creating a OneRoster class.
  *
- * Enforces required fields while allowing additional fields.
+ * Unknown keys are rejected intentionally; add supported fields here rather than relying on passthrough.
  */
 declare const OneRosterClassCreateInput = z
 	.object({
@@ -1400,14 +1428,22 @@ declare const OneRosterClassCreateInput = z
 		terms: z.array(Ref).min(1, 'terms must have at least one item'),
 		course: Ref,
 		org: Ref,
-		classCode: NonEmptyString.optional(),
+		classCode: NonEmptyString.nullable().optional(),
 		classType: z.enum(['homeroom', 'scheduled']).optional(),
-		location: NonEmptyString.optional(),
+		location: NonEmptyString.nullable().optional(),
 		grades: z.array(TimebackGrade).optional(),
 		subjects: z.array(TimebackSubject).optional(),
 		subjectCodes: z.array(NonEmptyString).optional(),
 		periods: z.array(NonEmptyString).optional(),
 		metadata: Metadata,
+
+		/**
+		 * NOTE: `resources` is accepted by the upstream CourseSchema but the current
+		 * implementation of serializeCourse() drops it before writing to the database,
+		 * so the API silently ignores this field on create/update until the service is
+		 * extended to persist it.
+		 */
+		// resources: z.array(GuidRef).nullable().optional(),
 	})
 	.strict()
 
@@ -1433,7 +1469,7 @@ declare const OneRosterEnrollmentCreateInput = z
 /**
  * Input for creating a OneRoster category.
  *
- * Enforces title and status while allowing additional fields.
+ * Unknown keys are rejected intentionally; add supported fields here rather than relying on passthrough.
  */
 declare const OneRosterCategoryCreateInput = z
 	.object({
@@ -1452,7 +1488,7 @@ declare const OneRosterCategoryCreateInput = z
 /**
  * Input for creating a OneRoster line item.
  *
- * Enforces required fields: title, class, school, category, assignDate, dueDate, status.
+ * Unknown keys are rejected intentionally; add supported fields here rather than relying on passthrough.
  */
 declare const OneRosterLineItemCreateInput = z
 	.object({
@@ -1463,11 +1499,14 @@ declare const OneRosterLineItemCreateInput = z
 		category: Ref,
 		assignDate: OneRosterDateString,
 		dueDate: OneRosterDateString,
-		status: Status,
-		description: z.string().optional(),
+		status: Status.optional(),
+		description: z.string().nullable().optional(),
 		resultValueMin: z.number().nullable().optional(),
 		resultValueMax: z.number().nullable().optional(),
-		scoreScale: Ref.optional(),
+		gradingPeriod: Ref.nullable().optional(),
+		academicSession: Ref.nullable().optional(),
+		scoreScale: Ref.nullable().optional(),
+		learningObjectiveSet: LearningObjectiveSetSchema.nullable().optional(),
 		metadata: Metadata,
 	})
 	.strict()
@@ -1479,14 +1518,14 @@ declare const OneRosterLineItemCreateInput = z
 /**
  * Input for creating a OneRoster result (grade).
  *
- * Enforces required fields: lineItem, student, scoreDate, scoreStatus, status.
+ * Unknown keys are rejected intentionally; add supported fields here rather than relying on passthrough.
  */
 declare const OneRosterResultCreateInput = z
 	.object({
 		sourcedId: NonEmptyString.optional(),
 		lineItem: Ref,
 		student: Ref,
-		class: Ref.optional(),
+		class: Ref.nullable().optional(),
 		scoreDate: OneRosterDateString,
 		scoreStatus: z.enum([
 			'exempt',
@@ -1498,7 +1537,13 @@ declare const OneRosterResultCreateInput = z
 		score: z.number().nullable().optional(),
 		textScore: z.string().nullable().optional(),
 		status: Status,
+		scoreScale: Ref.nullable().optional(),
 		comment: z.string().nullable().optional(),
+		learningObjectiveSet: LearningObjectiveScoreSetSchema.nullable().optional(),
+		inProgress: z.string().optional(),
+		incomplete: z.string().optional(),
+		late: z.string().optional(),
+		missing: z.string().optional(),
 		metadata: Metadata,
 	})
 	.strict()
@@ -1510,14 +1555,14 @@ declare const OneRosterResultCreateInput = z
 /**
  * Input for creating a OneRoster score scale.
  *
- * Enforces title while allowing additional fields.
+ * Unknown keys are rejected intentionally; add supported fields here rather than relying on passthrough.
  */
 declare const OneRosterScoreScaleCreateInput = z
 	.object({
 		sourcedId: NonEmptyString.optional(),
 		title: NonEmptyString.describe('title must be a non-empty string'),
-		status: Status.optional(),
-		type: z.string(),
+		status: Status,
+		type: NonEmptyString,
 		class: Ref,
 		course: Ref.nullable().optional(),
 		scoreScaleValue: z.array(
@@ -1530,8 +1575,6 @@ declare const OneRosterScoreScaleCreateInput = z
 				})
 				.strict(),
 		),
-		minScore: z.number().optional(),
-		maxScore: z.number().optional(),
 		metadata: Metadata,
 	})
 	.strict()
@@ -1542,12 +1585,13 @@ declare const OneRosterScoreScaleCreateInput = z
 
 /**
  * Input for creating a OneRoster assessment line item.
- * Matches Timeback server `AssessmentLineItemSchema` (beyond-timeback-api-2).
+ *
+ * Unknown keys are rejected intentionally; add supported fields here rather than relying on passthrough.
  */
 declare const OneRosterAssessmentLineItemCreateInput = z
 	.object({
 		sourcedId: NonEmptyString.optional(),
-		status: Status.optional(),
+		status: Status,
 		dateLastModified: IsoDateTimeString.optional(),
 		title: NonEmptyString.describe('title must be a non-empty string'),
 		description: z.string().nullable().optional(),
@@ -1573,14 +1617,19 @@ declare const OneRosterAssessmentLineItemCreateInput = z
 	})
 	.strict()
 
+// ═══════════════════════════════════════════════════════════════════════════════
+// ASSESSMENT RESULTS
+// ═══════════════════════════════════════════════════════════════════════════════
+
 /**
  * Input for creating a OneRoster assessment result.
- * Matches Timeback server `AssessmentResultSchema` (beyond-timeback-api-2).
+ *
+ * Unknown keys are rejected intentionally; add supported fields here rather than relying on passthrough.
  */
 declare const OneRosterAssessmentResultCreateInput = z
 	.object({
 		sourcedId: NonEmptyString.optional(),
-		status: Status.optional(),
+		status: Status,
 		dateLastModified: IsoDateTimeString.optional(),
 		metadata: Metadata,
 		assessmentLineItem: Ref,
@@ -1613,7 +1662,7 @@ declare const OneRosterAssessmentResultCreateInput = z
 /**
  * Input for creating a OneRoster organization.
  *
- * Enforces name and type while allowing additional fields.
+ * Unknown keys are rejected intentionally; add supported fields here rather than relying on passthrough.
  */
 declare const OneRosterOrgCreateInput = z
 	.object({
@@ -1621,7 +1670,7 @@ declare const OneRosterOrgCreateInput = z
 		status: Status.optional(),
 		name: NonEmptyString.describe('name must be a non-empty string'),
 		type: OrganizationType,
-		identifier: NonEmptyString.optional(),
+		identifier: z.string().nullish(),
 		parent: Ref.optional(),
 		metadata: Metadata,
 	})
@@ -1630,15 +1679,15 @@ declare const OneRosterOrgCreateInput = z
 /**
  * Input for creating a OneRoster school (org with type='school').
  *
- * Enforces name and optionally validates type.
+ * Unknown keys are rejected intentionally; add supported fields here rather than relying on passthrough.
  */
 declare const OneRosterSchoolCreateInput = z
 	.object({
 		sourcedId: NonEmptyString.optional(),
 		status: Status.optional(),
 		name: NonEmptyString.describe('name must be a non-empty string'),
-		type: z.literal('school').optional(),
-		identifier: NonEmptyString.optional(),
+		type: z.literal('school').default('school'),
+		identifier: z.string().nullish(),
 		parent: Ref.optional(),
 		metadata: Metadata,
 	})
@@ -1651,7 +1700,7 @@ declare const OneRosterSchoolCreateInput = z
 /**
  * Input for creating a OneRoster academic session.
  *
- * Enforces required fields: sourcedId, status, title, startDate, endDate, type, schoolYear, org.
+ * Unknown keys are rejected intentionally; add supported fields here rather than relying on passthrough.
  */
 declare const OneRosterAcademicSessionCreateInput = z
 	.object({
@@ -1676,15 +1725,17 @@ declare const OneRosterAcademicSessionCreateInput = z
 /**
  * Input for creating a OneRoster component resource.
  *
- * Enforces required fields while allowing additional fields.
+ * Unknown keys are rejected intentionally; add supported fields here rather than relying on passthrough.
  */
 declare const OneRosterComponentResourceCreateInput = z
 	.object({
-		sourcedId: NonEmptyString.optional(),
+		sourcedId: NonEmptyString,
 		title: NonEmptyString.describe('title must be a non-empty string'),
 		courseComponent: Ref,
 		resource: Ref,
 		status: Status,
+		sortOrder: z.number().optional(),
+		lessonType: LessonType.optional(),
 		metadata: Metadata,
 	})
 	.strict()
@@ -1696,7 +1747,7 @@ declare const OneRosterComponentResourceCreateInput = z
 /**
  * Input for creating a OneRoster course component.
  *
- * Enforces title, course, and status while allowing additional fields.
+ * Unknown keys are rejected intentionally; add supported fields here rather than relying on passthrough.
  */
 declare const OneRosterCourseComponentCreateInput = z
 	.object({
@@ -1704,9 +1755,19 @@ declare const OneRosterCourseComponentCreateInput = z
 		title: NonEmptyString.describe('title must be a non-empty string'),
 		course: Ref,
 		status: Status,
+		sortOrder: z.number().optional(),
+		parent: Ref.nullable().optional(),
+		courseComponent: Ref.nullable().optional(),
+		prerequisites: z.array(z.string()).nullable().optional(),
+		prerequisiteCriteria: z.string().nullable().optional(),
+		unlockDate: OneRosterDateString.nullable().optional(),
 		metadata: Metadata,
 	})
 	.strict()
+	.transform(({ courseComponent, parent, ...rest }) => ({
+		...rest,
+		parent: parent === undefined ? (courseComponent ?? undefined) : parent,
+	}))
 
 // ═══════════════════════════════════════════════════════════════════════════════
 // ENROLL INPUT (CONVENIENCE)
@@ -1715,7 +1776,7 @@ declare const OneRosterCourseComponentCreateInput = z
 /**
  * Input for enrolling a user in a class (convenience method).
  *
- * Enforces sourcedId and role while allowing additional fields.
+ * Unknown keys are rejected intentionally; add supported fields here rather than relying on passthrough.
  */
 declare const OneRosterEnrollInput = z
 	.object({
@@ -1767,13 +1828,32 @@ declare const OneRosterCredentialInput = z
 /**
  * Input for creating/updating demographics.
  *
- * Enforces sourcedId while allowing additional fields.
+ * Unknown keys are rejected intentionally; add supported fields here rather than relying on passthrough.
  */
 declare const OneRosterDemographicsCreateInput = z
 	.object({
 		sourcedId: NonEmptyString.describe('sourcedId must be a non-empty string'),
+		status: Status.optional(),
+		metadata: Metadata,
+		birthDate: z
+			.string()
+			.regex(/^\d{4}-\d{2}-\d{2}$/)
+			.nullable()
+			.optional(),
+		sex: z.enum(['male', 'female']).nullable().optional(),
+		americanIndianOrAlaskaNative: StringBoolean.nullable().optional(),
+		asian: StringBoolean.nullable().optional(),
+		blackOrAfricanAmerican: StringBoolean.nullable().optional(),
+		nativeHawaiianOrOtherPacificIslander: StringBoolean.nullable().optional(),
+		white: StringBoolean.nullable().optional(),
+		demographicRaceTwoOrMoreRaces: StringBoolean.nullable().optional(),
+		hispanicOrLatinoEthnicity: StringBoolean.nullable().optional(),
+		countryOfBirthCode: z.string().nullable().optional(),
+		stateOfBirthAbbreviation: z.string().nullable().optional(),
+		cityOfBirth: z.string().nullable().optional(),
+		publicSchoolResidenceStatus: z.string().nullable().optional(),
 	})
-	.loose()
+	.strict()
 
 // ═══════════════════════════════════════════════════════════════════════════════
 // RESOURCE INPUT
@@ -1782,7 +1862,7 @@ declare const OneRosterDemographicsCreateInput = z
 /**
  * Input for creating/updating resources.
  *
- * Enforces title and vendorResourceId while allowing additional fields.
+ * Unknown keys are rejected intentionally; add supported fields here rather than relying on passthrough.
  */
 declare const OneRosterResourceCreateInput = z
 	.object({
@@ -1791,10 +1871,26 @@ declare const OneRosterResourceCreateInput = z
 		vendorResourceId: NonEmptyString.describe('vendorResourceId must be a non-empty string'),
 		roles: z.array(z.enum(['primary', 'secondary'])).optional(),
 		importance: z.enum(['primary', 'secondary']).optional(),
-		vendorId: z.string().optional(),
-		applicationId: z.string().optional(),
+		vendorId: NonEmptyString.nullable().optional(),
+		applicationId: NonEmptyString.nullable().optional(),
 		status: Status.optional(),
-		metadata: ResourceMetadataSchema.nullable().optional(),
+
+		/**
+		 * Accepts typed metadata (discriminated by `type`) or truly custom metadata.
+		 *
+		 * NOTE: The server extracts any field whose name matches a known metadata
+		 * field (e.g., launchUrl, toolProvider, subType, …) and validates them against
+		 * the typed schemas. If any such field is present WITHOUT a `type` discriminator,
+		 * the server will reject the request. Keep untyped metadata to custom keys.
+		 * `fail_fast` remains valid without a discriminator, but it is still checked
+		 * against the upstream fast-fail schema before sending the request.
+		 *
+		 * Always include `type` when sending structured metadata keys.
+		 */
+		metadata: z
+			.union([ResourceMetadataSchema, UntypedResourceMetadataSchema])
+			.nullable()
+			.optional(),
 	})
 	.strict()
 
@@ -4793,7 +4889,7 @@ interface CoursesCallable extends CallableResource<Course, CourseFilterFields, S
     /** Create a new course component */
     createComponent(data: CourseComponentCreateInput): Promise<CreateResponse>;
     /** Update a course component */
-    updateComponent(sourcedId: string, data: Partial<CourseComponent>): Promise<void>;
+    updateComponent(sourcedId: string, data: CourseComponentCreateInput): Promise<void>;
     /** Delete a course component */
     deleteComponent(sourcedId: string): Promise<void>;
     /** List all component resources */
@@ -4805,7 +4901,7 @@ interface CoursesCallable extends CallableResource<Course, CourseFilterFields, S
     /** Create a new component resource */
     createComponentResource(data: ComponentResourceCreateInput): Promise<CreateResponse>;
     /** Update a component resource */
-    updateComponentResource(sourcedId: string, data: Partial<ComponentResource>): Promise<void>;
+    updateComponentResource(sourcedId: string, data: ComponentResourceCreateInput): Promise<void>;
     /** Delete a component resource */
     deleteComponentResource(sourcedId: string): Promise<void>;
     /** Create a course structure from QTI tests */