@aibrains/shared-types 0.1.0

package/dist/schemas/academics/course-section.schema.js

@@ -0,0 +1,128 @@
+"use strict";
+/**
+ * Course Section Schemas - Academics Service
+ *
+ * Zod schemas for course section (class instance) management DTOs.
+ * A course section is a specific offering of a course with a teacher,
+ * schedule, and enrollment cap for a given academic term.
+ *
+ * Ed-Fi Alignment:
+ * - Maps to Ed-Fi "Section" entity
+ * - sectionNumber -> Ed-Fi sectionIdentifier
+ * - primaryTeacherId -> Ed-Fi StaffSectionAssociation (primary)
+ * - maxEnrollment -> Ed-Fi availableCredits context
+ *
+ * @see https://api.ed-fi.org/v7.1/docs/swagger/index.html - Section
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sectionRosterResponseSchema = exports.studentSectionResponseSchema = exports.enrollStudentInSectionSchema = exports.sectionFilterSchema = exports.sectionListResponseSchema = exports.sectionResponseSchema = exports.updateSectionSchema = exports.createSectionSchema = void 0;
+const zod_1 = require("zod");
+const common_1 = require("../common");
+// ============================================
+// Create Section Schema
+// ============================================
+exports.createSectionSchema = zod_1.z.object({
+    // Course reference (Ed-Fi: CourseOfferingReference)
+    courseId: zod_1.z.string().uuid(),
+    // School reference (Ed-Fi: SchoolReference / LocationSchoolReference)
+    schoolId: zod_1.z.string().uuid(),
+    // Academic session (Ed-Fi: SessionReference)
+    academicYearId: zod_1.z.string().uuid(),
+    termId: zod_1.z.string().uuid().optional(),
+    // Section identity (Ed-Fi: sectionIdentifier)
+    sectionNumber: zod_1.z.string()
+        .min(1, 'Section number is required')
+        .max(20, 'Section number must not exceed 20 characters'),
+    sectionName: zod_1.z.string().max(100).optional(),
+    // Teacher assignment (Ed-Fi: StaffSectionAssociation)
+    primaryTeacherId: zod_1.z.string().uuid(),
+    coTeacherIds: zod_1.z.array(zod_1.z.string().uuid()).max(5).optional(),
+    // Physical location
+    roomId: zod_1.z.string().uuid().optional(),
+    // Enrollment capacity
+    maxEnrollment: zod_1.z.number()
+        .int()
+        .min(1, 'Max enrollment must be at least 1')
+        .max(500, 'Max enrollment must not exceed 500'),
+});
+// ============================================
+// Update Section Schema
+// ============================================
+exports.updateSectionSchema = exports.createSectionSchema.partial().omit({
+    courseId: true,
+    schoolId: true,
+    academicYearId: true,
+});
+// ============================================
+// Section Response Schema
+// ============================================
+exports.sectionResponseSchema = zod_1.z.object({
+    sectionId: zod_1.z.string().uuid(),
+    tenantId: zod_1.z.string(),
+    // Course reference
+    courseId: zod_1.z.string().uuid(),
+    courseCode: zod_1.z.string().optional(),
+    courseName: zod_1.z.string().optional(),
+    // School reference
+    schoolId: zod_1.z.string().uuid(),
+    // Academic session
+    academicYearId: zod_1.z.string().uuid(),
+    termId: zod_1.z.string().uuid().optional(),
+    // Section identity
+    sectionNumber: zod_1.z.string(),
+    sectionName: zod_1.z.string().optional(),
+    // Teacher assignment
+    primaryTeacherId: zod_1.z.string().uuid(),
+    primaryTeacherName: zod_1.z.string().optional(),
+    coTeacherIds: zod_1.z.array(zod_1.z.string().uuid()).optional(),
+    // Physical location
+    roomId: zod_1.z.string().uuid().optional(),
+    roomNumber: zod_1.z.string().optional(),
+    // Enrollment
+    maxEnrollment: zod_1.z.number().int(),
+    currentEnrollment: zod_1.z.number().int().min(0),
+    // Status
+    isActive: zod_1.z.boolean(),
+    // Metadata
+    createdAt: common_1.isoDateSchema,
+    updatedAt: common_1.isoDateSchema,
+    createdBy: zod_1.z.string().optional(),
+    updatedBy: zod_1.z.string().optional(),
+});
+// ============================================
+// Section List Response Schema
+// ============================================
+exports.sectionListResponseSchema = (0, common_1.createPaginatedResponseSchema)(exports.sectionResponseSchema);
+// ============================================
+// Section Filter Schema
+// ============================================
+exports.sectionFilterSchema = zod_1.z.object({
+    schoolId: zod_1.z.string().uuid().optional(),
+    courseId: zod_1.z.string().uuid().optional(),
+    academicYearId: zod_1.z.string().uuid().optional(),
+    termId: zod_1.z.string().uuid().optional(),
+    teacherId: zod_1.z.string().uuid().optional(),
+    isActive: zod_1.z.boolean().optional(),
+    searchTerm: zod_1.z.string().max(100).optional(),
+});
+// ============================================
+// Student-Section Enrollment Schemas
+// ============================================
+exports.enrollStudentInSectionSchema = zod_1.z.object({
+    studentId: zod_1.z.string().uuid(),
+});
+exports.studentSectionResponseSchema = zod_1.z.object({
+    studentId: zod_1.z.string().uuid(),
+    studentName: zod_1.z.string().optional(),
+    sectionId: zod_1.z.string().uuid(),
+    enrolledAt: common_1.isoDateSchema,
+    enrolledBy: zod_1.z.string().optional(),
+});
+exports.sectionRosterResponseSchema = zod_1.z.object({
+    sectionId: zod_1.z.string().uuid(),
+    courseName: zod_1.z.string().optional(),
+    sectionNumber: zod_1.z.string().optional(),
+    students: zod_1.z.array(exports.studentSectionResponseSchema),
+    totalCount: zod_1.z.number().int().min(0),
+});
+//# sourceMappingURL=course-section.schema.js.map

package/dist/schemas/academics/course-section.schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"course-section.schema.js","sourceRoot":"","sources":["../../../src/schemas/academics/course-section.schema.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH,6BAAwB;AACxB,sCAGmB;AAEnB,+CAA+C;AAC/C,wBAAwB;AACxB,+CAA+C;AAElC,QAAA,mBAAmB,GAAG,OAAC,CAAC,MAAM,CAAC;IAC1C,oDAAoD;IACpD,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE;IAE3B,sEAAsE;IACtE,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE;IAE3B,6CAA6C;IAC7C,cAAc,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE;IACjC,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;IAEpC,8CAA8C;IAC9C,aAAa,EAAE,OAAC,CAAC,MAAM,EAAE;SACtB,GAAG,CAAC,CAAC,EAAE,4BAA4B,CAAC;SACpC,GAAG,CAAC,EAAE,EAAE,8CAA8C,CAAC;IAC1D,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE;IAE3C,sDAAsD;IACtD,gBAAgB,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE;IACnC,YAAY,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IAE1D,oBAAoB;IACpB,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;IAEpC,sBAAsB;IACtB,aAAa,EAAE,OAAC,CAAC,MAAM,EAAE;SACtB,GAAG,EAAE;SACL,GAAG,CAAC,CAAC,EAAE,mCAAmC,CAAC;SAC3C,GAAG,CAAC,GAAG,EAAE,oCAAoC,CAAC;CAClD,CAAC,CAAC;AAIH,+CAA+C;AAC/C,wBAAwB;AACxB,+CAA+C;AAElC,QAAA,mBAAmB,GAAG,2BAAmB,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC;IACpE,QAAQ,EAAE,IAAI;IACd,QAAQ,EAAE,IAAI;IACd,cAAc,EAAE,IAAI;CACrB,CAAC,CAAC;AAIH,+CAA+C;AAC/C,0BAA0B;AAC1B,+CAA+C;AAElC,QAAA,qBAAqB,GAAG,OAAC,CAAC,MAAM,CAAC;IAC5C,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE;IAC5B,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE;IAEpB,mBAAmB;IACnB,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE;IAC3B,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAEjC,mBAAmB;IACnB,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE;IAE3B,mBAAmB;IACnB,cAAc,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE;IACjC,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;IAEpC,mBAAmB;IACnB,aAAa,EAAE,OAAC,CAAC,MAAM,EAAE;IACzB,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAElC,qBAAqB;IACrB,gBAAgB,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE;IACnC,kBAAkB,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzC,YAAY,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE;IAEnD,oBAAoB;IACpB,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;IACpC,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAEjC,aAAa;IACb,aAAa,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IAC/B,iBAAiB,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAE1C,SAAS;IACT,QAAQ,EAAE,OAAC,CAAC,OAAO,EAAE;IAErB,WAAW;IACX,SAAS,EAAE,sBAAa;IACxB,SAAS,EAAE,sBAAa;IACxB,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACjC,CAAC,CAAC;AAIH,+CAA+C;AAC/C,+BAA+B;AAC/B,+CAA+C;AAElC,QAAA,yBAAyB,GAAG,IAAA,sCAA6B,EAAC,6BAAqB,CAAC,CAAC;AAG9F,+CAA+C;AAC/C,wBAAwB;AACxB,+CAA+C;AAElC,QAAA,mBAAmB,GAAG,OAAC,CAAC,MAAM,CAAC;IAC1C,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;IACtC,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;IACtC,cAAc,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;IAC5C,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;IACpC,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;IACvC,QAAQ,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAChC,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE;CAC3C,CAAC,CAAC;AAIH,+CAA+C;AAC/C,qCAAqC;AACrC,+CAA+C;AAElC,QAAA,4BAA4B,GAAG,OAAC,CAAC,MAAM,CAAC;IACnD,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE;CAC7B,CAAC,CAAC;AAIU,QAAA,4BAA4B,GAAG,OAAC,CAAC,MAAM,CAAC;IACnD,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE;IAC5B,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE;IAC5B,UAAU,EAAE,sBAAa;IACzB,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAClC,CAAC,CAAC;AAIU,QAAA,2BAA2B,GAAG,OAAC,CAAC,MAAM,CAAC;IAClD,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE;IAC5B,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,aAAa,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACpC,QAAQ,EAAE,OAAC,CAAC,KAAK,CAAC,oCAA4B,CAAC;IAC/C,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;CACpC,CAAC,CAAC"}