@aibrains/shared-types 0.14.0 → 0.16.0

package/dist/utils/school-hours.d.ts

@@ -0,0 +1,48 @@
+/**
+ * School Hours Validation Utility
+ *
+ * Validates schedule slots, school days, and generates default bell schedule periods.
+ * All time values are HH:mm format (24-hour).
+ */
+export interface SchoolHoursConfig {
+    startTime: string;
+    endTime: string;
+    schoolDays: number[];
+    periodDuration: number;
+}
+export interface Period {
+    number: number;
+    startTime: string;
+    endTime: string;
+    type: 'class' | 'break';
+    label: string;
+}
+/**
+ * Check if a time falls within school hours (inclusive start, exclusive end)
+ */
+export declare function isWithinSchoolHours(time: string, startTime: string, endTime: string): boolean;
+/**
+ * Check if a day of week is a school day
+ */
+export declare function isSchoolDay(dayOfWeek: number, schoolDays: number[]): boolean;
+/**
+ * Validate a schedule slot against school hours config.
+ * Returns error message string or null if valid.
+ */
+export declare function validateScheduleSlot(params: {
+    startTime: string;
+    endTime: string;
+    dayOfWeek: number;
+    schoolConfig: SchoolHoursConfig;
+}): string | null;
+/**
+ * Auto-generate bell schedule periods based on school hours and period duration.
+ * Inserts breaks between periods.
+ */
+export declare function generateDefaultPeriods(startTime: string, endTime: string, periodDuration: number, breakDuration?: number): Period[];
+/**
+ * Validate a bell schedule against school hours.
+ * Returns array of error messages (empty if valid).
+ */
+export declare function validateBellSchedule(periods: Period[], schoolConfig: SchoolHoursConfig): string[];
+//# sourceMappingURL=school-hours.d.ts.map

package/dist/utils/school-hours.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"school-hours.d.ts","sourceRoot":"","sources":["../../src/utils/school-hours.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,MAAM;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC;IACxB,KAAK,EAAE,MAAM,CAAC;CACf;AAmBD;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAK7F;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,OAAO,CAE5E;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE;IAC3C,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,iBAAiB,CAAC;CACjC,GAAG,MAAM,GAAG,IAAI,CAyBhB;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CACpC,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,EACf,cAAc,EAAE,MAAM,EACtB,aAAa,GAAE,MAAW,GACzB,MAAM,EAAE,CAiCV;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAClC,OAAO,EAAE,MAAM,EAAE,EACjB,YAAY,EAAE,iBAAiB,GAC9B,MAAM,EAAE,CA+BV"}

package/dist/utils/school-hours.js

@@ -0,0 +1,134 @@
+"use strict";
+/**
+ * School Hours Validation Utility
+ *
+ * Validates schedule slots, school days, and generates default bell schedule periods.
+ * All time values are HH:mm format (24-hour).
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isWithinSchoolHours = isWithinSchoolHours;
+exports.isSchoolDay = isSchoolDay;
+exports.validateScheduleSlot = validateScheduleSlot;
+exports.generateDefaultPeriods = generateDefaultPeriods;
+exports.validateBellSchedule = validateBellSchedule;
+/**
+ * Parse HH:mm string to minutes since midnight
+ */
+function parseTime(time) {
+    const [h, m] = time.split(':').map(Number);
+    return h * 60 + m;
+}
+/**
+ * Format minutes since midnight to HH:mm
+ */
+function formatTime(minutes) {
+    const h = Math.floor(minutes / 60);
+    const m = minutes % 60;
+    return `${String(h).padStart(2, '0')}:${String(m).padStart(2, '0')}`;
+}
+/**
+ * Check if a time falls within school hours (inclusive start, exclusive end)
+ */
+function isWithinSchoolHours(time, startTime, endTime) {
+    const t = parseTime(time);
+    const start = parseTime(startTime);
+    const end = parseTime(endTime);
+    return t >= start && t <= end;
+}
+/**
+ * Check if a day of week is a school day
+ */
+function isSchoolDay(dayOfWeek, schoolDays) {
+    return schoolDays.includes(dayOfWeek);
+}
+/**
+ * Validate a schedule slot against school hours config.
+ * Returns error message string or null if valid.
+ */
+function validateScheduleSlot(params) {
+    const { startTime, endTime, dayOfWeek, schoolConfig } = params;
+    // Check school day
+    if (!isSchoolDay(dayOfWeek, schoolConfig.schoolDays)) {
+        const dayNames = ['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday'];
+        return `${dayNames[dayOfWeek]} is not a school day`;
+    }
+    // Check start time
+    if (!isWithinSchoolHours(startTime, schoolConfig.startTime, schoolConfig.endTime)) {
+        return `Start time ${startTime} falls outside school hours (${schoolConfig.startTime}-${schoolConfig.endTime})`;
+    }
+    // Check end time
+    if (!isWithinSchoolHours(endTime, schoolConfig.startTime, schoolConfig.endTime)) {
+        return `End time ${endTime} falls outside school hours (${schoolConfig.startTime}-${schoolConfig.endTime})`;
+    }
+    // Check order
+    if (parseTime(endTime) <= parseTime(startTime)) {
+        return `End time ${endTime} must be after start time ${startTime}`;
+    }
+    return null;
+}
+/**
+ * Auto-generate bell schedule periods based on school hours and period duration.
+ * Inserts breaks between periods.
+ */
+function generateDefaultPeriods(startTime, endTime, periodDuration, breakDuration = 10) {
+    const periods = [];
+    let currentTime = parseTime(startTime);
+    const schoolEnd = parseTime(endTime);
+    let periodNumber = 1;
+    while (currentTime + periodDuration <= schoolEnd) {
+        // Add class period
+        periods.push({
+            number: periodNumber,
+            startTime: formatTime(currentTime),
+            endTime: formatTime(currentTime + periodDuration),
+            type: 'class',
+            label: `Period ${periodNumber}`,
+        });
+        currentTime += periodDuration;
+        periodNumber++;
+        // Add break if there's room for another period after break
+        if (currentTime + breakDuration + periodDuration <= schoolEnd) {
+            periods.push({
+                number: periodNumber - 1, // breaks share the preceding period number
+                startTime: formatTime(currentTime),
+                endTime: formatTime(currentTime + breakDuration),
+                type: 'break',
+                label: periodNumber === 5 ? 'Lunch Break' : 'Break',
+            });
+            currentTime += breakDuration;
+        }
+    }
+    return periods;
+}
+/**
+ * Validate a bell schedule against school hours.
+ * Returns array of error messages (empty if valid).
+ */
+function validateBellSchedule(periods, schoolConfig) {
+    const errors = [];
+    const classPeriods = periods.filter(p => p.type === 'class');
+    if (classPeriods.length === 0) {
+        errors.push('Bell schedule must have at least one class period');
+        return errors;
+    }
+    // First period must not start before school start
+    const firstPeriod = classPeriods[0];
+    if (parseTime(firstPeriod.startTime) < parseTime(schoolConfig.startTime)) {
+        errors.push(`First period starts at ${firstPeriod.startTime}, before school start time ${schoolConfig.startTime}`);
+    }
+    // Last period must not end after school end
+    const lastPeriod = classPeriods[classPeriods.length - 1];
+    if (parseTime(lastPeriod.endTime) > parseTime(schoolConfig.endTime)) {
+        errors.push(`Last period ends at ${lastPeriod.endTime}, after school end time ${schoolConfig.endTime}`);
+    }
+    // Check period duration alignment (warning-level, not error)
+    for (const period of classPeriods) {
+        const duration = parseTime(period.endTime) - parseTime(period.startTime);
+        if (duration !== schoolConfig.periodDuration && duration !== schoolConfig.periodDuration * 2) {
+            // Allow single or double periods
+            errors.push(`Period ${period.number} duration (${duration}min) doesn't match configured period duration (${schoolConfig.periodDuration}min)`);
+        }
+    }
+    return errors;
+}
+//# sourceMappingURL=school-hours.js.map

package/dist/utils/school-hours.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"school-hours.js","sourceRoot":"","sources":["../../src/utils/school-hours.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAqCH,kDAKC;AAKD,kCAEC;AAMD,oDA8BC;AAMD,wDAsCC;AAMD,oDAkCC;AAxJD;;GAEG;AACH,SAAS,SAAS,CAAC,IAAY;IAC7B,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAC3C,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;AACpB,CAAC;AAED;;GAEG;AACH,SAAS,UAAU,CAAC,OAAe;IACjC,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,EAAE,CAAC,CAAC;IACnC,MAAM,CAAC,GAAG,OAAO,GAAG,EAAE,CAAC;IACvB,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC;AACvE,CAAC;AAED;;GAEG;AACH,SAAgB,mBAAmB,CAAC,IAAY,EAAE,SAAiB,EAAE,OAAe;IAClF,MAAM,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;IAC1B,MAAM,KAAK,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC;IACnC,MAAM,GAAG,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC;IAC/B,OAAO,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,GAAG,CAAC;AAChC,CAAC;AAED;;GAEG;AACH,SAAgB,WAAW,CAAC,SAAiB,EAAE,UAAoB;IACjE,OAAO,UAAU,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;AACxC,CAAC;AAED;;;GAGG;AACH,SAAgB,oBAAoB,CAAC,MAKpC;IACC,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,GAAG,MAAM,CAAC;IAE/D,mBAAmB;IACnB,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,YAAY,CAAC,UAAU,CAAC,EAAE,CAAC;QACrD,MAAM,QAAQ,GAAG,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,WAAW,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;QAChG,OAAO,GAAG,QAAQ,CAAC,SAAS,CAAC,sBAAsB,CAAC;IACtD,CAAC;IAED,mBAAmB;IACnB,IAAI,CAAC,mBAAmB,CAAC,SAAS,EAAE,YAAY,CAAC,SAAS,EAAE,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC;QAClF,OAAO,cAAc,SAAS,gCAAgC,YAAY,CAAC,SAAS,IAAI,YAAY,CAAC,OAAO,GAAG,CAAC;IAClH,CAAC;IAED,iBAAiB;IACjB,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,YAAY,CAAC,SAAS,EAAE,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC;QAChF,OAAO,YAAY,OAAO,gCAAgC,YAAY,CAAC,SAAS,IAAI,YAAY,CAAC,OAAO,GAAG,CAAC;IAC9G,CAAC;IAED,cAAc;IACd,IAAI,SAAS,CAAC,OAAO,CAAC,IAAI,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC;QAC/C,OAAO,YAAY,OAAO,6BAA6B,SAAS,EAAE,CAAC;IACrE,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;GAGG;AACH,SAAgB,sBAAsB,CACpC,SAAiB,EACjB,OAAe,EACf,cAAsB,EACtB,gBAAwB,EAAE;IAE1B,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,IAAI,WAAW,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC;IACvC,MAAM,SAAS,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC;IACrC,IAAI,YAAY,GAAG,CAAC,CAAC;IAErB,OAAO,WAAW,GAAG,cAAc,IAAI,SAAS,EAAE,CAAC;QACjD,mBAAmB;QACnB,OAAO,CAAC,IAAI,CAAC;YACX,MAAM,EAAE,YAAY;YACpB,SAAS,EAAE,UAAU,CAAC,WAAW,CAAC;YAClC,OAAO,EAAE,UAAU,CAAC,WAAW,GAAG,cAAc,CAAC;YACjD,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,UAAU,YAAY,EAAE;SAChC,CAAC,CAAC;QAEH,WAAW,IAAI,cAAc,CAAC;QAC9B,YAAY,EAAE,CAAC;QAEf,2DAA2D;QAC3D,IAAI,WAAW,GAAG,aAAa,GAAG,cAAc,IAAI,SAAS,EAAE,CAAC;YAC9D,OAAO,CAAC,IAAI,CAAC;gBACX,MAAM,EAAE,YAAY,GAAG,CAAC,EAAE,2CAA2C;gBACrE,SAAS,EAAE,UAAU,CAAC,WAAW,CAAC;gBAClC,OAAO,EAAE,UAAU,CAAC,WAAW,GAAG,aAAa,CAAC;gBAChD,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,OAAO;aACpD,CAAC,CAAC;YACH,WAAW,IAAI,aAAa,CAAC;QAC/B,CAAC;IACH,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;GAGG;AACH,SAAgB,oBAAoB,CAClC,OAAiB,EACjB,YAA+B;IAE/B,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,MAAM,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC;IAE7D,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC9B,MAAM,CAAC,IAAI,CAAC,mDAAmD,CAAC,CAAC;QACjE,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,kDAAkD;IAClD,MAAM,WAAW,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;IACpC,IAAI,SAAS,CAAC,WAAW,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC,YAAY,CAAC,SAAS,CAAC,EAAE,CAAC;QACzE,MAAM,CAAC,IAAI,CAAC,0BAA0B,WAAW,CAAC,SAAS,8BAA8B,YAAY,CAAC,SAAS,EAAE,CAAC,CAAC;IACrH,CAAC;IAED,4CAA4C;IAC5C,MAAM,UAAU,GAAG,YAAY,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACzD,IAAI,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC;QACpE,MAAM,CAAC,IAAI,CAAC,uBAAuB,UAAU,CAAC,OAAO,2BAA2B,YAAY,CAAC,OAAO,EAAE,CAAC,CAAC;IAC1G,CAAC;IAED,6DAA6D;IAC7D,KAAK,MAAM,MAAM,IAAI,YAAY,EAAE,CAAC;QAClC,MAAM,QAAQ,GAAG,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QACzE,IAAI,QAAQ,KAAK,YAAY,CAAC,cAAc,IAAI,QAAQ,KAAK,YAAY,CAAC,cAAc,GAAG,CAAC,EAAE,CAAC;YAC7F,iCAAiC;YACjC,MAAM,CAAC,IAAI,CAAC,UAAU,MAAM,CAAC,MAAM,cAAc,QAAQ,kDAAkD,YAAY,CAAC,cAAc,MAAM,CAAC,CAAC;QAChJ,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/validators/date-range.d.ts

@@ -10,8 +10,8 @@ export { dateSchema } from '../schemas/common';
  */
 export declare const datetimeSchema: z.ZodString;
 export declare const dateRangeSchema: z.ZodEffects<z.ZodObject<{
-    startDate: z.ZodEffects<z.ZodString, string, string>;
-    endDate: z.ZodEffects<z.ZodString, string, string>;
+    startDate: z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>;
+    endDate: z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>;
 }, "strip", z.ZodTypeAny, {
     startDate: string;
     endDate: string;
@@ -30,8 +30,8 @@ export type DateRange = z.infer<typeof dateRangeSchema>;
  * Academic year must be between 120 and 365 days
  */
 export declare const academicYearDateRangeSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
-    startDate: z.ZodEffects<z.ZodString, string, string>;
-    endDate: z.ZodEffects<z.ZodString, string, string>;
+    startDate: z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>;
+    endDate: z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>;
 }, "strip", z.ZodTypeAny, {
     startDate: string;
     endDate: string;
@@ -56,8 +56,8 @@ export type AcademicYearDateRange = z.infer<typeof academicYearDateRangeSchema>;
  * Grading period must be between 7 and 180 days
  */
 export declare const gradingPeriodDateRangeSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
-    startDate: z.ZodEffects<z.ZodString, string, string>;
-    endDate: z.ZodEffects<z.ZodString, string, string>;
+    startDate: z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>;
+    endDate: z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>;
 }, "strip", z.ZodTypeAny, {
     startDate: string;
     endDate: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aibrains/shared-types",
-  "version": "0.14.0",
+  "version": "0.16.0",
   "description": "Shared Zod schemas, TypeScript types, and validators for Education data models.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",