@royalschedule/maps 4.0.15 → 4.0.17

package/dist/Excel/v1/index.d.ts

@@ -1,34 +1,232 @@
-import { Types as Types$1 } from "../../core/types/index.js";
+import { IDType } from "../../core/interfaces/vertices/util/vertex.js";
+import { Day } from "../../core/interfaces/vertices/properties/days.js";
+import { Interval } from "../../core/interfaces/vertices/properties/intervals.js";
+import { Tag } from "../../core/interfaces/vertices/properties/tags.js";
+import { MaximumScheduleSpan } from "../../core/interfaces/vertices/properties/maximum-schedule-span.js";
+import { PlannedScheduledDuration } from "../../core/interfaces/vertices/properties/planned-scheduled-duration.js";
+import { MinBreakLength } from "../../core/interfaces/vertices/properties/min-break-length.js";
 import { Types } from "./types/index.js";
+import "../../index.js";
+import * as moment199 from "moment";
 
 //#region src/Excel/v1/index.d.ts
 declare class Map {
   static from: {
     schedules: (source: Types.Source) => {
       settings: {
-        discretization: number;
         numDays: number;
         dayStart: string;
         dayEnd: string;
+        discretization: number;
       };
-      locations: (Types$1.serialized.location & {
-        id: string;
-      })[];
-      teachers: (Types$1.serialized.teacher & {
-        id: string;
-      })[];
-      persons: (Types$1.serialized.person & {
-        id: string;
-      })[];
-      groups: (Types$1.serialized.group & {
-        id: string;
-      })[];
-      courses: (Types$1.serialized.course & {
-        id: string;
-      })[];
-      events: (Types$1.serialized.event & {
-        id: string;
-      })[];
+      locations: {
+        id: IDType;
+        ids?: string | undefined;
+        exceptions?: string[] | undefined;
+        lockedTimes?: string[] | undefined;
+        is?: "location" | undefined;
+        displayName?: string | undefined;
+        createdAt?: string | undefined;
+        updatedAt?: string | undefined;
+        lastModifiedBy?: string | undefined;
+        belongsTo?: string | undefined;
+        tags?: Tag[] | undefined;
+        minBreakLength?: number | undefined;
+        days?: Day[] | undefined;
+        lunch?: string[] | undefined;
+        maximumCapacity?: number | undefined;
+      }[];
+      teachers: {
+        id: IDType;
+        ids?: string | undefined;
+        exceptions?: string[] | undefined;
+        lockedTimes?: string[] | undefined;
+        is?: "teacher" | undefined;
+        displayName?: string | undefined;
+        createdAt?: string | undefined;
+        updatedAt?: string | undefined;
+        lastModifiedBy?: string | undefined;
+        rootInterval?: string | undefined;
+        person?: string | undefined;
+        belongsTo?: string | undefined;
+        tags?: Tag[] | undefined;
+        minBreakLength?: number | undefined;
+        maxNumWorkingHours?: number | false | undefined;
+        maxNumDailyWorkingHours?: number | number[] | false | undefined;
+        maximumScheduleSpan?: MaximumScheduleSpan | undefined;
+        forbidOverlappingEvents?: boolean | undefined;
+        disableDayLengthPunishment?: boolean | undefined;
+        weight?: number | undefined;
+        intervals?: Interval[] | undefined;
+        days?: Day[] | undefined;
+        lunch?: string[] | undefined;
+        signature?: string | undefined;
+        plannedScheduledDuration?: PlannedScheduledDuration | undefined;
+        complementaryTimes?: string[] | undefined;
+      }[];
+      persons: {
+        id: IDType;
+        ids?: string | undefined;
+        is?: "person" | undefined;
+        displayName?: string | undefined;
+        createdAt?: string | undefined;
+        updatedAt?: string | undefined;
+        lastModifiedBy?: string | undefined;
+        group?: string | undefined;
+        belongsTo?: string | undefined;
+        type?: "Student" | "Teacher" | "Other" | undefined;
+        tags?: Tag[] | undefined;
+        lastName?: string | undefined;
+        firstName?: string | undefined;
+        birthDate?: Date | undefined;
+        sex?: "Man" | "Woman" | undefined;
+        SSN?: {
+          value: string;
+          nationality?: string;
+        } | undefined;
+        emails?: {
+          value: string;
+          type?: string;
+        }[] | undefined;
+        phoneNumbers?: {
+          value: string;
+          type: string;
+        }[] | undefined;
+      }[];
+      groups: {
+        id: IDType;
+        ids?: string | undefined;
+        exceptions?: string[] | undefined;
+        lockedTimes?: string[] | undefined;
+        is?: "group" | undefined;
+        displayName?: string | undefined;
+        createdAt?: string | undefined;
+        updatedAt?: string | undefined;
+        lastModifiedBy?: string | undefined;
+        rootInterval?: string | undefined;
+        belongsTo?: string | undefined;
+        tags?: Tag[] | undefined;
+        minBreakLength?: number | undefined;
+        maxNumWorkingHours?: number | false | undefined;
+        maxNumDailyWorkingHours?: number | number[] | false | undefined;
+        maximumScheduleSpan?: MaximumScheduleSpan | undefined;
+        forbidOverlappingEvents?: boolean | undefined;
+        disableDayLengthPunishment?: boolean | undefined;
+        weight?: number | undefined;
+        species?: "class" | undefined;
+        intervals?: Interval[] | undefined;
+        days?: Day[] | undefined;
+        parentGroups?: string[] | undefined;
+        subGroups?: string[] | undefined;
+        lunch?: string[] | undefined;
+        members?: string[] | undefined;
+        derivedParentGroups?: {
+          implicit?: boolean | undefined;
+          explicit?: boolean | undefined;
+          group: string;
+        }[] | undefined;
+      }[];
+      courses: {
+        id: IDType;
+        ids?: string | undefined;
+        exceptions?: string[] | undefined;
+        groups?: {
+          groupIndex?: number | undefined;
+          to: string;
+          exclude?: string[] | undefined;
+        }[] | undefined;
+        teachers?: {
+          groupIndex?: number | undefined;
+          to: string;
+        }[] | undefined;
+        locations?: {
+          groupIndex?: number | undefined;
+          rank?: number | undefined;
+          locations: [string];
+        }[] | undefined;
+        events?: string[] | undefined;
+        lockedTimes?: string[] | undefined;
+        is?: "course" | undefined;
+        displayName?: string | undefined;
+        createdAt?: string | undefined;
+        updatedAt?: string | undefined;
+        lastModifiedBy?: string | undefined;
+        overlapGroup?: string | undefined;
+        period?: string | undefined;
+        syllabus?: string | undefined;
+        belongsTo?: string | undefined;
+        type?: string | undefined;
+        tags?: Tag[] | undefined;
+        minBreakLength?: MinBreakLength | undefined;
+        weight?: number | undefined;
+        intervals?: Interval[] | undefined;
+        days?: Day[] | undefined;
+        subject?: string | undefined;
+        color?: string | undefined;
+        eventDurationVariance?: number | undefined;
+        centerOfAttraction?: string | null | undefined;
+        density?: number | undefined;
+        plannedDuration?: string | undefined;
+        minutesPerWeek?: number | undefined;
+        expectedTotalHours?: number | undefined;
+        participants?: {
+          groupIndex?: number | undefined;
+          to: string;
+        }[] | undefined;
+      }[];
+      events: {
+        id: IDType;
+        ids?: string | undefined;
+        exceptions?: string[] | undefined;
+        groups?: {
+          groupIndex?: number | undefined;
+          to: string;
+          exclude?: string[] | undefined;
+        }[] | undefined;
+        teachers?: {
+          groupIndex?: number | undefined;
+          to: string;
+        }[] | undefined;
+        locations?: {
+          groupIndex?: number | undefined;
+          rank?: number | undefined;
+          locations: [string];
+        }[] | undefined;
+        lockedTimes?: string[] | undefined;
+        is?: "event" | undefined;
+        displayName?: string | undefined;
+        createdAt?: string | undefined;
+        updatedAt?: string | undefined;
+        lastModifiedBy?: string | undefined;
+        course?: string | undefined;
+        period?: string | undefined;
+        start?: (moment199.Moment | string) | undefined;
+        end?: (moment199.Moment | string) | undefined;
+        belongsTo?: string | undefined;
+        potentialCenter?: string | undefined;
+        type?: string | undefined;
+        tags?: Tag[] | undefined;
+        minBreakLength?: (MinBreakLength | null) | undefined;
+        weight?: number | undefined;
+        intervals?: Interval[] | null | undefined;
+        days?: Day[] | null | undefined;
+        color?: string | null | undefined;
+        centerOfAttraction?: string | null | undefined;
+        density?: number | undefined;
+        participants?: {
+          groupIndex?: number | undefined;
+          to: string;
+        }[] | undefined;
+        fixedStart?: boolean | undefined;
+        visible?: boolean | undefined;
+        parked?: boolean | undefined;
+        preferredDuration: number;
+        durationVariance?: number | undefined;
+        duration?: number | undefined;
+        weeks?: number[] | undefined;
+        overlapSpecies?: string | undefined;
+        inLocations?: (string | null)[] | undefined;
+      }[];
       meta?: {
         warnings?: string[];
       };

package/dist/Excel/v2/from/index.js

@@ -1,4 +1,5 @@
-import { chain, isNumber, isString } from "lodash-es";
+import { makeChainable } from "../../../common/make-chainable/index.js";
+import { countBy, isNumber, isString } from "lodash-es";
 import { nanoid } from "nanoid";
 
 //#region src/Excel/v2/from/index.ts
@@ -22,15 +23,23 @@ function toPositiveInteger(val) {
 	if (num <= 0) throw new Error(`toInteger: te result ${num} is not positive`);
 	return num;
 }
+/**
+* Converts a string/number to a trimmed string
+*/
 function toString(x) {
-	if (x == void 0) return void 0;
-	if (typeof x == "string" && !x.length) return void 0;
-	if (isNumber(x)) return x.toString();
-	return x.trim();
+	return isNumber(x) ? x.toString() : x.trim();
+}
+/**
+* Converts a possible nullish string/number to a trimmed string or undefined
+*/
+function toStringIfExists(x) {
+	if (x == null) return void 0;
+	return toString(x);
 }
 function extractLocations(course, locationsNameMap, warnings) {
+	if (course.locations == null) return;
 	const locationsStr = toString(course.locations);
-	if (!locationsStr) return void 0;
+	if (!locationsStr) return;
 	const locationReferences = [];
 	locationsStr.split("+").flatMap((x, i) => x.split(",").map((x$1) => [i, x$1.trim()])).forEach(([i, x]) => {
 		const key = x.toLowerCase();
@@ -57,8 +66,9 @@ function extractLocations(course, locationsNameMap, warnings) {
 	return locationReferences;
 }
 function extractGroups(course, groupsNameMap, warnings) {
+	if (course.groups == null) return;
 	const groupsStr = toString(course.groups);
-	if (!groupsStr) return void 0;
+	if (!groupsStr) return;
 	const groupReferences = [];
 	groupsStr.split(",").map((x) => x.trim()).forEach((x) => {
 		const key = x.toLowerCase();
@@ -82,6 +92,7 @@ function extractGroups(course, groupsNameMap, warnings) {
 	return groupReferences;
 }
 function extractTeachers(course, teachersNameMap, warnings) {
+	if (course.teachers == null) return;
 	const teachersStr = toString(course.teachers);
 	if (!teachersStr) return void 0;
 	const teacherReferences = [];
@@ -107,6 +118,7 @@ function extractTeachers(course, teachersNameMap, warnings) {
 	return teacherReferences;
 }
 function extractSyllabus(course, syllabusesCodeMap, syllabusesNameMap, warnings) {
+	if (course.syllabus == null) return void 0;
 	const syllabusValue = toString(course.syllabus);
 	if (!syllabusValue) return void 0;
 	const syllabus = syllabusesCodeMap.get(syllabusValue) || syllabusesNameMap.get(syllabusValue.toLowerCase());
@@ -115,18 +127,18 @@ function extractSyllabus(course, syllabusesCodeMap, syllabusesNameMap, warnings)
 			code: "invalid_syllabus_reference",
 			context: syllabusValue
 		});
-		return void 0;
+		return;
 	}
 	return syllabus.id;
 }
 function _schedules(source) {
 	const warnings = [];
-	source.settings = source.settings?.filter((x) => Object.values(x).some((y) => y.toString().trim().length > 0));
-	source.locations = source.locations?.filter((x) => Object.values(x).some((y) => y.toString().trim().length > 0));
-	source.teachers = source.teachers?.filter((x) => Object.values(x).some((y) => y.toString().trim().length > 0));
-	source.groups = source.groups?.filter((x) => Object.values(x).some((y) => y.toString().trim().length > 0));
-	source.persons = source.persons?.filter((x) => Object.values(x).some((y) => y.toString().trim().length > 0));
-	source.courses = source.courses?.filter((x) => Object.values(x).some((y) => y.toString().trim().length > 0));
+	source.settings = source.settings?.filter((x) => Object.values(x).some((y) => toString(y).length > 0));
+	source.locations = source.locations?.filter((x) => Object.values(x).some((y) => toString(y).length > 0));
+	source.teachers = source.teachers?.filter((x) => Object.values(x).some((y) => toString(y).length > 0));
+	source.groups = source.groups?.filter((x) => Object.values(x).some((y) => toString(y).length > 0));
+	source.persons = source.persons?.filter((x) => Object.values(x).some((y) => toString(y).length > 0));
+	source.courses = source.courses?.filter((x) => Object.values(x).some((y) => toString(y).length > 0));
 	const settings = {
 		discretization: 5,
 		numDays: 5,
@@ -157,13 +169,13 @@ function _schedules(source) {
 	const syllabusesCodeMap = /* @__PURE__ */ new Map();
 	if (!source.syllabuses) {}
 	source.syllabuses?.forEach((x) => {
-		const ids = toString(x.foreign_ID);
-		const subjectCode = toString(x.subject_code);
-		const subjectName = toString(x.subject_name);
-		const courseCode = toString(x.course_code);
-		const courseName = toString(x.course_name);
-		const schoolType = toString(x.school_type);
-		const id = x.ID?.toString() ?? generateId(syllabusesIdMap);
+		const ids = toStringIfExists(x.foreign_ID);
+		const subjectCode = toStringIfExists(x.subject_code);
+		const subjectName = toStringIfExists(x.subject_name);
+		const courseCode = toStringIfExists(x.course_code);
+		const courseName = toStringIfExists(x.course_name);
+		const schoolType = toStringIfExists(x.school_type);
+		const id = toStringIfExists(x.ID) ?? generateId(syllabusesIdMap);
 		if (syllabusesIdMap.has(id)) {
 			warnings.push({
 				code: "ignoring_duplicate_syllabus",
@@ -225,9 +237,9 @@ function _schedules(source) {
 	}].forEach(({ name, data, idMap, nameMap }) => {
 		if (!data) warnings.push({ code: `missing_${name.plural}_sheet` });
 		data?.forEach((x) => {
-			const ids = toString(x.foreign_ID);
-			const displayName = toString(x.name);
-			const id = x.ID?.toString() ?? generateId(idMap);
+			const ids = toStringIfExists(x.foreign_ID);
+			const displayName = toStringIfExists(x.name);
+			const id = toStringIfExists(x.ID) ?? generateId(idMap);
 			if (idMap.has(id)) {
 				warnings.push({
 					code: `ignoring_duplicate_${name.singular}`,
@@ -249,9 +261,9 @@ function _schedules(source) {
 	const groupsNameMap = /* @__PURE__ */ new Map();
 	if (!source.groups) warnings.push({ code: "missing_groups_sheet" });
 	source.groups?.forEach((x) => {
-		const ids = toString(x.foreign_ID);
-		const displayName = toString(x.name);
-		const id = x.ID?.toString() ?? generateId(groupsIdMap);
+		const ids = toStringIfExists(x.foreign_ID);
+		const displayName = toStringIfExists(x.name);
+		const id = toStringIfExists(x.ID) ?? generateId(groupsIdMap);
 		if (groupsIdMap.has(id)) {
 			warnings.push({
 				code: "ignoring_duplicate_group",
@@ -259,7 +271,7 @@ function _schedules(source) {
 			});
 			return;
 		}
-		const species = toString(x.is_class) == "1" ? "class" : void 0;
+		const species = toStringIfExists(x.is_class) == "1" ? "class" : void 0;
 		const y = {
 			id,
 			...ids && { ids },
@@ -274,11 +286,11 @@ function _schedules(source) {
 	const personsSsnMap = /* @__PURE__ */ new Map();
 	if (!source.persons) warnings.push({ code: "missing_persons_sheet" });
 	source.persons?.forEach((x) => {
-		const ids = toString(x.foreign_ID);
-		const firstName = toString(x.first_name);
-		const lastName = toString(x.last_name);
-		const SSN = toString(x.SSN);
-		const id = x.ID?.toString() ?? generateId(personsIdMap);
+		const ids = toStringIfExists(x.foreign_ID);
+		const firstName = toStringIfExists(x.first_name);
+		const lastName = toStringIfExists(x.last_name);
+		const SSN = toStringIfExists(x.SSN);
+		const id = toStringIfExists(x.ID) ?? generateId(personsIdMap);
 		if (personsIdMap.has(id)) {
 			warnings.push({
 				code: "ignoring_duplicate_person",
@@ -322,7 +334,9 @@ function _schedules(source) {
 	});
 	groupsNameMap.forEach((x) => {
 		let duplicateReported = false;
-		x.members = chain(toString(x.__raw.members)).split(",").map((x$1) => x$1.trim()).filter(Boolean).countBy().map((count, ssn) => {
+		if (!x.__raw.members) return;
+		x.members = makeChainable(x.__raw.members).chain((x$1) => toString(x$1).split(",").map((x$2) => x$2.trim()).filter((x$2) => x$2 != null)).chain((x$1) => countBy(x$1)).chain((y) => Object.entries(y).map(([ssn, count]) => {
+			if (!ssn) return;
 			if (!duplicateReported && count > 1) {
 				warnings.push({
 					code: "duplicate_group_member",
@@ -349,19 +363,18 @@ function _schedules(source) {
 				}
 			}
 			return person.id;
-		}).filter((x$1) => !!x$1).value();
+		}).filter((x$1) => x$1 != null)).value;
 	});
 	const coursesIdMap = /* @__PURE__ */ new Map();
 	const eventsIdMap = /* @__PURE__ */ new Map();
 	const overlapGroupsKeyMap = /* @__PURE__ */ new Map();
 	if (!source.courses) warnings.push({ code: "missing_courses_sheet" });
 	source.courses?.forEach((x) => {
-		const mergeWith = toString(x.merge_with);
-		if (mergeWith) return;
-		const ids = toString(x.foreign_ID);
-		const displayName = toString(x.name)?.trim();
-		const subject = toString(x.subject);
-		const courseId = x.ID?.toString() ?? generateId(coursesIdMap);
+		if (toStringIfExists(x.merge_with)) return;
+		const ids = toStringIfExists(x.foreign_ID);
+		const displayName = toStringIfExists(x.name);
+		const subject = toStringIfExists(x.subject);
+		const courseId = toStringIfExists(x.ID) ?? generateId(coursesIdMap);
 		if (coursesIdMap.has(courseId)) {
 			warnings.push({
 				code: "ignoring_duplicate_course",
@@ -392,29 +405,25 @@ function _schedules(source) {
 			context: `${minutesPerWeek} min/week OR ${expectedTotalHours} hrs`
 		});
 		const plannedDuration = expectedTotalHours ? `${expectedTotalHours} hrs` : minutesPerWeek ? `${minutesPerWeek} min/week` : void 0;
-		if (x.lesson_durations) {
-			const _durations = typeof x.lesson_durations === "string" ? x.lesson_durations.split(",").map((x$1) => x$1.trim()) : [x.lesson_durations];
-			const durations = _durations.map((e) => {
-				try {
-					return toPositiveMultipleOf5(e);
-				} catch {
-					warnings.push({
-						code: "invalid_lesson_durations",
-						context: x.lesson_durations
-					});
-					return void 0;
-				}
-			}).filter((x$1) => x$1 !== void 0);
-			durations.forEach((x$1) => {
-				const id = generateId(eventsIdMap);
-				const event = {
-					id,
-					course: courseId,
-					preferredDuration: x$1
-				};
-				eventsIdMap.set(id, event);
-			});
-		}
+		if (x.lesson_durations) (typeof x.lesson_durations === "string" ? x.lesson_durations.split(",").map((x$1) => x$1.trim()) : [x.lesson_durations]).map((e) => {
+			try {
+				return toPositiveMultipleOf5(e);
+			} catch {
+				warnings.push({
+					code: "invalid_lesson_durations",
+					context: x.lesson_durations
+				});
+				return;
+			}
+		}).filter((x$1) => x$1 !== void 0).forEach((x$1) => {
+			const id = generateId(eventsIdMap);
+			const event = {
+				id,
+				course: courseId,
+				preferredDuration: x$1
+			};
+			eventsIdMap.set(id, event);
+		});
 		if (x.overlap_group && toString(x.overlap_group)) {
 			const key = toString(x.overlap_group).toLowerCase();
 			const og = overlapGroupsKeyMap.get(key);
@@ -458,7 +467,7 @@ function _schedules(source) {
 		coursesIdMap.set(courseId, course);
 	});
 	source.courses?.forEach((x) => {
-		const mergeWith = toString(x.merge_with);
+		const mergeWith = toStringIfExists(x.merge_with);
 		if (!mergeWith) return;
 		if (!coursesIdMap.has(mergeWith)) {
 			warnings.push({
@@ -467,41 +476,37 @@ function _schedules(source) {
 			});
 			return;
 		}
-		const displayName = toString(x.name)?.trim();
+		const displayName = toStringIfExists(x.name);
 		const locations = extractLocations(x, locationsNameMap, warnings)?.map((x$1) => ({
 			groupIndex: x$1.groupIndex,
 			locations: [x$1.to]
 		}));
 		const groups = extractGroups(x, groupsNameMap, warnings);
 		const teachers = extractTeachers(x, teachersNameMap, warnings);
-		if (x.lesson_durations) {
-			const _durations = typeof x.lesson_durations === "string" ? x.lesson_durations.split(",").map((x$1) => x$1.trim()) : [x.lesson_durations];
-			const durations = _durations.map((e) => {
-				try {
-					return toPositiveMultipleOf5(e);
-				} catch {
-					warnings.push({
-						code: "invalid_lesson_durations",
-						context: x.lesson_durations
-					});
-					return void 0;
-				}
-			}).filter((x$1) => x$1 !== void 0);
-			durations.forEach((preferredDuration) => {
-				const id = generateId(eventsIdMap);
-				const event = {
-					id,
-					course: mergeWith,
-					preferredDuration,
-					...displayName && { displayName },
-					...groups && { groups },
-					...teachers && { teachers },
-					...locations && { locations },
-					__raw: x
-				};
-				eventsIdMap.set(id, event);
-			});
-		}
+		if (x.lesson_durations) (typeof x.lesson_durations === "string" ? x.lesson_durations.split(",").map((x$1) => x$1.trim()) : [x.lesson_durations]).map((e) => {
+			try {
+				return toPositiveMultipleOf5(e);
+			} catch {
+				warnings.push({
+					code: "invalid_lesson_durations",
+					context: x.lesson_durations
+				});
+				return;
+			}
+		}).filter((x$1) => x$1 !== void 0).forEach((preferredDuration) => {
+			const id = generateId(eventsIdMap);
+			const event = {
+				id,
+				course: mergeWith,
+				preferredDuration,
+				...displayName && { displayName },
+				...groups && { groups },
+				...teachers && { teachers },
+				...locations && { locations },
+				__raw: x
+			};
+			eventsIdMap.set(id, event);
+		});
 	});
 	return {
 		settings,